shoptet 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f2a8ff1331b90ddcd3421d6408b667643d3fe8b95643ea7833f192a8152103d
-  data.tar.gz: 8a87de0252b757023dd35c20f67885454d4cc85f72651b4b91c32a9430531805
+  metadata.gz: 8facc56cfe2afc649cbad1f5094830d94d83f1f8d3d564e8886f17efe1b5bc87
+  data.tar.gz: 82c8517d218cc6182c54620e1161428d992a43e70364c23438fb0970bf303a6f
 SHA512:
-  metadata.gz: 7b1cfa1f1fe0b8d57bb8df48793224a94dd970adad6af9438ada8bdbeb0ba62caa91578058c50582fdcf2f890970995ff6bb73c56358699b9fa2726dd5801520
-  data.tar.gz: 5d45e753e5a64158e0d1d21b2f1dbc6daea2c894a70c6a2b43e0eccdd3645fe2ae569f452865c7752fde2b3ea623e90c17dd83c8d005f95f1eb5175901ffa7bd
+  metadata.gz: 3ff366765e02c7fe423368d0afa62bda693811c96f4f681b490161274228d39e0713cca821d4d49768c17e5f7de51e80a291bad2473e5087ff3bf4f22ccf872b
+  data.tar.gz: c74cda5f867dd363950b031cd4995fdf9585b843e8f66b11bdd7ec4f5e8e3f728e8340d7cebf796756133b05b3b3678716994692a46b169454e680b8a357f516

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,23 +1,17 @@
 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 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
 
   def self.version
-    '0.0.2'
+    '0.0.7'
   end
 
   def self.ar_on_token_error(model)
@@ -37,20 +31,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 warehouses api_params = {}
+  def design_info api_params = {}
+    result = request 'https://api.myshoptet.com/api/eshop/design'
+
+    result['data']
+  end
+
+  def stocks api_params = {}
     enumerize 'https://api.myshoptet.com/api/stocks', api_params
   end
 
@@ -63,6 +108,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
@@ -93,20 +143,20 @@ 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
     headers = { 'Authorization' => "Bearer #{@oauth_token}" }
 
     result = Shoptet::Request.get @oauth_url, headers
-    handle_errors result, @oauth_url
+    handle_errors result, @oauth_url, headers
 
     result.fetch 'access_token'
   end
@@ -130,32 +180,36 @@ class Shoptet
       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) }
+      first_page.dig('data', data_key).each { y.yield _1 }
 
       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) }
+        result.dig('data', data_key).each { y.yield _1 }
       end
     end
   end
 
-  def request uri
+  def request uri, retry_on_token_error = true
     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
+    token_errors = handle_errors result, uri, headers
 
     if token_errors.any?
-      @on_token_error.call self
-      request uri
+      if retry_on_token_error
+        @on_token_error.call self
+        request uri, false
+      else
+        raise Error.new result
+      end
     else
       result
     end
   end
 
-  def handle_errors result, uri
+  def handle_errors result, uri, headers
     error = result['error']
     errors = result['errors'] || []
     token_errors, non_token_errors = errors.partition { |err| ['invalid-token', 'expired-token'].include? err['errorCode'] }
@@ -163,29 +217,15 @@ class Shoptet
     if error || non_token_errors.any?
       if error == 'addon_suspended'
         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

@@ -28,5 +28,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.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Premysl Donat
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-07 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: irb