ruby-brightpearl 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7950d4ca39461b4b4508b6db7ceefca32f3461bbb83f432ea29c80739e57a0cf
-  data.tar.gz: 8aaf0c72a2196d77f2f4d263b1e60dd078c92f5e20dbc226a70e38c1b2e9f476
+  metadata.gz: 898c21eda2183ad39766aed1a0973d4d3501df69c572bedc50cbe55497de8bfc
+  data.tar.gz: 6f9bcc5638f5fdce7f58f0d6d0a7f8611d86ff3b5a89dd0bd447b036bdf6a73b
 SHA512:
-  metadata.gz: 816871310b3ef7c096cbf4fb3717e09887aea158e236b36b8e324c2233047bd86f047b8cff15db8d78f9e06e15790821b88abd7946942e9418310ba3f18155d0
-  data.tar.gz: d544a07698537948b18a9b040fcdcc704b26edcb53d8319535e617bb6f7d09a79372f7a68a29cc704feb60c0d001d7a0dcf397b9ae5b4f222e1eeaa34687701d
+  metadata.gz: 523f4ca185fff9c6622cbb06e32469eb95f039d878ebe015fe1631926d9f17c54b5285aa5338397a7bcfe6cd35509b2f96536b93617e1640c28d222be91b2085
+  data.tar.gz: bd89d6e7a680e41092cb74d3f9be7a47870bf71a5de4017401f8845f25ac835db959d9fd614ae03dd8d9f7580e4de664d3cf1d37a1e5b2cf12240e70d329ce6a

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-02-03
+- New resource TaxCode
+- Fix minor typos
+- New optional config `debug_mode`
+## [0.3.0] - 2022-02-03
+- New resource ProductAvailability
+## [0.2.0] - 2022-02-02
+- Add refresh token mechanic with method `use_refresh_token`
+- Change config values
+  - Add refresh_token to allow automatic update of tokens when calling the new method `use_refresh_token`
+  - Remove `oauth_redirect_url` in favor of keyword arguments on `oauth_url` and `request_token`
+- Create a temp method for Client to use a token per request
+- Add error handling on auth request_token method and tests for some common errors.
+
 ## [0.1.0] - 2022-01-21
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.1.0)
+    ruby-brightpearl (0.4.0)
       httparty (~> 0.20)
 
 GEM

data/README.md

@@ -41,41 +41,55 @@ Using the official portal create a new application, the type must be `instance`,
 
 Start by setting up the initial configuration for the client:
 ```ruby
-Brightpearl.config.account =      ACCOUNT # From developer account creation
+require 'brightpearl'
+
+Brightpearl.config.account =      ACCOUNT # Account to request API access
 Brightpearl.config.dev_ref =      DEV_REF # From developer account creation
 
 Brightpearl.config.app_ref =      APP_REF # Brightpearl app ID
 Brightpearl.config.app_secret =   APP_REF # Brightpearl app secret
-
-Brightpearl.config.oauth_redirect_url = OAUTH_REDIRECT_URL # Brightpearl app authorized redirect url
 ```
 
 Before the API calls can be performed you will need to get a token, to get one the authentication flow must be followed as per brightpearl documentation: https://help.brightpearl.com/hc/en-us/articles/360032240811-Set-up-the-Authorization-Code-Grant-flow
 
 The oauth URL can be then generated with:
 ```ruby
-Brightpearl::Auth.oauth_url("random-passcode") # => "https://oauth.brightpearl.com/authorize/testAccount?response_type=code&client_id=testAppName&redirect_uri=https://2f826695ec8a.ngrok.io/oauth&state=random-passcode
+Brightpearl::Auth.oauth_url(state: "random-passcode", redirect_uri: "https://www.something.io/oauth") # => "https://oauth.brightpearl.com/authorize/testAccount?response_type=code&client_id=testAppName&redirect_uri=https://www.something.io/oauth&state=random-passcode
 ```
-NOTE: The argument on `oauth_url` is the state, this should be a non guessable string that the authorization server will pass back to you on redirection which you should check against to prevent CSRF attacks
+NOTE: The state argument on `oauth_url` method is a string defined by yourself, this should be a non guessable string that the authorization server will pass back to you on redirection which you should check against to prevent CSRF attacks
 
-#### 3) Trading your `auth code` for an access token.
+#### 3) Trading your `code` for an access token.
 
-The oauth process will return an url with a param called `code`, the value of this parameter is a temporary token that the app can exchange for an access token.
+The oauth process will redirect to your `redirect_uri` with a param called `code`, the value of this parameter is a temporary token that the app can exchange for an access token.
 
