after_ship 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43ff39d94f11902c3bfc5a7acfc36fc4092d5c5a
+  data.tar.gz: bab1423202559d88d3341bf209a002a85e9df8d4
+SHA512:
+  metadata.gz: 3aff898828a87d686b144230382a77f21b68f0a324830be48dfe1ba87ef1b919aa97a9e420bd3e23501cefc00e0701637b49f416dcf9a0ebcc194db25a31e686
+  data.tar.gz: ecc0ca8bcd619d082eb59fa7ec8a52f927fd1d1c30c4a007999a57e27fab92c9bbb783f56b3ee4140e66ce43a8e8b14374371ba57e57fd7609175fe73f9df9f2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.rubocop-my.yml

@@ -0,0 +1,2 @@
+Metrics/MethodLength:
+  Max: 12

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop-my.yml

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+rvm:
+  - 2.1.2
+  - 1.9.3
+  - jruby-19mode
+
+branches:
+  only:
+    - master
+
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+
+install: "bundle --jobs 4"
+script: "bundle exec rspec"

data/.yardopts

@@ -0,0 +1,7 @@
+--protected
+--private
+--embed-mixins
+lib/**/*.rb
+-
+README.md
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in after_ship.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Oldrich Vetesnik
+
+MIT License
+
+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,125 @@
+# AfterShip
+
+[![Build Status](https://travis-ci.org/ollie/after_ship.svg?branch=master)](https://travis-ci.org/ollie/after_ship)
+
+A smallish library to talking to AfterShip via v3 API.
+
+You will need an AfterShip API key, see here https://www.aftership.com/docs/api/3.0.
+The JSON is parsed by MultiJson (https://github.com/intridea/multi_json) so
+you may want to drop in your favorite JSON engine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'after_ship', git: 'https://github.com/ollie/after_ship.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Init the client:
+
+```ruby
+client = AfterShip.new(api_key: 'your-aftership-api-key')
+```
+
+Get a list of trackings
+https://www.aftership.com/docs/api/3.0/tracking/get-trackings
+
+```ruby
+client.trackings
+
+# Will return list of Tracking objects:
+
+[
+  #<AfterShip::Tracking ...>,
+  #<AfterShip::Tracking ...>,
+  ...
+]
+```
+
+Get a tracking
+https://www.aftership.com/docs/api/3.0/tracking/get-trackings-slug-tracking_number
+
+```ruby
+client.tracking('tracking-number', 'ups')
+
+# Will return Tracking object or raise AfterShip::ResourceNotFoundError
+# if not exists:
+
+#<AfterShip::Tracking:0x007fe555bd9560
+  @active=false,
+  @courier="UPS",
+  @created_at=#<DateTime: 2014-05-08T15:25:01+00:00 ((2456786j,55501s,0n),+0s,2299161j)>,
+  @updated_at=#<DateTime: 2014-07-18T09:00:47+00:00 ((2456857j,32447s,0n),+0s,2299161j)>>
+  @custom_fields={},
+  @customer_name=nil,
+  @destination_country_iso3="USA",
+  @emails=[],
+  @expected_delivery=nil,
+  @order_id="PL-12480166",
+  @order_id_path=nil,
+  @origin_country_iso3="IND",
+  @shipment_package_count=0,
+  @shipment_type="EXPEDITED",
+  @signed_by="FRONT DOOR",
+  @slug="ups",
+  @smses=[],
+  @source="api",
+  @status="Delivered",
+  @tag="Delivered",
+  @title="1ZA2207X6790326683",
+  @tracked_count=47,
+  @tracking_number="1ZA2207X6790326683",
+  @unique_token="ly9ueXUJC",
+  @checkpoints=[
+    #<AfterShip::Checkpoint:0x007fe555bb0340
+      @checkpoint_time=#<DateTime: 2014-05-12T14:07:00+00:00 ((2456790j,50820s,0n),+0s,2299161j)>,
+      @city="NEW YORK",
+      @country_iso3=nil,
+      @country_name="US",
+      @courier="UPS",
+      @created_at=#<DateTime: 2014-05-12T18:34:32+00:00 ((2456790j,66872s,0n),+0s,2299161j)>,
+      @message="DELIVERED",
+      @slug="ups",
+      @state="NY",
+      @status="Delivered",
+      @tag="Delivered",
+      @zip="10075">
+    #<AfterShip::Checkpoint ...>,
+    ...
+  ]>
+```
+
+Create a new tracking
+https://www.aftership.com/docs/api/3.0/tracking/post-trackings
+
+```ruby
+client.create_tracking('tracking-number', 'ups', order_id: 'external-id')
+
+# Will return Tracking object or raise AfterShip::InvalidArgumentError
+# if it exists:
+
+#<AfterShip::Tracking ...>
+```
+
+Update a tracking
+https://www.aftership.com/docs/api/3.0/tracking/put-trackings-slug-tracking_number
+
+```ruby
+client.update_tracking('tracking-number', 'ups', order_id: 'external-id')
+```
+
+## Contributing
+
+0. E-mail me or create an issue
+1. Fork it (https://github.com/ollie/after_ship/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+task default: :combo
+
+desc 'Run tests, rubocop and generate documentation'
+task :combo do
+  sh 'bundle exec rspec'
+  sh('bundle exec rubocop') {} # ignore status > 0
+  sh 'bundle exec yardoc'
+end
+
+desc 'Same as :combo but build a gem, too'
+task mega_combo: :combo do
+  sh 'gem build after_ship.gemspec'
+end
+
+desc 'Start a console'
+task :console do
+  sh 'bundle exec pry -I ./lib -r ./lib/after_ship.rb'
+end

data/after_ship.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'after_ship/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'after_ship'
+  spec.version       = AfterShip::VERSION
+  spec.authors       = ['Oldrich Vetesnik']
+  spec.email         = ['oldrich.vetesnik@gmail.com']
+  spec.summary       = 'A smallish library to talking to AfterShip via v3 API.'
+  spec.homepage      = 'https://github.com/ollie/after_ship'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  # System
+  spec.add_development_dependency 'bundler', '~> 1.6'
+
+  # Test
+  spec.add_development_dependency 'rspec',     '~> 3.1'
+  spec.add_development_dependency 'webmock',   '~> 1.19'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+
+  # Code style, debugging, docs
+  spec.add_development_dependency 'rubocop', '~> 0.26'
+  spec.add_development_dependency 'pry',     '~> 0.10'
+  spec.add_development_dependency 'yard',    '~> 0.8'
+  spec.add_development_dependency 'rake',    '~> 10.3'
+
+  # Networking
+  # Fast networking
+  spec.add_runtime_dependency 'typhoeus',   '~> 0.6'
+  # A common interface to multiple JSON libraries
+  spec.add_runtime_dependency 'multi_json', '~> 1.10'
+end

data/lib/after_ship/checkpoint.rb

@@ -0,0 +1,140 @@
+class AfterShip
+  # Wrapper object for AfterShip tracking checkpoint:
+  # https://www.aftership.com/docs/api/3.0/tracking/get-trackings-slug-tracking_number
+  class Checkpoint
+    include Attributes
+
+    # Tracking number, e.g. +1ZA2207X6794165804+.
+    #
+    # Should always be available.
+    #
+    # @return [String]
+    attr_reader :slug
+
+    # Location info (if any)
+    #
+    # May be empty.
+    #
+    # @return [String]
+    attr_accessor :city
+
+    # Courier name
+    #
+    # @return [String]
+    attr_accessor :courier
+
+    # Date and time of the tracking created.
+    #
+    # Should always be available.
+    #
+    # @return [DateTime]
+    attr_reader :created_at
+
+    # Country name of the checkpoint, may also contain other location info.
+    # Seems to be Alpha-2 code, e.g. +IN+, +DE+.
+    #
+    # May be empty.
+    #
+    # @return [String]
+    attr_accessor :country_name
+
+    # Country ISO Alpha-3 (three letters) of the checkpoint.
+    #
+    # May be empty.
+    #
+    # @return [String]
+    attr_accessor :country_iso3
+
+    # Checkpoint message
+    #
+    # Should always be available.
+    #
+    # @return [String]
+    attr_accessor :message
+
+    # Status of the checkpoint.
+    #
+    # Should always be available.
+    #
+    # @return [String]
+    attr_reader :tag
+
+    # Same as tag, except human-friendly:
+    #
+    # * +Pending+ => +Pending+
+    # * +InfoReceived+ => +Info Received+
+    # * +InTransit+ => +In Transit+
+    # * +OutForDelivery+ => +Out For Delivery+
+    # * +AttemptFail+ => +Attempt Failed+
+    # * +Delivered+ => +Delivered+
+    # * +Exception+ => +Exception+
+    # * +Expired+ => +Expired+
+    #
+    # @return [String]
+    attr_accessor :status
+
+    # Date and time of the checkpoint, provided by courier.
+    #
+    # Should always be available.
+    #
+    # @return [DateTime]
+    attr_reader :checkpoint_time
+
+    # Location info (if any).
+    #
+    # May be empty.
+    #
+    # @return [String]
+    attr_accessor :state
+
+    # Location info (if any).
+    #
+    # May be empty.
+    #
+    # @return [String]
+    attr_accessor :zip
+
+    # Better interface for a checkpoint.
+    #
+    # @param data [Hash] checkpoint hash
+    def initialize(data)
+      load_attributes(data)
+    end
+
+    # Tracking number, e.g. +1ZA2207X6794165804+.
+    #
+    # Should always be available.
+    #
+    # @return [String]
+    def slug=(value)
+      @slug        = value
+      self.courier = value.upcase
+      @slug
+    end
+
+    # Date and time of the tracking created.
+    #
+    # @return [DateTime]
+    def created_at=(value)
+      @created_at = DateUtils.parse(value)
+    end
+
+    # Status of the checkpoint.
+    #
+    # Should always be available.
+    #
+    # @return [String]
+    def tag=(value)
+      @tag        = value
+      self.status = TAG_STATUS.fetch(value)
+      @tag
+    end
+
+    # Date and time of the checkpoint, provided by courier.
+    #
+    # @return [DateTime]
+    def checkpoint_time=(value)
+      @checkpoint_time = DateUtils.parse(value)
+    end
+  end
+end

data/lib/after_ship/tracking.rb

@@ -0,0 +1,218 @@
+class AfterShip
+  # Wrapper object for AfterShip tracking:
+  # https://www.aftership.com/docs/api/3.0/tracking/get-trackings-slug-tracking_number
+  class Tracking
+    include Attributes
+
+    # Date and time of the tracking created.
+    #
+    # @return [DateTime]
+    attr_reader :created_at
+
+    # Date and time of the tracking last updated.
+    #
+    # @return [DateTime]
+    attr_reader :updated_at
+
+    # Tracking number, e.g. +1ZA2207X6794165804+.
+    #
+    # @return [String]
+    attr_accessor :tracking_number
+
+    # Unique code of courier.
+    #
+    # @return [String]
+    attr_reader :slug
+
+    # Courier name
+    #
+    # @return [String]
+    attr_accessor :courier
+
+    # Whether or not AfterShip will continue tracking the shipments. Value is
+    # +false+ when status is +Delivered+ or +Expired+.
+    #
+    # @return [Boolean]
+    attr_accessor :active
+
+    # Custom fields of the tracking.
+    #
+    # @return [Hash]
+    attr_accessor :custom_fields
+
+    # Customer name of the tracking.
+    #
+    # @return [String]
+    attr_accessor :customer_name
+
+    # Destination country of the tracking. ISO Alpha-3 (three letters). If you
+    # use postal service to send international shipments, AfterShip will
+    # automatically get tracking results from destination postal service based
+    # on destination country.
+    #
+    # @return [String]
+    attr_accessor :destination_country_iso3
+
+    # Email address(es) to receive email notifications. Comma separated for
+    # multiple values.
+    #
+    # @return [Array<String>]
+    attr_accessor :emails
+
+    # Expected delivery date (if any).
+    #
+    # Empty String,
+    # YYYY-MM-DD,
+    # YYYY-MM-DDTHH:MM:SS, or
+    # YYYY-MM-DDTHH:MM:SS+TIMEZONE.
+    #
+    # @return [DateTime]
+    attr_reader :expected_delivery
+
+    # Text field for order ID.
+    #
+    # @return [String]
+    attr_accessor :order_id
+
+    # Text field for order path.
+    #
+    # @return [String]
+    attr_accessor :order_id_path
+
+    # Origin country of the tracking. ISO Alpha-3 (three letters).
+    #
+    # @return [String]
+    attr_accessor :origin_country_iso3
+
+    # You can use the value, to direct access the tracking result at this url:
+    # https://yourusername.aftership.com/unique_token
+    #
+    # @return [String]
+    attr_accessor :unique_token
+
+    # Number of packages under the tracking.
+    #
+    # @return [Number]
+    attr_accessor :shipment_package_count
+
+    # Shipment type provided by carrier (if any).
+    #
+    # @return [String]
+    attr_accessor :shipment_type
+
+    # Signed by information for delivered shipment (if any).
+    #
+    # @return [String]
+    attr_accessor :signed_by
+
+    # Phone number(s) to receive sms notifications. The phone number(s) to
+    # receive sms notifications. Phone number should begin with <code>+</code>
+    # and +Area Code+ before phone number. Comma separated for multiple values.
+    #
+    # @return [Array<String>]
+    attr_accessor :smses
+
+    # Source of how this tracking is added.
+    #
+    # @return [String]
+    attr_accessor :source
+
+    # Current status of tracking.
+    #
+    # Value: +Pending+, +InfoReceived+, +InTransit+, +OutForDelivery+,
+    # +AttemptFail+, +Delivered+, +Exception+, +Expired+.
+    #
+    # See status definition https://www.aftership.com/docs/api/4/delivery-status.
+    #
+    # @return [String]
+    attr_reader :tag
+
+    # Same as tag, except human-friendly:
+    #
+    # * +Pending+ => +Pending+
+    # * +InfoReceived+ => +Info Received+
+    # * +InTransit+ => +In Transit+
+    # * +OutForDelivery+ => +Out For Delivery+
+    # * +AttemptFail+ => +Attempt Failed+
+    # * +Delivered+ => +Delivered+
+    # * +Exception+ => +Exception+
+    # * +Expired+ => +Expired+
+    #
+    # @return [String]
+    attr_accessor :status
+
+    # Title of the tracking.
+    #
+    # @return [String]
+    attr_accessor :title
+
+    # Number of attempts AfterShip tracks at courier's system.
+    #
+    # @return [Number]
+    attr_accessor :tracked_count
+
+    # Array of Checkpoint describes the checkpoint information.
+    #
+    # @return [Array<Checkpoint>]
+    attr_reader :checkpoints
+
+    # Better interface for a tracking.
+    #
+    # @param data [Hash] tracking hash
+    def initialize(data)
+      @checkpoints = []
+      load_attributes(data)
+    end
+
+    # Date and time of the tracking created.
+    #
+    # @return [DateTime]
+    def created_at=(value)
+      @created_at = DateTime.parse(value)
+    end
+
+    # Date and time of the tracking last updated.
+    #
+    # @return [DateTime]
+    def updated_at=(value)
+      @updated_at = DateTime.parse(value)
+    end
+
+    # Unique code of courier.
+    #
+    # @return [String]
+    def slug=(value)
+      @slug        = value
+      self.courier = value.upcase
+      @slug
+    end
+
+    # Expected delivery date (if any).
+    #
+    # @return [DateTime]
+    def expected_delivery=(value)
+      @expected_delivery = DateUtils.parse(value)
+    end
+
+    # Current status of tracking.
+    #
+    # Value: +Pending+, +InfoReceived+, +InTransit+, +OutForDelivery+,
+    # +AttemptFail+, +Delivered+, +Exception+, +Expired+.
+    #
+    # See status definition https://www.aftership.com/docs/api/4/delivery-status.
+    #
+    # @return [String]
+    def tag=(value)
+      @tag        = value
+      self.status = TAG_STATUS.fetch(value)
+      @tag
+    end
+
+    # Array of Checkpoint describes the checkpoint information.
+    #
+    # @return [Array<Checkpoint>]
+    def checkpoints=(value)
+      @checkpoints = value.map { |data| Checkpoint.new(data) }
+    end
+  end
+end

data/lib/after_ship/version.rb

@@ -0,0 +1,3 @@
+class AfterShip
+  VERSION = '0.0.2'
+end