shoptet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5707a03aee00c4da7081d5240e584e722e3acd3223a4e0a58c224c98b9a7dc77
+  data.tar.gz: d58ec4a17e917631a70bc2e662f5f16edeaf321b2a3f77df8a63450c17995380
+SHA512:
+  metadata.gz: 4b0e431494bcbc05f7c75c8cf50e298cfece53d8421c74f63fcd424dd7efdaa6e4ed44d7bfc8c2a5846d2819eab620933bfa85700613bf83673fc00f4381da93
+  data.tar.gz: 372d9d14962d9aefc387678197c7db28b95ccf9717a41a6517bd5043c1fe0a86b462f1935d2bf6c6fd261ffd637a8ef025500f1c6f2da9ee6d5ce2ba6a2c45a8

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shoptet.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    shoptet (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    io-console (0.5.6)
+    irb (1.2.7)
+      reline (>= 0.1.5)
+    reline (0.1.6)
+      io-console (~> 0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  irb
+  shoptet!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Premysl Donat
+
+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,88 @@
+# Shoptet
+
+This is Ruby API wrapper for [Shoptet API](https://developers.shoptet.com/) which provides access to e-shop data for addon developers.
+
+This is currently under development and hasn't been released to Rubygems yet.
+
+# How to install
+
+Currently only through Github:
+```
+gem 'shoptet', github: 'Masa331/shoptet'
+```
+
+# How to use
+
+## Setup
+
+First instantiate Shoptet which then represents connection to one specific shop
+```
+api = Shoptet.new(oauth_url, oauth_token, api_token, on_token_error)
+```
+And now you can access the data
+```
+api.price_lists
+# => returns Enumerator with all price lists
+
+```
+### params for `::new`
+
+#### * oauth_url
+string with the oauth url for the partner shop under which is the addon registered.
+
+#### oauth_token
+string or nil with oauth token(the one you get during addon instalation process) used for creating api tokens. This gem can function without it but isn't able to auto re-create api tokens when necessary then.
+
+#### api_token
+string or nil with api token for accessing actual data. If it's not provided or is expired then this gem will request new one with the provided oauth token.
+
+#### on_token_error
+proc with what happens when missing or expired api token is encountered. If it's not provided then the default behaviour is to request new api token and store and use the new token only in api instance. The default proc looks like this
+```
+DEFAULT_ON_TOKEN_ERROR = -> (api) do
+  api.api_token = api.new_api_token
+end
+```
+
+Custom proc can be used to add some special logic for this event like for example storing the new token also somewhere in the databse. The proc will be called with the api instance.
+
+For the common scenario when working with Rails and ActiveRecord this gem also provides proc which stores the new token in ActiveRecord model. The proc can be instantiated like this `Shoptet.ar_on_token_error(my_model_instance)` and expects the model to have `#api_token` setter defined. The exact behaviour can be seen in the [code]().
+
+## Parallel requests
+
+This gem fires only one network request at a time(of course) so some paralelization or whatnot is up to you.
+
+## Exceptions
+
+This gem fires special exceptions on various events.
+
+`Shoptet::Error` when some general error occurs  
+`Shoptet::AddonSuspended` when you are trying to access api for shop which has your addon suspended  
+`Shoptet::NoRights` when you try to access api endpoint which is not approved  
+`Shoptet::SlowDown` when 429 is returned from the api  
+`Shoptet::InvalidOauthToken` when invalid oauth token is used
+
+## Collection endpoints
+
+Methods for accessing collections(products, orders, ...) automatically handle pagination so you don't have to do it manually. These collection methods return instances of `Enumerator` on which you can run standard methods like `#each`, `#map`, etc.
+
+Also they accept hash with params which will be passed to Shoptet api. Through this you can set various filters and pagination.
+
+* `Shoptet#products(api_params: {})`
+* `Shoptet#products_changes(api_params: {})`
+* `Shoptet#supplies(api_params: {})`
+* `Shoptet#product_categories(api_params: {})`
+* `Shoptet#price_lists(api_params: {})`
+
+## Detail endpoints
+
+* `Shoptet#product(guid)`
+* `Shoptet#order(code)`
+
+## Other
+
+* `Shoptet#new_api_token` - this returns new api token created with oauth token
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shoptet'
+
+# 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'
+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/shoptet.rb

@@ -0,0 +1,206 @@
+require_relative 'shoptet/request'
+
+class Shoptet
+  class Error < StandardError
+    #TODO: check that this works
+    attr_reader :additional_data
+
+    def initialize message, additional_data = {}
+      super(message)
+      @additional_data = additional_data
+    end
+  end
+  class AddonSuspended < StandardError; end
+
+  DEFAULT_ON_TOKEN_ERROR = -> (api) do
+    api.api_token = api.new_api_token
+  end
+
+  def self.version
+    '0.0.1'
+  end
+
+  def self.ar_on_token_error(model)
+    -> (api) do
+      model.with_lock do
+        model.reload
+
+        if model.api_token != api.api_token
+          api.api_token = model.api_token
+        else
+          new_token = api.new_api_token
+          api.api_token = new_token
+          model.api_token = new_token
+          model.save!
+        end
+      end
+    end
+  end
+
+  attr_accessor :api_token
+
+  def initialize(oauth_url, oauth_token, api_token = nil, on_token_error = nil)
+    @oauth_url = oauth_url
+    @oauth_token = oauth_token
+    @api_token = api_token
+    @on_token_error = on_token_error || DEFAULT_ON_TOKEN_ERROR
+  end
+
+  def shop_info api_params = {}
+    request 'https://api.myshoptet.com/api/eshop'
+  end
+
+  def warehouses api_params = {}
+    enumerize 'https://api.myshoptet.com/api/stocks', api_params
+  end
+
+  def products api_params = {}
+    enumerize "https://api.myshoptet.com/api/products", api_params
+  end
+
+  def supplies warehouse_id, api_params = {}
+    uri = "https://api.myshoptet.com/api/stocks/#{warehouse_id}/supplies"
+    enumerize uri, api_params
+  end
+
+  def product_categories api_params = {}
+    enumerize 'https://api.myshoptet.com/api/categories', api_params
+  end
+
+  def products_changes api_params = {}
+    uri = 'https://api.myshoptet.com/api/products/changes'
+    enumerize uri, api_params
+  end
+
+  def price_lists api_params = {}
+    enumerize 'https://api.myshoptet.com/api/pricelists', api_params
+  end
+
+  def prices price_list_id, api_params = {}
+    uri = "https://api.myshoptet.com/api/pricelists/#{price_list_id}"
+    enumerize uri, api_params, 'pricelist'
+  end
+
+  def orders api_params = {}
+    enumerize 'https://api.myshoptet.com/api/orders', api_params
+  end
+
+  def orders_changes api_params = {}
+    uri = 'https://api.myshoptet.com/api/orders/changes'
+    enumerize uri, api_params
+  end
+
+  def order code, api_params = {}
+    uri = "https://api.myshoptet.com/api/orders/#{code}"
+    result = request assemble_uri(uri, api_params)
+    result.dig('data', 'order').merge(detail_url: uri)
+  end
+
+  def product guid, api_params = {}
+    uri = "https://api.myshoptet.com/api/products/#{guid}"
+    result = request assemble_uri(uri, api_params)
+    result.dig('data')
+  end
+
+  def new_api_token
+    headers = { 'Authorization' => "Bearer #{@oauth_token}" }
+
+    result = Shoptet::Request.get @oauth_url, headers
+    handle_errors result
+
+    # error = result['error']
+    # errors = result['errors'] || []
+    #
+    # #TODO: unite error handling with #request
+    # if error || errors.any?
+    #   additional_data = {
+    #     uri: @oauth_url,
+    #     headers: scrub_sensitive_headers(headers)
+    #   }
+    #
+    #   raise Error.new result, additional_data
+    # else
+    #   result.fetch 'access_token'
+    # end
+
+    result.fetch 'access_token'
+  end
+
+  private
+
+  def assemble_uri base, params = {}
+    u = URI(base)
+    u.query = URI.encode_www_form(params) if params.any?
+
+    u.to_s
+  end
+
+  def enumerize base_uri, filters = {}, data_key = nil
+    data_key ||= URI(base_uri).path.split('/').last
+    uri = assemble_uri base_uri, filters
+    size_proc = -> () { request(uri)['data']['paginator']['totalCount'] }
+
+    Enumerator.new(size_proc) do |y|
+      first_page = request uri
+      total_pages = first_page.dig('data', 'paginator', 'pageCount') || 0
+      other_pages = 2..total_pages
+
+      first_page.dig('data', data_key).each { y.yield _1.merge(page_url: uri) }
+
+      other_pages.each do |page|
+        uri = assemble_uri base_uri, filters.merge(page: page)
+        result = request uri
+        result.dig('data', data_key).each { y.yield _1.merge(page_url: uri) }
+      end
+    end
+  end
+
+  def request uri
+    headers = { 'Shoptet-Access-Token' => @api_token,
+                'Content-Type' => 'application/vnd.shoptet.v1.0' }
+
+    result = Shoptet::Request.get uri, headers
+    token_errors = handle_errors result
+
+    if token_errors.any?
+      @on_token_error.call self
+      request uri
+    else
+      result
+    end
+  end
+
+  def handle_errors result
+    error = result['error']
+    errors = result['errors'] || []
+    token_errors, non_token_errors = errors.partition { |err| ['invalid-token', 'expired-token'].include? err['errorCode'] }
+
+    if error || non_token_errors.any?
+      if error == 'addon_suspended'
+        raise AddonSuspended
+      else
+        additional_data = {
+          uri: uri,
+          headers: scrub_sensitive_headers(headers)
+        }
+
+        raise Error.new result, additional_data
+      end
+    end
+
+    token_errors
+  end
+
+  def scrub_sensitive_headers headers
+    scrubbed = {}
+
+    to_scrub = ['Shoptet-Access-Token', 'Authorization']
+    to_scrub.each do |header|
+      if headers[header]
+        scrubbed[header] = "#{headers[header][0..20]}..."
+      end
+    end
+
+    headers.merge scrubbed
+  end
+end

data/lib/shoptet/request.rb

@@ -0,0 +1,32 @@
+require 'net/http'
+
+#TODO: keep_alive_timeout ?
+
+class Shoptet
+  class Request
+    def self.get uri, headers
+      attempt ||= 0
+      attempt += 1
+
+      parsed_uri = URI(uri)
+
+      http = Net::HTTP.new parsed_uri.host, parsed_uri.port
+      http.use_ssl = true
+      http.open_timeout = 10
+      http.read_timeout = 10
+      http.write_timeout = 10
+      http.ssl_timeout = 10
+
+      request = Net::HTTP::Get.new parsed_uri
+      headers.each do |key, value|
+        request[key] = value
+      end
+
+      response = http.request request
+
+      JSON.parse response.body
+    rescue Net::OpenTimeout
+      retry if attempt < 4
+    end
+  end
+end

data/shoptet.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/shoptet'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'shoptet'
+  spec.version       = Shoptet.version
+  spec.authors       = ['Premysl Donat']
+  spec.email         = ['pdonat@seznam.cz']
+
+  spec.summary       = 'API wrapper for interacting with Shoptet api'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/Masa331/shoptet'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'irb'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: shoptet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Premysl Donat
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API wrapper for interacting with Shoptet api
+email:
+- pdonat@seznam.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shoptet.rb
+- lib/shoptet/request.rb
+- shoptet.gemspec
+homepage: https://github.com/Masa331/shoptet
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Masa331/shoptet
+  source_code_uri: https://github.com/Masa331/shoptet
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: API wrapper for interacting with Shoptet api
+test_files: []