shoptet 0.0.21 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1efde55dd585d22094917b78272e10cbc8614b2083970ae2128ec834b385e8c
-  data.tar.gz: 183788a89692e1d7c30b72fdee0457d08ec24e3be612e16fa88b919f6e8664fc
+  metadata.gz: cf65c602c4c267d61e5fb7bd64a993d1da6b2911ea857eea8ca78022eae03a33
+  data.tar.gz: 1e9ce67fb7dd3fa9059c7a2eb5faa21f32de6ca802aff9ac99244f27687420be
 SHA512:
-  metadata.gz: 18dd464f3bbb098b4a167696af5a85d89c3663d6146b0fad2cde5d83647a9415d3fb9d160e67b5a908a3740da8fafbb6a5120b572190251959dea291566be78e
-  data.tar.gz: 99112fd817ee04c38e26f4d2f31079551dfb3cefb2dd0ff76a8f5cecaab3fcc80694da4c94678f339a6de26cc09b62a60b8e3859f1816da97d1a84ced6faa0e6
+  metadata.gz: 72637f126f47c2e7ff0eb2ac9bf797f4b9108f5be4af8a6f43e3e1eae4b11a92a6fa2bcf7db48224904eb97ee1a4c51a86b66e9c8db98d50a6cdcecf3563f251
+  data.tar.gz: d149fc9bd73a3c5e4135e1f4956a9426b5d8edacd7963698e384454858556aa313473ec87734c2ae5e6ac15f6a4c4dfbe9052290ffd1d1b98255f6dce2a8f198

data/lib/shoptet.rb

@@ -1,78 +1,29 @@
 require 'delegate'
 require_relative 'shoptet/request'
+require_relative 'shoptet/api_enumerator'
 
 class Shoptet
-  include Shoptet::UrlHelpers
-
   class Error < StandardError; end
   class AddonSuspended < StandardError; end
   class AddonNotInstalled < StandardError; end
   class InvalidTokenNoRights < StandardError; end
-  class EmptyRequestResponse < StandardError; end
+  class EmptyResponse < StandardError; end
   class MaxPageReached < StandardError; end
+  class StockNotFound < StandardError; end
+  class ProductNotFound < StandardError; end
+  class SystemMaintenance < StandardError; end
+  class UnknownError < StandardError; end
 
   EXPIRED_TOKEN_CODE = 'expired-token'
   INVALID_TOKEN_CODE = 'invalid-token'
   ADDON_NOT_INSTALLED = 'Addon installation is not approved.'
 
-  DEFAULT_ON_TOKEN_ERROR = -> (api) do
+  ON_TOKEN_ERROR = -> (api) do
     api.api_token = api.new_api_token
   end
 
-  class ApiEnumerator < SimpleDelegator
-    def initialize base_url, filters, data_key, api
-      @base_url = base_url
-      @filters = filters
-      @data_key = data_key ||  URI(base_url).path.split('/').last
-      @api = api
-
-      @enum = Enumerator.new do |y|
-        first_page.dig('data', @data_key).each { y.yield _1 }
-
-        if total_pages > 1
-          other_pages = 2..(total_pages - 1)
-          other_pages.each do |page|
-            uri = @api.assemble_uri base_url, filters.merge(page: page)
-            result = @api.request uri
-            result.dig('data', @data_key).each { y.yield _1 }
-          end
-
-          last_page.dig('data', @data_key).each { y.yield _1 }
-        end
-      end
-
-      super @enum
-    end
-
-    def first_page
-      @first_page ||=
-        begin
-          uri = @api.assemble_uri @base_url, @filters
-          @api.request uri
-        end
-    end
-
-    def total_pages
-      first_page.dig('data', 'paginator', 'pageCount') || 0
-    end
-
-    def last_page
-      return first_page if total_pages < 2
-
-      @last_page ||=
-        begin
-          uri = @api.assemble_uri @base_url, @filters.merge(page: total_pages)
-          @api.request uri
-        end
-    end
-
-    def size
-      first_page['data']['paginator']['totalCount']
-    end
-  end
-
   def self.version
-    '0.0.21'
+    '0.0.26'
   end
 
   def self.ar_on_token_error(model)
@@ -102,7 +53,7 @@ class Shoptet
       'scope' => 'api'
     }
 
-    Shoptet::Request.post url, data
+    Shoptet::Request.post(url, data)
   end
 
   def self.login_token url, code, client_id, client_secret, redirect_url
@@ -115,11 +66,11 @@ class Shoptet
       scope: 'basic_eshop'
     }
 
-    Shoptet::Request.post url, data
+    Shoptet::Request.post(url, data)
   end
 
   def self.basic_eshop url, access_token
-    Shoptet::Request.get url, { 'Authorization' => "Bearer #{access_token}" }
+    Shoptet::Request.get(url, { 'Authorization' => "Bearer #{access_token}" })
   end
 
   attr_accessor :api_token
@@ -130,11 +81,11 @@ class Shoptet
     @shop_url = shop_url
     @client_id = client_id
     @api_token = api_token
-    @on_token_error = on_token_error || DEFAULT_ON_TOKEN_ERROR
+    @on_token_error = on_token_error || ON_TOKEN_ERROR
   end
 
   def endpoints api_params = {}
-    enumerize 'https://api.myshoptet.com/api/system/endpoints', api_params
+    enumerize('https://api.myshoptet.com/api/system/endpoints', api_params)
   end
 
   def endpoint_approved? endpoint
@@ -156,101 +107,101 @@ class Shoptet
       redirect_uri: redirect_url
     }.to_query
 
-    URI("#{@shop_url}action/OAuthServer/authorize?#{query}").to_s
+    URI("#{@shop_url}action/OAuthServer/authorize?#{query}")
   end
 
   def shop_info api_params = {}
-    url = assemble_uri 'https://api.myshoptet.com/api/eshop', api_params
-    result = request url
+    result = request('https://api.myshoptet.com/api/eshop', api_params)
     result['data']
   end
 
   def design_info api_params = {}
-    url = assemble_uri 'https://api.myshoptet.com/api/eshop/design', api_params
-    result = request url
+    result = request('https://api.myshoptet.com/api/eshop/design', api_params)
 
     result['data']
   end
 
   def stocks api_params = {}
-    enumerize 'https://api.myshoptet.com/api/stocks', 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
+    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
+    enumerize("https://api.myshoptet.com/api/stocks/#{warehouse_id}/supplies", api_params)
   end
 
   def stocks_movements warehouse_id, api_params = {}
-    uri = "https://api.myshoptet.com/api/stocks/#{warehouse_id}/movements"
-    enumerize uri, api_params
+    enumerize("https://api.myshoptet.com/api/stocks/#{warehouse_id}/movements", api_params)
   end
 
   def product_categories api_params = {}
-    enumerize 'https://api.myshoptet.com/api/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
+    enumerize('https://api.myshoptet.com/api/products/changes', api_params)
   end
 
   def price_lists api_params = {}
-    enumerize 'https://api.myshoptet.com/api/pricelists', 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'
+    enumerize("https://api.myshoptet.com/api/pricelists/#{price_list_id}", api_params, 'pricelist')
   end
 
   def orders api_params = {}
-    enumerize 'https://api.myshoptet.com/api/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
+  def orders_changes from:
+    api_params = { from: from.iso8601 }
+    enumerize('https://api.myshoptet.com/api/orders/changes', 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'
+    result = request("https://api.myshoptet.com/api/orders/#{code}", api_params)
+    result.dig('data', 'order')
   end
 
   def product guid, api_params = {}
-    uri = "https://api.myshoptet.com/api/products/#{guid}"
-    result = request assemble_uri(uri, api_params)
+    result = request("https://api.myshoptet.com/api/products/#{guid}", api_params)
+    result['data']
+  end
+
+  def product_by_code code, api_params = {}
+    result = request("https://api.myshoptet.com/api/products/code/#{code}", api_params)
     result['data']
   end
 
   def new_api_token
     headers = { 'Authorization' => "Bearer #{@oauth_token}" }
 
-    result = Shoptet::Request.get @oauth_url, headers
-    handle_errors result, @oauth_url, headers
+    result = Shoptet::Request.get(URI(@oauth_url), headers)
+    handle_errors(result)
 
-    result.fetch 'access_token'
+    result.fetch('access_token')
   end
 
-  def request uri, retry_on_token_error = true
+  def request url, api_params = {}, retry_on_token_error = true
+    url = URI(url)
+    url.query = URI.encode_www_form(api_params) if api_params.any?
+
     headers = { 'Shoptet-Access-Token' => @api_token,
                 'Content-Type' => 'application/vnd.shoptet.v1.0' }
 
-    result = Shoptet::Request.get uri, headers
-    token_errors = handle_errors result, uri, headers
+    result = Shoptet::Request.get(url, headers)
+    token_errors = handle_errors(result)
 
     if token_errors.any?
       if retry_on_token_error
-        @on_token_error.call self
-        request uri, false
+        @on_token_error.call(self)
+        request(url, api_params, false)
       else
-        raise Error.new result
+        raise Error.new(result)
       end
     else
       result
@@ -258,9 +209,7 @@ class Shoptet
   end
 
   def suspended?
-    data = shop_info
-
-    false if data
+    false if shop_info
   rescue Shoptet::AddonSuspended
     true
   end
@@ -268,10 +217,10 @@ class Shoptet
   private
 
   def enumerize base_url, filters = {}, data_key = nil
-    ApiEnumerator.new base_url, filters, data_key, self
+    ApiEnumerator.new(base_url, filters, data_key, self)
   end
 
-  def handle_errors result, uri, headers
+  def handle_errors result
     error = result['error']
     errors = result['errors'] || []
     token_errors, non_token_errors = errors.partition do |err|
@@ -289,6 +238,14 @@ class Shoptet
         raise AddonNotInstalled
       elsif errors.any? { |err| err["errorCode"] == 'invalid-token-no-rights' }
         raise InvalidTokenNoRights
+      elsif errors.any? { |err| err["errorCode"] == 'stock-not-found' }
+        raise StockNotFound
+      elsif errors.any? { |err| err["errorCode"] == 'product-not-found' }
+        raise ProductNotFound
+      elsif errors.any? { |err| err["errorCode"] == 'system-maintenance' }
+        raise SystemMaintenance
+      elsif errors.any? { |err| err["errorCode"] == 'unknown-error' }
+        raise UnknownError
       elsif errors.any? { |err| err["errorCode"] == 'page-not-found' && err['message'].include?('max page is') }
         raise MaxPageReached
       else

data/lib/shoptet/api_enumerator.rb

@@ -0,0 +1,44 @@
+class Shoptet
+  class ApiEnumerator < SimpleDelegator
+    def initialize base_url, filters, data_key, api
+      @base_url = base_url
+      @filters = filters
+      @data_key = data_key || URI(base_url).path.split('/').last
+      @api = api
+
+      @enum = Enumerator.new do |y|
+        first_page.dig('data', @data_key).each { y.yield _1 }
+
+        if total_pages > 1
+          other_pages = 2..(total_pages - 1)
+          other_pages.each do |page|
+            result = @api.request(base_url, filters.merge(page: page))
+            result.dig('data', @data_key).each { y.yield _1 }
+          end
+
+          last_page.dig('data', @data_key).each { y.yield _1 }
+        end
+      end
+
+      super @enum
+    end
+
+    def first_page
+      @first_page ||= @api.request(@base_url, @filters)
+    end
+
+    def last_page
+      return first_page if total_pages < 2
+
+      @last_page ||= @api.request(@base_url, @filters.merge(page: total_pages))
+    end
+
+    def total_pages
+      first_page.dig('data', 'paginator', 'pageCount') || 0
+    end
+
+    def size
+      first_page.dig('data', 'paginator', 'totalCount')
+    end
+  end
+end

data/lib/shoptet/request.rb

@@ -1,53 +1,41 @@
 require 'net/http'
-
-#TODO: keep_alive_timeout ?
+require 'oj'
 
 class Shoptet
-  module UrlHelpers
-    def assemble_uri base, params = {}
-      u = URI(base)
-      u.query = URI.encode_www_form(params) if params.any?
-
-      u.to_s
-    end
-  end
-
   class Request
-    def self.get uri, headers
-      parsed_uri = URI(uri)
-
-      http = Net::HTTP.new parsed_uri.host, parsed_uri.port
+    def self.get url, headers
+      http = Net::HTTP.new(url.host, url.port)
       http.use_ssl = true
       http.open_timeout = 60
       http.read_timeout = 60
       http.write_timeout = 60
       http.ssl_timeout = 60
 
-      request = Net::HTTP::Get.new parsed_uri
+      request = Net::HTTP::Get.new(url)
       headers.each do |key, value|
         request[key] = value
       end
 
-      response = http.request request
-      parsed_body = JSON.parse response.body
+      response = http.request(request)
+      parsed_body = Oj.load(response.body, mode: :compat)
 
       unless parsed_body
-        message = "Status code: #{response.code}, url: #{uri}"
-        fail Shoptet::EmptyRequestResponse.new(message)
+        message = "Status code: #{response.code}, url: #{url}"
+        fail Shoptet::EmptyResponse.new(message)
       end
 
       parsed_body
     end
 
-    def self.post uri, body
-      req = Net::HTTP::Post.new uri
-      req.set_form_data body
+    def self.post url, body
+      request = Net::HTTP::Post.new(url)
+      request.set_form_data(body)
 
-      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
-        http.request req
+      response = Net::HTTP.start(url.host, url.port, use_ssl: true) do |http|
+        http.request(request)
       end
 
-      JSON.parse res.body
+      Oj.load(response.body, mode: :compat)
     end
   end
 end

data/shoptet.gemspec

@@ -22,5 +22,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'oj'
+
   spec.add_development_dependency 'irb'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: shoptet
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.26
 platform: ruby
 authors:
 - Premysl Donat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-27 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: irb
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +54,7 @@ files:
 - bin/console
 - bin/setup
 - lib/shoptet.rb
+- lib/shoptet/api_enumerator.rb
 - lib/shoptet/request.rb
 - shoptet.gemspec
 homepage: https://github.com/Masa331/shoptet
@@ -63,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: API wrapper for interacting with Shoptet api