rapa 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1436b1e05d3a556e65e94f75c93d0037ff98cbb
-  data.tar.gz: 160943e78e50ff72e6d5b0c7c0a4cb1fc3704445
+  metadata.gz: 6759f32d6175ac260576b9fe16678e49e39ce482
+  data.tar.gz: c827b10203a61a7f1ad725a21cb879a97355fd65
 SHA512:
-  metadata.gz: 6dfaa37b322164e8af23cc890c0fa60118303184cd11d951f2a496085946bfdc336297b04d7e9a7e8223668c52720f7a6d1fd9c117986bc0cb39e189f8bf2db1
-  data.tar.gz: bbddac5952f7274550cde607dcda76c39edb04d092079f4f2486d33844c18ab27276478421c9009521163e0174f84bb0adc5ead0fc59f94777d6480fb30c4e50
+  metadata.gz: 5d252376839d2195a4743c11e892b1e224d552739d193c8477d498be7db1da4d58f4aee3bf73f839ea4f58beedefd5cbfefe3ddfce3f96eca4331623966ced21
+  data.tar.gz: f0b037b092716cf2c0cc6c71086ae11b8d8e53410749507ec8a955edfcddf96a468810ef3e4bde624fba66889673d58e9c77e3b5e7dd396abd66d4ecb888ffa2

data/.gitignore

@@ -0,0 +1,2 @@
+/Gemfile.lock
+/pkg/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## 0.3.0
+
+- Add `Rapa::Responses::SearchItemsResponse#error`
+- Add `Rapa::Responses::SearchItemsResponse#has_error?`
+- Add `Rapa::Responses::SearchItemsResponse#has_valid_request?`
+- Use `"All"` as default SearchIndex parameter
+- Fix bug that no files included in gem package
+
+## 0.2.1
+
+- Add `Rapa::Responses::SearchItemsResponse#total_pages`
+- Add `Rapa::Responses::SearchItemsResponse#total_results`
+- Fix response parser on `Rapa::Client#search_items`
+
+## 0.2.0
+
+- Add `Rapa::Client#search_items`
+
+## 0.1.0
+
+- Add `Rapa::Resources::ItemResource`
+- Change required Ruby version from 2.2.2 to 2.3
+
+## 0.0.1
+
+- 1st Release :tada:
+- Add `Rapa::Client#list_items`

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryo Nakamura
+
+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,227 @@
+# Rapa
+
+[![CircleCI](https://img.shields.io/circleci/project/github/r7kamura/rapa.svg)](https://circleci.com/gh/r7kamura/rapa)
+[![Gem Version](https://badge.fury.io/rb/rapa.svg)](https://rubygems.org/gems/rapa)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/github/r7kamura/rapa)
+
+An API client library for Amazon Product Advertising API, written in Ruby.
+
+See https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html for more details about Amazon Product Advertising API.
+
+## Requirements
+
+- Ruby 2.3 or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rapa"
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install rapa
+```
+
+## Usage
+
+### Rapa::Client.new
+
+Available options:
+
+- `:access_key_id`
+- `:associate_tag`
+- `:secret_access_key`
+
+Returns a `Rapa::Client`.
+
+```ruby
+require "rapa"
+client = Rapa::Client.new(
+  access_key_id: "...",
+  associate_tag: "...",
+  secret_access_key: "...",
+)
+```
+
+### Rapa::Client#list_items
+
+Available options:
+
+- `:asins`
+- `:domain`
+- `:related_item_page`
+- `:relationship_type`
+- `:response_groups`
+
+Returns a `Rapa::Responses::ListItemsResponse`.
+
+```ruby
+response = client.list_items(
+  asins: ["..."],
+  domain: "...",
+  response_groups: ["..."],
+)
+```
+
+### Rapa::Client#search_items
+
+Available options:
+
+- `:domain`
+- `:keywords`
+- `:related_item_page`
+- `:relationship_type`
+- `:response_groups`
+- `:search_index`
+
+Returns a `Rapa::Responses::SearchItemsResponse`.
+
+```ruby
+response = client.search_items(
+  domain: "...",
+  keywords: ["..."],
+  response_groups: ["..."],
+)
+```
+
+### Rapa::Responses::SearchItemsResponse
+
+Available methods:
+
+- `#error`
+- `#has_error?`
+- `#has_valid_request?`
+- `#total_pages`
+- `#total_results`
+
+### Rapa::Resources::ItemResource
+
+Available methods:
+
+- `#adult_product?`
+- `#alternate_versions`
+- `#asin`
+- `#authors`
+- `#binding`
+- `#browse_nodes`
+- `#creator_name`
+- `#creator_role`
+- `#ean`
+- `#episode_sequence`
+- `#genre`
+- `#has_customer_reviews?`
+- `#image_hi_res`
+- `#image_large`
+- `#image_medium`
+- `#image_small`
+- `#image_swatch`
+- `#image_thumbnail`
+- `#image_tiny`
+- `#isbn`
+- `#item_height`
+- `#item_length`
+- `#item_width`
+- `#label`
+- `#languages`
+- `#manufacturer`
+- `#number_of_pages`
+- `#package_height`
+- `#package_length`
+- `#package_weight`
+- `#package_width`
+- `#product_group`
+- `#product_type_name`
+- `#publication_date`
+- `#publisher`
+- `#related_item_count`
+- `#related_item_page`
+- `#related_item_page_count`
+- `#related_items`
+- `#relationship`
+- `#relationship_type`
+- `#release_date`
+- `#running_time`
+- `#sales_rank`
+- `#season_sequence`
+- `#similar_products`
+- `#studio`
+- `#title`
+- `#url_add_to_wishlist`
+- `#url_all_customer_reviews`
+- `#url_all_offers`
+- `#url_customer_reviews_iframe`
+- `#url_details_page`
+- `#url_tell_a_friend`
+
+## Hints
+
+### Domain
+
+Available domain examples:
+
+- `"ca"`
+- `"cn"`
+- `"co.jp"`
+- `"co.uk"`
+- `"com"`
+- `"com.br"`
+- `"com.mx"`
+- `"de"`
+- `"es"`
+- `"fr"`
+- `"in"`
+- `"it"`
+
+### SearchIndex
+
+Available SearchIndex examples:
+
+- `"All"`
+- `"Apparel"`
+- `"Appliances"`
+- `"Automotive"`
+- `"Baby"`
+- `"Beauty"`
+- `"Blended"`
+- `"Books"`
+- `"Classical"`
+- `"CreditCards"`
+- `"DVD"`
+- `"Electronics"`
+- `"ForeignBooks"`
+- `"GiftCards"`
+- `"Grocery"`
+- `"HealthPersonalCare"`
+- `"Hobbies"`
+- `"HomeImprovement"`
+- `"Industrial"`
+- `"Jewelry"`
+- `"KindleStore"`
+- `"Kitchen"`
+- `"Marketplace"`
+- `"MP3Downloads"`
+- `"Music"`
+- `"MusicalInstruments"`
+- `"OfficeProducts"`
+- `"PCHardware"`
+- `"PetSupplies"`
+- `"Shoes"`
+- `"Software"`
+- `"SportingGoods"`
+- `"Toys"`
+- `"Video"`
+- `"VideoDownload"`
+- `"VideoGames"`
+- `"Watches"`
+
+See http://docs.aws.amazon.com/AWSECommerceService/latest/DG/localevalues.html for more details.

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.3.0

data/lib/rapa/alternate_version.rb

@@ -0,0 +1,26 @@
+module Rapa
+  class AlternateVersion
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [String]
+    def asin
+      source["ASIN"]
+    end
+
+    # @return [String]
+    def binding
+      source["Binding"]
+    end
+
+    # @return [String]
+    def title
+      source["Title"]
+    end
+  end
+end

data/lib/rapa/browse_node.rb

@@ -0,0 +1,42 @@
+module Rapa
+  class BrowseNode
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [Array<Rapa::BrowseNode>, nil]
+    def children
+      if child_sources = source.dig("Children", "BrowseNode")
+        child_sources.map do |child_source|
+          ::Rapa::BrowseNode.new(child_source)
+        end
+      end
+    end
+
+    # @return [Integer]
+    def id
+      source["BrowseNodeId"].to_i
+    end
+
+    # @return [String]
+    def name
+      source["Name"]
+    end
+
+    # @return [Rapa::BrowseNode, nil]
+    def parent
+      if parent_source = source.dig("Ancestors", "BrowseNode")
+        ::Rapa::BrowseNode.new(parent_source)
+      end
+    end
+
+    # @return [String]
+    def title
+      source["Title"]
+    end
+  end
+end

data/lib/rapa/client.rb

@@ -0,0 +1,127 @@
+require "faraday"
+require "faraday_middleware"
+require "uri"
+
+module Rapa
+  class Client
+    # @param access_key_id [String]
+    # @param associate_tag [String]
+    # @param secret_access_key [String]
+    def initialize(access_key_id:, associate_tag:, secret_access_key:)
+      @access_key_id = access_key_id
+      @associate_tag = associate_tag
+      @secret_access_key = secret_access_key
+    end
+
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= ::Faraday::Connection.new do |connection|
+        connection.adapter :net_http
+        connection.response :xml
+        connection.options.params_encoder = ::Rapa::Encoder.new
+      end
+    end
+
+    # @param asins [Array<String>]
+    # @param domain [String]
+    # @param related_item_page [Integer, nil]
+    # @param relationship_type [String, nil]
+    # @param response_groups [Array<String>, nil]
+    # @return [Rapa::Responses::ListItemsResponse]
+    def list_items(
+      asins:,
+      domain:,
+      related_item_page: nil,
+      relationship_type: nil,
+      response_groups: nil
+    )
+      send_request(
+        asins: asins,
+        domain: domain,
+        query_class: ::Rapa::Queries::ListItemsQuery,
+        related_item_page: related_item_page,
+        relationship_type: relationship_type,
+        response_class: ::Rapa::Responses::ListItemsResponse,
+        response_groups: response_groups,
+      )
+    end
+
+    # @param domain [String]
+    # @param keywords [Array<String>]
+    # @param related_item_page [Integer, nil]
+    # @param relationship_type [String, nil]
+    # @param response_groups [Array<String>, nil]
+    # @param search_index [String, nil]
+    # @return [Rapa::Responses::SearchItemsResponse]
+    def search_items(
+      domain:,
+      keywords:,
+      related_item_page: nil,
+      relationship_type: nil,
+      response_groups: nil,
+      search_index: nil
+    )
+      send_request(
+        domain: domain,
+        keywords: keywords,
+        query_class: ::Rapa::Queries::SearchItemsQuery,
+        related_item_page: related_item_page,
+        relationship_type: relationship_type,
+        response_class: ::Rapa::Responses::SearchItemsResponse,
+        response_groups: response_groups,
+        search_index: search_index,
+      )
+    end
+
+    private
+
+    # @private
+    # @return [String]
+    def access_key_id
+      @access_key_id
+    end
+
+    # @private
+    # @return [String]
+    def associate_tag
+      @associate_tag
+    end
+
+    # @private
+    # @return [Hash]
+    def common_query_options
+      {
+        access_key_id: access_key_id,
+        associate_tag: associate_tag,
+      }
+    end
+
+    # @private
+    # @return [String]
+    def secret_access_key
+      @secret_access_key
+    end
+
+    # @private
+    # @param domain [String]
+    # @param query_class [Class]
+    # @param response_class [Class]
+    # @return [Rapa::Responses::BaseResponse]
+    def send_request(domain:, query_class:, response_class:, **options)
+      query_options = common_query_options.merge(options)
+      query = query_class.new(query_options)
+      url = ::Rapa::Url.new(domain: domain)
+      uri = ::URI.parse(url.to_s)
+      query_string = query.to_s
+      signature = ::Rapa::Signer.new(
+        host: uri.host,
+        http_method: "GET",
+        key: secret_access_key,
+        path: uri.path,
+        query_string: query_string,
+      ).sign
+      faraday_response = connection.get(uri, query.to_hash.merge(Signature: signature))
+      response_class.new(faraday_response)
+    end
+  end
+end

data/lib/rapa/encoder.rb

@@ -0,0 +1,16 @@
+require "cgi"
+
+module Rapa
+  class Encoder
+    # @param parameters [Hash]
+    # @return [String]
+    def encode(parameters)
+      parameters.map do |key, value|
+        [
+          key,
+          ::CGI.escape(value),
+        ].join("=")
+      end.join("&")
+    end
+  end
+end

data/lib/rapa/error.rb

@@ -0,0 +1,21 @@
+module Rapa
+  class Error
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [String]
+    def code
+      source["Code"]
+    end
+
+    # @return [String]
+    def message
+      source["Message"]
+    end
+  end
+end

data/lib/rapa/image.rb

@@ -0,0 +1,26 @@
+module Rapa
+  class Image
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [Integer]
+    def height
+      ::Rapa::Quantity.new(source["Height"])
+    end
+
+    # @return [String]
+    def url
+      source["URL"]
+    end
+
+    # @return [Integer]
+    def width
+      ::Rapa::Quantity.new(source["Width"])
+    end
+  end
+end

data/lib/rapa/language.rb

@@ -0,0 +1,21 @@
+module Rapa
+  class Language
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [String]
+    def name
+      source["Name"]
+    end
+
+    # @return [String]
+    def type
+      source["Type"]
+    end
+  end
+end

data/lib/rapa/price.rb

@@ -0,0 +1,26 @@
+module Rapa
+  class Price
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [Integer]
+    def amount
+      source["Amount"].to_i
+    end
+
+    # @return [String]
+    def currency_code
+      source["CurrencyCode"]
+    end
+
+    # @return [String]
+    def formatted_price
+      source["FormattedPrice"]
+    end
+  end
+end

data/lib/rapa/quantity.rb

@@ -0,0 +1,21 @@
+module Rapa
+  class Quantity
+    # @return [Hash]
+    attr_reader :source
+
+    # @param source [Hash]
+    def initialize(source)
+      @source = source
+    end
+
+    # @return [String]
+    def units
+      source["Units"]
+    end
+
+    # @return [Integer]
+    def value
+      source["__content__"].to_i
+    end
+  end
+end