springboard-retail 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 749ec3a018626e45895cdf3ce674d69ac06803b2
-  data.tar.gz: 8e779076c490e2d7d331b0488a8b7a28a054b843
+  metadata.gz: 738a7ddac21ce8cd9e2b2a74bd1fef9cddd504cc
+  data.tar.gz: b4b5290211fe0fe1c9fa7a5af94f233db8e01c79
 SHA512:
-  metadata.gz: 6c96e952949e093a9703cce11b9db9e17662eae0f49fecb37775c680d15623760bc5e749f84a16e24bc0abec06e83967bda583ef4cfe341b042e9e4cc4633255
-  data.tar.gz: edff0014f54cae6814448300aa2eb396f984e9140de482b35a09469cb76cb273da5b751258f33b81e1ec8a1750cab283a6b16b57a7d1d8550058a36ad422d635
+  metadata.gz: 7c5563eff3f6cfb9513ccc8559e043b50edf1ccd7b536b6c1e6effb0fbd4f090d194ba00a26a177e1cdfc49640a46a40c7f2c660c0ea2cc537a4ebc3a91295b7
+  data.tar.gz: f0d59e9cd2c1dc3a001d0254e8756a9eca0c30baf344a17bd23df9779dc05b3c6e715f1fadf2354fece490a892cc80e280345f1f157dc23eda636bc1fcc4904b

data/.travis.yml

@@ -1,3 +1,4 @@
+sudo: false
 language: ruby
 bundler_args: --without development
 rvm:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    springboard-retail (4.0.1)
+    springboard-retail (4.1.0)
       addressable (~> 2.2.8)
       hashie
       json (>= 1.7.4)
@@ -22,8 +22,8 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    hashie (3.4.1)
-    json (1.8.2)
+    hashie (3.4.3)
+    json (1.8.3)
     method_source (0.8.2)
     mime-types (2.4.3)
     multi_json (1.11.0)
