ruby-brightpearl 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36879f9ba393e143164df763df4236de07986efca7a99a7d2267e87015aa74e2
-  data.tar.gz: 56674204c47ed147f9e8798b598f90b6c98320a5c29859112036c563d5b7c480
+  metadata.gz: fdb848704f153ae9ba26d219cf41f6fb2837e47e7aacb4c7f2780d4abfa7e6ce
+  data.tar.gz: 693496443c266b56693804e2909672306298035e7caf3d266d2b5fa808d446dc
 SHA512:
-  metadata.gz: fe7b11761a9aa7f475f694e249c1c6bf674fbf119c31efedc0225fa5265acfbbd9b21ee16ec240aa9916f03e38696ea5380d1762b181430e8e88a43a6fcd6c7b
-  data.tar.gz: 35042bea78d916efe48dd23d7c7d2495f39c39b4445bce7043eca7701982bfc878a01e749df170f7fb64ae135fe25fbcd17bc24307a46ee1658c5fa6425e3665
+  metadata.gz: a8ec1a268a3bc9cc761d7f72f04e7f3130e3edbda988e369945d3fd4c8c7fcd96d22e8c59bed0d9329805bb9c3fe9dc517d8ef2a791bc1fc493eb52bf87714a6
+  data.tar.gz: 45a15dfbb0f95446c6cbb0625c0ea6998a7786e2e5f39ea917689df2e67e17f05f089aa4b6d29d06a05c4f753f3ae394cb5620f9c0c8d1aff5a2ff0542b8f8a1

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-brightpearl (0.3.0)
+    ruby-brightpearl (0.5.0)
       httparty (~> 0.20)
 
 GEM
@@ -9,18 +9,20 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    bigdecimal (3.1.9)
     byebug (11.1.3)
     crack (0.4.5)
       rexml
+    csv (3.3.3)
     diff-lcs (1.5.0)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.23.0)
+      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)
+    mini_mime (1.1.5)
+    multi_xml (0.7.1)
+      bigdecimal (~> 3.1)
     public_suffix (4.0.6)
     rake (13.0.6)
     rexml (3.2.5)

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

@@ -46,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

@@ -12,5 +12,7 @@ module Brightpearl
     attr_accessor :token              # API token
     attr_accessor :api_domain         # API URL base. Depends on instance region. Obtained after auth process
     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/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/product_availability.rb

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

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

@@ -4,7 +4,10 @@ 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'
+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.3.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brightpearl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - vicvans20
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -97,6 +97,7 @@ files:
 - lib/brightpearl/resource.rb
 - lib/brightpearl/resources.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
@@ -105,6 +106,7 @@ files:
 - 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
@@ -132,7 +134,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.