trailer_vote-media_types 2.1.0 → 2.2.0

data/lib/trailer_vote/media_types/configuration.rb

@@ -1,139 +1,139 @@
-# frozen_string_literal: true
-
-require_relative 'base_text'
-require_relative 'types/influx_db_connection_url'
-require_relative 'types/formatted_url'
-
-module TrailerVote
-  module MediaTypes
-
-    ##
-    # Media Types for Configuration
-    #
-    class Configuration < BaseText
-      media_type 'configuration', defaults: { suffix: :json, version: 5 }
-
-      validations do
-
-        version 5 do
-          attribute :configuration do
-            link :self
-            link :place
-            link :push_manifest
-            link :products
-            link :product_lookup
-            link :persona do
-              attribute :href, Types.makeFormattedUrl(:uuid)
-              attribute :templated, TrueClass
-            end
-            link :lookup do
-              attribute :href, Types.makeFormattedUrl(:authority, :identifier)
-              attribute :templated, TrueClass
-            end
-            link :analytics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :telemetrics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :issues
-            link :persona_config do
-              attribute :href, Types.makeFormattedUrl(:persona)
-              attribute :templated, TrueClass
-            end
-            attribute :customer_config
-          end
-        end
-
-        version 4 do
-          attribute :configuration do
-            link :self
-            link :place
-            link :push_manifest
-            link :products
-            link :product_lookup
-            link :persona do
-              attribute :href, Types.makeFormattedUrl(:uuid)
-              attribute :templated, TrueClass
-            end
-            link :analytics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :telemetrics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :issues
-            link :persona_config do
-              attribute :href, Types.makeFormattedUrl(:persona)
-              attribute :templated, TrueClass
-            end
-            attribute :customer_config
-          end
-        end
-
-        version 3 do
-          attribute :configuration do
-            link :self
-            link :place
-            link :push_manifest
-            link :products
-            link :product_lookup
-            link :persona do
-              attribute :href, Types.makeFormattedUrl(:uuid)
-              attribute :templated, TrueClass
-            end
-            link :analytics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :telemetrics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :issues
-          end
-        end
-
-        version 2 do
-          attribute :configuration do
-            link :self
-            link :place
-            link :products
-            link :product_lookup
-            link :persona do
-              attribute :href, Types.makeFormattedUrl(:uuid)
-              attribute :templated, TrueClass
-            end
-            link :analytics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :telemetrics do
-              attribute :href, Types::InfluxDbConnectionUrl
-            end
-            link :issues
-          end
-        end
-
-        version 1 do
-          attribute :configuration do
-            link :place
-            link :products
-            link :feedback do
-              attribute :href, Types.makeFormattedUrl(:uuid)
-              attribute :templated, TrueClass
-            end
-            link :persona do
-              attribute :href, Types.makeFormattedUrl(:uuid)
-              attribute :templated, TrueClass
-            end
-            link :analytics do
-              attribute :href, AllowNil(Types::InfluxDbConnectionUrl)
-            end
-          end
-        end
-      end
-
-      registrations :configuration do
-        versions 1, 2, 3
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'base_text'
+require_relative 'types/influx_db_connection_url'
+require_relative 'types/formatted_url'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Configuration
+    #
+    class Configuration < BaseText
+      media_type 'configuration', defaults: { suffix: :json, version: 5 }
+
+      validations do
+
+        version 5 do
+          attribute :configuration do
+            link :self
+            link :place
+            link :push_manifest
+            link :products
+            link :product_lookup
+            link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
+              attribute :templated, TrueClass
+            end
+            link :lookup do
+              attribute :href, Types.makeFormattedUrl(:authority, :identifier)
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :telemetrics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :issues
+            link :persona_config do
+              attribute :href, Types.makeFormattedUrl(:persona)
+              attribute :templated, TrueClass
+            end
+            attribute :customer_config
+          end
+        end
+
+        version 4 do
+          attribute :configuration do
+            link :self
+            link :place
+            link :push_manifest
+            link :products
+            link :product_lookup
+            link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :telemetrics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :issues
+            link :persona_config do
+              attribute :href, Types.makeFormattedUrl(:persona)
+              attribute :templated, TrueClass
+            end
+            attribute :customer_config
+          end
+        end
+
+        version 3 do
+          attribute :configuration do
+            link :self
+            link :place
+            link :push_manifest
+            link :products
+            link :product_lookup
+            link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :telemetrics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :issues
+          end
+        end
+
+        version 2 do
+          attribute :configuration do
+            link :self
+            link :place
+            link :products
+            link :product_lookup
+            link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :telemetrics do
+              attribute :href, Types::InfluxDbConnectionUrl
+            end
+            link :issues
+          end
+        end
+
+        version 1 do
+          attribute :configuration do
+            link :place
+            link :products
+            link :feedback do
+              attribute :href, Types.makeFormattedUrl(:uuid)
+              attribute :templated, TrueClass
+            end
+            link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, AllowNil(Types::InfluxDbConnectionUrl)
+            end
+          end
+        end
+      end
+
+      registrations :configuration do
+        versions 1, 2, 3
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/errors.rb

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-require 'trailer_vote/media_types/base_text'
-
-module TrailerVote
-  module MediaTypes
-    ##
-    # Media Types for errors
-    #
-    # All errors given back to any TrailerVote service have this media type. In order to ensure correct error
-    # content-type negotiation, clients SHOULD include the media type with a reduced quality param q in the Accept
-    # header of each request. The RECOMMENDED value for q is 0.1.
-    #
-    class Errors < BaseText
-      media_type 'errors', defaults: { suffix: :json, version: 1 }
-
-      validations do
-        version 1 do
-          collection :errors do
-            attribute :message, String
-            attribute :code, AllowNil(String)
-          end
-        end
-      end
-
-      registrations :errors do
-        versions 1
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'trailer_vote/media_types/base_text'
+
+module TrailerVote
+  module MediaTypes
+    ##
+    # Media Types for errors
+    #
+    # All errors given back to any TrailerVote service have this media type. In order to ensure correct error
+    # content-type negotiation, clients SHOULD include the media type with a reduced quality param q in the Accept
+    # header of each request. The RECOMMENDED value for q is 0.1.
+    #
+    class Errors < BaseText
+      media_type 'errors', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          collection :errors do
+            attribute :message, String
+            attribute :code, AllowNil(String)
+          end
+        end
+      end
+
+      registrations :errors do
+        versions 1
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/feedback.rb

