trailer_vote-media_types 0.9.3 → 0.10.0

data/Rakefile

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task default: :test
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -1,16 +1,16 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'trailer_vote/media_types'
-require 'awesome_print'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'trailer_vote/media_types'
+require 'awesome_print'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/trailer_vote/media_types.rb

@@ -1,33 +1,35 @@
-# frozen_string_literal: true
-
-require 'media_types'
-require_relative './media_types/version'
-
-require_relative './media_types/base_text'
-require_relative './media_types/audio_fragment'
-require_relative './media_types/configuration'
-require_relative './media_types/client_configuration'
-require_relative './media_types/errors'
-require_relative './media_types/fingerprint_binary'
-require_relative './media_types/product_lookup'
-require_relative './media_types/sentiment_feedback'
-require_relative './media_types/carousel'
-require_relative './media_types/feedback_listing'
-require_relative './media_types/interactive_player'
-require_relative './media_types/products_listing'
-require_relative './media_types/feedback'
-require_relative './media_types/persona'
-require_relative './media_types/place'
-require_relative './media_types/product'
-require_relative './media_types/product_image'
-require_relative './media_types/product_place_link'
-require_relative './media_types/product_video'
-require_relative './media_types/issue'
-
-module TrailerVote
-  module MediaTypes
-    INDEX_VIEW = ::MediaTypes::INDEX_VIEW
-    COLLECTION_VIEW = ::MediaTypes::COLLECTION_VIEW
-    CREATE_VIEW = ::MediaTypes::CREATE_VIEW
-  end
-end
+# frozen_string_literal: true
+
+require 'media_types'
+require_relative './media_types/version'
+
+require_relative './media_types/base_text'
+require_relative './media_types/audio_fragment'
+require_relative './media_types/configuration'
+require_relative './media_types/client_configuration'
+require_relative './media_types/errors'
+require_relative './media_types/fingerprint_binary'
+require_relative './media_types/product_lookup'
+require_relative './media_types/sentiment_feedback'
+require_relative './media_types/carousel'
+require_relative './media_types/feedback_listing'
+require_relative './media_types/interactive_player'
+require_relative './media_types/products_listing'
+require_relative './media_types/feedback'
+require_relative './media_types/persona'
+require_relative './media_types/place'
+require_relative './media_types/product'
+require_relative './media_types/product_image'
+require_relative './media_types/product_place_link'
+require_relative './media_types/product_video'
+require_relative './media_types/push_trivial_campaign'
+require_relative './media_types/push_manifest'
+require_relative './media_types/issue'
+
+module TrailerVote
+  module MediaTypes
+    INDEX_VIEW = ::MediaTypes::INDEX_VIEW
+    COLLECTION_VIEW = ::MediaTypes::COLLECTION_VIEW
+    CREATE_VIEW = ::MediaTypes::CREATE_VIEW
+  end
+end

data/lib/trailer_vote/media_types/audio_fragment.rb

@@ -1,108 +1,108 @@
-# frozen_string_literal: true
-
-require_relative 'base_text'
-require_relative 'types/http_url'
-require_relative 'types/iso8601'
-
-module TrailerVote
-  module MediaTypes
-
-    ##
-    # Media Types for Audio Fragments
-    #
-    # Audio Fragments are recognizable using {FingerprintBinary}. It might be an advertisement, a trailer or a sound
-    # bite. They belong to a {Product}. Audio fragments are used for recognition, e.g. showing an advertisement when
-    # it's recognised, and used for feedback, i.e. a requirement to record and store {Feedback}.
-    #
-    class AudioFragment < BaseText
-
-      # @!method to_constructable
-      #   Returns the construtable media type
-      #
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable ::MediaTypes::Constructable
-      #   @return [::MediaTypes::Constructable] a constructable
-      #
-      media_type 'audio_fragment', defaults: { suffix: :json, version: 1 }
-
-      # @!method valid?(data, constructed_media_type, **opts)
-      #   Validates the +data+ against the validation for +constructed_media_type+.
-      #
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme#valid%3F-instance_method ::MediaTypes::Scheme#valid?
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable#valid%3F-instance_method ::MediaTypes::Constructable#valid?
-      #
-      #   @param [Object] data the data to validate
-      #   @param [Constructable, String] constructed_media_type something that resolved into a media type with validations
-      #   @param [Hash] opts passed on to {::MediaTypes::Scheme#valid?}
-      #
-      #   @return [TrueClass, FalseClass] true if valid, false otherwise
-      #
-      # @!method validate!(data, constructed_media_type, **opts)
-      #   Validates the +data+ against the validation for +constructed_media_type+. Raises if invalid
-      #
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme#validate-instance_method ::MediaTypes::Scheme#validate
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable#validate!-instance_method ::MediaTypes::Constructable#validate!
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme/ValidationError ::MediaTypes::Scheme::ValidationError
-      #
-      #   @param [Object] data the data to validate
-      #   @param [Constructable, String] constructed_media_type something that resolved into a media type with validations
-      #   @param [Hash] opts passed on to {::MediaTypes::Scheme#validate}
-      #
-      #   @raise ::MediaTypes::Scheme::ValidationError an error if the scheme is not valid
-      #   @return [TrueClass] true if valid
-      #
-      validations do
-        version 1 do
-          version_1_base = ::MediaTypes::Scheme.new do
-            attribute :content_addressable, String
-            attribute :expires_at, AllowNil(Types::Iso8601)
-
-            link :self
-            link :product
-            link :feedback
-            link :advert
-            link :direct, optional: true
-          end
-
-          attribute :audio_fragment do
-            merge version_1_base
-          end
-
-          view 'index' do
-            attribute :audio_fragments do
-              collection :_index, allow_empty: true do
-                attribute :href, Types::HttpUrl
-                not_strict
-              end
-
-              not_strict
-            end
-          end
-
-          view 'collection' do
-            attribute :audio_fragments do
-              collection :_embedded, version_1_base, allow_empty: true
-              not_strict
-            end
-          end
-        end
-      end
-
-      # @!method register
-      #   Registers all the known permutations of versions, views, suffixes and aliases for this media type via
-      #   {::MediaTypes.register}
-      #
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes#register-class-method ::Mediatypes.register
-      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Registerable ::Mediatypes::Registerable
-      #
-      #   @return [Array<::MediaTypes::Registerable>]
-      registrations :audio_fragment do
-        view 'index', :audio_fragment_urls
-        view 'collection', :audio_fragments
-
-        versions 1
-
-        type_alias 'audio-fragment'
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'base_text'
+require_relative 'types/http_url'
+require_relative 'types/iso8601'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Audio Fragments
+    #
+    # Audio Fragments are recognizable using {FingerprintBinary}. It might be an advertisement, a trailer or a sound
+    # bite. They belong to a {Product}. Audio fragments are used for recognition, e.g. showing an advertisement when
+    # it's recognised, and used for feedback, i.e. a requirement to record and store {Feedback}.
+    #
+    class AudioFragment < BaseText
+
+      # @!method to_constructable
+      #   Returns the construtable media type
+      #
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable ::MediaTypes::Constructable
+      #   @return [::MediaTypes::Constructable] a constructable
+      #
+      media_type 'audio_fragment', defaults: { suffix: :json, version: 1 }
+
+      # @!method valid?(data, constructed_media_type, **opts)
+      #   Validates the +data+ against the validation for +constructed_media_type+.
+      #
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme#valid%3F-instance_method ::MediaTypes::Scheme#valid?
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable#valid%3F-instance_method ::MediaTypes::Constructable#valid?
+      #
+      #   @param [Object] data the data to validate
+      #   @param [Constructable, String] constructed_media_type something that resolved into a media type with validations
+      #   @param [Hash] opts passed on to {::MediaTypes::Scheme#valid?}
+      #
+      #   @return [TrueClass, FalseClass] true if valid, false otherwise
+      #
+      # @!method validate!(data, constructed_media_type, **opts)
+      #   Validates the +data+ against the validation for +constructed_media_type+. Raises if invalid
+      #
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme#validate-instance_method ::MediaTypes::Scheme#validate
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable#validate!-instance_method ::MediaTypes::Constructable#validate!
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme/ValidationError ::MediaTypes::Scheme::ValidationError
+      #
+      #   @param [Object] data the data to validate
+      #   @param [Constructable, String] constructed_media_type something that resolved into a media type with validations
+      #   @param [Hash] opts passed on to {::MediaTypes::Scheme#validate}
+      #
+      #   @raise ::MediaTypes::Scheme::ValidationError an error if the scheme is not valid
+      #   @return [TrueClass] true if valid
+      #
+      validations do
+        version 1 do
+          version_1_base = ::MediaTypes::Scheme.new do
+            attribute :content_addressable, String
+            attribute :expires_at, AllowNil(Types::Iso8601)
+
+            link :self
+            link :product
+            link :feedback
+            link :advert
+            link :direct, optional: true
+          end
+
+          attribute :audio_fragment do
+            merge version_1_base
+          end
+
+          view 'index' do
+            attribute :audio_fragments do
+              collection :_index, allow_empty: true do
+                attribute :href, Types::HttpUrl
+                not_strict
+              end
+
+              not_strict
+            end
+          end
+
+          view 'collection' do
+            attribute :audio_fragments do
+              collection :_embedded, version_1_base, allow_empty: true
+              not_strict
+            end
+          end
+        end
+      end
+
+      # @!method register
+      #   Registers all the known permutations of versions, views, suffixes and aliases for this media type via
+      #   {::MediaTypes.register}
+      #
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes#register-class-method ::Mediatypes.register
+      #   @see https://www.rubydoc.info/gems/media_types/MediaTypes/Registerable ::Mediatypes::Registerable
+      #
+      #   @return [Array<::MediaTypes::Registerable>]
+      registrations :audio_fragment do
+        view 'index', :audio_fragment_urls
+        view 'collection', :audio_fragments
+
+        versions 1
+
+        type_alias 'audio-fragment'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/base_text.rb

@@ -1,22 +1,22 @@
-# frozen_string_literal: true
-
-require 'media_types'
-
-module TrailerVote
-  module MediaTypes
-    class BaseText
-      include ::MediaTypes::Dsl
-
-      class << self
-
-        protected
-
-        BASE_TEXT_FORMAT = 'application/vnd.trailervote.%<type>s.v%<version>s.%<view>s+%<suffix>s'
-
-        def base_format
-          BASE_TEXT_FORMAT
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'media_types'
+
+module TrailerVote
+  module MediaTypes
+    class BaseText
+      include ::MediaTypes::Dsl
+
+      class << self
+
+        protected
+
+        BASE_TEXT_FORMAT = 'application/vnd.trailervote.%<type>s.v%<version>s.%<view>s+%<suffix>s'
+
+        def base_format
+          BASE_TEXT_FORMAT
+        end
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/carousel.rb

@@ -1,42 +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
+# 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