rakuten_product_api 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 679b3d9dba92d97e14f70f3b83648d49b0508e0e9060f75e1fe7ea070760be83
-  data.tar.gz: 988b9afe879c4c0be3c670ac036e32b6393cf9d2afaaade1806553b5f899d54c
+  metadata.gz: 75b9cbdd2339703bb57bc2d4eed267caacb9f8102153265ac00252d63a2fc7ea
+  data.tar.gz: f07396647cca6325ed7e87a72c1303f20f448b72380a263625527842fc4fdc94
 SHA512:
-  metadata.gz: c4d91eb4f03f5c13c6d840bc2510f5f746f839fe5ac9339ab242eeec1db59bbf2a4834e63d8787018bc791b28695b57fe235f9a7366b54e55e508e1577286be7
-  data.tar.gz: 66f8ba69dfc50802d57a9fd22a7e4db205972909112eebf0668b61a3935f69524ba1a0a8f0bc1ed48e3ce0899673bc9fe0467228c2e22e3b936a56845e21e2a8
+  metadata.gz: cdb8b95db0a4e09db5e89fb403aee90ab5a4038aec7ffed5da60ba967d9009f1bfaec25096317d5968d83bb2f8ba1aceb9bd0643d130827bff2bb06948552a99
+  data.tar.gz: 75c2e83b5990933636a2f22dde9d246f9cee997095a28723d94bbe60fc8b1e62d97f2e8d10fea563256f3e44bfa10de792dd1987b52c4220cf7ca0f442e2c4f2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rakuten_product_api (0.4.1)
+    rakuten_product_api (0.5.0)
       nokogiri (>= 1.13.6)
 
 GEM
@@ -12,10 +12,6 @@ GEM
     minitest (5.15.0)
     nokogiri (1.13.6-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.6-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.13.6-x86_64-linux)
-      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)

data/README.md

@@ -5,9 +5,9 @@ To experiment with this library, run `bin/console` for an interactive prompt.
 ## API Documentation
 
 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)
