protip 0.19.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bfa2572b20c366e72093d7c071ae2cbf26302a1
-  data.tar.gz: 282b0e395f8cc7038f8fc923d3857fd936155fb9
+  metadata.gz: 4e9e8d262a3ac9f0a1164c3da1c73895c23eb868
+  data.tar.gz: 6898418d57886241026534c0a04174944a2092c2
 SHA512:
-  metadata.gz: 86dbb93f457cef7f024e954929299aaec41714db6c9966228d4c499738d16dd6347cfe07ba389c7f52af2fb3d8148ba8896154c1f037d1c1c08dfc27bbfb8a0d
-  data.tar.gz: 131be596c91854dd6e504be790c4905139f2bae872997bff9ce36f0de539266613b3f2e41f767314475c1a7e852ed138aa3b153a71fa7c9a9dce600f969ecb2e
+  metadata.gz: 58bfca0184504abdc837dc766fde21eaa164f02fc22b1b0b3318ffb654bcc909474d0c660234145b8df69de866fc7da86c4c56f8dce71d3dc0769f15d85dbc13
+  data.tar.gz: 84502680643b0aac55ffda5e833381e0f20bae12415977b1a0991e0fa564aa16bf0ec4326870d1495e451e16c0de3d511260cb6b6f8568d396f4c12e0057d1db

data/definitions/protip/extensions.proto

@@ -0,0 +1,7 @@
+syntax = "proto3";
+
+import "google/protobuf/descriptor.proto";
+
+extend google.protobuf.FieldOptions {
+  string protip_enum = 14383889;
+}

data/definitions/protip/messages/repeated_wrappers.proto

@@ -1,5 +1,7 @@
 syntax = "proto3";
 
