asin 0.4.0.beta1 → 0.4.0

data/.document

@@ -1,2 +1,3 @@
-lib/*.rb
+lib/**/*.rb
 README.rdoc
+CHANGELOG.rdoc

data/CHANGELOG.rdoc

@@ -0,0 +1,25 @@
+== 0.4.0.beta2
+
+* add configuration option for item/cart class
+* add more functionality to item class
+
+== 0.4.0.beta1
+
+* added cart operations
+* added yml configuration
+
+== 0.3.0
+
+* add search_keywords method
+* open up search method to be more flexible
+
+== 0.2.0
+
+* rails initializer configuration
+* rpsec for tests
+
+== 0.1.0
+
+* add logger
+* use HTTPI as HTTP-adapter
+* use bundler for dependencies

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    asin (0.4.0.beta1)
+    asin (0.4.0)
       crack (~> 0.1.8)
       hashie (~> 1.0.0)
       httpi (~> 0.9.2)
@@ -17,27 +17,27 @@ GEM
       rspec (~> 2.0)
       rspec-instafail (~> 0.1.4)
     hashie (1.0.0)
-    httpclient (2.1.7.2)
-    httpi (0.9.2)
-      ntlm-http (>= 0.1.1)
+    httpclient (2.2.0.2)
+    httpi (0.9.4)
+      pyu-ntlm-http (>= 0.1.3.1)
       rack
-    ntlm-http (0.1.1)
+    pyu-ntlm-http (0.1.3.1)
     rack (1.2.2)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.1)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-instafail (0.1.7)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   asin!
-  fuubar (~> 0.0.3)
-  httpclient (~> 2.1.7.2)
-  rspec (~> 2.5.0)
+  fuubar (~> 0.0.4)
+  httpclient (~> 2.2.0.2)
+  rspec (~> 2.6.0)

data/README.rdoc

@@ -26,6 +26,8 @@ Inline style configuration:
   # or
   client.configure :secret => 'your-secret', :key => 'your-key'
 
+Have a look at ASIN::Configuration class for all the details.
+
 == Usage
 
 ASIN is designed as a module, so you can include it into any object you like:

data/asin.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency('hashie', '~> 1.0.0')
   s.add_dependency('httpi', '~> 0.9.2')
   
-  s.add_development_dependency('httpclient', '~> 2.1.7.2')
-  s.add_development_dependency('rspec', '~> 2.5.0')
-  s.add_development_dependency('fuubar', '~> 0.0.3')
+  s.add_development_dependency('httpclient', '~> 2.2.0.2')
+  s.add_development_dependency('rspec', '~> 2.6.0')
+  s.add_development_dependency('fuubar', '~> 0.0.4')
 end

data/lib/asin.rb

@@ -32,7 +32,7 @@ require 'asin/configuration'
 #
 # == Search
 #
-# After configuring your environment you can call the +lookup+ method to retrieve an +Item+ via the
+# After configuring your environment you can call the +lookup+ method to retrieve an +SimpleItem+ via the
 # Amazon Standard Identification Number (ASIN):
 #
 #   item = lookup '1430218150'
@@ -45,7 +45,7 @@ require 'asin/configuration'
 #   items.first.title
 #   => "Learn Objective-C on the Mac (Learn Series)"
 #
-# The +Item+ uses a Hashie::Mash as its internal data representation and you can get fetched data from it:
+# The +SimpleItem+ uses a Hashie::Mash as its internal data representation and you can get fetched data from it:
 #
 #   item.raw.ItemAttributes.ListPrice.FormattedPrice
 #   => "$39.99"
@@ -117,7 +117,7 @@ module ASIN
 
   # Performs an +ItemLookup+ REST call against the Amazon API.
   #
-  # Expects an ASIN (Amazon Standard Identification Number) and returns an +Item+:
+  # Expects an ASIN (Amazon Standard Identification Number) and returns an +SimpleItem+:
   #
   #   item = lookup '1430218150'
   #   item.title
@@ -129,14 +129,14 @@ module ASIN
   #
   #   lookup(asin, :ResponseGroup => :Medium)
   #
