we_ship_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a9ab972e96d49172e5934d5bd6ce9dda80cd309d4c9a12ae969a0b6571e5a0b
+  data.tar.gz: aae67d43ab246cefb44f098211bbb5d5c8700698b824b587112777b73bcc7b72
+SHA512:
+  metadata.gz: 6d9c64d5ba2a473cca8e7852529861a564080bb51146c21cf735ba6b6510bbc5ef58d580d4922994f3dc9e19bfb736753d4402296f696d1106a953f8d278f344
+  data.tar.gz: 66b82e1b2d136a712be2a9c28a17f45d127d856b173075f9272747fad61e6db01040a858c080298460e87e18c3924c8408001a37dc597dc70c4188f693ce0499

data/.env.example

@@ -0,0 +1,7 @@
+WE_SHIP_USERNAME = 'your_username'
+WE_SHIP_PASSWORD = 'your_password'
+WE_SHIP_BASE_URL = 'https://your-api.url/v2'
+WE_SHIP_FORMAT_VERSION = '123'
+WE_SHIP_CUSTOMER_CODE = 'YOURCLIENTCODE'
+WE_SHIP_ALLOW_DUPLICATES = 'Y'
+WE_SHIP_DEFAULT_PRODUCT_TYPE = 'XXX'

data/.github/workflows/gem-push.yml

@@ -0,0 +1,33 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/specs.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Specs
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake spec

