trailer_vote-media_types 0.5.0

data/lib/trailer_vote/media_types/product.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require_relative './types/product_data_type'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Products
+    #
+    # Products are all things that are the subject of Audio Fragments (advertisements, trailers, sound bites). This can
+    # be a book; a movie; a car; a drink; anything that would be a product in the real world. Recognition is done on the
+    # audio fragments, not on products directly.
+    #
+    # A product has attachments, such as data, {ProductImage}, and recognizable {AudioFragment}.
+    #
+    class Product < BaseText
+      media_type 'product', defaults: { suffix: :json, version: 2 }
+
+      validations do
+        index_scheme = ::MediaTypes::Scheme.new do
+          attribute :products do
+            collection :_index, allow_empty: true do
+              attribute :href, String
+              not_strict
+            end
+
+            not_strict
+          end
+        end
+
+        version 2 do
+          version_2_creation = ::MediaTypes::Scheme.new do
+            attribute :name, String
+            attribute :description, AllowNil(String)
+
+            collection :product_identifiers do
+              attribute :authority, String
+              attribute :identifier, String
+            end
+
+            attribute :data do
+              any do
+                attribute :type, Types::ProductDataType
+                attribute :type_version, Numeric
+
+                attribute :translations do
+                  any do
+                    attribute :name, AllowNil(String)
+                    attribute :description, AllowNil(String)
+                  end
+                end
+
+                not_strict
+              end
+            end
+
+            attribute :raw_data, optional: true do
+              # noinspection RubyBlockToMethodReference
+              not_strict
+            end
+          end
+
+          version_2_base = ::MediaTypes::Scheme.new do
+            attribute :updated_at, String
+            attribute :lock_version, Numeric
+
+            merge version_2_creation
+
+            link :self
+            link :images
+            link :videos
+            link :places
+            link :audio_fragments
+          end
+
+          attribute :product do
+            merge version_2_base
+          end
+
+          view 'create' do
+            attribute :product do
+              merge version_2_creation
+            end
+          end
+
+          view 'collection' do
+            attribute :products do
+              collection :_embedded, version_2_base
+              not_strict
+            end
+          end
+
+          view 'index' do
+            merge index_scheme
+          end
+        end
+
+        version 1 do
+
+          version_1_creation = ::MediaTypes::Scheme.new do
+            attribute :name, String
+            attribute :description, AllowNil(String)
+
+            collection :product_identifiers do
+              attribute :authority, String
+              attribute :identifier, String
+            end
+
+            attribute :data do
+              any do
+                attribute :type, Types::ProductDataType
+                attribute :type_version, Numeric
+                attribute :name, AllowNil(String)
+                attribute :description, AllowNil(String)
+
+                not_strict
+              end
+            end
+
+            attribute :raw_data, optional: true do
+              # noinspection RubyBlockToMethodReference
+              not_strict
+            end
+          end
+
+          version_1_base = ::MediaTypes::Scheme.new do
+            attribute :updated_at, String
+            attribute :lock_version, Numeric
+
+            merge version_1_creation
+
+            link :self
+            link :images
+            link :videos
+            link :places
+            link :audio_fragments
+          end
+
+          attribute :product do
+            merge version_1_base
+          end
+
+          view 'create' do
+            attribute :product do
+              merge version_1_creation
+            end
+          end
+
+          view 'collection' do
+            attribute :products do
+              collection :_embedded, version_1_base
+              not_strict
+            end
+          end
+
+          view 'index' do
+            merge index_scheme
+          end
+        end
+      end
+
+      registrations :product do
+        view 'index', :product_urls
+        view 'collection', :products
+        view 'create', :create_product
+
+        versions 1, 2
+
+        type_alias 'product.movie'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/product_image.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'media_types'
+
+require_relative './base_text'
+require_relative './types/product_image_type'
+require_relative './types/boolean'
+
+module TrailerVote
+  module MediaTypes
+    class ProductImage < BaseText
+      media_type 'product.image', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          version_1_creation = ::MediaTypes::Scheme.new do
+            attribute :identifier, String
+            attribute :source_url, String
+            attribute :deleted_at, AllowNil(String), optional: true
+          end
+
+          version_1_base = ::MediaTypes::Scheme.new do
+            attribute :updated_at, String
+
+            merge version_1_creation
+
+            attribute :data do
+              attribute :processed, Types::Boolean
+              attribute :type, Types::ProductImageType
+
+              not_strict
+            end
+
+            link :self
+            link :original, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+            link :thumbnail, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+            link :xlarge, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+            link :large, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+            link :medium, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+            link :small, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+            link :xsmall, allow_nil: true, optional: true do
+              attribute :content_digest, String
+              attribute :width, Numeric
+              attribute :height, Numeric
+            end
+          end
+
+          attribute :product_image do
+            merge version_1_base
+          end
+
+          view 'create' do
+            attribute :product_image do
+              merge version_1_creation
+              not_strict
+            end
+          end
+
+          view 'collection' do
+            attribute :product_images do
+              collection :_embedded, version_1_base
+              not_strict
+            end
+          end
+
+          view :index do
+            attribute :product_images do
+              collection :_index do
+                attribute :href, String
+                not_strict
+              end
+
+              not_strict
+            end
+          end
+        end
+      end
+
+      registrations :product_image do
+        view 'create', :create_product_image
+        view 'index', :product_image_urls
+        view 'collection', :product_images
+
+        type_alias 'product-image'
+        type_alias 'image'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/product_lookup.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+require 'media_types/scheme/any_of'
+
+module TrailerVote
+  module MediaTypes
+
+    ##
+    # Media Types for Product Lookups
+    #
+    # The product lookup is used to find products by means of an authority and identifier. An identifier **MUST** be
+    # unique for that authority. For example, on TMDb each movie has (at least) one identifier, but no two movies share
+    # a TMDb identifier.
+    #
+    # Each product on TrailerVote can have any number of authority-identifier pairs, and a client **SHOULD** lookup a
+    # product which each pair known simultaneously. For example, many movies on TMDb are also on IMDB and have an IMDB
+    # identifier.
+    #
+    class ProductLookup < BaseText
+      media_type 'product.lookup', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          collection 'product_identifiers', expected_type: nil do
+            attribute :authority, String
+            attribute :identifier
+          end
+        end
+      end
+
+      registrations(:product_lookup) do
+        type_alias 'product-lookup'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/product_place_link.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+
+module TrailerVote
+  module MediaTypes
+    class ProductPlaceLink < BaseText
+      media_type 'product_place_link', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+
+          attribute :product_place_link do
+            link :place
+            link :product
+          end
+
+          view 'create' do
+            attribute :place do
+              attribute :id, String
+            end
+          end
+        end
+      end
+
+      registrations do
+        view 'collection', :product_place_links
+        view 'create', :create_product_place_link
+        view 'index', :product_place_link_urls
+
+        type_alias 'place_product_link'
+        type_alias 'place-product-link'
+        type_alias 'product-place-link'
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/product_video.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'media_types'
+
+require_relative './base_text'
+require_relative './types/boolean'
+require_relative './types/product_movie_type'
+require_relative './types/product_movie_handler'
+
+
+module TrailerVote
+  module MediaTypes
+    class ProductVideo < BaseText
+      media_type 'product.video', defaults: { suffix: :json, version: 1 }
+
+      validations do
+        version 1 do
+          version_1_creation = ::MediaTypes::Scheme.new do
+            attribute :identifier, String
+            attribute :source_url, String
+            attribute :deleted_at, AllowNil(String), optional: true
+          end
+
+          version_1_base = ::MediaTypes::Scheme.new do
+            attribute :updated_at, String
+
+            merge version_1_creation
+
+            attribute :data do
+              attribute :processed, Types::Boolean
+              attribute :transcoded, Types::Boolean
+              attribute :type, Types::ProductMovieType
+              attribute :as, Types::ProductMovieHandler
+
+              not_strict
+            end
+
+            link :self
+            link :audio_fragment do
+              attribute :content_digest, String
+            end
+            link :direct, allow_nil: true, optional: true
+
+            # link :original do
+            #   attribute :content_digest, String
+            #   attribute :width, Numeric
+            #   attribute :height, Numeric
+            # end
+          end
+
+          attribute :product_video do
+            merge version_1_base
+          end
+
+          view 'create' do
+            attribute :video do
+              merge version_1_creation
+              not_strict
+            end
+          end
+
+          view 'collection' do
+            attribute :videos do
+              collection :_embedded, version_1_base
+              not_strict
+            end
+          end
+
+          view :index do
+            attribute :product_videos do
+              collection :_index do
+                attribute :href, String
+                not_strict
+              end
+
+              not_strict
+            end
+          end
+        end
+      end
+
+      registrations :product_video do
+        view 'create', :create_product_video
+        view 'index', :product_video_urls
+        view 'collection', :product_videos
+
+        type_alias 'product-video'
+        type_alias 'video'
+      end
+    end
+  end
+end