asin 0.7.0 → 0.8.0

data/.travis.yml

@@ -1,12 +1,10 @@
 script: "bundle exec rake"
 rvm:
-  - 1.8.7
   - 1.9.2
-  - rbx
-  - rbx-2.0
-  - ree
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
   - ruby-head
-  - jruby
 branches:
   only:
-    - develop
+    - develop

data/CHANGELOG.rdoc

@@ -1,3 +1,13 @@
+== 0.8.0
+
+* use confiture for configuration
+* implement SimilarityLookup
+
+== 0.7.0
+
+* jruby compatible
+* loosen gem dependencies
+
 == 0.6.1
 
 * fix error when passing nil to config values

data/Gemfile.lock

@@ -1,42 +1,51 @@
 PATH
   remote: .
   specs:
-    asin (0.7.0)
-      crack (~> 0.1)
-      hashie (~> 1.0)
+    asin (0.8.0)
+      confiture (~> 0.1)
+      crack (~> 0.3)
+      hashie (~> 1.1)
       httpi (~> 0.9)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.2.6)
-    crack (0.1.8)
+    addressable (2.2.8)
+    coderay (1.0.7)
+    confiture (0.1.2)
+    crack (0.3.1)
     diff-lcs (1.1.3)
     fuubar (0.0.6)
       rspec (~> 2.0)
       rspec-instafail (~> 0.1.8)
       ruby-progressbar (~> 0.0.10)
     hashie (1.1.0)
-    httpclient (2.2.1)
-    httpi (0.9.5)
+    httpclient (2.2.3)
+    httpi (0.9.7)
       rack
-    rack (1.3.2)
-    rake (0.9.2)
+    method_source (0.7.1)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    rack (1.4.1)
+    rake (0.9.2.2)
     rash (0.3.1)
       hashie (~> 1.1.0)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-instafail (0.1.8)
-    rspec-mocks (2.6.0)
+    rspec-instafail (0.1.9)
+    rspec-mocks (2.7.0)
     ruby-progressbar (0.0.10)
+    slop (2.4.4)
     vcr (1.11.3)
-    webmock (1.7.6)
-      addressable (~> 2.2, > 2.2.5)
+    webmock (1.8.7)
+      addressable (>= 2.2.7)
       crack (>= 0.1.7)
 
 PLATFORMS
@@ -45,10 +54,11 @@ PLATFORMS
 
 DEPENDENCIES
   asin!
-  fuubar (~> 0.0)
-  httpclient (~> 2.2)
-  rake (~> 0.9)
-  rash (~> 0.3)
-  rspec (~> 2.6)
-  vcr (~> 1.10)
-  webmock (~> 1.6)
+  fuubar (~> 0.0.5)
+  httpclient (~> 2.2.3)
+  pry (~> 0.9.9)
+  rake (~> 0.9.2.2)
+  rash (~> 0.3.1)
+  rspec (~> 2.7.0)
+  vcr (~> 1.11.3)
+  webmock (~> 1.8.7)

data/README.rdoc

