functions_framework 0.4.0 → 0.6.0

data/lib/functions_framework/cloud_events/errors.rb

@@ -1,42 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module FunctionsFramework
-  module CloudEvents
-    ##
-    # Base class for all CloudEvents errors.
-    #
-    class CloudEventsError < ::StandardError
-    end
-
-    ##
-    # Errors indicating unsupported or incorrectly formatted HTTP content or
-    # headers.
-    #
-    class HttpContentError < CloudEventsError
-    end
-
-    ##
-    # Errors indicating an unsupported or incorrect spec version.
-    #
-    class SpecVersionError < CloudEventsError
-    end
-
-    ##
-    # Errors related to CloudEvent attributes.
-    #
-    class AttributeError < CloudEventsError
-    end
-  end
-end

data/lib/functions_framework/cloud_events/event.rb

@@ -1,84 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "date"
-require "uri"
-
-require "functions_framework/cloud_events/event/field_interpreter"
-require "functions_framework/cloud_events/event/v0"
-require "functions_framework/cloud_events/event/v1"
-
-module FunctionsFramework
-  module CloudEvents
-    ##
-    # An Event object represents a complete CloudEvent, including both data and
-    # context attributes. The following are true of all event objects:
-    #
-    #  *  Event classes are defined within this module. For example, events
-    #     conforming to the CloudEvents 1.0 specification are of type
-    #     {FunctionsFramework::CloudEvents::Event::V1}.
-    #  *  All event classes include this module, so you can use
-    #     `is_a? FunctionsFramework::CloudEvents::Event` to test whether an
-    #     object is an event.
-    #  *  All event objects are immutable. Data and atribute values can be
-    #     retrieved but not modified. To "modify" an event, make a copy with
-    #     the desired changes. Generally, event classes will provide a helper
-    #     method for this purpose.
-    #  *  All event objects have a `spec_version` method that returns the
-    #     version of the CloudEvents spec implemented by that event. (Other
-    #     methods may be different, depending on the spec version.)
-    #
-    # To create an event, you may either:
-    #
-    #  *  Construct an instance of the event class directly, for example by
-    #     calling {Event::V1.new} and passing a set of attributes.
-    #  *  Call {Event.create} and pass a spec version and a set of attributes.
-    #     This will choose the appropriate event class based on the version.
-    #  *  Decode an event from another representation. For example, use
-    #     {CloudEvents::JsonFormat} to decode an event from JSON, or use
-    #     {CloudEvents::HttpBinding} to decode an event from an HTTP request.
-    #
-    # See https://github.com/cloudevents/spec for more information about
-    # CloudEvents. The documentation for the individual event classes
-    # {FunctionsFramework::CloudEvents::Event::V0} and
-    # {FunctionsFramework::CloudEvents::Event::V1} also include links to their
-    # respective specifications.
-    #
-    module Event
-      class << self
-        ##
-        # Create a new cloud event object with the given version. Generally,
-        # you must also pass additional keyword arguments providing the event's
-        # data and attributes. For example, if you pass `1.0` as the
-        # `spec_version`, the remaining keyword arguments will be passed
-        # through to the {Event::V1.new} constructor.
-        #
-        # @param spec_version [String] The required `specversion` field.
-        # @param kwargs [keywords] Additional parameters for the event.
-        #
-        def create spec_version:, **kwargs
-          case spec_version
-          when "0.3"
-            V0.new spec_version: spec_version, **kwargs
-          when /^1(\.|$)/
-            V1.new spec_version: spec_version, **kwargs
-          else
-            raise SpecVersionError, "Unrecognized specversion: #{spec_version}"
-          end
-        end
-        alias new create
-      end
-    end
-  end
-end

data/lib/functions_framework/cloud_events/event/field_interpreter.rb