@@ -75,3 +75,6 @@ DEPENDENCIES
   rspec (~> 3.2)
   springboard-retail!
   webmock
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/springboard-retail.png)](http://badge.fury.io/rb/springboard-retail)
 [![Build Status](https://travis-ci.org/springboardretail/springboard-client-ruby.png?branch=master)](https://travis-ci.org/springboardretail/springboard-client-ruby)
 [![Code Climate](https://codeclimate.com/github/springboardretail/springboard-client-ruby.png)](https://codeclimate.com/github/springboardretail/springboard-client-ruby)
-[![Coverage Status](https://coveralls.io/repos/springboardretail/springboard-client-ruby/badge.png)](https://coveralls.io/r/springboardretail/springboard-client-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/springboardretail/springboard-client-ruby/badge.svg?branch=master)](https://coveralls.io/github/springboardretail/springboard-client-ruby?branch=master)
 [![Dependency Status](https://gemnasium.com/springboardretail/springboard-client-ruby.png)](https://gemnasium.com/springboardretail/springboard-client-ruby)
 
 This is the [Springboard Retail](http://springboardretail.com/) (a point-of-sale/retail management system) client library for Ruby. It provides access to the Springboard Retail HTTP API.
@@ -27,8 +27,10 @@ gem install springboard-retail
 
 ```ruby
 require 'springboard-retail'
-springboard = Springboard::Client.new 'https://example.myspringboard.us/api'
-springboard.auth :username => 'user', :password => 'secret'
+springboard = Springboard::Client.new(
+  'https://example.myspringboard.us/api',
+  token: 'secret_token'
+)
 ```
 
 ## Resource oriented

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler/setup'
+require 'bundler/gem_tasks'
 Bundler.require(:default, :development)
 
 require 'rspec/core/rake_task'

data/lib/springboard/client.rb

@@ -42,6 +42,7 @@ module Springboard
     # @param [String] base_uri Base URI
     # @option opts [Boolean, String] :debug Pass true to debug to stdout. Pass a String to debug to given filename.
     # @option opts [Boolean] :insecure Disable SSL certificate verification
+    # @option opts [String] :token Springboard API Token
     def initialize(base_uri, opts={})
       @base_uri = URI.parse(base_uri)
       configure_session(base_uri, opts)
@@ -69,6 +70,7 @@ module Springboard
     end
 
     ##
+    # @deprecated see {#initialize}.
     # Passes the given credentials to the server, storing the session token on success.
     #
     # @raise [AuthFailed] If the credentials were invalid or the server returned an error
@@ -78,6 +80,8 @@ module Springboard
     # @option opts [String] :username Springboard username
     # @option opts [String] :password Springboard password
     def auth(opts={})
+      warn "[DEPRECATION] `auth` is deprecated. Please use `Springboard::Client.new '#{base_uri}', token: 'secret_token'` instead."
+
       unless opts[:username] && opts[:password]
         raise "Must specify :username and :password"
       end
@@ -199,7 +203,7 @@ module Springboard
         end
       end
     end
-  
+
     ##
     # Returns a count of subordinate resources of the given collection resource
     # URI.
@@ -248,6 +252,7 @@ module Springboard
     def configure_session(base_url, opts)
       session.base_url = base_url
       session.headers['Content-Type'] = 'application/json'
+      session.headers['Authorization'] = "Bearer #{opts[:token]}" if opts[:token]
       session.handle_cookies
       session.insecure = opts[:insecure] if opts.has_key?(:insecure)
       session.timeout = DEFAULT_TIMEOUT

data/spec/springboard/client/resource_spec.rb

@@ -6,10 +6,6 @@ describe Springboard::Client::Resource do
   let(:resource_path) { '/some/path' }
   let(:resource) { Springboard::Client::Resource.new(client, resource_path) }
 
-  def parse_uri(uri)
-    Addressable::URI.parse(uri)
-  end
-
   describe "[]" do
     it "should return a new resource" do
       expect(resource["subpath"]).to be_a Springboard::Client::Resource

data/spec/springboard/client_spec.rb

@@ -68,6 +68,19 @@ describe Springboard::Client do
       client.__send__(:configure_session, base_url, {})
       expect(client.session.connect_timeout).to eq(Springboard::Client::DEFAULT_CONNECT_TIMEOUT)
     end
+
+    context 'headers' do
+      let(:headers) { double('headers') }
+      before do
+        allow(session).to receive(:headers).and_return(headers)
+      end
+
+      it 'sets Content-Type header' do
+        expect(headers).to receive(:[]=).once.with('Content-Type', 'application/json')
+        expect(headers).to receive(:[]=).once.with('Authorization', 'Bearer token')
+        client.__send__(:configure_session, base_url, :token => 'token')
+      end
+    end
   end
 
   describe "[]" do
@@ -76,6 +89,21 @@ describe Springboard::Client do
     end
   end
 
+  describe "debug=" do
+    context "with a file path" do
+      it "should pass the path to enable_debug on the Patron session" do
+        expect(client.session).to receive(:enable_debug).with('/path/to/log')
+        client.debug = '/path/to/log'
+      end
+    end
+
+    context "with true" do
+      it "should pass nil to enable_debug on the Patron session" do
+        expect(client.session).to receive(:enable_debug).with(nil)
+        client.debug = true
+      end
+    end
+  end
 
   [:get, :head, :delete].each do |method|
     bang_method = "#{method}!"
@@ -211,4 +239,14 @@ describe Springboard::Client do
       end.to yield_successive_args(*all_results)
     end
   end
+
+  describe "count" do
+    it "should request the first page/record of the collection and return the total" do
+      response = double(Springboard::Client::Response)
+      allow(response).to receive(:[]).with('total').and_return(17)
+      expect(client).to receive(:get!).with("/things?page=1&per_page=1".to_uri)
+        .and_return(response)
+      expect(client.count('/things')).to eq(17)
+    end
+  end
 end

data/springboard-retail.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'springboard-retail'
-  s.version           = '4.0.1'
+  s.version           = '4.1.0'
   s.platform          = Gem::Platform::RUBY
   s.authors           = ['Jay Stotz']
   s.summary           = 'Springboard Retail API client library'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springboard-retail
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Jay Stotz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -103,8 +103,8 @@ files:
 - vendor/cache/crack-0.4.2.gem
 - vendor/cache/diff-lcs-1.2.5.gem
 - vendor/cache/docile-1.1.5.gem
-- vendor/cache/hashie-3.4.1.gem
-- vendor/cache/json-1.8.2.gem
+- vendor/cache/hashie-3.4.3.gem
+- vendor/cache/json-1.8.3.gem
 - vendor/cache/method_source-0.8.2.gem
 - vendor/cache/mime-types-2.4.3.gem
 - vendor/cache/multi_json-1.11.0.gem
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Springboard Retail API client library