amazon_pa_api 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edd7205207a1d63992e1ce76e00ea23a84da1dcf
-  data.tar.gz: 116ef6b511304f7902da9ab287c56022fba74ab6
+  metadata.gz: 9d40c14d5eefeb894fb39a056f1e1a1c0f73d199
+  data.tar.gz: 3b8cd40d8f39d1e9e054ea9ea6beb4be33e32dc2
 SHA512:
-  metadata.gz: 0f48685698d113ddb7e7dda899711959eef12f4423b59658c023e2290629e69cec65fbe2124af6a779795731322b6e355ab9f52d9021aa3bf38005239621b2e8
-  data.tar.gz: 1769d6dd9694c0330792a975bad26e2981e9500924ac89a57c934ade208561a7605faa8c133a1c384003702b1259ac450a31e17a739fc3afb020c2ea1e4a678a
+  metadata.gz: 8635e29f1d5464973baed13c5ff644e5cb30eab917e4d39eb61f7d4e0b9430c1955aeb72bc72d65556feef6d1586064ba23b0fe30978fe9873607f5ecd330247
+  data.tar.gz: 23190915af42be806daa5f4880b59006de700d10610b766b5ef33bf1623f3f44696a78fb58d8f402e9f9751ac2f8fec69dd6703712f766738d5049708aed3343

data/README.md

@@ -1,6 +1,11 @@
 # AmazonPaApi
 
-The purpose of this gem is to make use of Amazon Product Advertising API and pull easily Amazon products information.
+The purpose of this gem is to make use of Amazon Product Advertising API and pull easily Amazon products information.  
+Supported Amazon Product Advertising API operations.
+
+* ItemLookup
+* ItemSearch
+* SimilarityLookup
 
 ## Installation
 
@@ -21,16 +26,19 @@ Or install it yourself as:
 ## Usage
 
 You can use easily Amazon Product Advertising API calls, like this.
-```ruby
-	item_lookup = AmazonPaApi::ItemLookup.new('B0026IAWMU')
-	item_lookup.access_key_id = "Your Amazon AWS access key id"
-	item_lookup.secret_access_key = "Your Amazon AWS secret key"
-	item_lookup.associate_tag = "Your Amazon associate tag"
+
+```
+    item_lookup = AmazonPaApi::ItemLookup.new('B0026IAWMU')
+    item_lookup.access_key_id = "Your Amazon AWS access key id"  # required
+    item_lookup.secret_access_key = "Your Amazon AWS secret key" # required
+    item_lookup.associate_tag = "Your Amazon associate tag"      # required
 	
-	puts item_lookup.get.body     # => XML
+    puts item_lookup.get.body     # => XML
 ```
+
 Or you can set Amazon credentials as hash, like this.
-```ruby
+
+```
     credentials = { access_key_id: "Your Amazon AWS access key id",
                     secret_access_key: "Your Amazon AWS secret key",
 	 			   	associate_tag: "Your Amazon associate tag"
@@ -38,20 +46,27 @@ Or you can set Amazon credentials as hash, like this.
     item_search = AmazonPaApi::ItemSearch.new('Attack on Titan', 'Books')
     item_search.credentials = credentials
     puts item_search.get.body     # => XML
-
-	item_lookup = AmazonPaApi::ItemLookup.new('B0026IAWMU')
+    
+    item_lookup = AmazonPaApi::ItemLookup.new('B0026IAWMU')
     item_lookup.credentials = credentials
-	puts item_lookup.get.body     # => XML
+    puts item_lookup.get.body     # => XML
 ```
+
 If you want to choice Amazon ECommerce end point, like this.
-```ruby
-	item_lookup = = AmazonPaApi::ItemLookup.new('B0026IAWMU', region: :uk)
+
 ```
