protip 0.11.1 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eacbefd07c48cf491c512855a68a820c48d44be6
-  data.tar.gz: f79accd3d4f140b5f7e6696d6c27c19e76726bce
+  metadata.gz: 8ab7e84f6fd394d2b5cb52c67d1a5db5f245c36a
+  data.tar.gz: 4726d4e87f0453b0c2bd0bc55c2ac52ff23c58e3
 SHA512:
-  metadata.gz: 3359ad844b26d2792f63e09254a6266810eb09e21915be9c5fe4fdfcc0752bb70bff905d107be4edba1acfad6911040ef13885b076a54767842d8b9f2e9fefe0
-  data.tar.gz: 574b9fab112f596088f28f66119a246efd64133a1732a3193b5556457857d8edee814eb5749f957ef1b5f6ff986351486770acacbe2b2405978f0fdb79272c0a
+  metadata.gz: 4721c4d9f10135735502dccfb105532d4b6b31a74dcda08b1298bb0cc9bec791897c90002997c826cf399fb3953018bfdab5f5e62710834ccf99a21d5a5c458f
+  data.tar.gz: cde835698f8a9feb4eb3743b7c3bfdd5ab2bb0e42d0963cb0ebd1849aa96640d6f2169db6302901ca1a4e4e33c5385ce16ae2e86efb674672dbbb5ff1114aa28

data/lib/protip/resource.rb

@@ -178,13 +178,17 @@ module Protip
         if query
           if actions.include?(:show)
             define_singleton_method :find do |id, query_params = {}|
-              SearchMethods.show(self, id, query.new(query_params))
+              wrapper = ::Protip::Wrapper.new(query.new, converter)
+              wrapper.assign_attributes query_params
+              SearchMethods.show(self, id, wrapper.message)
             end
           end
 
           if actions.include?(:index)
             define_singleton_method :all do |query_params = {}|
-              SearchMethods.index(self, query.new(query_params))
+              wrapper = ::Protip::Wrapper.new(query.new, converter)
+              wrapper.assign_attributes query_params
+              SearchMethods.index(self, wrapper.message)
             end
           end
         else
@@ -209,7 +213,9 @@ module Protip
       def member(action:, method:, request: nil, response: nil)
         if request
           define_method action do |request_params = {}|
-            ExtraMethods.member self, action, method, request.new(request_params), response
+            wrapper = ::Protip::Wrapper.new(request.new, self.class.converter)
+            wrapper.assign_attributes request_params
+            ExtraMethods.member self, action, method, wrapper.message, response
           end
         else
           define_method action do
@@ -221,7 +227,9 @@ module Protip
       def collection(action:, method:, request: nil, response: nil)
         if request
           define_singleton_method action do |request_params = {}|
-            ExtraMethods.collection self, action, method, request.new(request_params), response
+            wrapper = ::Protip::Wrapper.new(request.new, converter)
+            wrapper.assign_attributes request_params
+            ExtraMethods.collection self, action, method, wrapper.message, response
           end
         else
           define_singleton_method action do

data/test/unit/protip/resource_test.rb

@@ -21,6 +21,7 @@ module Protip::ResourceTest # Namespace for internal constants
 
         add_message 'resource_query' do
           optional :param, :string, 1
+          optional :nested_message, :message, 2, 'nested_message'
         end
 
         # Give these things a different structure than resource_query_class,
@@ -28,6 +29,7 @@ module Protip::ResourceTest # Namespace for internal constants
         # type but still yielding correct results.
         add_message 'action_query' do
           optional :param, :string, 4
+          optional :nested_message, :message, 5, 'nested_message'
         end
         add_message 'action_response' do
           optional :response, :string, 3
@@ -124,6 +126,73 @@ module Protip::ResourceTest # Namespace for internal constants
       end
     end
 
