nylas 5.6.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bcbd7a865f3b26271776f6e5358647e8e8d9d92d29b9e33f1e942bb0153ea80
-  data.tar.gz: 8a16ead2bc3cccb8f29dcdcf97cbb128722f0f68acf843a96788426c440fbe6c
+  metadata.gz: 54c46b764fd777bee7eb27539bd6dc54ad253b76a242db3cfa9c969e128c05e4
+  data.tar.gz: 2c0876d20db34b5796ec2d6c21c487de8d661cd6041a899604b6dcf594ffa8f1
 SHA512:
-  metadata.gz: 2678a4be307e3870b12d605f5cac42878a884ac97e562ce9cb372d2db54135d9f12ebec4422910efff329e81f4beffa59fe485192f8974832a8d8957cf622431
-  data.tar.gz: 8f77887a487ee85104aae6557bbdf6a39f2fd96bd5fc5265f68e7923655fed39eb2269d9a59d6fc0209ead37cc3cc8b272fbe496ad08e027e64f2c5ab841ed6e
+  metadata.gz: f70e5d14160b41bb0b50fddc2a17141fd16405fc9f0460a0fbdeaf7ac9ff356332a0400167322c63e7c0a1d0673a1b234a57e1427d9682c8bf88e59e0ca2a5c6
+  data.tar.gz: f4494a94a6bf17fc43be9af8961ce9ceb0ce9b97e76b06e598bf4214934d81561378f3519c3715a536d2b8703194bfe6ba047496e1ab425b3bdb99b18e46bc90

data/lib/nylas/draft.rb

@@ -27,6 +27,7 @@ module Nylas
     attribute :body, :string
     attribute :starred, :boolean
     attribute :unread, :boolean
+    attribute :metadata, :hash
 
     has_n_of_attribute :events, :event
     has_n_of_attribute :files, :file, read_only: true

data/lib/nylas/model/attributable.rb

@@ -17,8 +17,8 @@ module Nylas
       end
 
       # @return [Hash] Representation of the model with values serialized into primitives based on their Type
-      def to_h
-        attributes.to_h
+      def to_h(enforce_read_only: false)
+        attributes.to_h(enforce_read_only: enforce_read_only)
       end
 
       protected

data/lib/nylas/model/attribute_definition.rb

@@ -5,7 +5,7 @@ module Nylas
     # Define a particular attribute for a given model
     class AttributeDefinition
       extend Forwardable
-      def_delegators :type, :cast, :serialize
+      def_delegators :type, :cast, :serialize, :serialize_for_api
       attr_accessor :type_name, :read_only, :default
 
       def initialize(type_name:, read_only:, default:)

data/lib/nylas/model/attributes.rb

@@ -28,23 +28,34 @@ module Nylas
         end
       end
 
-      def to_h(keys: attribute_definitions.keys)
-        keys.each_with_object({}) do |key, casted_data|
-          value = attribute_definitions[key].serialize(self[key])
+      # Convert the object to hash
+      # @param keys [Array<String>] The keys included
+      # @param enforce_read_only [Boolean] Whether to enforce read_only property (serializing for API)
+      # @return [Hash] The hash representation of the object
+      def to_h(keys: attribute_definitions.keys, enforce_read_only: false)
+        casted_data = {}
+        keys.each do |key|
+          value = attribute_to_hash(key, enforce_read_only)
           # If the value is an empty hash but we specify that it is valid (via default value), serialize it
           casted_data[key] = value unless value.nil? || (value.respond_to?(:empty?) && value.empty? &&
             !(attribute_definitions[key].default == value && value.is_a?(Hash)))
         end
+        casted_data
       end
 
-      def serialize(keys: attribute_definitions.keys)
-        JSON.dump(to_h(keys: keys))
+      # Serialize the object
+      # @param keys [Array<String>] The keys included
+      # @param enforce_read_only [Boolean] Whether to enforce read_only property (serializing for API)
+      # @return [String] The serialized object as a JSON string
+      def serialize(keys: attribute_definitions.keys, enforce_read_only: false)
+        JSON.dump(to_h(keys: keys, enforce_read_only: enforce_read_only))
       end
 
+      # Serialize the object to an API-compatible JSON string
+      # @param keys [Array<String>] The keys included
+      # @return [String] The serialized object as a JSON string
       def serialize_for_api(keys: attribute_definitions.keys)
-        api_keys = keys.delete_if { |key| attribute_definitions[key].read_only == true }
-
-        serialize(keys: api_keys)
+        serialize(keys: keys, enforce_read_only: true)
       end
 
       def serialize_all_for_api(keys: attribute_definitions.keys)
@@ -68,6 +79,19 @@ module Nylas
       def default_attributes
         attribute_definitions.keys.zip([]).to_h
       end
+
+      # Convert the attribute value as a hash
+      # @param key [String] The attribute's key
+      # @param enforce_read_only [Boolean] Whether to enforce read_only property (serializing for API)
+      # @return [nil | Hash] The appropriately serialized value
+      def attribute_to_hash(key, enforce_read_only)
+        attribute_definition = attribute_definitions[key]
+        if enforce_read_only
+          attribute_definition.read_only == true ? nil : attribute_definition.serialize_for_api(self[key])
+        else
+          attribute_definition.serialize(self[key])
+        end
+      end
     end
   end
 end

data/lib/nylas/model/list_attribute_definition.rb

@@ -18,9 +18,17 @@ module Nylas
         list.map { |item| type.cast(item) }
       end
 
-      def serialize(list)
+      def serialize(list, enforce_read_only: false)
         list = default if list.nil? || list.empty?
-        list.map { |item| type.serialize(item) }
+        if enforce_read_only
+          list.map { |item| type.serialize_for_api(item) }
+        else
+          list.map { |item| type.serialize(item) }
+        end
+      end
+
+      def serialize_for_api(list)
+        serialize(list, enforce_read_only: true)
       end
 
       def type

data/lib/nylas/new_message.rb

@@ -20,6 +20,7 @@ module Nylas
     attribute :subject, :string
     attribute :body, :string
     attribute :reply_to_message_id, :string
+    attribute :metadata, :hash
 
     has_n_of_attribute :file_ids, :string
 

data/lib/nylas/participant.rb

@@ -7,6 +7,6 @@ module Nylas
     attribute :name, :string
     attribute :email, :string
     attribute :comment, :string
-    attribute :status, :string
+    attribute :status, :string, read_only: true
   end
 end

data/lib/nylas/types.rb

@@ -7,8 +7,27 @@ module Nylas
       @registry ||= Registry.new
     end
 
+    # Base type for attributes
+    class ValueType
+      def cast(object)
+        object
+      end
+
+      def serialize(object)
+        object
+      end
+
+      def deseralize(object)
+        object
+      end
+
+      def serialize_for_api(object)
+        serialize(object)
+      end
+    end
+
     # Casts/Serializes data that is persisted and used natively as a Hash
-    class HashType
+    class HashType < ValueType
       def serialize(object)
         object.to_h
       end
@@ -22,10 +41,11 @@ module Nylas
 
     # Type for attributes that are persisted in the API as a hash but exposed in ruby as a particular
     # {Model} or Model-like thing.
-    class ModelType
+    class ModelType < ValueType
       attr_accessor :model
 
       def initialize(model:)
+        super()
         self.model = model
       end
 
@@ -33,6 +53,10 @@ module Nylas
         object.to_h
       end
 
+      def serialize_for_api(object)
+        object&.to_h(enforce_read_only: true)
+      end
+
       def cast(value)
         return model.new if value.nil?
         return value if already_cast?(value)
@@ -56,23 +80,8 @@ module Nylas
       end
     end
 
-    # Type for attributes that do not require casting/serializing/deserializing.
-    class ValueType
-      def cast(object)
-        object
-      end
-
-      def serialize(object)
-        object
-      end
-
-      def deseralize(object)
-        object
-      end
-    end
-
     # Type for attributes represented as a unix timestamp in the API and Time in Ruby
-    class UnixTimestampType
+    class UnixTimestampType < ValueType
       def cast(object)
         return object if object.is_a?(Time) || object.nil?
         return Time.at(object.to_i) if object.is_a?(String)

data/lib/nylas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nylas
-  VERSION = "5.6.0"
+  VERSION = "5.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Nylas, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler