protip 0.10.7 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b850dce0ab76a3cf657edf39432495b52dad7a77
-  data.tar.gz: b701dbeccd7c35c6498eeb352c0afbda121874e2
+  metadata.gz: 25ad2e3a190f034f359fc8ca65ade0e535cb9ae6
+  data.tar.gz: 1e5a004ee50b758b10af25a4013dbb28f8aca8aa
 SHA512:
-  metadata.gz: 960d989e26b5814b3ef5064629e00217f616398ba52bea8633e7a27deea3e34495ec7748d1fba1bca7b920bfcac74dfab711f6c528e1d3b7c58093a0470dc6bb
-  data.tar.gz: cb11b1de1015d05d34e3db6aae61fcfde9b7d943b5d77ee1a88a2bc7cf1815bb19d0aff57a2953b6f549edcf2d068eb4e9cdbc1e75e2efbcab5599d83a02736e
+  metadata.gz: 6cfef2853b9da32d395e76fdffaf9ffa71f527cc31da27264b54a0f338aa8a9b78b4011ea307c93e85a6285325ab3b13b371752fa048cf51df0940d1538c77b9
+  data.tar.gz: cc4d369252fc7b80a414a039d59942643e8a70a2ecdb1544ca256a3a8577f6ed0dff15a08f62a07268ff61601d37cb2d7b5a4c4a15f86af896666a7ba20fddd7

data/definitions/google/protobuf/wrappers.proto

@@ -0,0 +1,99 @@
+// Protocol Buffers - Google's data interchange format
+// Copyright 2008 Google Inc.  All rights reserved.
+// https://developers.google.com/protocol-buffers/
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//     * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+// Wrappers for primitive (non-message) types. These types are useful
+// for embedding primitives in the `google.protobuf.Any` type and for places
+// where we need to distinguish between the absence of a primitive
+// typed field and its default value.
+
+syntax = "proto3";
+
+package google.protobuf;
+
+option java_multiple_files = true;
+option java_outer_classname = "WrappersProto";
+option java_package = "com.google.protobuf";
+option csharp_namespace = "Google.Protobuf.WellKnownTypes";
+option objc_class_prefix = "GPB";
+
+
+// Wrapper message for double.
+message DoubleValue {
+  // The double value.
+  double value = 1;
+}
+
+// Wrapper message for float.
+message FloatValue {
+  // The float value.
+  float value = 1;
+}
+
+// Wrapper message for int64.
+message Int64Value {
+  // The int64 value.
+  int64 value = 1;
+}
+
+// Wrapper message for uint64.
+message UInt64Value {
+  // The uint64 value.
+  uint64 value = 1;
+}
+
+// Wrapper message for int32.
+message Int32Value {
+  // The int32 value.
+  int32 value = 1;
+}
+
+// Wrapper message for uint32.
+message UInt32Value {
+  // The uint32 value.
+  uint32 value = 1;
+}
+
+// Wrapper message for bool.
+message BoolValue {
+  // The bool value.
+  bool value = 1;
+}
+
+// Wrapper message for string.
+message StringValue {
+  // The string value.
+  string value = 1;
+}
+
+// Wrapper message for bytes.
+message BytesValue {
+  // The bytes value.
+  bytes value = 1;
+}

data/definitions/protip/messages/array.proto

@@ -1,5 +1,6 @@
-// TODO: Move to plain protip namespace, use Any?
-package Protip.Messages;
+syntax = "proto3";
+
+package protip.messages;
 
 message Array {
   repeated bytes messages = 1;

data/definitions/protip/messages/errors.proto

@@ -1,5 +1,6 @@
-// TODO: move to plain protip namespace, use map type, change messages -> message
-package Protip.Messages;
+syntax = "proto3";
+
+package protip.messages;
 
 message Errors {
   repeated string messages = 1;
@@ -7,6 +8,6 @@ message Errors {
 }
 
 message FieldError {
-  optional string field = 1;
-  optional string message = 2;
+  string field = 1;
+  string message = 2;
 }

data/definitions/protip/messages/types.proto

@@ -1,7 +1,9 @@
-package protip;
+syntax = "proto3";
+
+package protip.messages;
 
 message Date {
-  required int64 year = 1;
-  required uint32 month = 2;
-  required uint32 day = 3;
+  int64 year = 1;
+  uint32 month = 2;
+  uint32 day = 3;
 }

data/lib/google/protobuf/wrappers.rb

@@ -0,0 +1,48 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/protobuf/wrappers.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.protobuf.DoubleValue" do
+    optional :value, :double, 1
+  end
+  add_message "google.protobuf.FloatValue" do
+    optional :value, :float, 1
+  end
+  add_message "google.protobuf.Int64Value" do
+    optional :value, :int64, 1
+  end
+  add_message "google.protobuf.UInt64Value" do
+    optional :value, :uint64, 1
+  end
+  add_message "google.protobuf.Int32Value" do
+    optional :value, :int32, 1
+  end
+  add_message "google.protobuf.UInt32Value" do
+    optional :value, :uint32, 1
+  end
+  add_message "google.protobuf.BoolValue" do
+    optional :value, :bool, 1
+  end
+  add_message "google.protobuf.StringValue" do
+    optional :value, :string, 1
+  end
+  add_message "google.protobuf.BytesValue" do
+    optional :value, :string, 1
+  end
+end
+
+module Google
+  module Protobuf
+    DoubleValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.DoubleValue").msgclass
+    FloatValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.FloatValue").msgclass
+    Int64Value = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.Int64Value").msgclass
+    UInt64Value = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.UInt64Value").msgclass
+    Int32Value = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.Int32Value").msgclass
+    UInt32Value = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.UInt32Value").msgclass
+    BoolValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.BoolValue").msgclass
+    StringValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.StringValue").msgclass
+    BytesValue = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.protobuf.BytesValue").msgclass
+  end
+end

data/lib/protip/client.rb

@@ -1,3 +1,4 @@
+require 'active_support/concern'
 require 'protip/error'
 require 'net/http'
 
@@ -23,7 +24,7 @@ module Protip
       uri = URI.join base_uri, path
 
       request                 = method.new uri
-      request.body            = (message == nil ? nil : message.encode)
+      request.body            = (message ? message.class.encode(message) : nil)
       request['Accept']       = 'application/x-protobuf'
       request.content_type    = 'application/x-protobuf'
 
@@ -45,9 +46,7 @@ module Protip
       if response_type
         begin
           response_type.decode response.body
-        # NotImplementedError catches the "Group is deprecated" exception raised by protobuf on some bad inputs.
-        # We may be able to remove it if we switch to a different protobuf gem.
-        rescue StandardError, NotImplementedError => error
+        rescue StandardError => error
           raise ::Protip::ParseError.new error, request, response
         end
       else

data/lib/protip/error.rb

@@ -1,7 +1,6 @@
-# Missing dependency from the protobuf require
-require 'protobuf'
+# Runtime exceptions for the library (protip/messages/errors defines the messages backing resource errors).
 
-require 'protip/messages/errors.pb'
+require 'protip/messages/errors'
 
 module Protip
   class Error < RuntimeError

data/lib/protip/messages/array.rb

@@ -0,0 +1,16 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: protip/messages/array.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "protip.messages.Array" do
+    repeated :messages, :string, 1
+  end
+end
+
+module Protip
+  module Messages
+    Array = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.Array").msgclass
+  end
+end

data/lib/protip/messages/errors.rb

@@ -0,0 +1,22 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: protip/messages/errors.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "protip.messages.Errors" do
+    repeated :messages, :string, 1
+    repeated :field_errors, :message, 2, "protip.messages.FieldError"
+  end
+  add_message "protip.messages.FieldError" do
+    optional :field, :string, 1
+    optional :message, :string, 2
+  end
+end
+
+module Protip
+  module Messages
+    Errors = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.Errors").msgclass
+    FieldError = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.FieldError").msgclass
+  end
+end

data/lib/protip/messages/types.rb

@@ -0,0 +1,18 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: protip/messages/types.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "protip.messages.Date" do
+    optional :year, :int64, 1
+    optional :month, :uint32, 2
+    optional :day, :uint32, 3
+  end
+end
+
+module Protip
+  module Messages
+    Date = Google::Protobuf::DescriptorPool.generated_pool.lookup("protip.messages.Date").msgclass
+  end
+end

data/lib/protip/resource.rb

@@ -19,7 +19,7 @@ require 'protip/error'
 require 'protip/standard_converter'
 require 'protip/wrapper'
 
-require 'protip/messages/array.pb'
+require 'protip/messages/array'
 
 module Protip
   module Resource
@@ -141,26 +141,28 @@ module Protip
       attr_accessor :client
 
       attr_reader :message
-      attr_reader :converter
 
       attr_writer :base_path
       def base_path
         @base_path == nil ? raise(RuntimeError.new 'Base path not yet set') : @base_path.gsub(/\/$/, '')
       end
 
+      attr_writer :converter
+      def converter
+        @converter || (@_standard_converter ||= Protip::StandardConverter.new)
+      end
+
       private
 
       # Primary entry point for defining resourceful behavior.
-      def resource(actions:, message:, query: nil, converter: Protip::StandardConverter.new)
+      def resource(actions:, message:, query: nil)
         if @message
           raise RuntimeError.new('Only one call to `resource` is allowed')
         end
 
-        @converter = converter
-
         # Define attribute readers/writers
         @message = message
-        @message.all_fields.each do |field|
+        @message.descriptor.each do |field|
           def_delegator :@wrapper, :"#{field.name}"
           def_delegator :@wrapper, :"#{field.name}="
         end
@@ -269,13 +271,13 @@ module Protip
     end
 
     def persisted?
-      message.field?(:id)
+      id != nil
     end
 
     def attributes
       # Like `.as_json`, but includes nil fields to match ActiveRecord behavior.
-      self.class.message.all_fields.map{|field| field.name}.inject({}) do |hash, attribute_name|
-        hash[attribute_name] = message.field?(attribute_name) ? public_send(attribute_name).as_json : nil
+      self.class.message.descriptor.map{|field| field.name}.inject({}) do |hash, attribute_name|
+        hash[attribute_name] = public_send(attribute_name)
         hash
       end
     end

data/lib/protip/standard_converter.rb

@@ -1,8 +1,7 @@
 require 'protip/converter'
 
-require 'protobuf'
-require 'protip/messages/types.pb'
-require 'protip/messages/wrappers.pb'
+require 'protip/messages/types'
+require 'google/protobuf'
 
 module Protip
   class StandardConverter
@@ -14,62 +13,34 @@ module Protip
     @conversions = {}
 
     ## Protip types
-    @conversions[Protip::Date] = {
+    @conversions['protip.messages.Date'] = {
       to_object: ->(message) { ::Date.new(message.year, message.month, message.day) },
-      to_message: lambda do |date|
+      to_message: lambda do |date, message_class|
         raise ArgumentError unless date.is_a?(::Date)
-        Protip::Date.new year: date.year, month: date.month, day: date.day
+        message_class.new year: date.year, month: date.month, day: date.day
       end
     }
 
     ## Standard wrappers
-    [Protip::Int64Value, Protip::Int32Value, Protip::UInt64Value, Protip::UInt32Value].each do |message_class|
-      @conversions[message_class] = {
+    %w(Int64 Int32 UInt64 UInt32 Double Float Bool String Bytes).map{|type| "google.protobuf.#{type}Value"}.each do |name|
+      @conversions[name] = {
         to_object: ->(message) { message.value },
-        to_message: lambda do |integer|
-          raise ArgumentError unless integer.is_a?(Integer)
-          message_class.new value: integer
-        end
-      }
-    end
-    [Protip::DoubleValue, Protip::FloatValue].each do |message_class|
-      @conversions[message_class] = {
-        to_object: ->(message) { message.value },
-        to_message: lambda do |float|
-          raise ArgumentError unless float.is_a?(Float)
-          message_class.new value: float
-        end
-      }
-    end
-    [Protip::BoolValue].each do |message_class|
-      @conversions[message_class] = {
-        to_object: ->(message) { message.value },
-        to_message: lambda do |bool|
-          # Protobuf throws a type error if this isn't the correct type, so we don't need to check
-          message_class.new value: bool
-        end
-      }
-    end
-    [Protip::StringValue, Protip::BytesValue].each do |message_class|
-      @conversions[message_class] = {
-        to_object: ->(message) { message.value },
-        to_message: lambda do |string|
-          # Protobuf throws a type error if this isn't the correct type, so we don't need to check
-          message_class.new value: string
+        to_message: lambda do |value, message_class|
+          message_class.new value: value
         end
       }
     end
 
     def convertible?(message_class)
-      self.class.conversions.has_key?(message_class)
+      self.class.conversions.has_key?(message_class.descriptor.name)
     end
 
     def to_object(message)
-      self.class.conversions[message.class][:to_object].call(message)
+      self.class.conversions[message.class.descriptor.name][:to_object].call(message)
     end
 
     def to_message(object, message_class)
-      self.class.conversions[message_class][:to_message].call(object)
+      self.class.conversions[message_class.descriptor.name][:to_message].call(object, message_class)
     end
   end
 end