shoptet 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682cc8f11ec548207514c501fb63e2c18ea8f9cb3a7ff4eb6db35b458b75b022
-  data.tar.gz: ec70519cd497dd8a49e9c72ee1940ec084fa0a2203889de3292febb658885c1a
+  metadata.gz: 020dcc94bd92d287243ac40e3bf854a9f0e5f4c32670fe221aa7af1a6b785e39
+  data.tar.gz: 5d3701df86ba602c16e626b7f703b01c733ef6878a3cfa862217c17cad19890e
 SHA512:
-  metadata.gz: 2ce582d9fdbac257cffd92e2b9cb60ac718141af95a2a744ad27605c35c883bbd82f9838deb9b1fde57802a37740f49309ac034b541b19ad2557e41b09ca0bbc
-  data.tar.gz: 0bc005b177781df29dd9c7b0471d317ed108529b717455bd70a88bbb3ccbdc8b303bbd1ff21e9c2e7cb834a969876de547eecd86d17cddf32a80cfa473fe297a
+  metadata.gz: b060e7a30c1cd96da7f7978231f40648b6a738154a33b0c6b5d8be538edd7e0f2dbfaa29490a16e979337244e9bd432b69e2a0cb3cc604a36d4354ba6c20e3a1
+  data.tar.gz: '0599e14ba6550168b2b02b31a8b25cb1452d244e27acb358d7a858473033c6992e0dec4a4cf28cf04d46d6c83c82ee4e06d54a0d00e7a2dc1e4afdda06827cb1'

data/README.md

@@ -1,8 +1,6 @@
 # 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.
+This is Ruby API wrapper for [Shoptet API](https://shoptet.docs.apiary.io) which provides access to e-shop data for addon developers.
 
 # How to install
 
@@ -82,6 +80,7 @@ Also they accept hash with params which will be passed to Shoptet api. Through t
 ## Other
 
 * `Shoptet#new_api_token` - this returns new api token created with oauth token
+* `Shoptet::install` - TODO
 
 ## License
 

data/lib/shoptet.rb

@@ -1,24 +1,72 @@
+require 'delegate'
 require_relative 'shoptet/request'
 
 class Shoptet
-  class Error < StandardError
-    #TODO: check that this works
-    attr_reader :additional_data
+  include Shoptet::UrlHelpers
 
-    def initialize message, additional_data = {}
-      super(message)
-      @additional_data = additional_data
-    end
-  end
+  class Error < StandardError; end
   class AddonSuspended < StandardError; end
   class AddonNotInstalled < StandardError; end
+  class InvalidTokenNoRights < StandardError; end
 
   DEFAULT_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.3'
+    '0.0.8'
   end
 
   def self.ar_on_token_error(model)
@@ -38,20 +86,71 @@ class Shoptet
     end
   end
 
+  def self.install url, redirect_url, client_id, client_secret, code
+    data = {
+      'redirect_uri' => redirect_url,
+      'client_id' => client_id,
+      'client_secret' => client_secret,
+      'code' => code,
+      'grant_type' => 'authorization_code',
+      'scope' => 'api'
+    }
+
+    Shoptet::Request.post url, data
+  end
+
+  def self.login_token url, code, client_id, client_secret, redirect_url
+    data = {
+      code: code,
+      grant_type: 'authorization_code',
+      client_id: client_id,
+      client_secret: client_secret,
+      redirect_uri: redirect_url,
+      scope: 'basic_eshop'
+    }
+
+    Shoptet::Request.post url, data
+  end
+
+  def self.basic_eshop url, access_token
+    Shoptet::Request.get url, { 'Authorization' => "Bearer #{access_token}" }
+  end
+
   attr_accessor :api_token
 
-  def initialize(oauth_url, oauth_token, api_token = nil, on_token_error = nil)
+  def initialize oauth_url:, oauth_token:, shop_url:, client_id:, api_token: nil, on_token_error: nil
     @oauth_url = oauth_url
     @oauth_token = oauth_token
+    @shop_url = shop_url
+    @client_id = client_id
     @api_token = api_token
     @on_token_error = on_token_error || DEFAULT_ON_TOKEN_ERROR
   end
 
+  def authorize_url redirect_url, state
+    query = {
+      client_id: @client_id,
+      state: state,
+      scope: 'basic_eshop',
+      response_type: 'code',
+      redirect_uri: redirect_url
+    }.to_query
+
+    URI("#{@shop_url}action/OAuthServer/authorize?#{query}").to_s
+  end
+
   def shop_info api_params = {}
-    request 'https://api.myshoptet.com/api/eshop'
+    result = request 'https://api.myshoptet.com/api/eshop'
+    result['data']
+  end
+
+  def design_info api_params = {}
+    result = request 'https://api.myshoptet.com/api/eshop/design'
+
+    result['data']
   end
 
-  def warehouses api_params = {}
+  def stocks api_params = {}
     enumerize 'https://api.myshoptet.com/api/stocks', api_params
   end
 
@@ -64,6 +163,11 @@ class Shoptet
     enumerize uri, api_params
   end
 
+  def stocks_movements warehouse_id, api_params = {}
+    uri = "https://api.myshoptet.com/api/stocks/#{warehouse_id}/movements"
+    enumerize uri, api_params
+  end
+
   def product_categories api_params = {}
     enumerize 'https://api.myshoptet.com/api/categories', api_params
   end
@@ -94,13 +198,13 @@ class Shoptet
   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)
+    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.dig('data')
+    result['data']
   end
 
   def new_api_token
@@ -112,35 +216,6 @@ class Shoptet
     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, retry_on_token_error = true
     headers = { 'Shoptet-Access-Token' => @api_token,
                 'Content-Type' => 'application/vnd.shoptet.v1.0' }
@@ -160,6 +235,12 @@ class Shoptet
     end
   end
 
+  private
+
+  def enumerize base_url, filters = {}, data_key = nil
+    ApiEnumerator.new base_url, filters, data_key, self
+  end
+
   def handle_errors result, uri, headers
     error = result['error']
     errors = result['errors'] || []
@@ -170,29 +251,13 @@ class Shoptet
         raise AddonSuspended
       elsif error == 'addon_not_installed'
         raise AddonNotInstalled
+      elsif errors.any? { |err| err["errorCode"] == 'invalid-token-no-rights' }
+        raise InvalidTokenNoRights
       else
-        additional_data = {
-          uri: uri,
-          headers: scrub_sensitive_headers(headers)
-        }
-
-        raise Error.new result, additional_data
+        raise Error.new result
       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

@@ -3,6 +3,15 @@ require 'net/http'
 #TODO: keep_alive_timeout ?
 
 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
       attempt ||= 0
@@ -28,5 +37,16 @@ class Shoptet
     rescue Net::OpenTimeout
       retry if attempt < 4
     end
+
+    def self.post uri, body
+      req = Net::HTTP::Post.new uri
+      req.set_form_data body
+
+      res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request req
+      end
+
+      JSON.parse res.body
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoptet
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Premysl Donat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-08 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb