paapi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cad942d2b1dc53bddcf3aae1397a9e7381fc58c0f0cac8205dc104375bb3579
-  data.tar.gz: '09cbf5cf7e8a57ff2741bc3f60870dbe5f07f20983808399164a17c292b5726c'
+  metadata.gz: a4bac67043fb32a957f0b015eb468efbcc852b9e5285940ff152bdc012b4c751
+  data.tar.gz: e4f35c14a82bf615d95167b869cb7b73c69cc85e7f05bd0ef1c37a96556b5b78
 SHA512:
-  metadata.gz: ed07665c0791353feccdbc0589208592c4c032a45e9d8656d8ad63d7783e9380c5b5851aa6458c85fb736d4fc9e6e0beabd0beb8102a2b72ec0d43f4e8dd855b
-  data.tar.gz: 56418706b3d9a0c0cd8a2e6df5231a50d7b8df8963289a59fe0401ffe0fb015d634f9695ae750d7fbfff581cf7847baee4ae7e05a93c0d9d38a308ba034d1558
+  metadata.gz: 5943daef94869da7e96ca4d1b1b35fdd98f58f90bcebd7a00c24e1b11baf32cc5488986104b2d8edc95637076630437aaa2a5467683a8ca219e8a2a31b99aed4
+  data.tar.gz: 7dd1fd49d4c63a6e6ff67d2881137f0c7bd5c0fe6e166a917929b3f08d69f1a31dbbf63d3d5720f75fce53f3ff67fe0b5b3d097858eff99c362e0731fed68aec

data/README.md

@@ -2,6 +2,8 @@
 
 `paapi` is a slim wrapper around [Amazon's Product Advertising API 5.0](https://webservices.amazon.com/paapi5/documentation/).
 
+This gem is under development and currently incomplete.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/paapi.rb

@@ -1,21 +1,27 @@
 require 'paapi/version'
 
-require 'paapi/locales'
 require 'paapi/aws_request'
 require 'paapi/client'
+require 'paapi/item'
 require 'paapi/response'
 
 module Paapi
   class Error < StandardError; end
   class NotImplemented < StandardError; end
+  SEARCH_PARAMS = %i[keywords actor, artist, author, brand title].freeze
   DEFAULT_PARTNER_TYPE = 'Associates'
   DEFAULT_MARKET = :us
   DEFAULT_RESOURCES = [
     'Images.Primary.Large',
+    'ItemInfo.ByLineInfo',
     'ItemInfo.ContentInfo',
+    'ItemInfo.ExternalIds',
+    'ItemInfo.Features',
+    'ItemInfo.ManufactureInfo',
     'ItemInfo.ProductInfo',
+    'ItemInfo.TechnicalInfo', # Includes format when Kindle
     'ItemInfo.Title',
-    'ItemInfo.ExternalIds',
+    'ItemInfo.TradeInInfo',
     'Offers.Listings.Availability.Message',
     'Offers.Listings.Condition',
     'Offers.Listings.Condition.SubCondition',
@@ -25,7 +31,39 @@ module Paapi
     'Offers.Listings.MerchantInfo',
     'Offers.Listings.Price',
     'Offers.Listings.SavingBasis'
-  ]
+  ].freeze
+
+  Locale = Struct.new(:key, :name, :host, :region) do
+    def site
+      host.sub('webservices', 'www')
+    end
+  end
+
+  MARKETPLACES = {
+    au: Locale.new(:au, 'Australia',	          'webservices.amazon.com.au', 'us-west-2'),
+    br: Locale.new(:br, 'Brazil',	              'webservices.amazon.com.br'	 'us-east-1'),
+    ca: Locale.new(:ca, 'Canada',	              'webservices.amazon.ca',	   'us-east-1'),
+    fr: Locale.new(:fr, 'France',	              'webservices.amazon.fr',	   'eu-west-1'),
+    de: Locale.new(:de, 'Germany',	            'webservices.amazon.de',	   'eu-west-1'),
+    in: Locale.new(:in, 'India',	              'webservices.amazon.in',	   'eu-west-1'),
+    it: Locale.new(:it, 'Italy',	              'webservices.amazon.it',	   'eu-west-1'),
+    jp: Locale.new(:jp, 'Japan',	              'webservices.amazon.co.jp',	 'us-west-2'),
+    mx: Locale.new(:mx, 'Mexico',	              'webservices.amazon.com.mx', 'us-east-1'),
+    es: Locale.new(:es, 'Spain',                'webservices.amazon.es',	   'eu-west-1'),
+    tr: Locale.new(:tk, 'Turkey',	              'webservices.amazon.com.tr', 'eu-west-1'),
+    ae: Locale.new(:ae, 'United Arab Emirates',	'webservices.amazon.ae',	   'eu-west-1'),
+    uk: Locale.new(:uk, 'United Kingdom',	      'webservices.amazon.co.uk',	 'eu-west-1'),
+    us: Locale.new(:us, 'United States',	      'webservices.amazon.com',	   'us-east-1'),
+  }.freeze
+
+  Operation = Struct.new(:target_name, :endpoint_suffix, :http_method, :service )
+
+  OPERATIONS = {
+    get_browse_nodes: Operation.new( 'GetBrowseNodes', 'getbrowsenodes', 'POST', 'ProductAdvertisingAPI' ),
+    get_items:        Operation.new( 'GetItems',       'getitems',       'POST', 'ProductAdvertisingAPI' ),
+    get_variations:   Operation.new( 'GetVariations',  'getvariations',  'POST', 'ProductAdvertisingAPI' ),
+    search_items:     Operation.new( 'SearchItems',    'searchitems',    'POST', 'ProductAdvertisingAPI' )
+  }.freeze
 
   class << self
     attr_accessor :access_key,
