asin 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abef77f2e50d6a015876901fb59472be004cce65
-  data.tar.gz: c754d67ee4606e8391b6b664335ab88da865caef
+  metadata.gz: 00b2605291551bb77e09ebf2bf7f60fa0d7ec6c3
+  data.tar.gz: 63d7a88fffc477049a4e1419e3d761133f35cc5f
 SHA512:
-  metadata.gz: 078a4412405820ee2950741ee800611e42e39abf9f026c14d4704466ee4079d6fdca5e2897570a14fd334fba2ee65cce0445d765ded0a93858d93af7819970c3
-  data.tar.gz: b33aac2017be20aac7bd6946e0ff407ab5ef01469e77f76516d4b64225e662983cfcffe89a21315014537166434e587eacb01d3ccc774f05bfcfa61495d1d4bf
+  metadata.gz: 0250269c613eca2fc754638bedeb58b5b05719d954e2e57534e76fb16863972bff9bce3e3604808060ad9108b2039b66d7d447d76b4c4ac2d6c18c3f9743084a
+  data.tar.gz: 4bcb447e52f21214adb88c0e3b19d96399e3305fa02a1b95352f98a0eab394b55fc974d164c5d536d54f1e5a149301ce54a6b2d752f9298e29c1c6481b9db657

data/.gitignore

@@ -4,3 +4,4 @@ pkg
 .DS_Store
 .bundle
 .rvmrc
+coverage

data/.irbrc

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path('lib')
+
+require 'asin'
+
+ASIN::Configuration.configure do |config|
+  config.secret        = ENV['ASIN_SECRET']
+  config.key           = ENV['ASIN_KEY']
+  config.associate_tag = ENV['ASIN_TAG']
+end
+
+@client = ASIN::Client.instance
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -1,6 +1,5 @@
 script: "bundle exec rake"
 rvm:
-  - 1.9.3
+  - 2.0.0
+  - 2.1.0
   - jruby-19mode
-  - rbx-19mode
-  - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.0.0
+
+* configurable items are no longer supported, in favor of Hashie::Rash, see upgrading instructions
+
+## 1.2.0
+
+* Added more methods to simplify accessing certain nodes. (kyletcarlson) https://github.com/phoet/asin/pull/30
+
 ## 1.1.2
 
 * compatibility update https://github.com/phoet/asin/issues/22

data/Gemfile

@@ -2,3 +2,8 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in asin.gemspec
 gemspec
+
+group :development do
+  gem 'pry-plus', platforms: :ruby
+  gem 'coveralls'
+end

data/Gemfile.lock

@@ -1,36 +1,84 @@
 PATH
   remote: .
   specs:
-    asin (1.1.0)
+    asin (1.2.0)
       confiture (>= 0.1)
       crack (>= 0.3)
       hashie (>= 1.1)
       httpi (>= 0.9)
+      rash (>= 0.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.3.2)
-    coderay (1.0.8)
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    bond (0.5.1)
+    coderay (1.1.0)
+    colorize (0.5.8)
+    columnize (0.3.6)
     confiture (0.1.4)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
     crack (0.3.1)
+    debug_inspector (0.0.2)
+    debugger (1.6.6)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.2)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.2)
     diff-lcs (1.1.3)
-    hashie (1.2.0)
+    hashie (2.0.5)
     httpclient (2.3.0.1)
-    httpi (2.0.0)
+    httpi (2.1.0)
       rack
-    method_source (0.8.1)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
+      rubyntlm (~> 0.3.2)
+    interception (0.5)
+    jist (1.5.1)
+      json
+    json (1.8.1)
+    method_source (0.8.2)
+    mime-types (1.23)
+    multi_json (1.7.6)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
       method_source (~> 0.8)
