trailer_vote-media_types 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0ae94c202f4bcf97f426fd623c9f38f1d0dd47710e1b7808dc632be3d1a69aa
-  data.tar.gz: e0f9e54893cc3bd7e1828f66267b606fb28225eec452d93bf66d916ad87ee87e
+  metadata.gz: c57c38b2a54615d048b410cbb49059bb08512c2659eb885301decd9a5cb4332f
+  data.tar.gz: 5a3eff968faff84bfe7c68ec0d4626cc0c380593a61ed966b971787652c64852
 SHA512:
-  metadata.gz: 27e0ad42f2dd613cc6d0801bd8d9555796ea7f1e96461e1c4d6fb990a8dd5966214d691a9db9876956ed55b963c75d01a04e15e43b46e90f1d4eb89aaf8e2f28
-  data.tar.gz: dbbdee01421b632bed52aeb124a96f76847e1e743b3eaf3e85ac112bec1fc44378556ef3950096dab31756bed0f1193fe15af80ad92850f7f3319bae6dda578a
+  metadata.gz: 0b5e311947d3c7e450c2a41ea5670e9661d4e7e4adbd6b2b30f65a59b5fe994f6c5eeb5a36aa6afd7b0ab3b536a8e006b3ab75d9605f98e3b5cdecb1103b655a
+  data.tar.gz: acf04c53066fbf6ba185d065c6914fae105b442335fa72ea6af7fc9b3662ca07e5ed15a3d72e59ba26287a222a1d99730fdd5eba5336e1b651279a8d6c416923

data/.gitignore

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

data/.rubocop.yml

@@ -1,29 +1,29 @@
-AllCops:
-  Include:
-    - '**/Rakefile'
-    - 'lib/**/*.rb'
-  Exclude:
-    - 'Gemfile'
-    - 'bin/**/*'
-  TargetRubyVersion: 2.4
-
-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
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - 'lib/**/*.rb'
+  Exclude:
+    - 'Gemfile'
+    - 'bin/**/*'
+  TargetRubyVersion: 2.4
+
+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

@@ -1,19 +1,19 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 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}
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 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

