a2z 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## A2z 0.1.1 (Jan 3, 2012)
+
+* Add `offers` and `offer_summary` accessors on `Item`, populating them when
+  present in an item lookup or item search API response. *Matt Huggins*
+
 ## A2z 0.1.0 (Jan 3, 2012)
 
 * Add `editorial_reviews` accessor on `Item`, populating them when present in

data/README.md

@@ -216,18 +216,26 @@ For example:
 
     response = client.item_search { ... }  # => #<A2z::Responses::ItemSearch ...>
     item = response.items.first            # => #<A2z::Responses::Item ...>
+    
     item.asin                              # => "B008FERRFO"
-    item.title                             # => "Away From The World (Deluxe Version)"
-    item.keys                              # => ["artist", "manufacturer", "product_group"]
+    item.keys                              # => ["artist", "manufacturer", "product_group", "title"]
+    item.title?                            # => true
     item.artist?                           # => true
     item.manufacturer?                     # => true
     item.product_group?                    # => true
     item.composer?                         # => false
+    item.title                             # => "Away From The World (Deluxe Version)"
     item.artist                            # => "Dave Matthews Band"
     item.manufacturer                      # => "RCA"
     item.product_group                     # => "Music"
+    
     item.editorial_reviews.size            # => 1
     item.editorial_reviews.first           # => #<A2z::Responses::EditorialReview ...>
+    
+    item.offers.size                       # => 1
+    item.offers.first                      # => #<A2z::Responses::Offer ...>
+    item.offer_summary                     # => #<A2z::Responses::OfferSummary ...>
+    
     item.detail_page_url                   # => "http://www.amazon.com/Away-From-World-Deluxe-Version/dp/B008FERRFO..."
 
 When an item lookup or item search includes the "Images" response group, items
@@ -251,7 +259,7 @@ response.
     item.image_sets[:primary]              # => #<A2z::Responses::ImageSet ...>
 
 Refer to the Image Sets and Images sections below for more information on using
-this objects.
+these objects.
 
 ### Image Sets
 
@@ -292,6 +300,49 @@ For example:
     image.width                            # => 297
     image.height                           # => 500
 
