springboard-retail 4.3.0 → 5.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd35455f3b848e238263429302242ec4897b99f9190841b9cc03cd78e7fe70c9
-  data.tar.gz: 1f768fc9359ac7ec8daff47888b647eedb7b84f9f91cf2a1b8fa24b474afe266
+  metadata.gz: e3f1c34c2de4f27e11f8f93d315320fda31dc5ce77cae64ff5bfd8ad05b1a829
+  data.tar.gz: 32a2792c3918475a048016e65abf4a94f9bb49390f8e814f8bcd9ffae715f6de
 SHA512:
-  metadata.gz: 3e1ea9566b62cd2cfc1676ef8ddb2aa9627cecb56b0d4a8d47ce8536586ff824d81bd44cc06bad91f91239ae84be33c4915abff21ae08bf759da4c9c4e7793bf
-  data.tar.gz: 7ad3f24caf64aa63b0608f63bd047c3472abbb6e81c51388de342089953cfedc3c1d441a10e714b3c482254c0146d2123eeca78e7b7cec2b35d5e17be6719b3d
+  metadata.gz: f3163fe21165c88658f48c473059fd3e780ec831ad48ee1dbc385e0f1a91227663bb193fd2bf4f20f1f6891017cbf0c863dfb9ee89599f5eb68f8e27d96e9daa
+  data.tar.gz: 5374e740213dfe9ffe0c5e2e7f76dc3b9f6b7dcebd5afc2292fa696e129aedc79cfe7124ba2f1971f9accaa6610d8cd45ca44b2329d60a98dd2ab0fa95ebc230

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    springboard-retail (4.3.0)
+    springboard-retail (5.0.0.beta1)
+      faraday
       hashie
       json (>= 1.7.4)
-      patron (= 0.4.18)
 
 GEM
   remote: https://rubygems.org/
@@ -23,13 +23,15 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    faraday (0.15.3)
+      multipart-post (>= 1.2, < 3)
     hashie (3.6.0)
     json (2.1.0)
     method_source (0.8.2)
     mime-types (2.4.3)
     multi_json (1.11.0)
+    multipart-post (2.0.0)
     netrc (0.10.3)
-    patron (0.4.18)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)

data/README.md

@@ -7,7 +7,7 @@
 
 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.
 