+    item_lookup = AmazonPaApi::ItemLookup.new('B00NLDYGDK', region: :uk)
+```
+
 You can use Amazon Product Advertising API operation's request parameters as instance methods.
-```ruby
-	item_lookup.id_type = :ean
-	item_lookup.condition = :new
+
 ```
+    item_lookup.id_type = 'EAN'
+	item_lookup.seach_index = 'Books'
+    item_lookup.condition = 'New'
+    puts item_search.get.body     # => XML	
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/amazon_pa_api.rb

@@ -1,9 +1,8 @@
 require "amazon_pa_api/version"
-require "amazon_pa_api/request"
 require "amazon_pa_api/extensions"
-require "amazon_pa_api/operation"
-require "amazon_pa_api/item_lookup"
-require "amazon_pa_api/item_search"
+require "amazon_pa_api/operations/item_lookup"
+require "amazon_pa_api/operations/item_search"
+require "amazon_pa_api/operations/similarity_lookup"
 
 require "net/http"
 require "cgi"

data/lib/amazon_pa_api/{item_lookup.rb → operations/item_lookup.rb}

@@ -1,7 +1,9 @@
+require 'amazon_pa_api/operations/operation'
+
 module AmazonPaApi
   class ItemLookup < AmazonPaApi::Operation
 
-    #= this operation has request parameters.
+    # This is list of Amazon Product Advertising API request parameters.
     REQUEST_PARAMETERS = [
       :condition,
       :id_type,
@@ -20,7 +22,7 @@ module AmazonPaApi
       :response_group,
     ]
 
-    #= ItemLookup requires ItemId.
+    # ItemLookup requires ItemId.
     def initialize(item_id, region: :jp)
       super()
       self.item_id = item_id

data/lib/amazon_pa_api/{item_search.rb → operations/item_search.rb}

@@ -1,7 +1,9 @@
+require 'amazon_pa_api/operations/operation'
+
 module AmazonPaApi
   class ItemSearch < AmazonPaApi::Operation
 
-    #= this operation has request parameters.
+    # This is list of Amazon Product Advertising API request parameters.
     REQUEST_PARAMETERS = [
       :actor,
       :artist, 
@@ -40,7 +42,7 @@ module AmazonPaApi
       :response_group
     ]
 
-    #= ItemSearch requires keywords and search index.
+    # ItemSearch requires keywords and search index.
     def initialize(keywords, search_index, region: :jp)
       super()
       self.keywords = keywords

data/lib/amazon_pa_api/{operation.rb → operations/operation.rb}

@@ -1,28 +1,30 @@
+require 'amazon_pa_api/request'
+
 module AmazonPaApi
   #= This is the parent class of every PA api Operations performed.
   class Operation
 
     include AmazonPaApi::Request
     
-    #= PA api requires thease credentials.
+    # PA api requires thease credentials.
     # String - You must to set thease before performing operations.
     attr_accessor :access_key_id, :secret_access_key, :associate_tag
 
-    #= Subclass set this variables at initialize.
+    # Subclass set this variables at initialize.
     # String - The name of operation you want to perform.
     attr_accessor :operation
 
-    #= Subclass set this variables at initialize.
+    # Subclass set this variables at initialize.
     # String - It will be use this to pick the right associates key up.
     #          default is jp.
     attr_accessor :region
 
-    #= You can get PA api response via thease.
+    # You can get PA api response via thease.
     attr_reader :header, :body
     
     API_VERSION = "2010-09-01".freeze
 
-    #= PA api end points.
+    # PA api end points.
     #  PA api calls can be sent to any of 6 regions.
     END_POINTS = {
       ca: "http://ecs.amazonaws.ca/onca/xml",
@@ -39,25 +41,12 @@ module AmazonPaApi
       end
     end
 
-    #= Execute the request to Amazon.
+    # Execute the request to Amazon.
     def get
-      if self.access_key_id.nil? || self.access_key_id.to_s.size == 0 ||
-         self.secret_access_key.nil? || self.secret_access_key.to_s.size == 0 ||
-         self.associate_tag.nil? || self.associate_tag.to_s.size == 0 
-        raise "PA api requires AWS  credentials."
-      end
-
-      unsigned_uri = URI.parse("#{END_POINTS[self.region]}?#{request_params_string}")
-      uri = add_signature(unsigned_uri)
-
-      response = get_response uri
-      @header = response.header
-      @body = response.body
-
-      response
+      request
     end
 
-    #= You can set PA api credentials via this.
+    # You can set PA api credentials via this.
     def credentials=(access_key_id: '',
                      secret_access_key: '',
                      associate_tag:''
@@ -69,7 +58,7 @@ module AmazonPaApi
     
     protected
 
-    #= It set instance variable from defined request parameters in subclass.
+    # It set instance variable from defined request parameters in subclass.
     def params
       self.class.const_get("REQUEST_PARAMETERS").inject({}) do |parameters, param|
         value = instance_variable_get("@#{param}")
@@ -78,18 +67,19 @@ module AmazonPaApi
       end
     end
 
-    #= It set common query parameters as hash.
+    # It set common query parameters as hash.
     def request_params
-      {"Service"                    => "AWSECommerceService",
-       "Timestamp"                  => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
-       "AWSAccessKeyId"             => self.access_key_id.to_s,
-       "Operation"                  => self.operation,
-       "AssociateTag"               => self.associate_tag.to_s,
-       "Version"                    => API_VERSION,
-      }.merge!(params)
+      parameters ={
+        "Service"                    => "AWSECommerceService",
+        "Timestamp"                  => Time.now.utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
+        "AWSAccessKeyId"             => self.access_key_id.to_s,
+        "AssociateTag"               => self.associate_tag.to_s,
+        "Operation"                  => self.operation,
+        "Version"                    => API_VERSION,
+      }.merge!(params)                                                                                 
     end
 
-    #= It sort and set all query parameters as hash.
+    # It sort and set all query parameters as hash.
     def request_params_string
       request_params.sort.inject('') do |params_string, (k,v)|
         params_string  += '&' unless params_string.size == 0
@@ -100,7 +90,7 @@ module AmazonPaApi
 
     private
 
-    #= it add signature parameter from uri
+    # it add signature parameter from uri
     #  URI - To Amazon AWS ECommerce Service.
     def add_signature(unsigned_uri)
       signature = OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new("sha256"),
@@ -113,5 +103,24 @@ module AmazonPaApi
 
     end
 
+    # it add signature and requests Amazon via http.
+    def request
+      if self.access_key_id.nil? ||
+         self.secret_access_key.nil? ||
+         self.associate_tag.nil?
+        raise "PA api requires AWS credentials. Please set access_key_id, secret_access_key and associate_tag, try again."
+      end
+      raise "Invalid region. region: #{self.region}" unless END_POINTS.include?(self.region)
+
+      unsigned_uri = URI.parse("#{END_POINTS[self.region]}?#{request_params_string}")
+      uri = add_signature(unsigned_uri)
+
+      response = get_response uri
+      @header = response.header
+      @body = response.body
+
+      response
+    end
+    
   end
 end

data/lib/amazon_pa_api/operations/similarity_lookup.rb

@@ -0,0 +1,23 @@
+require 'amazon_pa_api/operations/operation'
+
+module AmazonPaApi
+  class SimilarityLookup < AmazonPaApi::Operation
+
+    # This is list of Amazon Product Advertising API request parameters.
+    REQUEST_PARAMETERS = [
+      :condition,
+      :item_id,
+      :merchant_id,
+      :similarity_type,
+      :response_group,
+    ]
+
+    def initialize(item_id, region: :jp)
+      super()
+      self.item_id = item_id
+      self.region = region
+      self.operation = "SimilarityLookup"
+    end
+      
+  end
+end

data/lib/amazon_pa_api/request.rb

@@ -1,10 +1,13 @@
 # coding: utf-8
 module AmazonPaApi
+  #= This is mixed into operations class.
   module Request
+    # HTTP access parameters
     attr_accessor :open_timeout, :read_timeout
     
     private
 
+    # it get HTTP response.
     def get_response(uri_or_url, limit = 10)
       raise "Redirect is too depp." if limit <= 0
       uri = uri_or_url.class == String ? URI.parse(uri_or_url) : uri_or_url
@@ -25,7 +28,7 @@ module AmazonPaApi
         redirect_uri = URI::parse(response.header['location'])
         return get_response(redirect_uri, limit -1 )
       else
-        raise "Error connecting to Amazon. response: #{response.to_w}"
+        raise "Error connecting to Amazon. response: #{response.to_s}"
       end
     end
                      

data/lib/amazon_pa_api/version.rb

@@ -1,3 +1,3 @@
 module AmazonPaApi
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amazon_pa_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - sakura-computer
@@ -73,9 +73,10 @@ files:
 - bin/setup
 - lib/amazon_pa_api.rb
 - lib/amazon_pa_api/extensions.rb
-- lib/amazon_pa_api/item_lookup.rb
-- lib/amazon_pa_api/item_search.rb
-- lib/amazon_pa_api/operation.rb
+- lib/amazon_pa_api/operations/item_lookup.rb
+- lib/amazon_pa_api/operations/item_search.rb
+- lib/amazon_pa_api/operations/operation.rb
+- lib/amazon_pa_api/operations/similarity_lookup.rb
 - lib/amazon_pa_api/request.rb
 - lib/amazon_pa_api/version.rb
 homepage: https://github.com/sakura-computer/amazon_pa_api