rakuten_product_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1fd5a4ee5820366f85f0c1266d2f0edd5ce8375343e64cccd6c55ab95274619
-  data.tar.gz: 56e0a89e406c5d7e16cf7b9cc80be336eba8d9ae1fc1c01c94d6088d980c8815
+  metadata.gz: 40785ddd9e89396be1d1e1831b0bda84092e17468308df8a9d381c15fa3124b4
+  data.tar.gz: 6bd0cc952f0a5f31a324b9d01f861c24dc8acb17c0745782079702db1f57856e
 SHA512:
-  metadata.gz: 67867a384786c0c5f316fb228a130c5e8593a8d7e18639d305de3849a7d78a467c19c57f5ec1406bc0e5ef674031c4834c280abf9a974bf9b5f0f86fb53b7994
-  data.tar.gz: e27d9b209f5f6ac43cbd9ae8af25a0ccb74d343ec89e11601604cbbbae85f538521db537a85ec4bafb235b306777b18ba0fd0c91839ad926a8b914495df40061
+  metadata.gz: 76780f846ad13f4098a3eb1eaca268eddb966053baed830f5a531857f33065998e379e840dd594d0d11124339e3885c1cd0719e7ed279e850f6f7c76d50dd917
+  data.tar.gz: 22a2d56430510a521f8b3ca7b3ff881eea656033b4ac56c7e7b540eb344c0e77fa80f7c73045951892641d576b8db6713dac722765931c8a7101635065717038

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    rakuten_product_api (0.1.0)
-      byebug
-      nokogiri
+    rakuten_product_api (0.2.0)
+      nokogiri (~> 1)
 
 GEM
   remote: https://rubygems.org/
@@ -39,6 +38,7 @@ PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
+  byebug (~> 11)
   minitest (~> 5.0)
   rake (~> 13.0)
   rakuten_product_api!

data/README.md

@@ -1,10 +1,10 @@
 # RakutenProductApi
 
-To experiment with that code, run `bin/console` for an interactive prompt.
+To experiment with this library, run `bin/console` for an interactive prompt.
 
 ## API Documentation
 
