newgistics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a4bcf5101a15db9de29e852df07c6561d08858ae
+  data.tar.gz: 7f608f2476a8d3cf2bd9ee34122cfb5ea1c1f757
+SHA512:
+  metadata.gz: e7b56a167e8451fdf7c0cb5b5a631f8c62d485fc83c9036e07826c9d8a411531db8f80ff43db72ed4aeba07357ce0cf58c34b511467ee5e3b74530a8e1ea7556
+  data.tar.gz: df095043057ee1c87513bd1e14e15604ef04f8553356beb1035b3a0e46e858c4c9626f2b234540000add8cafbceb17c9b2ceb005b22fad4f9bbfb726c9ca3455

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+engines:
+  rubocop:
+    enabled: true
+    checks:
+      Rubocop/Style/Documentation:
+        enabled: false
+      Rubocop/Style/FrozenStringLiteralComment:
+        enabled: false
+      Rubocop/Style/StringLiterals:
+        enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby:
+          mass_threshold: 20
+ratings:
+  paths:
+  - app/**
+  - lib/**
+  - "**.rb"
+  - "**.go"
+exclude_paths:
+- spec/**/*
+- "**/vendor/**/*"

data/.env.sample

@@ -0,0 +1,2 @@
+NEWGISTICS_API_KEY=YourApiKey
+NEWGISTICS_API_URL=YourApiUrl

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter '/spec/'
+  add_group "Libraries", "lib"
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

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 vmmf08@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.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Manuel Martinez
+
+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,187 @@
+[![Code Climate](https://codeclimate.com/repos/5991e52637216b02640002d4/badges/9e19d346f6da0db0783c/gpa.svg)](https://codeclimate.com/repos/5991e52637216b02640002d4/feed)
+[![Test Coverage](https://codeclimate.com/repos/5991e52637216b02640002d4/badges/9e19d346f6da0db0783c/coverage.svg)](https://codeclimate.com/repos/5991e52637216b02640002d4/coverage)
+[ ![Codeship Status for rocketsofawesome/newgistics-ruby](https://app.codeship.com/projects/63cb9a70-68b6-0135-a28b-5ec5668067cc/status?branch=master)](https://app.codeship.com/projects/241459)
+# Newgistics
+
+This Ruby gem allows you to interact with the Newgistics Fulfillment API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'newgistics', github: 'rocketsofawesome/newgistics-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+## Configuration
+Here is a list of the available configuration options and their default values
+
+| Option          | Description                                                                                                                                                                                                                                                | Default Value                                |
+|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
+| `api_base_url`        | The URL of the Newgistics API                                                                                                                                                                                                                              | `"https://apistaging.newgisticsfulfillment.com"` |
+| `api_key`         | Your Newgistics API key                                                                                                                                                                                                                                    | `nil`                                          |
+| `time_zone`       | The time zone used by Newgistics. When the API sends timestamps back it doesn't include a time zone, if it's not provided, the value of this setting will be used when parsing the timestamps into `Time` objects. You shouldn't need to change this setting | `"America/Denver"`                               |
+| `local_time_zone` | The time zone used by your application, all Newgistics timestamps will be translated to this time zone automatically.                                                                                                                                      | `"UTC"`                                         |
+
+### Setting your configuration
+
+To set configuration options use the `Newgistics.configure` method:
+
+```ruby
+Newgistics.configure do |config|
+  config.api_key = ENV['NEWGISTICS_API_KEY']
+  config.api_base_url = ENV['NEWGISTIC_API_URL']
+  config.local_time_zone = "America/New_York"
+end
+```
+
+When setting `time_zone` or `local_time_zone` pass a `String` with [the name of your time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
+
+If you're using this gem in a Rails app, you'll probably want to put this config in an initializer.
+
+## Resources
+
+### Orders
+
+#### Placing an order on Newgistics
+
+```ruby
+order = Newgistics::Order.new(order_attributes)
+order.save
+```
+
+`order_attributes` is a `Hash` containing all the attributes for the order, the attributes should map one-to-one to the Newgistics API spec.
+
+`order.save` will return `true` if the order is placed successfully and `false` otherwise, any errors or warnings generated when placing the order are available under `order.errors` and `order.warnings` respectively
+
+#### Updating a shipment's/order's contents on Newgistics
+```ruby
+shipment_update = Newgistics::ShipmentUpdate.new(id: SHIPMENT_ID)
+shipment_update.add_items = [Newgistics::Item]
+shipment_update.remove_items = [Newgistics::Item]
+shipment_update.save
+```
+
+`add_items` and `remove_items` are arrays of `Newgistics::Item` that only require a `sku` and a `qty`. With these arrays we will update Newgistics what items to add and/or remove on the specified shipment_update object by either the shipment id(`id`) or you can use the internal order id(`order_id`) but BEWARE: use one or the other not both.
+
+`shipment_update.save` will return `true` if the order is updated successfully and `false` otherwise, any errors or warnings generated when updating the shipment are available under `shipment_update.errors` and `shipment_update.warnings` respectively. `shipment_update.success` or also `shipment_update.success?` will also be updated to the corresponding value.
+
+#### Cancelling a shipment/order on Newgistics
+```ruby
+shipment_cancellation = Newgistics::ShipmentCancellation.new(shipment_id: SHIPMENT_ID)
+shipment_cancellation.save
+```
+
+You must either give a `shipment_id` or `order_id` when cancelling a shipment in order for Newgistics to find the appropriate shipment. There are also optional parameters of `cancel_if_in_process` and `cancel_if_backorder` which are boolean values and covered in the Newgistics API documentation.
+
+`shipment_cancellation.save` will return `true` if the order is cancelled successfully and `false` otherwise, any errors or warnings generated when cancelling the shipment are available under `shipment_cancellation.errors` and `shipment_cancellation.warnings` respectively. `shipment_cancellation.success` or also `shipment_cancellation.success?` will also be updated to the corresponding value.
+
+### Shipments
+
+#### Searching for shipments on Newgistics
+
+```ruby
+Newgistics::Shipment.
+  where(start_received_timestamp: start_date).
+  where(end_received_timestamp: end_date).
+  all
+```
+
+`start_date` and `end_date` are `Date` types in ISO 8601 format. Please note that when using timestamps the Newgistics API expects that you send both the `start_` timestamp and the `end_` timestamp. This means you cannot send `start_received_timestamp` without sending `end_received_timestamp` the same goes for `shipped_timestamp` and `exception_timestamp`.
+
+You can use the `where` method to specify the parameters of the Search. Parameter keys will be automatically camelized when sent to Newgistics, for a full list of the available parameters refer to the Newgistics API documentation.
+
+`Newgistics::Shipment.where(conditions).all` will return a list of `Newgistics::Shipment` elements if the request is successful. Otherwise it will raise a `Newgistics::QueryError`.
+
+### Inbound Returns
+
+#### Sending inbound returns to Newgistics
+```ruby
+Newgistics::InboundReturn.new(inbound_return_attributes).save
+```
+
+`inbound_return_attributes` is a `Hash` containing all the attributes for the inbound return, the attributes should map one-to-one to the Newgistics API spec. *Caveat*: you should only supply either `shipment_id` or `order_id` but not both because you will receive an error from the API.
+
+`inbound_return.save` will return `true` if the inbound return is sent successfully to Newgistics and `false` otherwise, any errors or warnings generated when sending the inbound_return are available under `inbound_return.errors` and `inbound_return.warnings` respectively
+
+#### Searching for inbound returns on Newgistics
+
+```ruby
+Newgistics::InboundReturn.
+  where(start_created_timestamp: start_date).
+  where(end_created_timestamp: end_date).
+  all
+```
+
+You can use the `where` method to specify the parameters of the Search. Parameter keys will be automatically camelized when sent to Newgistics, for a full list of the available parameters refer to the Newgistics API documentation.
+
+`Newgistics::InboundReturn.where(conditions).all` will return a list of `Newgistics::InboundReturn` elements if the request is successful. Otherwise it will raise a `Newgistics::QueryError`.
+
+### Returns
+
+#### Searching for returns received by Newgistics
+```ruby
+Newgistics::Return.
+  where(start_timestamp: start_date).
+  where(end_timestamp: end_date).
+  all
+```
+
+`start_date` and `end_date` are Date types in ISO 8601 format. Please note that when using timestamps the Newgistics API expects that you send both the `start_timestamp` and the `end_timestamp.` This means you cannot send `start_timestamp` without sending `end_timestamp`.
+
+You can use the where method to specify the parameters of the Search. Parameter keys will be automatically camelized when sent to Newgistics, for a full list of the available parameters refer to the Newgistics API documentation.
+
+`Newgistics::Return.where(conditions).all` will return a list of `Newgistics::Return` elements if the request is successful. Otherwise it will raise a `Newgistics::QueryError`.
+
+### Products
+
+#### Retrieving products from Newgistics
+```ruby
+products = Newgistics::Product.all
+products = Newgistics::Product.
+  where(sku: sku).
+  where(warehouse: warehouse_id).
+  all
+```
+`sku` is a product's sku and `warehouse` is the warehouse's id number, where both of these values are strings. Parameter keys will be automatically camelized when sent to Newgistics, for a full list of the available parameters refer to the Newgistics API documentation.
+
+However, parameters are not necessary for this endpoint and you will receive the complete inventory of products if you give it no parameters, so this allows you to just use the `all` method to retrieve the entire inventory.
+
+`Newgistics::Product.all` will return a list of `Newgistics::Product` elements if the request is successful. Otherwise it will raise a `Newgistics::QueryError`.
+
+### Inventory
+
+#### Retrieve inventory details from Newgistics
+
+```ruby
+Newgistics::Inventory.
+  where(start_timestamp: start_date, end_timestamp: end_date).
+  all
+```
+`start_date` and `end_date` are Date types in ISO8601 format.
+
+You can use the `where` method to specify the parameters for the Search. Parameter keys will be automatically camelized when sent to
+Newgistics, for a full list of the available parameters refer to the Newgistics API documentation.
+
+## 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/rocketsofawesome/newgistics-ruby. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Newgistics project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/newgistics/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,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "newgistics"
+require "irb"
+require "pry"
+require "dotenv"
+
+Dotenv.load
+
+Newgistics.configure do |config|
+  config.api_base_url = ENV.fetch('NEWGISTICS_API_URL', "https://apistaging.newgisticsfulfillment.com")
+  config.api_key = ENV['NEWGISTICS_API_KEY']
+end
+
+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.rb

@@ -0,0 +1,68 @@
+require "virtus"
+require "nokogiri"
+require "faraday"
+require "tzinfo"
+
+require "newgistics/api"
+require "newgistics/default_logger"
+require "newgistics/configuration"
+require "newgistics/time_zone"
+require "newgistics/timestamp"
+require "newgistics/customer"
+require "newgistics/item"
+require "newgistics/order"
+require "newgistics/product"
+require "newgistics/return"
+require "newgistics/inbound_return"
+require "newgistics/inventory"
+require "newgistics/query"
+require "newgistics/errors"
+require "newgistics/string_helper"
+require "newgistics/shipment_cancellation"
+require "newgistics/shipment_update"
+require "newgistics/warehouse"
+require "newgistics/requests/cancel_shipment"
+require "newgistics/requests/post_shipment"
+require "newgistics/requests/post_inbound_return"
+require "newgistics/requests/search"
+require "newgistics/requests/update_shipment_contents"
+require "newgistics/response_handlers/cancel_shipment"
+require "newgistics/response_handlers/post_shipment"
+require "newgistics/response_handlers/post_inbound_return"
+require "newgistics/response_handlers/post_errors"
+require "newgistics/response_handlers/search"
+require "newgistics/response_handlers/update_shipment_contents"
+require "newgistics/fee"
+require "newgistics/shipment"
+require "newgistics/version"
+require "newgistics/xml_marshaller"
+
+module Newgistics
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.api
+    @api ||= Api.new
+  end
+
+  def self.logger
+    @logger ||= DefaultLogger.build
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.time_zone
+    configuration.time_zone
+  end
+
+  def self.local_time_zone
+    configuration.local_time_zone
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end