paapi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4bac67043fb32a957f0b015eb468efbcc852b9e5285940ff152bdc012b4c751
-  data.tar.gz: e4f35c14a82bf615d95167b869cb7b73c69cc85e7f05bd0ef1c37a96556b5b78
+  metadata.gz: c51a902c63c17b386688df97e49c8b201fb3309de82ace4b9e9b5d9f420923ff
+  data.tar.gz: c312da6d5bfb22c21b43f5449e616c48fcf661dfd08e9e4b2e106512c6c5575d
 SHA512:
-  metadata.gz: 5943daef94869da7e96ca4d1b1b35fdd98f58f90bcebd7a00c24e1b11baf32cc5488986104b2d8edc95637076630437aaa2a5467683a8ca219e8a2a31b99aed4
-  data.tar.gz: 7dd1fd49d4c63a6e6ff67d2881137f0c7bd5c0fe6e166a917929b3f08d69f1a31dbbf63d3d5720f75fce53f3ff67fe0b5b3d097858eff99c362e0731fed68aec
+  metadata.gz: f76777564d20118875ecb809a5c32c88a7d58245b3012947a4a55ac150e182e88cf34179de9e60999dd03b404cd9dea136346e12aec7199161ab122bf62f6f00
+  data.tar.gz: b2c64410108d2d2e4ce5e8bed0a1da8eee6d4fff83fd3c176b737e771d030cb5972c6e9cf84a3b26de2673f6b15116a622b7d3423b1bde252fbfd66c97e1dcdc

data/README.md

@@ -2,7 +2,9 @@
 
 `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.
+This gem is under heavy development and currently incomplete.
+
+[![Build Status](https://travis-ci.org/dkam/paapi.svg?branch=master)](https://travis-ci.org/dkam/paapi)
 
 ## Installation
 
@@ -24,7 +26,7 @@ Or install it yourself as:
 
 ### Configuration
 
-The library can be initialised with a Rails initializer such as
+The library can be configured with an initializer. For Rails, create the file `config/initializers/paapi.rb`
 
 ```ruby
 Paapi.configure do |config|
@@ -83,6 +85,8 @@ gv = client.get_variations(asin: 'B00422MCUS')
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+If you create a file `config.rb`, it will be loaded by `bin/console`, allowing you to configure keys and markets.
+
 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

data/bin/console

@@ -11,4 +11,5 @@ require 'paapi'
 # Pry.start
 
 require 'irb'
+load 'config.rb' if File.exist? 'config.rb'
 IRB.start(__FILE__)

data/lib/paapi/client.rb

@@ -1,8 +1,9 @@
 require 'http'
+require 'aws-sigv4'
 
 module Paapi
   class Client
-    include AwsRequest
+
     attr_accessor :partner_tag, :marketplace, :resources
     attr_reader :partner_type, :access_key, :secret_key, :market
 
@@ -14,13 +15,14 @@ module Paapi
                    partner_type: DEFAULT_PARTNER_TYPE
                   )
       raise ArgumentError unless MARKETPLACES.keys.include?(market.to_sym)
+
       @access_key = access_key
       @secret_key = secret_key
       @partner_type = partner_type
       @resources = resources unless resources.nil?
 
       self.market = market
-      @partner_tag = partner_tag if !partner_tag.nil?      
+      @partner_tag = partner_tag if !partner_tag.nil?
     end
 
     def market=(a_market)
@@ -33,23 +35,14 @@ module Paapi
 
     def get_items(item_ids:, **options)
       payload = { ItemIds: Array(item_ids), Resources:  @resources }
-
-      res = do_request(op: :get_items, payload: payload)
-
-      # Errors, ItemResults -> Items -> Item
-      return Response.new(res)
+      request(op: :get_items, payload: payload)
     end
 
     def get_variations(asin:, **options )
       payload = { ASIN: asin, Resources:  @resources }
-
-      res = do_request(op: :get_variations, payload: payload)
-      
-      # Errors, VariationsResult->Items
-       Response.new(res)
+      request(op: :get_variations, payload: payload)
     end
 