+import public "protip/extensions.proto";
+
 package protip.messages;
 
 message RepeatedDouble {
@@ -36,4 +38,10 @@ message RepeatedString {
 
 message RepeatedBytes {
   repeated bytes values = 1;
+}
+
+// Should generally be used with the "protip_enum" option
+// for serialization to/from Ruby.
+message RepeatedEnum {
+  repeated int32 values = 1;
 }

data/definitions/protip/messages/test.proto

@@ -0,0 +1,18 @@
+// Should be temporary - enables testing our hacky enum option handling with an actual compiled file.
+// Do not depend on anything in this file.
+
+syntax = "proto3";
+
+import "protip/messages/repeated_wrappers.proto";
+import "protip/messages/wrappers.proto";
+
+package protip.messages;
+
+message EnumTest {
+  enum Enum {
+    ZERO = 0;
+    ONE = 1;
+  }
+  protip.messages.EnumValue enum = 1 [(protip_enum) = "protip.messages.EnumTest.Enum"];
+  protip.messages.RepeatedEnum enums = 2 [(protip_enum) = "protip.messages.EnumTest.Enum"];
+}

data/definitions/protip/messages/wrappers.proto

@@ -0,0 +1,9 @@
+syntax = "proto3";
+
+import public "protip/extensions.proto";
+
+package protip.messages;
+
+message EnumValue {
+  int32 value = 1;
+}

data/lib/google/protobuf/descriptor.rb

@@ -0,0 +1 @@
+# Placeholder file until Google rolls google/protobuf/descriptor into the gem

data/lib/protip/converter.rb

@@ -11,11 +11,11 @@ module Protip
       )
     end
 
-    def to_object(message)
+    def to_object(message, field)
       raise NotImplementedError.new('Must convert a message into a Ruby object')
     end
 
-    def to_message(object, message_class)
+    def to_message(object, message_class, field)
       raise NotImplementedError.new('Must convert a Ruby object into a message of the given type')
     end
   end

data/lib/protip/extensions.rb

@@ -0,0 +1,9 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: protip/extensions.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/descriptor'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+end
+

data/lib/protip/messages/repeated_wrappers.rb

@@ -3,6 +3,7 @@
 
 require 'google/protobuf'
 
+require 'protip/extensions'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "protip.messages.RepeatedDouble" do
     repeated :values, :double, 1
@@ -31,6 +32,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "protip.messages.RepeatedBytes" do
     repeated :values, :bytes, 1
   end
+  add_message "protip.messages.RepeatedEnum" do
+    repeated :values, :int32, 1
+  end
 end
 
 module Protip
@@ -44,5 +48,6 @@ module Protip
     RepeatedBool = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.RepeatedBool").msgclass
     RepeatedString = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.RepeatedString").msgclass
     RepeatedBytes = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.RepeatedBytes").msgclass
+    RepeatedEnum = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.RepeatedEnum").msgclass
   end
 end

data/lib/protip/messages/test.rb

@@ -0,0 +1,28 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: protip/messages/test.proto
+
+require 'google/protobuf'
+
+require 'protip/messages/repeated_wrappers'
+require 'protip/messages/wrappers'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "protip.messages.EnumTest" do
+    optional :enum, :message, 1, "protip.messages.EnumValue"
+    optional :enums, :message, 2, "protip.messages.RepeatedEnum"
+  end
+  add_enum "protip.messages.EnumTest.Enum" do
+    value :ZERO, 0
+    value :ONE, 1
+  end
+end
+
+module Protip
+  module Messages
+    EnumTest = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.EnumTest").msgclass
+    EnumTest::Enum = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.EnumTest.Enum").enummodule
+  end
+end
+
+# -- Protip hack until https://github.com/google/protobuf/issues/1198 is resolved
+Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.EnumTest").lookup("enum").instance_variable_set(:"@_protip_enum_value", "protip.messages.EnumTest.Enum")
+Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.EnumTest").lookup("enums").instance_variable_set(:"@_protip_enum_value", "protip.messages.EnumTest.Enum")

data/lib/protip/messages/wrappers.rb

@@ -0,0 +1,17 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: protip/messages/wrappers.proto
+
+require 'google/protobuf'
+
+require 'protip/extensions'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "protip.messages.EnumValue" do
+    optional :value, :int32, 1
+  end
+end
+
+module Protip
+  module Messages
+    EnumValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.EnumValue").msgclass
+  end
+end

data/lib/protip/standard_converter.rb

@@ -9,6 +9,7 @@ require 'protip/messages/money'
 require 'protip/messages/range'
 require 'protip/messages/repeated_wrappers'
 require 'protip/messages/types'
+require 'protip/messages/wrappers'
 require 'google/protobuf'
 module Protip
   class StandardConverter
@@ -24,15 +25,15 @@ module Protip
 
     ## Protip types
     @conversions['protip.messages.Currency'] = {
-      to_object: ->(message) { message.currency_code },
-      to_message: ->(currency_code, message_class) { message_class.new currency_code: currency_code }
+      to_object: ->(message, field) { message.currency_code },
+      to_message: ->(currency_code, message_class, field) { message_class.new currency_code: currency_code }
     }
 
     @conversions['protip.messages.Money'] = {
-      to_object: ->(message) do
+      to_object: ->(message, field) do
         ::Money.new(message.amount_cents, message.currency.currency_code)
       end,
-      to_message: ->(money, message_class) do
+      to_message: ->(money, message_class, field) do
         raise ArgumentError unless money.is_a?(::Money)
         currency = ::Protip::Messages::Currency.new(currency_code: money.currency.iso_code.to_sym)
         message_class.new(
@@ -43,16 +44,16 @@ module Protip
     }
 
     @conversions['protip.messages.Date'] = {
-      to_object: ->(message) { ::Date.new(message.year, message.month, message.day) },
-      to_message: lambda do |date, message_class|
+      to_object: ->(message, field) { ::Date.new(message.year, message.month, message.day) },
+      to_message: lambda do |date, message_class, field|
         raise ArgumentError unless date.is_a?(::Date)
         message_class.new year: date.year, month: date.month, day: date.day
       end
     }
 
     @conversions['protip.messages.Range'] = {
-      to_object: ->(message) { message.begin..message.end },
-      to_message: ->(range, message_class) do
+      to_object: ->(message, field) { message.begin..message.end },
+      to_message: ->(range, message_class, field) do
         message_class.new(begin: range.begin.to_i, end: range.end.to_i)
       end
     }
@@ -60,43 +61,76 @@ module Protip
     ## Standard wrappers
     %w(Int64 Int32 UInt64 UInt32 Double Float String Bytes).each do |type|
       @conversions["google.protobuf.#{type}Value"] = {
-        to_object: ->(message) { message.value },
-        to_message: lambda do |value, message_class|
+        to_object: ->(message, field) { message.value },
+        to_message: lambda do |value, message_class, field|
           message_class.new value: value
         end
       }
       @conversions["protip.messages.Repeated#{type}"] = {
-        to_object: ->(message) { message.values.to_a.freeze },
-        to_message: lambda do |value, message_class|
+        to_object: ->(message, field) { message.values.to_a.freeze },
+        to_message: lambda do |value, message_class, field|
           message_class.new values: (value.is_a?(Enumerable) ? value : [value])
         end
       }
     end
 
     conversions['google.protobuf.BoolValue'] = {
-      to_object: ->(message) { message.value },
-      to_message: lambda do |value, message_class|
+      to_object: ->(message, field) { message.value },
+      to_message: lambda do |value, message_class, field|
         message_class.new value: value_to_boolean(value)
       end
     }
 
     conversions['protip.messages.RepeatedBool'] = {
-      to_object: ->(message) { message.values.to_a.freeze },
-      to_message: lambda do |value, message_class|
+      to_object: ->(message, field) { message.values.to_a.freeze },
+      to_message: lambda do |value, message_class, field|
         message_class.new values: (value.is_a?(Enumerable) ? value : [value]).map{|v| value_to_boolean(v)}
       end
 
     }
 
+    conversions['protip.messages.EnumValue'] = {
+      to_object: lambda do |message, field|
+        enum_for_field(field).lookup_value(message.value) || message.value
+      end,
+      to_message: lambda do |value, message_class, field|
+        enum_value = (value.is_a?(Fixnum) ? value : enum_for_field(field).lookup_name(value.to_sym))
+        if nil == enum_value
+          raise RangeError.new('Unknown symbol value for an EnumValue field.')
+        end
+        message_class.new(value: enum_value)
+      end
+    }
+
+    conversions['protip.messages.RepeatedEnum'] = {
+      to_object: lambda do |message, field|
+        enum = enum_for_field(field)
+        message.values.map{|v| enum.lookup_value(v) || v}
+      end,
+      to_message: lambda do |values, message_class, field|
+        enum = nil # Don't look this up unless we have to
+        (values = [values]) unless values.is_a?(Enumerable) # Convert to an array if a scalar was given
+        # Convert values in the same way we do for +protip.messages.EnumValue+
+        message_class.new values: (values.map do |value|
+          if value.is_a?(Fixnum)
+            value
+          else
+            enum ||= enum_for_field(field)
+            enum.lookup_name(value.to_sym) || (raise RangeError.new('Unknown symbol value for a RepeatedEnum field.'))
+          end
+        end)
+      end
+    }
+
     ## ActiveSupport objects
     conversions['protip.messages.ActiveSupport.TimeWithZone'] = {
-      to_object: ->(message) {
+      to_object: ->(message, field) {
         ActiveSupport::TimeWithZone.new(
           Time.at(message.utc_timestamp).utc,
           ActiveSupport::TimeZone.new(message.time_zone_name)
         )
       },
-      to_message: ->(value, message_class) {
+      to_message: ->(value, message_class, field) {
         if !value.is_a?(::ActiveSupport::TimeWithZone) && (value.is_a?(Time) || value.is_a?(DateTime))
           value = ::ActiveSupport::TimeWithZone.new(value.to_time.utc, ::ActiveSupport::TimeZone.new('UTC'))
         end
@@ -113,12 +147,12 @@ module Protip
       self.class.conversions.has_key?(message_class.descriptor.name)
     end
 
-    def to_object(message)
-      self.class.conversions[message.class.descriptor.name][:to_object].call(message)
+    def to_object(message, field)
+      self.class.conversions[message.class.descriptor.name][:to_object].call(message, field)
     end
 
-    def to_message(object, message_class)
-      self.class.conversions[message_class.descriptor.name][:to_message].call(object, message_class)
+    def to_message(object, message_class, field)
+      self.class.conversions[message_class.descriptor.name][:to_message].call(object, message_class, field)
     end
 
     class << self
@@ -130,6 +164,11 @@ module Protip
         # exception)
         value
       end
+
+      private
+      def enum_for_field(field)
+        Google::Protobuf::DescriptorPool.generated_pool.lookup(field.instance_variable_get(:'@_protip_enum_value'))
+      end
     end
   end
 end

data/lib/protip/wrapper.rb

@@ -187,7 +187,7 @@ module Protip
         if nil == value
           nil
         elsif converter.convertible?(field.subtype.msgclass)
-          converter.to_object value
+          converter.to_object value, field
         elsif nested_resources.has_key?(field_name_sym)
           resource_klass = nested_resources[field_name_sym]
           resource_klass.new value
@@ -217,7 +217,7 @@ module Protip
         elsif value.is_a?(field.subtype.msgclass)
           value
         elsif converter.convertible?(field.subtype.msgclass)
-          converter.to_message value, field.subtype.msgclass
+          converter.to_message value, field.subtype.msgclass, field
         elsif nested_resources.has_key?(field.name.to_sym)
           value.message
         else

data/test/test_helper.rb

@@ -2,6 +2,5 @@ require 'minitest/autorun'
 require 'mocha/mini_test'
 require 'webmock/minitest'
 require 'minitest/stub/const'
-require 'minitest/debugger' if ENV['DEBUG']
 
 require 'minitest/pride'

data/test/unit/protip/resource_test.rb

@@ -63,6 +63,7 @@ module Protip::ResourceTest # Namespace for internal constants
         pool.lookup(name).msgclass
       end
     end
+    let(:nested_message_field) { resource_message_class.descriptor.lookup('nested_message') }
     # Stubbed API client
     let :client do
       mock.responds_like_instance_of(Class.new { include Protip::Client })
@@ -158,8 +159,8 @@ module Protip::ResourceTest # Namespace for internal constants
 
         it 'converts message types to and from their Ruby values when the converter allows' do
           converter.expects(:convertible?).at_least_once.with(nested_message_class).returns(true)
-          converter.expects(:to_message).once.with(6, nested_message_class).returns(nested_message_class.new number: 100)
-          converter.expects(:to_object).at_least_once.with(nested_message_class.new number: 100).returns 'intern'
+          converter.expects(:to_message).once.with(6, nested_message_class, nested_message_field).returns(nested_message_class.new number: 100)
+          converter.expects(:to_object).at_least_once.with(nested_message_class.new(number: 100), nested_message_field).returns 'intern'
 
           resource = resource_class.new
           resource.nested_message = 6
@@ -243,8 +244,8 @@ module Protip::ResourceTest # Namespace for internal constants
       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
+        # nested_message_field_name 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(
@@ -252,7 +253,7 @@ module Protip::ResourceTest # Namespace for internal constants
           path
           query_class
           response
-          nested_message_field
+          nested_message_field_name
           invoke_method!
         ).each do |name|
           raise "Must define #{name} before invoking `it_converts_query_parameters`" unless respond_to?(name)
@@ -262,7 +263,7 @@ module Protip::ResourceTest # Namespace for internal constants
         client.expects(:request)
           .once
           .with(method: http_method, path: path,
-            message: query_class.new(:"#{nested_message_field}" => nested_message_class.new(number: 43)),
+            message: query_class.new(:"#{nested_message_field_name}" => nested_message_class.new(number: 43)),
             response_type: (nil == response ? nil : response.class),
           ).returns(response)
       end
@@ -272,10 +273,12 @@ module Protip::ResourceTest # Namespace for internal constants
       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))
+          resource_class.converter.stubs(:to_message)
+            .with(42, nested_message_class, query_class.descriptor.lookup(nested_message_field_name.to_s))
+            .returns(nested_message_class.new(number: 43))
         end
 
-        let(:parameters) { {"#{nested_message_field}" => 42} }
+        let(:parameters) { {"#{nested_message_field_name}" => 42} }
         it 'converts query parameters' do
           invoke_method!
         end
@@ -288,14 +291,14 @@ module Protip::ResourceTest # Namespace for internal constants
         end
 
         describe 'with a hash' do
-          let(:parameters) { {"#{nested_message_field}" => {number: 43}} }
+          let(:parameters) { {"#{nested_message_field_name}" => {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)} }
+          let(:parameters) { {"#{nested_message_field_name}" => nested_message_class.new(number: 43)} }
           it 'allows a submessage to be provided directly' do
             invoke_method!
           end
@@ -398,7 +401,7 @@ module Protip::ResourceTest # Namespace for internal constants
           let(:http_method) { Net::HTTP::Get }
           let(:path) { 'base_path' }
           let(:query_class) { resource_query_class }
-          let(:nested_message_field) { :nested_message }
+          let(:nested_message_field_name) { :nested_message }
           let(:invoke_method!) { resource_class.all(parameters) }
           it_converts_query_parameters
         end
@@ -482,7 +485,7 @@ module Protip::ResourceTest # Namespace for internal constants
           let(:http_method) { Net::HTTP::Get }
           let(:path) { 'base_path/5' }
           let(:query_class) { resource_query_class }
-          let(:nested_message_field) { :nested_message }
+          let(:nested_message_field_name) { :nested_message }
           let(:invoke_method!) { resource_class.find 5, parameters }
           it_converts_query_parameters
         end
@@ -571,9 +574,9 @@ module Protip::ResourceTest # Namespace for internal constants
         describe '(message attributes)' do
           before do
             converter.stubs(:convertible?).with(nested_message_class).returns(true)
-            converter.stubs(:to_message).with(42, nested_message_class).returns(nested_message_class.new(number: 52))
-            converter.stubs(:to_object).with(nested_message_class.new(number: 52)).returns(42)
-            converter.stubs(:to_object).with(nested_message_class.new(number: 62)).returns(72)
+            converter.stubs(:to_message).with(42, nested_message_class, nested_message_field).returns(nested_message_class.new(number: 52))
+            converter.stubs(:to_object).with(nested_message_class.new(number: 52), nested_message_field).returns(42)
+            converter.stubs(:to_object).with(nested_message_class.new(number: 62), nested_message_field).returns(72)
           end
           it 'marks convertible messages as changed if they are changed as Ruby values' do
             setter.set nested_message: 42
@@ -937,7 +940,7 @@ module Protip::ResourceTest # Namespace for internal constants
           let(:http_method) { Net::HTTP::Post }
           let(:path) { path }
           let(:query_class) { action_query_class }
-          let(:nested_message_field) { :nested_message }
+          let(:nested_message_field_name) { :nested_message }
           let(:invoke_method!) { target.action(parameters) }
           it_converts_query_parameters
         end

data/test/unit/protip/standard_converter_test.rb

@@ -4,8 +4,23 @@ require 'money'
 require 'google/protobuf/wrappers'
 require 'protip/messages/active_support/time_with_zone'
 require 'protip/standard_converter'
+require 'protip/messages/test'
 
 describe Protip::StandardConverter do
+  let :pool do
+    # See https://github.com/google/protobuf/blob/master/ruby/tests/generated_code.rb for
+    # examples of field types you can add here
+    pool = Google::Protobuf::DescriptorPool.new
+    pool.build do
+      add_enum 'number' do
+        value :ZERO, 0
+        value :ONE, 1
+      end
+    end
+    pool
+  end
+  let(:enum) { pool.lookup 'number' }
+
   let(:converter) { Protip::StandardConverter.new }
 
   let(:integer_types) do
@@ -94,6 +109,8 @@ describe Protip::StandardConverter do
     end
   end
 
+  let(:field) { mock.responds_like_instance_of Google::Protobuf::FieldDescriptor }
+
   describe '#to_object' do
     it 'converts wrapper types' do
       {
@@ -104,7 +121,7 @@ describe Protip::StandardConverter do
         bytes_value   => bytes_types,
       }.each do |value, message_types|
         message_types.each do |message_class|
-          assert_equal value, converter.to_object(message_class.new value: value)
+          assert_equal value, converter.to_object(message_class.new(value: value), field)
         end
       end
     end
@@ -118,7 +135,7 @@ describe Protip::StandardConverter do
         bytes_value   => repeated_bytes_types,
       }.each do |value, message_types|
         message_types.each do |message_class|
-          result = converter.to_object(message_class.new values: [value])
+          result = converter.to_object(message_class.new(values: [value]), field)
           assert_equal [value], result
           exception = assert_raises RuntimeError do
             result << value
@@ -129,26 +146,26 @@ describe Protip::StandardConverter do
     end
 
     it 'converts dates' do
-      date = converter.to_object(::Protip::Messages::Date.new year: 2015, month: 2, day: 9)
+      date = converter.to_object(::Protip::Messages::Date.new(year: 2015, month: 2, day: 9), field)
       assert_instance_of ::Date, date
       assert_equal '2015-02-09', date.strftime
     end
 
     it 'converts ranges' do
-      range = converter.to_object(::Protip::Messages::Range.new begin: 1, end: 4)
+      range = converter.to_object(::Protip::Messages::Range.new(begin: 1, end: 4), field)
       assert_instance_of ::Range, range
       assert_equal 1..4, range
     end
 
     it 'converts currency' do
-      currency = converter.to_object(::Protip::Messages::Currency.new currency_code: :GBP)
+      currency = converter.to_object(::Protip::Messages::Currency.new(currency_code: :GBP), field)
       assert_equal :GBP, currency
     end
 
     it 'converts money' do
       message = ::Protip::Messages::Money.new amount_cents: 250,
                                               currency: (::Protip::Messages::Currency.new currency_code: :CAD)
-      money = converter.to_object(message)
+      money = converter.to_object(message, field)
       assert_instance_of ::Money, money
       assert_equal Money::Currency.new(:CAD), money.currency
       assert_equal 250, money.fractional
@@ -158,11 +175,42 @@ describe Protip::StandardConverter do
     it 'converts times with zones' do
       message = ::Protip::Messages::ActiveSupport::TimeWithZone.new utc_timestamp: 1451610000,
                                                                     time_zone_name: 'America/Los_Angeles'
-      time = converter.to_object(message)
+      time = converter.to_object(message, field)
       assert_instance_of ::ActiveSupport::TimeWithZone, time
       assert_equal 1451610000, time.to_i
       assert_equal '2015-12-31T17:00:00-08:00', time.iso8601
     end
+
+    describe 'enums' do
+      before do
+        ::Protip::StandardConverter.stubs(:enum_for_field).with(field).returns(enum)
+      end
+
+      # Make sure we mirror the behavior of an actual enum field on the message.
+      it 'converts enum values in range to symbols' do
+        message = ::Protip::Messages::EnumValue.new value: 1
+        assert_equal :ONE, converter.to_object(message, field)
+      end
+
+      it 'converts enum values out of range to integers' do
+        message = ::Protip::Messages::EnumValue.new value: 5
+        assert_equal 5, converter.to_object(message, field)
+      end
+
+      it 'converts repeated enum values in range to symbols' do
+        message = ::Protip::Messages::RepeatedEnum.new values: [0, 1]
+        assert_equal [:ZERO, :ONE], converter.to_object(message, field)
+      end
+
+      it 'converts repeated enum values out of range to integers' do
+        message = ::Protip::Messages::RepeatedEnum.new values: [3, 1, 5]
+        assert_equal [3, :ONE, 5], converter.to_object(message, field)
+      end
+    end
+  end
+
+  describe '.enum_for_field' do
+    # TODO pending https://github.com/google/protobuf/issues/1198
   end
 
   describe '#to_message' do
@@ -175,7 +223,7 @@ describe Protip::StandardConverter do
         bytes_value   => bytes_types,
       }.each do |value, message_types|
         message_types.each do |message_class|
-          assert_equal message_class.new(value: value), converter.to_message(value, message_class)
+          assert_equal message_class.new(value: value), converter.to_message(value, message_class, field)
         end
       end
     end
@@ -189,7 +237,7 @@ describe Protip::StandardConverter do
         bytes_value   => repeated_bytes_types,
       }.each do |value, message_types|
         message_types.each do |message_class|
