ruby-brightpearl 0.1.01 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9c38f924ae03982adecfada432233c107e5467db0eb095b6d08d21fe97b12c7
-  data.tar.gz: 9e27faf80334e375e42028afc329e7858ad6fdee017edae060220875a51fd49a
+  metadata.gz: 005e8e38899a3409cace6dc97b98f6e56057ad6631c4ee1f1fd8acaefae15c78
+  data.tar.gz: bf794427303a93c9a590a5de4c1ab5490003bbbeae0e383d15e775c6a95233e9
 SHA512:
-  metadata.gz: 39f59eb208a807d6bd797aade272521f80c33616a9be0e8b00183ae1fcee74c336a36422898d71cd1445833e8c2f3bc29e26ed1a7c2d9bfa9c7f5d2eb623ea73
-  data.tar.gz: 50c52c2a69b03d906667b891dff07786846e07f8fc63b2be6a2a834acab0cc6b603b7dc9614103e0f17f45917a1d53710da55228ecaf43d4b774ebfc19752e3d
+  metadata.gz: d074392ad00706d6f0e766e831e55e21d01873b8139318690ae0b9f841f61f734f0d11d05dfaa6504087d5a2dacba3a673028693002a544dbdb428f4ca2c17c7
+  data.tar.gz: 2f6227ee40bdba46caf0c8dd7b4a70f01c66f4de1dd849c32dfaf63c2385040fd2d2a9902aa5b16d921711eee00d0bfc53cf4d582d230c630d4c18ea3c7387e2

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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.01)
+    ruby-brightpearl (0.2.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}",

data/lib/brightpearl/config.rb

@@ -7,11 +7,10 @@ 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
   end 
 end 

data/lib/brightpearl/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.1.01
+  version: 0.2.0
 platform: ruby
 authors:
 - vicvans20
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty