beyond_api 0.7.1.pre → 0.8.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e0129444a024277fbe0f4abee48a66429124bd1a2e6a58111c9de45009a3a33
-  data.tar.gz: d2456258eb86285646a5cd0560f76156a54eaea591375c6b3a9a11e85811bbd5
+  metadata.gz: 687b39004d4ab172f3a2433b310fd09b95d3aa241be7e5f782941ae0edbeb491
+  data.tar.gz: 0524b2418f1185ae9902054381fc17ecd5e97fba16b9b2af5df80fd7bca47f65
 SHA512:
-  metadata.gz: e068ce40c0df8c695b847d086bb214f4d6b77839743ed1c8284d5be7e765fbeb3d0d6db6757ee6c74aae201765b1e4c47997292100f461cb64cd1608e376395f
-  data.tar.gz: 2196eed2089a57bd8eed949b2076d963e079324aaeccb08e5e3bb566e2a6f48c71177e6301d43fcef8aaf83e1a68f08fead959db0d74763da3a0b832899ec4b6
+  metadata.gz: 93a00f049eb3570f335a5ea6ad1eefc323ed1ea96b9e642dafa3277ad5854ccc6edc16d5b7aae156cd46cf7311809cdad4b4eb241d2935e24895e1bd581857ce
+  data.tar.gz: 85c9dfe12bbeb3dd6592a6371be3611f85b009a6eb050cf12bba2cf5a9f93025809a44f46364ec5e9c7c474f542108e8a0112ff16beac30e410f8d85bbe0b7a7

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### v0.8.0.pre
+
+* deprecations
+  * Remove `BeyondApi::Shop#open`
+  * Remove `BeyondApi::Shop#close`
+  * Remove `BeyondApi::Scopes`
+
+* features
+  * 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
@@ -6,12 +20,12 @@
 
 ### v0.7.0.pre
 
-* features
-  * Add `Products#assign_variation_images_differentiator` method
-
 * 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beyond_api (0.7.1.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

data/lib/beyond_api.rb

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

data/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

data/lib/beyond_api/resources/shop.rb

@@ -65,26 +65,6 @@ module BeyondApi
       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 @@ module BeyondApi
       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.
     #

data/lib/beyond_api/resources/token.rb

@@ -8,6 +8,7 @@ module BeyondApi
 
     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,12 +18,7 @@ module BeyondApi
                                                   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
@@ -30,9 +26,23 @@ module BeyondApi
                                                   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

data/lib/beyond_api/session.rb

@@ -13,7 +13,6 @@ require "beyond_api/resources/payment_methods"
 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 @@ module BeyondApi
       BeyondApi::Products.new(self)
     end
 
-    def scopes
-      BeyondApi::Scopes.new(self)
-    end
-
     def script_tags
       BeyondApi::ScriptTags.new(self)
     end

data/lib/beyond_api/version.rb

@@ -1,3 +1,3 @@
 module BeyondApi
-  VERSION = "0.7.1.pre".freeze
+  VERSION = "0.8.0.pre".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beyond_api
 version: !ruby/object:Gem::Version
-  version: 0.7.1.pre
+  version: 0.8.0.pre
 platform: ruby
 authors:
 - Unai Abrisketa
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,7 @@ files:
 - bin/setup
 - lib/beyond_api.rb
 - lib/beyond_api/connection.rb
+- lib/beyond_api/error.rb
 - lib/beyond_api/ext.rb
 - lib/beyond_api/request.rb
 - lib/beyond_api/resources/base.rb
@@ -156,7 +157,6 @@ files:
 - lib/beyond_api/resources/products/variation_properties.rb
 - lib/beyond_api/resources/products/videos.rb
 - lib/beyond_api/resources/products_view.rb
-- lib/beyond_api/resources/scopes.rb
 - lib/beyond_api/resources/script_tags.rb
 - lib/beyond_api/resources/shipping_zones.rb
 - lib/beyond_api/resources/shop.rb

data/lib/beyond_api/resources/scopes.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require "beyond_api/utils"
-
-module BeyondApi
-  class Scopes < Base
-    include BeyondApi::Utils
-
-    #
-    # A +GET+ request will list all scopes in the system.
-    #
-    #   $ curl 'https://api-shop.beyondshop.cloud/api/scopes' -i -X GET \
-    #       -H 'Authorization: Bearer <Access token>'
-    #
-    # @beyond_api.scopes +scop:r+
-    #
-    # @option params [Integer] :size the page size
-    # @option params [Integer] :page the page number
-
-    # @return [OpenStruct]
-    #
-    # @example
-    #   @scopes = session.scopes.all(size: 20, page: 0)
-    #
-    def all(params = {})
-      response, status = BeyondApi::Request.get(@session, "/scopes", params)
-
-      handle_response(response, status)
-    end
-  end
-end