data/.gitignore

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

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alessandro@juul.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in we_ship_client.gemspec
+gemspec
+
+gem 'loogi_http', '~> 1.0', path: '../loogi_http'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'dotenv', '~> 2.7'

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: ../loogi_http
+  specs:
+    loogi_http (1.0.0)
+      faraday (~> 1.0.1)
+      faraday-cookie_jar (~> 0.0.6)
+      faraday_middleware (~> 1.0.0)
+
+PATH
+  remote: .
+  specs:
+    we_ship_client (1.0.0)
+      activesupport
+      dry-struct (>= 0.6, < 1.5)
+      dry-types
+      loogi_http (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.9)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
+    dry-configurable (0.14.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-cookie_jar (0.0.7)
+      faraday (>= 0.8.0)
+      http-cookie (~> 1.0.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    minitest (5.15.0)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    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.2)
+      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.3)
+    stub_env (1.0.4)
+      rspec (>= 2.0, < 4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-darwin-21
+
+DEPENDENCIES
+  dotenv (~> 2.7)
+  loogi_http (~> 1.0)!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  stub_env
+  vcr
+  we_ship_client!
+  webmock
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 JUUL Labs
+
+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,111 @@
+# WeShipClient
+
+[![Specs](https://github.com/JuulLabs-OSS/we_ship_client/actions/workflows/specs.yml/badge.svg)](https://github.com/JuulLabs-OSS/we_ship_client/actions/workflows/specs.yml)
+
+This is a Ruby client for the We Ship Express V2 API provided by https://www.weshipexpress.com/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'we_ship_client'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install we_ship_client
+
+
+## Usage
+
+First, set the required environment variables and load them in your app, using your preferred method (dotenv, figaro etc.).
+See `.env.example` for a reference.
+
+### Get Tracking
+
+```ruby
+auth_token = WeShipClient::TokenClient.new.generate_access_token
+
+request = WeShipClient::Entities::TrackRequest.new(
+  customer_code: [ENV['WE_SHIP_CUSTOMER_CODE']],
+  internal_tracking_num: [your_tracking_number]
+)
+
+response = WeShipClient::Interactors::GetTracking.new(
+  auth_token: auth_token,
+  track_request: request
+).call
+```
+
+### Process Orders
+
+```ruby
+auth_token = WeShipClient::TokenClient.new.generate_access_token
+
+orders = [
+  WeShipClient::Entities::Order.new(
+    orderNo: 'ABC123',
+    orderDate: '2021-01-01',
+    shipMethod: '',
+    fulfillmentLocation: 'XXX',
+    shipToAddress: WeShipClient::Entities::Address.new(
+      name: 'Name',
+      address1: 'Address 1'
+      address2: 'Address 2',
+      city: 'New York',
+      state: 'NY',
+      postalCode: '12345',
+      country: 'US',
+      homePhone: '+123456789'
+    ),
+    orderItems: WeShipClient::Entities::OrderItems.new(
+      orderItem: [
+        WeShipClient::Entities::OrderItem.new(
+          productName: 'Item name',
+          productSKU: 'SKU',
+          productType: 'XXX',
+          quantity: 1,
+          weight: '10'
+        )
+      ]
+    )
+  )
+]
+
+request = WeShipClient::Entities::ProcessOrdersRequest.new(
+  clientCode: ENV['WE_SHIP_CUSTOMER_CODE'],
+  order: orders
+)
+
+response = WeShipClient::Interactors::ProcessOrders.new(
+  auth_token: auth_token,
+  process_orders_request: request
+).call
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+To execute tests, run `bundle exec rake spec`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JuulLabs-OSS/we_ship_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JuulLabs-OSS/we_ship_client/blob/master/CODE_OF_CONDUCT.md).
+
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'we_ship_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/we_ship_client/client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'loogi_http'
+require 'loogi_http/connection'
+
+module WeShipClient
+  class Client
+    DEFAULT_TIMEOUT = 90
+
+    attr_reader :http_client, :logger
+
+    # @param http_client [LoogiHttp::Connection]
+    # @param logger [Logger]
+    # @param timeout [Integer,nil] The request timeout
+    def initialize(http_client: LoogiHttp::Connection, logger: LoogiHttp.logger, timeout: nil)
+      timeout ||= DEFAULT_TIMEOUT
+
+      @http_client = http_client.new(
+        Faraday::Connection.new do |connection|
+          connection.request :json
+          connection.adapter Faraday.default_adapter
+          connection.options[:open_timeout] = timeout
+          connection.options[:timeout] = timeout
+        end
+      )
+      @logger = logger
+    end
+
+    def base_url
+      ENV['WE_SHIP_BASE_URL']
+    end
+  end
+end

data/lib/we_ship_client/entities/address.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+
+module WeShipClient
+  module Entities
+    # A shipping/billing address.
+    class Address < Base
+      attribute :name, Types::Strict::String
+      attribute :address1, Types::Strict::String
+      attribute? :address2, Types::Strict::String.optional
+      attribute :city, Types::Strict::String
+      attribute :state, Types::Strict::String
+      attribute :postalCode, Types::Strict::String
+      attribute :country, Types::Strict::String
+      attribute :homePhone, Types::Strict::String
+    end
+  end
+end

data/lib/we_ship_client/entities/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require_relative 'types'
+
+module WeShipClient
+  module Entities
+    class Base < Dry::Struct
+      transform_keys(&:to_sym)
+
+      # This sets dry types to use the default value when nil is passed
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
+    end
+  end
+end

data/lib/we_ship_client/entities/order.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+require 'we_ship_client/entities/address'
+require 'we_ship_client/entities/order_items'
+
+module WeShipClient
+  module Entities
+    # A single order with all the details.
+    class Order < Base
+      attribute :orderNo, Types::Strict::String
+      attribute :orderDate, Types::Strict::String
+      attribute :shipMethod, Types::Strict::String
+      attribute :fulfillmentLocation, Types::Strict::String
+      attribute? :billToAddress, Address.optional
+      attribute :shipToAddress, Address
+      attribute :orderItems, OrderItems
+    end
+  end
+end

data/lib/we_ship_client/entities/order_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+
+module WeShipClient
+  module Entities
+    # A single order item.
+    class OrderItem < Base
+      attribute :productName, Types::Strict::String
+      attribute :productSKU, Types::Strict::String
+      attribute :productType, Types::Strict::String.default(ENV['WE_SHIP_DEFAULT_PRODUCT_TYPE'])
+      attribute :quantity, Types::Strict::Integer
+      attribute :weight, Types::Strict::String
+    end
+  end
+end

data/lib/we_ship_client/entities/order_items.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+require 'we_ship_client/entities/order_item'
+
+module WeShipClient
+  module Entities
+    # Just a container for the order items list.
+    # Note the singular "orderItem" name that may be confusing.
+    class OrderItems < Base
+      attribute :orderItem, Types::Strict::Array.of(OrderItem).constrained(min_size: 1)
+    end
+  end
+end

data/lib/we_ship_client/entities/process_orders_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+require 'we_ship_client/entities/order'
+
+module WeShipClient
+  module Entities
+    # The request payload used by `Interactors::ProcessOrders`.
+    class ProcessOrdersRequest < Base
+      # NOTE: The order of these attributes MUST remain this way
+      # or the API will not properly handle the request and instead
+      # throw: {
+      #  :response=>{
+      #    :invalidrequest=>{
+      #       :description=>"Invalid content was found starting with element 'clientCode'. One of '{order}' is expected.",
+      #       :status=>"Fail"
+      #  }}}
+      attribute :formatVersion, Types::Strict::String.default(ENV['WE_SHIP_FORMAT_VERSION'])
+      attribute :clientCode, Types::Strict::String.default(ENV['WE_SHIP_CUSTOMER_CODE'])
+      attribute :allowDuplicates, Types::Strict::String.default(ENV['WE_SHIP_ALLOW_DUPLICATES'])
+      attribute :order, Types::Strict::Array.of(Order)
+    end
+  end
+end

data/lib/we_ship_client/entities/responses/order_accepted.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+
+module WeShipClient
+  module Entities
+    module Responses
+      # Details of a single accepted order.
+      class OrderAccepted < Base
+        attribute :description, Types::Strict::String
+        attribute :orderId, Types::Strict::String
+        attribute :referenceNo, Types::Strict::String
+        attribute :status, Types::Strict::String
+        attribute :type, Types::Strict::String
+      end
+    end
+  end
+end

data/lib/we_ship_client/entities/responses/order_rejected.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'we_ship_client/entities/base'
+
+module WeShipClient
+  module Entities
+    module Responses
+      # Details of a single rejected order.
+      class OrderRejected < Base
+        attribute :description, Types::Strict::String
+        attribute? :referenceNo, Types::Strict::String.optional
+        attribute :status, Types::Strict::String
+        attribute? :type, Types::Strict::String.optional
+      end
+    end
+  end
+end