trailer_vote-media_types 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f98f974c07395747cb305e0decfbba8f0b55c01b
+  data.tar.gz: b7d07d6dcada4d6d0a07e3423cfe555119705570
+SHA512:
+  metadata.gz: a9b902007b4417d44a04ebc12986e7eec12d05bac6a451771dfe7f1b1d36454497b67d19a8d24c46a0fb6eedef5ae5149c7d9a148a236657ef620c4829970cdf
+  data.tar.gz: f74410cc2caedb5f3d74cb8de32020421b5a0d6208016c45c95bb39c0d550f6d3cd2d0dd5472e608c4b2acf16945fa86ebdf8b29f5bd780582772795094ffe8a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/test/reports/
+/tmp/
+
+/.byebug_history
+/.rakeTasks
+

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - 'lib/**/*.rb'
+  Exclude:
+    - 'Gemfile'
+    - 'bin/**/*'
+  TargetRubyVersion: 2.3
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/IfUnlessModifier:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+  - 2.4
+  - 2.5
+  - 2.6
+  - rbx-3
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-3
+    - rvm: 2.6
+before_install:
+  - gem update --system
+  - gem --version
+install:
+  - bundle install --with development --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.5.0
+
+:baby: initial public release. Not considered stable until version 1.0.0.

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in trailer_vote-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    trailer_vote-media_types (0.5.0)
+      media_types (~> 0.5.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    awesome_print (1.8.0)
+    builder (3.2.3)
+    docile (1.3.1)
+    json (2.1.0)
+    media_types (0.5.5)
+    minitest (5.11.3)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.3.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    oj (3.6.11)
+    rake (10.5.0)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  minitest-ci
+  minitest-reporters
+  oj
+  rake (~> 10.0)
+  simplecov
+  trailer_vote-media_types!
+
+BUNDLED WITH
+   1.16.5

data/README.md

@@ -0,0 +1,105 @@
+# TrailerVote::MediaTypes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trailer_vote-media_types'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trailer_vote-media_types
+
+## Usage
+
+This gem is based on [`media_types`](https://github.com/SleeplessByte/media-types-ruby), and inherits all the functionality from that gem. In general, you can use `trailer_vote-media_types` in the following ways:
+
+### `Accept` and `Content-Type` construction
+
+All the media types can be turned into a header value, both acceptable for the `Accept` and `Content-Type` headers:
+
+```ruby
+TrailerVote::MediaTypes::Configuration.to_constructable.version(2).to_s
+# => "application/vnd.trailervote.configuration.v2+json"
+```
+
+The [`Constructable`](https://www.rubydoc.info/gems/media_types/MediaTypes/Constructable) result of `#to_constructable` allows for chaining the various options in our media types, namely `view` (e.g. `index`, `create`) and `version`. The default `suffix` is none for binary types and `json` for text type, as we don't support XML at the moment.
+
+It is **recommended** to always include `.version(n)`, otherwise you will get the newest version, which might not be what you support in the code.
+
+### `Accept` with quality parameter
+
+If you want to have multiple `Accept` values, but with different priorities, `Constructable#to_s` accepts an additional parameter to set this. For example, if you want to make a fully qualified `Accept` header and you prefer product version 2, but accept version 1 as well:
+
+```ruby
+[
+    TrailerVote::MediaTypes::Product.to_constructable.version(2).to_s,
+    TrailerVote::MediaTypes::Product.to_constructable.version(1).to_s(0.9),
+    TrailerVote::MediaTypes::Errors.to_constructable.version(1).to_s(0.1)
+].join(', ')
+# => "application/vnd.trailervote.configuration.product.v2+json,
+#       application/vnd.trailervote.configuration.product.v1+json; q=0.9,
+#       application/vnd.trailervote.errors.v1+json; q=0.1"
+```
+
+### Data validation
+
+All the media types come equipped with validations, for most known / expected permutations of views and versions. Validations are based on [`Scheme`](https://www.rubydoc.info/gems/media_types/MediaTypes/Scheme) from the [`media_types`](https://github.com/SleeplessByte/media-types-ruby) gem.
+
+```ruby
+media_type = TrailerVote::MediaTypes::ClientConfiguration.to_constructable.version(1)
+# => application/vnd.trailervote.client_configuration.v1+json
+
+media_type.valid?(
+    configuration: {
+        place: "https://fake.trailervote.com/api/places/435ec0b8-100d-4e92-8a17-04bc77e90880",
+        persona: "https://fake.trailervote.com/api/persona/e03a1c72-8bce-408c-a6e4-de215e73dd92"
+    }
+)
+# => true
+
+media_type.validate!(
+    configuration: {
+        place: "https://fake.trailervote.com/api/places/435ec0b8-100d-4e92-8a17-04bc77e90880",
+    }
+)
+# => raises MediaTypes::Scheme::ExhaustedOutputError: Missing keys in output: [:persona] at [.->configuration]
+```
+
+### `Mime::Type` registration
+
+In case you use `action_dispatch/http/mime_type`, you may register the TrailerVote Media Types into the `Mime::Type` registry like so:
+```ruby
+TrailerVote::MediaTypes::Persona.register
+# => [...] # Array of registered types, each version, each suffix permutation, all aliases
+```
+
+You can now look them up in the registry:
+
+```ruby
+media_type = TrailerVote::MediaTypes::Persona.to_constructable.version(1).to_s
+# => "application/vnd.trailervote.persona.v1+json"
+
+Mime::Type.lookup(media_type)
+# => Mime::Type entry
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the
+version number in `version.rb`, and then run `bundle update trailer_vote-media_types` in any repository that depends on
+this gem. If you have permissions, you may call `bundle exec rake release` to create a new git tag, push
+git commits and tags, and push the `.gem` file to the rubygems gem server.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [TrailerVote/trailervote-media-types](https://github.com/TrailerVote/trailervote-media-types)

data/Rakefile

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

data/bin/console

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

data/bin/setup

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

data/lib/trailer_vote/media_types.rb

@@ -0,0 +1,32 @@
+# 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'
+
+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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative './base_text'
+
+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 :deleted_at, AllowNil(String)
+
+            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, String
+                not_strict
+              end
+
+              not_strict
+            end
+          end
+
+          view 'collection' do
+            attribute :audio_fragments do
+              collection :_embedded, version_1_base
+              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

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