-      slop (~> 3.3.1)
-    pry (0.9.10-java)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
-      spoon (~> 0.0)
-    rack (1.4.1)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    pry-doc (0.6.0)
+      pry (~> 0.9)
+      yard (~> 0.8)
+    pry-docmore (0.1.1)
+      pry
+      pry-doc
+    pry-plus (1.0.0)
+      bond
+      jist
+      pry-debugger
+      pry-doc
+      pry-docmore
+      pry-rescue
+      pry-stack_explorer
+    pry-rescue (1.4.0)
+      interception (>= 0.4)
+      pry
+    pry-stack_explorer (0.4.9.1)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rack (1.5.2)
     rake (0.9.2.2)
+    rash (0.4.0)
+      hashie (~> 2.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -39,12 +87,18 @@ GEM
     rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.3)
-    slop (3.3.3)
-    spoon (0.0.1)
+    rubyntlm (0.3.4)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.5.0)
+    thor (0.18.1)
     vcr (2.2.5)
     webmock (1.8.11)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
+    yard (0.8.7.3)
 
 PLATFORMS
   java
@@ -52,8 +106,9 @@ PLATFORMS
 
 DEPENDENCIES
   asin!
+  coveralls
   httpclient (>= 2.2.3)
-  pry (~> 0.9.9)
+  pry-plus
   rake (~> 0.9.2.2)
   rspec (~> 2.11.0)
   vcr (~> 2.2.5)

data/README.md

@@ -1,6 +1,8 @@
 ## Infos
 
