whiplash_api 0.1.1 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74a85dbf10a36892fe32bd9e139c24c224e8f646
+  data.tar.gz: 098b22a96b9eb3b97473feb2c5731cfdfb2f6261
+SHA512:
+  metadata.gz: 838992e0107a5a1f879e36310b758769260b480696e1bf94fd3f5986218b1169ed7b63d1a084c14096a34260433828d450827cf7e985b6d6b53c2211d1adff0f
+  data.tar.gz: 0ea784819cc42c368884c4ae1093d032064edf2ee4b50fa4f054155655825a4f6d28c08819166ad6e7cac5b8cc1e50a1667c1b0f4a083b23ce4339a0b61c0dc7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -1,20 +1,21 @@
-Copyright (c) 2012 Whiplash Merchandising/Mark Dickson
+The MIT License (MIT)
 
-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:
+Copyright (c) 2015 Nikhil Gupta
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+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 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.
+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.rdoc → README.md}

@@ -1,22 +1,26 @@
 Whiplash API V1 - Ruby Client
 ================================
 
-This library provides a wrapper around the Whiplash Merchandising REST API for use within Ruby apps or via the console.
+[![Build Status](https://travis-ci.org/nikhgupta/whiplash_api.svg?branch=master)](https://travis-ci.org/nikhgupta/whiplash_api)
 
-== Note
+This library provides a wrapper around the [Whiplash][whiplash] [Merchandising REST API][api] for use within Ruby apps or via the console.
 
-**If you are using a Rails app, the advised approach is to use ActiveResource. You can get started or gain inspiration from our example Rails app: https://github.com/ideaoforder/whiplash-rails-example**
+### Note
 
-== Requirements
+**If you are using a Rails app, the advised approach is to use ActiveResource. You can get started or gain inspiration from our [example Rails app][app]: **
 
-- Ruby 1.8.7+
+### Requirements
+
+- Ruby 1.9.3+
 - Rubygems
 - JSON
 - ActiveResource
 
 A valid API key is required to authenticate requests. You can find your API key on your customer account page.
 
-== Installation
+You can, also, use the test API key `Hc2BHTn3bcrwyPooyYTP` to test this client.
+
+### Installation
 
 ```
 gem install whiplash_api 
@@ -28,7 +32,7 @@ Or if you're using Bundler:
 gem 'whiplash_api'
 ```
 
-== Configuration
+### Configuration
 
 To use the API client in your Ruby code, provide the required credentials as follows:
 
@@ -36,22 +40,27 @@ To use the API client in your Ruby code, provide the required credentials as fol
 require 'rubygems'
 require 'whiplash_api'
 
-WhiplashApi::Base.api_key = 'XXXXXXXXXXXXX'
+WhiplashAPI::Base.api_key = 'XXXXXXXXXXXXX'
 ```
+
+An error will be raised if no API key is provided.
+
 You'll likely want to start by testing in the Sandbox:
 
 ```
- WhiplashApi::Base.test = true
+ WhiplashAPI::Base.testing!
 ```
 
-== Usage
+You can, also, check a very basic implementation/example inside `exe/whiplash_api` file.
+
+### Usage
 
-The API currently gives you access to your Orders, Items, and OrderItems.
+The API currently gives you access to all endpoints supported by [Whiplash][whiplash] [Merchandising API][api].
 
 ```
 $ irb
 >
-> WhiplashApi::Base.api_key = 'XXXXXXXXXXXXX'
+> WhiplashAPI::Base.api_key = 'XXXXXXXXXXXXX'
 >
 > items = WhiplashAPI::Item.all
 >
@@ -59,13 +68,13 @@ $ irb
 >
 > order = WhiplashAPI::Order.last
 >
-> orders = WhiplashAPI::Order.status('shipped')
+> orders = WhiplashAPI::Order.all(:params => {:status => 'shipped', :created_at_min => '2008-01-01'})
 >
 > order_item = WhiplashAPI::OrderItem.originator(ID_IN_YOUR_STORE)
 >
 ```
 
-== Contributing to the Whiplash API Gem
+### Contributing to the Whiplash API Gem
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -75,7 +84,21 @@ $ irb
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+### Testing Whiplash API Gem
+
+You can run the tests on the current version of this gem, by cloning it locally, and then, running:
+
+```
+WL_KEY=Hc2BHTn3bcrwyPooyYTP rspec spec
+```
+
+Note that, testing can take a long time, since tests are performed directly on the testing server, and no mocks are used. This is to ensure that the API conforms to the tests, at the same time.
+
+### Copyright
 
 Copyright (c) 2012 Whiplash Merchandising/Mark Dickson. See LICENSE.txt for further details.
 
+
+  [whiplash]: https://www.whiplashmerch.com/
+  [api]: https://www.whiplashmerch.com/developers/api
+  [app]: https://github.com/ideaoforder/whiplash-rails-example

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 "whiplash_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

data/bin/setup

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

data/exe/whiplash_api

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "thor"
+require "whiplash_api"
+require "whiplash_api/cli"
+
+WhiplashApi::CLI.start ARGV

data/lib/whiplash_api.rb

@@ -1,7 +1,10 @@
-require "rubygems"
-require 'active_resource'
+require "active_resource"
+require "whiplash_api/version"
 
 require 'whiplash_api/base'
+require 'whiplash_api/connection'
 require 'whiplash_api/item'
 require 'whiplash_api/order'
-require 'whiplash_api/order_item'
+require 'whiplash_api/order_item'
+require 'whiplash_api/shipnotice'
+require 'whiplash_api/shipnotice_item'

data/lib/whiplash_api/base.rb

@@ -1,54 +1,50 @@
-module WhiplashAPI
-
-  # Example Class Method
-  # def reserved(*names)
-  #   class_variable_set(:@@reserved, names.collect{|x| x.to_s})
-  # end
+module WhiplashApi
+  class Error < ::StandardError; end
+  class RecordNotFound < Error; end
 
   class Base < ActiveResource::Base
-    extend WhiplashAPI
-    
-    self.site = 'https://www.whiplashmerch.com/api/'
+    self.site   = 'https://www.whiplashmerch.com/api/'
     self.format = :json
-    
-    # Thanks to Brandon Keepers for this little nugget:
-    # http://opensoul.org/blog/archives/2010/02/16/active-resource-in-practice/
+
     class << self
-      # If headers are not defined in a given subclass, then obtain
-      # headers from the superclass.
-      def headers
-        if defined?(@headers)
-          @headers
-        elsif superclass != Object && superclass.headers
-          superclass.headers
-        else
-          @headers ||= {}
-        end
+      def testing!
+        self.site = 'http://testing.whiplashmerch.com/api/'
+
+        ActiveSupport::Notifications.subscribe("request.active_resource") do |*args|
+          puts "[ActiveResource] Request:  #{args.last[:request_uri]}"
+          puts "[ActiveResource] Response: #{args.last[:result].body}"
+        end if ENV['DEBUG'].present?
       end
-      
+
+      # Override the connection that ActiveResource uses, so that we can add our
+      # own error messages for the weird cases when API returns 422 error.
+      def connection(refresh = false)
+        message = "You must set a valid API Key. Current: #{headers['X-API-KEY'].inspect}"
+        raise WhiplashApi::Error, message if headers['X-API-KEY'].blank?
+        @connection = WhiplashApi::Connection.new(site, format) if refresh || @connection.nil?
+        super
+      end
+
       def api_key=(api_key)
         headers['X-API-KEY'] = api_key
       end
-      
+
       def api_version=(v)
         headers['X-API-VERSION'] = v
       end
-      
-      def local=(v)
-        self.site = 'http://localhost:3000/api/' if v
-      end
-      
-      def test=(v)
-        self.site = 'http://testing.whiplashmerch.com/api/' if v
+
+      protected
+
+      def sanitize_as_resource(collection)
+        return collection if collection.blank?
+        as_array   = collection.is_a?(Array)
+        collection = [collection].flatten.map do |resource|
+          resource = self.new(resource)
+          resource.instance_variable_set("@persisted", true)
+          resource
+        end
+        as_array ? collection : collection.first
       end
-    
     end
-    
-    # Example Instance Method
-    # def class_name
-    #   self.class.name.split('::').last.downcase
-    # end
-        
   end
-
-end
+end

data/lib/whiplash_api/cli.rb

@@ -0,0 +1,49 @@
+require 'pry'
+
+# An example implementation of this gem.
+module WhiplashApi
+  class CLI < Thor
+
+    class_option :test,  boolean: true, desc: "run using test API endpoints."
+    class_option :local, boolean: true, desc: "run using localhost API endpoints."
+
+    desc "list [API_KEY]", "Fetch items for the current account"
+    def list(api_key = nil)
+      setup! api_key
+
+      items = WhiplashApi::Item.all
+      items.each do |item|
+        message  = "%16s" % item.sku
+        message += "%20s" % item.description
+        message += "  %3s  " % (item.available ? "Yes" : "No")
+        message += item.title
+        say_status "Product", message
+      end
+    end
+
+    desc "sku ID [API_KEY]", "Fetch item by SKU"
+    def sku(id, api_key = nil)
+      setup! api_key
+
+      item = WhiplashApi::Item.sku id
+      message  = "%16s" % item.sku
+      message += "%20s" % item.description
+      message += "  %3s  " % (item.available ? "Yes" : "No")
+      message += item.title
+      say_status "Product", message
+    end
+
+    desc "test", "test"
+    def test
+      setup!
+      binding.pry
+    end
+
+    private
+
+    def setup!(api_key = nil)
+      WhiplashApi::Base.api_key = api_key || ENV['WL_KEY']
+      WhiplashApi::Base.testing! if ENV['API_ENV'] == "test" || options[:test]
+    end
+  end
+end

data/lib/whiplash_api/connection.rb

@@ -0,0 +1,26 @@
+module WhiplashApi
+  class Connection < ActiveResource::Connection
+    private
+
+    def request(*arguments)
+      super
+    rescue ActiveResource::ResourceInvalid => e
+      data = JSON.parse e.response.body
+      case
+      when data['error'].present? && data['error'].downcase =~ /record.*not.*found/
+        raise WhiplashApi::RecordNotFound
+      when data['error'].present?
+        raise WhiplashApi::Error, data['error'].humanize
+      when data['errors'].present? && data['errors']['base'].present?
+        messages = data['errors']['base']
+        raise WhiplashApi::Error, "Errors were encountered while creating the resource.\n- #{messages.join("\n- ")}"
+      when data['errors'].present?
+        messages = data['errors'].map{|k,v| v.map{|message| "#{k.humanize} #{message}"}}.flatten
+        raise WhiplashApi::Error, "Errors were encountered while creating the resource.\n- #{messages.join("\n- ")}"
+      else
+        raise WhiplashApi::Error, "Errors were encountered while creating the resource.\nResponse was: #{e.response.body}"
+      end
+    end
+  end
+end
+

data/lib/whiplash_api/item.rb

@@ -1,15 +1,57 @@
-module WhiplashAPI
-  
+module WhiplashApi
   class Item < Base
     class << self
+      def count(args={})
+        self.get(:count, args)
+      end
+
       def sku(sku, args={})
-        self.get(:sku, {:sku => sku}.merge(args))
+        sanitize_as_resource self.get(:sku, { sku: sku }.merge(args))
       end
-      
+
+      def group(id, args={})
+        sanitize_as_resource self.get("group/#{id}", args)
+      end
+
       def originator(id, args={})
-        self.get(:originator, {:originator_id => id}.merge(args))
+        sanitize_as_resource self.get("originator/#{id}", args)
+      end
+
+      def find_or_create(id, args={})
+        self.find(id)
+      rescue WhiplashApi::RecordNotFound
+        create(args)
+      end
+
+      def find_or_create_by_sku(sku, args={})
+        first_by_sku(sku) || create(args.merge(sku: sku))
+      end
+
+      def find_or_create_by_originator_id(id, args={})
+        originator(id) || create(args.merge(originator_id: id))
+      end
+
+      def update(args={})
+        item = self.originator(args[:originator_id])
+        raise RecordNotFound, "No item was found with given Originator ID." unless item
+        item.update_attributes(args) ? item : nil
+      end
+
+      def delete(*args)
+        super
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No Item was found with given ID."
+      end
+
+      # additional useful methods:
+      def first_by_sku(sku, args={})
+        self.sku(sku, args).first
       end
     end
-  end
 
-end
+    # instance methods
+    def destroy(args={})
+      self.class.delete(self.id, args)
+    end
+  end
+end

data/lib/whiplash_api/order.rb

@@ -1,15 +1,134 @@
-module WhiplashAPI
-  
+module WhiplashApi
   class Order < Base
     class << self
-      def status(status, args={})
-        self.get(:status, {:status => status}.merge(args))
+      def status_for(status)
+        status_mapping[status].to_s.titleize
       end
-      
+      def status_code_for(status)
+        status_mapping.invert[status.to_s.underscore.to_sym]
+      end
+
+      def count(args={})
+        self.get(:count, args)
+      end
+
       def originator(id, args={})
-        self.get(:originator, {:originator_id => id}.merge(args))
+        sanitize_as_resource self.get("originator/#{id}", args)
+      end
+
+      def find_or_create_by_originator_id(id, args={})
+        originator(id) || create(args.merge(originator_id: id))
+      end
+
+      def update(args={})
+        order = self.originator(args[:originator_id])
+        raise RecordNotFound, "No order found with given Originator ID." unless order
+        order.update_attributes(args) ? order : false
+      end
+
+      def pause(id, args={})
+        self.put("#{id}/pause")
+      end
+
+      def release(id, args={})
+        self.put("#{id}/release")
+      end
+
+      def cancel(id, args={})
+        self.put("#{id}/cancel")
+      end
+
+      def uncancel(id, args={})
+        self.put("#{id}/uncancel")
+      end
+
+      private
+
+      def status_mapping
+        {
+          35 =>  :quote,
+          40 =>  :cancelled,
+          45 =>  :closed_by_originator,
+          50 =>  :unpaid,
+          75 =>  :pending_return,
+          77 =>  :return_verified,
+          80 =>  :items_unavailable,
+          90 =>  :paused,
+          95 =>  :unassignable,
+          100 => :processing,
+          120 => :printed,
+          150 => :picked,
+          155 => :prepacking_in_progress,
+          160 => :packed,
+          200 => :label_scheduled_for_purchase,
+          250 => :label_purchased,
+          300 => :shipped,
+          350 => :delivered,
+          400 => :returned_undeliverable,
+          410 => :replacement_requested,
+          430 => :exchanged,
+          450 => :refund_requested
+        }
       end
     end
-  end
 
-end
+    # instance methods
+
+    def unshipped?
+      self.status.to_i < 300
+    end
+
+    def paused?
+      self.status.to_i == 90
+    end
+
+    def cancelled?
+      self.status.to_i == 40
+    end
+
+    def unprocessed?
+      self.status.to_i < 100
+    end
+
+    def being_processed?
+      self.status.to_i == 100
+    end
+    alias :processing? :being_processed?
+
+    def pause
+      self.put(:pause)
+    end
+
+    def release
+      self.put(:release)
+    end
+
+    def cancel
+      self.put(:cancel)
+    end
+
+    def uncancel
+      self.put(:uncancel)
+    end
+
+    # def pause
+    #   self.put(:pause) and return if unshipped?
+    #   raise Error, "Orders may only be paused before they have been shipped."
+    # end
+
+    # def release
+    #   self.put(:release) and return if paused?
+    #   raise Error, "Cannot release an order that has not been paused."
+    # end
+
+    # def cancel
+    #   self.put(:cancel) and return if unshipped?
+    #   raise Error, "Orders may only be cancelled before they have been shipped."
+    # end
+
+    # def uncancel
+    #   self.put(:uncancel) and return if cancelled?
+    #   raise Error, "Cannot uncancel an order that has not been cancelled."
+    # end
+  end
+end

data/lib/whiplash_api/order_item.rb

@@ -1,11 +1,50 @@
-module WhiplashAPI
-  
+module WhiplashApi
   class OrderItem < Base
     class << self
+
+      # Finders for OrderItem require `order_id` key to be present.
+      # The following routine enforces this condition.
+      #
+      def find(*args)
+        scope   = args.slice!(0)
+        options = args.slice!(0) || {}
+
+        if [:all, :first, :last, :one].include?(scope)
+          invalid = options[:params].to_s.empty? || options[:params][:order_id].to_s.empty?
+          raise Error, "You must supply an Order ID (as parameter) to retrieve order items for." if invalid
+        end
+
+        super(scope, options)
+      end
+
       def originator(id, args={})
-        self.get(:originator, {:originator_id => id}.merge(args))
+        self.collection_name = "order_items/originator"
+        order = self.find(id, args) rescue nil
+        self.collection_name = "order_items"
+        order
+      end
+
+      def find_or_create_by_originator_id(id, args={})
+        originator(id) || create(args.merge(originator_id: id))
+      end
+
+      def update(id, args={})
+        response = self.put(id, {}, args.to_json)
+        response.code.to_i >= 200 && response.code.to_i < 300
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No order item found with given ID."
+      end
+
+      def delete(*args)
+        super
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No order item was found with given ID."
       end
     end
-  end
 
-end
+    # instance methods
+    def destroy
+      self.class.delete(self.id)
+    end
+  end
+end

data/lib/whiplash_api/shipnotice.rb

@@ -0,0 +1,68 @@
+module WhiplashApi
+  class Shipnotice < Base
+    class << self
+
+      def status_for(status_code)
+        status_mapping[status_code].to_s.titleize
+      end
+      def status_code_for(status)
+        status_mapping.invert[status.to_s.underscore.to_sym]
+      end
+
+      def warehouse_for(warehouse_code)
+        warehouse_mapping[warehouse_code].to_s.titleize
+      end
+      def warehouse_code_for(warehouse)
+        warehouse_mapping.invert[warehouse]
+      end
+
+      def count(args={})
+        self.get(:count, args)
+      end
+
+      def update(id, args={})
+        response = self.put(id, {}, args.to_json)
+        response.code.to_i >= 200 && response.code.to_i < 300
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No Shipment notice found with given ID."
+      end
+
+      def delete(*args)
+        super
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No Shipment notice found with given ID."
+      end
+
+      private
+
+      def status_mapping
+        {
+          25  => :unexpected,
+          50  => :draft,
+          100 => :in_transit,
+          150 => :arrived,
+          200 => :processing,
+          250 => :problem,
+          300 => :completed,
+        }
+      end
+
+      def warehouse_mapping
+        { 1 => "Ann Arbor", 2 => "San Francisco", 3 => "London" }
+      end
+    end
+
+    # instance methods
+    def received?
+      self.status.to_i > 100
+    end
+
+    def processed?
+      self.status.to_i > 200
+    end
+
+    def destroy
+      self.class.delete(self.id)
+    end
+  end
+end

data/lib/whiplash_api/shipnotice_item.rb

@@ -0,0 +1,39 @@
+module WhiplashApi
+  class ShipnoticeItem < Base
+    class << self
+
+      # Finders for ShipnoticeItem require `shipnotice_id` key to be present.
+      # The following routine enforces this condition.
+      #
+      def find(*args)
+        scope   = args.slice!(0)
+        options = args.slice!(0) || {}
+
+        if [:all, :first, :last, :one].include?(scope)
+          invalid = options[:params].to_s.empty? || options[:params][:shipnotice_id].to_s.empty?
+          raise Error, "You must supply a Shipment Notice ID (as parameter) to retrieve shipnotice items for." if invalid
+        end
+
+        super(scope, options)
+      end
+
+      def update(id, args={})
+        response = self.put(id, {}, args.to_json)
+        response.code.to_i >= 200 && response.code.to_i < 300
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No shipnotice item found with given ID."
+      end
+
+      def delete(*args)
+        super
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No shipnotice item found with given ID."
+      end
+    end
+
+    # instance methods
+    def destroy
+      self.class.delete(self.id)
+    end
+  end
+end

data/lib/whiplash_api/version.rb

@@ -0,0 +1,3 @@
+module WhiplashApi
+  VERSION = "1.0.3"
+end

data/whiplash_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 'whiplash_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whiplash_api"
+  spec.version       = WhiplashApi::VERSION
+  spec.authors       = ["Mark Dickson"]
+  spec.email         = ["mark@sitesteaders.com"]
+
+  spec.summary       = %q{Ruby Gem for connecting to the Whiplash Merchandising API}
+  spec.description   = %q{Ruby Gem for connecting to the Whiplash Merchandising API}
+  spec.homepage      = "http://github.com/ideaoforder/whiplash_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activeresource", "~> 4.0.0"
+end

metadata

@@ -1,175 +1,164 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: whiplash_api
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  segments_generated: true
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 1.0.3
 platform: ruby
-authors: 
+authors:
 - Mark Dickson
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2012-09-17 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2015-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
   prerelease: false
-  type: :runtime
-  name: activesupport
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 3
-        - 5
-        segments_generated: true
-        version: 2.3.5
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
   prerelease: false
-  type: :runtime
-  name: activeresource
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  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 
-        hash: 9
-        segments: 
-        - 2
-        - 3
-        - 5
-        segments_generated: true
-        version: 2.3.5
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rdoc
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 3
-        - 12
-        segments_generated: true
-        version: "3.12"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: bundler
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        segments_generated: true
-        version: 1.0.0
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
-  name: jeweler
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 1
-        - 8
-        - 4
-        segments_generated: true
-        version: 1.8.4
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  type: :development
-  name: rcov
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        segments_generated: true
-        version: "0"
-  requirement: *id006
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: Ruby Gem for connecting to the Whiplash Merchandising API
-email: mark@sitesteaders.com
-executables: []
-
+email:
+- mark@sitesteaders.com
+executables:
+- whiplash_api
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/whiplash_api
 - lib/whiplash_api.rb
 - lib/whiplash_api/base.rb
+- lib/whiplash_api/cli.rb
+- lib/whiplash_api/connection.rb
 - lib/whiplash_api/item.rb
 - lib/whiplash_api/order.rb
 - lib/whiplash_api/order_item.rb
-- LICENSE.txt
-- README.rdoc
-has_rdoc: true
+- lib/whiplash_api/shipnotice.rb
+- lib/whiplash_api/shipnotice_item.rb
+- lib/whiplash_api/version.rb
+- whiplash_api.gemspec
 homepage: http://github.com/ideaoforder/whiplash_api
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      segments_generated: true
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      segments_generated: true
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby Gem for connecting to the Whiplash Merchandising API
 test_files: []
-