protip 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25ad2e3a190f034f359fc8ca65ade0e535cb9ae6
-  data.tar.gz: 1e5a004ee50b758b10af25a4013dbb28f8aca8aa
+  metadata.gz: eacbefd07c48cf491c512855a68a820c48d44be6
+  data.tar.gz: f79accd3d4f140b5f7e6696d6c27c19e76726bce
 SHA512:
-  metadata.gz: 6cfef2853b9da32d395e76fdffaf9ffa71f527cc31da27264b54a0f338aa8a9b78b4011ea307c93e85a6285325ab3b13b371752fa048cf51df0940d1538c77b9
-  data.tar.gz: cc4d369252fc7b80a414a039d59942643e8a70a2ecdb1544ca256a3a8577f6ed0dff15a08f62a07268ff61601d37cb2d7b5a4c4a15f86af896666a7ba20fddd7
+  metadata.gz: 3359ad844b26d2792f63e09254a6266810eb09e21915be9c5fe4fdfcc0752bb70bff905d107be4edba1acfad6911040ef13885b076a54767842d8b9f2e9fefe0
+  data.tar.gz: 574b9fab112f596088f28f66119a246efd64133a1732a3193b5556457857d8edee814eb5749f957ef1b5f6ff986351486770acacbe2b2405978f0fdb79272c0a

data/lib/protip/messages/array.rb

@@ -5,7 +5,7 @@ require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "protip.messages.Array" do
-    repeated :messages, :string, 1
+    repeated :messages, :bytes, 1
   end
 end
 

data/lib/protip/wrapper.rb

@@ -109,12 +109,23 @@ module Protip
     end
 
     def as_json
-      json = {}
-      message.class.descriptor.map(&:name).each do |name|
-        value = public_send(name)
-        json[name.to_s] = value.respond_to?(:as_json) ? value.as_json : value
+      to_h.as_json
+    end
+
+    # @return [Hash] A hash whose keys are the fields of our message, and whose values are the Ruby representations
+    #   (either nested hashes or converted messages) of the field values.
+    def to_h
+      hash = {}
+      message.class.descriptor.each do |field|
+        value = public_send(field.name)
+        if field.label == :repeated
+          value.map!{|v| v.is_a?(self.class) ? v.to_h : v}
+        else
+          value = (value.is_a?(self.class) ? value.to_h : value)
+        end
+        hash[field.name.to_sym] = value
       end
-      json
+      hash
     end
 
     def ==(wrapper)
@@ -127,18 +138,25 @@ module Protip
     private
 
     def get(field)
+      if field.label == :repeated
+        message[field.name].map{|value| to_ruby_value field, value}
+      else
+        to_ruby_value field, message[field.name]
+      end
+    end
+
+    # Helper for getting values - converts the value for the given field to one that we can return to the user
+    def to_ruby_value(field, value)
       if field.type == :message
-        if nil == message[field.name]
+        if nil == value
           nil
+        elsif converter.convertible?(field.subtype.msgclass)
+          converter.to_object value
         else
-          if converter.convertible?(field.subtype.msgclass)
-            converter.to_object message[field.name]
-          else
-            self.class.new message[field.name], converter
-          end
+          self.class.new value, converter
         end
       else
-        message[field.name]
+        value
       end
     end
 

data/test/functional/protip/resource_test.rb

@@ -92,9 +92,11 @@ describe 'Protip::Resource (functional)' do
   describe '.all' do
     describe 'with a successful server response' do
       before do
+        # If this is erroring out, change :string to :bytes in array.rb - the Ruby compiler currently compiles
+        # incorrectly.
         response = Protip::Messages::Array.new(messages: ['bilbo', 'baggins'].each_with_index.map do |name, index|
           message = resource_message_class.new(id: int_message_class.new(value: index), ordered_tests: name, nested_int: int_message_class.new(value: index + 42))
-          message.class.encode(message).encode('UTF-8')
+          message.class.encode(message)
         end)
         stub_request(:get, 'https://external.service/resources')
           .to_return body: response.class.encode(response)

data/test/unit/protip/resource_test.rb

@@ -130,7 +130,7 @@ module Protip::ResourceTest # Namespace for internal constants
           messages: [
             resource_message_class.new(string: 'banjo', id: 1),
             resource_message_class.new(string: 'kazooie', id: 2),
-          ].map{|m| resource_message_class.encode(m).encode('UTF-8')}
+          ].map{|m| resource_message_class.encode(m)}
         })
       end
 

data/test/unit/protip/wrapper_test.rb

@@ -215,6 +215,69 @@ module Protip::WrapperTest # namespace for internal constants
       end
     end
 
+    describe '#convert' do
+      let :wrapped_message do
+        m = message_class.new({
+          string: 'test',
+          inner: inner_message_class.new(value: 1),
+        })
+        m.strings += %w(test1 test2)
+        [2, 3].each do |i|
+          m.inners.push inner_message_class.new(value: i)
+        end
+        m
+      end
+      before do
+        converter.stubs(:convertible?).with(message_class).returns false
+      end
+
+      it 'never checks the convertibility of the top-level message' do
+        converter.expects(:convertible?).with(message_class).never
+        converter.stubs(:convertible?).with(inner_message_class).returns false
+        assert_instance_of Hash, wrapper.to_h
+      end
+
+      describe 'with a nested convertible message' do
+        before do
+          converter.stubs(:convertible?).with(inner_message_class).returns true
+          [1, 2, 3].each{|i| converter.stubs(:to_object).with(inner_message_class.new(value: i)).returns(i)}
+        end
+        it 'returns a hash with the nested message converted' do
+          assert_equal 1, wrapper.to_h[:inner]
+        end
+        it 'converts a repeated instance of the nested message to an array' do
+          assert_equal [2, 3], wrapper.to_h[:inners]
+        end
+      end
+
+      describe 'with a nested inconvertible message' do
+        before do
+          converter.stubs(:convertible?).with(inner_message_class).returns false
+        end
+
+        it 'contains keys for all fields of the parent message' do
+          assert_equal %i(string strings inner inners inner_blank).sort, wrapper.to_h.keys.sort
+        end
+        it 'assigns nil for missing nested messages' do
+          hash = wrapper.to_h
+          assert hash.has_key?(:inner_blank)
+          assert_nil hash[:inner_blank]
+        end
+        it 'assigns a hash for a scalar instance of the inconvertible message' do
+          assert_equal({value: 1, note: ''}, wrapper.to_h[:inner])
+        end
+        it 'assigns an array of hashes for a repeated instance of the inconvertible message' do
+          assert_equal([{value: 2, note: ''}, {value: 3, note: ''}], wrapper.to_h[:inners])
+        end
+        it 'assigns primitive fields directly' do
+          assert_equal 'test', wrapper.to_h[:string]
+        end
+        it 'assigns an array for repeated primitive fields' do
+          assert_equal %w(test1 test2), wrapper.to_h[:strings]
+        end
+      end
+    end
+
     describe '#get' do
       it 'does not convert simple fields' do
         converter.expects(:convertible?).never

metadata

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