Merge remote-tracking branch 'upstream/master'

Author: unabris

CHANGELOG.md

@@ -1,11 +1,31 @@
-### v0.7.0.pre
+### v0.8.0.pre
+
+* deprecations
+  * Remove `BeyondApi::Shop#open`
+  * Remove `BeyondApi::Shop#close`
+  * Remove `BeyondApi::Scopes`
 
 * features
-  * Add `Products#assign_variation_images_differentiator` method
+  * Add `BeyondApi::Token#client_credentials`
+
+* enhancements
+  * Create a custom `BeyondApi::Error` class
+  * Avoid duplicated code on token response handling
+
+### v0.7.1.pre
+
+* bug-fixes
+  * Allow to create a `BeyondApi::Session` without `access_token` and `refresh_token`
+  * Fix no-Rails logger
+
+### v0.7.0.pre
 
 * deprecations
   * `Variations#adjust_stock_level` receives parameter `relative_amount` instead of `body`
 
+* features
+  * Add `Products#assign_variation_images_differentiator` method
+
 ### v0.6.0.pre
 
 * bug-fixes

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.7.0.pre)
+    beyond_api (0.8.0.pre)
       faraday (~> 0.15)
 
 GEM
@@ -52,4 +52,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.0.pre.3
+   2.1.4

lib/beyond_api.rb

@@ -3,13 +3,14 @@
 require "beyond_api/connection"
 require "beyond_api/request"
 require "beyond_api/session"
+require "beyond_api/error"
 
 require "beyond_api/ext"
 require "beyond_api/utils"
 
-module BeyondApi
-  class Error < StandardError; end
+require "logger"
 
+module BeyondApi
   def self.logger
     @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
   end

lib/beyond_api/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BeyondApi
+  class Error
+    attr_reader :error_id, :details, :message, :trace_id
+
+    def initialize(data)
+      @error_id = data['errorId']
+      @details = data['details']
+      @message = data['message']
+      @trace_id = data['traceId']
+    end
+  end
+end

lib/beyond_api/request.rb

@@ -9,7 +9,7 @@ class << self
         define_method(method) do |session, path, params = {}|
           response = BeyondApi::Connection.default.send(method) do |request|
             request.url(session.api_url + path)
-            request.headers['Authorization'] = "Bearer #{ session.access_token }"
+            request.headers['Authorization'] = "Bearer #{ session.access_token }" unless session.access_token.nil?
             request.params = params.to_h.camelize_keys
           end
 
@@ -21,7 +21,7 @@ class << self
         define_method(method) do |session, path, body = {}, params = {}|
           response = BeyondApi::Connection.default.send(method) do |request|
             request.url(session.api_url + path)
-            request.headers['Authorization'] = "Bearer #{ session.access_token }"
+            request.headers['Authorization'] = "Bearer #{ session.access_token }" unless session.access_token.nil?
             request.params = params.to_h.camelize_keys
             request.body = body.camelize_keys.to_json
           end
@@ -34,7 +34,7 @@ class << self
     def self.upload(session, path, file_binary, content_type, params)
       response = BeyondApi::Connection.default.post do |request|
         request.url(session.api_url + path)
-        request.headers['Authorization'] = "Bearer #{ session.access_token }"
+        request.headers['Authorization'] = "Bearer #{ session.access_token }" unless session.access_token.nil?
         request.headers['Content-Type'] = content_type
         request.params = params.to_h.camelize_keys
         request.body = file_binary

lib/beyond_api/resources/base.rb

@@ -8,10 +8,9 @@ class InvalidSessionError < StandardError; end
 
     def initialize(session)
       @session = session
-      raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondApi::Session
-      if session.api_url.nil? || session.access_token.nil? || session.refresh_token.nil?
-        raise InvalidSessionError.new("Session api_url, access_token and refresh_token cannot be nil")
-      end
+
+      raise InvalidSessionError, "Invalid session" unless session.is_a? BeyondApi::Session
+      raise InvalidSessionError, "Session api_url cannot be nil" if session.api_url.nil?
     end
   end
 end

lib/beyond_api/resources/scopes.rb

@@ -65,26 +65,6 @@ def attributes(params = {})
       handle_response(response, status)
     end
 
-    #
-    # A +POST+ request is used to close a shop.
-    #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/shop/close' -i -X POST \
-    #       -H 'Content-Type: application/json' \
-    #       -H 'Authorization: Bearer <Access token>'
-    #
-    # @beyond_api.scopes +shcl:c+
-    #
-    # @return true
-    #
-    # @example
-    #   session.shop.close
-    #
-    def close
-      response, status = BeyondApi::Request.post(@session, "/shop/close")
-
-      handle_response(response, status, respond_with_true: true)
-    end
-
     #
     # A +POST+ request is used to create a shop attribute.
     #
@@ -310,26 +290,6 @@ def legal_details
       handle_response(response, status)
     end
 
-    #
-    # A +POST+ request is used to open a shop.
-    #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/shop/open' -i -X POST \
-    #       -H 'Content-Type: application/json' \
-    #       -H 'Authorization: Bearer <Access token>'
-    #
-    # @beyond_api.scopes +shcl:c+
-    #
-    # @return true
-    #
-    # @example
-    #   session.shop.open
-    #
-    def open
-      response, status = BeyondApi::Request.post(@session, "/shop/open")
-
-      handle_response(response, status, respond_with_true: true)
-    end
-
     #
     # A +GET+ request is issued to search for shop images by label.
     #

lib/beyond_api/resources/shop.rb

@@ -8,6 +8,7 @@ class InvalidSessionError < StandardError; end
 
     def initialize(session)
       @session = session
+
       raise InvalidSessionError.new("Invalid session") unless session.is_a? BeyondApi::Session
       raise InvalidSessionError.new("Session api_url cannot be nil") if session.api_url.nil?
     end
@@ -17,22 +18,31 @@ def create(code)
                                                   grant_type: "authorization_code",
                                                   code: code)
 
-      if status.between?(200, 299)
-        @session.access_token = response["access_token"]
-        @session.refresh_token = response["refresh_token"]
-      else
-        BeyondApi::Error.new(response)
-      end
+      handle_response(response, status)
     end
 
     def refresh
       response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
                                                   grant_type: "refresh_token",
                                                   refresh_token: @session.refresh_token)
 
+      handle_response(response, status)
+    end
+
+    def client_credentials
+      response, status = BeyondApi::Request.token(@session.api_url + "/oauth/token",
+                                                  grant_type: "client_credentials")
+
+      handle_response(response, status)
+    end
+
+    private
+
+    def handle_response(response, status)
       if status.between?(200, 299)
         @session.access_token = response["access_token"]
         @session.refresh_token = response["refresh_token"]
+        @session
       else
         BeyondApi::Error.new(response)
       end

lib/beyond_api/resources/token.rb

@@ -13,7 +13,6 @@
 require "beyond_api/resources/product_attribute_definitions"
 require "beyond_api/resources/products_view"
 require "beyond_api/resources/products"
-require "beyond_api/resources/scopes"
 require "beyond_api/resources/script_tags"
 require "beyond_api/resources/shipping_zones"
 require "beyond_api/resources/shop"
@@ -82,10 +81,6 @@ def products
       BeyondApi::Products.new(self)
     end
 
-    def scopes
-      BeyondApi::Scopes.new(self)
-    end
-
     def script_tags
       BeyondApi::ScriptTags.new(self)
     end