rakuten_product_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1fd5a4ee5820366f85f0c1266d2f0edd5ce8375343e64cccd6c55ab95274619
+  data.tar.gz: 56e0a89e406c5d7e16cf7b9cc80be336eba8d9ae1fc1c01c94d6088d980c8815
+SHA512:
+  metadata.gz: 67867a384786c0c5f316fb228a130c5e8593a8d7e18639d305de3849a7d78a467c19c57f5ec1406bc0e5ef674031c4834c280abf9a974bf9b5f0f86fb53b7994
+  data.tar.gz: e27d9b209f5f6ac43cbd9ae8af25a0ccb74d343ec89e11601604cbbbae85f538521db537a85ec4bafb235b306777b18ba0fd0c91839ad926a8b914495df40061

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-02-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rakuten_product_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    rakuten_product_api (0.1.0)
+      byebug
+      nokogiri
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    minitest (5.14.3)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (1.9.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rakuten_product_api!
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Dan Milne
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+# RakutenProductApi
+
+To experiment with that code, run `bin/console` for an interactive prompt.
+
+## API Documentation
+
+The 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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rakuten_product_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rakuten_product_api
+
+## Usage
+
+The library can be configured with an initializer. For Rails, create the 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'
+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
+client = RakutenProductApi::Client.new
+
+client.username
+=> "dkam"
+```
+
+### Search
+Search for keywords:
+
+```ruby
+results = client.search(keyword: 'Murderbot', mid: 38131)
+results.items.count
+=> 7
+
+results.items[0].merchant
+=> "Rakuten Kobo Australia"
+
+results.items[0].isbn
+=> "9781250185464"
+
+results.items[0].title
+=> "Exit Strategy"
+
+results.items[0].price
+=> ["15.06", "AUD"]
+
+results.items[0].rrp
+=> ["18.70", "AUD"]
+```
+
+Search for ISBNs:
+
+```ruby
+results = client.search(keyword: '9781501977824', mid: 38131)
+results.items[0].gtin
+=> "9781501977824"
+results.items[0].title
+=> "All Systems Red"
+```
+
+The API also allows other attribute:
+
+* exact
+* one
+* none
+* sort & sorttype
+
+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.
+
+## Notes
+
+* ISBN is taken from either the `sku` or the `keywords` fields and mached against a regular expression `/97[98]\d{10}/` as there's no specific field for it.
+* Condition is guessed by looking for the string "Used" in the description.  This is a terrible idea, but there is no field for condition.
+* This library aliases rrp -> price and price -> saleprice.  When sorting you need to use the original attribute names ( price / saleprice )
+
+## Development
+
+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.
+
+```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'
+end
+```
+
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dkam/rakuten_product_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rakuten_product_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+load "config.rb" if File.exist? "config.rb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rakuten_product_api.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "rakuten_product_api/version"
+require_relative "rakuten_product_api/client"
+require_relative "rakuten_product_api/response"
+require_relative "rakuten_product_api/item"
+
+module RakutenProductApi
+  class Error < StandardError; end
+
+  APPLICATION_END_POINT = "https://api.rakutenmarketing.com/productsearch/1.0"
+
+  class << self
+    attr_accessor :sid,
+                  :username,
+                  :password,
+                  :consumer_key,
+                  :consumer_secret,
+                  :mid,
+                  :sort,
+                  :sorttype
+
+    def configure
+      yield self
+      true
+    end
+    alias config configure
+
+    def hello
+      puts "Oh Hai"
+    end
+  end
+end

data/lib/rakuten_product_api/client.rb

@@ -0,0 +1,133 @@
+require "uri"
+require "net/http"
+require "net/https"
+require "base64"
+require "nokogiri"
+
+module RakutenProductApi
+  class Client
+    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
+      @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)
+      Response.new(api_request(options.merge(keyword: keyword)))
+    end
+
+    def api_request(payload)
+      ensure_authentication
+
+      params = default_params.merge(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["Accept"] = "application/xml"
+
+        http.request(req)
+      end
+
+      puts "RESPONSE CODE #{res.code} received" if res.code != "200"
+
+      res
+    end
+  end
+end

data/lib/rakuten_product_api/item.rb

@@ -0,0 +1,83 @@
+require "forwardable"
+
+module RakutenProductApi
+  class Item
+    extend Forwardable
+    attr_accessor :raw
+
+    def_delegators :@raw, :xpath, :at_xpath
+
+    def initialize(data)
+      @raw = data
+    end
+
+    def title
+      get "productname"
+    end
+
+    def merchant
+      get "merchantname"
+    end
+
+    def price
+      [at_xpath("saleprice")&.text, at_xpath("saleprice/@currency")&.text]
+    end
+
+    def rrp
+      [at_xpath("price")&.text, at_xpath("price/@currency")&.text]
+    end
+
+    def upc
+      get "upccode"
+    end
+
+    def isbn
+      return at_xpath("sku").text[/97[98]\d{10}/] if at_xpath("sku")&.text.match?(/97[98]\d{10}/)
+      return at_xpath("keywords").text[/97[98]\d{10}/] if at_xpath("keywords").text.match?(/97[98]\d{10}/)
+    end
+
+    def link
+      get "linkurl"
+    end
+
+    def image_url
+      get "imageurl"
+    end
+
+    def description_short
+      get "description/short"
+    end
+
+    def description_long
+      get "description/long"
+    end
+
+    def keywords
+      get("keywords")&.split("~~")
+    end
+
+    def used?
+      description.match?(/used/i)
+    end
+
+    def new?
+      !used?
+    end
+
+    def get(path)
+      return nil if path.nil? || path.empty?
+
+      @raw.at_xpath(path)&.text
+    end
+
+    def result_count
+      @raw.at_xpath("result/item").count
+    end
+
+    %w[mid merchantname linkid createdon sku productname imageurl linkurl upccode].each do |x|
+      define_method(x) do
+        return get(x)
+      end
+    end
+  end
+end

data/lib/rakuten_product_api/response.rb

@@ -0,0 +1,18 @@
+require "nokogiri"
+
+module RakutenProductApi
+  class Response
+    attr_reader :http_response, :raw, :datas, :doc, :items
+
+    def initialize(response)
+      @http_response = response
+      @raw = Nokogiri::XML(response.body)
+
+      @items = @raw.xpath("result/item").map { |d| Item.new(d) }
+    end
+
+    def body
+      @raw.to_s
+    end
+  end
+end

data/lib/rakuten_product_api/version.rb

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

data/rakuten_product_api.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/rakuten_product_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rakuten_product_api"
+  spec.version       = RakutenProductApi::VERSION
+  spec.authors       = ["Dan Milne"]
+  spec.email         = ["d@nmilne.com"]
+
+  spec.summary       = "Client for Rakutenmarketing.com."
+  spec.homepage      = "https://github.com/dkam/rakuten_product_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dkam/rakuten_product_api"
+  spec.metadata["changelog_uri"] = "https://github.com/dkam/rakuten_product_api/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "nokogiri", "~> 1"
+
+  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
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rakuten_product_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dan Milne
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+description:
+email:
+- d@nmilne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rakuten_product_api.rb
+- lib/rakuten_product_api/client.rb
+- lib/rakuten_product_api/item.rb
+- lib/rakuten_product_api/response.rb
+- lib/rakuten_product_api/version.rb
+- rakuten_product_api.gemspec
+homepage: https://github.com/dkam/rakuten_product_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dkam/rakuten_product_api
+  source_code_uri: https://github.com/dkam/rakuten_product_api
+  changelog_uri: https://github.com/dkam/rakuten_product_api/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Client for Rakutenmarketing.com.
+test_files: []