@@ -1,150 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module FunctionsFramework
-  module CloudEvents
-    module Event
-      ##
-      # A helper that extracts and interprets event fields from an input hash.
-      #
-      # @private
-      #
-      class FieldInterpreter
-        def initialize args
-          @args = keys_to_strings args
-          @attributes = {}
-        end
-
-        def finish_attributes
-          @attributes.merge! @args
-          @args = {}
-          @attributes
-        end
-
-        def string keys, required: false
-          object keys, required: required do |value|
-            case value
-            when ::String
-              raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
-              [value, value]
-            else
-              raise AttributeError, "Illegal type for #{keys.first}:" \
-                                    " String expected but #{value.class} found"
-            end
-          end
-        end
-
-        def uri keys, required: false
-          object keys, required: required do |value|
-            case value
-            when ::String
-              raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
-              begin
-                [::URI.parse(value), value]
-              rescue ::URI::InvalidURIError => e
-                raise AttributeError, "Illegal format for #{keys.first}: #{e.message}"
-              end
-            when ::URI::Generic
-              [value, value.to_s]
-            else
-              raise AttributeError, "Illegal type for #{keys.first}:" \
-                                    " String or URI expected but #{value.class} found"
-            end
-          end
-        end
-
-        def rfc3339_date_time keys, required: false
-          object keys, required: required do |value|
-            case value
-            when ::String
-              begin
-                [::DateTime.rfc3339(value), value]
-              rescue ::Date::Error => e
-                raise AttributeError, "Illegal format for #{keys.first}: #{e.message}"
-              end
-            when ::DateTime
-              [value, value.rfc3339]
-            when ::Time
-              value = value.to_datetime
-              [value, value.rfc3339]
-            else
-              raise AttributeError, "Illegal type for #{keys.first}:" \
-                                    " String, Time, or DateTime expected but #{value.class} found"
-            end
-          end
-        end
-
-        def content_type keys, required: false
-          object keys, required: required do |value|
-            case value
-            when ::String
-              raise AttributeError, "The #{keys.first} field cannot be empty" if value.empty?
-              [ContentType.new(value), value]
-            when ContentType
-              [value, value.to_s]
-            else
-              raise AttributeError, "Illegal type for #{keys.first}:" \
-                                    " String, or ContentType expected but #{value.class} found"
-            end
-          end
-        end
-
-        def spec_version keys, accept:
-          object keys, required: true do |value|
-            case value
-            when ::String
-              raise SpecVersionError, "Unrecognized specversion: #{value}" unless accept =~ value
-              [value, value]
-            else
-              raise AttributeError, "Illegal type for #{keys.first}:" \
-                                    " String expected but #{value.class} found"
-            end
-          end
-        end
-
-        UNDEFINED = Object.new
-
-        def object keys, required: false, allow_nil: false
-          value = UNDEFINED
-          keys.each do |key|
-            key_present = @args.key? key
-            val = @args.delete key
-            value = val if allow_nil && key_present || !allow_nil && !val.nil?
-          end
-          if value == UNDEFINED
-            raise AttributeError, "The #{keys.first} field is required" if required
-            return nil
-          end
-          if block_given?
-            converted, raw = yield value
-          else
-            converted = raw = value
-          end
-          @attributes[keys.first] = raw
-          converted
-        end
-
-        private
-
-        def keys_to_strings hash
-          result = {}
-          hash.each do |key, val|
-            result[key.to_s] = val
-          end
-          result
-        end
-      end
-    end
-  end
-end

data/lib/functions_framework/cloud_events/event/v0.rb

@@ -1,236 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "date"
-require "uri"
-
-module FunctionsFramework
-  module CloudEvents
-    module Event
-      ##
-      # A CloudEvents V0 data type.
-      #
-      # This object represents a complete CloudEvent, including the event data
-      # and context attributes. It supports the standard required and optional
-      # attributes defined in CloudEvents V0.3, and arbitrary extension
-      # attributes. All attribute values can be obtained (in their string form)
-      # via the {Event::V0#[]} method. Additionally, standard attributes have
-      # their own accessor methods that may return typed objects (such as
-      # `DateTime` for the `time` attribute).
-      #
-      # This object is immutable. The data and attribute values can be
-      # retrieved but not modified. To obtain an event with modifications, use
-      # the {#with} method to create a copy with the desired changes.
-      #
-      # See https://github.com/cloudevents/spec/blob/v0.3/spec.md for
-      # descriptions of the standard attributes.
-      #
-      class V0
-        include Event
-
-        ##
-        # Create a new cloud event object with the given data and attributes.
-        #
-        # Event attributes may be presented as keyword arguments, or as a Hash
-        # passed in via the `attributes` argument (but not both).
-        #
-        # The following standard attributes are supported and exposed as
-        # attribute methods on the object.
-        #
-        #  *  **:spec_version** (or **:specversion**) [`String`] - _required_ -
-        #     The CloudEvents spec version (i.e. the `specversion` field.)
-        #  *  **:id** [`String`] - _required_ - The event `id` field.
-        #  *  **:source** [`String`, `URI`] - _required_ - The event `source`
-        #     field.
-        #  *  **:type** [`String`] - _required_ - The event `type` field.
-        #  *  **:data** [`Object`] - _optional_ - The data associated with the
-        #     event (i.e. the `data` field.)
-        #  *  **:data_content_encoding** (or **:datacontentencoding**)
-        #     [`String`] - _optional_ - The content-encoding for the data (i.e.
-        #     the `datacontentencoding` field.)
-        #  *  **:data_content_type** (or **:datacontenttype**) [`String`,
-        #     {ContentType}] - _optional_ - The content-type for the data, if
-        #     the data is a string (i.e. the event `datacontenttype` field.)
-        #  *  **:schema_url** (or **:schemaurl**) [`String`, `URI`] -
-        #     _optional_ - The event `schemaurl` field.
-        #  *  **:subject** [`String`] - _optional_ - The event `subject` field.
-        #  *  **:time** [`String`, `DateTime`, `Time`] - _optional_ - The
-        #     event `time` field.
-        #
-        # Any additional attributes are assumed to be extension attributes.
-        # They are not available as separate methods, but can be accessed via
-        # the {Event::V1#[]} operator.
-        #
-        # @param attributes [Hash] The data and attributes, as a hash.
-        # @param args [keywords] The data and attributes, as keyword arguments.
-        #
-        def initialize attributes: nil, **args
-          interpreter = FieldInterpreter.new attributes || args
-          @spec_version = interpreter.spec_version ["specversion", "spec_version"], accept: /^0\.3$/
-          @id = interpreter.string ["id"], required: true
-          @source = interpreter.uri ["source"], required: true
-          @type = interpreter.string ["type"], required: true
-          @data = interpreter.object ["data"], allow_nil: true
-          @data_content_encoding = interpreter.string ["datacontentencoding", "data_content_encoding"]
-          @data_content_type = interpreter.content_type ["datacontenttype", "data_content_type"]
-          @schema_url = interpreter.uri ["schemaurl", "schema_url"]
-          @subject = interpreter.string ["subject"]
-          @time = interpreter.rfc3339_date_time ["time"]
-          @attributes = interpreter.finish_attributes
-        end
-
-        ##
-        # Create and return a copy of this event with the given changes. See
-        # the constructor for the parameters that can be passed. In general,
-        # you can pass a new value for any attribute, or pass `nil` to remove
-        # an optional attribute.
-        #
-        # @param changes [keywords] See {#initialize} for a list of arguments.
-        # @return [FunctionFramework::CloudEvents::Event]
-        #
-        def with **changes
-          attributes = @attributes.merge changes
-          V0.new attributes: attributes
-        end
-
-        ##
-        # Return the value of the given named attribute. Both standard and
-        # extension attributes are supported.
-        #
-        # Attribute names must be given as defined in the standard CloudEvents
-        # specification. For example `specversion` rather than `spec_version`.
-        #
-        # Results are given in their "raw" form, generally a string. This may
-        # be different from the Ruby object returned from corresponding
-        # attribute methods. For example:
-        #
-        #     event["time"]     # => String rfc3339 representation
-        #     event.time        # => DateTime object
-        #
-        # @param key [String,Symbol] The attribute name.
-        # @return [String,nil]
-        #
-        def [] key
-          @attributes[key.to_s]
-        end
-
-        ##
-        # Return a hash representation of this event.
-        #
-        # @return [Hash]
-        #
-        def to_h
-          @attributes.dup
-        end
-
-        ##
-        # The `id` field. Required.
-        #
-        # @return [String]
-        #
-        attr_reader :id
-
-        ##
-        # The `source` field as a `URI` object. Required.
-        #
-        # @return [URI]
-        #
-        attr_reader :source
-
-        ##
-        # The `type` field. Required.
-        #
-        # @return [String]
-        #
-        attr_reader :type
-
-        ##
-        # The `specversion` field. Required.
-        #
-        # @return [String]
-        #
-        attr_reader :spec_version
-        alias specversion spec_version
-
-        ##
-        # The event-specific data, or `nil` if there is no data.
-        #
-        # Data may be one of the following types:
-        #  *  Binary data, represented by a `String` using the `ASCII-8BIT`
-        #     encoding.
-        #  *  A string in some other encoding such as `UTF-8` or `US-ASCII`.
-        #  *  Any JSON data type, such as a Boolean, Integer, Array, Hash, or
-        #     `nil`.
-        #
-        # @return [Object]
-        #
-        attr_reader :data
-
-        ##
-        # The optional `datacontentencoding` field as a `String` object, or
-        # `nil` if the field is absent.
-        #
-        # @return [String,nil]
-        #
-        attr_reader :data_content_encoding
-        alias datacontentencoding data_content_encoding
-
-        ##
-        # The optional `datacontenttype` field as a
-        # {FunctionsFramework::CloudEvents::ContentType} object, or `nil` if
-        # the field is absent.
-        #
-        # @return [FunctionsFramework::CloudEvents::ContentType,nil]
-        #
-        attr_reader :data_content_type
-        alias datacontenttype data_content_type
-
-        ##
-        # The optional `schemaurl` field as a `URI` object, or `nil` if the
-        # field is absent.
-        #
-        # @return [URI,nil]
-        #
-        attr_reader :schema_url
-        alias schemaurl schema_url
-
-        ##
-        # The optional `subject` field, or `nil` if the field is absent.
-        #
-        # @return [String,nil]
-        #
-        attr_reader :subject
-
-        ##
-        # The optional `time` field as a `DateTime` object, or `nil` if the
-        # field is absent.
-        #
-        # @return [DateTime,nil]
-        #
-        attr_reader :time
-
-        ## @private
-        def == other
-          other.is_a?(V1) && @attributes == other.instance_variable_get(:@attributes)
-        end
-        alias eql? ==
-
-        ## @private
-        def hash
-          @hash ||= @attributes.hash
-        end
-      end
-    end
-  end
-end