-  def lookup(asin, params={})
+  def lookup(asin, params={:ResponseGroup => :Medium})
     response = call(params.merge(:Operation => :ItemLookup, :ItemId => asin))
-    Item.new(response['ItemLookupResponse']['Items']['Item'])
+    handle_item(response['ItemLookupResponse']['Items']['Item'])
   end
 
   # Performs an +ItemSearch+ REST call against the Amazon API.
   #
-  # Expects a search-string which can be an arbitrary array of strings (ASINs f.e.) and returns a list of +Items+:
+  # Expects a search-string which can be an arbitrary array of strings (ASINs f.e.) and returns a list of +SimpleItem+s:
   #
   #   items = search_keywords 'Learn', 'Objective-C'
   #   items.first.title
@@ -151,14 +151,14 @@ module ASIN
   # Have a look at the different search index values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
   #
   def search_keywords(*keywords)
-    params = keywords.last.is_a?(Hash) ? keywords.pop : {:SearchIndex => :Books}
+    params = keywords.last.is_a?(Hash) ? keywords.pop : {:SearchIndex => :Books, :ResponseGroup => :Medium}
     response = call(params.merge(:Operation => :ItemSearch, :Keywords => keywords.join(' ')))
-    (response['ItemSearchResponse']['Items']['Item'] || []).map {|item| Item.new(item)}
+    (response['ItemSearchResponse']['Items']['Item'] || []).map {|item| handle_item(item)}
   end
 
   # Performs an +ItemSearch+ REST call against the Amazon API.
   #
-  # Expects a Hash of search params where and returns a list of +Items+:
+  # Expects a Hash of search params where and returns a list of +SimpleItem+s:
   #
   #   items = search :SearchIndex => :Music
   #
@@ -170,14 +170,14 @@ module ASIN
   #
   # Have a look at the different search index values on the Amazon-Documentation[http://docs.amazonwebservices.com/AWSEcommerceService/4-0/]
   #
-  def search(params={:SearchIndex => :Books})
+  def search(params={:SearchIndex => :Books, :ResponseGroup => :Medium})
     response = call(params.merge(:Operation => :ItemSearch))
