a2z 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## A2z 0.0.3 (Dec 30, 2012)
+
+* Add `small_image`, `medium_image`, and `large_image` accessors on `Item`,
+  populating them when present in an item lookup or item search API response.
+  *Matt Huggins*
+
+* Add `image_sets` accessor on `Item`, populating them when present in an item
+  lookup or item search API response. *Matt Huggins*
+
+* Add `Item#parent_asin` method to retrieve ASIN for parent item when
+  available. *Matt Huggins*
+
+* Create this change log file. *Matt Huggins*
+
+## A2z 0.0.2 (Dec 29, 2012)
+
+* Create `Item#keys` method & dynamic boolean methods to check for item
+  attribute existence. *Matt Huggins*
+
+## A2z 0.0.1 (Dec 27, 2012)
+
+* Initial release. *Matt Huggins*

data/README.md

@@ -219,6 +219,69 @@ For example:
     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
+will also have their `small_image`, `medium_image`, `large_image`, and
+`image_sets` attributes populated, assuming they are included in the API
+response.
+
+    response = client.item_lookup do
+      id 'B008VVEJNE'
+      response_group 'Images'
+    end
+    
+    item = response.item
+    
+    item.small_image           # => #<A2z::Responses::Image ...>
+    item.medium_image          # => #<A2z::Responses::Image ...>
+    item.large_image           # => #<A2z::Responses::Image ...>
+    
+    item.image_sets.size       # => 2
+    item.image_sets.keys       # => [:primary, :variant]
+    item.image_sets[:primary]  # => #<A2z::Responses::ImageSet ...>
+
+Refer to the Image Sets and Images sections below for more information on using
+this objects.
+
+### Image Sets
+
+Image sets are accessible on items when the "Images" responses group is
+included as part of an item lookup or item search request.  Image sets are
+relatively simple objects, only including a category name and hash of images
+keyed by size.
+
+For example:
+
+    response = client.item_lookup do
+      id 'B008VVEJNE'
+      response_group 'Images'
+    end
+    
+    item_set = response.item.image_sets[:primary]
+    
+    item_set.category         # => "primary"
+    item_set.images.keys      # => [:swatch, :small, :thumbnail, :tiny, :medium, :large]
+    item_set.images[:swatch]  # => #<A2z::Responses::Image ...>
+
+Refer to the Images section below for more information on using this objects.
+
+### Images
+
+Images are accessible on items and through item sets when the "Images" response
+group is included as part of an item lookup or item search request.  Images
+include only vital information, including the URL, width, and height in pixels.
+
+For example:
+
+    response = client.item_lookup do
+      id 'B008VVEJNE'
+      response_group 'Images'
+    end
+    
+    image = response.item.large_image
+    image.url     # => "http://ecx.images-amazon.com/images/I/411%2BCDuXoSL.jpg"
+    image.width   # => 297
+    image.height  # => 500
+
 ### Operation Requests
 
 Item lookup and item search response objects include an

data/lib/a2z/responses.rb

@@ -1,3 +1,5 @@
+require 'a2z/responses/image'
+require 'a2z/responses/image_set'
 require 'a2z/responses/item'
 require 'a2z/responses/item_link'
 require 'a2z/responses/item_lookup'

data/lib/a2z/responses/image.rb

@@ -0,0 +1,24 @@
+module A2z
+  module Responses
+    class Image
+      attr_accessor :url, :width, :height
+      
+      def width=(value)
+        @width = value.to_i
+      end
+      
+      def height=(value)
+        @height = value.to_i
+      end
+      
+      def self.from_response(data)
+        new.tap do |image|
+          image.url = data['URL']
+          image.width = data['Width']
+          image.height = data['Height']
+          image.freeze
+        end
+      end
+    end
+  end
+end

data/lib/a2z/responses/image_set.rb

@@ -0,0 +1,28 @@
+module A2z
+  module Responses
+    class ImageSet
+      include Helpers
+      
+      attr_accessor :category, :images
+      
+      def initialize
+        @images = {}
+      end
+      
+      def self.from_response(data)
+        new.tap do |image_set|
+          image_set.category = data['Category']
+          
+          data.each_pair do |key, value|
+            if key =~ /\A(.+)Image\z/
+              name = underscore($1).to_sym
+              image_set.images[name] = Image.from_response(value)
+            end
+          end
+
+          image_set.freeze
+        end
+      end
+    end
+  end
+end

data/lib/a2z/responses/item.rb

@@ -3,11 +3,13 @@ module A2z
     class Item
       include Helpers
       
-      attr_accessor :asin, :detail_page_url, :links
+      attr_accessor :asin, :parent_asin, :detail_page_url, :links, :image_sets,
+                    :small_image, :medium_image, :large_image
       
       def initialize
         @links = []
         @attrs = {}
+        @image_sets = {}
       end
       
       def keys
@@ -45,6 +47,7 @@ module A2z
       def self.from_response(data)
         new.tap do |item|
           item.asin = data['ASIN']
+          item.parent_asin = data['ParentASIN']
           item.detail_page_url = data['DetailPageURL']
           
           if data['ItemLinks']
@@ -55,6 +58,20 @@ module A2z
             data['ItemAttributes'].each { |key, value| item[underscore(key)] = value }
           end
           
+          if data['ImageSets'] && data['ImageSets']['ImageSet']
+            image_sets = data['ImageSets']['ImageSet']
+            image_sets = [image_sets] unless image_sets.kind_of?(Array)
+            
+            image_sets.each do |image_set|
+              image_set = ImageSet.from_response(image_set)
+              item.image_sets[image_set.category.to_sym] = image_set
+            end
+          end
+          
+          item.small_image = Image.from_response(data['SmallImage']) if data['SmallImage']
+          item.medium_image = Image.from_response(data['MediumImage']) if data['MediumImage']
+          item.large_image = Image.from_response(data['LargeImage']) if data['LargeImage']
+          
           item.freeze
         end
       end

data/lib/a2z/version.rb

@@ -1,3 +1,3 @@
 module A2z
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/a2z/responses/image_set_spec.rb

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

data/spec/a2z/responses/image_spec.rb

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

data/spec/a2z/responses/item_link_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe A2z::Responses::ItemLink do
   subject do
-    A2z::Responses::ItemLink.from_response(item_hash)
+    A2z::Responses::ItemLink.from_response(item_link_hash)
   end
   
-  let(:item_hash) { Hash.new }
+  let(:item_link_hash) { Hash.new }
   
   describe '.from_response' do
     it 'should return an item link object'

data/spec/a2z/responses/item_lookup_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe A2z::Responses::ItemLookup do
   subject do
-    A2z::Responses::ItemLookup.from_response(item_hash)
+    A2z::Responses::ItemLookup.from_response(item_lookup_hash)
   end
   
-  let(:item_hash) { Hash.new }
+  let(:item_lookup_hash) { Hash.new }
   
   describe '.from_response' do
     it 'should return an item lookup object'

data/spec/a2z/responses/item_search_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 
 describe A2z::Responses::ItemSearch do
   subject do
-    A2z::Responses::ItemSearch.from_response(item_hash)
+    A2z::Responses::ItemSearch.from_response(item_search_hash)
   end
   
-  let(:item_hash) { Hash.new }
+  let(:item_search_hash) { Hash.new }
   
   describe '.from_response' do
     it 'should return an item search object'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: a2z
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Matt Huggins
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-29 00:00:00 -05:00
+date: 2012-12-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -98,6 +99,8 @@ files:
 - lib/a2z/requests/item_search.rb
 - lib/a2z/requests/response_group.rb
 - lib/a2z/responses.rb
+- lib/a2z/responses/image.rb
+- lib/a2z/responses/image_set.rb
 - lib/a2z/responses/item.rb
 - lib/a2z/responses/item_link.rb
 - lib/a2z/responses/item_lookup.rb
@@ -108,6 +111,8 @@ files:
 - spec/a2z/requests/item_lookup_spec.rb
 - spec/a2z/requests/item_search_spec.rb
 - spec/a2z/requests/response_group_spec.rb
+- spec/a2z/responses/image_set_spec.rb
+- spec/a2z/responses/image_spec.rb
 - spec/a2z/responses/item_link_spec.rb
 - spec/a2z/responses/item_lookup_spec.rb
 - spec/a2z/responses/item_search_spec.rb
@@ -155,6 +160,8 @@ test_files:
 - spec/a2z/requests/item_lookup_spec.rb
 - spec/a2z/requests/item_search_spec.rb
 - spec/a2z/requests/response_group_spec.rb
+- spec/a2z/responses/image_set_spec.rb
+- spec/a2z/responses/image_spec.rb
 - spec/a2z/responses/item_link_spec.rb
 - spec/a2z/responses/item_lookup_spec.rb
 - spec/a2z/responses/item_search_spec.rb