+### Offers
+
+Offers are accessible on items when the "Offers", "OfferListings", or
+"OfferFull" response group is included as part of an item lookup or item search
+request.
+
+    offer = item.offers.first              # => #<A2z::Responses::Offer ...>
+    
+    offer.price                            # => #<Money fractional:699 currency:USD>
+    offer.price.format                     # => "$6.99"
+    
+    offer.amount_saved                     # => #<Money fractional:699 currency:USD>
+    offer.amount_saved.format              # => "$6.99"
+    
+    offer.percentage_saved                 # => 50
+    
+    offer.listing_id                       # => "oRHYBpasjoYr7hV0Ji5g6wjyJVv4xj1ZKnYRnsLsdzvcYotTARQNNueaVBzRP2CJCq..."
+    offer.condition                        # => "New"
+    offer.availability                     # => "Usually ships in 24 hours"
+    offer.super_saver_shipping_eligible?   # => true
+
+For more help on working with Money objects, refer to the
+[RubyMoney gem page](http://rubymoney.github.com/money/).
+
+### Offer Summaries
+
+Offer summaries are accessible on items when the "Offers", "OfferFull", or
+"OfferSummary" response group is included as part of an item lookup or item
+search request.
+
+    offer_summary = item.offer_summary     # => #<A2z::Responses::OfferSummary ...>
+    
+    offer_summary.lowest_new_price         # => #<Money fractional:699 currency:USD>
+    offer_summary.lowest_used_price        # => #<Money fractional:699 currency:USD>
+    
+    offer_summary.total_new                # => 28
+    offer_summary.total_used               # => 17
+    offer_summary.total_collectible        # => 0
+    offer_summary.total_refurbished        # => 0
+
+For more help on working with Money objects, refer to the
+[RubyMoney gem page](http://rubymoney.github.com/money/).
+
 ### Editorial Reviews
 
 Editorial reviews are accessible on items when the "EditorialResponse" response
@@ -304,7 +355,7 @@ response objects only include the source and the content.
 
 ### Operation Requests
 
-Item lookup and item search response objects include an
+Item lookup, item search, and browse node lookup response objects include an
 `A2z::Responses::OperationRequest` accessible via the `#operation_request`
 instance method.
 

data/a2z.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   
   gem.add_dependency 'crack'
   gem.add_dependency 'jeff'
+  gem.add_dependency 'money'
   
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/lib/a2z/responses.rb

@@ -7,4 +7,6 @@ require 'a2z/responses/item'
 require 'a2z/responses/item_link'
 require 'a2z/responses/item_lookup'
 require 'a2z/responses/item_search'
+require 'a2z/responses/offer'
+require 'a2z/responses/offer_summary'
 require 'a2z/responses/operation_request'

data/lib/a2z/responses/item.rb

@@ -4,13 +4,15 @@ module A2z
       include Helpers
       
       attr_accessor :asin, :parent_asin, :detail_page_url, :links, :image_sets,
-                    :small_image, :medium_image, :large_image, :editorial_reviews
+                    :small_image, :medium_image, :large_image, :editorial_reviews,
+                    :offers, :offer_summary
       
       def initialize
         @links = []
         @attrs = {}
         @image_sets = {}
         @editorial_reviews = []
+        @offers = []
       end
       
       def keys
@@ -55,7 +57,9 @@ module A2z
           item.medium_image = Image.from_response(data['MediumImage']) if data['MediumImage']
           item.large_image = Image.from_response(data['LargeImage']) if data['LargeImage']
           
-          if data['ItemLinks']
+          item.offer_summary = OfferSummary.from_response(data['OfferSummary']) if data['OfferSummary']
+          
+          if data['ItemLinks'] && data['ItemLinks']['ItemLink']
             item_links = array_wrap(data['ItemLinks']['ItemLink'])
             item.links = item_links.collect { |link| ItemLink.from_response(link) }
           end
@@ -77,6 +81,11 @@ module A2z
             item.editorial_reviews = reviews.collect { |review| EditorialReview.from_response(review) }
           end
           
+          if data['Offers'] && data['Offers']['Offer']
+            offers = array_wrap(data['Offers']['Offer'])
+            item.offers = offers.collect { |offer| Offer.from_response(offer) }
+          end
+          
           item.freeze
         end
       end

data/lib/a2z/responses/offer.rb

@@ -0,0 +1,54 @@
+require 'money'
+
+module A2z
+  module Responses
+    class Offer
+      attr_accessor :listing_id, :condition, :price, :amount_saved,
+                    :percentage_saved, :availability
+      
+      def initialize
+        @price = Money.new(0, 'USD')
+        @amount_saved = Money.new(0, 'USD')
+        @percentage_saved = 0
+        @super_saver_shipping_eligible = false
+      end
+      
+      def price=(value)
+        value = Money.new(value, 'USD') unless value.kind_of?(Money)
+        @price = value
+      end
+      
+      def amount_saved=(value)
+        value = Money.new(value, 'USD') unless value.kind_of?(Money)
+        @amount_saved = value
+      end
+      
+      def super_saver_shipping_eligible=(value)
+        @super_saver_shipping_eligible = !!value
+      end
+      
+      def super_saver_shipping_eligible?
+        @super_saver_shipping_eligible
+      end
+      
+      def self.from_response(data)
+        new.tap do |offer|
+          if (attributes = data['OfferAttributes'])
+            offer.condition = attributes['Condition']
+          end
+          
+          if (listing = data['OfferListing'])
+            offer.listing_id = listing['OfferListingId']
+            offer.price = Money.new(listing['Price']['Amount'].to_i, listing['Price']['CurrencyCode']) if listing['Price']
+            offer.amount_saved = Money.new(listing['AmountSaved']['Amount'].to_i, listing['AmountSaved']['CurrencyCode']) if listing['AmountSaved']
+            offer.percentage_saved = listing['PercentageSaved'].to_i
+            offer.availability = listing['Availability']
+            offer.super_saver_shipping_eligible = listing['IsEligibleForSuperSaverShipping'] == '1'
+          end
+          
+          offer.freeze
+        end
+      end
+    end
+  end
+end

data/lib/a2z/responses/offer_summary.rb

@@ -0,0 +1,64 @@
+require 'money'
+
+module A2z
+  module Responses
+    class OfferSummary
+      attr_accessor :lowest_new_price, :lowest_used_price, :total_new,
+                    :total_used, :total_collectible, :total_refurbished
+      
+      def initialize
+        @lowest_new_price = Money.new(0, 'USD')
+        @lowest_used_price = Money.new(0, 'USD')
+        @total_new = 0
+        @total_used = 0
+        @total_collectible = 0
+        @total_refurbished = 0
+      end
+      
+      def lowest_new_price=(value)
+        value = Money.new(value, 'USD') unless value.kind_of?(Money)
+        @lowest_new_price = value
+      end
+      
+      def lowest_used_price=(value)
+        value = Money.new(value, 'USD') unless value.kind_of?(Money)
+        @lowest_used_price = value
+      end
+      
+      def total_new=(value)
+        @total_new = value.to_i
+      end
+      
+      def total_used=(value)
+        @total_used = value.to_i
+      end
+      
+      def total_collectible=(value)
+        @total_collectible = value.to_i
+      end
+      
+      def total_refurbished=(value)
+        @total_refurbished = value.to_i
+      end
+      
+      def self.from_response(data)
+        new.tap do |offer_summary|
+          if data['LowestNewPrice']
+            offer_summary.lowest_new_price = Money.new(data['LowestNewPrice']['Amount'].to_i, data['LowestNewPrice']['CurrencyCode'])
+          end
+          
+          if data['LowestUsedPrice']
+            offer_summary.lowest_used_price = Money.new(data['LowestNewPrice']['Amount'].to_i, data['LowestNewPrice']['CurrencyCode'])
+          end
+          
+          offer_summary.total_new = data['TotalNew']
+          offer_summary.total_used = data['TotalUsed']
+          offer_summary.total_collectible = data['TotalCollectible']
+          offer_summary.total_refurbished = data['TotalRefurbished']
+          
+          offer_summary.freeze
+        end
+      end
+    end
+  end
+end

data/lib/a2z/version.rb

@@ -1,3 +1,3 @@
 module A2z
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/a2z/responses/offer_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe A2z::Responses::Offer do
+  subject do
+    A2z::Responses::Offer.from_response(offer_hash)
+  end
+  
+  let(:offer_hash) { Hash.new }
+  
+  describe '.from_response' do
+    it 'should return an offer object'
+  end
+end

data/spec/a2z/responses/offer_summary_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe A2z::Responses::OfferSummary do
+  subject do
+    A2z::Responses::OfferSummary.from_response(offer_summary_hash)
+  end
+  
+  let(:offer_summary_hash) { Hash.new }
+  
+  describe '.from_response' do
+    it 'should return an offer summary object'
+  end
+end

data/spec/a2z/version_spec.rb

@@ -3,5 +3,5 @@ require 'spec_helper'
 describe A2z do
   subject { A2z }
   
-  specify { subject::VERSION.should == '0.1.0' }
+  specify { subject::VERSION.should == '0.1.1' }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: a2z
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crack
-  requirement: &2152624760 !ruby/object:Gem::Requirement
+  requirement: &2151907560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152624760
+  version_requirements: *2151907560
 - !ruby/object:Gem::Dependency
   name: jeff
-  requirement: &2152623600 !ruby/object:Gem::Requirement
+  requirement: &2151906660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152623600
+  version_requirements: *2151906660
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: &2151905960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151905960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152623080 !ruby/object:Gem::Requirement
+  requirement: &2151904760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152623080
+  version_requirements: *2151904760
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152622440 !ruby/object:Gem::Requirement
+  requirement: &2151902900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152622440
+  version_requirements: *2151902900
 description: Ruby DSL for Amazon Product Advertising API
 email: matt.huggins@gmail.com
 executables: []
@@ -88,6 +99,8 @@ files:
 - lib/a2z/responses/item_link.rb
 - lib/a2z/responses/item_lookup.rb
 - lib/a2z/responses/item_search.rb
+- lib/a2z/responses/offer.rb
+- lib/a2z/responses/offer_summary.rb
 - lib/a2z/responses/operation_request.rb
 - lib/a2z/version.rb
 - spec/a2z/client_spec.rb
@@ -104,6 +117,8 @@ files:
 - spec/a2z/responses/item_lookup_spec.rb
 - spec/a2z/responses/item_search_spec.rb
 - spec/a2z/responses/item_spec.rb
+- spec/a2z/responses/offer_spec.rb
+- spec/a2z/responses/offer_summary_spec.rb
 - spec/a2z/version_spec.rb
 - spec/spec_helper.rb
 - tasks/debug.rake
@@ -147,5 +162,7 @@ test_files:
 - spec/a2z/responses/item_lookup_spec.rb
 - spec/a2z/responses/item_search_spec.rb
 - spec/a2z/responses/item_spec.rb
+- spec/a2z/responses/offer_spec.rb
+- spec/a2z/responses/offer_summary_spec.rb
 - spec/a2z/version_spec.rb
 - spec/spec_helper.rb