cin7_api 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00aa61f9aba5bdaed71770a08bf215e94cc7dded390dcf68c04b175d672e359b
-  data.tar.gz: cf3b16f9e72f5f213c2b6a9fc6cab2517354ca238eea1af5afd24b3da02f2a82
+  metadata.gz: 0553e1a9d4db6501e28ed87aa824a5e58ce79171917f04f7d3c9fb72cb35454e
+  data.tar.gz: d71205d4103dc6eecaaf6fa6b4b1465e8ff14e3e4b017edfa0d9daa24e7452d6
 SHA512:
-  metadata.gz: ef12eed82b1d6ffdfdbcf6881d5fd83b91552df444d4b016008253b8763e4cd893f101175e474d85b62196e16422211f0d0c89490f2b7d17171f803f7ffd2e0a
-  data.tar.gz: 89e8c1b6f97614e2914bcc89e049a7e3273625e4e785be2a44a9c8a529504fd0a4e51e326f51c7aaba491c8f3e7462b438f1ce9c71e87bb191ec4886040ecef3
+  metadata.gz: a19008caf61d33c068423f9aa656d5eba3348d2b262bdc044f7914a395385bf9465244a281b5173c0272170c556acb20ea287f24acd02bc48f2af6608424f476
+  data.tar.gz: 69a986ad34adda010c8075166e031ef3e1a56411d7e904498f2c4bee318fb0250b4fd36b77773b4c4f0cf6bdc5bdff5a8297c3f3d1ee9b877fed6c9ad674d2ba

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cin7_api (1.0.2)
+    cin7_api (1.0.5)
       activesupport
       faraday (~> 2.5)
       zeitwerk
@@ -19,10 +19,10 @@ GEM
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    faraday (2.5.2)
+    faraday (2.6.0)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
+    faraday-net_http (3.0.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
@@ -69,7 +69,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
     vcr (6.1.0)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.1)
 
 PLATFORMS
   x86_64-darwin-21

data/lib/cin7_api/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class Error < StandardError
+  end
+
+  class ServerError < StandardError
+  end
+
+  class RateLimitError < StandardError
+  end
+end

data/lib/cin7_api/resource.rb

@@ -35,9 +35,9 @@ module Cin7API
       when 404
         raise Error, "The resource you have specified cannot be found. #{error_message}"
       when 429
-        raise Error, "The API rate limit for your application has been exceeded. #{error_message}"
+        raise RateLimitError, "The API rate limit for your application has been exceeded. #{error_message}"
       when 500
-        raise Error,
+        raise ServerError,
               "An unhandled error with the Cin7 API. Contact the Cin7 API team if problems persist. #{error_message}"
       when 503
         raise Error,

data/lib/cin7_api/resources/credit_note_resource.rb

@@ -2,20 +2,19 @@
 
 module Cin7API
   class CreditNoteResource < Resource
-    # NOTE: Cin7 is doing a binary OR check for the filter params
     # @client.credit_note.where(sales_reference: "#1050", email: "postco360@example.com")
     def where(**params)
-      credit_notes = get_request("CreditNotes", params: params).body
-      credit_notes.map { |attributes| CreditNote.new(attributes) }
+      response_body = get_request("CreditNotes", params: params).body
+      credit_notes = response_body.map { |attributes| CreditNote.new(attributes) }
+      # Doing a filter here because Cin7 is doing a binary OR check for the filter params
+      credit_notes.filter do |credit_note|
+        params.reduce(true) { |acc, (key, value)| acc && credit_note[key] == value }
+      end
     end
 
     # @client.credit_note.find_by(sales_reference: "#1050", email: "postco360@example.com")
     def find_by(**params)
-      credit_note =
-        where(**params).find do |p|
-          params.reduce(true) { |acc, (key, value)| acc && p[key] == value }
-        end
-      credit_note ? CreditNote.new(credit_note) : nil
+      where(**params).first
     end
 
     # @client.credit_note.find(2223)

data/lib/cin7_api/resources/payment_resource.rb

@@ -2,19 +2,19 @@
 
 module Cin7API
   class PaymentResource < Resource
-    # @client.payment.where(order_id: 2223)
+    # @client.payment.where(order_id: 2223, order_ref: "CRN-2223")
     def where(**params)
-      payments = get_request("Payments", params: params).body
-      payments.map { |attributes| Payment.new(attributes) }
+      response_body = get_request("Payments", params: params).body
+      payments = response_body.map { |attributes| Payment.new(attributes) }
+      # Doing a filter here because Cin7 is doing a binary OR check for the filter params
+      payments.filter do |payment|
+        params.reduce(true) { |acc, (key, value)| acc && payment[key] == value }
+      end
     end
 
     # @client.payment.find_by(order_id: 2223, order_ref: "CRN-2223")
     def find_by(**params)
-      payment =
-        where(**params).find do |p|
-          params.reduce(true) { |acc, (key, value)| acc && p[key] == value }
-        end
-      payment.present? ? payment : nil
+      where(**params).first
     end
 
     # @client.payment.find(698)

data/lib/cin7_api/resources/sales_order_resource.rb

@@ -2,20 +2,19 @@
 
 module Cin7API
   class SalesOrderResource < Resource
-    # NOTE: Cin7 is doing a binary OR check for the filter params
     # @client.sales_order.where(reference: "#1050", email: "postco360@example.com")
     def where(**params)
-      sales_orders = get_request("SalesOrders", params: params).body
-      sales_orders.map { |attributes| SalesOrder.new(attributes) }
+      response_body = get_request("SalesOrders", params: params).body
+      sales_orders = response_body.map { |attributes| SalesOrder.new(attributes) }
+      # Doing a filter here because Cin7 is doing a binary OR check for the filter params
+      sales_orders.filter do |sales_order|
+        params.reduce(true) { |acc, (key, value)| acc && sales_order[key] == value }
+      end
     end
 
     # @client.sales_order.find_by(reference: "#1050", email: "postco360@example.com")
     def find_by(**params)
-      sales_order =
-        where(**params).find do |p|
-          params.reduce(true) { |acc, (key, value)| acc && p[key] == value }
-        end
-      sales_order ? SalesOrder.new(sales_order) : nil
+      where(**params).first
     end
 
     # @client.sales_order.find(2218)

data/lib/cin7_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cin7API
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/lib/cin7_api.rb

@@ -7,7 +7,12 @@ loader = Zeitwerk::Loader.for_gem
 loader.inflector.inflect("cin7_api" => "Cin7API")
 loader.collapse("#{__dir__}/cin7_api/objects")
 loader.collapse("#{__dir__}/cin7_api/resources")
-loader.setup # ready!
+# Zeitwerk doesn't support multiple classes in a single file
+# https://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#one-file-one-constant-at-the-same-top-level
+loader.ignore("#{__dir__}/cin7_api/errors.rb")
+loader.setup
+
+require "cin7_api/errors"
 
 module Cin7API
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cin7_api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Wei Zhe Heng
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,7 +113,7 @@ files:
 - Rakefile
 - lib/cin7_api.rb
 - lib/cin7_api/client.rb
-- lib/cin7_api/error.rb
+- lib/cin7_api/errors.rb
 - lib/cin7_api/object.rb
 - lib/cin7_api/objects/credit_note.rb
 - lib/cin7_api/objects/payment.rb

data/lib/cin7_api/error.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Cin7API
-  class Error < StandardError; end
-end