+- [Tryout Guide](https://developers.rakutenadvertising.com/guides/try_out_apis)
+- [Product Search](https://developers.rakutenadvertising.com/guides/product_search)
+- [API Keys](https://developers.rakutenadvertising.com/default/dashboard/applications/)
 
 ## Installation
 
@@ -27,15 +27,15 @@ Or install it yourself as:
 
 ## Usage
 
-The library can be configured with an initializer. For Rails, create the file `config/initializers/rakuten.rb`
+The library comes with `bin/console` which can be used to explore the client and api.  If there is a local `./config.rb` the console script will load it.
+
+To configured the library for Rails, create an initializer file `config/initializers/rakuten.rb`
 
 ```ruby
 RakutenProductApi.configure do |config|
   config.sid             = 'your-site-id'
-  config.username        = 'your-rakuten-username'
-  config.password        = 'your-rakuten-password'
-  config.consumer_key    = 'your-consumer-key'
-  config.consumer_secret = 'your-consumer-secret'
+  config.client_id       = 'your-client-id'
+  config.client_secret   = 'your-client-secret'
 end
 ```
 
@@ -44,22 +44,22 @@ Once you have configured the library, you can create a client.
 ```ruby
 client = RakutenProductApi::Client.new
 
-client.username
-=> "your-rakuten-username"
+client.sid
+=> "your-site-id"
 ```
 
 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
+This library needs to query the API to retreive an `access_token` which has an `access_token_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.
+You can initialise the library with the `access_token` and `access_token_expires_at` values to avoid this lookup. If the `access_token_expires_at` is nil or 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.endpoint
+=> "https://api.linksynergy.com"
 
 client.access_token
 => "abcd1234"

data/lib/rakuten_product_api/authenticate.rb

@@ -7,23 +7,21 @@ 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
+    attr_accessor :sid, :endpoint, :access_token, :access_token_expires_at, :refresh_token
 
-    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)
+    def initialize( sid:               RakutenProductApi.sid,
+                    client_id:         RakutenProductApi.client_id,
+                    client_secret:     RakutenProductApi.client_secret,
+                    endpoint:          RakutenProductApi.endpoint,
+                    access_token:      nil,
+                    access_token_expires_at: nil)
 
-      @sid               = sid
-      @username          = username
-      @password          = password
-      @consumer_key      = consumer_key
-      @consumer_secret   = consumer_secret
+      @sid               = sid # account-id ?
       @access_token      = access_token
-      @access_expires_at = access_expires_at
+      @access_token_expires_at = access_token_expires_at
+      @client_id         = client_id
+      @client_secret     = client_secret
+      @endpoint          = endpoint
     end
 
     def auth_header
@@ -31,30 +29,24 @@ module RakutenProductApi
       "Bearer #{@access_token}"
     end
 
-    def request_auth_token
-      Base64.strict_encode64("#{@consumer_key}:#{@consumer_secret}").strip
+    def token_key
+      Base64.strict_encode64("#{@client_id}:#{@client_secret}").strip
     end
 
-    def api_request_auth
-      res = auth_request(
-        "https://api.rakutenmarketing.com/token",
-        { grant_type: "password", username: @username, password: @password, scope: @sid }
-      )
+    def api_request_auth_token
+      res = auth_request( { scope: @sid } )
 
       process_auth_response(res)
 
-      @access_expires_at = Time.now.to_i + @expires_in
+      @access_token_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" }
-      )
+    def refresh_api_request_auth_token
+      res = auth_request( { refresh_token: @refresh_token, scope: @sid}  )
 
       process_auth_response(res)
 
-      @access_expires_at = Time.now.to_i + @expires_in
+      @access_token_expires_at = Time.now.to_i + @expires_in
     end
 
     def process_auth_response(res)
@@ -69,11 +61,11 @@ module RakutenProductApi
       end
     end
 
-    def auth_request(url, payload)
-      uri = URI(url)
+    def auth_request(payload)
+      uri = URI("#{@endpoint}/token")
       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["Authorization"] = "Bearer #{token_key}"
 
         req.set_form_data(payload)
         http.request(req)
@@ -81,15 +73,15 @@ module RakutenProductApi
     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
+      if @access_token_expires_at.nil?
+        #puts "NO TOKEN: getting auth token"
+        api_request_auth_token
+      elsif Time.now.to_i > @access_token_expires_at
+        #puts "EXPIRED TOKEN: getting auth token"
+        api_request_auth_token
+      elsif Time.now.to_i > (@access_token_expires_at - REFRESH_TOKEN_LEEWAY)
+        #puts "TOKEN EXPIRES WITHIN LEEWAY : refresh auth token"
+        refresh_api_request_auth_token
       end
     end
   end

data/lib/rakuten_product_api/client.rb

@@ -10,38 +10,32 @@ module RakutenProductApi
     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, :authenticate
+    attr_accessor :sid, :username, :password, :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)
+    def initialize(sid: RakutenProductApi.sid,
+                   endpoint: RakutenProductApi.endpoint,
+                   access_token: nil,
+                   access_token_expires_at: nil)
+  
+      @sid = sid
+      @endpoint = endpoint
 
       @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)
+                                       access_token_expires_at: access_token_expires_at)
 
-      @sid             = sid
-      @username        = username
-      @password        = password
-      @consumer_key    = consumer_key
-      @consumer_secret = consumer_secret
     end
 
-    def search(keyword: nil, **options)
-      Response.new(api_request(options.merge(keyword: keyword)))
+    def search(**options)
+      params = %i{ keyword exact one none cat language max pagenumber mid, sort, sorttype }
+      allowed_options = options.select {|k, v| params.include?(k)}
+      Response.new(api_request(options, '/productsearch/1.0'))
     end
 
-    def api_request(payload)
+    def api_request(payload, path)
       params = payload.map { |k, v| "#{k}=#{v}" }.join("&")
-      uri = URI("https://api.rakutenmarketing.com/productsearch/1.0?#{params}")
+
+      uri = URI("#{@endpoint}#{path}?#{params}")
 
       res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
         req = Net::HTTP::Get.new(uri)

data/lib/rakuten_product_api/version.rb

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

data/lib/rakuten_product_api.rb

@@ -11,26 +11,21 @@ require_relative "rakuten_product_api/item"
 module RakutenProductApi
   class Error < StandardError; end
 
-  APPLICATION_END_POINT = "https://api.rakutenmarketing.com/productsearch/1.0"
+  APPLICATION_END_POINT = "https://api.linksynergy.com"
 
   class << self
     attr_accessor :sid,
-                  :username,
-                  :password,
-                  :consumer_key,
-                  :consumer_secret,
                   :mid,
                   :sort,
-                  :sorttype
+                  :sorttype,
+                  :client_id,
+                  :client_secret,
+                  :endpoint
 
     def configure
+      self.endpoint = APPLICATION_END_POINT # Set a default API Endpoint
       yield self
-      true
     end
     alias config configure
-
-    def hello
-      puts "Oh Hai"
-    end
   end
 end

data/rakuten_product_api.gemspec

@@ -29,8 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "nokogiri", ">= 1.13.6"
-
+  spec.add_runtime_dependency 'nokogiri', '~> 1.13', '>= 1.13.6'
   spec.add_development_dependency "byebug", "~> 11"
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: rakuten_product_api
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Dan Milne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.6
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.6