amazon_pa_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b58d4eea3a6af7df87c5d39d0022be5491a43935
+  data.tar.gz: c6dc032953e373889ccb94a0dba0cb58ea450a23
+SHA512:
+  metadata.gz: 5c27cde0d227b78ce348b1427c843546f5ec47fe33b744736ade7ec6c276f5bbde2653e9b1a980a9bd873e09f49b425c2b4433fb1a665fda665033044fcfd863
+  data.tar.gz: eeb3e0e16b3192abb5ab335aea065734a6d2a82fda10e6be077d057206ea2fa750bb2a00b488f69cc481ea1b27cfa54c36511deae1c0ffbee57c6dbacca21a29

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.pryrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amazon_pa_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Masaru Ishimoto
+
+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,61 @@
+# AmazonPaApi
+
+The purpose of this gem is to make use of Amazon Product Advertising API and pull easily Amazon products information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amazon_pa_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amazon_pa_api
+
+## 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"
+	
+	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"
+				  }
+    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.credentials = credentials
+	puts item_lookup.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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/amazon_pa_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/amazon_pa_api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amazon_pa_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amazon_pa_api"
+  spec.version       = AmazonPaApi::VERSION
+  spec.authors       = ["sakura-computer"]
+  spec.email         = ["ishimoto.masaru@sakura-computer.co.jp"]
+
+  spec.summary       = %q{For Amazon Product Advertiseing API.}
+  spec.description   = %q{The purpose of this gem is to make use of Amazon Product Advertising API and pull easily Amazon products information.}
+  spec.homepage      = "https://github.com/sakura-computer/amazon_pa_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "amazon_pa_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/amazon_pa_api.rb

@@ -0,0 +1,11 @@
+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 "net/http"
+require "cgi"
+require "openssl"
+require "base64"

data/lib/amazon_pa_api/extensions.rb

@@ -0,0 +1,16 @@
+module AmazonPaApi
+  module Extensions
+    class ::String
+      def camel_case
+        self.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+      end
+      def snake_case
+        self.to_s.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+      end
+    end
+  end
+end

data/lib/amazon_pa_api/item_lookup.rb

@@ -0,0 +1,31 @@
+module AmazonPaApi
+  class ItemLookup < AmazonPaApi::Operation
+
+    #= this operation has request parameters.
+    REQUEST_PARAMETERS = [
+      :condition,
+      :id_type,
+      :item_id,
+      :merchant_id,
+      :offer_page,
+      :related_items_page,
+      :relationship_type,
+      :review_page,
+      :review_sort,
+      :search_index,
+      :tag_page,
+      :tags_per_page,
+      :tag_sort,
+      :variation_page,
+      :response_group,
+    ]
+
+    #= ItemLookup requires ItemId.
+    def initialize(item_id, region: :jp)
+      super()
+      self.item_id = item_id
+      self.region = region
+      self.operation = "ItemLookup"
+    end
+  end
+end

data/lib/amazon_pa_api/item_search.rb

@@ -0,0 +1,52 @@
+module AmazonPaApi
+  class ItemSearch < AmazonPaApi::Operation
+
+    #= this operation has request parameters.
+    REQUEST_PARAMETERS = [
+      :actor,
+      :artist, 
+      :audience_rating,
+      :author, 
+      :availability,
+      :brand, 
+      :browse_node,
+      :city,
+      :composer, 
+      :condition,
+      :conductor, 
+      :director,
+      :item_page,
+      :keywords,
+      :manufacturer,
+      :maximum_price,
+      :merchant_id,
+      :minimum_price,
+      :neighborhood,
+      :orchestra,
+      :postal_code,
+      :power, 
+      :publisher,
+      :related_items_page,
+      :relationship_type,
+      :review_sort,
+      :search_index,
+      :sort, 
+      :tag_page,
+      :tags_per_page,
+      :tag_sort, 
+      :text_stream,
+      :title,
+      :variation_page,
+      :response_group
+    ]
+
+    #= ItemSearch requires keywords and search index.
+    def initialize(keywords, search_index, region: :jp)
+      super()
+      self.keywords = keywords
+      self.search_index = search_index
+      self.region = region
+      self.operation = "ItemSearch"
+    end
+  end
+end