-It is a wrapper around the [Patron](http://toland.github.com/patron/) HTTP client library. Supports MRI 1.9+.
+It is a wrapper around the [Faraday](https://github.com/lostisland/faraday) HTTP client library.
 
 You can find [documentation here](http://rdoc.info/github/springboardretail/springboard-client-ruby).
 

data/Rakefile

@@ -11,6 +11,7 @@ task :default => :spec
 desc "Start a console with a Springboard::Client instance"
 task :console do
   require 'springboard/client'
+  require 'pry'
   CLIENT = Springboard::Client.new(ENV['URI'])
   CLIENT.auth :username => ENV['USER'], :password => ENV['PASSWORD']
   Pry.start

data/lib/springboard/client.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
-require 'patron'
+require 'faraday'
 require 'json'
+require 'logger'
 
 require 'springboard/client/errors'
 
@@ -33,6 +34,10 @@ module Springboard
     # @return [URI] The client's base URI
     attr_reader :base_uri
 
+    ##
+    # @return [Faraday::Connection] Faraday's connection
+    attr_reader :connection
+
     ##
     # @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.
@@ -40,17 +45,8 @@ module Springboard
     # @option opts [String] :token Springboard API Token
     def initialize(base_uri, opts={})
       @base_uri = URI.parse(base_uri)
-      configure_session(base_uri, opts)
-    end
-
-    ##
-    # Returns the underlying Patron session
-    #
-    # @see http://patron.rubyforge.org/Patron/Session.html Patron::Session docs
-    #
-    # @return [Patron::Session]
-    def session
-      @session ||= Patron::Session.new
+      @opts = opts
+      configure_connection!
     end
 
     ##
@@ -61,7 +57,8 @@ module Springboard
     #
     # @return [String, Boolean] The debug argument
     def debug=(debug)
-      session.enable_debug(debug == true ? nil : debug)
+      @opts[:debug] = debug
+      configure_connection!
     end
 
     ##
@@ -85,7 +82,13 @@ module Springboard
         :password => opts[:password]
       response = post '/auth/identity/callback', body,
         'Content-Type' => 'application/x-www-form-urlencoded'
-      response.success? or raise AuthFailed, "Springboard auth failed"
+
+      if response.success?
+        @session_cookie = response.headers['set-cookie']
+        return true
+      else
+        raise AuthFailed, "Springboard auth failed"
+      end
     end
 
     ##
@@ -214,20 +217,26 @@ module Springboard
 
     private
 
+    attr_reader :opts, :session_cookie
+
     def prepare_request_body(body)
       body.is_a?(Hash) ? JSON.dump(body) : body
     end
 
     def make_request(method, uri, headers=false, body=false)
-      args = [prepare_uri(uri).to_s]
-      args.push prepare_request_body(body) unless body === false
-      args.push headers unless headers === false
-      new_response session.__send__(method, *args)
+      response = connection.__send__( method, prepare_uri(uri)) do |request|
+        request.headers = headers unless headers === false
+        request.headers['Cookie'] = session_cookie if session_cookie
+
+        request.body = prepare_request_body(body) unless body === false
+      end
+
+      new_response(response)
     end
 
     def raise_on_fail(response)
       if !response.success?
-        error = RequestFailed.new "Request failed with status: #{response.status_line}"
+        error = RequestFailed.new "Request failed with status: #{response.status}"
         error.response = response
         raise error
       end
@@ -236,22 +245,35 @@ module Springboard
 
     def prepare_uri(uri)
       uri = URI.parse(uri)
-      uri.to_s.gsub(/^#{base_uri.to_s}|^#{base_uri.path}/, '')
+      uri.to_s
+        .gsub(/^#{base_uri.to_s}|^#{base_uri.path}/, '')
+        .gsub(/^\//, '')
     end
 
-    def new_response(patron_response)
-      Response.new patron_response, self
+    def new_response(faraday_response)
+      Response.new faraday_response, self
+    end
+
+    def configure_connection!
+      @connection = Faraday.new
+
+      connection.url_prefix= base_uri.to_s
+
+      connection.headers['Content-Type'] = 'application/json'
+      connection.headers['Authorization'] = "Bearer #{opts[:token]}" if opts[:token]
+
+      connection.ssl[:verify] = false if opts.has_key?(:insecure)
+
+      connection.options.timeout  = DEFAULT_TIMEOUT
+      connection.options.open_timeout = DEFAULT_CONNECT_TIMEOUT
+
+      if debug = opts[:debug]
+        connection.response :logger, debug_logger(debug), bodies: true
+      end
     end
 
-    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
-      session.connect_timeout = DEFAULT_CONNECT_TIMEOUT
-      self.debug = opts[:debug] if opts.has_key?(:debug)
+    def debug_logger(debug)
+      Logger.new(debug == true ? STDOUT : debug)
     end
   end
 end

data/lib/springboard/client/response.rb

@@ -44,9 +44,9 @@ module Springboard
       end
 
       ##
-      # Delegates missing methods to the underlying Patron::Response.
+      # Delegates missing methods to the underlying Faraday::Response.
       #
-      # @see http://patron.rubyforge.org/Patron/Response.html Patron::Response docs
+      # @see https://www.rubydoc.info/gems/faraday/Faraday/Response Faraday::Response docs
       def method_missing(method, *args, &block)
         @response.respond_to?(method) ? @response.__send__(method, *args, &block) : super
       end

data/spec/shared_client_context.rb

@@ -1,5 +1,5 @@
 shared_context "client" do
   let(:base_url) { "http://bozo.com/api" }
   let(:client) { Springboard::Client.new(base_url) }
-  let(:session) { client.session }
+  let(:connection) { client.connection }
 end

data/spec/springboard/client/response_spec.rb

@@ -4,11 +4,16 @@ describe Springboard::Client::Response do
   include_context "client"
 
   let(:raw_body) { '{"key":"value"}' }
-  let(:raw_headers) { 'X-Custom-Header: Hi' }
+  let(:raw_headers) { { 'X-Custom-Header' => 'Hi' } }
   let(:status_code) { 200 }
   let(:path) { '/path' }
-  let(:patron_response) { Patron::Response.new(path, status_code, 0, raw_headers, raw_body) }
-  let(:response) { Springboard::Client::Response.new(patron_response, client) }
+  let(:faraday_response) do
+    env = Faraday::Env.new(:get, raw_body, path, nil, nil, nil, nil,
+                           nil, raw_body, raw_headers, status_code)
+
+    Faraday::Response.new(env)
+  end
+  let(:response) { Springboard::Client::Response.new(faraday_response, client) }
 
   describe "body" do
     describe "if raw body is valid JSON" do
@@ -54,7 +59,7 @@ describe Springboard::Client::Response do
 
   describe "resource" do
     describe "when Location header is returned" do
-      let(:raw_headers) { 'Location: /new/path' }
+      let(:raw_headers) { { Location: '/new/path' } }
 
       it "should be a Springboard::Client::Resource" do
         expect(response.resource).to be_a Springboard::Client::Resource
@@ -66,7 +71,7 @@ describe Springboard::Client::Response do
     end
 
     describe "when Location header is not returned" do
-      let(:raw_headers) { '' }
+      let(:raw_headers) { Hash.new }
 
       it "should be nil" do
         expect(response.resource).to be_nil

data/spec/springboard/client_spec.rb

@@ -3,17 +3,19 @@ require 'spec_helper'
 describe Springboard::Client do
   include_context "client"
 
-  describe "session" do
-    it "should be a Patron::Session" do
-      expect(client.session).to be_a Patron::Session
+  describe "connection" do
+    it "should be a Faraday::Connection" do
+      expect(client.connection).to be_a Faraday::Connection
     end
   end
 
   describe "auth" do
     it "should attempt to authenticate with the given username and password" do
-      request_stub = stub_request(:post, "#{base_url}/auth/identity/callback").with \
+      request_stub = stub_request(:post, "#{base_url}/auth/identity/callback").with(
         :body => "auth_key=coco&password=boggle",
         :headers => {'Content-Type' => 'application/x-www-form-urlencoded'}
+      )
+
       client.auth(:username => 'coco', :password => 'boggle')
       expect(request_stub).to have_been_requested
     end
@@ -34,51 +36,55 @@ describe Springboard::Client do
       expect { client.auth(:username => 'someone', :password => 'wrong') }.to \
         raise_error(Springboard::Client::AuthFailed, "Springboard auth failed")
     end
+
+    it "should store the session cookie" do
+      stub_request(:post, "#{base_url}/auth/identity/callback").to_return(headers: {'set-cookie' => '123'})
+      client.auth(:username => 'someone', :password => 'right')
+      expect(client.instance_variable_get(:@session_cookie)).to eq('123')
+    end
   end
 
   describe "initialize" do
-    it "should call configure_session" do
-      expect_any_instance_of(Springboard::Client).to receive(:configure_session).with(base_url, {:x => 'y'})
+    it "should call configure_connection!" do
+      expect_any_instance_of(Springboard::Client).to receive(:configure_connection!)
       Springboard::Client.new(base_url, :x => 'y')
     end
   end
 
-  describe "configure_session" do
-    it "should set the session's base_url" do
-      expect(session).to receive(:base_url=).with(base_url)
-      client.__send__(:configure_session, base_url, :x => 'y')
+  describe "configure_connection" do
+    it "should set the connection's url_prefix" do
+      client.__send__(:configure_connection!)
+      expect(connection.url_prefix.to_s).to eq(base_url)
     end
 
-    it "should enable cookies" do
-      expect(session).to receive(:handle_cookies)
-      client.__send__(:configure_session, base_url, :x => 'y')
-    end
-
-    it "should allow setting insecure on the session" do
-      expect(session).to receive(:insecure=).with(true)
-      client.__send__(:configure_session, base_url, :insecure => true)
+    it "should allow setting insecure on the connection" do
+      client.__send__(:opts)[:insecure] = true
+      client.__send__(:configure_connection!)
+      expect(connection.ssl[:verify]).to be false
     end
 
     it "set the default timeout" do
-      client.__send__(:configure_session, base_url, {})
-      expect(client.session.timeout).to eq(Springboard::Client::DEFAULT_TIMEOUT)
+      client.__send__(:configure_connection!)
+      expect(connection.options.timeout).to eq(Springboard::Client::DEFAULT_TIMEOUT)
     end
 
     it "set the default connect timeout" do
-      client.__send__(:configure_session, base_url, {})
-      expect(client.session.connect_timeout).to eq(Springboard::Client::DEFAULT_CONNECT_TIMEOUT)
+      client.__send__(:configure_connection!)
+      expect(connection.options.open_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)
+        connection = double('Connection').as_null_object
+        allow(Faraday).to receive(:new).and_return(connection)
+        allow(connection).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')
+        Springboard::Client.new(base_url, token: 'token')
       end
     end
   end
@@ -110,26 +116,29 @@ describe Springboard::Client do
   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
+    it "should set opts[:debug]" do
+      logger = double
+      allow(Logger).to receive(:new).with('/path/to/log').and_return(logger)
+
+      client.debug = '/path/to/log'
+      expect(client.__send__(:opts)[:debug]).to eq('/path/to/log')
     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
+    it "should reconfigure connection" do
+      logger = double
+      allow(Logger).to receive(:new).with('/path/to/log').and_return(logger)
+
+      expect(client).to receive(:configure_connection!)
+      client.debug = '/path/to/log'
     end
   end
 
   [:get, :head, :delete].each do |method|
     bang_method = "#{method}!"
     describe method do
-      it "should call session's #{method}" do
-        expect(session).to receive(method).with('/relative/path')
+      it "should call connection's #{method}" do
+        expect(connection).to receive(method).with('relative/path')
+
         client.__send__(method, '/relative/path')
       end
 
@@ -157,7 +166,7 @@ describe Springboard::Client do
       it "should raise an exception on failure" do
         response = double(Springboard::Client::Response)
         expect(response).to receive(:success?).and_return(false)
-        expect(response).to receive(:status_line).and_return('404 Not Found')
+        expect(response).to receive(:status).and_return(404)
         expect(client).to receive(method).with('/path', false).and_return(response)
         expect { client.send(bang_method, '/path') }.to raise_error(Springboard::Client::RequestFailed)
       end
@@ -168,8 +177,12 @@ describe Springboard::Client do
   [:put, :post].each do |method|
     bang_method = "#{method}!"
     describe method do
-      it "should call session's #{method}" do
-        expect(session).to receive(method).with('/relative/path', 'body')
+      it "should call connection's #{method}" do
+        request = double.as_null_object
+
+        expect(request).to receive(:body=).with('body')
+        expect(connection).to receive(method).with('relative/path').and_yield(request)
+
         client.__send__(method, '/relative/path', 'body')
       end
 
@@ -180,8 +193,12 @@ describe Springboard::Client do
       end
 
       it "should serialize the request body as JSON if it is a hash" do
+        request = double.as_null_object
         body_hash = {:key1 => 'val1', :key2 => 'val2'}
-        expect(session).to receive(method).with('/path', body_hash.to_json)
+
+        expect(connection).to receive(method).and_yield(request)
+        expect(request).to receive(:body=).with(body_hash.to_json)
+
         client.__send__(method, '/path', body_hash)
       end
 
@@ -211,7 +228,7 @@ describe Springboard::Client do
       it "should raise an exception on failure" do
         response = double(Springboard::Client::Response)
         expect(response).to receive(:success?).and_return(false)
-        expect(response).to receive(:status_line).and_return('404 Not Found')
+        expect(response).to receive(:status).and_return(404)
         expect(client).to receive(method).with('/path', 'body', false).and_return(response)
         expect { client.send(bang_method, '/path', 'body') }.to raise_error { |error|
           expect(error).to be_a(Springboard::Client::RequestFailed)

data/springboard-retail.gemspec

@@ -1,13 +1,13 @@
 Gem::Specification.new do |s|
   s.name              = 'springboard-retail'
-  s.version           = '4.3.0'
+  s.version           = '5.0.0.beta1'
   s.platform          = Gem::Platform::RUBY
   s.authors           = ['Jay Stotz']
   s.summary           = 'Springboard Retail API client library'
 
   s.required_rubygems_version = '>= 1.3.6'
 
-  s.add_runtime_dependency 'patron', '0.4.18'
+  s.add_runtime_dependency 'faraday'
   s.add_runtime_dependency 'json', '>= 1.7.4'
   s.add_runtime_dependency 'hashie'
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: springboard-retail
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.0.0.beta1
 platform: ruby
 authors:
 - Jay Stotz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-19 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: patron
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.18
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.18
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -90,13 +90,14 @@ 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/faraday-0.15.3.gem
 - vendor/cache/hashie-3.6.0.gem
 - vendor/cache/json-2.1.0.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
+- vendor/cache/multipart-post-2.0.0.gem
 - vendor/cache/netrc-0.10.3.gem
-- vendor/cache/patron-0.4.18.gem
 - vendor/cache/pry-0.10.1.gem
 - vendor/cache/rake-10.4.2.gem
 - vendor/cache/rest-client-1.7.3.gem