dustbag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a0b547e89a4dbcbb9fe7e467fbcf2b442f0d045
+  data.tar.gz: 701d443ae47bd1fb8e30e7bb77a5c71108737970
+SHA512:
+  metadata.gz: 17753ceb38260a57ae4ef5d557014a26ce76382eb968a47ded76618c53e31d01cf2240451513d199b9c7712736b4cb4744b6952cee6097ecd26c9d4610086d87
+  data.tar.gz: b7993fd441f38f07f4c8f12ea16dd8c7e57f3d341ce71b60864884839c6386ff5a11169a35134ecc1612343b77e7840f92d6923b83a64c768b991d77736dfd60

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) [2015] [Herman Eleazar Moreno Valle]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# Dustbag
+[![Build Status](https://snap-ci.com/supherman/dustbag/branch/master/build_image)](https://snap-ci.com/supherman/dustbag/branch/master)
+[![Code Climate](https://codeclimate.com/github/supherman/dustbag/badges/gpa.svg)](https://codeclimate.com/github/supherman/dustbag)
+[![Test Coverage](https://codeclimate.com/github/supherman/dustbag/badges/coverage.svg)](https://codeclimate.com/github/supherman/dustbag/coverage)
+
+**Dustbag** is a set of response parsers for [Vacumm](https://github.com/hakanensari/vacuum) (a Ruby wrapper of the [Amazon Product Advertising API](https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html)
+
+
+![](https://sightsandsoundsinc.files.wordpress.com/2010/06/dust-image.jpg)
+
+Vacuum is an excellent client for the Amazon Product Advertising API, it handles all the possible interactons with the API, but unfortunately you're required to implement your own response parse mechanisms. So Vacuum just give us a ton of dust (in form of xml), which is not bad, because that's not its job, dustbag's job is to handle all that dust and give it a meaningful use.
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'dustbag'
+```
+
+## Prerequisite
+
+You'll need credentials to access to the Amazon Product Advertising API, also an affiliate tag, you can get them following [this instructions](https://affiliate-program.amazon.com/gp/advertising/api/detail/your-account.html?ie=UTF8&pf_rd_i=assoc-api-thank-you-0&pf_rd_m=ATVPDKIKX0DER&pf_rd_p=&pf_rd_r=&pf_rd_s=assoc-center-1&pf_rd_t=501&ref_=amb_link_83957991_1&rw_useCurrentProtocol=1)
+
+Once you get your credentials, you'll need to configure Vacuum to use your credentials, you have two options, you can set the following env vars:
+
+```zsh
+export AWS_ACCESS_KEY_ID=key
+export AWS_SECRET_ACCESS_KEY=secret
+```
+
+Or, you can explicitly say to vacuum to use your credentials:
+
+```Ruby
+request.configure(
+    aws_access_key_id: 'key',
+    aws_secret_access_key: 'secret',
+    associate_tag: 'tag'
+)
+```
+
+One more thing, this gem makes use of the [Money](https://github.com/RubyMoney/money) gem, money makes use of i18n to format money strings, by default this behaviour is disabled, if you want to enable i18n with money, you can enable it by setting the next env var:
+
+```
+export USE_I18N_FOR_MONEY=true
+```
+
+
+## Usage
+
+```ruby
+require 'vacuum'
+require 'dustbag'
+
+request = Vacuum.new
+request.associate_tag = 'tag'
+
+response = request.item_search(
+  query: {
+    'Keywords' => 'Architecture',
+    'SearchIndex' => 'Books'
+  }
+)
+
+response.parser = Dustbag::Parser
+
+response.parse
+
+```
+
+You'll get an ```ItemSearchReponse``` object, this object has an 'items' method which is a collection of the Items matchig your search, if you want to see what can you do with these itmes, look at the source code of the [```Item``` class](https://github.com/supherman/dustbag/blob/master/lib/dustbag/item.rb)
+
+## Project status
+
+Right now, there is only one response parser implemented (ItemSearchResponse), the remaining work is to implement the following responses:
+
+- [BrowseNodeLookup](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/BrowseNodeLookup.html)
+- [ItemLookup](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/ItemLookup.html)
+- [SimilarityLookup](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/SimilarityLookup.html)
+- [CartAdd](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CartAdd.html)
+- [CartClear](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CartClear.html)
+- [CartCreate](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CartCreate.html)
+- [CartGet](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CartGet.html)
+- [CartModify](http://docs.aws.amazon.com/AWSECommerceService/latest/DG/CartModify.html)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/dustbag.rb

@@ -0,0 +1,47 @@
+require 'money'
+require 'ox'
+require 'dustbag/version'
+
+Money.use_i18n = ENV['USE_I18N_FOR_MONEY'] || false
+
+module Dustbag
+  autoload :Accessories, 'dustbag/accessories'
+  autoload :Accessory, 'dustbag/accessory'
+  autoload :Arguments, 'dustbag/arguments'
+  autoload :AvailabilityAttributes, 'dustbag/availability_attributes'
+  autoload :BrowseNode, 'dustbag/browse_node'
+  autoload :BrowseNodes, 'dustbag/browse_nodes'
+  autoload :Common, 'dustbag/common'
+  autoload :CustomerReviews, 'dustbag/customer_reviews'
+  autoload :Dimension, 'dustbag/dimension'
+  autoload :Dimensions, 'dustbag/dimensions'
+  autoload :EditorialReview, 'dustbag/editorial_review'
+  autoload :EditorialReviews, 'dustbag/editorial_reviews'
+  autoload :HttpHeaders, 'dustbag/http_headers'
+  autoload :Image, 'dustbag/image'
+  autoload :ImageSet, 'dustbag/image_set'
+  autoload :ImageSets, 'dustbag/image_sets'
+  autoload :Item, 'dustbag/item'
+  autoload :ItemAttributes, 'dustbag/item_attributes'
+  autoload :ItemLink, 'dustbag/item_link'
+  autoload :ItemLinks, 'dustbag/item_links'
+  autoload :ItemSearchRequest, 'dustbag/item_search_request'
+  autoload :ItemSearchResponse, 'dustbag/item_search_response'
+  autoload :Items, 'dustbag/items'
+  autoload :Language, 'dustbag/language'
+  autoload :Languages, 'dustbag/languages'
+  autoload :Offer, 'dustbag/offer'
+  autoload :OfferSummary, 'dustbag/offer_summary'
+  autoload :Offers, 'dustbag/offers'
+  autoload :OperationRequest, 'dustbag/operation_request'
+  autoload :Parser, 'dustbag/parser'
+  autoload :Price, 'dustbag/price'
+  autoload :Request, 'dustbag/request'
+  autoload :SimilarProduct, 'dustbag/similar_product'
+  autoload :SimilarProducts, 'dustbag/similar_products'
+  autoload :SimpleProduct, 'dustbag/simple_product'
+  autoload :VariationAttribute, 'dustbag/variation_attribute'
+  autoload :VariationAttributes, 'dustbag/variation_attributes'
+  autoload :VariationSummary, 'dustbag/variation_summary'
+  autoload :Variations, 'dustbag/variations'
+end

data/lib/dustbag/accessories.rb

@@ -0,0 +1,7 @@
+module Dustbag
+  class Accessories
+    include Parser::CollectionNode
+
+    member_name 'Accessory'
+  end
+end

data/lib/dustbag/accessory.rb

@@ -0,0 +1,6 @@
+module Dustbag
+  class Accessory
+    include Parser::Node
+    include SimpleProduct
+  end
+end

data/lib/dustbag/arguments.rb

@@ -0,0 +1,8 @@
+module Dustbag
+  class Arguments
+    include Parser::CollectionNode
+    include Parser::MapCollectionNode
+
+    member_name 'Argument'
+  end
+end

data/lib/dustbag/availability_attributes.rb

@@ -0,0 +1,9 @@
+module Dustbag
+  class AvailabilityAttributes
+    include Parser::Node
+
+    text_attributes type: 'AvailabilityType'
+
+    numeric_attributes :maximum_hours, :minimum_hours
+  end
+end

data/lib/dustbag/browse_node.rb

@@ -0,0 +1,15 @@
+module Dustbag
+  class BrowseNode
+    include Parser::Node
+
+    numeric_attributes id: 'BrowseNodeId'
+
+    text_attributes :name
+
+    children ancestors: BrowseNodes
+
+    def category_root?
+      subnode_text('IsCategoryRoot') == '1'
+    end
+  end
+end

data/lib/dustbag/browse_nodes.rb

@@ -0,0 +1,7 @@
+module Dustbag
+  class BrowseNodes
+    include Parser::CollectionNode
+
+    member_name 'BrowseNode'
+  end
+end

data/lib/dustbag/common.rb

@@ -0,0 +1,7 @@
+module Dustbag
+  module Common
+    include Parser::Node
+
+    children :operation_request
+  end
+end

data/lib/dustbag/customer_reviews.rb

@@ -0,0 +1,11 @@
+module Dustbag
+  class CustomerReviews
+    include Parser::Node
+
+    text_attributes iframe_url: 'IFrameURL'
+
+    def any?
+      subnode_text('HasReviews') == 'true'
+    end
+  end
+end

data/lib/dustbag/dimension.rb

@@ -0,0 +1,13 @@
+module Dustbag
+  class Dimension
+    include Parser::Node
+
+    def value
+      text.to_i
+    end
+
+    def units
+      attributes[:Units]
+    end
+  end
+end

data/lib/dustbag/dimensions.rb

@@ -0,0 +1,10 @@
+module Dustbag
+  class Dimensions
+    include Parser::Node
+
+    children height: Dimension,
+             length: Dimension,
+             weight: Dimension,
+             width:  Dimension
+  end
+end

data/lib/dustbag/editorial_review.rb

@@ -0,0 +1,11 @@
+module Dustbag
+  class EditorialReview
+    include Parser::Node
+
+    text_attributes :source, :content
+
+    def link_suppressed?
+      subnode_text('IsLinkSuppressed') == '1'
+    end
+  end
+end

data/lib/dustbag/editorial_reviews.rb

@@ -0,0 +1,7 @@
+module Dustbag
+  class EditorialReviews
+    include Parser::CollectionNode
+
+    member_name 'EditorialReview'
+  end
+end

data/lib/dustbag/http_headers.rb

@@ -0,0 +1,8 @@
+module Dustbag
+  class HttpHeaders
+    include Parser::CollectionNode
+    include Parser::MapCollectionNode
+
+    member_name 'Header'
+  end
+end

data/lib/dustbag/image.rb

@@ -0,0 +1,5 @@
+module Dustbag
+  class Image
+    include Parser::Node
+  end
+end

data/lib/dustbag/image_set.rb

@@ -0,0 +1,9 @@
+module Dustbag
+  class ImageSet
+    include Parser::Node
+
+    def category
+      attributes[:Category]
+    end
+  end
+end

data/lib/dustbag/image_sets.rb

@@ -0,0 +1,7 @@
+module Dustbag
+  class ImageSets
+    include Parser::CollectionNode
+
+    member_name 'ImageSet'
+  end
+end

data/lib/dustbag/item.rb

@@ -0,0 +1,21 @@
+module Dustbag
+  class Item
+    include Parser::Node
+
+    text_attributes asin:            'ASIN',
+                    parent_asin:     'ParentASIN',
+                    detail_page_url: 'DetailPageURL'
+
+    numeric_attributes :sales_rank
+
+    children :item_links, :item_attributes, :image_sets, :offer_summary,
+             :offers, :customer_reviews, :editorial_reviews, :similar_products,
+             :browse_nodes, :accessories, :variation_summary, :variations,
+             :variation_attributes
+
+    children small_image:  Image,
+             medium_image: Image,
+             large_image:  Image
+
+  end
+end

data/lib/dustbag/item_attributes.rb

@@ -0,0 +1,79 @@
+module Dustbag
+  class ItemAttributes
+    include Parser::Node
+
+    text_attributes :manufacturer, :product_group, :title, :director, :binding,
+                    :brand, :color, :model, :part_number, :product_type_name,
+                    :publisher, :studio, :size, :audience_rating, :genre
+
+    numeric_attributes :number_of_items, :number_of_pages, :package_quantity
+
+    text_attributes ean:  'EAN',
+                    mpn:  'MPN',
+                    upc:  'UPC',
+                    isbn: 'ISBN'
+
+    children item_dimensions: Dimensions,
+             package_dimensions: Dimensions,
+             running_time: Dimension
+
+    children :languages
+
+    def actors
+      repeated_subnodes_text('Actor')
+    end
+
+    def creators
+      repeated_subnodes('Creator').inject({}) do |acc, val|
+        acc[val['Role']] = val.text
+        acc
+      end
+    end
+
+    def authors
+      repeated_subnodes_text('Author')
+    end
+
+    def ean_list
+      list = subnode('EANList')
+      list && list.locate('EANListElement').map do |element|
+        element.text
+      end
+    end
+
+    def features
+      repeated_subnodes_text('Feature')
+    end
+
+    def labels
+      repeated_subnodes_text('Label')
+    end
+
+    def trade_in_value
+      Price.parse(subnode('TradeInValue'))
+    end
+
+    def upc_list
+      list = subnode('UPCList')
+      list && list.locate('UPCListElement').map do |element|
+        element.text
+      end
+    end
+
+    def list_price
+      Price.parse(subnode('ListPrice'))
+    end
+
+    def release_date
+      Date.parse(subnode_text('ReleaseDate')) rescue nil
+    end
+
+    def publication_date
+      Date.parse(subnode_text('PublicationDate')) rescue nil
+    end
+
+    def adult_product?
+      subnode_text('IsAdultProduct') == '1'
+    end
+  end
+end