-[![Build Status](https://secure.travis-ci.org/phoet/asin.png)](http://travis-ci.org/phoet/asin)
+[![Build Status](https://img.shields.io/travis/phoet/asin/master.svg)](https://travis-ci.org/phoet/asin)
+[![Code Climate](https://img.shields.io/codeclimate/github/phoet/asin.svg)](https://codeclimate.com/github/phoet/asin)
+[![Coverage Status](https://img.shields.io/coveralls/phoet/asin/master.svg)](https://coveralls.io/r/phoet/asin?branch=master)
 
 ASIN is a simple, extensible wrapper for parts of the REST-API of Amazon Product Advertising API (aka Associates Web Service aka Amazon E-Commerce Service).
 
@@ -10,6 +12,19 @@ Have a look at the [RDOC](http://rdoc.info/projects/phoet/asin) for this project
 
 The gem runs smoothly with Rails 3 and is tested against multiple rubies. See *.travis.yml* for details.
 
+
+## Upgrading from Version 1.x
+
+Version 2 removes all the SimpleXXX classes in favor of Hashie::Rash.
+
+The old api is available if you require the ASIN::Adapter
+
+    require 'asin'
+    require 'asin/adapter'
+
+It's also a good starting point for looking into writing your own API adapter.
+
+
 ## Installation
 
     gem install asin
@@ -20,6 +35,7 @@ or in your Gemfile:
     gem 'asin'
     gem 'httpclient' # optional, see HTTPI
 
+
 ## Configuration
 
 Rails style initializer (config/initializers/asin.rb):
@@ -32,6 +48,7 @@ Rails style initializer (config/initializers/asin.rb):
 
 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:
@@ -58,23 +75,19 @@ But you can also use the *instance* method to get a proxy-object:
     items = client.lookup '1430218150'
     
     # have a look at the title of the item
-    items.first.title
+    items.first.item_attributes.title
     => Learn Objective-C on the Mac (Learn Series)
     
     # search for any kind of stuff on amazon with keywords
     items = search_keywords 'Learn', 'Objective-C'
-    items.first.title
+    items.first.item_attributes.title
     => "Learn Objective-C on the Mac (Learn Series)"
     
     # search for any kind of stuff on amazon with custom parameters
     search :Keywords => 'Learn Objective-C', :SearchIndex => :Books
-    items.first.title
+    items.first.item_attributes.title
     => "Learn Objective-C on the Mac (Learn Series)"
     
-    # 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'
 
@@ -84,51 +97,31 @@ There is an additional set of methods to support AWS cart operations:
     
     # create a cart with an item
     cart = client.create_cart({:asin => '1430218150', :quantity => 1})
-    cart.items
-    => [<#Hashie::Mash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
-    
-    # get an already existing cart from a CartId and HMAC
-    cart = client.get_cart('176-9182855-2326919', 'KgeVCA0YJTbuN/7Ibakrk/KnHWA=')
-    cart.empty?
-    => false
+    cart.cart_items.cart_item
+    => [<#Hashie::Rash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
     
     # clear everything from the cart
     cart = client.clear_cart(cart)
-    cart.empty?
-    => true
-    
-    # add items to the cart
-    cart = client.add_items(cart, {:asin => '1430216263', :quantity => 2})
-    cart.empty?
-    => false
+    cart.cart_items.cart_item
+    => []
     
     # update items in the cart
     cart = client.update_items(cart, {:cart_item_id => cart.items.first.CartItemId, :action => :SaveForLater}, {:cart_item_id => cart.items.first.CartItemId, :quantity => 7})
-    cart.saved_items
-    => [<#Hashie::Mash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
+    cart.saved_for_later_items.saved_for_later_item
+    => [<#Hashie::Rash ASIN="1430218150" CartItemId="U3G241HVLLB8N6" ... >]
 
 It's also possible to access browse nodes:
 
     client = ASIN::Client.instance
     
     # create a cart with an item
-    node = client.browse_node('163357', :ResponseGroup => :TopSellers)
-    node.node_id
+    node = client.browse_node('17', :ResponseGroup => :TopSellers)
+    node.first.browse_node_id
     => '163357'
-    node.name
-    => 'Comedy'
+    node.first.name
+    => 'Literature & Fiction'
 
-## Response Configuration
 
-ASIN is customizable in the way it returns Responses from Amazon.
-By default it will return *SimpleItem*, *SimpleCart* or *SimpleNode* instances,
-but you can override this behavior for using your custom Classes:
-
-    client.configure :item_type => YourItemClass
-    client.configure :cart_type => YourCartClass
-    client.configure :node_type => YourNodeClass
-
-You can also use built-in *:raw*, *:mash* types.
 ## HTTPI
 
 ASIN uses [HTTPI](https://github.com/rubiii/httpi) as a HTTP-Client adapter.
@@ -137,11 +130,13 @@ As a default HTTPI uses _httpclient_ so you should add that dependency to your p
 
     gem 'httpclient'
 
+
 ## Confiture
 
 ASIN uses [Confiture](https://github.com/phoet/confiture) as a Configuration gem.
 See the Confiture documentation for different configuration styles.
 
+
 ## License
 
 "THE BEER-WARE LICENSE" (Revision 42):

data/asin.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency('crack',     '>= 0.3')
   s.add_dependency('hashie',    '>= 1.1')
+  s.add_dependency('rash',      '>= 0.4')
   s.add_dependency('httpi',     '>= 0.9')
   s.add_dependency('confiture', '>= 0.1')
 
@@ -31,5 +32,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency('vcr',        '~> 2.2.5')
   s.add_development_dependency('webmock',    '~> 1.8.7')
   s.add_development_dependency('rspec',      '~> 2.11.0')
-  s.add_development_dependency('pry',        '~> 0.9.9')
 end

data/lib/asin.rb

@@ -1,8 +1,5 @@
 module ASIN
-  autoload :Client,         'asin/client'
-  autoload :SimpleItem,     'asin/simple_item'
-  autoload :SimpleCart,     'asin/simple_cart'
-  autoload :SimpleNode,     'asin/simple_node'
-  autoload :Version,        'asin/version'
-  autoload :Configuration,  'asin/configuration'
-end
+  require 'asin/client'
+  require 'asin/version'
+  require 'asin/configuration'
+end

data/lib/asin/adapter.rb

@@ -0,0 +1,222 @@
+module ASIN
+  module Adapter
+    def handle_type(data, type)
+      Hashie::Rash.new(data).tap do |rash|
+        rash.instance_eval do
+          case type
+          when :cart
+            def url
+              purchase_url
+            end
+
+            def price
+              sub_total.formatted_price
+            end
+
+            def items
+              return [] unless cart_items
+              cart_items.cart_item.is_a?(Array) ? cart_items.cart_item : [cart_items.cart_item]
+            end
+
+            def saved_items
+              return [] unless saved_for_later_items
+              saved_for_later_items.saved_for_later_item.is_a?(Array) ? saved_for_later_items.saved_for_later_item : [saved_for_later_items.saved_for_later_item]
+            end
+
+            def valid?
+              request.is_valid == 'True'
+            end
+
+            def empty?
+              cart_items.nil?
+            end
+
+          when :item
+            def title
+              item_attributes!.title
+            end
+
+            def amount
+              item_attributes!.list_price!.amount.to_i
+            end
+
+            def details_url
+              detail_page_url
+            end
+
+            def review
+              editorial_reviews!.editorial_review!.content
+            end
+
+            def image_url
+              large_image!.url
+            end
+
+            def review
+              EditorialReviews!.EditorialReview!.Content
+            end
+
+            def image_url
+              LargeImage!.URL
+            end
+
+            # <ItemAttributes>
+            def author
+              item_attributes!.author
+            end
+
+            def binding
+              item_attributes!.binding
+            end
+
+            def brand
+              item_attributes!.brand
+            end
+
+            def ean
+              item_attributes!.ean
+            end
+
+            def edition
+              item_attributes!.edition
+            end
+
+            def isbn
+              item_attributes!.isbn
+            end
+
+            def item_dimensions
+              item_attributes!.item_dimensions
+            end
+
+            # hundredths of an inch
+            def item_height
+              item_attributes!.item_dimensions.height
+            end
+
+            # hundredths of an inch
+            def item_length
+              item_attributes!.item_dimensions[:length]
+            end
+
+            # hundredths of an inch
+            def item_width
+              item_attributes!.item_dimensions.width
+            end
+
+            # hundredths of a pound
+            def item_weight
+              item_attributes!.item_dimensions.weight
+            end
+
+            def package_dimensions
+              item_attributes!.package_dimensions
+            end
+
+            # hundredths of an inch
+            def package_height
+              item_attributes!.package_dimensions.height
+            end
+
+            # hundredths of an inch
+            def package_length
+              item_attributes!.package_dimensions[:length]
+            end
+
+            # hundredths of an inch
+            def package_width
+              item_attributes!.package_dimensions.width
+            end
+
+            # hundredths of a pound
+            def package_weight
+              item_attributes!.package_dimensions.weight
+            end
+
+            def label
+              item_attributes!.label
+            end
+
+            def language
+              item_attributes!.languages.language.first.name
+            end
+
+            def formatted_price
+              item_attributes!.list_price.formatted_price
+            end
+
+            def manufacturer
+              item_attributes!.manufacturer
+            end
+
+            def mpn
+              item_attributes!.mpn
+            end
+
+            def page_count
+              item_attributes!.number_of_pages
+            end
+
+            def part_number
+              item_attributes!.part_number
+            end
+
+            def product_group
+              item_attributes!.product_group
+            end
+
+            def publication_date
+              item_attributes!.publication_date
+            end
+
+            def publisher
+              item_attributes!.publisher
+            end
+
+            def sku
+              item_attributes!.sku
+            end
+
+            def studio
+              item_attributes!.studio
+            end
+
+            def total_new
+              offer_summary!.total_new
+            end
+
+            def total_used
+              offer_summary!.total_used
+            end
+
+          when :node
+            def node_id
+              browse_node_id
+            end
+
+            def children
+              return [] unless children
+              children.browse_node.is_a?(Array) ? children.browse_node : [children.browse_node]
+            end
+
+            def ancestors
+              return [] unless ancestors
+              ancestors.browse_node.is_a?(Array) ? ancestors.browse_node : [ancestors.browse_node]
+            end
+
+            def top_item_set
+              return [] unless top_item_set
+              top_item_set.top_item.is_a?(Array) ? top_item_set.top_item : [top_item_set.top_item]
+            end
+          end
+        end
+      end
+    end
+  end
+
+  module Client
+    # REM (ps) this is a workaround for jruby, because they don't support Module.prepend https://github.com/jruby/jruby/issues/751
+    remove_method :handle_type
+    include ASIN::Adapter
+  end
+end