-    (response['ItemSearchResponse']['Items']['Item'] || []).map {|item| Item.new(item)}
+    (response['ItemSearchResponse']['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 +Cart+:
+  # Expects one ore more item-hashes and returns a +SimpleCart+:
   #
   #   cart = create_cart({:asin => '1430218150', :quantity => 1})
   #
@@ -195,7 +195,7 @@ module ASIN
 
   # Performs an +CartGet+ REST call against the Amazon API.
   #
-  # Expects the CartId and the HMAC to identify the returning +Cart+:
+  # Expects the CartId and the HMAC to identify the returning +SimpleCart+:
   #
   #   cart = get_cart('176-9182855-2326919', 'KgeVCA0YJTbuN/7Ibakrk/KnHWA=')
   #
@@ -205,7 +205,7 @@ module ASIN
 
   # Performs an +CartAdd+ REST call against the Amazon API.
   #
-  # Expects a +Cart+ created with +create_cart+ and one ore more Item-Hashes and returns an updated +Cart+:
+  # Expects a +SimpleCart+ created with +create_cart+ and one ore more Item-Hashes and returns an updated +SimpleCart+:
   #
   #   cart = add_items(cart, {:asin => '1430216263', :quantity => 2})
   #
@@ -223,7 +223,7 @@ module ASIN
 
   # Performs an +CartModify+ REST call against the Amazon API.
   #
-  # Expects a +Cart+ created with +create_cart+ and one ore more Item-Hashes to modify and returns an updated +Cart+:
+  # Expects a +SimpleCart+ created with +create_cart+ and one ore more Item-Hashes to modify and returns an updated +SimpleCart+:
   #
   #   cart = update_items(cart, {:cart_item_id => cart.items.first.CartItemId, :quantity => 7})
   #
@@ -241,7 +241,7 @@ module ASIN
 
   # Performs an +CartClear+ REST call against the Amazon API.
   #
-  # Expects a +Cart+ created with +create_cart+ and returns an empty +Cart+:
+  # Expects a +SimpleCart+ created with +create_cart+ and returns an empty +SimpleCart+:
   #
   #   cart = clear_cart(cart)
   #
@@ -250,6 +250,10 @@ module ASIN
   end
 
   private
+  
+    def handle_item(item)
+      Configuration.item_type.is_a?(Class) ? Configuration.item_type.new(item) : item
+    end
 
     def create_item_params(items)
       keyword_mappings = {
@@ -271,7 +275,8 @@ module ASIN
 
     def cart(operation, params={})
       response = call(params.merge(:Operation => operation))
-      Cart.new(response["#{operation}Response"]['Cart'])
+      cart = response["#{operation}Response"]['Cart']
+      Configuration.cart_type.is_a?(Class) ? Configuration.cart_type.new(cart) : cart
     end
 
 

data/lib/asin/cart.rb

@@ -2,13 +2,13 @@ require 'hashie'
 
 module ASIN
 
-  # = Cart
+  # = SimpleCart
   #
-  # The +Cart+ class is a wrapper for the Amazon XML-REST-Response.
+  # The +SimpleCart+ class is a wrapper for the Amazon XML-REST-Response.
   #
   # A Hashie::Mash is used for the internal data representation and can be accessed over the +raw+ attribute.
   #
-  class Cart
+  class SimpleCart
 
     attr_reader :raw
 

data/lib/asin/configuration.rb

@@ -5,6 +5,7 @@ module ASIN
     class << self
 
       attr_accessor :secret, :key, :host, :logger
+      attr_accessor :item_type, :cart_type
 
       # Rails initializer configuration.
       #
@@ -33,6 +34,8 @@ module ASIN
       # [key] the API access key
       # [host] the host, which defaults to 'webservices.amazon.com'
       # [logger] a different logger than logging to STDERR (nil for no logging)
+      # [item_type] a different class for SimpleItem, use :raw for a plain mash
+      # [cart_type] a different class for SimpleCart, use :raw for a plain mash
       #
       def configure(options={})
         init_config
@@ -65,11 +68,13 @@ module ASIN
 
         def init_config(force=false)
           return if @init && !force
-          @init   = true
-          @secret = ''
-          @key    = ''
-          @host   = 'webservices.amazon.com'
-          @logger = Logger.new(STDERR)
+          @init       = true
+          @secret     = ''
+          @key        = ''
+          @host       = 'webservices.amazon.com'
+          @logger     = Logger.new(STDERR)
+          @item_type  = SimpleItem
+          @cart_type  = SimpleCart
         end
     end
   end

data/lib/asin/item.rb

@@ -2,13 +2,13 @@ require 'hashie'
 
 module ASIN
 
-  # =Item
+  # =SimpleItem
   #
-  # The +Item+ class is a wrapper for the Amazon XML-REST-Response.
+  # The +SimpleItem+ class is a wrapper for the Amazon XML-REST-Response.
   #
   # A Hashie::Mash is used for the internal data representation and can be accessed over the +raw+ attribute.
   #
-  class Item
+  class SimpleItem
 
     attr_reader :raw
 
@@ -16,8 +16,28 @@ module ASIN
       @raw = Hashie::Mash.new(hash)
     end
 
+    def asin
+      @raw.ASIN
+    end
+
     def title
-      @raw.ItemAttributes.Title
+      @raw.ItemAttributes!.Title
+    end
+
+    def amount
+      @raw.ItemAttributes!.ListPrice!.Amount.to_i
+    end
+
+    def details_url
+      @raw.DetailPageURL
+    end
+
+    def review
+       @raw.EditorialReviews!.EditorialReview!.Content
+    end
+
+    def image_url
+      @raw.LargeImage!.URL
     end
   end
 

data/lib/asin/version.rb

@@ -1,3 +1,3 @@
 module ASIN
-  VERSION = "0.4.0.beta1"
+  VERSION = "0.4.0"
 end

data/rakefile.rb

@@ -10,7 +10,7 @@ RSpec::Core::RakeTask.new do |t|
 end
 
 Rake::RDocTask.new(:rdoc_dev) do |rd|
-  rd.rdoc_files.include("lib/**/*.rb", "README.rdoc")
+  rd.rdoc_files.include(File.readlines('.document').map(&:strip))
   rd.options + ['-a', '--inline-source', '--charset=UTF-8']
 end
 

data/spec/cart_spec.rb

@@ -62,7 +62,7 @@ module ASIN
 
       end
 
-      context Cart do
+      context SimpleCart do
 
         before do
           @helper.configure :secret => @secret, :key => @key
@@ -139,7 +139,7 @@ module ASIN
         end
 
         it "should handle response data" do
-          cart = Cart.new(@two_items)
+          cart = SimpleCart.new(@two_items)
           cart.valid?.should be(true)
           cart.cart_id.should eql('186-8702292-9782208')
           cart.hmac.should eql('Ck5MXUE+OQiC/Jh8u6NhBf5FbV8=')
@@ -149,7 +149,7 @@ module ASIN
         end
 
         it "should handle one item" do
-          cart = Cart.new(@two_items)
+          cart = SimpleCart.new(@two_items)
           cart.items.first.CartItemId eql('U3G241HVLLB8N6')
         end
 

data/spec/search_spec.rb

@@ -65,6 +65,34 @@ module ASIN
         item.title.should =~ /Learn Objective/
       end
 
+      it "should have metadata" do
+        item = @helper.lookup(ANY_ASIN, :ResponseGroup => :Medium)
+        item.asin.should eql(ANY_ASIN)
+        item.title.should =~ /Learn Objective/
+        item.amount.should eql(3999)
+        item.details_url.should eql('http://www.amazon.com/Learn-Objective-C-Mac-Mark-Dalrymple/dp/1430218150%3FSubscriptionId%3DAKIAJFA5X7RTOKFNPVZQ%26tag%3Dws%26linkCode%3Dxm2%26camp%3D2025%26creative%3D165953%26creativeASIN%3D1430218150')
+        item.image_url.should eql('http://ecx.images-amazon.com/images/I/41kq5bDvnUL.jpg')
+        item.review.should =~ /Learn Objective-C on the Macintosh/
+      end
+
+      it "should return a custom item class" do
+        module TEST
+          class TestItem
+            attr_accessor :testo
+            def initialize(hash)
+              @testo = hash
+            end
+          end
+        end
+        @helper.configure :item_type => TEST::TestItem
+        @helper.lookup(ANY_ASIN).testo.should_not be_nil
+      end
+
+      it "should return a raw value" do
+        @helper.configure :item_type => :raw
+        @helper.lookup(ANY_ASIN)['ItemAttributes']['Title'].should_not be_nil
+      end
+
       it "should search_keywords a book with fulltext" do
         items = @helper.search_keywords 'Learn', 'Objective-C'
         items.should have(10).things
@@ -74,7 +102,7 @@ module ASIN
 
       it "should search_keywords never mind music" do
         items = @helper.search_keywords 'nirvana', 'never mind', :SearchIndex => :Music
-        items.should have(9).things
+        items.should have(8).things
 
         items.first.title.should =~ /Nevermind/
       end

data/spec/spec_helper.rb

@@ -6,6 +6,6 @@ require 'pp'
 ANY_ASIN    = '1430218150'
 OTHER_ASIN  = '1430216263'
 
-Rspec.configure do |c|
+RSpec.configure do |c|
   c.mock_with :rspec
 end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: asin
 version: !ruby/object:Gem::Version 
-  prerelease: 6
-  version: 0.4.0.beta1
+  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Peter Schr\xC3\xB6der"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 +02:00
+date: 2011-05-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.1.7.2
+        version: 2.2.0.2
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -65,7 +65,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.0
+        version: 2.6.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -76,7 +76,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.0.3
+        version: 0.0.4
   type: :development
   version_requirements: *id006
 description: Amazon Simple INterface.
@@ -92,6 +92,7 @@ files:
 - .document
 - .gitignore
 - .rvmrc
+- CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - README.rdoc
@@ -124,9 +125,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
 requirements: []
 
 rubyforge_project: asin