initial commit

Author: Arjan van der Gaag

.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

CHANGELOG.md

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

Gemfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|) { "spec" }
+end

Guardfile

@@ -0,0 +1,19 @@
+Copyright (C) 2011 by Arjan van der Gaag
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

LICENSE.md

@@ -0,0 +1,18 @@
+```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::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])
+```
+
+```ruby
+Bol.configure do |c|
+  c.key = '...'
+  c.secret = ''
+  c.per_page = 10
+  c.default_order = 'sales_ranking'
+end
+```

README.md

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

Rakefile

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'bol/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'bol'
+  s.version     = Bol::VERSION
+  s.authors     = ['Arjan van der Gaag']
+  s.email       = ['[email protected]']
+  s.homepage    = ""
+  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.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  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

@@ -0,0 +1,10 @@
+require 'bol/version'
+
+module Bol
+  autoload :Category,      'bol/category'
+  autoload :Configuration, 'bol/configuration'
+  autoload :Product,       'bol/product'
+  autoload :Query,         'bol/query'
+  autoload :Request,       'bol/request'
+  autoload :Requests,      'bol/requests'
+end

lib/bol.rb

@@ -0,0 +1,4 @@
+module Bol
+  class Category
+  end
+end

lib/bol/category.rb

@@ -0,0 +1,4 @@
+module Bol
+  class Configuration
+  end
+end

lib/bol/configuration.rb

@@ -0,0 +1,4 @@
+module Bol
+  class Product
+  end
+end

lib/bol/product.rb

@@ -0,0 +1,4 @@
+module Bol
+  class Query
+  end
+end

lib/bol/query.rb

@@ -0,0 +1,4 @@
+module Bol
+  class Request
+  end
+end

lib/bol/request.rb

@@ -0,0 +1,8 @@
+module Bol
+  module Requests
+    autoload :Product,  'bol/requests/product'
+    autoload :Category, 'bol/requests/category'
+    autoload :Search,   'bol/requests/search'
+    autoload :List,     'bol/requests/list'
+  end
+end

lib/bol/requests.rb

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

lib/bol/requests/category.rb

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

lib/bol/requests/list.rb

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

lib/bol/requests/product.rb

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

lib/bol/requests/search.rb

@@ -0,0 +1,3 @@
+module Bol
+  VERSION = '0.0.1'
+end

lib/bol/version.rb

@@ -0,0 +1,19 @@
+require 'minitest/spec'
+require 'bol'
+
+describe Bol do
+  describe '#configure' do
+    it 'should create configuration object'
+    it 'should yield config object without argument'
+    it 'should raise with non-hash argument'
+    it 'should not yield with argument'
+  end
+
+  describe '#products' do
+    it 'should delegate to new empty category products'
+  end
+
+  describe '#search' do
+    it 'should delegate to new empty category search'
+  end
+end

spec/bol_spec.rb

@@ -0,0 +1,42 @@
+require 'minitest/spec'
+
+describe Bol::Category do
+  describe 'combining categories' do
+    it 'should add two categories for a combined scope'
+    it 'should subtract two categories to reduce scope'
+    it 'should manually add category IDs'
+  end
+
+  describe '#search' do
+    it 'should create new query'
+    it 'should create new request'
+    it 'should not send request'
+    it 'should set query term'
+    it 'should return query'
+  end
+
+  describe 'list methods' do
+    it 'should create new request'
+    it 'should return new request'
+    it 'should allow setting order'
+    it 'should allow setting limit'
+    it 'should allow setting offset'
+    it 'should allow setting page'
+  end
+
+  describe 'default category' do
+    it 'should set request category scope to 0'
+  end
+
+  describe 'subcategories' do
+    it 'should create category list request'
+    it 'should return array of Category objects'
+  end
+
+  describe '#find' do
+    it 'should create request'
+    it 'should set id on request'
+    it 'should request category scope when found'
+    it 'should raise error when not found'
+  end
+end

spec/category_spec.rb

@@ -0,0 +1,13 @@
+require 'minitest/spec'
+
+describe Bol::Configuration do
+  describe 'as a hash' do
+    it 'should should set known keys'
+    it 'should raise for unknown keys'
+  end
+
+  describe 'as attributes' do
+    it 'should should set known keys'
+    it 'should raise for unknown keys'
+  end
+end

spec/configuration_spec.rb

@@ -0,0 +1,26 @@
+require 'minitest/spec'
+
+describe Bol::Product do
+  describe '#find' do
+    it 'should create new request'
+    it 'should not send request'
+    it 'should set id param'
+    it 'should return product instance'
+    it 'should raise error when not found'
+  end
+
+  describe 'attributes' do
+    it 'should delegate [] to attributes'
+    it 'should expose attributes as methods'
+
+    describe 'release date' do
+      it 'should parse to a Datetime'
+    end
+
+    describe 'cover' do
+      it 'should return medium by default'
+      it 'should take format as argument'
+      it 'should raise on invalid format'
+    end
+  end
+end

spec/product_spec.rb

@@ -0,0 +1,39 @@
+require 'minitest/spec'
+
+describe Bol::Query do
+  describe 'category scope' do
+    it 'should set category scope'
+    it 'should raise unless given a number'
+    it 'should set category param'
+  end
+
+  describe '#limit' do
+    it 'should raise unless given a number'
+    it 'should add parameter to request'
+    it 'should return query'
+  end
+
+  describe '#page' do
+    it 'should raise unless given numeric'
+    it 'should default to 1'
+    it 'should add limit param to request'
+    it 'should add offset param to request'
+    it 'should use per page config to determine offset value'
+    it 'should return query'
+  end
+
+  describe '#offset' do
+    it 'should raise unless given a number'
+    it 'should add parameter to request'
+    it 'should return query'
+  end
+
+  describe '#order' do
+    it 'should convert to string'
+    it 'should raise unless wrong format'
+    it 'should add order direction on request'
+    it 'should add order key on request'
+    it 'should return query'
+  end
+end
+

spec/query_spec.rb

@@ -0,0 +1,46 @@
+require 'minitest/spec'
+
+describe Bol::Request do
+  describe 'category scope' do
+    it 'should set category scope'
+    it 'should raise when scope is not an id'
+    it 'should keep scope across requests'
+    it 'should reset scope'
+    it 'should add scope as param'
+  end
+
+  describe 'signing' do
+    it 'should raise error when key and secret are not configured'
+    it 'should add signature to request by default'
+  end
+
+  describe 'firing' do
+    it 'should trigger HTTP request on looping'
+    it 'should trigger event manually'
+  end
+
+  describe Bol::Requests::Product do
+    it 'should get from correct URL'
+    it 'should require param id'
+    it 'should yield Product'
+  end
+
+  describe Bol::Requests::Category do
+    it 'should get from correct URL'
+    it 'should require param id'
+    it 'should yield Category'
+  end
+
+  describe Bol::Requests::Search do
+    it 'should get from correct URL'
+    it 'should require param term'
+    it 'should allow key ...'
+    it 'should yield Product'
+  end
+
+  describe Bol::Requests::List do
+    it 'should get from correct URL'
+    it 'should require param type'
+    it 'should yield Product'
+  end
+end