newgistics-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: adeb0dca14b7fd3f05d97e0f2d133e3248efab60
+  data.tar.gz: 1ac4045861b114bde4f3b225e6c2c2f0444aa0d3
+SHA512:
+  metadata.gz: 099ffce4eb663a88a8ba4fbb5461b201618c8db783476e599eddb0ffc10d502452666e22411081e262eda88edf93d6dcb8245e3c2bd91d93644c9101ff854aa6
+  data.tar.gz: 80997b7e1d7fcbfd4ec690ab1880fbb4d4322036c3d55fc806147e7eaa78872a8a7a797ce0c1d7f63b401be51d55c7cf8c0434213e5e6f96a48cfa1fbee1100b

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+.rspec_status
+spec/api_credentials.yml
+Gemfile.lock
+
+*.gem

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 lorrain.florian@gmail.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in newgistics-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 florrain
+
+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,68 @@
+# Newgistics::Api
+
+A Ruby 2 client for the Newgistics API, free from dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newgistics-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install newgistics-api
+
+## Usage
+
+1. Initialize the GEM:
+```ruby
+NewgisticsApi.configure do |config|
+  config.api_key = api_credentials["api_key"]
+  config.host = api_credentials["host"]
+end
+```
+
+2. Run a request
+Each of the method arguments are passes as keyword arguments. You can find the supported methods in lib/newgistics_api.
+
+For example, the tracking API takes 3 parameters: `def track_shipment(merchant_id: nil, qualifier: nil, search_strings: [])`:
+```ruby
+response = NewgisticsApi::Tracking.new.track_shipment(merchant_id: "123", qualifier: "Barcode", search_strings: [721234567890])
+```
+
+3. Manipulate the response
+```ruby
+response.success?
+
+response.body # raw JSON body
+response.parsed_body # JSON parsed body
+response.decorated_response # decorated response if the class has a decorator
+```
+
+## 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.
+
+If you need to re-run VCR cassettes, `cp spec/api_credentials.yml.sample spec/api_credentials.yml` and update the file with your credentials. VCR is configured to anonymize the API_KEY and the HOST for you.
+
+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/thredup/newgistics-api. 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.
+
+Before pushing your changes, make sure you worked on the test coverage and your test files and VCR cassettes don't contain any credentials or any kind of critical information.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Newgistics::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/thredup/newgistics-api/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 "newgistics/api"
+
+# 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/newgistics_api.rb

@@ -0,0 +1,21 @@
+require "newgistics_api/version"
+require "newgistics_api/configuration"
+
+module NewgisticsApi
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+require "newgistics_api/exceptions/not_found_shipment_error"
+require "newgistics_api/client"
+require "newgistics_api/shipment"
+require "newgistics_api/tracking"

data/lib/newgistics_api/client.rb

@@ -0,0 +1,57 @@
+module NewgisticsApi
+  class Client
+    def make_request(method, path)
+      uri = URI.parse("#{host}#{path}")
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      request = Net::HTTP.const_get(method.to_s.downcase.capitalize).new(uri.request_uri)
+      request.add_field("X-API-Key", api_key)
+      request["Accept"] = "application/json"
+
+      if block_given?
+        block_output = yield
+
+        raise TypeError, "The output of the block must be a Hash" unless block_output.is_a?(Hash)
+
+        request.body = block_output.to_json
+        request["Content-Type"] = "application/json"
+      end
+
+      response = http.request(request)
+
+      Response.new(self.class, response)
+    end
+
+    private
+
+    def host
+      NewgisticsApi.configuration.host
+    end
+
+    def api_key
+      NewgisticsApi.configuration.api_key
+    end
+
+    class Response
+      attr_reader :response, :parsed_body, :decorated_response
+
+      def initialize(class_object, response)
+        @class_object = class_object
+        @response = response
+        @parsed_body = JSON.parse(response.body)
+        @decorated_response = class_object.const_defined?(:Decorator) ? class_object::Decorator.decorate(body) : nil
+      end
+
+      def body
+        @parsed_body
+      end
+
+      def success?
+        response.is_a?(Net::HTTPOK) || response.is_a?(Net::HTTPSuccess)
+      end
+
+    end
+  end
+end

data/lib/newgistics_api/configuration.rb

@@ -0,0 +1,10 @@
+module NewgisticsApi
+  class Configuration
+    attr_accessor :api_key, :host
+
+    def initialize
+      @api_key = nil
+      @host = nil
+    end
+  end
+end

data/lib/newgistics_api/exceptions/not_found_shipment_error.rb

@@ -0,0 +1,6 @@
+module NewgisticsApi
+  module Exceptions
+    class NotFoundShipmentError < StandardError
+    end
+  end
+end

data/lib/newgistics_api/shipment.rb

@@ -0,0 +1,40 @@
+module NewgisticsApi
+  class Shipment < Client
+    def create_shipment(additional_data: nil, consumer: nil, client_service_flag: nil, disposition_rule_set_id: nil, label_count: nil, merchant_id: nil, return_id: nil, show_zpl_link: false)
+      make_request(:post, "/WebAPI/Shipment/") do
+        {
+          "additionalData" => additional_data.map do |name, value|
+            { "Name" => name, "Value" => value }
+          end,
+          "clientServiceFlag" => client_service_flag,
+          "consumer" => {
+            "Address" => {
+              "Address1" => consumer["Address"]["Address1"],
+              "Address2" => consumer["Address"]["Address2"],
+              "Address3" => consumer["Address"]["Address3"],
+              "City" => consumer["Address"]["City"],
+              "CountryCode" => consumer["Address"]["CountryCode"],
+              "Name" => consumer["Address"]["Name"],
+              "State" => consumer["Address"]["State"],
+              "Zip" => consumer["Address"]["Zip"],
+            },
+            "DaytimePhoneNumber" => consumer["Address"]["DaytimePhoneNumber"],
+            "EveningPhoneNumber" => consumer["Address"]["EveningPhoneNumber"],
+            "FaxNumber" => consumer["Address"]["FaxNumber"],
+            "FirstName" => consumer["FirstName"],
+            "Honorific" => consumer["Honorific"],
+            "LastName" => consumer["LastName"],
+            "MiddleInitial" => consumer["MiddleInitial"],
+            "PrimaryEmailAddress" => consumer["PrimaryEmailAddress"],
+          },
+          "deliveryMethod" => "SelfService",
+          "dispositionRuleSetId" => disposition_rule_set_id,
+          "labelCount" => label_count,
+          "merchantID" => merchant_id,
+          "returnId" => return_id,
+          "showZplLink" => show_zpl_link
+        }
+      end
+    end
+  end
+end

data/lib/newgistics_api/tracking.rb

@@ -0,0 +1,95 @@
+module NewgisticsApi
+  class Tracking < Client
+    SERVICE_TYPES = [
+      SERVICE_SHIPMENT = "SHIPMENT", # Outbound
+      SERVICE_RETURN = "RETURN" # Inbound
+    ]
+
+    # Shipment codes
+    SHIPMENT_SHIPPED_CODES = %w(PSC IPS)
+    SHIPMENT_DELIVERED_CODES = %w(DEL)
+
+    # Return codes
+    RETURN_SHIPPED_CODES = %w(PUU UPROC)
+    RETURN_DELIVERED_CODES = %w(DRC)
+
+    SHIPPED_CODES = SHIPMENT_SHIPPED_CODES | RETURN_SHIPPED_CODES
+    DELIVERED_CODES = SHIPMENT_DELIVERED_CODES | RETURN_DELIVERED_CODES
+
+    STATUSES = [
+      STATUS_CREATED = "Created",
+      STATUS_DELIVERED = "Delivered",
+      STATUS_DEPARTED = "Departed",
+      STATUS_EXCEPTION = "Exception",
+      STATUS_IN_TRANSIT = "InTransit",
+      STATUS_IN_USPS_NETWORK = "InUSPSNetwork",
+      STATUS_NOT_FOUND = "NotFound",
+      STATUS_RECEIVED = "Received",
+      STATUS_UNKNOWN = "Unknown"
+    ]
+
+    def track_shipment(merchant_id: nil, qualifier: nil, search_strings: [])
+      make_request(:post, "/WebAPI/Shipment/Tracking") do
+        {
+          "merchantID" => merchant_id,
+          "qualifier" => qualifier,
+          "searchStrings" => search_strings
+        }
+      end
+    end
+
+    class Decorator
+      def self.decorate(response)
+        return {} if (package = (response["Packages"] || [])[0]).nil?
+        return {} if (events = package["PackageTrackingEvents"] || []).empty?
+
+        raise NewgisticsApi::NotFoundTrackingNumberError.new if response["Status"] == STATUS_NOT_FOUND
+
+        # Outbound - packages shipped from the DC
+        # Inbound - packages handed by the customer to the carrier
+        shipped_event = events.find { |event| event && SHIPPED_CODES.include?(event["EventCode"]) }
+        delivered_event = events.find { |event| event && DELIVERED_CODES.include?(event["EventCode"]) }
+
+        {
+          ngst_status: package["Status"],
+          simple_status: determine_simple_status(
+            package,
+            shipped_event,
+            delivered_event
+          ),
+          all_events: events,
+          relevant_events: {
+            shipped: shipped_event ? { timestamp: parse_event_date(shipped_event), details: shipped_event } : nil,
+            delivered: delivered_event ? { timestamp: parse_event_date(delivered_event), details: delivered_event } : nil
+          }
+        }
+      end
+
+      private
+
+      # What interests us is either the package is in states:
+      # - shipped (shipments)
+      # - delivered (shipments and returns)
+      # - inbound (returns)
+      def self.determine_simple_status(package, shipped_event, delivered_event)
+        status = package["Status"]
+        service = package["Service"]
+
+        return "delivered" if delivered_event
+        if shipped_event
+          return "inbound" if service == SERVICE_RETURN
+          return "shipped"
+        end
+        return status if status == STATUS_UNKNOWN
+        return "created" if status == STATUS_CREATED
+      end
+
+      def self.parse_event_date(event)
+        return unless event
+        return if (date = event["Date"]).match(%r(^\/Date\((.*)-)).nil?
+        time = date.match(%r(^\/Date\((.*)-))[1]
+        Time.at(time.to_i / 1000)
+      end
+    end
+  end
+end

data/lib/newgistics_api/version.rb

@@ -0,0 +1,3 @@
+module NewgisticsApi
+  VERSION = "0.0.1"
+end

data/newgistics-api.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "newgistics_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "newgistics-api"
+  spec.version       = NewgisticsApi::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["florrain"]
+  spec.email         = ["florian.lorrain@thredup.com"]
+
+  spec.summary       = %q{Ruby client for the Newgistics API}
+  spec.description   = %q{Ruby client for the Newgistics API}
+  spec.homepage      = "https://github.com/thredup/newgistics-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.required_ruby_version = "~> 2.0"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock", "2.3.2"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: newgistics-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- florrain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: Ruby client for the Newgistics API
+email:
+- florian.lorrain@thredup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/newgistics_api.rb
+- lib/newgistics_api/client.rb
+- lib/newgistics_api/configuration.rb
+- lib/newgistics_api/exceptions/not_found_shipment_error.rb
+- lib/newgistics_api/shipment.rb
+- lib/newgistics_api/tracking.rb
+- lib/newgistics_api/version.rb
+- newgistics-api.gemspec
+homepage: https://github.com/thredup/newgistics-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Newgistics API
+test_files: []