+    # index/find/member/collection actions should all convert more complex Ruby objects to submessages in their
+    # queries
+    def self.it_converts_query_parameters
+      before do
+        # Sanity check - the user should specify all these variables in "let" statements
+        # http_method, path, query_class, and response specify the expected call to the client
+        # nested_message_field specifies the field on the query class that may or may not be convertible, and should
+        #   refer to a submessage field of type nested_message_class
+        # invoke_method! should call the desired method, assuming that +parameters+ contains the query parameters to
+        #   pass in (e.g. `resource_class.all(parameters)` or `resource_class.find('id', parameters)`)
+        %i(
+          http_method
+          path
+          query_class
+          response
+          nested_message_field
+          invoke_method!
+        ).each do |name|
+          raise "Must define #{name} before invoking `it_converts_query_parameters`" unless respond_to?(name)
+        end
+
+        # All tests expect the same HTTP call
+        client.expects(:request)
+          .once
+          .with(method: http_method, path: path,
+            message: query_class.new(:"#{nested_message_field}" => nested_message_class.new(number: 43)),
+            response_type: (nil == response ? nil : response.class),
+          ).returns(response)
+      end
+
+
+
+      describe 'with a convertible message' do
+        before do
+          resource_class.converter.stubs(:convertible?).with(nested_message_class).returns(true)
+          resource_class.converter.stubs(:to_message).with(42, nested_message_class).returns(nested_message_class.new(number: 43))
+        end
+
+        let(:parameters) { {"#{nested_message_field}" => 42} }
+        it 'converts query parameters' do
+          invoke_method!
+        end
+      end
+
+      describe 'with an inconvertible message' do
+        before do
+          resource_class.converter.stubs(:convertible?).with(nested_message_class).returns(false)
+          resource_class.converter.expects(:to_message).never
+        end
+
+        describe 'with a hash' do
+          let(:parameters) { {"#{nested_message_field}" => {number: 43}} }
+          it 'allows a hash to be provided for the nested message' do
+            invoke_method!
+          end
+        end
+
+        describe 'with a submessage' do
+          let(:parameters) { {"#{nested_message_field}" => nested_message_class.new(number: 43)} }
+          it 'allows a submessage to be provided directly' do
+            invoke_method!
+          end
+        end
+      end
+    end
+
+
     describe '.all' do
       let :response do
         Protip::Messages::Array.new({
@@ -213,6 +282,15 @@ module Protip::ResourceTest # Namespace for internal constants
           .returns(response)
           resource_class.all
         end
+
+        describe '(convertibility)' do
+          let(:http_method) { Net::HTTP::Get }
+          let(:path) { 'base_path' }
+          let(:query_class) { resource_query_class }
+          let(:nested_message_field) { :nested_message }
+          let(:invoke_method!) { resource_class.all(parameters) }
+          it_converts_query_parameters
+        end
       end
     end
 
@@ -288,6 +366,15 @@ module Protip::ResourceTest # Namespace for internal constants
             .returns(response)
           resource_class.find 6
         end
+
+        describe '(convertibility)' do
+          let(:http_method) { Net::HTTP::Get }
+          let(:path) { 'base_path/5' }
+          let(:query_class) { resource_query_class }
+          let(:nested_message_field) { :nested_message }
+          let(:invoke_method!) { resource_class.find 5, parameters }
+          it_converts_query_parameters
+        end
       end
     end
 
@@ -537,6 +624,8 @@ module Protip::ResourceTest # Namespace for internal constants
           end
         end
 
+        let(:response) { nil }
+
         it 'sends a request with a body to the expected endpoint' do
           client.expects(:request)
             .once
@@ -554,6 +643,15 @@ module Protip::ResourceTest # Namespace for internal constants
             .returns(nil)
           target.action
         end
+
+        describe '(convertibility)' do
+          let(:http_method) { Net::HTTP::Post }
+          let(:path) { path }
+          let(:query_class) { action_query_class }
+          let(:nested_message_field) { :nested_message }
+          let(:invoke_method!) { target.action(parameters) }
+          it_converts_query_parameters
+        end
       end
 
       describe 'with a response type' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protip
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.11.2
 platform: ruby
 authors:
 - AngelList
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-13 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel