dkam/paapi
1
0
Fork 0
mirror of https://github.com/dkam/paapi.git synced 2025-12-28 07:04:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add configuration system and documentation. Clean up tests

Browse Source
This commit is contained in:
Dan Milne
2019-09-10 09:25:23 +10:00
parent f1e946d946
commit 250986d1c7
5 changed files with 138 additions and 272 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Gemfile
View File

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

30
README.md
View File

@@ -20,6 +20,8 @@ Or install it yourself as:
## Usage ## Usage
### Configuration
The library can be initialised with a Rails initializer such as The library can be initialised with a Rails initializer such as
```ruby ```ruby
@@ -35,14 +37,38 @@ Configurable itemes:
* secret_key * secret_key
* partner_tag * partner_tag
* partner_type * partner_type
* marketplace * market
* partner_market
* test_mode * test_mode
Using the `partner_market` configuration item lets you set a hash of marketplaces and partner_tags.
```ruby
Paapi.configure do |config|
config.access_key = 'your-access-key'
config.secret_key = 'your-secret-key'
config.partner_market = {au: 'au_partner_tag', us: 'us_partner_tag'}
end
client = Paapi::Client.new(market: :au)
client.partner_tag
> 'au_partner_tag'
client.market = :us
client.partner_tag
> 'us_partner_tag'
```
The full list of market keys is `au, br, ca, fr, de, in, it, jp, mx, es, tr, ae, uk, us`
### Using the Paapi
```ruby ```ruby
require 'paapi' require 'paapi'
client = Paapi::Client.new(access_key: ENV['access_key'], secret_key: ENV['secret_key'], marketplace: :au, partner_tag: ENV['partner_tag']) client = Paapi::Client.new(access_key: ENV['access_key'], secret_key: ENV['secret_key'], market: :au, partner_tag: ENV['partner_tag'])
gi = client.get_items(item_ids: '1857231384') gi = client.get_items(item_ids: '1857231384')

22
lib/paapi.rb
View File

@@ -8,13 +8,33 @@ require 'paapi/response'
module Paapi module Paapi
class Error < StandardError; end class Error < StandardError; end
class NotImplemented < StandardError; end class NotImplemented < StandardError; end
DEFAULT_PARTNER_TYPE = 'Associates'
DEFAULT_MARKET = :us
DEFAULT_RESOURCES = [
'Images.Primary.Large',
'ItemInfo.ContentInfo',
'ItemInfo.ProductInfo',
'ItemInfo.Title',
'ItemInfo.ExternalIds',
'Offers.Listings.Availability.Message',
'Offers.Listings.Condition',
'Offers.Listings.Condition.SubCondition',
'Offers.Listings.DeliveryInfo.IsAmazonFulfilled',
'Offers.Listings.DeliveryInfo.IsFreeShippingEligible',
'Offers.Listings.DeliveryInfo.IsPrimeEligible',
'Offers.Listings.MerchantInfo',
'Offers.Listings.Price',
'Offers.Listings.SavingBasis'
]
class << self class << self
attr_accessor :access_key, attr_accessor :access_key,
:secret_key, :secret_key,
:partner_tag, :partner_tag,
:partner_type, :partner_type,
:marketplace, :market,
:partner_market,
:resources,
:test_mode :test_mode
def configure def configure

49
lib/paapi/client.rb
View File

@@ -3,40 +3,35 @@ require 'http'
module Paapi module Paapi
class Client class Client
include AwsRequest include AwsRequest
attr_accessor :marketplace, :partner_tag attr_accessor :partner_tag, :marketplace, :resources
attr_reader :partner_type, :access_key, :secret_key attr_reader :partner_type, :access_key, :secret_key, :market
def initialize(access_key: Paapi.access_key, def initialize(access_key: Paapi.access_key,
secret_key: Paapi.secret_key, secret_key: Paapi.secret_key,
marketplace: Paapi.marketplace || :us, partner_tag: Paapi.partner_tag,
partner_tag: Paapi.partner_tag, market: Paapi.market || DEFAULT_MARKET,
resources: nil, resources: Paapi.resources || DEFAULT_RESOURCES,
partner_type: 'Associates' partner_type: DEFAULT_PARTNER_TYPE
) )
raise ArgumentError unless MARKETPLACES.keys.include?(marketplace.to_sym) raise ArgumentError unless MARKETPLACES.keys.include?(market.to_sym)
@access_key = access_key @access_key = access_key
@secret_key = secret_key @secret_key = secret_key
@marketplace = MARKETPLACES[marketplace.to_sym]
@partner_tag = partner_tag
@partner_type = partner_type @partner_type = partner_type
@resources = resources || [ @resources = resources unless resources.nil?
"Images.Primary.Large",
"ItemInfo.ContentInfo", self.market = market
"ItemInfo.ProductInfo", @partner_tag = partner_tag if !partner_tag.nil?
"ItemInfo.Title",
"ItemInfo.ExternalIds",
"Offers.Listings.Availability.Message",
"Offers.Listings.Condition",
"Offers.Listings.Condition.SubCondition",
"Offers.Listings.DeliveryInfo.IsAmazonFulfilled",
"Offers.Listings.DeliveryInfo.IsFreeShippingEligible",
"Offers.Listings.DeliveryInfo.IsPrimeEligible",
"Offers.Listings.MerchantInfo",
"Offers.Listings.Price",
"Offers.Listings.SavingBasis"
]
end end
def market=(_market)
@market = _market
@marketplace = MARKETPLACES[market.to_sym]
if !Paapi.partner_market.nil?
@partner_tag = Paapi.partner_market.dig(_market) || @partner_tag
end
end
def get_items(item_ids:, **options) def get_items(item_ids:, **options)
item_ids = Array(item_ids) item_ids = Array(item_ids)

307
test/paapi_test.rb
View File

