cin7_api 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: def4242ec47be664686584c99a2375d3c349c3e30410caac8e42a0ae2ad24089
-  data.tar.gz: f71f8db45c6efec4c24252c9a5ee25050bc79b9626f64787213d68c6625807ce
+  metadata.gz: 056166ba00f5465bd7aa38f23e82a384f0690cb4edaddf990d6794cd30785736
+  data.tar.gz: 9cc3abe5f31a1c51a063dfd52e30a040dcab70078f1d54f26df6c71fa61e0cdb
 SHA512:
-  metadata.gz: 2e0bc2731ab0ec35e5d45efa3d748310b27833ccdaf76490a8272858608da8143db299119841d1a4b03e1ea36799e09e2a483aea15fd187857c76c77e5a15c47
-  data.tar.gz: bb2e02999a87823610ffc55037a6c1ad06752bdd9df89be4c2d35046f956d1605f9e1856d1a8e2b917d13ef5105231f89d807fc9c9fff734543503e80ace8621
+  metadata.gz: b2d9165f321d846269107172ee3da875725e086cbf20246f2a9dc70de0ecbc51f3595d76829eca8ff285dc3c908ff3398ea643bf6575d0832dca0889202f8927
+  data.tar.gz: 1a14d8c4a9977f810609cdaec318edc69801cc2fba5b4825b57d878dd3c813e3c2f09d00ccd705cd3305ec4c5580d907ef2ec4996e3ddd7810bccdf978a83c54

data/Gemfile

@@ -8,5 +8,3 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cin7_api (1.0.4)
+    cin7_api (1.1.0)
       activesupport
       faraday (~> 2.5)
       zeitwerk
@@ -9,34 +9,35 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     dotenv (2.8.1)
-    faraday (2.6.0)
+    faraday (2.7.5)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.1)
-    i18n (1.12.0)
+    faraday-net_http (3.0.2)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.16.3)
+    minitest (5.18.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -51,27 +52,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.1)
-    rubocop (1.36.0)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    tzinfo (2.0.5)
+    standard (1.25.5)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     vcr (6.1.0)
-    zeitwerk (2.6.1)
+    zeitwerk (2.6.8)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-21
   x86_64-linux
 
@@ -81,7 +90,7 @@ DEPENDENCIES
   pry
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  standard (~> 1.25.0)
   vcr
 
 BUNDLED WITH

data/lib/cin7_api/client.rb

@@ -26,6 +26,10 @@ module Cin7API
       PaymentResource.new(self)
     end
 
+    def branch
+      BranchResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new do |conn|
         conn.url_prefix = BASE_URL

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/{error.rb → objects/branch.rb}

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

data/lib/cin7_api/resource.rb

@@ -35,13 +35,14 @@ 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,
-              "An unhandled error with the Cin7 API. Contact the Cin7 API team if problems persist. #{error_message}"
+        raise ServerError,
+          "An unhandled error with the Cin7 API. Contact the Cin7 API team if problems persist. #{error_message}"
       when 503
         raise Error,
-              "API is currently unavailable – typically due to a scheduled outage – try again soon. #{error_message}"
+          "API is currently unavailable – typically due to a scheduled outage – try again soon. #{error_message}"
       end
 
       response
@@ -51,14 +52,15 @@ module Cin7API
 
     def parsed_params(params)
       # E.g: Need to convert to where: ["OrderId=2223", "SalesRefernce='CRN-2223'"]
-      parsed_params = params.each_with_object([]) do |(key, value), array|
-        # Cin7 requires string value filter to be wrapped in single-quote
-        parsed_value = value.is_a?(String) ? %('#{value}') : value
-        array << "#{key.to_s.camelcase}=#{parsed_value}"
-      end
+      parsed_params =
+        params.each_with_object([]) do |(key, value), array|
+          # Cin7 requires string value filter to be wrapped in single-quote
+          parsed_value = value.is_a?(String) ? %('#{value}') : value
+          array << "#{key.to_s.camelcase}=#{parsed_value}"
+        end
 
       # Only handle for Cin7 where query for now
-      { where: parsed_params }
+      {where: parsed_params}
     end
   end
 end

data/lib/cin7_api/resources/branch_resource.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class BranchResource < Resource
+    # Use 1 for active branches
+    # Use 0 for inactive branches
+    # @client.branch.where(active: 1)
+    def where(**params)
+      response_body = get_request("Branches", params: params).body
+      branches = response_body.map { |attributes| Branch.new(attributes) }
+      # Doing a filter here because Cin7 is doing a binary OR check for the filter params
+      branches.filter do |branch|
+        params.reduce(true) do |acc, (key, value)|
+          if key == :active
+            parsed_value = value == 1
+            branch["is_active"] == parsed_value
+          else
+            acc && branch[key] == value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cin7_api/resources/credit_note_resource.rb

@@ -35,5 +35,30 @@ module Cin7API
       responses = put_request("CreditNotes", body: attributes_array).body
       responses.map { |attributes| Response.new(attributes) }
     end
+
+    # attributes_array = [
+    #   {
+    #     branchId: 3,
+    #     salesReference: "HBP1030",
+    #     lineItems: [
+    #       {
+    #         code: "5-PAIRS-SOCKS",
+    #         styleCode: "5-PAIRS-SOCKS",
+    #         sizeCodes: nil,
+    #         name: "5PAIRS SOCKS - ONE SIZE",
+    #         option1: "ONE SIZE",
+    #         option2: "",
+    #         option3: nil,
+    #         qty: 1,
+    #         unitPrice: 0
+    #       },
+    #     ],
+    #   }
+    # ]
+    # @client.credit_note.create(attributes_array)
+    def create(attributes_array)
+      responses = post_request("CreditNotes", body: attributes_array).body
+      responses.map { |attributes| Response.new(attributes) }
+    end
   end
 end

data/lib/cin7_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cin7API
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 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.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Wei Zhe Heng
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -113,13 +127,15 @@ 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/branch.rb
 - lib/cin7_api/objects/credit_note.rb
 - lib/cin7_api/objects/payment.rb
 - lib/cin7_api/objects/response.rb
 - lib/cin7_api/objects/sales_order.rb
 - lib/cin7_api/resource.rb
+- lib/cin7_api/resources/branch_resource.rb
 - lib/cin7_api/resources/credit_note_resource.rb
 - lib/cin7_api/resources/payment_resource.rb
 - lib/cin7_api/resources/sales_order_resource.rb
@@ -149,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Cin7 API Wrapper