whiplash_api 1.0.6 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a92bd769283e38a3430455207ddc5481d7c55745
-  data.tar.gz: 2d6c8ea5e92d6dd5002b1a02571ca482ff7c7da8
+  metadata.gz: 1b8e4cde329204d9a5cfbaeeee4f98fca367bf2d
+  data.tar.gz: 83e20c82aaa00ece745944f6ddb1c1a853466346
 SHA512:
-  metadata.gz: 2839984f50273684227e474a41a5e93d12fe30bb17a016dc91c0f5463c37703e81aadd5ddfe8bc1bd4bd2c3aae840a83b895d0ba496f65fb1d723ed420b28069
-  data.tar.gz: 768fb3dee5910cb1e37d149c9bfba65cd01d473679b0ac26b1c02e2d6a02c7193d0d4cbab2a345704f3b18aaa00485ec3c50b88060c0c4b2f888996e9d12fa6c
+  metadata.gz: f978b08e9b7bbc52a70dcfb09a86f050e8043b3a6c2a2155ea83b40467985ad834c1421c313cace4ac00892c2962a72907b80b13bb2672444f9e696724419203
+  data.tar.gz: 1951090bdfa4d3d17a30014721d4573b2aa44a90f2abe3a84b89932951c83e86923c644dfa5caabfa07efd9fb00c892b25a5efd7ce28ff90b8ae60d4837d175d

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .ruby-gemset
 .ruby-version
+.rbenv-vars

data/README.md

@@ -5,10 +5,6 @@ Whiplash API V1 - Ruby Client
 
 This library provides a wrapper around the [Whiplash][whiplash] [Merchandising REST API][api] for use within Ruby apps or via the console.
 
-### Note
-
-**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]: **
-
 ### Requirements
 
 - Ruby 1.9.3+