-
     # 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?
@@ -58,18 +51,56 @@ module Paapi
 
       payload = { Keywords: keywords, Resources:  @resources, ItemCount: 10, ItemPage: 1, SearchIndex: search_index }.merge(options)
 
-      res = do_request(op: :search_items, payload: payload)
-
-      Response.new(res)
+      request(op: :search_items, payload: payload)
     end
 
     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)
+      request(op: :get_browse_nodes, payload: payload)
+    end
+    
+    private
+    
+    def 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'
+
+      Response.new( HTTP.headers(headers).post(endpoint, json: payload ) )
     end
   end
+  
+  
 end

data/lib/paapi/item.rb

@@ -2,9 +2,13 @@ require 'nameable'
 
 module Paapi
   class Item
-    attr_accessor :raw
+    attr_accessor :hash
     def initialize(data)
-      @raw = data
+      @hash = data
+    end
+
+    def listings
+      get(['Offers', 'Listings']).map {|d| Listing.new(d)}
     end
 
     def asin
@@ -22,20 +26,20 @@ module Paapi
     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)
@@ -44,33 +48,33 @@ module Paapi
     def contributors
       get(%w{ItemInfo ByLineInfo Contributors})
     end
-    
+
     def contributors_of(kind)
-      contributors&.select { |e| e['Role'] == kind }&.map { |e| Nameable(e['Name'])}
+      contributors&.select { |e| e['Role'] == kind.to_s.gsub(/([[:alpha:]]+)/) { |w| w.capitalize } }&.map { |e| Nameable(e['Name'])}
     end
-    
+
+    def actors
+      contributors_of 'Actor'
+    end
+
+    def artists
+      contributors_of 'Artist'
+    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})
+    def publishers
+      contributors_of 'Publisher'
     end
 
     def eans
@@ -84,7 +88,7 @@ module Paapi
     def features
       get(%w{ItemInfo Features DisplayValues})&.join(' ')
     end
-    
+
     def brand
       get(%w{ItemInfo ByLineInfo Brand DisplayValue})
     end
@@ -93,6 +97,10 @@ module Paapi
       get(%w{ItemInfo ManufactureInfo ItemPartNumber DisplayValue})
     end
 
+    def model
+      get(%w{ItemInfo ManufactureInfo Model})
+    end
+
     def package
       get(%w{ItemInfo TechnicalInfo Formats DisplayValues})
     end
@@ -102,12 +110,12 @@ module Paapi
     end
 
     def get(keys)
-      @raw.dig(*keys)
+      @hash.dig(*keys)
     end
-    
+
     def self.to_items(data)
       data.map {|d| Item.new(d)}
     end
-    
+
   end
 end

data/lib/paapi/response.rb

@@ -2,41 +2,25 @@ require 'json'
 
 module Paapi
   class Response
-    attr_reader :http_response, :data, :datas, :doc, :items
+    attr_reader :http_response, :json, :datas, :doc, :items
 
     def initialize(response)
       @http_response = response
-      @data = JSON.parse(response.body.to_s)
-      
-      @datas = symbolise(JSON.parse(response.body.to_s))
-      @doc  = JSON.parse(@datas.to_json, object_class: OpenStruct)
+      @json = JSON.parse(response.body.to_s)
 
-      @items_data = @data.dig('ItemsResult', 'Items')
-      @items_data ||= @data.dig('SearchResult', 'Items')
+      @items_data = @json.dig('ItemsResult', 'Items')
+      @items_data ||= @json.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
+
+    def result_count
+      @json.dig('SearchResult', 'TotalResultCount')
     end
 
-    
+
+
   end
 end

data/lib/paapi/version.rb

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

data/lib/paapi.rb

@@ -1,6 +1,5 @@
 require 'paapi/version'
 
-require 'paapi/aws_request'
 require 'paapi/client'
 require 'paapi/item'
 require 'paapi/response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dan Milne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2019-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,7 +138,6 @@ 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

data/lib/paapi/aws_request.rb

@@ -1,47 +0,0 @@
-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