ruby-brightpearl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7950d4ca39461b4b4508b6db7ceefca32f3461bbb83f432ea29c80739e57a0cf
+  data.tar.gz: 8aaf0c72a2196d77f2f4d263b1e60dd078c92f5e20dbc226a70e38c1b2e9f476
+SHA512:
+  metadata.gz: 816871310b3ef7c096cbf4fb3717e09887aea158e236b36b8e324c2233047bd86f047b8cff15db8d78f9e06e15790821b88abd7946942e9418310ba3f18155d0
+  data.tar.gz: d544a07698537948b18a9b040fcdcc704b26edcb53d8319535e617bb6f7d09a79372f7a68a29cc704feb60c0d001d7a0dcf397b9ae5b4f222e1eeaa34687701d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-01-21
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at vicvans20@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-brightpearl.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    ruby-brightpearl (0.1.0)
+      httparty (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  ruby-brightpearl!
+  vcr (~> 6.0)
+  webmock
+
+BUNDLED WITH
+   2.3.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 vicvans20
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Brightpearl
+
+The Brightpearl gem allows Ruby developers to access the Brightpearl API resources for instance confidential apps.
+
+The Brightpearl API is implemented as a REST API JSON interface, using various HTTP verbs such as: GET/POST/PUT/PATCH/OPTIONS/DELETE. Each resource, like Order, Product, or Contact, has different operations available.
+
+To read more, follow the link to the official documentation: https://api-docs.brightpearl.com/
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-brightpearl'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby-brightpearl
+
+## Usage
+
+### Requirements
+
+All API usage happens through brightpearl applications, created by developers for private usage or for use by other brightpearl site owners:
+
+A brightpearl developer account is required to begin the development of apps, to read more info about the account creation refer to: https://help.brightpearl.com/hc/en-us/articles/211124886-Register-as-a-Brightpearl-developer
+
+Once an account is provided, developers can create applications through the official portal of brightpearl applications: https://developer.brightpearl.com/
+
+### Usage
+
+#### 1) Create an app
+
+Using the official portal create a new application, the type must be `instance`, once the app has been created an "application ID" and "secret" should be provided.
+
+#### 2) Requesting access for a brightpearl account
+
+Start by setting up the initial configuration for the client:
+```ruby
+Brightpearl.config.account =      ACCOUNT # From developer account creation
+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
+```
+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
+
+#### 3) Trading your `auth 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.
+
+This can be done by calling:
+
+```ruby
+Brightpearl::Auth.request_token(AUTH_TOKEN) # => { 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
+```
+
+Token has a expiration time, when the token has expired a new one can be obtained using the refresh token.
+ 
+ #### 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.
+
+NOTE: Search operations returns a Ruby object for the resource as well for easier access to the attributes, this is returned in the `:records` key on the result.
+
+```ruby
+result = Brightpearl::Order.get(1)
+
+order = result[:payload]["response"].first
+puts order["id"] # => 1
+puts order["orderTypeCode"] # => "SO"
+```
+
+Brightpearl API allows for multiple items to be requested at once on most resources:
+```ruby
+product_ids = [1, 2, 3]
+result = Brightpearl::Product.get(product_ids.join(","))
+puts result[:payload]["response"].size # => 3
+```
+
+NOTE: For more information about brightpearl API syntax refer to: https://help.brightpearl.com/hc/en-us/articles/212645003-URI-syntax
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-brightpearl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby-brightpearl/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Brightpearl project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby-brightpearl/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "brightpearl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/brightpearl/api_operations/get.rb

@@ -0,0 +1,11 @@
+module Brightpearl
+  module APIOperations
+    module Get
+      def get(id_set, query_params = nil)
+        path = "#{resource_path}/#{id_set}"
+        path = "#{path}?#{to_query(query_params)}" if query_params
+        send_request(path: path, method: :get)
+      end
+    end
+  end
+end

data/lib/brightpearl/api_operations/options.rb

@@ -0,0 +1,9 @@
+module Brightpearl
+  module APIOperations
+    module Options
+      def options(id_set)
+        send_request(path: "#{resource_path}/#{id_set}", method: :options)
+      end
+    end
+  end
+end

data/lib/brightpearl/api_operations/patch.rb

@@ -0,0 +1,9 @@
+module Brightpearl
+  module APIOperations
+    module Patch
+      def patch(id, params)
+        send_request(path: "#{resource_path}/#{id}", method: :patch, body: params)
+      end
+    end
+  end
+end

data/lib/brightpearl/api_operations/post.rb

@@ -0,0 +1,9 @@
+module Brightpearl
+  module APIOperations
+    module Post
+      def post(params)
+        send_request(path: "#{resource_path}", method: :post, body: params)
+      end
+    end
+  end
+end

data/lib/brightpearl/api_operations/put.rb

@@ -0,0 +1,9 @@
+module Brightpearl
+  module APIOperations
+    module Put
+      def put(id, params)
+        send_request(path: "#{resource_path}/#{id}", method: :put, body: params)
+      end
+    end
+  end
+end

data/lib/brightpearl/api_operations.rb

@@ -0,0 +1,5 @@
+require 'brightpearl/api_operations/get'
+require 'brightpearl/api_operations/post'
+require 'brightpearl/api_operations/patch'
+require 'brightpearl/api_operations/put'
+require 'brightpearl/api_operations/options'

data/lib/brightpearl/auth.rb

@@ -0,0 +1,33 @@
+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}"
+    end
+
+    def self.request_token(auth_token)
+      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
+      }
+
+      response = HTTParty.post(token_endpoint, 
+        body: body,
+        headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded',
+          'charset' => 'utf-8'
+        }
+      )
+      data = JSON.parse(response.body)
+
+      return {
+        token: data["access_token"],
+        refresh_token: data["refresh_token"],
+        api_domain: data["api_domain"],
+      }
+    end
+  end
+end

data/lib/brightpearl/client.rb

@@ -0,0 +1,62 @@
+module Brightpearl
+  class Client
+    # attr_accessor :token
+    def self.send_request(path:, method: :get, **options )
+      headers = {
+        "brightpearl-app-ref": "#{Brightpearl.config.app_ref}",
+        "brightpearl-dev-ref": "#{Brightpearl.config.dev_ref}",
+        "Authorization": "Bearer #{Brightpearl.config.token}"
+      }
+
+      url = "#{base_url}/#{path}"
+
+      case method
+      when :get
+        response = HTTParty.get(url, headers: headers )
+      when :delete
+        response = HTTParty.delete(url, headers: headers)
+      when :patch
+        response = HTTParty.patch(url, 
+          headers: headers.merge({ "Content-Type": "application/json" }), 
+          body: options[:body].to_json,
+        )
+      when :put
+        response = HTTParty.put(url, 
+          headers: headers.merge({ "Content-Type": "application/json" }), 
+          body: options[:body].to_json,
+        )
+      when :post
+        response = HTTParty.post(url, 
+          headers: headers.merge({ "Content-Type": "application/json" }), 
+          body: options[:body].to_json,
+        )
+      when :options
+        response = HTTParty.options(url, headers: headers )
+      else
+        puts "Unrecognized http method"
+      end
+
+      puts url
+      json = JSON.parse(response.body)
+
+      if response.code == 503 # Unavailable MOST likeyly throttled
+        raise Brightpearl::Throttled.new("Throttled", response: json, status: response.code)
+      elsif response.code == 401
+        raise Brightpearl::InvalidToken.new(json["response"], response: json, status: 401)
+      elsif !!json["errors"]
+        raise Brightpearl::RequestError.new("Request Error",  response: json, status: response.code)
+      end
+
+      return { 
+        payload: json, 
+        quota_remaining: response.headers["brightpearl-requests-remaining"] 
+      }
+      
+    end
+
+    def self.base_url
+      "https://#{Brightpearl.config.api_domain}/public-api/#{Brightpearl.config.account}"; 
+    end
+
+  end
+end

data/lib/brightpearl/config.rb

@@ -0,0 +1,17 @@
+module Brightpearl
+  class Config
+    # Developer Account
+    attr_accessor :dev_ref            # Developer ID
+    attr_accessor :account            # Brightpearl account
+    
+    # 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
+  end 
+end 

data/lib/brightpearl/errors.rb

@@ -0,0 +1,36 @@
+module Brightpearl
+  class RequestError < StandardError
+    attr_reader :response, :code, :status
+    def initialize(msg, response: nil, status: nil)
+      if response["errors"] && response["errors"].size == 1 # If error is easily identifiable then set it as the Error message
+        error = response["errors"][0]["message"]
+        @code = response["errors"][0]["code"]
+        super(error)
+      else
+        super(msg)
+      end
+      puts @code
+      puts error
+      @response = response
+      @status = status
+    end
+  end
+
+  class Throttled < StandardError
+    attr_reader :response, :code, :status
+    def initialize(msg, response: nil, status: nil)
+      super(msg)
+      @response = response
+      @status = status
+    end
+  end
+  
+  class InvalidToken < StandardError
+    attr_reader :response, :status
+    def initialize(msg, response: nil, status: nil)
+      super(msg)
+      @response = response
+      @status = status
+    end
+  end
+end

data/lib/brightpearl/resource.rb

@@ -0,0 +1,13 @@
+module Brightpearl
+  class Resource
+
+    def self.send_request(path:, method: :get, **options)
+      Brightpearl::Client.send_request(path: path, method: method, **options)
+    end
+
+    def self.to_query(query_params)
+      URI.encode_www_form(query_params)
+    end
+
+  end
+end

data/lib/brightpearl/resources/order.rb

@@ -0,0 +1,72 @@
+module Brightpearl
+  class Order < Resource
+    extend Brightpearl::APIOperations::Get
+    extend Brightpearl::APIOperations::Post
+    extend Brightpearl::APIOperations::Patch
+    extend Brightpearl::APIOperations::Options
+
+    attr_accessor :id, :order_type_id, :contact_id, :order_status_id, :order_stock_status_id,
+                  :created_on, :created_by_id,
+                  :customer_ref, :order_payment_status_id, :updated_on,
+                  :parent_order_id, :order_shipping_status_id, :external_ref,
+                  :installed_integration_instance_id, :warehouse_id, :staff_owner_contact_id,
+                  :tax_date, :department_id, :delivery_date
+
+    class << self
+      def resource_path
+        "order-service/order"
+      end
+
+      # https://api-docs.brightpearl.com/order/order/get.html
+      # https://api-docs.brightpearl.com/order/order/post.html
+      # https://api-docs.brightpearl.com/order/order/patch.html
+      # https://api-docs.brightpearl.com/order/order/options.html
+    
+  
+      # https://api-docs.brightpearl.com/order/order/search.html
+      def search(query_params = {})
+        response = send_request(path: "order-service/order-search?#{to_query(query_params)}", method: :get)
+        return response.merge({ # modify final payload to set search results as objects
+          records: response[:payload]["response"]["results"].map { |item| Order.new(item) },
+         })
+      end
+    end
+
+    # DSL
+    # ARA => API Record Array(from search and other endpoints)
+    def initialize(ara, as_response: false)
+      unless as_response
+        @id = ara[0];
+        @order_type_id = ara[1]; @contact_id = ara[2]; @order_status_id = ara[3]; @order_stock_status_id = ara[4];
+        @created_on = ara[5]; @created_by_id = ara[6]; 
+        @customer_ref = ara[7]; @order_payment_status_id = ara[8]; @updated_on = ara[9]; 
+        @parent_order_id = ara[10]; @order_shipping_status_id = ara[11]; @external_ref = ara[12];
+        @installed_integration_instance_id = ara[13]; @warehouse_id = ara[14]; @staff_owner_contact_id = ara[15]; 
+        @tax_date = ara[16];
+        @department_id = ara[17];
+        @delivery_date = ara[18];
+      else  # Order response from get_order
+        @id = ara["id"]
+        @order_type_id = nil 
+        @contact_id = ara["parties"]["customer"]["contactId"]
+        @order_status_id = ara["orderStatus"]["orderStatusId"]
+        @order_stock_status_id = nil
+        @created_on = ara["createdOn"]
+        @created_by_id = ara["createdById"]
+        @customer_ref = nil
+        @order_payment_status_id = nil
+        @updated_on = ara["updatedOn"]
+        @parent_order_id = ara["parentOrderId"]
+        @order_shipping_status_id = nil
+        @external_ref = ara["reference"]
+        @installed_integration_instance_id = nil
+        @warehouse_id = ara["warehousrId"]
+        @staff_owner_contact_id = ara["assignment"]["current"]["staffOwnerContactId"]
+        @tax_date = ara["invoices"][0] && ara["invoices"][0]["taxDate"]
+        @department_id = nil
+        @delivery_date = nil
+      end
+    end
+
+  end
+end

data/lib/brightpearl/resources/order_row.rb

@@ -0,0 +1,21 @@
+module Brightpearl
+  class OrderRow < Resource
+    class << self 
+      # https://api-docs.brightpearl.com/order/order-row/post.html
+      def post(order_id, params)
+        send_request(path: "order-service/order/#{order_id}/row", method: :post, body: params)
+      end
+  
+      # https://api-docs.brightpearl.com/order/order-row/patch.html
+      def patch(order_id, id, params)
+        send_request(path: "order-service/order/#{order_id}/row/#{id}", method: :patch, body: params)
+      end
+      
+      # https://api-docs.brightpearl.com/order/order-row/patch.html
+      def delete(order_id, id)
+        send_request(path: "order-service/order/#{order_id}/row/#{id}", method: :delete)
+      end
+    end
+
+  end
+end

data/lib/brightpearl/resources/order_shipping_status.rb

@@ -0,0 +1,12 @@
+module Brightpearl
+  class OrderShippingStatus < Resource
+
+    class << self
+      # https://api-docs.brightpearl.com/order/order-shipping-status/get.html
+      def get
+        send_request(path: "order-service/order-shipping-status", method: :get)
+      end
+
+    end
+  end
+end

data/lib/brightpearl/resources/order_status.rb

@@ -0,0 +1,15 @@
+module Brightpearl
+  class OrderStatus < Resource
+    extend Brightpearl::APIOperations::Get
+    extend Brightpearl::APIOperations::Post
+    class << self
+      def resource_path
+        "order-service/order-status"
+      end
+
+      # https://api-docs.brightpearl.com/order/order-status/get.html
+      # https://api-docs.brightpearl.com/order/order-status/post.html
+
+    end
+  end
+end

data/lib/brightpearl/resources/order_status_update.rb

@@ -0,0 +1,12 @@
+module Brightpearl
+  class OrderStatusUpdate < Resource
+
+    class << self
+      # https://api-docs.brightpearl.com/order/order-status-update/put.html
+      def put(id, params)
+        send_request(path: "order-service/order/#{id}/status", method: :put, body: params)
+      end
+
+    end
+  end
+end

data/lib/brightpearl/resources/price_list.rb

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

data/lib/brightpearl/resources/product.rb

@@ -0,0 +1,49 @@
+module Brightpearl
+  class Product < Resource
+    extend Brightpearl::APIOperations::Get
+    extend Brightpearl::APIOperations::Post
+    extend Brightpearl::APIOperations::Put
+    extend Brightpearl::APIOperations::Options
+
+    attr_accessor :id, :product_name, :sku, :barcode,
+                  :ean, :upc, :isbn, :mpn, 
+                  :stock_tracked, :sales_channel_name, :created_on, :updated_on,
+                  :bright_pearl_category_code, :product_group_id, :brand_id,
+                  :product_type_id, :product_status, :primary_supplier_id
+
+    class << self
+      def resource_path
+        "product-service/product"
+      end
+      
+      # https://api-docs.brightpearl.com/product/product/get.html
+      # https://api-docs.brightpearl.com/product/product/post.html
+      # https://api-docs.brightpearl.com/product/product/put.html
+      # https://api-docs.brightpearl.com/product/product/options.html
+  
+      # https://api-docs.brightpearl.com/product/product/search.html
+      def search(query_params = {})
+        response = send_request(path: "product-service/product-search?#{to_query(query_params)}", method: :get)
+        return response.merge({ # modify final payload to set search results as objects
+          records: response[:payload]["response"]["results"].map { |item| Product.new(item) },
+         })
+      end
+    end
+
+    # DSL
+    # ARA => API Record Array
+    def initialize(ara)
+      @id = ara[0];
+      @product_name = ara[1]; @sku = ara[2]; @barcode = ara[3];  
+      @ean = ara[4]; @upc = ara[5]; @isbn = ara[6]; @mpn = ara[7];
+      @stock_tracked = ara[8]; @sales_channel_name = ara[9];
+      @created_on = ara[10]; @updated_on = ara[11];
+      @bright_pearl_category_code = ara[12]; @product_group_id = ara[13];
+      @brand_id = ara[14]; 
+      @product_type_id = ara[15];
+      @product_status = ara[16];
+      @primary_supplier_id = ara[17];
+    end
+
+  end
+end

data/lib/brightpearl/resources/product_price.rb

@@ -0,0 +1,25 @@
+module Brightpearl
+  class ProductPrice < Resource
+    class << self 
+      # https://api-docs.brightpearl.com/product/product-price/get.html
+      def get(product_idset, price_list_idset = nil)
+        path = "product-service/product-price/#{product_idset}"
+        path = "#{path}/price-list/#{price_list_id}" if price_list_idset
+        send_request(path: path, method: :get)
+      end
+  
+      # https://api-docs.brightpearl.com/product/product-price/put.html
+      def put(product_id, params)
+        send_request(path: "product-service/product-price/#{product_id}/price-list", method: :put, body: params)
+      end
+      
+      # https://api-docs.brightpearl.com/product/product-price/options.html
+      def options(product_idset, price_list_idset = nil)
+        path = "product-service/product-price/#{product_idset}"
+        path = "#{path}/price-list/#{price_list_id}" if price_list_idset
+        send_request(path: path, method: :options)
+      end
+    end
+
+  end
+end

data/lib/brightpearl/resources.rb

@@ -0,0 +1,9 @@
+require 'brightpearl/resource'
+require 'brightpearl/resources/order'
+require 'brightpearl/resources/order_row'
+require 'brightpearl/resources/order_shipping_status'
+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'

data/lib/brightpearl/version.rb

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

data/lib/brightpearl.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'httparty'
+require 'uri'
+
+require "brightpearl/version"
+require 'brightpearl/config'
+require 'brightpearl/errors'
+require 'brightpearl/client'
+require 'brightpearl/auth'
+
+require 'brightpearl/api_operations'
+require 'brightpearl/resources'
+
+module Brightpearl
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.config
+    @config ||= Config.new
+  end
+  
+end

data/playground.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
+
+require 'pry'
+require_relative './lib/brightpearl.rb'
+
+Brightpearl.config.api_domain =   ENV["RUBY_BRIGHTPEARL_ENDPOINT"]
+Brightpearl.config.app_ref =      ENV["RUBY_BRIGHTPEARL_APP_REF"]
+Brightpearl.config.dev_ref =      ENV["RUBY_BRIGHTPEARL_DEV_REF"]
+Brightpearl.config.account =      ENV["RUBY_BRIGHTPEARL_ACCOUNT"]
+Brightpearl.config.token =        ENV["RUBY_BRIGHTPEARL_TOKEN"] # It expires
+
+puts "hello"
+
+puts Brightpearl::Order.get(1)

data/ruby-brightpearl.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/brightpearl/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-brightpearl"
+  spec.version = Brightpearl::VERSION
+  spec.authors = ["vicvans20"]
+  spec.email = ["vicvans20@gmail.com"]
+
+  spec.summary = "Brightpearl API ruby client."
+  spec.description = "Simple Ruby client to interact with brightpearl API."
+  spec.homepage = "https://github.com/vicvans20/ruby-brightpearl"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  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["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.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'httparty', '~> 0.20'
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_development_dependency("vcr", "~> 6.0")
+  spec.add_development_dependency("webmock")
+  spec.add_development_dependency("byebug")
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/ruby/brightpearl.rbs

@@ -0,0 +1,4 @@
+module Brightpearl
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ruby-brightpearl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vicvans20
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple Ruby client to interact with brightpearl API.
+email:
+- vicvans20@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/brightpearl.rb
+- lib/brightpearl/api_operations.rb
+- lib/brightpearl/api_operations/get.rb
+- lib/brightpearl/api_operations/options.rb
+- lib/brightpearl/api_operations/patch.rb
+- lib/brightpearl/api_operations/post.rb
+- lib/brightpearl/api_operations/put.rb
+- lib/brightpearl/auth.rb
+- lib/brightpearl/client.rb
+- lib/brightpearl/config.rb
+- lib/brightpearl/errors.rb
+- lib/brightpearl/resource.rb
+- lib/brightpearl/resources.rb
+- lib/brightpearl/resources/order.rb
+- lib/brightpearl/resources/order_row.rb
+- lib/brightpearl/resources/order_shipping_status.rb
+- lib/brightpearl/resources/order_status.rb
+- lib/brightpearl/resources/order_status_update.rb
+- lib/brightpearl/resources/price_list.rb
+- lib/brightpearl/resources/product.rb
+- lib/brightpearl/resources/product_price.rb
+- lib/brightpearl/version.rb
+- playground.rb
+- ruby-brightpearl.gemspec
+- sig/ruby/brightpearl.rbs
+homepage: https://github.com/vicvans20/ruby-brightpearl
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_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: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Brightpearl API ruby client.
+test_files: []