@@ -1,82 +1,82 @@
-# Changelog
-
-## 0.9.2
-
-- Add vimeo as video handler
-
-## 0.9.1
-
-- Allow empty for various `index` and `collection` views
-
-## 0.9.0
-
-- Add `issue` media type
-- Update `trailer_vote-fixtures` to 1.2.0
-
-## 0.8.1
-
-- Use external `trailer_vote-fixtures`
-
-## 0.8.0
-
-- Add `Issue` media type
-- Add `issues` link to configuration media type
-
-## 0.7.6
-
-- Allow `content_*` to be `nil`
-
-## 0.7.5
-
-- Add `content_language` and `content_region` to assets
-
-## 0.7.4
-
-- Allow `type` on partial `image_links` (such as sentiment_feedback)
-
-## 0.7.3
-
-- Add `type` to image self link
-- Add `type` to image index links
-- Add `type` to video self link
-- Add `type` to video index links
-
-## 0.7.2
-
-- Allow for `content_digest` and dimensions on image links (output)
-
-## 0.7.1
-
-- Fix version 2 of sentiment feedback not registering
-- Change default version of sentiment feedback to v2
-
-## 0.7.0
-
-- Add `products` link to configuration v1
-- Add scheme validation for `data` property of products
-
-## 0.6.3
-
-- Fix `product_video` create root key
-
-## 0.6.2
-
-- Loosen Gem dependency versions to allow any minor update, except for dogfooded gems, which are allowed major updates, until they hit 1.0.0
-- Add metadata urls for gemspec
-
-## 0.6.1
-
-- Allow for http urls because not all services in all environments may operate with TLS enabled.
-
-## 0.6.0
-
-- Update `media_types` to `0.6.0` so that the integrations become available downstream.
-- Rename all `deleted_at` to `expires_at` (#1)
-- Add `Types::HttpsUrl`, `Types::InfluxDbConnectionUrl`, `Types.makeFormattedUrl`, `Types.Iso8601` to check format of string attributes. (#2)
-- Add documentation for `updated_at` fields (#4)
-- Add expected type for `ProductLookup` `identifier` (#5)
-- Remove optional nil for analytics and metrics url by changing the type (#3)
-
-## 0.5.0
-
-:baby: initial public release. Not considered stable until version 1.0.0.
+# Changelog
+
+## 0.9.2
+
+- Add vimeo as video handler
+
+## 0.9.1
+
+- Allow empty for various `index` and `collection` views
+
+## 0.9.0
+
+- Add `issue` media type
+- Update `trailer_vote-fixtures` to 1.2.0
+
+## 0.8.1
+
+- Use external `trailer_vote-fixtures`
+
+## 0.8.0
+
+- Add `Issue` media type
+- Add `issues` link to configuration media type
+
+## 0.7.6
+
+- Allow `content_*` to be `nil`
+
+## 0.7.5
+
+- Add `content_language` and `content_region` to assets
+
+## 0.7.4
+
+- Allow `type` on partial `image_links` (such as sentiment_feedback)
+
+## 0.7.3
+
+- Add `type` to image self link
+- Add `type` to image index links
+- Add `type` to video self link
+- Add `type` to video index links
+
+## 0.7.2
+
+- Allow for `content_digest` and dimensions on image links (output)
+
+## 0.7.1
+
+- Fix version 2 of sentiment feedback not registering
+- Change default version of sentiment feedback to v2
+
+## 0.7.0
+
+- Add `products` link to configuration v1
+- Add scheme validation for `data` property of products
+
+## 0.6.3
+
+- Fix `product_video` create root key
+
+## 0.6.2
+
+- Loosen Gem dependency versions to allow any minor update, except for dogfooded gems, which are allowed major updates, until they hit 1.0.0
+- Add metadata urls for gemspec
+
+## 0.6.1
+
+- Allow for http urls because not all services in all environments may operate with TLS enabled.
+
+## 0.6.0
+
+- Update `media_types` to `0.6.0` so that the integrations become available downstream.
+- Rename all `deleted_at` to `expires_at` (#1)
+- Add `Types::HttpsUrl`, `Types::InfluxDbConnectionUrl`, `Types.makeFormattedUrl`, `Types.Iso8601` to check format of string attributes. (#2)
+- Add documentation for `updated_at` fields (#4)
+- Add expected type for `ProductLookup` `identifier` (#5)
+- Remove optional nil for analytics and metrics url by changing the type (#3)
+
+## 0.5.0
+
+:baby: initial public release. Not considered stable until version 1.0.0.

data/Gemfile

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

@@ -1,51 +1,51 @@
-PATH
-  remote: .
-  specs:
-    trailer_vote-media_types (0.9.2)
-      media_types (>= 0.6.0, < 1)
-
-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.6.0)
-    minitest (5.11.3)
-    minitest-ci (3.4.0)
-      minitest (>= 5.0.6)
-    minitest-reporters (1.3.5)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    oj (3.7.6)
-    rake (10.5.0)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    trailer_vote-fixtures (1.2.0)
-
-PLATFORMS
-  ruby
-  x64-mingw32
-
-DEPENDENCIES
-  awesome_print
-  bundler (~> 1.16)
-  minitest (~> 5.0)
-  minitest-ci (~> 3.4)
-  minitest-reporters (~> 1.3)
-  oj (~> 3.6)
-  rake (~> 10.0)
-  simplecov (~> 0.16)
-  trailer_vote-fixtures (~> 1.2)
-  trailer_vote-media_types!
-
-BUNDLED WITH
-   1.17.3
+PATH
+  remote: .
+  specs:
+    trailer_vote-media_types (0.10.0)
+      media_types (>= 0.6.0, < 1)
+
+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.6.0)
+    minitest (5.11.3)
+    minitest-ci (3.4.0)
+      minitest (>= 5.0.6)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    oj (3.7.8)
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    trailer_vote-fixtures (1.3.1)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  minitest-ci (~> 3.4)
+  minitest-reporters (~> 1.3)
+  oj (~> 3.6)
+  rake (~> 10.0)
+  simplecov (~> 0.16)
+  trailer_vote-fixtures (~> 1.3)
+  trailer_vote-media_types!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -1,118 +1,118 @@
-# TrailerVote::MediaTypes
-[![Build Status](https://travis-ci.com/TrailerVote/trailervote-media-types.svg?branch=master)](https://travis-ci.com/TrailerVote/trailervote-media-types)
-[![Gem Version](https://badge.fury.io/rb/trailer_vote-media_types.svg)](https://badge.fury.io/rb/trailer_vote-media_types)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f5ea339bc868a4e3c362/maintainability)](https://codeclimate.com/github/TrailerVote/trailervote-media-types/maintainability)
-
-## 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
-    
-## Notes
-
-### `updated_at` vs `Last-Modified` headers
-
-When this is used in conjunction with a TrailerVote service, the `updated_at` attributes inside the body of a response will take precedence over any `Last-Modified` header. The `updated_at` value **SHOULD** reflect the last time the resource was updated, whereas the `Last-Modified` value may change when the representation is updated.
-
-### Are ids missing?
-
-No, the `id` or `uuid` attributes are not missing. As per the [TrailerVote API considerations](https://docs.trailervote.com/reference) clients **SHOULD** not need to construct URLs. Both internally and externally, where possible, we refer to resources by their fully qualified URL which _is_ their identifier, instead of something like a UUID.
-
-## 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)
+# TrailerVote::MediaTypes
+[![Build Status](https://travis-ci.com/TrailerVote/trailervote-media-types.svg?branch=master)](https://travis-ci.com/TrailerVote/trailervote-media-types)
+[![Gem Version](https://badge.fury.io/rb/trailer_vote-media_types.svg)](https://badge.fury.io/rb/trailer_vote-media_types)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f5ea339bc868a4e3c362/maintainability)](https://codeclimate.com/github/TrailerVote/trailervote-media-types/maintainability)
+
+## 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
+    
+## Notes
+
+### `updated_at` vs `Last-Modified` headers
+
+When this is used in conjunction with a TrailerVote service, the `updated_at` attributes inside the body of a response will take precedence over any `Last-Modified` header. The `updated_at` value **SHOULD** reflect the last time the resource was updated, whereas the `Last-Modified` value may change when the representation is updated.
+
+### Are ids missing?
+
+No, the `id` or `uuid` attributes are not missing. As per the [TrailerVote API considerations](https://docs.trailervote.com/reference) clients **SHOULD** not need to construct URLs. Both internally and externally, where possible, we refer to resources by their fully qualified URL which _is_ their identifier, instead of something like a UUID.
+
+## 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)