ruby-brightpearl 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdb848704f153ae9ba26d219cf41f6fb2837e47e7aacb4c7f2780d4abfa7e6ce
-  data.tar.gz: 693496443c266b56693804e2909672306298035e7caf3d266d2b5fa808d446dc
+  metadata.gz: d50d3172ec36f06ca6b5ac76a9fc5f69b578df384db02b467d4c57502ede7dae
+  data.tar.gz: 89d67376fd2e4a6c5e007c2c6300cd657e2115b202b4f67403c1364921cdf6f0
 SHA512:
-  metadata.gz: a8ec1a268a3bc9cc761d7f72f04e7f3130e3edbda988e369945d3fd4c8c7fcd96d22e8c59bed0d9329805bb9c3fe9dc517d8ef2a791bc1fc493eb52bf87714a6
-  data.tar.gz: 45a15dfbb0f95446c6cbb0625c0ea6998a7786e2e5f39ea917689df2e67e17f05f089aa4b6d29d06a05c4f753f3ae394cb5620f9c0c8d1aff5a2ff0542b8f8a1
+  metadata.gz: 7789dbc2a64efb929655e07def14a753246baf3ade6b7b6d3ed750da89b77abe9568ba1974634f7f22f98db54de6f379787c14d5901eddca571c0ced4ce56eb0
+  data.tar.gz: d259a5ead61c86d653f866bc150d5a604db202bd907b71530965d3cc27030d50e33f2fb122c0f591a971c515f07bc10c00855b1824535f0b6e9c4e0b525394a0

data/CHANGELOG.md

@@ -1,16 +1,39 @@
 ## [Unreleased]
 
-## [0.5.0]
+## [0.7.0] - 2025-11-03
+
+### Added
+
+- New API Operation `DELETE`
+- **New resource `Webhook`**
+  - Available operations: `GET`, `POST`, `DELETE`
+
+### Changed
+- Improved `Brightpearl::RequestError` message to include error code when available
+  - For example, `CMNC-404 - Resource not found` instead of just `Resource not found`
+
+## [0.6.0] - 2025-08-28
+
+- New resource `Customer`
+- New resource `CustomerCustomField`
+- Minor fixes on development libs
+
+## [0.5.0] - 2025-03-27
+
 - Add new resource OrderCustomField
 - Improve test environment to use different bp credentials without breaking the cassettes
 
 ## [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`

data/Gemfile

@@ -3,8 +3,4 @@
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in ruby-brightpearl.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.5.0)
+    ruby-brightpearl (0.7.0)
       httparty (~> 0.20)
 
 GEM
@@ -9,20 +9,27 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    bigdecimal (3.1.9)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
     byebug (11.1.3)
+    coderay (1.1.3)
     crack (0.4.5)
       rexml
-    csv (3.3.3)
+    csv (3.3.5)
     diff-lcs (1.5.0)
+    dotenv (3.1.8)
     hashdiff (1.0.1)
-    httparty (0.23.0)
+    httparty (0.23.2)
       csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
+    method_source (1.1.0)
     mini_mime (1.1.5)
-    multi_xml (0.7.1)
+    multi_xml (0.7.2)
       bigdecimal (~> 3.1)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (4.0.6)
     rake (13.0.6)
     rexml (3.2.5)
@@ -39,7 +46,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    vcr (6.0.0)
+    vcr (6.3.1)
+      base64
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
@@ -50,10 +58,12 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
+  dotenv
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   ruby-brightpearl!
-  vcr (~> 6.0)
+  vcr (~> 6.3.1)
   webmock
 
 BUNDLED WITH

data/lib/brightpearl/api_operations/delete.rb

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

data/lib/brightpearl/api_operations.rb

@@ -2,4 +2,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'
+require 'brightpearl/api_operations/options'
+require 'brightpearl/api_operations/delete'

data/lib/brightpearl/client.rb

@@ -54,6 +54,7 @@ module Brightpearl
       elsif response.code == 401
         raise Brightpearl::InvalidToken.new(json["response"], response: json, status: 401)
       elsif !!json["errors"]
+        # Request Error is the fallback message. If response has a tangible error message, first one will be used from response json
         raise Brightpearl::RequestError.new("Request Error",  response: json, status: response.code)
       end
 

data/lib/brightpearl/errors.rb

@@ -3,9 +3,11 @@ module Brightpearl
     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"]
+        error_message = response["errors"][0]["message"]
         @code = response["errors"][0]["code"]
-        super(error)
+
+        error_message = "#{@code} - #{error_message}" if @code
+        super(error_message)
       else
         super(msg)
       end

data/lib/brightpearl/resources/customer.rb

@@ -0,0 +1,60 @@
+module Brightpearl
+  # https://api-docs.brightpearl.com/contact/contact/index.html
+  class Customer < Resource
+    extend Brightpearl::APIOperations::Get
+    extend Brightpearl::APIOperations::Post
+    extend Brightpearl::APIOperations::Patch
+    extend Brightpearl::APIOperations::Options
+
+    attr_accessor :id, :primary_email, :secondary_email, :tertiary_email,
+                  :first_name, :last_name, :is_supplier, :company_name,
+                  :is_staff, :is_customer, :created_on, :updated_on, :last_contacted_on,
+                  :last_ordered_on, :nominal_code, :is_primary, :pri, :sec,
+                  :mob, :exact_company_name, :title
+
+    class << self
+      def resource_path
+        "contact-service/contact"
+      end
+
+      # https://api-docs.brightpearl.com/contact/contact/get.html
+      # https://api-docs.brightpearl.com/contact/contact/post.html
+      # https://api-docs.brightpearl.com/contact/contact/patch.html
+      # https://api-docs.brightpearl.com/contact/contact/options.html
+    
+      # https://api-docs.brightpearl.com/contact/contact/search.html
+      def search(query_params = {})
+        response = send_request(path: "contact-service/contact-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| Customer.new(item) },
+         })
+      end
+    end
+
+    # ARA => API Record Array
+    def initialize(ara)
+      @id = ara[0]
+      @primary_email = ara[1]
+      @secondary_email = ara[2]
+      @tertiary_email = ara[3]
+      @first_name = ara[4]
+      @last_name = ara[5]
+      @is_supplier = ara[6]
+      @company_name = ara[7]
+      @is_staff = ara[8]
+      @is_customer = ara[9]
+      @created_on = ara[10]
+      @updated_on = ara[11]
+      @last_contacted_on = ara[12]
+      @last_ordered_on = ara[13]
+      @nominal_code = ara[14]
+      @is_primary = ara[15]
+      @pri = ara[16]
+      @sec = ara[17]
+      @mob = ara[18]
+      @exact_company_name = ara[19]
+      @title = ara[20]
+    end
+
+  end
+end

data/lib/brightpearl/resources/customer_custom_field.rb

@@ -0,0 +1,18 @@
+module Brightpearl
+  # Contact custom fields are the user-defined data held against Brightpearl contacts. Several data types are available. Custom fields are separated between Supplier contacts and Customer contacts, and may only be assigned to one of these groups.
+  # https://api-docs.brightpearl.com/contact/custom-field/index.html
+  class CustomerCustomField < Resource
+    class << self 
+      # https://api-docs.brightpearl.com/contact/custom-field/get.html
+      def get(contact_id)
+        send_request(path: "contact-service/contact/#{contact_id}/custom-field", method: :get)
+      end
+  
+      # https://api-docs.brightpearl.com/contact/custom-field/patch.html
+      def patch(contact_id, params)
+        send_request(path: "contact-service/contact/#{contact_id}/custom-field", method: :patch, body: params)
+      end
+    end
+
+  end
+end

data/lib/brightpearl/resources/order.rb

@@ -60,7 +60,7 @@ module Brightpearl
         @order_shipping_status_id = nil
         @external_ref = ara["reference"]
         @installed_integration_instance_id = nil
-        @warehouse_id = ara["warehousrId"]
+        @warehouse_id = ara["warehouseId"]
         @staff_owner_contact_id = ara["assignment"]["current"]["staffOwnerContactId"]
         @tax_date = ara["invoices"][0] && ara["invoices"][0]["taxDate"]
         @department_id = nil