@@ -1,50 +1,50 @@
-# frozen_string_literal: true
-
-require_relative 'base_text'
-require_relative 'types/uuid_v4'
-require_relative 'types/vote_value'
-require_relative 'types/iso8601'
-
-module TrailerVote
-  module MediaTypes
-    class Feedback < BaseText
-      media_type 'feedback', defaults: { suffix: :json, version: 1 }
-
-      validations do
-        version 1 do
-          version_1_base = ::MediaTypes::Scheme.new do
-            attribute :value, Types::VoteValue
-            attribute :updated_at, Types::Iso8601
-
-            link :audio_fragment
-            link :product
-            link :persona
-          end
-
-          attribute :feedback do
-            merge version_1_base
-          end
-
-          view 'collection' do
-            attribute :feedback do
-              collection :_embedded, version_1_base, allow_empty: true
-              not_strict
-            end
-          end
-
-          view 'create' do
-            attribute :feedback do
-              attribute :persona, Types::UuidV4
-              attribute :value, Types::VoteValue
-            end
-          end
-        end
-      end
-
-      registrations :feedback do
-        view 'create', :create_feedback
-        view 'collection', :feedback_collection
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'base_text'
+require_relative 'types/uuid_v4'
+require_relative 'types/vote_value'
+require_relative 'types/iso8601'
+
+module TrailerVote
+  module MediaTypes
+    class Feedback < BaseText
+      media_type 'feedback', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          version_1_base = ::MediaTypes::Scheme.new do
+            attribute :value, Types::VoteValue
+            attribute :updated_at, Types::Iso8601
+
+            link :audio_fragment
+            link :product
+            link :persona
+          end
+
+          attribute :feedback do
+            merge version_1_base
+          end
+
+          view 'collection' do
+            attribute :feedback do
+              collection :_embedded, version_1_base, allow_empty: true
+              not_strict
+            end
+          end
+
+          view 'create' do
+            attribute :feedback do
+              attribute :persona, Types::UuidV4
+              attribute :value, Types::VoteValue
+            end
+          end
+        end
+      end
+
+      registrations :feedback do
+        view 'create', :create_feedback
+        view 'collection', :feedback_collection
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/feedback_listing.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-
-require_relative 'base_text'
-require_relative 'types/vote_value'
-require_relative 'types/iso8601'
-require_relative 'partials/image_links'
-
-module TrailerVote
-  module MediaTypes
-    class FeedbackListing < BaseText
-      media_type 'feedback_listing'
-
-      defaults do
-        suffix :json
-        version 1
-      end
-
-      validations do
-        version 1 do
-          attribute :feedback_listing do
-            collection :items, allow_empty: true do
-              attribute :title, AllowNil(String)
-              attribute :value, Types::VoteValue
-              attribute :updated_at, Types::Iso8601
-
-              link :audio_fragment
-              link :product
-              link :persona
-              link :feedback
-              link :interactive_player
-
-              attribute :image, expected_type: AllowNil(::Hash), allow_empty: true, optional: true do
-                attribute :_embedded, expected_type: AllowNil(::Hash), allow_empty: true do
-                  merge Partials::IMAGE_LINKS
-                end
-              end
-            end
-
-            link :self
-          end
-        end
-      end
-
-      registrations :feedback_listing do
-        type_alias 'feedback-listing'
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'base_text'
+require_relative 'types/vote_value'
+require_relative 'types/iso8601'
+require_relative 'partials/image_links'
+
+module TrailerVote
+  module MediaTypes
+    class FeedbackListing < BaseText
+      media_type 'feedback_listing'
+
+      defaults do
+        suffix :json
+        version 1
+      end
+
+      validations do
+        version 1 do
+          attribute :feedback_listing do
+            collection :items, allow_empty: true do
+              attribute :title, AllowNil(String)
+              attribute :value, Types::VoteValue
+              attribute :updated_at, Types::Iso8601
+
+              link :audio_fragment
+              link :product
+              link :persona
+              link :feedback
+              link :interactive_player
+
+              attribute :image, expected_type: AllowNil(::Hash), allow_empty: true, optional: true do
+                attribute :_embedded, expected_type: AllowNil(::Hash), allow_empty: true do
+                  merge Partials::IMAGE_LINKS
+                end
+              end
+            end
+
+            link :self
+          end
+        end
+      end
+
+      registrations :feedback_listing do
+        type_alias 'feedback-listing'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/fingerprint_binary.rb

@@ -1,67 +1,67 @@
-# frozen_string_literal: true
-
-require 'media_types'
-
-module TrailerVote
-  module MediaTypes
-
-    ##
-    # Media Types for Fingerprints
-    #
-    # Clients **MUST** match the version of their audio fingerprinter and this media type version. This is a binary
-    # media type and returns a file or {Errors}.
-    #
-    class FingerprintBinary
-      include ::MediaTypes::Dsl
-
-      def self.base_format
-        'application/vnd.trailervote.fingerprint.v%<version>s'
-      end
-
-      media_type 'fingerprint', defaults: { version: '~' }
-
-      class Current < FingerprintBinary
-        media_type 'fingerprint', defaults: { version: 'C' }
-
-        class << self
-          def register(version:, **___)
-            mime_type = FingerprintBinary.to_constructable.version(version).to_s
-
-            Array(
-              ::MediaTypes::Registerable.new(
-                mime_type,
-                symbol: :fingerprint_bin,
-                aliases: []
-              ).tap { |registerable| ::MediaTypes.register(registerable) }
-            )
-          end
-        end
-      end
-
-      class Deprecated < FingerprintBinary
-        def self.base_format
-          'application/vnd.trailervote.fingerprint.deprecated'
-        end
-
-        media_type 'fingerprint.deprecated', defaults: { version: nil }
-
-        class << self
-
-          def register(versions:, **___)
-            aliases = versions.map do |version|
-              FingerprintBinary.to_constructable.version(version).to_s
-            end
-
-            Array(
-              ::MediaTypes::Registerable.new(
-                base_format,
-                symbol: :fingerprint_deprecated_bin,
-                aliases: aliases
-              ).tap { |registerable| ::MediaTypes.register(registerable) }
-            )
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'media_types'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Fingerprints
+    #
+    # Clients **MUST** match the version of their audio fingerprinter and this media type version. This is a binary
+    # media type and returns a file or {Errors}.
+    #
+    class FingerprintBinary
+      include ::MediaTypes::Dsl
+
+      def self.base_format
+        'application/vnd.trailervote.fingerprint.v%<version>s'
+      end
+
+      media_type 'fingerprint', defaults: { version: '~' }
+
+      class Current < FingerprintBinary
+        media_type 'fingerprint', defaults: { version: 'C' }
+
+        class << self
+          def register(version:, **___)
+            mime_type = FingerprintBinary.to_constructable.version(version).to_s
+
+            Array(
+              ::MediaTypes::Registerable.new(
+                mime_type,
+                symbol: :fingerprint_bin,
+                aliases: []
+              ).tap { |registerable| ::MediaTypes.register(registerable) }
+            )
+          end
+        end
+      end
+
+      class Deprecated < FingerprintBinary
+        def self.base_format
+          'application/vnd.trailervote.fingerprint.deprecated'
+        end
+
+        media_type 'fingerprint.deprecated', defaults: { version: nil }
+
+        class << self
+
+          def register(versions:, **___)
+            aliases = versions.map do |version|
+              FingerprintBinary.to_constructable.version(version).to_s
+            end
+
+            Array(
+              ::MediaTypes::Registerable.new(
+                base_format,
+                symbol: :fingerprint_deprecated_bin,
+                aliases: aliases
+              ).tap { |registerable| ::MediaTypes.register(registerable) }
+            )
+          end
+        end
+      end
+    end
+  end
+end