Exploring gem setup and implemented basic Request

Author: Arjan van der Gaag

CHANGELOG.md

@@ -0,0 +1 @@
+(unreleased)

Guardfile

@@ -1,18 +1,60 @@
+**Currently a work in progress**
+
+A Ruby wrapper around the [bol.com developers API][docs], that will be made
+available as a Gem. Currently in pre-alpha stage.
+
+[docs]: http://developers.bol.com
+
+## Available operations
+
+Here's an overview of all the operations that should be implemented:
+
 ```ruby
 Bol::Category.find(params[:id]).products
 Bol::Category.find(params[:id]).subcategories
 Bol::Category.find(params[:id]).top_products
-Bol::Category.find(params[:id]).search()
+Bol::Category.find(params[:id]).search(params[:query])
 Bol::Product.find(params[:id])
 Bol::Product.search(params[:query]).limit(10).offset(10).order('sales_ranking ASC')
 Bol::Product.search(params[:query]).page(params[:page])
 ```
 
+These simply map to operations provided by the API to search, load lists of
+products or load a single product by ID. I do aim to a add a little sugar
+to make working with Ruby objects a little easier:
+
+* Add `page` helper method to combine `limit` and `offset`
+* Scope operations by category in a ActiveRecord association style
+* Delay API calls until explicitly requested or triggered by looping over
+  results
+
+## Configuration
+
 ```ruby
 Bol.configure do |c|
-  c.key = '...'
-  c.secret = ''
+  c.key = 'your public access key'
+  c.secret = 'your private secret'
   c.per_page = 10
   c.default_order = 'sales_ranking'
 end
 ```
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version
+  unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have
+  your own version, that is fine but bump version in a commit by itself I can
+  ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## History
+
+For a full list of changes, please see CHANGELOG.md
+
+## License
+
+Copyright (C) 2011 by Arjan van der Gaag. Published under the MIT license. See
+LICENSE.md for details.

README.md

@@ -1,9 +1,9 @@
 require 'bundler/gem_tasks'
-
 require 'rake/testtask'
+
 Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/test_*.rb']
+  t.libs << 'spec'
+  t.test_files = FileList['spec/**/*_spec.rb']
   t.verbose = true
 end
 

Rakefile

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Bol::VERSION
   s.authors     = ['Arjan van der Gaag']
   s.email       = ['[email protected]']
-  s.homepage    = ""
+  s.homepage    = "https://github.com/avdgaag/bol"
   s.summary     = %q{Simple Ruby wrapper around the bol.com developer API}
   s.description = %q{Access the bol.com product catalog from a Ruby project.}
 
@@ -17,11 +17,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'turn'
-  s.add_development_dependency 'guard'
-  s.add_development_dependency 'guard-minitest'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'fakeweb'
-  s.add_development_dependency 'rb-fsevent'
-  s.add_development_dependency 'growl'
 end

bol.gemspec

@@ -7,4 +7,13 @@ module Bol
   autoload :Query,         'bol/query'
   autoload :Request,       'bol/request'
   autoload :Requests,      'bol/requests'
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure(options = nil)
+    @configuration = Configuration.new(options)
+    yield @configuration if options.nil?
+  end
 end

lib/bol.rb

@@ -1,4 +1,25 @@
 module Bol
   class Category
+    def self.search(*args)
+      new(0).search(*args)
+    end
+
+    attr_reader :id
+
+    def initialize(id = 0)
+      @id = id
+    end
+
+    def search(terms)
+      request = Requests::Search.new(Query.new(id, terms)).query
+    end
+
+    def subcategories
+      Requests::Category.new(Query.new(id))
+    end
+
+    def top
+      Requests::List.new(Query.new(id)).query
+    end
   end
 end

lib/bol/category.rb

@@ -1,4 +1,41 @@
 module Bol
   class Configuration
+    ALLOWED_KEYS = %w[key per_page].map(&:to_sym)
+
+    def initialize(options = {})
+      raise ArgumentError unless options.nil? or options.respond_to? :each_pair
+
+      @options = { per_page: 10 }
+
+      unless options.nil?
+        options.each_pair do |k, v|
+          self[k] = v
+        end
+      end
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+    def []=(key, value)
+      raise ArgumentError unless ALLOWED_KEYS.include?(key)
+      @options[key] = value
+    end
+
+    def method_missing(name, *args)
+      return super unless respond_to? name
+      if name.to_s =~ /=$/
+        send(:[]=, name.to_s.sub(/=$/, '').to_sym, *args)
+      else
+        send(:[], name)
+      end
+    end
+
+    def respond_to?(name)
+      super or
+        ALLOWED_KEYS.include?(name) or
+        ALLOWED_KEYS.include?(name.to_s.sub(/=$/, '').to_sym)
+    end
   end
 end

lib/bol/configuration.rb

@@ -1,4 +1,40 @@
 module Bol
   class Product
+    def self.find(id)
+      q = Query.new(0)
+      q.product_id = id
+      Requests::Product.new(q)
+    end
+
+    attr_reader :attributes
+
+    def initialize
+      @attributes = {}
+    end
+
+    def [](key)
+      @attributes[key]
+    end
+
+    def []=(key, value)
+      @attributes[key] = value
+    end
+
+    def method_missing(name, *args)
+      if attributes.keys.include?(name)
+        if name =~ /=$/
+          attributes[name] = *args
+        else
+          attributes[name]
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to?(name)
+      super or attributes.keys.include?(name) or
+        attributes.keys.include?(name.to_s.sub(/=$/, '').to_sym)
+    end
   end
 end

lib/bol/product.rb

@@ -1,4 +1,52 @@
 module Bol
   class Query
+    attr_reader :terms, :category_id
+    attr_accessor :product_id
+
+    def initialize(category_id, terms = nil)
+      raise ArgumentError unless category_id.is_a?(Fixnum)
+      @category_id = category_id
+      @terms = terms
+    end
+
+    def params
+      p = {
+        categoryId: @category_id,
+      }
+      p[:nrProducts]       = @limit           if @limit
+      p[:offset]           = @offset          if @offset
+      p[:sortingMethod]    = @order_key       if @order_key
+      p[:sortingAscending] = @order_direction if @order_direction
+      p[:productId]        = @product_id      if @product_id
+      p
+    end
+
+    def order(str)
+      if str =~ /^(sales_ranking|price|title|publishing_date|customer_rating) (ASC|DESC)/
+        @order_key = $1
+        @order_direction = $2 == 'ASC' ? 'true' : 'false'
+      else
+        raise ArgumentError
+      end
+      self
+    end
+
+    def page(n = nil)
+      limit Bol.configuration[:per_page]
+      offset ((n || 1).to_i - 1) * Bol.configuration[:per_page]
+      self
+    end
+
+    def offset(n = nil)
+      return @offset if n.nil?
+      @offset = n.to_i
+      self
+    end
+
+    def limit(n = nil)
+      return @limit if n.nil?
+      @limit = n.to_i
+      self
+    end
   end
 end

lib/bol/query.rb

@@ -1,4 +1,55 @@
+require 'net/https'
+require 'base64'
+require 'uri'
+
 module Bol
   class Request
+    extend Forwardable
+    attr_reader :query, :path, :access_key, :secret, :response
+
+    DOMAIN = 'openapi.bol.com'
+
+    def initialize(query, path)
+      @query = query
+      @path  = path
+    end
+
+    def fetch
+      uri = URI.parse("https://#{DOMAIN}#{path}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.content_type = 'application/xml'
+      request['Connection'] = 'close'
+      request['X-OpenAPI-Authorization'] = signature(date)
+      request['X-OpenAPI-Date'] = date
+      @response = http.request(request)
+      self
+    end
+
+    def_delegators :response, :code, :body
+
+    def success?
+      response.code == '200'
+    end
+
+  private
+
+    def date
+      @date ||= Time.now.utc.strftime '%a, %d %B %Y %H:%M:%S GMT'
+    end
+
+    def signature
+      msg =  <<-EOS
+GET
+
+application/xml
+#{date}
+x-openapi-date:#{date}
+#{path}
+EOS
+      access_key + ':' + Base64.encode64(OpenSSL::HMAC.digest('sha256', secret, msg.chomp)).sub(/\n/, '')
+    end
   end
 end

lib/bol/request.rb

@@ -1,6 +1,6 @@
 module Bol
   module Requests
-    class Category
+    class Category < Request
     end
   end
 end

lib/bol/requests/category.rb

@@ -1,6 +1,6 @@
 module Bol
   module Requests
-    class List
+    class List < Request
     end
   end
 end

lib/bol/requests/list.rb

@@ -1,6 +1,6 @@
 module Bol
   module Requests
-    class Product
+    class Product < Request
     end
   end
 end

lib/bol/requests/product.rb

@@ -1,6 +1,6 @@
 module Bol
   module Requests
-    class Search
+    class Search < Request
     end
   end
 end