@@ -16,9 +12,9 @@ This library provides a wrapper around the [Whiplash][whiplash] [Merchandising R
 - JSON
 - ActiveResource
 
-A valid API key is required to authenticate requests. You can find your API key on your customer account page.
+A valid API key (v1) or Oauth token (v2) is required to authenticate requests. You can find your API key on your customer account page. 
 
-You can, also, use the test API key `Hc2BHTn3bcrwyPooyYTP` to test this client.
+You can also use the test API key `Hc2BHTn3bcrwyPooyYTP` to test this client.
 
 ### Installation
 
@@ -40,15 +36,29 @@ 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.
 
+### API Versions
+
+The default Whiplash API is v1 and uses API keys. The v2 API uses Oauth, and is currently available in private beta. 
+
+Both API versions are fully supported by this gem. Unless specified, API v1 is used.
+
+NOTE: The API Key is your OAuth access token if you are using API v2. If you want to use API v2, call `.api_version` before setting the OAuth token:
+
+```
+WhiplashApi::Base.api_version = 1
+WhiplashApi::Base.api_key = 'XXXXXXXXXXXXX'
+```
+
+### Sandbox usage
+
 You'll likely want to start by testing in the Sandbox:
 
 ```
- WhiplashAPI::Base.testing!
+ WhiplashApi::Base.testing!
 ```
 
 You can, also, check a very basic implementation/example inside `exe/whiplash_api` file.
@@ -60,17 +70,17 @@ The API currently gives you access to all endpoints supported by [Whiplash][whip
 ```
 $ irb
 >
-> WhiplashAPI::Base.api_key = 'XXXXXXXXXXXXX'
+> WhiplashApi::Base.api_key = 'XXXXXXXXXXXXX'
 >
-> items = WhiplashAPI::Item.all
+> items = WhiplashApi::Item.all
 >
-> items = WhiplashAPI::Item.sku('SOME-SKU-111')
+> items = WhiplashApi::Item.sku('SOME-SKU-111')
 >
-> order = WhiplashAPI::Order.last
+> order = WhiplashApi::Order.last
 >
-> orders = WhiplashAPI::Order.all(:params => {:status => 'shipped', :created_at_min => '2008-01-01'})
+> orders = WhiplashApi::Order.all(:params => {:status => 'shipped', :created_at_min => '2008-01-01'})
 >
-> order_item = WhiplashAPI::OrderItem.originator(ID_IN_YOUR_STORE)
+> order_item = WhiplashApi::OrderItem.originator(ID_IN_YOUR_STORE)
 >
 ```
 
@@ -86,19 +96,31 @@ $ irb
 
 ### Testing Whiplash API Gem
 
-You can run the tests on the current version of this gem, by cloning it locally, and then, running:
+You can run the tests on the current version of this gem, by cloning it
+locally. Tests require setting up the following environment variables:
 
 ```
-WL_KEY=Hc2BHTn3bcrwyPooyYTP rspec spec
+WL_API_KEY=Hc2BHTn3bcrwyPooyYTP # for testing if API v1 support
+WL_OAUTH_KEY=23447e1eaeddf2d1c4af4c9cf88524af2863cb1f72d500dd9328b34735a3f3b0 # for testing if API v2 support
+WL_API_VERSION=2 # By default, API v2 is used for all tests, but can be toggled using this.
+WL_CUSTOMER_ID=242 # Use the given Customer ID for API v2
+rspec spec
 ```
 
-You can skip teardown for the tests (where the test suite removes/deleted instances of created resources on the testing server) by setting an environment variable `NO_TEARDOWN`.
+You can skip checking support for API v1 by not setting the corresp. env
+variable.
+
+You can skip teardown for the tests (where the test suite
+removes/deleted instances of created resources on the testing server) by
+setting an environment variable `NO_TEARDOWN`.
 
-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.
+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.
+Copyright (c) 2015 Whiplash Merchandising/Mark Dickson. See LICENSE.txt for further details.
 
 
   [whiplash]: https://www.whiplashmerch.com/

data/lib/whiplash_api.rb

@@ -8,3 +8,4 @@ require 'whiplash_api/order'
 require 'whiplash_api/order_item'
 require 'whiplash_api/shipnotice'
 require 'whiplash_api/shipnotice_item'
+require 'whiplash_api/web_hook'

data/lib/whiplash_api/base.rb

@@ -7,10 +7,13 @@ module WhiplashApi
     self.format = :json
 
     class << self
+      attr_accessor :api_version, :api_key, :customer_id
+
       def testing!
         self.site = 'http://testing.whiplashmerch.com/api/'
 
         ActiveSupport::Notifications.subscribe("request.active_resource") do |*args|
+          puts "[ActiveResource] Headers: #{WhiplashApi::Base.headers}"
           puts "[ActiveResource] Request:  #{args.last[:request_uri]}"
           puts "[ActiveResource] Response: #{args.last[:result].body}"
         end if ENV['DEBUG'].present?
@@ -19,8 +22,6 @@ module WhiplashApi
       # 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
@@ -30,12 +31,35 @@ module WhiplashApi
         Thread.current["active.resource.currentthread.headers"]
       end
 
-      def api_key=(api_key)
-        headers['X-API-KEY'] = api_key
+      def api_version
+        @api_version ||= WhiplashApi::DEFAULT_API_VERSION
       end
 
       def api_version=(v = nil)
-        headers['X-API-VERSION'] = v || 1
+        @api_version = v.to_i > 0 ? v.to_i : WhiplashApi::DEFAULT_API_VERSION
+        headers['X-API-VERSION'] = @api_version.to_s
+      end
+
+      def api_key=(api_key)
+        @api_key = api_key
+        raise Error, "You must set a valid API Key." if @api_key.blank?
+
+        if api_version == 1
+          headers['X-API-KEY'] = @api_key
+        else
+          headers['Authorization'] = "Bearer #{@api_key}"
+        end
+      end
+
+      def customer_id=(customer_id = nil)
+        @customer_id = customer_id
+        headers['X-CUSTOMER-ID'] = customer_id.to_s
+      end
+
+      def reset_headers!
+        %w[X-API-KEY X-API-VERSION Authorization].each do |key|
+          headers.delete(key)
+        end
       end
 
       protected

data/lib/whiplash_api/connection.rb

@@ -4,13 +4,13 @@ module WhiplashApi
 
     def request(*arguments)
       super
-    rescue ActiveResource::ResourceInvalid => e
+    rescue ActiveResource::ResourceInvalid, ActiveResource::ForbiddenAccess, ActiveResource::UnauthorizedAccess => e
       data = JSON.parse e.response.body
       case
       when data['error'].present? && data['error'].downcase =~ /record.*not.*found/
-        raise WhiplashApi::RecordNotFound
+        raise WhiplashApi::RecordNotFound, data['error']
       when data['error'].present?
-        raise WhiplashApi::Error, data['error'].humanize
+        raise WhiplashApi::Error, "#{e.class}: #{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- ")}"
@@ -18,7 +18,7 @@ module WhiplashApi
         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}"
+        raise
       end
     end
   end

data/lib/whiplash_api/order_item.rb

@@ -35,16 +35,29 @@ module WhiplashApi
         raise RecordNotFound, "No order item found with given ID."
       end
 
+      def separate(id, args={})
+        response = self.post("#{id}/separate")
+        sanitize_as_resource JSON.parse(response.body)
+      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
 
     # instance methods
     def destroy
       self.class.delete(self.id)
     end
+
+    def separate
+      self.class.separate(self.id)
+    end
+
   end
 end

data/lib/whiplash_api/version.rb

@@ -1,3 +1,4 @@
 module WhiplashApi
-  VERSION = "1.0.6"
+  VERSION = "1.2.3"
+  DEFAULT_API_VERSION = 1
 end

data/lib/whiplash_api/web_hook.rb

@@ -0,0 +1,18 @@
+module WhiplashApi
+  class WebHook < Base
+    class << self
+
+      def delete(*args)
+        super
+      rescue WhiplashApi::RecordNotFound
+        raise RecordNotFound, "No Web Hook was found with given ID."
+      end
+
+    end
+
+    # instance methods
+    def destroy(args={})
+      self.class.delete(self.id, args)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whiplash_api
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.2.3
 platform: ruby
 authors:
 - Mark Dickson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,6 +138,7 @@ files:
 - lib/whiplash_api/shipnotice.rb
 - lib/whiplash_api/shipnotice_item.rb
 - lib/whiplash_api/version.rb
+- lib/whiplash_api/web_hook.rb
 - whiplash_api.gemspec
 homepage: http://github.com/ideaoforder/whiplash_api
 licenses:
@@ -159,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Gem for connecting to the Whiplash Merchandising API