@@ -43,4 +81,9 @@ module Paapi
     end
     alias_method :config, :configure
   end
+
+  def symbolize_keys(hash)
+    Hash[hash.map{|k,v| v.is_a?(Hash) ? [k.to_sym, symbolize_keys(v)] : [k.to_sym, v] }]
+  end
 end
+

data/lib/paapi/aws_request.rb

@@ -0,0 +1,47 @@
+require 'http'
+require 'aws-sigv4'
+
+# https://webservices.amazon.com/paapi5/documentation/common-request-parameters.html
+module Paapi
+  module AwsRequest
+    def do_request(op:,  payload:)
+      raise ArguemntError unless Paapi::OPERATIONS.keys.include?(op)
+
+      operation = OPERATIONS[op]
+
+      headers = {
+        'X-Amz-Target' => "com.amazon.paapi5.v1.ProductAdvertisingAPIv1.#{operation.target_name}",
+        'Content-Encoding' => 'amz-1.0',
+      }
+
+      default_payload = {
+        'PartnerTag' => partner_tag,
+        'PartnerType' => partner_type,
+        'Marketplace' => marketplace.site
+      }
+
+      payload = default_payload.merge(payload)
+
+      endpoint =  "https://#{marketplace.host}/paapi5/#{operation.endpoint_suffix}"
+
+      signer = Aws::Sigv4::Signer.new(
+        service: operation.service,
+        region: marketplace.region,
+        access_key_id: access_key,
+        secret_access_key: secret_key,
+        http_method: operation.http_method,
+        endpoint: marketplace.host
+      )
+
+      signature = signer.sign_request(http_method: operation.http_method, url: endpoint, headers: headers, body: payload.to_json)
+
+      headers['Host'] = marketplace.host
+      headers['X-Amz-Date'] = signature.headers['x-amz-date']
+      headers['X-Amz-Content-Sha256']= signature.headers['x-amz-content-sha256']
+      headers['Authorization'] = signature.headers['authorization']
+      headers['Content-Type'] = 'application/json; charset=utf-8'
+
+      HTTP.headers(headers).post(endpoint, json: payload )
+    end
+  end
+end

data/lib/paapi/client.rb

@@ -23,35 +23,38 @@ module Paapi
       @partner_tag = partner_tag if !partner_tag.nil?      
     end
 
-    def market=(_market)
-      @market = _market
+    def market=(a_market)
+      @market = a_market
       @marketplace = MARKETPLACES[market.to_sym]
       if !Paapi.partner_market.nil?
-        @partner_tag = Paapi.partner_market.dig(_market) || @partner_tag
+        @partner_tag = Paapi.partner_market.dig(a_market) || @partner_tag
       end
     end
 
     def get_items(item_ids:, **options)
-      item_ids = Array(item_ids)
-
-      payload = { ItemIds: item_ids, Resources:  @resources }
+      payload = { ItemIds: Array(item_ids), Resources:  @resources }
 
       res = do_request(op: :get_items, payload: payload)
 
-      Response.new(res)
+      # Errors, ItemResults -> Items -> Item
+      return Response.new(res)
     end
 
     def get_variations(asin:, **options )
       payload = { ASIN: asin, Resources:  @resources }
 
       res = do_request(op: :get_variations, payload: payload)
-      Response.new(res)
+      
+      # Errors, VariationsResult->Items
+       Response.new(res)
     end
 
-    def search_items(keywords:, **options )
-      search_index = 'All'
 
-      # %i[Keywords Actor Artist Author Brand Title ]
+    # TODO: Currently we assume Keywords, but we need one of the follow: [Keywords Actor Artist Author Brand Title ]
+    def search_items(keywords: nil, **options )
+      raise ArgumentError("Missing keywords") unless (options.keys | SEARCH_PARAMS).length.positive?
+
+      search_index = options.dig(:SearchIndex) ||'All'
 
       payload = { Keywords: keywords, Resources:  @resources, ItemCount: 10, ItemPage: 1, SearchIndex: search_index }.merge(options)
 
@@ -60,9 +63,13 @@ module Paapi
       Response.new(res)
     end
 
-    def get_browse_nodes(keywords:, **options)
-      raise NotImplemented
-      #Response.new(Request.new(client: self).get_browse_nodes(keywords: keywords, **options))
+    def get_browse_nodes(browse_node_ids:, **options)
+      resources = ['BrowseNodes.Ancestor', 'BrowseNodes.Children']
+      payload = { BrowseNodeIds: Array(browse_node_ids), Resources:  @resources }.merge(options)
+
+      res = do_request(op: :get_browse_nodes, payload: payload)
+
+      Response.new(res)
     end
   end
 end

data/lib/paapi/item.rb

@@ -0,0 +1,113 @@
+require 'nameable'
+
+module Paapi
+  class Item
+    attr_accessor :raw
+    def initialize(data)
+      @raw = data
+    end
+
+    def asin
+      get(['ASIN'])
+    end
+
+    def detail_url
+      get(['DetailPageURL'])
+    end
+
+    def image_url
+      get(%w{Images Primary Large Height URL})
+    end
+
+    def title
+      get(%w{ItemInfo Title DisplayValue})
+    end
+    
+    def manufacturer
+      get(%w{ItemInfo ByLineInfo Manufacturer DisplayValue})
+    end
+    
+    def publisher
+      manufacturer
+    end
+    
+    def publication_date
+      d = get(%w{ItemInfo ContentInfo PublicationDate DisplayValue})
+      return d.nil? ? nil : Date.parse(d)
+    end
+    
+    def release_date
+      d = get(%w{ItemInfo ProductInfo ReleaseDate DisplayValue})
+      return d.nil? ? nil : Date.parse(d)
+    end
+
+    def contributors
+      get(%w{ItemInfo ByLineInfo Contributors})
+    end
+    
+    def contributors_of(kind)
+      contributors&.select { |e| e['Role'] == kind }&.map { |e| Nameable(e['Name'])}
+    end
+    
+    def authors
+      contributors_of 'Author'
+    end
+    
+    def illustrators
+      contributors_of 'Illustrator'
+    end
+    
+    def actors
+      contributors_of 'Actor'
+    end
+
+    def narrators
+      contributors_of 'Narrator'
+    end
+    
+    def publishers
+      contributors_of 'Publisher' 
+    end
+
+    def release_date
+      get(%w{ItemInfo ReleaseDate})
+    end
+
+    def eans
+      get(%w{ItemInfo ExternalIds EANs DisplayValues})
+    end
+
+    def upcs
+      get(%w{ItemInfo ExternalIds UPCs DisplayValues})
+    end
+
+    def features
+      get(%w{ItemInfo Features DisplayValues})&.join(' ')
+    end
+    
+    def brand
+      get(%w{ItemInfo ByLineInfo Brand DisplayValue})
+    end
+
+    def part_number
+      get(%w{ItemInfo ManufactureInfo ItemPartNumber DisplayValue})
+    end
+
+    def package
+      get(%w{ItemInfo TechnicalInfo Formats DisplayValues})
+    end
+
+    def kindle?
+      !package.nil? && package&.include?('Kindle eBook')
+    end
+
+    def get(keys)
+      @raw.dig(*keys)
+    end
+    
+    def self.to_items(data)
+      data.map {|d| Item.new(d)}
+    end
+    
+  end
+end

data/lib/paapi/response.rb

@@ -2,10 +2,41 @@ require 'json'
 
 module Paapi
   class Response
-    attr_reader :http_response, :data
+    attr_reader :http_response, :data, :datas, :doc, :items
+
     def initialize(response)
       @http_response = response
-      @data = JSON.parse( response.body.to_s )
+      @data = JSON.parse(response.body.to_s)
+      
+      @datas = symbolise(JSON.parse(response.body.to_s))
+      @doc  = JSON.parse(@datas.to_json, object_class: OpenStruct)
+
+      @items_data = @data.dig('ItemsResult', 'Items')
+      @items_data ||= @data.dig('SearchResult', 'Items')
+      @items_data ||= []
+      
+      @items = @items_data.map {|d| Item.new(d)}
+
     end
+  
+    def snake_case(s)
+      return s.downcase if s.match(/\A[A-Z]+\z/)
+      s.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z])([A-Z])/, '\1_\2').
+      downcase
+    end
+    
+    def symbolise(obj)
+      if obj.is_a? Hash
+        return obj.inject({}) do |memo, (k, v)|
+          memo.tap { |m| m[snake_case(k)] = symbolise(v) }
+        end
+      elsif obj.is_a? Array
+        return obj.map { |memo| symbolise(memo) }
+      end
+      obj
+    end
+
+    
   end
 end

data/lib/paapi/version.rb

@@ -1,3 +1,3 @@
 module Paapi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/paapi.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'http', '~> 4'
   spec.add_dependency 'aws-sigv4', '~> 1'
+  spec.add_dependency 'nameable', '~> 1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paapi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dan Milne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: nameable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 description: 
 email:
 - d@nmilne.com
@@ -124,7 +138,9 @@ files:
 - bin/console
 - bin/setup
 - lib/paapi.rb
+- lib/paapi/aws_request.rb
 - lib/paapi/client.rb
+- lib/paapi/item.rb
 - lib/paapi/response.rb
 - lib/paapi/version.rb
 - paapi.gemspec