springboard-retail 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d9770a0c5bb9a5076f573cace057df69eb35278
-  data.tar.gz: 1688bf41e05ac367c0c331df7615a44449c59048
+SHA256:
+  metadata.gz: 13eaf04ac55ef152f9c444f235656ad9899634d173aff26f6d87d287d9c07b94
+  data.tar.gz: ec8edecf083f85ce0750ba307080a00044daff4020acd8defd2ef6ce50ea45f2
 SHA512:
-  metadata.gz: bc11ebe786dbda84a438fba1b21ff38fe4b4d03da694eb078df9d88e5ca986eea4e570369ba656b2115639c210d8971a7d4a19a8bd347cebac3a8caee08465d1
-  data.tar.gz: 3dea0c75be77495585c9476cd9b04eaf6ff1aa86bdf2ff13aef27450443f6fdfcad92a2c43a6a328768a3a9dfc1ab2f31bcd6fcb69a275d1aa93b42f6a2c9b9a
+  metadata.gz: 158b90cf3fe6e854ec8aaa1ca77d503e7b43e3ce7aa106ad832bb5e85e3b6cde8712f6981d6f49827605d1fa636ed7dfb271edd32de805dac2deeac10412bf6d
+  data.tar.gz: 00e9ce7b716561a0994c06e2f8c78159f68346999f063cad57f9fb11ab2e1e5a1b66cef00849a5ee34950156ee81d1c6b37c287988783ba7a73cc2fcb7991d3a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    springboard-retail (4.1.1)
+    springboard-retail (4.2.0)
       addressable (~> 2.2.8)
       hashie
       json (>= 1.7.4)
@@ -24,8 +24,8 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    hashie (3.5.5)
-    json (2.0.3)
+    hashie (3.5.7)
+    json (2.1.0)
     method_source (0.8.2)
     mime-types (2.4.3)
     multi_json (1.11.0)
@@ -80,4 +80,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.14.4
+   1.16.2

data/README.md

@@ -103,6 +103,19 @@ resource.sort(:description, :created_at).filter(:active => true).each do |item|
 end
 ```
 
+### Returning select fields
+Resources have a `only` method that accepts any number of field keys to return only the selected fields. Note that each call to `only` overwrites any previous fields.
+
+```ruby
+resource.only(:id)
+resource.only(:public_id, :updated_at)
+
+# returns a new resource for chaining:
+resource.only(:public_id, :updated_at).filter(:active => true).each do |item|
+  # ...
+end
+```
+
 ### Creating Resources
 
 Create a new resource via POST:

data/lib/springboard/client.rb

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'patron'
-require 'addressable/uri'
 require 'json'
 
 require 'springboard/client/errors'
@@ -18,10 +17,6 @@ module Springboard
   # Provides direct access to the URI-oriented interface via the HTTP methods.
   # Provides access to the URI-oriented interface via the {#[]} method.
   class Client
-    ##
-    # Alias for {Addressable::URI}
-    URI = Addressable::URI
-
     ##
     # Default number of records per page when iterating over collection resources
     DEFAULT_PER_PAGE = 20
@@ -85,7 +80,7 @@ module Springboard
       unless opts[:username] && opts[:password]
         raise "Must specify :username and :password"
       end
-      body = URI.form_encode \
+      body = ::Addressable::URI.form_encode \
         :auth_key => opts[:username],
         :password => opts[:password]
       response = post '/auth/identity/callback', body,
@@ -265,4 +260,4 @@ end
 require 'springboard/client/resource'
 require 'springboard/client/response'
 require 'springboard/client/body'
-require 'springboard/client/uri_ext'
+require 'springboard/client/uri'

data/lib/springboard/client/collection.rb

@@ -79,6 +79,19 @@ module Springboard
         query('sort' => sorts)
       end
 
+      ##
+      # Returns a new resource with the given fields added to the query string as _only parameters.
+      #
+      # @example
+      #    resource.only('id', :public_id)
+      #
+      # @param [#to_s] returns One or more fields
+      #
+      # @return [Resource]
+      def only(*fields)
+        query('_only' => fields)
+      end
+
       ##
       # Performs a request to get the first result of the first page of the 
       # collection and returns it.

data/lib/springboard/client/uri.rb

@@ -0,0 +1,96 @@
+require 'addressable/uri'
+
+module Springboard
+  class Client
+    ##
+    # A wrapper around Addressable::URI
+    class URI
+      ##
+      # Returns a URI object based on the parsed string.
+      #
+      # @return [URI]
+      def self.parse(value)
+        return value if value.is_a?(self)
+        new(::Addressable::URI.parse(value))
+      end
+
+      ##
+      # Joins several URIs together.
+      #
+      # @return [URI]
+      def self.join(*args)
+        new(::Addressable::URI.join(*args))
+      end
+
+      ##
+      # Creates a new URI object from an Addressable::URI
+      #
+      # @return [URI]
+      def initialize(uri)
+        @uri = uri
+      end
+
+      ##
+      # Returns a new URI with the given subpath appended to it. Ensures a single
+      # forward slash between the URI's path and the given subpath.
+      #
+      # @return [URI]
+      def subpath(subpath)
+        uri = dup
+        uri.path = "#{path}/" unless path.end_with?('/')
+        uri.join subpath.to_s.gsub(/^\//, '')
+      end
+
+      ##
+      # Merges the given hash of query string parameters and values with the URI's
+      # existing query string parameters (if any).
+      def merge_query_values!(values)
+        self.springboard_query_values = (self.query_values || {}).merge(normalize_query_hash(values))
+      end
+
+      def ==(other_uri)
+        return false unless other_uri.is_a?(self.class)
+        uri == other_uri.__send__(:uri)
+      end
+
+      private
+
+      attr_reader :uri
+
+      def springboard_query_values=(values)
+        retval = self.query_values = normalize_query_hash(values)
+        # Hack to strip digits from Addressable::URI's subscript notation
+        self.query = self.query.gsub(/\[\d+\]=/, '[]=')
+        retval
+      end
+
+      def self.delegate_and_wrap(*methods)
+        methods.each do |method|
+          define_method(method) do |*args, &block|
+            result = @uri.__send__(method, *args, &block)
+            if result.is_a?(Addressable::URI)
+              self.class.new(result)
+            else
+              result
+            end
+          end
+        end
+      end
+
+      delegate_and_wrap(
+        :join, :path, :path=, :form_encode, :to_s,
+        :query_values, :query_values=, :query, :query=
+      )
+
+      def normalize_query_hash(hash)
+        hash.inject({}) do |copy, (k, v)|
+          copy[k.to_s] = case v
+            when Hash then normalize_query_hash(v)
+            when true, false then v.to_s
+            else v end
+          copy
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -5,8 +5,13 @@ require 'springboard-retail'
 require 'webmock/rspec'
 require 'shared_client_context'
 
+RSpec.configure do |c|
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+end
+
 class String
   def to_uri
-    Addressable::URI.parse(self)
+    Springboard::Client::URI.parse(self)
   end
 end

data/spec/springboard/client/resource_spec.rb

@@ -97,6 +97,16 @@ describe Springboard::Client::Resource do
     end
   end
 
+  describe "only" do
+    it "should set the _only parameter based on the given values" do
+      expect(resource.only('f1', 'f2').uri.query).to eq('_only[]=f1&_only[]=f2')
+    end
+
+    it "should replace the existing _only parameters" do
+      expect(resource.only('f1').only('f2', 'f3').uri.query).to eq('_only[]=f2&_only[]=f3')
+    end
+  end
+
   %w{count each each_page}.each do |method|
     describe method do
       it "should call the client's #{method} method with the resource's URI" do

data/spec/springboard/client/{uri_ext_spec.rb → uri_spec.rb}

@@ -1,13 +1,42 @@
 require 'spec_helper'
 
-describe Addressable::URI do
-  let(:uri) { Addressable::URI.parse('/relative/path') }
+describe Springboard::Client::URI do
+  let(:uri) { described_class.parse('/relative/path') }
 
   describe "subpath" do
     it "should return a new URI with the path relative to the receiver" do
-      expect(uri.subpath('other')).to eq(Addressable::URI.parse('/relative/path/other'))
-      expect(uri.subpath('/other')).to eq(Addressable::URI.parse('/relative/path/other'))
-      uri.subpath(Addressable::URI.parse('/other')) == Addressable::URI.parse('/relative/path/other')
+      expect(uri.subpath('other')).to eq(described_class.parse('/relative/path/other'))
+      expect(uri.subpath('/other')).to eq(described_class.parse('/relative/path/other'))
+      uri.subpath(described_class.parse('/other')) == described_class.parse('/relative/path/other')
+    end
+  end
+
+  describe "parse" do
+    it "should return a URI based on the given string" do
+      uri = described_class.parse('/some_path')
+      expect(uri).to be_a(described_class)
+      expect(uri.to_s).to eq('/some_path')
+    end
+  end
+
+  describe "==" do
+    it "should consider two URIs parsed from the same string equal" do
+      expect(
+        described_class.parse('http://example.com/some_path?a=1&b=2') ==
+        described_class.parse('http://example.com/some_path?a=1&b=2')
+      ).to be(true)
+    end
+
+    it "should consider two URIs parsed from different strings not equal" do
+      expect(
+        described_class.parse('http://example.com/some_path?a=1&b=2') ==
+        described_class.parse('http://example.com/some_path?a=1&c=3')
+      ).to be(false)
+
+      expect(
+        described_class.parse('http://foo.example.com') ==
+        described_class.parse('http://bar.example.com')
+      ).to be(false)
     end
   end
 

data/springboard-retail.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'springboard-retail'
-  s.version           = '4.1.1'
+  s.version           = '4.2.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.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Jay Stotz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: patron
@@ -88,13 +88,13 @@ files:
 - lib/springboard/client/errors.rb
 - lib/springboard/client/resource.rb
 - lib/springboard/client/response.rb
-- lib/springboard/client/uri_ext.rb
+- lib/springboard/client/uri.rb
 - spec/shared_client_context.rb
 - spec/spec_helper.rb
 - spec/springboard/client/body_spec.rb
 - spec/springboard/client/resource_spec.rb
 - spec/springboard/client/response_spec.rb
-- spec/springboard/client/uri_ext_spec.rb
+- spec/springboard/client/uri_spec.rb
 - spec/springboard/client_spec.rb
 - springboard-retail.gemspec
 - vendor/cache/addressable-2.2.8.gem
@@ -146,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Springboard Retail API client library

data/lib/springboard/client/uri_ext.rb

@@ -1,51 +0,0 @@
-module Springboard
-  class Client
-    ##
-    # Extensions to the Addressable::URI class.
-    module URIExt
-      ##
-      # Returns a new URI with the given subpath appended to it. Ensures a single
-      # forward slash between the URI's path and the given subpath.
-      def subpath(subpath)
-        uri = dup
-        uri.path = "#{path}/" unless path.end_with?('/')
-        uri.join subpath.to_s.gsub(/^\//, '')
-      end
-
-      ##
-      # Merges the given hash of query string parameters and values with the URI's
-      # existing query string parameters (if any).
-      def merge_query_values!(values)
-        self.springboard_query_values = (self.query_values || {}).merge(normalize_query_hash(values))
-      end
-
-      private
-
-      def springboard_query_values=(values)
-        retval = self.query_values = normalize_query_hash(values)
-        # Hack to strip digits from Addressable::URI's subscript notation
-        self.query = self.query.gsub(/\[\d+\]=/, '[]=')
-        retval
-      end
-
-      def normalize_query_hash(hash)
-        hash.inject({}) do |copy, (k, v)|
-          copy[k.to_s] = case v
-            when Hash then normalize_query_hash(v)
-            when true, false then v.to_s
-            else v end
-          copy
-        end
-      end
-    end
-  end
-end
-
-##
-# We include Springboard::Client::URIExt into Addressable::URI because its design
-# doesn't support subclassing.
-#
-# @see http://addressable.rubyforge.org/api/Addressable/URI.html Addressable::URI docs
-class Addressable::URI
-  include Springboard::Client::URIExt
-end