trailer_vote-media_types 0.5.0

data/lib/trailer_vote/media_types/carousel.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require_relative './partials/image_links'
+
+module TrailerVote
+  module MediaTypes
+
+    class Carousel < BaseText
+      media_type 'carousel'
+
+      defaults do
+        suffix :json
+        version 1
+      end
+
+      validations do
+        version 1 do
+          attribute :carousel do
+            collection :items do
+              attribute :title, AllowNil(String)
+              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
+
+              link :product
+              link :video
+              link :direct
+              link :interactive_player
+            end
+
+            link :self
+          end
+        end
+      end
+
+      registrations(:carousel) {}
+    end
+  end
+end

data/lib/trailer_vote/media_types/client_configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Client Configuration
+    #
+    # The client configuration media type is used when a client, such as the SDK clients, want to configure the
+    # TrailerVote services. When accepted, the TrailerVote services may use the passed configurations to return specific
+    # responses based on that configuration. For example, the {Configuration} from the root endpoint changed based on
+    # the values.
+    #
+    class ClientConfiguration < BaseText
+      media_type 'client_configuration', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          attribute :configuration do
+            attribute :place, String
+            attribute :persona, String
+          end
+        end
+      end
+
+      registrations :client_configuration do
+        versions 1
+        type_alias 'client-configuration'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/configuration.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Configuration
+    #
+    class Configuration < BaseText
+      media_type 'configuration', defaults: { suffix: :json, version: 2 }
+
+      validations do
+        version 2 do
+          attribute :configuration do
+            link :self
+            link :place
+            link :products
+            link :product_lookup
+            link :persona do
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, AllowNil(String)
+            end
+            link :telemetrics do
+              attribute :href, AllowNil(String)
+            end
+          end
+        end
+
+        version 1 do
+          attribute :configuration do
+            link :place
+            link :feedback do
+              attribute :templated, TrueClass
+            end
+            link :persona do
+              attribute :templated, TrueClass
+            end
+            link :analytics do
+              attribute :href, AllowNil(String)
+            end
+          end
+        end
+      end
+
+      registrations :configuration do
+        versions 1, 2
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/errors.rb

@@ -0,0 +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

data/lib/trailer_vote/media_types/feedback.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require_relative './types/uuid_v4'
+require_relative './types/vote_value'
+
+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, String
+
+            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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require_relative './types/vote_value'
+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, String
+
+              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

@@ -0,0 +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

data/lib/trailer_vote/media_types/interactive_player.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+
+module TrailerVote
+  module MediaTypes
+    class InteractivePlayer < BaseText
+      media_type 'interactive_player'
+
+      defaults do
+        suffix :json
+        version 1
+      end
+
+      validations do
+        version 1 do
+          attribute :interactive_player do
+            attribute :title, AllowNil(String)
+
+            link :self
+            link :advert
+            link :direct
+            link :product
+          end
+        end
+      end
+
+      registrations :interactive_player do
+        type_alias 'interactive-player'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/partials/image_links.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'media_types'
+
+module TrailerVote
+  module MediaTypes
+    module Partials
+      IMAGE_LINKS = ::MediaTypes::Scheme.new do
+        link :self
+        link :original
+        link :thumbnail, optional: true
+        link :xlarge, optional: true
+        link :large, optional: true
+        link :medium, optional: true
+        link :small, optional: true
+        link :xsmall, optional: true
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/persona.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require_relative './types/uuid_v4'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Persona
+    #
+    # A Persona is a uniquely identified person / a unique device. When someone uses the SDK, the client MUST generate a
+    # UUID v4 and use that as Persona. This allows the API to link Feedback on Audio Fragments to a Persona, and MAY act
+    # as likes/dislikes (interests/disinterests).
+    #
+    class Persona < BaseText
+      media_type 'persona', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          attribute :persona do
+            attribute :id, Types::UuidV4
+            link :self
+            link :feedback
+          end
+
+          view('create') {}
+        end
+      end
+
+      registrations :persona do
+        view 'create', :create_persona
+
+        versions 1
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/place.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require_relative './types/uuid_v4'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for places
+    #
+    # Each set of credentials has a Place associated to it. A place might be the HQ of an enterprise, or a physical
+    # location on the map. You can always access all the data of your place and all the children, as the places in our
+    # system are configured to be a tree.
+    #
+    class Place < BaseText
+      media_type 'place', defaults: { suffix: :json, version: 2 }
+
+      validations do
+        index_scheme = ::MediaTypes::Scheme.new do
+          attribute :places do
+            collection :_index, allow_empty: true do
+              attribute :href, String
+              not_strict
+            end
+
+            not_strict
+          end
+        end
+
+        version 2 do
+          version_2_base = ::MediaTypes::Scheme.new do
+            attribute :name, String
+            attribute :parent_place, AllowNil(Types::UuidV4)
+            attribute :deleted_at, AllowNil(String)
+            attribute :updated_at, String
+
+            link :self
+            link :products_archive
+            link :parent, allow_nil: true
+          end
+
+          attribute :place do
+            merge version_2_base
+          end
+
+          view 'create' do
+            attribute :place do
+              attribute :name, String
+              attribute :parent_place, String
+              attribute :deleted_at, AllowNil(String)
+            end
+          end
+
+          view 'collection' do
+            attribute :places do
+              collection :_embedded, version_2_base
+              not_strict
+            end
+          end
+
+          view 'index' do
+            merge index_scheme
+          end
+        end
+
+        version 1 do
+          version_1_base = ::MediaTypes::Scheme.new do
+            attribute :name, String
+            attribute :parent_place, AllowNil(String)
+            attribute :deleted_at, AllowNil(String)
+            attribute :updated_at, String
+
+            link :self
+            link :products
+            link :parent, allow_nil: true
+          end
+
+          attribute :place do
+            merge version_1_base
+          end
+
+          view 'collection' do
+            attribute :places do
+              collection :_embedded, version_1_base
+              not_strict
+            end
+          end
+
+          view 'index' do
+            merge index_scheme
+          end
+        end
+      end
+
+      registrations :place do
+        view 'create', :create_place
+        view 'index', :place_urls
+        view 'collection', :places
+
+        versions 1, 2
+      end
+    end
+  end
+end