@@ -1,253 +1,78 @@
require "test_helper" require 'test_helper'
class PaapiTest < Minitest::Test class PaapiTest < Minitest::Test
def setup
Paapi.configure do |config|
config.access_key = nil
config.secret_key = nil
config.market = nil
config.partner_tag = nil
config.resources = nil
config.partner_type = nil
end
end
def test_that_it_has_a_version_number def test_that_it_has_a_version_number
refute_nil ::Paapi::VERSION refute_nil ::Paapi::VERSION
end end
def test_it_does_something_useful def test_configuration_is_correctly_set_using_partner_market
assert false Paapi.configure do |config|
config.access_key = 'some_key'
config.secret_key = 'some_secret'
config.partner_market = {au: 'au_partner', us: 'us_partner', uk: 'uk_partner', ca: 'ca_partner'}
end
c = Paapi::Client.new
assert_equal :us, c.market, "Default Market should be US"
assert_equal 'us_partner', c.partner_tag
c = Paapi::Client.new(market: :au)
assert_equal 'au_partner', c.partner_tag
c.market = :ca
assert_equal 'ca_partner', c.partner_tag
# set the market to an unconfigured market, should not change the partner_tag
orig_tag = c.partner_tag
c.market = :gb
assert_equal orig_tag, c.partner_tag
end end
def test_json_payload_generation def test_configuration_is_correctly_set_using
payload = { Paapi.configure do |config|
"Keywords": "9781473619814", config.access_key = 'some_key'
"Resources": [ config.secret_key = 'some_secret'
"Images.Primary.Large", config.partner_tag = 'abc'
"ItemInfo.ByLineInfo", config.market = :uk
"ItemInfo.ContentInfo", end
"ItemInfo.ContentRating",
"ItemInfo.Classifications",
"ItemInfo.ExternalIds",
"ItemInfo.Features",
"ItemInfo.ManufactureInfo",
"ItemInfo.ProductInfo",
"ItemInfo.TechnicalInfo",
"ItemInfo.Title",
"ItemInfo.TradeInInfo",
"Offers.Listings.Availability.MaxOrderQuantity",
"Offers.Listings.Availability.Message",
"Offers.Listings.Availability.MinOrderQuantity",
"Offers.Listings.Availability.Type",
"Offers.Listings.Condition",
"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"
],
"PartnerTag": "booko01-22",
"PartnerType": "Associates",
"Marketplace": "www.amazon.com.au",
"Operation": "SearchItems"
}
headers = %q{Host: webservices.amazon.com.au c = Paapi::Client.new
X-Amz-Date: 20190903T014126Z
X-Amz-Target: com.amazon.paapi5.v1.ProductAdvertisingAPIv1.SearchItems
Content-Encoding: amz-1.0}
request = %q{https://webservices.amazon.com.au/!YW16LTEuMDtjb20uYW1hem9uLnBhYXBpNS52MS5Qcm9kdWN0QWR2ZXJ0aXNpbmdBUEl2MS5TZWFyY2hJdGVtczt7CiAgICAiS2V5d29yZHMiOiAiOTc4MTQ3MzYxOTgxNCIsCiAgICAiUmVzb3VyY2VzIjogWwogICAgICAgICJJbWFnZXMuUHJpbWFyeS5MYXJnZSIsCiAgICAgICAgIkl0ZW1JbmZvLkJ5TGluZUluZm8iLAogICAgICAgICJJdGVtSW5mby5Db250ZW50SW5mbyIsCiAgICAgICAgIkl0ZW1JbmZvLkNvbnRlbnRSYXRpbmciLAogICAgICAgICJJdGVtSW5mby5DbGFzc2lmaWNhdGlvbnMiLAogICAgICAgICJJdGVtSW5mby5FeHRlcm5hbElkcyIsCiAgICAgICAgIkl0ZW1JbmZvLkZlYXR1cmVzIiwKICAgICAgICAiSXRlbUluZm8uTWFudWZhY3R1cmVJbmZvIiwKICAgICAgICAiSXRlbUluZm8uUHJvZHVjdEluZm8iLAogICAgICAgICJJdGVtSW5mby5UZWNobmljYWxJbmZvIiwKICAgICAgICAiSXRlbUluZm8uVGl0bGUiLAogICAgICAgICJJdGVtSW5mby5UcmFkZUluSW5mbyIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5BdmFpbGFiaWxpdHkuTWF4T3JkZXJRdWFudGl0eSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5BdmFpbGFiaWxpdHkuTWVzc2FnZSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5BdmFpbGFiaWxpdHkuTWluT3JkZXJRdWFudGl0eSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5BdmFpbGFiaWxpdHkuVHlwZSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5Db25kaXRpb24iLAogICAgICAgICJPZmZlcnMuTGlzdGluZ3MuQ29uZGl0aW9uLlN1YkNvbmRpdGlvbiIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5EZWxpdmVyeUluZm8uSXNBbWF6b25GdWxmaWxsZWQiLAogICAgICAgICJPZmZlcnMuTGlzdGluZ3MuRGVsaXZlcnlJbmZvLklzRnJlZVNoaXBwaW5nRWxpZ2libGUiLAogICAgICAgICJPZmZlcnMuTGlzdGluZ3MuRGVsaXZlcnlJbmZvLklzUHJpbWVFbGlnaWJsZSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5EZWxpdmVyeUluZm8uU2hpcHBpbmdDaGFyZ2VzIiwKICAgICAgICAiT2ZmZXJzLkxpc3RpbmdzLklzQnV5Qm94V2lubmVyIiwKICAgICAgICAiT2ZmZXJzLkxpc3RpbmdzLkxveWFsdHlQb2ludHMuUG9pbnRzIiwKICAgICAgICAiT2ZmZXJzLkxpc3RpbmdzLk1lcmNoYW50SW5mbyIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5QcmljZSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5Qcm9ncmFtRWxpZ2liaWxpdHkuSXNQcmltZUV4Y2x1c2l2ZSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5Qcm9ncmFtRWxpZ2liaWxpdHkuSXNQcmltZVBhbnRyeSIsCiAgICAgICAgIk9mZmVycy5MaXN0aW5ncy5Qcm9tb3Rpb25zIiwKICAgICAgICAiT2ZmZXJzLkxpc3RpbmdzLlNhdmluZ0Jhc2lzIiwKICAgICAgICAiT2ZmZXJzLlN1bW1hcmllcy5IaWdoZXN0UHJpY2UiLAogICAgICAgICJPZmZlcnMuU3VtbWFyaWVzLkxvd2VzdFByaWNlIiwKICAgICAgICAiT2ZmZXJzLlN1bW1hcmllcy5PZmZlckNvdW50IgogICAgXSwKICAgICJQYXJ0bmVyVGFnIjogImJvb2tvMDEtMjIiLAogICAgIlBhcnRuZXJUeXBlIjogIkFzc29jaWF0ZXMiLAogICAgIk1hcmtldHBsYWNlIjogInd3dy5hbWF6b24uY29tLmF1Igp9} assert_equal 'abc', c.partner_tag
assert_equal :uk, c.market
response = { assert_equal 'some_key', c.access_key
"SearchResult": {
"Items": [
{
"ASIN": "1473619815",
"DetailPageURL": "https://www.amazon.com.au/dp/1473619815?tag=booko01-22&linkCode=osi&th=1&psc=1",
"Images": {
"Primary": {
"Large": {
"Height": 500,
"URL": "https://m.media-amazon.com/images/I/51HoUcxVnFL.jpg",
"Width": 325
}
}
},
"ItemInfo": {
"ByLineInfo": {
"Contributors": [
{
"Locale": "en_AU",
"Name": "Chambers, Becky",
"Role": "Author"
}
],
"Manufacturer": {
"DisplayValue": "Hodder Paperbacks",
"Label": "Manufacturer",
"Locale": "en_AU"
}
},
"Classifications": {
"Binding": {
"DisplayValue": "Paperback",
"Label": "Binding",
"Locale": "en_AU"
},
"ProductGroup": {
"DisplayValue": "Book",
"Label": "ProductGroup",
"Locale": "en_AU"
}
},
"ContentInfo": {
"Edition": {
"DisplayValue": "1",
"Label": "Edition",
"Locale": "en_AU"
},
"Languages": {
"DisplayValues": [
{
"DisplayValue": "English",
"Type": "Published"
},
{
"DisplayValue": "English",
"Type": "Original Language"
},
{
"DisplayValue": "English",
"Type": "Unknown"
}
],
"Label": "Language",
"Locale": "en_AU"
},
"PagesCount": {
"DisplayValue": 432,
"Label": "NumberOfPages",
"Locale": "en_US"
},
"PublicationDate": {
"DisplayValue": "2016-03-08T00:00:01Z",
"Label": "PublicationDate",
"Locale": "en_US"
}
},
"ExternalIds": {
"EANs": {
"DisplayValues": [
"9781473619814"
],
"Label": "EAN",
"Locale": "en_US"
},
"ISBNs": {
"DisplayValues": [
"1473619815"
],
"Label": "ISBN",
"Locale": "en_US"
}
},
"ManufactureInfo": {
"ItemPartNumber": {
"DisplayValue": "23025256",
"Label": "PartNumber",
"Locale": "en_US"
}
},
"ProductInfo": {
"ItemDimensions": {
"Weight": {
"DisplayValue": 471,
"Label": "Weight",
"Locale": "en_AU",
"Unit": "Grams"
}
},
"ReleaseDate": {
"DisplayValue": "2016-03-08T00:00:01Z",
"Label": "ReleaseDate",
"Locale": "en_US"
},
"UnitCount": {
"DisplayValue": 1,
"Label": "NumberOfItems",
"Locale": "en_US"
}
},
"Title": {
"DisplayValue": "The Long Way to a Small, Angry Planet: Wayfarers 1",
"Label": "Title",
"Locale": "en_AU"
}
},
"Offers": {
"Listings": [
{
"Availability": {
"MaxOrderQuantity": 20,
"Message": "In stock.",
"MinOrderQuantity": 1,
"Type": "Now"
},
"Condition": {
"SubCondition": {
"Value": "New"
},
"Value": "New"
},
"DeliveryInfo": {
"IsAmazonFulfilled": true,
"IsFreeShippingEligible": true,
"IsPrimeEligible": true
},
"Id": "1UP5v2BpBF5QeBZF7Dge7V%2BN3pdmW4ZkvT%2BvE4GABbmz4koGqDSZFDZwQj5o95bZrvKmWdqZPW0SiDhCIOjyAKlRmsz4hYXtSkQLSlwCc77AiiAbX1ja0CBjRVVdgLJ6",
"IsBuyBoxWinner": true,
"MerchantInfo": {
"Id": "ANEGB3WVEVKZB",
"Name": "Amazon AU"
},
"Price": {
"Amount": 16.41,
"Currency": "AUD",
"DisplayAmount": "$16.41"
},
"ProgramEligibility": {
"IsPrimeExclusive": false,
"IsPrimePantry": false
},
"ViolatesMAP": false
}
],
"Summaries": [
{
"Condition": {
"Value": "New"
},
"HighestPrice": {
"Amount": 49.31,
"Currency": "AUD",
"DisplayAmount": "$49.31"
},
"LowestPrice": {
"Amount": 15.46,
"Currency": "AUD",
"DisplayAmount": "$15.46"
},
"OfferCount": 18
}
]
}
}
],
"SearchURL": "https://www.amazon.com.au/s?k=9781473619814&rh=p_n_availability%3A-1&tag=booko01-22&linkCode=osi",
"TotalResultCount": 1
}
}
end end
def test_configuration_defaults_are_correct
Paapi.configure do |config|
config.access_key = 'some_key'
config.secret_key = 'some_secret'
end
c = Paapi::Client.new
assert_equal Paapi::DEFAULT_RESOURCES, c.resources
resources = ['test1', 'test2']
Paapi.configure do |config|
config.access_key = 'some_key'
config.secret_key = 'some_secret'
config.resources = resources
end
c = Paapi::Client.new
assert_equal resources, c.resources
end
end end