-          assert_equal message_class.new(values: [value]), converter.to_message(value, message_class)
+          assert_equal message_class.new(values: [value]), converter.to_message(value, message_class, field)
         end
       end
     end
@@ -203,7 +251,9 @@ describe Protip::StandardConverter do
         bytes_value   => repeated_bytes_types,
       }.each do |value, message_types|
         message_types.each do |message_class|
-          assert_equal message_class.new(values: [value, value]), converter.to_message([value, value], message_class)
+          assert_equal message_class.new(values: [value, value]), converter.to_message(
+            [value, value], message_class, field
+          )
         end
       end
     end
@@ -211,23 +261,23 @@ describe Protip::StandardConverter do
     it 'converts dates' do
       date = ::Date.new(2012, 5, 7)
       assert_equal 7, date.day # Sanity check argument order
-      assert_equal ::Protip::Messages::Date.new(year: 2012, month: 5, day: 7), converter.to_message(date, ::Protip::Messages::Date)
+      assert_equal ::Protip::Messages::Date.new(year: 2012, month: 5, day: 7), converter.to_message(date, ::Protip::Messages::Date, field)
     end
 
     it 'converts ranges' do
       range = -1..34
-      assert_equal ::Protip::Messages::Range.new(begin: -1, end: 34), converter.to_message(range, ::Protip::Messages::Range)
+      assert_equal ::Protip::Messages::Range.new(begin: -1, end: 34), converter.to_message(range, ::Protip::Messages::Range, field)
     end
 
     it 'converts currency' do
       currency = :HKD
-      message = converter.to_message(currency, ::Protip::Messages::Currency)
+      message = converter.to_message(currency, ::Protip::Messages::Currency, field)
       assert_equal ::Protip::Messages::Currency.new(currency_code: currency), message
     end
 
     it 'converts money' do
       money = ::Money.new(250, 'CAD')
-      message = converter.to_message(money, ::Protip::Messages::Money)
+      message = converter.to_message(money, ::Protip::Messages::Money, field)
       assert_instance_of ::Protip::Messages::Money, message
       assert_equal ::Protip::Messages::Money.new(
                      amount_cents: money.cents,
@@ -240,21 +290,21 @@ describe Protip::StandardConverter do
     it 'converts truthy values to booleans' do
       [true, 1, '1', 't', 'T', 'true', 'TRUE', 'on', 'ON'].each do |truth_value|
         assert_equal Google::Protobuf::BoolValue.new(value: true),
-                     converter.to_message(truth_value, Google::Protobuf::BoolValue)
+                     converter.to_message(truth_value, Google::Protobuf::BoolValue, field)
       end
     end
 
     it 'converts falsey values to booleans' do
       [false, 0, '0', 'f', 'F', 'false', 'FALSE', 'off', 'OFF'].each do |false_value|
         assert_equal Google::Protobuf::BoolValue.new(value: false),
-                     converter.to_message(false_value, Google::Protobuf::BoolValue)
+                     converter.to_message(false_value, Google::Protobuf::BoolValue, field)
       end
     end
 
     it 'raises an exception if non-boolean values passed to boolean field' do
       [nil, 'test', Object.new, 2, {}, []].each do |bad_value|
         assert_raises TypeError do
-          converter.to_message(bad_value, Google::Protobuf::BoolValue)
+          converter.to_message(bad_value, Google::Protobuf::BoolValue, field)
         end
       end
     end
@@ -262,24 +312,119 @@ describe Protip::StandardConverter do
     it 'converts times with zones' do
       time_with_zone = ::ActiveSupport::TimeWithZone.new(Time.new(2016, 1, 1, 0, 0, 0, 0),
         ::ActiveSupport::TimeZone.new('America/New_York'))
-      message = converter.to_message(time_with_zone, ::Protip::Messages::ActiveSupport::TimeWithZone)
+      message = converter.to_message(time_with_zone, ::Protip::Messages::ActiveSupport::TimeWithZone, field)
       assert_equal 1451606400, message.utc_timestamp
       assert_equal 'America/New_York', message.time_zone_name
     end
 
     it 'converts times without zones' do
       time = Time.new(2016, 1, 1, 0, 0, 0, -3600)
-      message = converter.to_message(time, ::Protip::Messages::ActiveSupport::TimeWithZone)
+      message = converter.to_message(time, ::Protip::Messages::ActiveSupport::TimeWithZone, field)
       assert_equal 1451610000, message.utc_timestamp
       assert_equal 'UTC', message.time_zone_name
     end
 
     it 'converts datetimes without zones' do
       datetime = DateTime.new(2016, 1, 1, 0, 0, 0, '-1')
-      message = converter.to_message(datetime, ::Protip::Messages::ActiveSupport::TimeWithZone)
+      message = converter.to_message(datetime, ::Protip::Messages::ActiveSupport::TimeWithZone, field)
       assert_equal 1451610000, message.utc_timestamp
       assert_equal 'UTC', message.time_zone_name
 
     end
+
+    describe 'enums' do
+      before do
+        ::Protip::StandardConverter.stubs(:enum_for_field).with(field).returns(enum)
+      end
+      def convert(value)
+        converter.to_message value, message_class, field
+      end
+      %w(zero one two).each do |number| # values symbolizing as :ZERO, :ONE, :TWO
+        let number do
+          value = mock
+          value.stubs(:to_sym).returns(number.upcase.to_sym)
+          value
+        end
+      end
+
+      describe '::Protip::Messages::EnumValue' do
+        let(:message_class) { ::Protip::Messages::EnumValue }
+        # Ensure identical behavior to setting a standard enum field
+        it 'converts integers' do
+          assert_equal 1, convert(1).value, 'improper conversion of an in-range integer'
+          assert_equal 4, convert(4).value, 'improper conversion of an out-of-range integer'
+        end
+        it 'converts non-integers via to_sym' do
+          assert_equal 1, convert(one).value, 'improper conversion of non-integer value'
+        end
+        it 'throws an error when a non-existent symbol is given' do
+          assert_raises RangeError do
+            convert(two)
+          end
+        end
+      end
+
+      describe '::Protip::Messages::RepeatedEnum' do
+        let(:message_class) { ::Protip::Messages::RepeatedEnum }
+        it 'converts integers' do
+          assert_equal [1, 4], convert([1, 4]).values
+        end
+        it 'converts non-integers via to_sym' do
+          assert_equal [0, 2, 1], convert([zero, 2, one]).values
+        end
+        it 'throws an error when a non-existent symbol is given' do
+          assert_raises RangeError do
+            convert([0, two])
+          end
+        end
+        it 'allows assigning a scalar value' do
+          assert_equal [1], convert(one).values
+        end
+      end
+    end
   end
+
+  describe '(enums - functional)' do # Temp - test an actual compiled file to make sure our options hack is working
+    let(:wrapped_message) { Protip::Messages::EnumTest.new }
+    let(:wrapper) { Protip::Wrapper.new wrapped_message, converter }
+
+    let(:value_map) do
+      {
+        :ONE => :ONE,
+        1 => :ONE,
+        2 => 2,
+      }
+    end
+
+    it 'allows setting and getting a scalar field by Ruby value' do
+      value_map.each do |value, expected|
+        wrapper.enum = value
+        assert_equal expected, wrapper.enum
+      end
+      assert_raises RangeError do
+        wrapper.enum = :TWO
+      end
+    end
+    it 'allows setting and getting a scalar field by message' do
+      wrapper.enum = ::Protip::Messages::EnumValue.new(value: 1)
+      assert_equal :ONE, wrapper.enum
+    end
+
+    it 'allows setting and getting a repeated field by Ruby value' do
+      value_map.each do |value, expected|
+        wrapper.enums = [value]
+        assert_equal [expected], wrapper.enums
+      end
+      assert_raises RangeError do
+        wrapper.enums = [:TWO]
+      end
+    end
+    it 'allows setting and geting a repeated field by message' do
+      wrapper.enums = ::Protip::Messages::RepeatedEnum.new(values: [2])
+      assert_equal [2], wrapper.enums
+    end
+
+
+  end
+
 end

data/test/unit/protip/wrapper_test.rb

@@ -59,6 +59,7 @@ module Protip::WrapperTest # namespace for internal constants
         pool.lookup(name).msgclass
       end
     end
+    let (:inner_message_field) { message_class.descriptor.lookup('inner') }
 
     # Stubbed API client
     let :client do
@@ -209,7 +210,7 @@ module Protip::WrapperTest # namespace for internal constants
         end
 
         it 'converts scalar Ruby values to protobuf messages' do
-          converter.expects(:to_message).once.with(45, inner_message_class).returns(inner_message_class.new(value: 43))
+          converter.expects(:to_message).once.with(45, inner_message_class, inner_message_field).returns(inner_message_class.new(value: 43))
           wrapper.assign_attributes inner: 45
           assert_equal inner_message_class.new(value: 43), wrapped_message.inner
         end
@@ -329,7 +330,7 @@ module Protip::WrapperTest # namespace for internal constants
       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)}
+          [1, 2, 3].each{|i| converter.stubs(:to_object).with(inner_message_class.new(value: i), anything).returns(i)}
         end
         it 'returns a hash with the nested message converted' do
           assert_equal 1, wrapper.to_h[:inner]
@@ -385,7 +386,7 @@ module Protip::WrapperTest # namespace for internal constants
 
       it 'converts convertible messages' do
         converter.expects(:convertible?).with(inner_message_class).once.returns(true)
-        converter.expects(:to_object).once.with(inner_message_class.new(value: 25)).returns 40
+        converter.expects(:to_object).once.with(inner_message_class.new(value: 25), inner_message_field).returns 40
         assert_equal 40, wrapper.inner
       end
 
@@ -445,7 +446,7 @@ module Protip::WrapperTest # namespace for internal constants
 
       it 'converts convertible messages' do
         converter.expects(:convertible?).at_least_once.with(inner_message_class).returns(true)
-        converter.expects(:to_message).with(40, inner_message_class).returns(inner_message_class.new(value: 30))
+        converter.expects(:to_message).with(40, inner_message_class, inner_message_field).returns(inner_message_class.new(value: 30))
 
         wrapper.inner = 40
         assert_equal inner_message_class.new(value: 30), wrapper.message.inner

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protip
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.20.0
 platform: ruby
 authors:
 - AngelList
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-08 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -98,20 +98,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest-stub-const
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +179,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - definitions/google/protobuf/wrappers.proto
+- definitions/protip/extensions.proto
 - definitions/protip/messages/active_support/time_with_zone.proto
 - definitions/protip/messages/array.proto
 - definitions/protip/messages/currency.proto
@@ -200,12 +187,16 @@ files:
 - definitions/protip/messages/money.proto
 - definitions/protip/messages/range.proto
 - definitions/protip/messages/repeated_wrappers.proto
+- definitions/protip/messages/test.proto
 - definitions/protip/messages/types.proto
+- definitions/protip/messages/wrappers.proto
+- lib/google/protobuf/descriptor.rb
 - lib/google/protobuf/wrappers.rb
 - lib/protip.rb
 - lib/protip/client.rb
 - lib/protip/converter.rb
 - lib/protip/error.rb
+- lib/protip/extensions.rb
 - lib/protip/messages/active_support/time_with_zone.rb
 - lib/protip/messages/array.rb
 - lib/protip/messages/currency.rb
@@ -213,7 +204,9 @@ files:
 - lib/protip/messages/money.rb
 - lib/protip/messages/range.rb
 - lib/protip/messages/repeated_wrappers.rb
+- lib/protip/messages/test.rb
 - lib/protip/messages/types.rb
+- lib/protip/messages/wrappers.rb
 - lib/protip/resource.rb
 - lib/protip/resource/associations/association.rb
 - lib/protip/resource/associations/belongs_to_association.rb