paapi_mini 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2fe6b5e86b7884e190fc6a4216deaa262a1d9d0ed15176cefa2cd409174ba931
+  data.tar.gz: 236cb6789ac6140643819c6333c664592bfc8969b0fa06a8e8b4bb57f11498cf
+SHA512:
+  metadata.gz: 46514b47c10ff8493d1abb427e735465a30b0fcb09e416d08d6c371b2b250c176b297c1c53d41c208bc7b400e73687fb9d4911989e35d79891de50d71df213e9
+  data.tar.gz: fc421e43462fdcd9efdd30385ad32f254739436573e42ec1bfb3993ebe04530d135db5d3a8df990568569d6fc89ea384f1b41700450f5ff549cfaf71ea0c1d9c

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/paapi_mini.iml" filepath="$PROJECT_DIR$/.idea/paapi_mini.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/paapi_mini.iml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="jdk" jdkName="rbenv: 3.1.2" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.3.7, rbenv: 3.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.16.3, rbenv: 3.1.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, rbenv: 3.1.2) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## [0.1.0] - 2022-10-16
+### Added
+- Added. ChangeLog And Release.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paapi_mini.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 oco
+
+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,63 @@
+# PaapiMini
+
+* This is a Gem for easy Amazon product search.<br>
+Before using it, you need to pass Amazon Associate review and get ACCESS_KEY etc. as preparation.
+* [Amazon Product Advertising API 5.0](https://webservices.amazon.com/paapi5/documentation/)　is supported.
+* This Gem is implemented using only the Ruby standard-attached library, so it does not depend on other Gems.
+
+* Ruby versions that have been tested by rbenv
+```
+ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin20]
+ruby 3.0.0rc1 (2020-12-20 master 8680ae9cbd) [x86_64-darwin20]
+ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [x86_64-darwin21]
+```
+* We have not tested Ruby for Windows at this time.<br>
+Also, since the author's Amazon Associate review is conducted by Amazon.co.jp, we are only able to test from this region.<br>
+Therefore, the default behavior of the API is Amazon.co.jp. It is possible to change it with an argument.<br>
+We would appreciate it if you could provide us with feedback if you can confirm that it works on the Windows version or in regions other than Amazon.co.jp.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paapi_mini'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install paapi_mini
+
+## Usage
+
+```ruby
+    require 'paapi_mini'
+
+    # The keyword argument to the search_items method can be used to refine the condition.
+    # Please refer to the official reference for the specifications of each argument.
+    # See Also https://webservices.amazon.com/paapi5/documentation/search-items.html
+    # Default Values.
+    # item_page: 1,
+    # min_price: 1,
+    # max_price: 100000,
+    # min_review_rating: 1,
+    # host: "webservices.amazon.co.jp",
+    # region: "us-west-2",
+    # market_place: "www.amazon.co.jp"
+    
+    res = PaapiMini::search_items(ENV['ACCESS_KEY'], ENV['SECRET_KEY'], ENV['PARTNER_TAG'],
+                                  keywords: "Ruby", min_review_rating: 3)
+
+    # res is Net::HTTPResponse Object
+    # See Also https://docs.ruby-lang.org/
+    puts res.code
+    puts res.body
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/aws_v4_auth.rb

@@ -0,0 +1,211 @@
+require 'digest'
+require 'openssl'
+require 'time'
+require 'uri'
+
+module PaapiMini
+
+  class Auth
+
+    attr_reader :access_key,
+                :secret_key,
+                :path,
+                :region,
+                :service,
+                :http_method_name,
+                :headers,
+                :payload,
+                :xamz_date,
+                :current_date,
+                :signed_headers
+
+    HMAC_ALGORITHM = 'AWS4-HMAC-SHA256'
+    AWS4_REQUEST = 'aws4_request'
+
+    public
+
+    # Make Auth Headers Strings for Amazon Product Advertising API 5.0
+    # reference: https://webservices.amazon.com/paapi5/documentation/without-sdk.html
+    #            https://webservices.amazon.com/paapi5/documentation/sending-request.html#signing
+    # important! https://webservices.amazon.co.jp/paapi5/scratchpad/
+    def make_headers
+      @headers['X-Amz-Date'] = @xamz_date
+      @headers['X-Amz-Content-Sha256'] = OpenSSL::Digest::SHA256.hexdigest(@payload)
+
+      canonical_url = prepare_canonical_request(@http_method_name, @path, @headers['X-Amz-Content-Sha256'])
+      string_to_sign = prepare_string_to_sign(canonical_url)
+      signature = calculate_signature(string_to_sign)
+      @headers['Authorization'] = build_authorization_string(signature)
+      Hash[@headers]
+    end
+
+    # URI文字列の生成
+    # create_search_itemsを呼び出していないと機能しない
+    def make_uri
+      "https://#{@headers['Host']}#{@path}"
+    end
+
+    def prepare_canonical_request(http_method_name, path, payload)
+      canonical_url = []
+      uri = URI.parse(path.to_s)
+      canonical_url << http_method_name
+      canonical_url << "#{uri.path}\n"
+
+      @signed_headers = []
+      headers = @headers.sort_by(&:first)
+      canonical_headers = []
+      headers.each do |key, value|
+        @signed_headers << key.downcase
+        canonical_headers << "#{key.downcase}:#{value}"
+      end
+
+      canonical_url << "#{canonical_headers.join("\n")}\n"
+      canonical_url << @signed_headers.join(";")
+      canonical_url << payload
+      canonical_url.join("\n")
+    end
+
+    def prepare_string_to_sign(canonical_url)
+      string_to_sign = []
+      string_to_sign << HMAC_ALGORITHM
+      string_to_sign << @xamz_date
+      string_to_sign << "#{@current_date}/#{@region}/#{@service}/#{AWS4_REQUEST}"
+      string_to_sign << OpenSSL::Digest::SHA256.hexdigest(canonical_url)
+      string_to_sign.join("\n")
+    end
+
+    def calculate_signature(string_to_sign)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), signature_key(), string_to_sign)
+    end
+
+    def build_authorization_string(signature)
+      build_authorization_string = []
+      build_authorization_string << "Credential=#{credentials_path}"
+      build_authorization_string << "SignedHeaders=#{@signed_headers.join(";")}"
+      build_authorization_string << "Signature=#{signature}"
+      "#{HMAC_ALGORITHM} #{build_authorization_string.join(", ")}"
+    end
+
+    def credentials_path
+      credentials = [@access_key, @current_date, region, service, AWS4_REQUEST]
+      credentials.join("/")
+    end
+
+    protected
+
+
+    def initialize(access_key, secret_key, path, region, service, http_method_name, headers, payload)
+      @access_key, @secret_key, @path = access_key, secret_key, path
+      @region, @service, @http_method_name = region, service, http_method_name
+      @headers, @payload = headers, payload
+      @xamz_date, @current_date = Auth::utc_timestamp(Time.now)
+    end
+
+
+
+    # https://docs.aws.amazon.com/general/latest/gr/signature-v4-examples.html#signature-v4-examples-ruby
+    def signature_key
+      secret = "AWS4#{@secret_key}"
+      date = Auth::hmac_sha_256(secret, @current_date)
+      region = Auth::hmac_sha_256(date, @region)
+      service = Auth::hmac_sha_256(region, @service)
+      Auth::hmac_sha_256(service, AWS4_REQUEST)
+    end
+
+    class << self
+
+      # SearchItems
+      # https://webservices.amazon.com/paapi5/documentation/search-items.html
+      # SearchIndex
+      # https://webservices.amazon.com/paapi5/documentation/locale-reference/japan.html
+      def create_search_items(access_key,
+                              secret_key,
+                              partner_tag,
+                              keywords:,
+                              item_page: 1,
+                              min_price: 1,
+                              max_price: 100000,
+                              min_review_rating: 1,
+                              host: "webservices.amazon.co.jp",
+                              region: "us-west-2",
+                              market_place: "www.amazon.co.jp")
+
+        service = 'ProductAdvertisingAPI'
+        http_method_name = 'POST'
+        api_path = '/paapi5/searchitems'
+
+        headers = {}
+        headers['Content-Encoding'] = 'amz-1.0'
+        headers['Host'] = host
+        headers['X-Amz-Target'] = 'com.amazon.paapi5.v1.ProductAdvertisingAPIv1.SearchItems'
+
+        request_payload = <<~EOS
+          {
+            "Keywords": "#{keywords}",
+            "Resources": [
+              "BrowseNodeInfo.WebsiteSalesRank",
+              "CustomerReviews.Count",
+              "CustomerReviews.StarRating",
+              "Images.Primary.Small",
+              "Images.Primary.Medium",
+              "ItemInfo.ByLineInfo",
+              "ItemInfo.ContentInfo",
+              "ItemInfo.ContentRating",
+              "ItemInfo.Classifications",
+              "ItemInfo.ManufactureInfo",
+              "ItemInfo.ProductInfo",
+              "ItemInfo.TechnicalInfo",
+              "ItemInfo.Title",
+              "ItemInfo.TradeInInfo",
+              "Offers.Listings.Condition",
+              "Offers.Listings.Condition.ConditionNote",
+              "Offers.Listings.Condition.SubCondition",
+              "Offers.Listings.DeliveryInfo.IsAmazonFulfilled",
+              "Offers.Listings.DeliveryInfo.IsFreeShippingEligible",
+              "Offers.Listings.DeliveryInfo.IsPrimeEligible",
+              "Offers.Listings.DeliveryInfo.ShippingCharges",
+              "Offers.Listings.IsBuyBoxWinner",
+              "Offers.Listings.LoyaltyPoints.Points",
+              "Offers.Listings.MerchantInfo",
+              "Offers.Listings.Price",
+              "Offers.Listings.ProgramEligibility.IsPrimeExclusive",
+              "Offers.Listings.ProgramEligibility.IsPrimePantry",
+              "Offers.Listings.Promotions",
+              "Offers.Listings.SavingBasis",
+              "Offers.Summaries.HighestPrice",
+              "Offers.Summaries.LowestPrice",
+              "Offers.Summaries.OfferCount",
+              "ParentASIN",
+              "SearchRefinements"
+            ],
+            "SearchIndex": "All",
+            "PartnerTag": "#{partner_tag}",
+            "PartnerType": "Associates",
+            "Marketplace": "#{market_place}",
+            "Operation": "SearchItems",
+            "ItemPage": #{item_page},
+            "MinReviewsRating": #{min_review_rating},
+            "MinPrice": #{min_price},
+            "MaxPrice": #{max_price},
+            "CurrencyOfPreference":"JPY",
+            "Condition":"New",
+            "DeliveryFlags":["FulfilledByAmazon"]
+          }
+        EOS
+
+        Auth.new(access_key, secret_key, api_path, region, service, http_method_name, headers, request_payload)
+      end
+
+      def hmac_sha_256(key, base_string)
+        OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), key, base_string)
+      end
+
+      def utc_timestamp(time)
+        now = time.utc
+        return now.strftime("%Y%m%dT%H%M%SZ"), now.strftime("%Y%m%d")
+      end
+
+    end
+
+  end
+end

data/lib/http_client.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+module PaapiMini
+module Http
+
+  # Exception
+  class Error < StandardError
+    def initialize(msg = 'HttpClient Error Message.')
+      super
+    end
+  end
+
+  # Post
+  def self.post(uri, payload, headers, options = {})
+    begin
+      parsed_uri, http = create_http(uri, options.has_key?(:proxy_url) ? options[:proxy_url] : nil)
+      req = Net::HTTP::Post.new(parsed_uri.request_uri)
+
+      headers.each do |key, value|
+        req[key.to_s] = value.to_s
+      end
+
+      if options.has_key?(:basic_auth)
+        req.basic_auth(options[:basic_auth][0], options[:basic_auth][1])
+      end
+
+      req.body = payload
+      http.request(req)
+    rescue => e
+      raise PaapiMini::Http::Error.new("#{e.message} #{e.backtrace}" )
+    end
+  end
+
+  class << self
+    private
+
+    def create_http(uri, proxy_uri)
+      parsed_uri = URI.parse(uri)
+      if parsed_uri.to_s == ""
+        raise PaapiMini::Http::Error.new("URI parse error. uri=>#{uri}")
+      end
+
+      http = if !proxy_uri.nil? && proxy_uri.length > 0
+               parsed_proxy_uri = URI.parse(proxy_uri)
+               if parsed_proxy_uri.to_s == ""
+                 raise PaapiMini::Http::Error.new("URI parse error. proxy_uri=>#{proxy_uri}")
+               end
+
+               # Proxy Server
+               proxy_class = Net::HTTP::Proxy(parsed_proxy_uri.host.to_s, parsed_proxy_uri.port)
+               proxy_class.new(parsed_uri.host, parsed_uri.port)
+             else
+               Net::HTTP.new(parsed_uri.host.to_s, parsed_uri.port)
+             end
+
+      http.open_timeout = 5
+      http.read_timeout = 5
+
+      if parsed_uri.scheme == 'https'
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+      [parsed_uri, http]
+    end
+  end
+end
+end

data/lib/paapi_mini/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PaapiMini
+  VERSION = "0.1.0"
+end

data/lib/paapi_mini.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "paapi_mini/version"
+require_relative 'aws_v4_auth'
+require_relative 'http_client'
+
+module PaapiMini
+  class Error < StandardError; end
+
+  def self.search_items(access_key,
+                       secret_key,
+                       partner_tag,
+                       keywords,
+                       item_page: 1,
+                       min_price: 1,
+                       max_price: 100000,
+                       min_review_rating: 1,
+                       host: "webservices.amazon.co.jp",
+                       region: "us-west-2",
+                       market_place: "www.amazon.co.jp")
+
+    aws_auth = Auth.create_search_items(access_key,
+                                        secret_key,
+                                        partner_tag,
+                                        keywords: keywords,
+                                        item_page: item_page,
+                                        min_price: min_price,
+                                        max_price: max_price,
+                                        min_review_rating: min_review_rating,
+                                        host: host,
+                                        region: region,
+                                        market_place: market_place)
+
+    aws_auth_headers = aws_auth.make_headers
+    aws_auth_headers['Content-Type'] = 'application/json; charset=utf-8'
+
+    return Http.post(aws_auth.make_uri, aws_auth.payload, aws_auth_headers)
+  end
+
+
+end

data/paapi_mini.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/paapi_mini/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "paapi_mini"
+  spec.version = PaapiMini::VERSION
+  spec.authors = ["oco"]
+  spec.email = ["osio.toshimasa@gmail.com"]
+
+  spec.summary = "Simple Amazon SearchItems By Amazon Advertising Product API."
+  spec.description = "This Gem is implemented using only the Ruby standard library, so it does not depend on other Gems"
+  spec.homepage = "https://github.com/osio-toshimasa/paapi_mini"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  #  spec.metadata["allowed_push_host"] = ""
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/osio-toshimasa/paapi_mini"
+  spec.metadata["changelog_uri"] = "https://github.com/osio-toshimasa/paapi_mini/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/paapi_mini.rbs

@@ -0,0 +1,4 @@
+module PaapiMini
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: paapi_mini
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- oco
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-16 00:00:00.000000000 Z
+dependencies: []
+description: This Gem is implemented using only the Ruby standard library, so it does
+  not depend on other Gems
+email:
+- osio.toshimasa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/modules.xml"
+- ".idea/paapi_mini.iml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/aws_v4_auth.rb
+- lib/http_client.rb
+- lib/paapi_mini.rb
+- lib/paapi_mini/version.rb
+- paapi_mini.gemspec
+- sig/paapi_mini.rbs
+homepage: https://github.com/osio-toshimasa/paapi_mini
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/osio-toshimasa/paapi_mini
+  source_code_uri: https://github.com/osio-toshimasa/paapi_mini
+  changelog_uri: https://github.com/osio-toshimasa/paapi_mini/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Simple Amazon SearchItems By Amazon Advertising Product API.
+test_files: []