@@ -9,15 +9,7 @@ For more information on the REST calls, have a look at the whole Amazon E-Commer
 
 Have a look at the RDOC[http://rdoc.info/projects/phoet/asin] for this project, if you like browsing some docs.
 
-The gem runs smoothly with Rails 3 and is tested against these rubies:
-
-- 1.8.7
-- 1.9.2
-- rbx
-- rbx-2.0
-- ree
-- ruby-head
-- jruby
+The gem runs smoothly with Rails 3 and is tested against multiple rubies. See +.travis.yml+ for details.
 
 == Installation
 
@@ -101,6 +93,9 @@ But you can also use the +instance+ method to get a proxy-object:
   # access the internal data representation (Hashie::Mash)
   item.raw.ItemAttributes.ListPrice.FormattedPrice
   => $39.99
+  
+  # search for similar items like the one you already have
+  items = client.similar '1430218150'
 
 There is an additional set of methods to support AWS cart operations:
 
@@ -165,3 +160,10 @@ As a default HTTPI uses _httpclient_ so you should add that dependency to your p
 
   gem 'httpclient'
 
+
+== License
+
+"THE BEER-WARE LICENSE" (Revision 42):
+ps@nofail.de[mailto:ps@nofail.de] wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return Peter Schröder

data/asin.gemspec

@@ -19,18 +19,20 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency('crack',  '~> 0.1')
-  s.add_dependency('hashie', '~> 1.0')
-  s.add_dependency('httpi',  '~> 0.9')
+  s.add_dependency('crack',     '~> 0.3')
+  s.add_dependency('hashie',    '~> 1.1')
+  s.add_dependency('httpi',     '~> 0.9')
+  s.add_dependency('confiture', '~> 0.1')
 
   s.add_runtime_dependency('jruby-openssl') if RUBY_PLATFORM == 'java'
 
-  s.add_development_dependency('httpclient', '~> 2.2')
-  s.add_development_dependency('rash',       '~> 0.3')
-  
-  s.add_development_dependency('rake',       '~> 0.9')
-  s.add_development_dependency('vcr',        '~> 1.10')
-  s.add_development_dependency('webmock',    '~> 1.6')
-  s.add_development_dependency('rspec',      '~> 2.6')
-  s.add_development_dependency('fuubar',     '~> 0.0')
+  s.add_development_dependency('httpclient', '~> 2.2.3')
+  s.add_development_dependency('rash',       '~> 0.3.1')
+
+  s.add_development_dependency('rake',       '~> 0.9.2.2')
+  s.add_development_dependency('vcr',        '~> 1.11.3')
+  s.add_development_dependency('webmock',    '~> 1.8.7')
+  s.add_development_dependency('rspec',      '~> 2.7.0')
+  s.add_development_dependency('fuubar',     '~> 0.0.5')
+  s.add_development_dependency('pry',        '~> 0.9.9')
 end

data/lib/asin/client.rb

@@ -179,7 +179,7 @@ module ASIN
 
     # Performs an +ItemSearch+ REST call against the Amazon API.
     #
-    # Expects a Hash of search params where and returns a list of +SimpleItem+s:
+    # Expects a Hash of search params and returns a list of +SimpleItem+s:
     #
     #   items = search :SearchIndex => :Music
     #
@@ -198,7 +198,7 @@ module ASIN
 
     # Performs an +BrowseNodeLookup+ REST call against the Amazon API.
     #
-    # Expects a Hash of search params where and returns a +SimpleNode+:
+    # Expects a node-id and returns a +SimpleNode+:
     #
     #   node = browse_node '163357'
     #
@@ -215,6 +215,26 @@ module ASIN
       handle_type(response['BrowseNodeLookupResponse']['BrowseNodes']['BrowseNode'], Configuration.node_type)
     end
 
+    # Performs an +SimilarityLookup+ REST call against the Amazon API.
+    #
+    # Expects one ore more asins and returns a list of +SimpleNode+s:
+    #
+    #   node = browse_node '163357'
+    #
+    # ==== Options:
+    #
+    # Additional parameters for the API call like this:
+    #
+    #   similar('1430218150', :SimilarityType => :Intersection, :ResponseGroup => :Small)
+    #
+    # Have a look at the optional config values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/SimilarityLookup.html]
+    #
+    def similar(*asins)
+      params = asins.last.is_a?(Hash) ? asins.pop : {:SimilarityType => :Random, :ResponseGroup => :Medium}
+      response = call(params.merge(:Operation => :SimilarityLookup, :ItemId => asins.join(',')))
+      arrayfy(response['SimilarityLookupResponse']['Items']['Item']).map {|item| handle_item(item)}
+    end
+
     # Performs an +CartCreate+ REST call against the Amazon API.
     #
     # Expects one ore more item-hashes and returns a +SimpleCart+:
@@ -289,8 +309,8 @@ module ASIN
       cart(:CartClear, {:CartId => cart.cart_id, :HMAC => cart.hmac})
     end
 
-    private()
-    
+    private
+
     def arrayfy(item)
       return [] unless item
       item.is_a?(Array) ? item : [item]
@@ -339,7 +359,7 @@ module ASIN
     end
 
     def call(params)
-      Configuration.validate_credentials!
+      Configuration.validate!
 
       log(:debug, "calling with params=#{params}")
       signed = create_signed_query_string(params)
@@ -371,7 +391,7 @@ module ASIN
       # utc timestamp needed for signing
       params[:Timestamp] = Time.now.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
 
-      
+
       query = create_query(params)
 
       # yeah, you really need to sign the get-request not the query
@@ -382,7 +402,7 @@ module ASIN
       signature = CGI.escape(Base64.encode64(hmac).chomp)
       "#{query}&Signature=#{signature}"
     end
-    
+
     def create_query(params)
       params.map do |key, value|
         value = value.collect{|v| v.to_s.strip}.join(',') if value.is_a?(Array)

data/lib/asin/configuration.rb

@@ -1,105 +1,57 @@
-require "yaml"
-require 'logger'
+require "logger"
+require "confiture"
 
 module ASIN
-  class Configuration
-    class << self
-
-      attr_accessor :secret, :key, :host, :logger
-      attr_accessor :item_type, :cart_type, :node_type
-      attr_accessor :version, :associate_tag
-
-      # Rails initializer configuration.
-      #
-      # Expects at least +secret+ and +key+ for the API call:
-      #
-      #   ASIN::Configuration.configure do |config|
-      #     config.secret = 'your-secret'
-      #     config.key    = 'your-key'
-      #   end
-      #
-      # With the latest version of the Product Advertising API you need to include your associate_tag[https://affiliate-program.amazon.com/gp/advertising/api/detail/api-changes.html].
-      #
-      # You may pass options as a hash as well:
-      #
-      #   ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
-      #
-      # Or configure everything using YAML:
-      #
-      #   ASIN::Configuration.configure :yaml => 'config/asin.yml'
-      #
-      #   ASIN::Configuration.configure :yaml => 'config/asin.yml' do |config, yml|
-      #     config.key = yml[Rails.env]['aws_access_key']
-      #   end
-      #
-      # ==== Options:
-      #
-      # [secret] the API secret key (required)
-      # [key] the API access key (required)
-      # [associate_tag] your Amazon associate tag. Default is blank (required in latest API version)
-      # [host] the host, which defaults to 'webservices.amazon.com'
-      # [logger] a different logger than logging to STDERR (nil for no logging)
-      # [version] a custom version of the API calls. Default is 2010-11-01
-      # [item_type] a different class for SimpleItem, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
-      # [cart_type] a different class for SimpleCart, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
-      # [node_type] a different class for SimpleNode, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
-      #
-      def configure(options={})
-        init_config
-        if yml_path = options[:yaml] || options[:yml]
-          yml = File.open(yml_path) { |file| YAML.load(file) }
-          if block_given?
-            yield self, yml
-          else
-            yml.each do |key, value|
-              send(:"#{key}=", value)
-            end
-          end
-        elsif block_given?
-          yield self
-        else
-          options.each do |key, value|
-            send(:"#{key}=", value)
-          end
-        end
-        self
-      end
-
-      # Checks if given credentials are valid and raises an error if not.
-      #
-      def validate_credentials!
-        raise "you have to configure ASIN: 'configure :secret => 'your-secret', :key => 'your-key'" if blank?(:secret) || blank?(:key)
-        [:host, :item_type, :cart_type, :node_type, :version, :associate_tag].each { |item| raise "nil is not a valid value for #{item}" unless self.send item }
-      end
 
-      # Resets configuration to defaults
-      #
-      def reset
-        init_config(true)
-      end
-
-      # Check if a key is set
-      #
-      def blank?(key)
-        val = self.send :key
-        val.nil? || val.empty?
-      end
-
-      private()
-
-      def init_config(force=false)
-        return if @init && !force
-        @init          = true
-        @secret        = ''
-        @key           = ''
-        @host          = 'webservices.amazon.com'
-        @logger        = Logger.new(STDERR)
-        @item_type     = SimpleItem
-        @cart_type     = SimpleCart
-        @node_type     = SimpleNode
-        @version       = '2010-11-01'
-        @associate_tag = ''
-      end
-    end
+  # Rails initializer configuration.
+  #
+  # Expects at least +secret+ and +key+ for the API call:
+  #
+  #   ASIN::Configuration.configure do |config|
+  #     config.secret = 'your-secret'
+  #     config.key    = 'your-key'
+  #   end
+  #
+  # With the latest version of the Product Advertising API you need to include your associate_tag[https://affiliate-program.amazon.com/gp/advertising/api/detail/api-changes.html].
+  #
+  # You may pass options as a hash as well:
+  #
+  #   ASIN::Configuration.configure :secret => 'your-secret', :key => 'your-key'
+  #
+  # Or configure everything using YAML:
+  #
+  #   ASIN::Configuration.configure :yaml => 'config/asin.yml'
+  #
+  #   ASIN::Configuration.configure :yaml => 'config/asin.yml' do |config, yml|
+  #     config.key = yml[Rails.env]['aws_access_key']
+  #   end
+  #
+  # ==== Options:
+  #
+  # [secret] the API secret key (required)
+  # [key] the API access key (required)
+  # [associate_tag] your Amazon associate tag. Default is blank (required in latest API version)
+  # [host] the host, which defaults to 'webservices.amazon.com'
+  # [logger] a different logger than logging to STDERR (nil for no logging)
+  # [version] a custom version of the API calls. Default is 2010-11-01
+  # [item_type] a different class for SimpleItem, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
+  # [cart_type] a different class for SimpleCart, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
+  # [node_type] a different class for SimpleNode, use :mash / :rash for Hashie::Mash / Hashie::Rash or :raw for a plain hash
+  #
+  class Configuration
+    include Confiture::Configuration
+    confiture_allowed_keys(:secret, :key, :host, :version, :associate_tag, :logger, :item_type, :cart_type, :node_type)
+    confiture_mandatory_keys(:secret, :key)
+    confiture_defaults({
+      :secret        => '',
+      :key           => '',
+      :host          => 'webservices.amazon.com',
+      :version       => '2010-11-01',
+      :associate_tag => '',
+      :logger        => Logger.new(STDERR),
+      :item_type     => SimpleItem,
+      :cart_type     => SimpleCart,
+      :node_type     => SimpleNode,
+    })
   end
 end

data/lib/asin/version.rb

@@ -1,3 +1,3 @@
 module ASIN
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/rakefile.rb

@@ -1,6 +1,5 @@
 require "bundler"
-require "rake/rdoctask"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 Bundler::GemHelper.install_tasks
 
@@ -9,9 +8,4 @@ RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
 
-Rake::RDocTask.new(:rdoc_dev) do |rd|
-  rd.rdoc_files.include(File.readlines('.document').map(&:strip))
-  rd.options + ['-a', '--line-numbers', '--charset=UTF-8']
-end
-
 task :default=>:spec