cin7_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7da8b2f7f6c38eaccde0b704581dde8fab9337b7f12a41faef7f12070bbfd1df
+  data.tar.gz: 6483ede66b64cb1cb877adb3b9412bcfedb4d3f91a2e87421155a12b9f51ea19
+SHA512:
+  metadata.gz: c5a0fd863152ab5699888436345bc278f7de43b54761ae89546b7a08af8c0bddbdf6aaeddb4bf1d68bdac0dadee3ac5bead32d7fdb4ef905db8e6223a352e4d9
+  data.tar.gz: 78764e32b7388deea6c9ac51aa55dad9ed8601fdf6147f2fb217cddbbd32e52db7e3b842b22c51d532f989fc8a062856c1c0adb7833e79b513155e6886beca9d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.streerc

@@ -0,0 +1 @@
+--print-width=100

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tech@weizheheng.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cin7_api.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    cin7_api (0.1.0)
+      activesupport
+      faraday (~> 2.5)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      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)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      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)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      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)
+      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)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    vcr (6.1.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  cin7_api!
+  dotenv
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  vcr
+
+BUNDLED WITH
+   2.3.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 PostCo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,159 @@
+# Cin7Api
+
+This is a Cin7 API wrapper gem to perform CRUD actions to the following resources:
+- SalesOrders
+- CreditNotes
+- Payments
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cin7_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cin7_api
+
+## Usage
+
+### Prerequisite
+This Gem requires the following Cin7 API permission:
+1. SalesOrder: READ and UPDATE
+2. CreditNote: READ and UPDATE
+3. Payment: READ, UPDATE and WRITE
+
+### SalesOrder
+
+```ruby
+client = Cin7API::Client.new(username: ENV["CIN7_USERNAME"], api_key: ENV["CIN7_API_KEY"])
+
+# Retrieve a list of SalesOrders with filter params
+# NOTE: Cin7 does a binary OR check on the filter params
+# This query will return SalesOrders with reference "#1050" OR email "postco360@example.com"
+client.sales_order.where(reference: "#1050", email: "postco360@example.com")
+
+# Find SalesOrder by filter params
+# NOTE: This will do a array#find for SalesOrder matching all the filter params
+# Return nil if none is found
+client.sales_order.find_by(reference: "#1050", email: "postco360@example.com")
+
+# Find SalesOrder by id
+# Return SalesOrder or raise Cin7API::Error
+client.sales_order.find(2218)
+
+# Update SalesOrders
+# NOTE: Cin7 only allow bulk updates
+# NOTE: The key has to be in lower camelCase
+attributes_array = [
+  {
+    id: 2221,
+    lineItems: [{ id: 8140, unitPrice: 100 }],
+    dispatchedDate: "2022-09-16T09:00:00Z",
+    invoiceDate: "2022-09-16T09:00:00Z"
+  }
+]
+# => [#<Cin7API::Response index=0, success=true, id=2221, code="#1052", errors=[]>]
+client.sales_order.update(attributes_array)
+```
+
+### CreditNote
+
+```ruby
+client = Cin7API::Client.new(username: ENV["CIN7_USERNAME"], api_key: ENV["CIN7_API_KEY"])
+
+# Retrieve a list of CreditNotes with filter params
+# NOTE: Cin7 does a binary OR check on the filter params
+# This query will return CreditNotes with sales_reference "#1050" OR email "postco360@example.com"
+client.credit_note.where(sales_reference: "#1050", email: "postco360@example.com")
+
+# Find CreditNote by filter params
+# NOTE: This will do a array#find for CreditNote matching all the filter params
+# Return nil if none is found
+client.credit_note.find_by(reference: "#1050", email: "postco360@example.com")
+
+# Find CreditNote by id
+# Return CreditNote or raise Cin7API::Error
+client.credit_note.find(2223)
+
+# Update CreditNote
+# NOTE: Cin7 only allow bulk updates
+# NOTE: The key has to be in lower camelCase
+attributes_array = [
+  {
+    id: 2223,
+    lineItems: [{ id: 8142, unitPrice: 10 }, {id: 8143, unitPrice: 10}],
+    completedDate: "2022-09-10T09:00:00Z",
+    creditNoteDate: "2022-09-10T09:00:00Z",
+  }
+]
+# => [#<Cin7API::Response index=0, success=true, id=2223, code="CRN-2223", errors=[]>]
+client.credit_note.update(attributes_array)
+```
+
+### Payment
+
+```ruby
+client = Cin7API::Client.new(username: ENV["CIN7_USERNAME"], api_key: ENV["CIN7_API_KEY"])
+
+# Retrieve a list of Payments with filter params
+# NOTE: Cin7 does a binary OR check on the filter params
+# This query will return Payments with order_id 2223 OR order_ref "CRN-2223"
+client.payment.where(order_id: 2223, order_ref: "CRN-2223")
+
+# Find Payment by filter params
+# NOTE: This will do a array#find for Payment matching all the filter params
+# Return nil if none is found
+client.payment.find_by(order_id: 2223, order_ref: "CRN-2223")
+
+# Find Payment by id
+# Return Payment or raise Cin7API::Error
+client.payment.find(698)
+
+# Create Payment
+# NOTE: Cin7 only allow bulk creates
+# NOTE: The key has to be in lower camelCase
+attributes_array = [
+  {
+    orderType: "CreditNote",
+    orderRef: "CRN-2223",
+    orderId: 2223,
+    method: "Not Paid",
+    amount: 10,
+    paymentDate: "2022-09-10T09:00:00Z"
+  }
+]
+# => [#<Cin7API::Response index=0, success=true, id=713, code=nil, errors=[]>]
+client.payment.create(attributes_array)
+
+# Update Payment
+# NOTE: Cin7 only allow bulk updates
+# NOTE: The key has to be in lower camelCase
+attributes_array = [{ id: 713, orderId: 2223, method: "manual", amount: 0 }]
+# => [#<Cin7API::Response index=0, success=true, id=713, code=nil, errors=[]>]
+client.payment.update(attributes_array)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cin7_api. 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]/cin7_api/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cin7Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cin7_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/cin7_api.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/cin7_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "cin7_api"
+  spec.version = Cin7API::VERSION
+  spec.authors = ["Wei Zhe Heng"]
+  spec.email = ["marcusheng@postco.co"]
+
+  spec.summary = "Cin7 API Wrapper"
+  spec.homepage = "https://github.com/PostCo/cin7_api"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PostCo/cin7_api"
+  spec.metadata["changelog_uri"] = "https://github.com/PostCo/cin7_api/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "activesupport"
+  spec.add_dependency "zeitwerk"
+  spec.add_development_dependency("dotenv")
+  spec.add_dependency "faraday", "~> 2.5"
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.add_development_dependency("pry")
+  spec.add_development_dependency("vcr")
+end

data/lib/cin7_api/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Cin7API
+  class Client
+    BASE_URL = "https://api.cin7.com/api/v1/"
+
+    attr_reader :username, :api_key, :adapter
+
+    def initialize(username:, api_key:, adapter: Faraday.default_adapter)
+      @username = username
+      @api_key = api_key
+      @adapter = adapter
+    end
+
+    def sales_order
+      SalesOrderResource.new(self)
+    end
+
+    def credit_note
+      CreditNoteResource.new(self)
+    end
+
+    def payment
+      PaymentResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter
+        conn.request :authorization, :basic, username, api_key
+      end
+    end
+  end
+end

data/lib/cin7_api/error.rb

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

data/lib/cin7_api/object.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+require "ostruct"
+
+module Cin7API
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key.underscore, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/cin7_api/objects/credit_note.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class CreditNote < Object
+  end
+end

data/lib/cin7_api/objects/payment.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class Payment < Object
+  end
+end

data/lib/cin7_api/objects/response.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class Response < Object
+  end
+end

data/lib/cin7_api/objects/sales_order.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class SalesOrder < Object
+  end
+end

data/lib/cin7_api/resource.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string"
+
+module Cin7API
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, parsed_params(params), headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def handle_response(response)
+      error_message = response.body
+
+      case response.status
+      when 400
+        raise Error, "A bad request or a validation exception has occurred. #{error_message}"
+      when 401
+        raise Error, "Invalid authorization credentials. #{error_message}"
+      when 403
+        raise Error, "Connection doesn't have permission to access the resource. #{error_message}"
+      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}"
+      when 500
+        raise Error,
+              "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}"
+      end
+
+      response
+    end
+
+    private
+
+    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
+
+      # Only handle for Cin7 where query for now
+      { where: parsed_params }
+    end
+  end
+end

data/lib/cin7_api/resources/credit_note_resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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) }
+    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
+    end
+
+    # @client.credit_note.find(2223)
+    def find(id)
+      CreditNote.new(get_request("CreditNotes/#{id}").body)
+    end
+
+    # attributes_array = [
+    #   {
+    #     id: 2223,
+    #     lineItems: [{ id: 8142, unitPrice: 10 }, {id: 8143, unitPrice: 10}],
+    #     completedDate: "2022-09-10T09:00:00Z",
+    #     creditNoteDate: "2022-09-10T09:00:00Z",
+    #   }
+    # ]
+    # @client.credit_note.update(attributes_array)
+    def update(attributes_array)
+      responses = put_request("CreditNotes", body: attributes_array).body
+      responses.map { |attributes| Response.new(attributes) }
+    end
+  end
+end

data/lib/cin7_api/resources/payment_resource.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Cin7API
+  class PaymentResource < Resource
+    # @client.payment.where(order_id: 2223)
+    def where(**params)
+      payments = get_request("Payments", params: params).body
+      payments.map { |attributes| Payment.new(attributes) }
+    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
+    end
+
+    # @client.payment.find(698)
+    def find(id)
+      Payment.new(get_request("Payments/#{id}").body)
+    end
+
+    # attributes_array = [
+    #   {
+    #     orderType: "CreditNote",
+    #     orderRef: "CRN-2223",
+    #     orderId: 2223,
+    #     method: "Not Paid",
+    #     amount: 10,
+    #     paymentDate: "2022-09-10T09:00:00Z",
+    #   }
+    # ]
+    # @client.payment.create(attributes_array)
+    def create(attributes_array)
+      responses = post_request("Payments", body: attributes_array).body
+      responses.map { |attributes| Response.new(attributes) }
+    end
+
+    # attributes_array = [
+    #   {
+    #     id: 712,
+    #     orderId: 2223,
+    #     method: "manual",
+    #     amount: 0,
+    #   }
+    # ]
+    # @client.payment.update(attributes_array)
+    def update(attributes_array)
+      responses = put_request("Payments", body: attributes_array).body
+      responses.map { |attributes| Response.new(attributes) }
+    end
+  end
+end

data/lib/cin7_api/resources/sales_order_resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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) }
+    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
+    end
+
+    # @client.sales_order.find(2218)
+    def find(id)
+      SalesOrder.new(get_request("SalesOrders/#{id}").body)
+    end
+
+    # attributes_array = [
+    #   {
+    #     id: 2221,
+    #     lineItems: [{ id: 8140, unitPrice: 100 }],
+    #     dispatchedDate: "2022-09-16T09:00:00Z",
+    #     invoiceDate: "2022-09-16T09:00:00Z"
+    #   }
+    # ]
+    # @client.sales_order.update(attributes_array)
+    def update(attributes_array)
+      responses = put_request("SalesOrders", body: attributes_array).body
+      responses.map { |attributes| Response.new(attributes) }
+    end
+  end
+end

data/lib/cin7_api/version.rb

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

data/lib/cin7_api.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "cin7_api/version"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "cin7_api" => "Cin7API"
+)
+loader.collapse("./lib/cin7_api/resources")
+loader.collapse("./lib/cin7_api/objects")
+loader.setup # ready!
+
+module Cin7Api
+end

data/sig/cin7_api.rbs

@@ -0,0 +1,4 @@
+module Cin7Api
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: cin7_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wei Zhe Heng
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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:
+email:
+- marcusheng@postco.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".streerc"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- cin7_api.gemspec
+- lib/cin7_api.rb
+- lib/cin7_api/client.rb
+- lib/cin7_api/error.rb
+- lib/cin7_api/object.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/credit_note_resource.rb
+- lib/cin7_api/resources/payment_resource.rb
+- lib/cin7_api/resources/sales_order_resource.rb
+- lib/cin7_api/version.rb
+- sig/cin7_api.rbs
+homepage: https://github.com/PostCo/cin7_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/PostCo/cin7_api
+  source_code_uri: https://github.com/PostCo/cin7_api
+  changelog_uri: https://github.com/PostCo/cin7_api/releases
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.22
+signing_key:
+specification_version: 4
+summary: Cin7 API Wrapper
+test_files: []