-The API documentation can be found at the following links.
+The Rakuten Product API documentation can be found at the following links.
 - [API Documentation PDF](https://developers.rakutenmarketing.com/console/registry/resource/_system/governance/apimgt/applicationdata/provider/RakutenMarketing/artifacts/API_Developer_Portal-Acquiring_Your_Access_Token_Guide.pdf)
 - [API Overview](https://developers.rakutenmarketing.com/subscribe/)
 - [API Keys](https://developers.rakutenmarketing.com/subscribe/site/pages/subscriptions.jag)
@@ -39,8 +39,6 @@ RakutenProductApi.configure do |config|
 end
 ```
 
-Additionally, you can configure a mid (Merchant ID).  This will be applied to all requests and restrict queries to that merchant.
-
 Once you have configured the library, you can create a client.
 
 ```ruby
@@ -50,8 +48,27 @@ client.username
 => "dkam"
 ```
 
-### Search
-Search for keywords:
+This client should be threadsafe.  Configuration values are local to your instance.
+
+### Authentication
+This library needs to query the API to retreive an `access_token` which has an `access_expires_at` time, prior to which, the library will refresh the token
+
+You can initialise the library with the `access_token` and `access_expires_at` values to avoid this lookup. If the `access_expires_at` is in the past, the library will fetch the value so you can safely cache this value and use it without checking it's expiry.
+
+```ruby
+client = RakutenProductApi::Client.new(access_token: 'abcd1234', access_expires_at: 1613362973)
+
+client.username
+=> "dkam"
+
+client.access_token
+=> "abcd1234"
+````
+
+## Querying
+### Search for keywords:
+
+You can specify which merchants to query by using `mid: 38131`
 
 ```ruby
 results = client.search(keyword: 'Murderbot', mid: 38131)
@@ -74,7 +91,9 @@ results.items[0].rrp
 => ["18.70", "AUD"]
 ```
 
-Search for ISBNs:
+### Search for ISBNs:
+
+You can specify which merchants to query by using `mid: 38131`
 
 ```ruby
 results = client.search(keyword: '9781501977824', mid: 38131)
@@ -93,8 +112,6 @@ The API also allows other attribute:
 
 When using sort, you must also use sorttype ( 'asc' or 'dsc').  See the documentation for more.
 
-This client should be threadsafe.  Configuration values are local to your instance.
-
 ## TODO
 
 This library implement the parts I need. For example, it doesn't handle paging through results as I don't need it, but I'm happy to accept pull request.
@@ -109,7 +126,7 @@ This library implement the parts I need. For example, it doesn't handle paging t
 
 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.
+If you create a file `config.rb`, it will be loaded by `bin/console`, allowing you to configure it automatically.
 
 ```ruby
 RakutenProductApi.configure do |config|

data/lib/rakuten_product_api.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
+require "forwardable"
 require_relative "rakuten_product_api/version"
+require_relative "rakuten_product_api/authenticate"
 require_relative "rakuten_product_api/client"
 require_relative "rakuten_product_api/response"
 require_relative "rakuten_product_api/item"

data/lib/rakuten_product_api/authenticate.rb

@@ -0,0 +1,96 @@
+require "uri"
+require "net/http"
+require "net/https"
+require "base64"
+require "json"
+
+module RakutenProductApi
+  class Authenticate
+    REFRESH_TOKEN_LEEWAY = 60 * 10 # Ten minutes prior to expiry we should refresh token
+    attr_accessor :sid, :username, :password, :consumer_key, :consumer_secret, :access_token, :access_expires_at
+
+    def initialize(sid:               RakutenProductApi.sid,
+                   username:          RakutenProductApi.username,
+                   password:          RakutenProductApi.password,
+                   consumer_key:      RakutenProductApi.consumer_key,
+                   consumer_secret:   RakutenProductApi.consumer_secret,
+                   access_token:      nil,
+                   access_expires_at: nil)
+
+      @sid               = sid
+      @username          = username
+      @password          = password
+      @consumer_key      = consumer_key
+      @consumer_secret   = consumer_secret
+      @access_token      = access_token
+      @access_expires_at = access_expires_at
+    end
+
+    def auth_header
+      ensure_authentication
+      "Bearer #{@access_token}"
+    end
+
+    def request_auth_token
+      Base64.strict_encode64("#{@consumer_key}:#{@consumer_secret}").strip
+    end
+
+    def api_request_auth
+      res = auth_request(
+        "https://api.rakutenmarketing.com/token",
+        { grant_type: "password", username: @username, password: @password, scope: @sid }
+      )
+
+      process_auth_response(res)
+
+      @access_expires_at = Time.now.to_i + @expires_in
+    end
+
+    def refresh_api_request_auth
+      res = auth_request(
+        "https://api.rakutenmarketing.com/token",
+        { grant_type: "refresh_token", refresh_token: @refresh_token, scope: "Production" }
+      )
+
+      process_auth_response(res)
+
+      @access_expires_at = Time.now.to_i + @expires_in
+    end
+
+    def process_auth_response(res)
+      if res.code == "200"
+        doc = JSON.parse(res.body)
+        @expires_in    = doc["expires_in"].to_i
+        @refresh_token = doc["refresh_token"]
+        @access_token  = doc["access_token"]
+      else
+        puts "RESPONSE CODE #{res.code} received"
+        res
+      end
+    end
+
+    def auth_request(url, payload)
+      uri = URI(url)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        req = Net::HTTP::Post.new(uri)
+        req["Authorization"] = "Basic #{request_auth_token}"
+
+        req.set_form_data(payload)
+        http.request(req)
+      end
+    end
+
+    def ensure_authentication
+      if @access_expires_at.nil?
+        # puts "NIL: getting auth"
+        api_request_auth
+      elsif Time.now.to_i > @access_expires_at
+        # puts "EXPIRED: getting auth"
+        api_request_auth
+      elsif Time.now.to_i > (@access_expires_at + REFRESH_TOKEN_LEEWAY)
+        # puts "REFRESH LEEWAY: getting auth"
+        refresh_api_request_auth
+      end
+    end
+  end
+end

data/lib/rakuten_product_api/client.rb

@@ -6,105 +6,33 @@ require "nokogiri"
 
 module RakutenProductApi
   class Client
+    extend Forwardable
+    def_delegators :@authenticate, :access_token, :access_expires_at
     REFRESH_TOKEN_LEEWAY = 60 * 10 # Ten minutes prior to expiry we should refresh token
 
-    attr_accessor :sid, :username, :password, :consumer_key, :consumer_secret, :mid, :auth_expires_at
-
-    def initialize(sid:             RakutenProductApi.sid,
-                   username:        RakutenProductApi.username,
-                   password:        RakutenProductApi.password,
-                   consumer_key:    RakutenProductApi.consumer_key,
-                   consumer_secret: RakutenProductApi.consumer_secret,
-                   mid:             RakutenProductApi.mid,
-                   sort:            RakutenProductApi.sort,
-                   sorttype:        RakutenProductApi.sorttype)
-
-      @sid = sid
-      @username = username
-      @password = password
-      @consumer_key = consumer_key
+    attr_accessor :sid, :username, :password, :consumer_key, :consumer_secret, :authenticate
+
+    def initialize(sid:               RakutenProductApi.sid,
+                   username:          RakutenProductApi.username,
+                   password:          RakutenProductApi.password,
+                   consumer_key:      RakutenProductApi.consumer_key,
+                   consumer_secret:   RakutenProductApi.consumer_secret,
+                   access_token:      nil,
+                   access_expires_at: nil)
+
+      @authenticate = Authenticate.new(sid: sid,
+                                       username: username,
+                                       password: password,
+                                       consumer_key: consumer_key,
+                                       consumer_secret: consumer_secret,
+                                       access_token: access_token,
+                                       access_expires_at: access_expires_at)
+
+      @sid             = sid
+      @username        = username
+      @password        = password
+      @consumer_key    = consumer_key
       @consumer_secret = consumer_secret
-      @mid = mid
-      @sort = sort
-      @sorttype = sorttype
-
-      @auth_expires_at = nil
-    end
-
-    def default_params
-      dp = {}
-      dp[:mid]      = @mid unless @mid.nil?
-      dp[:sort]     = @sort unless @sort.nil?
-      dp[:sorttype] = @sorttype unless @sorttype.nil?
-      dp
-    end
-
-    def request_auth_token
-      Base64.strict_encode64("#{@consumer_key}:#{@consumer_secret}").strip
-    end
-
-    def request_auth_token_header
-      "Authorization: Basic #{request_auth_token}"
-    end
-
-    def api_request_auth
-      res = auth_request(
-        "https://api.rakutenmarketing.com/token",
-        { grant_type: "password", username: @username, password: @password, scope: @sid }
-      )
-
-      process_auth_response(res)
-
-      @auth_expires_at = Time.now.to_i + @expires_in
-    end
-
-    def refresh_api_request_auth
-      res = auth_request(
-        "https://api.rakutenmarketing.com/token",
-        { grant_type: "refresh_token", refresh_token: @refresh_token, scope: "Production" }
-      )
-
-      process_auth_response(res)
-
-      @auth_expires_at = Time.now.to_i + @expires_in
-    end
-
-    def process_auth_response(res)
-      if res.code == "200"
-        doc = JSON.parse(res.body)
-        @expires_in    = doc["expires_in"].to_i
-        @refresh_token = doc["refresh_token"]
-        @access_token  = doc["access_token"]
-      else
-        puts "RESPONSE CODE #{res.code} received"
-        res
-      end
-    end
-
-    def auth_request(url, payload)
-      uri = URI(url)
-      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        req = Net::HTTP::Post.new(uri)
-        req["Authorization"] = "Basic #{request_auth_token}"
-
-        req.set_form_data(payload)
-        http.request(req)
-      end
-    end
-
-    def ensure_authentication
-      if @auth_expires_at.nil?
-        puts "NIL: getting auth"
-        api_request_auth
-      elsif Time.now.to_i > @auth_expires_at
-        puts "EXPIRED: getting auth"
-        api_request_auth
-      elsif Time.now.to_i > (@auth_expires_at + REFRESH_TOKEN_LEEWAY)
-        puts "REFRESH LEEWAY: getting auth"
-        refresh_api_request_auth
-      else
-        puts "VALID AUTH"
-      end
     end
 
     def search(keyword: nil, **options)
@@ -112,14 +40,12 @@ module RakutenProductApi
     end
 
     def api_request(payload)
-      ensure_authentication
-
-      params = default_params.merge(payload).map { |k, v| "#{k}=#{v}" }.join("&")
+      params = payload.map { |k, v| "#{k}=#{v}" }.join("&")
       uri = URI("https://api.rakutenmarketing.com/productsearch/1.0?#{params}")
 
       res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         req = Net::HTTP::Get.new(uri)
-        req["Authorization"] = "Bearer #{@access_token}"
+        req["Authorization"] = @authenticate.auth_header
         req["Accept"] = "application/xml"
 
         http.request(req)

data/lib/rakuten_product_api/item.rb

@@ -1,5 +1,3 @@
-require "forwardable"
-
 module RakutenProductApi
   class Item
     extend Forwardable

data/lib/rakuten_product_api/version.rb

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

data/rakuten_product_api.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "nokogiri", "~> 1"
 
-  spec.add_development_dependency 'byebug', '~> 11'
+  spec.add_development_dependency "byebug", "~> 11"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rakuten_product_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dan Milne
@@ -56,6 +56,7 @@ files:
 - bin/console
 - bin/setup
 - lib/rakuten_product_api.rb
+- lib/rakuten_product_api/authenticate.rb
 - lib/rakuten_product_api/client.rb
 - lib/rakuten_product_api/item.rb
 - lib/rakuten_product_api/response.rb
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Client for Rakutenmarketing.com.