data/lib/amazon_pa_api/operation.rb

@@ -0,0 +1,117 @@
+module AmazonPaApi
+  #= This is the parent class of every PA api Operations performed.
+  class Operation
+
+    include AmazonPaApi::Request
+    
+    #= 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.
+    # String - The name of operation you want to perform.
+    attr_accessor :operation
+
+    #= 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.
+    attr_reader :header, :body
+    
+    API_VERSION = "2010-09-01".freeze
+
+    #= PA api end points.
+    #  PA api calls can be sent to any of 6 regions.
+    END_POINTS = {
+      ca: "http://ecs.amazonaws.ca/onca/xml",
+      de: "http://ecs.amazonaws.de/onca/xml",
+      fr: "http://ecs.amazonaws.fr/onca/xml",
+      jp: "http://ecs.amazonaws.jp/onca/xml",
+      uk: "http://ecs.amazonaws.co.uk/onca/xml",
+      us: "http://ecs.amazonaws.com/onca/xml",
+    }.freeze
+    
+    def initialize
+      self.class.const_get("REQUEST_PARAMETERS").each do |param|
+        self.class.send(:attr_accessor, param)
+      end
+    end
+
+    #= 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
+    end
+
+    #= You can set PA api credentials via this.
+    def credentials=(access_key_id: '',
+                     secret_access_key: '',
+                     associate_tag:''
+                    )
+      self.access_key_id = access_key_id
+      self.secret_access_key = secret_access_key
+      self.associate_tag = associate_tag
+    end
+    
+    protected
+
+    #= 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}")
+        parameters[param.to_s.camel_case] = value unless value.nil?
+        parameters
+      end
+    end
+
+    #= 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)
+    end
+
+    #= 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
+        params_string  += "#{k.to_s}=#{CGI.escape(v.to_s)}"
+        params_string
+      end
+    end
+
+    private
+
+    #= 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"),
+                                       self.secret_access_key,
+                                       "GET\n#{unsigned_uri.host}\n#{unsigned_uri.path}\n#{unsigned_uri.query}"
+                                      )
+      signature = [signature].pack("m").chomp
+      signature = URI.escape(signature, Regexp.new("[+=]"))
+      URI.parse "#{unsigned_uri}&Signature=#{signature}"
+
+    end
+
+  end
+end

data/lib/amazon_pa_api/request.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+module AmazonPaApi
+  module Request
+    attr_accessor :open_timeout, :read_timeout
+    
+    private
+
+    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
+
+      http = Net::HTTP.new(uri.host)
+
+      http.open_timeout = self.open_timeout || 30
+      http.read_timeout = self.read_timeout || 60
+
+      response = http.start do
+        http.get(uri.request_uri)
+      end
+
+      case response
+      when Net::HTTPSuccess
+        response
+      when Net::HTTPMovedPermanently, Net::HTTPRedirection
+        redirect_uri = URI::parse(response.header['location'])
+        return get_response(redirect_uri, limit -1 )
+      else
+        raise "Error connecting to Amazon. response: #{response.to_w}"
+      end
+    end
+                     
+  end
+end

data/lib/amazon_pa_api/version.rb

@@ -0,0 +1,3 @@
+module AmazonPaApi
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: amazon_pa_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sakura-computer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The purpose of this gem is to make use of Amazon Product Advertising
+  API and pull easily Amazon products information.
+email:
+- ishimoto.masaru@sakura-computer.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amazon_pa_api.gemspec
+- bin/console
+- 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/request.rb
+- lib/amazon_pa_api/version.rb
+homepage: https://github.com/sakura-computer/amazon_pa_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: For Amazon Product Advertiseing API.
+test_files: []
+has_rdoc: