ruby-brightpearl 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 898c21eda2183ad39766aed1a0973d4d3501df69c572bedc50cbe55497de8bfc
-  data.tar.gz: 6f9bcc5638f5fdce7f58f0d6d0a7f8611d86ff3b5a89dd0bd447b036bdf6a73b
+  metadata.gz: a80cab051224d81b25426eb10655cbc17a7671befe929070149f9f8f0e15d7a0
+  data.tar.gz: f3123fd3ed140e7609c4b8001e3550442432ec7758fe9d7f1509d5950d27389e
 SHA512:
-  metadata.gz: 523f4ca185fff9c6622cbb06e32469eb95f039d878ebe015fe1631926d9f17c54b5285aa5338397a7bcfe6cd35509b2f96536b93617e1640c28d222be91b2085
-  data.tar.gz: bd89d6e7a680e41092cb74d3f9be7a47870bf71a5de4017401f8845f25ac835db959d9fd614ae03dd8d9f7580e4de664d3cf1d37a1e5b2cf12240e70d329ce6a
+  metadata.gz: 3a0a2a922874b73cf68f788338c7ebf9b3b5c925a8fa211c009dd09a2e37f891b4d3bb45d5d65043907b1b4302aba4506608549debe5feb2932b65cb0cddfc21
+  data.tar.gz: c5b1cecc26f306eddcd7be95374c809704d925fb8238afc9d2ff0c9e4058eeb45e9685aeb38c506262a80977432d274c5a886aa3c051cd085bfa8aa86d5647a1

data/CHANGELOG.md

@@ -1,12 +1,27 @@
 ## [Unreleased]
 
+## [0.6.0]
+
+- New resource `Customer`
+- New resource `CustomerCustomField`
+- Minor fixes on development libs
+
+## [0.5.0]
+
+- 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.4.0)
+    ruby-brightpearl (0.6.0)
       httparty (~> 0.20)
 
 GEM
@@ -9,18 +9,27 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    base64 (0.3.0)
+    bigdecimal (3.2.2)
     byebug (11.1.3)
+    coderay (1.1.3)
     crack (0.4.5)
       rexml
+    csv (3.3.5)
     diff-lcs (1.5.0)
+    dotenv (3.1.8)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.23.1)
+      csv
+      mini_mime (>= 1.0.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)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    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)
@@ -37,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)
@@ -48,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/README.md

@@ -119,6 +119,30 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Testing
+
+Before you can you tests, you have to setup some env variables:
+* RUBY_BRIGHTPEARL_ENDPOINT: The API endpoint to use, e.g. https://ws-use.brightpearl.com
+* RUBY_BRIGHTPEARL_APP_REF: The app ref to use, e.g. barulu
+* RUBY_BRIGHTPEARL_DEV_REF: The dev ref to use, e.g. barulu
+* RUBY_BRIGHTPEARL_ACCOUNT: The account to use, e.g. barulu
+* RUBY_BRIGHTPEARL_TOKEN: The token to use, e.g. barulu
+
+You have to fetch these yourself.
+
+## Release
+
+To release a new version follow these steps:,
+1. Update CHANGELOG.md with the new version changes
+2. Update the version number in `version.rb` 
+3. Execute bundle to update version on `Gemfile.lock` automatically
+4. Commit the changes and change the branch to `main`
+5. 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).
+
+> Remember to execute `bundle exec rake release` on `main` branch
+> `Gemfile.lock` update for version is done after running `bundle install` with the `version.rb` updated
+
+
 ## 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).

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/order_custom_field.rb

@@ -0,0 +1,19 @@
+module Brightpearl
+  # Order custom fields are user-defined data held against an order. 
+  # Custom fields are defined separately for sales and purchase orders. 
+  # Field names and data types are shared between every order of the same type. Several data types are available.
+  class OrderCustomField < Resource
+    class << self 
+      # https://api-docs.brightpearl.com/order/order-customfields/get.html
+      def get(order_id)
+        send_request(path: "order-service/order/#{order_id}/custom-field", method: :get)
+      end
+  
+      # https://api-docs.brightpearl.com/order/order-customfields/patch.html
+      def patch(order_id, params)
+        send_request(path: "order-service/order/#{order_id}/custom-field", method: :patch, body: params)
+      end
+    end
+
+  end
+end

data/lib/brightpearl/resources.rb

@@ -1,9 +1,15 @@
 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'

data/lib/brightpearl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Brightpearl
-  VERSION = "0.4.0"
+  VERSION = "0.6.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,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - vicvans20
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2025-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,14 +30,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 +66,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
@@ -96,7 +152,10 @@ 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
 - lib/brightpearl/resources/order_shipping_status.rb
 - lib/brightpearl/resources/order_status.rb
@@ -133,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Brightpearl API ruby client.