data/lib/brightpearl/resources/webhook.rb

@@ -0,0 +1,19 @@
+module Brightpearl
+  # Webhooks are used to define a 'callback contract' between Brightpearl and some third-party system. They specify the circumstances under which Brightpearl should send an HTTP message to the third-party system and the format of that message.
+  # 
+  # They are typically used to notify a remote server supporting some integration of a change in the state of a resource in a customer's Brightpearl account. For example, a carrier integration will want to know when Goods-Out Notes are picked or packed.
+  # 
+  # Please read Brightpearl webhooks for more information on how and when to use webhooks.
+  # https://api-docs.brightpearl.com/integration/webhook/index.html
+  class Webhook < Resource
+    extend Brightpearl::APIOperations::Get # /integration-service/webhook/{ID-SET}
+    extend Brightpearl::APIOperations::Post # /integration-service/webhook
+    extend Brightpearl::APIOperations::Delete # /integration-service/webhook/{ID}
+
+    class << self
+      def resource_path
+        "integration-service/webhook"
+      end
+    end
+  end
+end

data/lib/brightpearl/resources.rb

@@ -1,13 +1,22 @@
 require 'brightpearl/resource'
+
+require 'brightpearl/resources/customer'
+require 'brightpearl/resources/customer_custom_field'
+
 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/order_custom_field'
+
 require 'brightpearl/resources/product'
 require 'brightpearl/resources/product_price'
 require 'brightpearl/resources/price_list'
 require 'brightpearl/resources/product_availability'
+
+# Integration
+require 'brightpearl/resources/webhook'
+
 # Accounting
 require 'brightpearl/resources/tax_code'

data/lib/brightpearl/version.rb

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

data/playground.rb

@@ -1,14 +1,18 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
 
 require 'pry'
+require 'dotenv'
+require 'json'
 require_relative './lib/brightpearl.rb'
 
+Dotenv.load('.env')
+
 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 "The following request should work without issues if the token is valid"
 
 puts Brightpearl::Order.get(1)

data/ruby-brightpearl.gemspec

@@ -31,13 +31,17 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   
-  # Uncomment to register a new dependency of your gem
+  # Runtime dependencies - what users need to use your gem
   spec.add_dependency 'httparty', '~> 0.20'
-  # spec.add_dependency "example-gem", "~> 1.0"
 
-  spec.add_development_dependency("vcr", "~> 6.0")
+  # Development dependencies - what developers need to work on the gem
+  spec.add_development_dependency("vcr", "~> 6.3.1")
   spec.add_development_dependency("webmock")
   spec.add_development_dependency("byebug")
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("rake", "~> 13.0")
+  spec.add_development_dependency("dotenv")
+  spec.add_development_dependency("pry")
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - vicvans20
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +65,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: pry
+  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
@@ -85,6 +140,7 @@ files:
 - bin/setup
 - lib/brightpearl.rb
 - lib/brightpearl/api_operations.rb
+- lib/brightpearl/api_operations/delete.rb
 - lib/brightpearl/api_operations/get.rb
 - lib/brightpearl/api_operations/options.rb
 - lib/brightpearl/api_operations/patch.rb
@@ -96,6 +152,8 @@ files:
 - lib/brightpearl/errors.rb
 - lib/brightpearl/resource.rb
 - lib/brightpearl/resources.rb
+- lib/brightpearl/resources/customer.rb
+- lib/brightpearl/resources/customer_custom_field.rb
 - lib/brightpearl/resources/order.rb
 - lib/brightpearl/resources/order_custom_field.rb
 - lib/brightpearl/resources/order_row.rb
@@ -107,6 +165,7 @@ files:
 - lib/brightpearl/resources/product_availability.rb
 - lib/brightpearl/resources/product_price.rb
 - lib/brightpearl/resources/tax_code.rb
+- lib/brightpearl/resources/webhook.rb
 - lib/brightpearl/version.rb
 - playground.rb
 - ruby-brightpearl.gemspec
@@ -119,7 +178,6 @@ metadata:
   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
@@ -134,8 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Brightpearl API ruby client.
 test_files: []