orderspace-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab5e3c865f82ea7b2797a52f607b6460da31a21564e87dd737500345640c179d
+  data.tar.gz: 72c899077ef985f60547a3d3f51bac54667c80ac15f9dabb67c95468f70c2c6c
+SHA512:
+  metadata.gz: b4e33f5a8bb0e08247db43c0fab02f319eb7319801d23431d3c7291974fb5de664d61e7ab954dad568cbf3f8e57978e5cfb08e28d60306241ef63130309de944
+  data.tar.gz: 0f32c14f8b8d0fcc24a5187e45011d5a89500fff6c2383d2306bd26cac2124465b70b9c558efa50b9a96eacd801fca7c9b33da25f6f400abd4275a9810da5018

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-01
+
+- Initial release connecting to the oauth, customers and orders endpoints as well as parsing webhook events.

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 enrique@ecomba.pro. 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 orderspace-ruby.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'standard', '~> 1.3'
+gem 'webmock'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    orderspace-ruby (0.1.0)
+      httparty (= 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.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.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.18.1)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.1)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  orderspace-ruby!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov
+  standard (~> 1.3)
+  webmock
+
+BUNDLED WITH
+   2.3.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Enrique Comba Riepenhausen
+
+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,197 @@
+# Bean Mind Orderspace Ruby Client
+
+:bomb: **This gem is under development, USE AT YOUR OWN RISK**
+
+A Ruby client to connect and use the Orderspace API (https://apidocs.orderspace.com/).
+
+![Orderspace Logo](orderspace-logo.png)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add orderspace-ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install orderspace-ruby
+
+## Usage
+
+Before you start you will have to setup a _"private app"_ in Orderspace.
+
+```https://[your_company_name].orderspace.com/admin/apps/new```
+
+In the form you will have to name the app and add a contact email address. Once you've done so, you will be given
+a `client_id` and a `client_secret`. These two values are the ones you'll need when using this client.
+
+### Initialising the client
+
+The client is initialised with the `client_id` and the `client_secret` you acquired when setting up a new private app
+in Orderspace as described above.
+
+```ruby
+client = Orderspace::Client.with(client_id, client_secret)
+```
+
+This will use the OAuth endpoint to grab the `auth token` and insert it in the headers for each subsequent call to the API.
+
+Please note that Orderspace's Auth tokens work for a limited time. 
+
+:warning: DO NOT STORE YOUR AUTH TOKEN AS IT MIGHT NOT WORK IN LATER REQUESTS! :warning:
+
+### Customers Endpoint
+
+Things you can do with the customers endpoint.
+
+#### Creating a customer
+
+```ruby
+customer = Orderspace::Structs::Customer.new.tap do |c|
+  c.company_name = "Your Customers Company"
+  # other attributes you might want to set.
+end
+
+# This customer will have an id as assigned by Orderspace during creation
+created_customer = client.customers.create_customer(customer)
+```
+
+#### Listing customers
+
+Listing customers will return a `Orderspace::Structs::CustomerList` struct.
+
+```ruby
+customers = client.customers.list_customers
+```
+
+You can also pass options to narrow your list down like so:
+
+```ruby
+options = { query: { limit: 42, status: 'active' } }
+customers = client.customers.list_customers(options)
+```
+
+Refer to the [list customers](https://apidocs.orderspace.com/#list-customers) endpoint documentation for further options you can use.
+
+#### Getting a customer
+
+```ruby
+customer_id = 'cu_dnwz8gnx'
+customer = client.customers.get_customer(customer_id)
+```
+
+#### Updating a customer
+
+To update a customer you will have to first get the customer (so that the id and other fields are properly populated).
+
+```ruby
+customer = client.customers.get_customer(customer_id)
+customer.company_name = "New Company Name"
+
+updated_customer = client.customers.edit_customer(customer)
+```
+
+### Orders Endpoint
+
+Things you can do with orders.
+
+#### List orders
+
+Listing orders will return a `Orderspace::Structs::OrderList` struct.
+
+```ruby
+orders = client.orders.list_orders
+```
+
+You can also pass options to narrow your list down like so:
+
+```ruby
+options = { query: { limit: 20, status: 'preorder' } }
+orders = client.orders.list_orders(options)
+```
+
+Refer to the [list orders](https://apidocs.orderspace.com/#list-orders) endpoint documentation for further options you can use.
+
+#### Getting an order
+
+```ruby
+order_id = 'or_l5DYqeDn'
+order = client.orders.get_order(order_id)
+```
+
+### Webhooks Endpoint
+
+Things you can do with webhooks.
+
+#### Creating a webhook
+
+```ruby
+webhook = Orderspace::Structs::Webhook.new.tap do |w|
+  w.endpoint = 'https://your/uri/to/receive/the/event'
+  w.events = %w[order.created dispatch.created]
+end
+
+new_webhook = client.webhooks.create(webhook)
+```
+
+#### Listing webhooks
+
+Listing webhooks will return a `Orderspace::Structs::WebhookList` struct.
+
+```ruby
+webhooks = client.webhooks.list_webhooks
+```
+
+#### Getting a webhook
+
+```ruby
+webhook_id = 'wh_o9ernm4p'
+webhook = client.webhooks.get_webhook(webhook_id)
+```
+
+#### Updating a webhook
+
+To update a webhook you will have to first get the webhook (so that the id field is properly populated).
+
+```ruby
+webhook = client.webhooks.get_webhook(webhook_id)
+webhook.events = %w[order.created order.deleted]
+
+updated_webhook = client.webhooks.update_webhook(webhook)
+```
+
+#### Deleting a webhook
+
+To delete a webhook you will have to first get the webhook (so that the id field is properly populated).
+
+It will return a `Orderspace::Structs::Webhook` struct with only it's `id` and `deleted` attributes as a confirmation.
+
+```ruby
+webhook = client.webhooks.get_webhook(webhook_id)
+deleted = client.webhooks.delete_webhook(webhook)
+```
+
+## 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/bean-mind/orderspace-ruby. 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]/orderspace-ruby/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 Orderspace::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bean-mind/orderspace-ruby/blob/main/CODE_OF_CONDUCT.md).
+
+## Bean Mind
+
+This gem was created by [Bean Mind](https://beanmind.com) as part of the [Orderspace](https://www.orderspace.com) integration work
+in our product.
+
+![Bean Mind](beanmind.svg)

data/Rakefile

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

data/beanmind.svg

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg width="100%" height="100%" viewBox="0 0 284 283" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linecap:square;stroke-miterlimit:1.5;">
+    <g transform="matrix(1,0,0,1,-374.926,-351.162)">
+        <g id="Brain-mesh" serif:id="Brain mesh">
+            <g id="Layer1">
+                <path d="M450.335,633.979L514.98,576.351L563.917,575.572L586,534.937L636.823,533.51L658.665,477.801L628.127,429.901L552.961,397.447L499.215,401.398L397.477,437.725L374.926,476.631L381.042,514.036L407.483,541.91L415.115,565.172L454.579,571.421L450.335,633.979ZM456.153,622.094L459.877,567.198L418.913,560.712C418.913,560.712 411.884,539.284 411.884,539.284L385.728,511.711C385.728,511.711 380.149,477.59 380.149,477.59C380.149,477.59 400.884,441.818 400.884,441.818C400.884,441.818 500.257,406.335 500.257,406.335C500.257,406.335 552.104,402.523 552.104,402.523C552.104,402.523 624.736,433.883 624.736,433.883C624.736,433.883 653.082,478.344 653.082,478.344C653.082,478.344 633.376,528.605 633.376,528.605C633.376,528.605 582.982,530.019 582.982,530.019L560.918,570.619C560.918,570.619 513.041,571.381 513.041,571.381L456.153,622.094Z" style="fill:rgb(95,95,95);"/>
+            </g>
+            <g id="Layer2">
+                <path d="M478.422,570.959L516.796,552.829L584.264,533.059L655.034,475.462L599.569,449.102L555.293,402.349L534.806,460.234L599.569,449.102L584.264,533.059L534.806,460.234L488.559,513.955L584.264,533.059L488.559,513.955L430.706,513.955L378.63,478.007L430.706,513.955L458.785,448.169L398.684,441.01L458.785,448.169L500.022,402.893L458.785,448.169L534.806,460.234L458.785,448.169L488.559,513.955L430.706,513.955L408.262,538.765L458.087,568.187L488.559,513.955L478.422,570.959Z" style="fill:none;stroke:rgb(95,95,95);stroke-width:4px;"/>
+                <path d="M454.579,626.514L478.422,570.959L489.303,515.713L514.98,552.834L514.98,570.959" style="fill:none;stroke:rgb(95,95,95);stroke-width:4px;"/>
+            </g>
+        </g>
+        <g id="Circles">
+            <g transform="matrix(-0.000954338,0.781568,-0.781568,-0.000954338,429.901,516.847)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(102,153,153);stroke:rgb(95,95,95);stroke-width:7.68px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.175695,0.98794,-0.98794,-0.175695,488.453,511.672)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(255,102,51);stroke:rgb(95,95,95);stroke-width:5.98px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.0115577,0.776699,-0.776699,-0.0115577,458.546,449.12)">
+                <circle cx="0" cy="0" r="9.492" style="fill:white;stroke:rgb(95,95,95);stroke-width:7.72px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.0115577,0.776699,-0.776699,-0.0115577,540,386.276)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(0,255,51);stroke:rgb(95,95,95);stroke-width:7.72px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.0115577,0.776699,-0.776699,-0.0115577,565.31,361.535)">
+                <circle cx="0" cy="0" r="9.492" style="fill:white;stroke:rgb(95,95,95);stroke-width:7.72px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.088091,1.23528,-1.23528,-0.088091,534.681,459.842)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(255,0,153);stroke:rgb(95,95,95);stroke-width:4.84px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(0.0737842,1.12488,-1.12488,0.0737842,499.078,404.349)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(255,102,51);stroke:rgb(95,95,95);stroke-width:5.32px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(0.0737842,1.12488,-1.12488,0.0737842,589.89,386.747)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(255,0,153);stroke:rgb(95,95,95);stroke-width:5.32px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.105076,0.878331,-0.878331,-0.105076,599.664,450.617)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(102,153,153);stroke:rgb(95,95,95);stroke-width:6.78px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.0781548,1.05963,-1.05963,-0.0781548,582.768,531.351)">
+                <circle cx="0" cy="0" r="9.492" style="fill:rgb(0,255,51);stroke:rgb(95,95,95);stroke-width:5.65px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+            <g transform="matrix(-0.0115577,0.776699,-0.776699,-0.0115577,452.99,571.176)">
+                <circle cx="0" cy="0" r="9.492" style="fill:white;stroke:rgb(95,95,95);stroke-width:7.72px;stroke-linecap:round;stroke-linejoin:round;"/>
+            </g>
+        </g>
+    </g>
+</svg>

data/lib/orderspace/client.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Orderspace
+  ##
+  # This class is the entrypoint to the Orderspace API
+  #
+  # To obtain an access token you will have to have registered a private application
+  # with Orderspace (https://<your_space>.orderspace.com/admin/apps/new).
+  # This will give you the client_id and client_secret you need in order to get your access token.
+  #
+  # client = Client.with(client_key, client_secret)
+  class Client
+
+    include Default
+
+    HEADER_AUTHORIZATION = 'Authorization'
+    API_VERSION = 'v1'
+
+    attr_reader :access_token
+
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    def self.with(client_id, client_secret)
+      credentials = new.oauth.obtain_access_token(client_id, client_secret)
+      new(credentials.access_token)
+    end
+
+    ##
+    # Represents the base url to Orderspace's API (i.e. https://api.orderspace.com/)
+    # @return [String] the base url to Orderspace's API
+    def self.base_url
+      BASE_URL
+    end
+
+    ##
+    # Represents the URL to the Orderspace API with it's version (i.e. https://api.orderspace.com/v1/)
+    # @return [String] the versioned Orderspace API url
+    def self.versioned_url
+      "#{base_url}#{API_VERSION}/"
+    end
+
+    ##
+    # Returns the oauth endpoint
+    def oauth
+      OauthEndpoint.new(self)
+    end
+
+    ##
+    # Returns the customers endpoint
+    def customers
+      CustomersEndpoint.new(self)
+    end
+
+    ##
+    # Returns the orders endpoint
+    def orders
+      OrdersEndpoint.new(self)
+    end
+
+    ##
+    # Returns the webhooks endpoint
+    def webhooks
+      WebhooksEndpoint.new(self)
+    end
+
+    class OauthEndpoint < Orderspace::Endpoint
+      include Orderspace::Endpoint::Oauth
+    end
+
+    class CustomersEndpoint < Orderspace::Endpoint
+      include Orderspace::Endpoint::Customers
+    end
+
+    class OrdersEndpoint < Orderspace::Endpoint
+      include Orderspace::Endpoint::Orders
+    end
+
+    class WebhooksEndpoint < Orderspace::Endpoint
+      include Orderspace::Endpoint::Webhooks
+    end
+
+    def get(path, options = {})
+      execute(:get, path, nil, options.to_h)
+    end
+
+    def post(path, data = nil, options = {})
+      execute(:post, path, data, options)
+    end
+
+    def put(path, data = nil, options = {})
+      execute(:put, path, data, options)
+    end
+
+    def delete(path, data = nil, options = {})
+      execute(:delete, path, data, options)
+    end
+
+    def execute(method, path, data = nil, options = {})
+      uri = Client.versioned_url + path
+      response = request(method, uri, data, options)
+
+      case response.code
+      when 200..299
+        response
+      when 400
+        raise BadRequestError, response
+      when 401
+        raise AuthorizationFailedError, response
+      when 404
+        raise NotFoundError, response
+      when 422
+        raise UnprocessableEntityError, response
+      when 429
+        raise TooManyRequestsError, response
+      when 500
+        raise InternalServerError, response
+      else
+        raise RequestError, response
+      end
+    end
+
+    def request(method, uri, data = nil, options = {})
+      request_options = add_custom_request_options(options)
+
+      request_options[:headers]['Authorization'] = "Bearer #{@access_token}" if @access_token
+
+      if data
+        request_options[:headers]['Content-Type'] = 'application/json'
+        request_options[:body] = JSON.dump(data)
+      end
+
+      HTTParty.send(method, uri, request_options)
+    end
+
+    def add_custom_request_options(custom_options)
+      base_request_options.tap do |options|
+        custom_options.each do |key, value|
+          options[key] = value
+        end
+      end
+    end
+
+    def base_request_options
+      {
+        format: :json,
+        headers: {
+          'Accept' => 'application/json',
+          'User-Agent' => USER_AGENT
+        }
+      }
+    end
+  end
+end

data/lib/orderspace/default.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Orderspace
+  ##
+  # Module to compile the default settings
+  module Default
+
+    # Default Orderspace API endpoint
+    BASE_URL = 'https://api.orderspace.com/'
+
+    # Default User-Agent header
+    USER_AGENT = "beanmind-orderspace-ruby/#{VERSION}".freeze
+  end
+end

data/lib/orderspace/endpoint/customers.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Orderspace
+  class Endpoint
+    ##
+    # Contains the methods to interact with the customers endpoint.
+    # @see https://apidocs.orderspace.com/#customers
+    module Customers
+      include Orderspace::Structs
+
+      ##
+      # Used to add a customer to your orderspace account
+      #
+      # @see https://apidocs.orderspace.com/#create-a-customer
+      #
+      # @param customer [Orderspace::Structs::Customer] The customer to be added
+      # @return [Orderspace::Structs::Customer] The customer added (including the generated id)
+      def create_customer(customer)
+        response = client.post('customers', { customer: Orderspace::Structs.hashify(customer) })
+        Orderspace::Structs.from(JSON.parse(response.body)['customer'], Customer)
+      end
+
+      ##
+      # Lists all the customers in your account.
+      #
+      # You can pass in options like so:
+      # { query: { starting_after: 'cu_53zjgvnm', limit: 1 } }
+      #
+      # Check tho orderspace API documentation to know all the options available.
+      #
+      # @see https://apidocs.orderspace.com/#list-customers
+      #
+      # @return customer_list [Orderspace::Structs::CustomerList] a list of customers
+      def list_customers(options = {})
+        response = client.get('customers', options)
+
+        Orderspace::Structs.from(JSON.parse(response.body), CustomerList)
+      end
+
+      ##
+      # Returns a customer searching by it's id
+      # @param customer_id [String] the id of the customer we are looking for.
+      # @return [Orderspace::Structs::Customer] The customer found
+      def get_customer(customer_id)
+        response = client.get("customers/#{customer_id}")
+
+        Orderspace::Structs.from(JSON.parse(response.body)['customer'], Customer)
+      end
+
+      ##
+      # Allows to edit the customer and change it's attributes
+      # @param customer [Orderspace::Structs::Customer] the customer to be edited (note it must have it's id)
+      def edit_customer(customer)
+        response = client.put("customers/#{customer.id}", { customer: Orderspace::Structs.hashify(customer) })
+
+        Orderspace::Structs.from(JSON.parse(response.body)['customer'], Customer)
+      end
+    end
+  end
+end

data/lib/orderspace/endpoint/endpoint.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Orderspace
+  ##
+  # Defines the parent class for the endpoints
+  class Endpoint
+    attr_reader :client
+
+    ##
+    # Endpoints are initialized by passing the client
+    # @param client [Orderspace::Client] the Orderspace client that interacts with the Orderspace API
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/orderspace/endpoint/oauth.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Orderspace
+  class Endpoint
+
+    ##
+    # Contains the methods to interact with the oauth endpoint.
+    # @see https://apidocs.orderspace.com/#authentication
+    module Oauth
+
+      include Orderspace::Structs
+
+      ##
+      # Fetches the orderspace access token to interact with the Orderspace API
+      # @param client_id [String] the client id as defined when the app was registered
+      # @param client_secret [String] the client secret as defined when the app was registered
+      # @return [Orderspace::Structs::OauthCredentials] the Oauth credentials containing the access token.
+      def obtain_access_token(client_id, client_secret)
+        response = client.request(:post, 'https://identity.orderspace.com/oauth/token',
+                                  { client_id:, client_secret:, grant_type: 'client_credentials' })
+
+        Orderspace::Structs.from(JSON.parse(response.body), OauthCredentials)
+      end
+    end
+  end
+end

data/lib/orderspace/endpoint/orders.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orderspace
+  class Endpoint
+
+    ##
+    # Contains the methods to interact with the orders endpoint.
+    # @see https://apidocs.orderspace.com/#orders
+    module Orders
+      include Orderspace::Structs
+
+      ##
+      # Lists all the orders.
+      #
+      # You can pass in options like so:
+      #
+      # { query: { limit: 20 } }
+      #
+      # Check tho orderspace API documentation to know all the options available.
+      #
+      # @see https://apidocs.orderspace.com/#list-orders
+      #
+      # @return order_list [Orderspace::Structs::OrderList] a list of orders
+      def list_orders(options = {})
+        response = client.get('orders', options)
+        Orderspace::Structs.from(JSON.parse(response.body), OrderList)
+      end
+
+      ##
+      # Returns an order recognised by its id
+      # @param order_id [String] the id of the order we want to get
+      # @return order [Orderspace::Structs::Order] the order found
+      def get_order(order_id)
+        response = client.get("orders/#{order_id}")
+
+        Orderspace::Structs.from(JSON.parse(response.body)['order'], Order)
+      end
+    end
+  end
+end

data/lib/orderspace/endpoint/webhooks.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Orderspace
+  class Endpoint
+    ##
+    # Contains the methods to interact with the webhooks endpoint.
+    # @see https://apidocs.orderspace.com/#webhooks
+    module Webhooks
+      include Orderspace::Structs
+
+      ##
+      # Creates a new webhook
+      # @see https://apidocs.orderspace.com/#create-a-webhook
+      # @param webhook [Orderspace::Structs::Webhook]
+      # @return webhook [Orderspace::Structs::Webhook] the webhook with it's id
+      def create(webhook)
+        response = client.post('webhooks', { webhook: Orderspace::Structs.hashify(webhook) })
+        parse_webhook response
+      end
+
+      ##
+      # Lists all the webhooks you've registered
+      # @see https://apidocs.orderspace.com/#list-webhooks
+      # @return webhook_list [Orderspace::Struct::WebhookList]
+      def list_webhooks
+        response = client.get('webhooks')
+        Orderspace::Structs.from(JSON.parse(response.body), WebhookList)
+      end
+
+      ##
+      # Gets a webhook by it's id
+      # @param id [String] the id of the webhook
+      # @return webhook [Orderspace::Structs::Webhook] the webhook we were looking for
+      def get_webhook(id)
+        parse_webhook client.get("webhooks/#{id}")
+      end
+
+      ##
+      # Updates the current webhook
+      # @param webhook [Orderspace::Structs::Webhook] the webhook we want to update
+      # @return webhook [Orderspace::Structs::Webhook] the updated webhook
+      def update_webhook(webhook)
+        parse_webhook client.put("webhooks/#{webhook.id}")
+      end
+
+      ##
+      # Deletes the webhook
+      # @param webhook [Orderspace::Structs::Webhook] the webhook we want to delete
+      # @return webhook [Orderspace::Structs::Webhook] the deleted webhook (containing only the id and deleted (boolean))
+      def delete_webhook(webhook)
+        parse_webhook client.delete("webhooks/#{webhook.id}")
+      end
+
+      private
+      def parse_webhook(response)
+        Orderspace::Structs.from(JSON.parse(response.body)['webhook'], Webhook)
+      end
+    end
+  end
+end

data/lib/orderspace/endpoints.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'endpoint/endpoint'
+require_relative 'endpoint/customers'
+require_relative 'endpoint/orders'
+require_relative 'endpoint/oauth'
+require_relative 'endpoint/webhooks'

data/lib/orderspace/error.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Orderspace
+  ##
+  # Basic Error
+  class Error < StandardError
+  end
+
+  ##
+  # For when a validation fails
+  class ValidationFailedError < Error
+  end
+
+  ##
+  # Basic Error representing the possible errors that can happen during our communication with the API.
+  class RequestError < Error
+    attr_reader :response, :message
+
+    def initialize(response)
+      @response = response
+      super(message_from(response))
+    end
+
+    private
+
+    def message_from(response)
+      if contains_json?(response)
+        @message = response['message']
+      else
+        "#{response.response.code} #{response.response.message}"
+      end
+    end
+
+    def contains_json?(response)
+      content_type = response.headers['Content-Type']
+      content_type&.start_with?('application/json')
+    end
+  end
+
+  ##
+  # Generic (HTTP Status 400) error
+  class BadRequestError < RequestError
+  end
+
+  ##
+  # HTTP status 401 Error
+  class AuthorizationFailedError < RequestError
+
+    private
+
+    def message_from(response)
+      response.headers['www-authenticate'].to_s.split(/error_description=/, -1).last.delete('"')
+    end
+  end
+
+  ##
+  # HTTP status 404 Error
+  class NotFoundError < RequestError
+  end
+
+  ##
+  # HTTP status 422 Error
+  class UnprocessableEntityError < RequestError
+  end
+
+  ##
+  # HTTP status 429 error
+  class TooManyRequestsError < RequestError
+  end
+
+  ##
+  # Generic (HTTP Status 500) Error
+  class InternalServerError < RequestError
+  end
+end

data/lib/orderspace/struct/address.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Orderspace
+
+  # mandatory: company name, contact name, line1, postcode country
+  #
+  module Structs
+    Address = Struct.new(:company_name, :contact_name, :line1, :line2, :city, :postal_code, :state, :country)
+  end
+end

data/lib/orderspace/struct/buyer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Orderspace
+  module Structs
+    Buyer = Struct.new(:name, :email_address)
+  end
+end

data/lib/orderspace/struct/customer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Orderspace
+  # mandatory company_name, login_email? contact_name, address (company name, contact name, line1, postcode country)
+  module Structs
+    Customer = Struct.new(:id, :company_name, :created_at, :status, :reference, :buyers, :phone, :email_addresses,
+                          :tax_number, :tax_rate_id, :addresses, :minimum_spend, :payment_terms_id,
+                          :customer_group_id, :price_list_id)
+
+    CustomerList = Struct.new(:customers, :has_more)
+
+    class CustomerValidator
+      def self.validate(customer)
+        return unless customer.company_name.nil?
+
+        raise ValidationFailedError, 'Validation failed: Company name cannot be blank'
+      end
+    end
+  end
+end

data/lib/orderspace/struct/event.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Orderspace
+  module Structs
+    Event = Struct.new(:event, :data)
+  end
+end

data/lib/orderspace/struct/oauth_credentials.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Orderspace
+  module Structs
+
+    OauthCredentials = Struct.new(:access_token, :token_type, :expires_in, :scope)
+  end
+end

data/lib/orderspace/struct/order.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Orderspace
+  module Structs
+    Order = Struct.new(:id, :number, :created, :status, :customer_id, :company_name, :phone, :email_addresses,
+                       :delivery_date, :reference, :internal_note, :customer_po_number, :customer_note,
+                       :standing_order_id, :shipping_type, :shipping_address, :billing_address, :order_lines,
+                       :currency, :net_total, :gross_total)
+    OrderLine = Struct.new(:id, :sku, :name, :options, :grouping_category, :shipping, :quantity, :unit_price,
+                           :sub_total, :tax_name, :tax_rate, :tax_amount, :on_hold, :invoiced, :paid, :dispatched)
+    OrderList = Struct.new(:orders, :has_more)
+  end
+end

data/lib/orderspace/struct/webhook.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Orderspace
+  module Structs
+    Webhook = Struct.new(:id, :endpoint, :events, :signing_key, :deleted)
+
+    WebhookList = Struct.new(:webhooks)
+  end
+end

data/lib/orderspace/structs.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Orderspace
+  ##
+  # The structs module scopes the structs returned and sent to the Orderspace API
+  module Structs
+    ##
+    # Converts (if possible) a json payload into the desired struct
+    # @param json [object] a json object
+    # @param struct [Struct] the desired struct
+    # @return [Struct] the fully initialized struct
+    def self.from(json, struct)
+      if json.is_a? Array
+        json.collect {|element| assign_values_to_struct(element, struct)}
+      else
+        assign_values_to_struct(json, struct)
+      end
+    end
+
+    ##
+    # Converts a struct into a hash
+    # @param struct [Struct] the struct we want to convert
+    # @return [Hash] the hash representation of the struct
+    def self.hashify(struct)
+      hash_dump(struct)
+    end
+
+    ##
+    # Used to make sure the struct is valid before it's posted to the server
+    # @param struct [Struct] the struct we want to validate
+    # @raise [ValidationFailedError] with the error message
+    def self.validate(struct)
+      validator = eval(struct.class.to_s + 'Validator')
+      validator.validate(struct)
+    end
+
+    private
+
+    def self.assign_values_to_struct(json, struct)
+      struct.new.tap do |new_object|
+        json.each do |key, value|
+          method_name = "#{key}="
+          if value.is_a? Array
+            begin
+              build_structs(key, method_name, new_object, value)
+            rescue
+              new_object.send(method_name.to_sym, value)
+            end
+          elsif address?(key)
+            new_object.send(method_name.to_sym, Orderspace::Structs.from(value, Orderspace::Structs::Address))
+          elsif data?(key)
+            event_struct = assign_values_to_struct(value[value.keys.first], eval_to_struct(value.keys.first.capitalize))
+            new_object.send(method_name.to_sym, event_struct)
+          elsif new_object.respond_to? method_name
+            new_object.send(method_name.to_sym, value)
+          end
+        end
+      end
+    end
+
+    def self.address?(key)
+      key.eql?('shipping_address') || key.eql?('billing_address')
+    end
+
+    def self.data?(key)
+      key.eql? 'data'
+    end
+
+    def self.hash_dump(struct)
+      hash = {}
+
+      struct.members.collect do |member|
+        value = extract_value_from(struct, member)
+        hash[member.to_sym] = value unless value.nil?
+      end
+      hash
+    end
+
+    def self.build_structs(key, method_name, new_object, value)
+      clazz = infer_class(key)
+      return unless new_object.respond_to? method_name
+
+      new_object.send(method_name.to_sym, value.map do |data|
+        Orderspace::Structs.from(data, eval_to_struct(clazz))
+      end)
+    end
+
+    def self.eval_to_struct(clazz)
+      class_eval("Orderspace::Structs::#{clazz}", __FILE__, __LINE__)
+    end
+
+    def self.infer_class(key)
+      if key.include? '_'
+        clazz = key.chomp('s').split('_').map{|e| e.capitalize}.join
+      elsif key.end_with?('es')
+        clazz = key.capitalize.chomp('es')
+      elsif key.end_with?('s')
+        clazz = key.capitalize.chomp('s')
+      end
+      clazz
+    end
+
+    def self.extract_value_from(struct, member)
+      if struct.send(member.to_sym).is_a? Array
+        begin
+          struct.send(member.to_sym).map { |member| hash_dump(member) }
+        rescue
+          struct.send(member.to_sym)
+        end
+      else
+        struct.send(member.to_sym)
+      end
+    end
+  end
+end
+
+require_relative 'struct/address'
+require_relative 'struct/buyer'
+require_relative 'struct/customer'
+require_relative 'struct/event'
+require_relative 'struct/oauth_credentials'
+require_relative 'struct/order'
+require_relative 'struct/webhook'

data/lib/orderspace/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Orderspace
+  ##
+  # The current version of this gem
+  VERSION = '0.1.0'
+end

data/lib/orderspace.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+##
+# This module represents the overarching scope of the gem
+#
+module Orderspace
+end
+
+require 'orderspace/version'
+require 'orderspace/default'
+require 'orderspace/error'
+
+require 'orderspace/structs'
+require 'orderspace/endpoints'
+require 'orderspace/client'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: orderspace-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Enrique Comba Riepenhausen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description: The orderspace ruby client allows you to connect to orderspace using
+  Ruby
+email:
+- enrique@beanmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- beanmind.svg
+- lib/orderspace.rb
+- lib/orderspace/client.rb
+- lib/orderspace/default.rb
+- lib/orderspace/endpoint/customers.rb
+- lib/orderspace/endpoint/endpoint.rb
+- lib/orderspace/endpoint/oauth.rb
+- lib/orderspace/endpoint/orders.rb
+- lib/orderspace/endpoint/webhooks.rb
+- lib/orderspace/endpoints.rb
+- lib/orderspace/error.rb
+- lib/orderspace/struct/address.rb
+- lib/orderspace/struct/buyer.rb
+- lib/orderspace/struct/customer.rb
+- lib/orderspace/struct/event.rb
+- lib/orderspace/struct/oauth_credentials.rb
+- lib/orderspace/struct/order.rb
+- lib/orderspace/struct/webhook.rb
+- lib/orderspace/structs.rb
+- lib/orderspace/version.rb
+- orderspace-logo.png
+homepage: https://github.com/bean-mind/orderspace-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bean-mind/orderspace-ruby
+  source_code_uri: https://github.com/bean-mind/orderspace-ruby
+  changelog_uri: https://github.com/bean-mind/orderspace-ruby/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Connect to your Orderspace API with ruby
+test_files: []