-This can be done by calling:
+This process be done by:
 
 ```ruby
-Brightpearl::Auth.request_token(AUTH_TOKEN) # => { token: "XXX", refresh_token: "XYZ", api_domain: "ws-use.brightpearl.com" }
+Brightpearl::Auth.request_token(auth_token: AUTH_TOKEN, redirect_uri: "https://www.something.io/oauth") # => { payload: { "access_token" => "XXX", "refresh_token" => "XYZ", "api_domain" => "ws-use.brightpearl.com" } }
 ```
 
 After the token is obtained it can be added to client by setting it on the config:
 ```ruby
 Brightpearl.config.api_domain = API_DOMAIN # Such as ws-use.brightpearl.com
 Brightpearl.config.token = TOKEN
+Brightpearl.config.refresh_token = REFRESH_TOKEN
+```
+
+NOTES: 
+* The token has a expiration time, when the token has expired a new one can be obtained using a refresh token.
+* The redirect_uri used on `request_token` should be the same used on `oauth_url`
+
+#### 3A) Using the refresh token to get a new access token
+
+When the token has expired, the `use_refresh_token` method can be used:
+```ruby
+Brightpearl::Auth.use_refresh_token(refresh_token: "XXX")
+# If refresh_token is loaded on config just call the method
+Brightpearl::Auth.use_refresh_token()
 ```
 
-Token has a expiration time, when the token has expired a new one can be obtained using the refresh token.
- 
+The return value is the same as `request_token`, additionally by default the new `token` and `refresh_token` are loaded on `Brightpearl.config`, if for some reason this is undesired it can be turned off by calling the method as `Brightpearl::Auth.use_refresh_token(autoupdate: false)`
+
  #### 4) Making requests
 Responses to REST requests are parsed into a hash with the keys `:payload` with the actual response from brightpearl API and `:quota_remaining` with the value of the current quota.
 

data/lib/brightpearl/auth.rb

@@ -1,17 +1,17 @@
 module Brightpearl
   class Auth
-    def self.oauth_url(state)
-      "https://oauth.brightpearl.com/authorize/#{Brightpearl.config.account}?response_type=code&client_id=#{Brightpearl.config.app_ref}&redirect_uri=#{Brightpearl.config.oauth_redirect_url}&state=#{state}"
+    def self.oauth_url(state:, redirect_uri:)
+      "https://oauth.brightpearl.com/authorize/#{Brightpearl.config.account}?response_type=code&client_id=#{Brightpearl.config.app_ref}&redirect_uri=#{redirect_uri}&state=#{state}"
     end
 
-    def self.request_token(auth_token)
+    def self.request_token(auth_token:, redirect_uri:)
       token_endpoint = "https://oauth.brightpearl.com/token/#{Brightpearl.config.account}"
       body = {
         grant_type: "authorization_code",
         code: auth_token,
         client_id: Brightpearl.config.app_ref,
         client_secret: Brightpearl.config.app_secret,
-        redirect_uri: Brightpearl.config.oauth_redirect_url
+        redirect_uri: redirect_uri, # SAME AS THE ONE USED ON oauth_url
       }
 
       response = HTTParty.post(token_endpoint, 
@@ -21,13 +21,48 @@ module Brightpearl
           'charset' => 'utf-8'
         }
       )
-      data = JSON.parse(response.body)
+      json = JSON.parse(response.body)
+      raise Brightpearl::RequestError.new(json["error_description"] || json["error"], response: json, status: 400) if response.code == 400
 
       return {
-        token: data["access_token"],
-        refresh_token: data["refresh_token"],
-        api_domain: data["api_domain"],
+        payload: json,
+        data: {
+          token: json["access_token"],
+          refresh_token: json["refresh_token"],
+          api_domain: json["api_domain"],
+        }
       }
     end
+
+    def self.use_refresh_token(refresh_token: nil, autoupdate: true)
+      token_endpoint = "https://oauth.brightpearl.com/token/#{Brightpearl.config.account}"
+      rtoken = refresh_token || Brightpearl.config.refresh_token
+      body = {
+        grant_type: "refresh_token",
+        refresh_token: rtoken,
+        client_id: Brightpearl.config.app_ref,
+      }
+      response = HTTParty.post(token_endpoint, 
+        body: body,
+        headers: { "Content-Type": "application/x-www-form-urlencoded", 'charset' => 'utf-8' }
+      )
+
+      json = JSON.parse(response.body)
+      if json["access_token"] && autoupdate
+        Brightpearl.config.token = json["access_token"]
+        Brightpearl.config.refresh_token = json["refresh_token"]
+      end
+
+      return {
+        payload: json,
+        data: {
+          token: json["access_token"],
+          refresh_token: json["refresh_token"],
+          api_domain: json["api_domain"]
+        }
+      }
+
+    end
+
   end
 end

data/lib/brightpearl/client.rb

@@ -1,6 +1,16 @@
 module Brightpearl
   class Client
-    # attr_accessor :token
+    # Send a request using a different token than the global config. (Useful when using a different token for specific calls)
+    def self.temp(token:, &block)
+      original_token = Brightpearl.config.token
+      begin
+        Brightpearl.config.token = token
+        yield
+      ensure
+        Brightpearl.config.token = original_token
+      end
+    end
+
     def self.send_request(path:, method: :get, **options )
       headers = {
         "brightpearl-app-ref": "#{Brightpearl.config.app_ref}",
@@ -36,7 +46,7 @@ module Brightpearl
         puts "Unrecognized http method"
       end
 
-      puts url
+      puts url if Brightpearl.config.debug_mode
       json = JSON.parse(response.body)
 
       if response.code == 503 # Unavailable MOST likeyly throttled

data/lib/brightpearl/config.rb

@@ -7,11 +7,12 @@ module Brightpearl
     # Application specific
     attr_accessor :app_ref            # App ref
     attr_accessor :app_secret         # App secret
-    attr_accessor :oauth_redirect_url # App authorized oauth redirect for app
     
     # Based on authentication process
     attr_accessor :token              # API token
     attr_accessor :api_domain         # API URL base. Depends on instance region. Obtained after auth process
-    # attr_accessor :refresh_token
+    attr_accessor :refresh_token      # API refresh token
+
+    attr_accessor :debug_mode         # Display log data for request done when true
   end 
 end 

data/lib/brightpearl/errors.rb

@@ -9,8 +9,6 @@ module Brightpearl
       else
         super(msg)
       end
-      puts @code
-      puts error
       @response = response
       @status = status
     end

data/lib/brightpearl/resources/product_availability.rb

@@ -0,0 +1,13 @@
+module Brightpearl
+  class ProductAvailability < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "warehouse-service/product-availability"
+      end
+      
+      # https://api-docs.brightpearl.com/warehouse/product-availability/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/tax_code.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class TaxCode < Resource
+    extend Brightpearl::APIOperations::Get
+    class << self
+      def resource_path
+        "accounting-service/tax-code"
+      end
+
+      def get(id_set = nil)
+        if id_set
+          super
+        else
+          super(nil)
+        end
+      end
+      
+      # https://api-docs.brightpearl.com/accounting/tax-code/get.html
+
+    end
+  end
+end

data/lib/brightpearl/resources.rb

@@ -6,4 +6,7 @@ require 'brightpearl/resources/order_status'
 require 'brightpearl/resources/order_status_update'
 require 'brightpearl/resources/product'
 require 'brightpearl/resources/product_price'
-require 'brightpearl/resources/price_list'
+require 'brightpearl/resources/price_list'
+require 'brightpearl/resources/product_availability'
+# Accounting
+require 'brightpearl/resources/tax_code'

data/lib/brightpearl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Brightpearl
-  VERSION = "0.1.0"
+  VERSION = "0.4.0"
 end

data/ruby-brightpearl.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/vicvans20/ruby-brightpearl."
+  spec.metadata["source_code_uri"] = "https://github.com/vicvans20/ruby-brightpearl"
   spec.metadata["changelog_uri"] = "https://github.com/vicvans20/ruby-brightpearl/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - vicvans20
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -103,7 +103,9 @@ files:
 - lib/brightpearl/resources/order_status_update.rb
 - lib/brightpearl/resources/price_list.rb
 - lib/brightpearl/resources/product.rb
+- lib/brightpearl/resources/product_availability.rb
 - lib/brightpearl/resources/product_price.rb
+- lib/brightpearl/resources/tax_code.rb
 - lib/brightpearl/version.rb
 - playground.rb
 - ruby-brightpearl.gemspec
@@ -114,7 +116,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/vicvans20/ruby-brightpearl
-  source_code_uri: https://github.com/vicvans20/ruby-brightpearl.
+  source_code_uri: https://github.com/vicvans20/ruby-brightpearl
   changelog_uri: https://github.com/vicvans20/ruby-brightpearl/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []