shift_commerce-oms_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c22d8bbfb4d12a2e03b19a50a8db61c9fae98f46e3676c155d5f0fa1fd3bd788
+  data.tar.gz: f8608af40ebec634cfa24b11bae49dd0a37bf594f3ffd448b995d146914b6afd
+SHA512:
+  metadata.gz: 6b8131bce04e95e5bebbe7357787904f36dec799d78c56254c1b7752411966f48eff976dbb482906de5baeaf5d2b4c1e05c738375fe15de5bce49bab72b38309
+  data.tar.gz: 6197216f60aec50734d890ce1e2489e546b169ee8bc4daeef078088d10f1b009aa8c57fae7ac83f25eefd840d630f0e087855307518fcb06877608feb4c28665

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shift_commerce-oms_api_client.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    shift_commerce-oms_api_client (1.0.0)
+      json-schema (~> 2.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.4.4)
+    json-schema (2.8.1)
+      addressable (>= 2.4)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  shift_commerce-oms_api_client!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,36 @@
+# ShiftCommerce::OmsApiClient
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shift_commerce/oms_api_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shift_commerce-oms_api_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install shift_commerce-oms_api_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, 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/paulspringett/shift_commerce-oms_api_client.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TASK.md

@@ -0,0 +1,115 @@
+## Tasks
+
+4. Convert the fulfillments and cancellations into valid payloads and submit them to the Shift OMS.
+
+   The Shift OMS provides two endpoints, one for fulfilling an order and another for cancelling. As a convenience, we've provided an Ruby API client to do this.
+
+### Setup
+
+Add the gem to your Gemfile:
+
+```ruby
+# Gemfile
+
+gem "shift_commerce-oms-api-client"
+```
+
+Install:
+
+```
+bundle install
+```
+
+### Recording fulfillments
+
+Create a new client:
+
+```ruby
+client = ShiftCommerce::OmsApiClient.new
+```
+
+Record the fulfillment:
+
+```ruby
+response = client.record_fulfillment(valid_payload)
+response.status_code
+# => 201
+response.data
+# => {success: true}
+
+response = client.record_fulfillment(invalid_payload)
+response.status_code
+# => 422
+response.data
+# => {success: false, error: "The property '#/data/attributes' did not contain a required property of 'account_reference'"}
+```
+
+The following is an example of a valid payload:
+
+```json
+// Example fulfillment payload
+
+{
+  "data": {
+    "type": "record_fulfillment",
+    "attributes": {
+      "account_reference": "acme",
+      "order_reference": "500324412",
+      "shipments": [
+        {
+          "line_items": [
+            {
+              "sku": "MG60-D15-81400-small",
+              "quantity": 1
+            }
+          ],
+          "tracking_codes": [
+            {
+              "url": "https://somecourier.com/?tracking_code=examplecode8279278"
+            }
+          ],
+          "shipped_at": "2020-01-08T12:01:01Z"
+        }
+      ]
+    }
+  }
+}
+```
+
+### Cancelling orders
+
+Create a new client:
+
+```ruby
+client = ShiftCommerce::OmsApiClient.new
+```
+
+Record the fulfillment:
+
+```ruby
+response = client.cancel_order(valid_payload)
+response.status_code
+# => 201
+response.data
+# => {success: true}
+
+response = client.cancel_order(invalid_payload)
+response.status_code
+# => 422
+response.data
+# => {success: false, error: "The property '#/data/attributes' did not contain a required property of 'account_reference'"}
+```
+
+```json
+// Example cancellation payload
+
+{
+  "data": {
+    "type": "cancel_order",
+    "attributes": {
+      "account_reference": "acme",
+      "order_reference": "500324412"
+    }
+  }
+}
+```

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shift_commerce/oms_api_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shift_commerce/oms_api_client.rb

@@ -0,0 +1,35 @@
+require "shift_commerce/oms_api_client/version"
+
+require "json"
+require "json-schema"
+
+module ShiftCommerce
+  Response = Struct.new(:status_code, :data)
+  class OmsApiClient
+    def record_fulfillment(payload)
+      JSON::Validator.validate!(record_fulfillment_schema, payload)
+      Response.new(201, {success: true})
+    rescue JSON::Schema::ValidationError => ex
+      Response.new(422, {success: false, error: ex.message})
+    end
+
+    def cancel_order(payload)
+      JSON::Validator.validate!(cancel_order_schema, payload)
+      Response.new(201, {success: true})
+    rescue JSON::Schema::ValidationError => ex
+      Response.new(422, {success: false, error: ex.message})
+    end
+
+    private
+
+    def record_fulfillment_schema
+      @record_fulfillment_schema ||=
+        JSON.parse(File.read("schemas/record_fulfillment.json"))
+    end
+
+    def cancel_order_schema
+      @cancel_order_schema ||=
+        JSON.parse(File.read("schemas/cancel_order.json"))
+    end
+  end
+end

data/lib/shift_commerce/oms_api_client/version.rb

@@ -0,0 +1,5 @@
+module ShiftCommerce
+  class OmsApiClient
+    VERSION = "1.0.0"
+  end
+end

data/schemas/cancel_order.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "required": [
+    "data"
+  ],
+  "properties": {
+    "data": {
+      "type": "object",
+      "required": [
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "type": {
+          "const": "cancel_order"
+        },
+        "attributes": {
+          "type": "object",
+          "required": [
+            "account_reference",
+            "order_reference"
+          ],
+          "properties": {
+            "account_reference": {
+              "type": "string"
+            },
+            "order_reference": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

data/schemas/record_fulfillment.json

@@ -0,0 +1,105 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema",
+  "type": "object",
+  "required": [
+    "data"
+  ],
+  "properties": {
+    "data": {
+      "type": "object",
+      "required": [
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "type": {
+          "const": "record_fulfillment"
+        },
+        "attributes": {
+          "type": "object",
+          "required": [
+            "account_reference",
+            "order_reference",
+            "shipments"
+          ],
+          "properties": {
+            "account_reference": {
+              "type": "string"
+            },
+            "order_reference": {
+              "type": "string"
+            },
+            "shipments": {
+              "type": "array",
+              "additionalItems": true,
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "required": [
+                      "line_items",
+                      "shipped_at"
+                    ],
+                    "properties": {
+                      "line_items": {
+                        "type": "array",
+                        "additionalItems": true,
+                        "items": {
+                          "anyOf": [
+                            {
+                              "type": "object",
+                              "required": [
+                                "sku",
+                                "quantity"
+                              ],
+                              "properties": {
+                                "sku": {
+                                  "type": "string"
+                                },
+                                "quantity": {
+                                  "type": "integer"
+                                }
+                              },
+                              "additionalProperties": false
+                            }
+                          ]
+                        }
+                      },
+                      "tracking_codes": {
+                        "type": "array",
+                        "additionalItems": true,
+                        "items": {
+                          "anyOf": [
+                            {
+                              "type": "object",
+                              "required": [
+                                "url"
+                              ],
+                              "properties": {
+                                "url": {
+                                  "type": "string"
+                                }
+                              },
+                              "additionalProperties": false
+                            }
+                          ]
+                        }
+                      },
+                      "shipped_at": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
+                  }
+                ]
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

data/shift_commerce-oms_api_client.gemspec

@@ -0,0 +1,22 @@
+require_relative "lib/shift_commerce/oms_api_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "shift_commerce-oms_api_client"
+  spec.version = ShiftCommerce::OmsApiClient::VERSION
+  spec.authors = ["Paul Springett"]
+  spec.email = ["paul.springett@shiftcommerce.com"]
+
+  spec.summary = "Dummy API client for the SHIFT Commerce Ruby Exercise"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "json-schema", "~> 2.8"
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: shift_commerce-oms_api_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Springett
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+description:
+email:
+- paul.springett@shiftcommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- TASK.md
+- bin/console
+- bin/setup
+- lib/shift_commerce/oms_api_client.rb
+- lib/shift_commerce/oms_api_client/version.rb
+- schemas/cancel_order.json
+- schemas/record_fulfillment.json
+- shift_commerce-oms_api_client.gemspec
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Dummy API client for the SHIFT Commerce Ruby Exercise
+test_files: []