trailer_vote-media_types 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f98f974c07395747cb305e0decfbba8f0b55c01b
-  data.tar.gz: b7d07d6dcada4d6d0a07e3423cfe555119705570
+  metadata.gz: 926ad35dab8657d957fee399fca27858da92ff86
+  data.tar.gz: ed70f02bdf523fee98124088ce13dce593da415f
 SHA512:
-  metadata.gz: a9b902007b4417d44a04ebc12986e7eec12d05bac6a451771dfe7f1b1d36454497b67d19a8d24c46a0fb6eedef5ae5149c7d9a148a236657ef620c4829970cdf
-  data.tar.gz: f74410cc2caedb5f3d74cb8de32020421b5a0d6208016c45c95bb39c0d550f6d3cd2d0dd5472e608c4b2acf16945fa86ebdf8b29f5bd780582772795094ffe8a
+  metadata.gz: 84cf671dc44bbff7f2be93740f3b0abdf4ba8c0e510e342f9324a360a8acc355e680fe96164d825db911b17f7c31a18d6914ac2c6f53a2937da91760942b3d54
+  data.tar.gz: 75dfc602858601f3810ec46c98ec5760f3235be6b2448a86425a1677cd6848aa4b3d9a0f9d721fb6d6e107e369473ca3a7a2d9ae22e2913993b283c086cda384

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 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.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    trailer_vote-media_types (0.5.0)
-      media_types (~> 0.5.5)
+    trailer_vote-media_types (0.6.0)
+      media_types (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,7 +12,7 @@ GEM
     builder (3.2.3)
     docile (1.3.1)
     json (2.1.0)
-    media_types (0.5.5)
+    media_types (0.6.0)
     minitest (5.11.3)
     minitest-ci (3.4.0)
       minitest (>= 5.0.6)

data/README.md

@@ -15,6 +15,16 @@ And then execute:
 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
 

data/lib/trailer_vote/media_types/audio_fragment.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
+require_relative 'base_text'
+require_relative 'types/https_url'
+require_relative 'types/iso8601'
 
 module TrailerVote
   module MediaTypes
@@ -52,7 +54,7 @@ module TrailerVote
         version 1 do
           version_1_base = ::MediaTypes::Scheme.new do
             attribute :content_addressable, String
-            attribute :deleted_at, AllowNil(String)
+            attribute :expires_at, AllowNil(Types::Iso8601)
 
             link :self
             link :product
@@ -68,7 +70,7 @@ module TrailerVote
           view 'index' do
             attribute :audio_fragments do
               collection :_index, allow_empty: true do
-                attribute :href, String
+                attribute :href, Types::HttpsUrl
                 not_strict
               end
 

data/lib/trailer_vote/media_types/carousel.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './partials/image_links'
+require_relative 'base_text'
+require_relative 'partials/image_links'
 
 module TrailerVote
   module MediaTypes

data/lib/trailer_vote/media_types/client_configuration.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
+require_relative 'base_text'
+require_relative 'types/https_url'
 
 module TrailerVote
   module MediaTypes
@@ -19,8 +20,8 @@ module TrailerVote
       validations do
         version 1 do
           attribute :configuration do
-            attribute :place, String
-            attribute :persona, String
+            attribute :place, Types::HttpsUrl
+            attribute :persona, Types::HttpsUrl
           end
         end
       end

data/lib/trailer_vote/media_types/configuration.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
+require_relative 'base_text'
+require_relative 'types/influx_db_connection_url'
+require_relative 'types/formatted_url'
 
 module TrailerVote
   module MediaTypes
@@ -19,13 +21,14 @@ module TrailerVote
             link :products
             link :product_lookup
             link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
               attribute :templated, TrueClass
             end
             link :analytics do
-              attribute :href, AllowNil(String)
+              attribute :href, Types::InfluxDbConnectionUrl
             end
             link :telemetrics do
-              attribute :href, AllowNil(String)
+              attribute :href, Types::InfluxDbConnectionUrl
             end
           end
         end
@@ -34,13 +37,15 @@ module TrailerVote
           attribute :configuration do
             link :place
             link :feedback do
+              attribute :href, Types.makeFormattedUrl(:uuid)
               attribute :templated, TrueClass
             end
             link :persona do
+              attribute :href, Types.makeFormattedUrl(:uuid)
               attribute :templated, TrueClass
             end
             link :analytics do
-              attribute :href, AllowNil(String)
+              attribute :href, AllowNil(Types::InfluxDbConnectionUrl)
             end
           end
         end

data/lib/trailer_vote/media_types/feedback.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './types/uuid_v4'
-require_relative './types/vote_value'
+require_relative 'base_text'
+require_relative 'types/uuid_v4'
+require_relative 'types/vote_value'
+require_relative 'types/iso8601'
 
 module TrailerVote
   module MediaTypes
@@ -13,7 +14,7 @@ module TrailerVote
         version 1 do
           version_1_base = ::MediaTypes::Scheme.new do
             attribute :value, Types::VoteValue
-            attribute :updated_at, String
+            attribute :updated_at, Types::Iso8601
 
             link :audio_fragment
             link :product

data/lib/trailer_vote/media_types/feedback_listing.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './types/vote_value'
-require_relative './partials/image_links'
+require_relative 'base_text'
+require_relative 'types/vote_value'
+require_relative 'types/iso8601'
+require_relative 'partials/image_links'
 
 module TrailerVote
   module MediaTypes
@@ -20,7 +21,7 @@ module TrailerVote
             collection :items, allow_empty: true do
               attribute :title, AllowNil(String)
               attribute :value, Types::VoteValue
-              attribute :updated_at, String
+              attribute :updated_at, Types::Iso8601
 
               link :audio_fragment
               link :product

data/lib/trailer_vote/media_types/interactive_player.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
+require_relative 'base_text'
 
 module TrailerVote
   module MediaTypes

data/lib/trailer_vote/media_types/persona.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './types/uuid_v4'
+require_relative 'base_text'
+require_relative 'types/uuid_v4'
 
 module TrailerVote
   module MediaTypes

data/lib/trailer_vote/media_types/place.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './types/uuid_v4'
+require_relative 'base_text'
+require_relative 'types/uuid_v4'
+require_relative 'types/iso8601'
 
 module TrailerVote
   module MediaTypes
@@ -32,8 +33,8 @@ module TrailerVote
           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
+            attribute :expires_at, AllowNil(String)
+            attribute :updated_at, Types::Iso8601
 
             link :self
             link :products_archive
@@ -48,7 +49,7 @@ module TrailerVote
             attribute :place do
               attribute :name, String
               attribute :parent_place, String
-              attribute :deleted_at, AllowNil(String)
+              attribute :expires_at, AllowNil(Types::Iso8601)
             end
           end
 
@@ -68,8 +69,8 @@ module TrailerVote
           version_1_base = ::MediaTypes::Scheme.new do
             attribute :name, String
             attribute :parent_place, AllowNil(String)
-            attribute :deleted_at, AllowNil(String)
-            attribute :updated_at, String
+            attribute :expires_at, AllowNil(String)
+            attribute :updated_at, Types::Iso8601
 
             link :self
             link :products

data/lib/trailer_vote/media_types/product.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './types/product_data_type'
+require_relative 'base_text'
+require_relative 'types/product_data_type'
+require_relative 'types/iso8601'
 
 module TrailerVote
   module MediaTypes
@@ -63,7 +64,7 @@ module TrailerVote
           end
 
           version_2_base = ::MediaTypes::Scheme.new do
-            attribute :updated_at, String
+            attribute :updated_at, Types::Iso8601
             attribute :lock_version, Numeric
 
             merge version_2_creation
@@ -126,7 +127,7 @@ module TrailerVote
           end
 
           version_1_base = ::MediaTypes::Scheme.new do
-            attribute :updated_at, String
+            attribute :updated_at, Types::Iso8601
             attribute :lock_version, Numeric
 
             merge version_1_creation

data/lib/trailer_vote/media_types/product_image.rb

@@ -2,9 +2,11 @@
 
 require 'media_types'
 
-require_relative './base_text'
-require_relative './types/product_image_type'
-require_relative './types/boolean'
+require_relative 'base_text'
+require_relative 'types/product_image_type'
+require_relative 'types/boolean'
+require_relative 'types/iso8601'
+require_relative 'types/https_url'
 
 module TrailerVote
   module MediaTypes
@@ -15,12 +17,12 @@ module TrailerVote
         version 1 do
           version_1_creation = ::MediaTypes::Scheme.new do
             attribute :identifier, String
-            attribute :source_url, String
-            attribute :deleted_at, AllowNil(String), optional: true
+            attribute :source_url, Types::HttpsUrl
+            attribute :expires_at, AllowNil(Types::Iso8601), optional: true
           end
 
           version_1_base = ::MediaTypes::Scheme.new do
-            attribute :updated_at, String
+            attribute :updated_at, Types::Iso8601
 
             merge version_1_creation
 
@@ -90,7 +92,7 @@ module TrailerVote
           view :index do
             attribute :product_images do
               collection :_index do
-                attribute :href, String
+                attribute :href, Types::HttpsUrl
                 not_strict
               end
 

data/lib/trailer_vote/media_types/product_lookup.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
+require_relative 'base_text'
 require 'media_types/scheme/any_of'
 
 module TrailerVote
@@ -24,7 +24,7 @@ module TrailerVote
         version 1 do
           collection 'product_identifiers', expected_type: nil do
             attribute :authority, String
-            attribute :identifier
+            attribute :identifier, String
           end
         end
       end

data/lib/trailer_vote/media_types/product_place_link.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
+require_relative 'base_text'
+require_relative 'types/https_url'
 
 module TrailerVote
   module MediaTypes
@@ -16,9 +17,7 @@ module TrailerVote
           end
 
           view 'create' do
-            attribute :place do
-              attribute :id, String
-            end
+            attribute :place, Types::HttpsUrl
           end
         end
       end

data/lib/trailer_vote/media_types/product_video.rb

@@ -2,11 +2,12 @@
 
 require 'media_types'
 
-require_relative './base_text'
-require_relative './types/boolean'
-require_relative './types/product_movie_type'
-require_relative './types/product_movie_handler'
-
+require_relative 'base_text'
+require_relative 'types/boolean'
+require_relative 'types/product_movie_type'
+require_relative 'types/product_movie_handler'
+require_relative 'types/iso8601'
+require_relative 'types/https_url'
 
 module TrailerVote
   module MediaTypes
@@ -17,12 +18,12 @@ module TrailerVote
         version 1 do
           version_1_creation = ::MediaTypes::Scheme.new do
             attribute :identifier, String
-            attribute :source_url, String
-            attribute :deleted_at, AllowNil(String), optional: true
+            attribute :source_url, Types::HttpsUrl
+            attribute :expires_at, AllowNil(Types::Iso8601), optional: true
           end
 
           version_1_base = ::MediaTypes::Scheme.new do
-            attribute :updated_at, String
+            attribute :updated_at, Types::Iso8601
 
             merge version_1_creation
 
@@ -69,7 +70,7 @@ module TrailerVote
           view :index do
             attribute :product_videos do
               collection :_index do
-                attribute :href, String
+                attribute :href, Types::HttpsUrl
                 not_strict
               end
 

data/lib/trailer_vote/media_types/products_listing.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './partials/image_links'
+require_relative 'base_text'
+require_relative 'partials/image_links'
+require_relative 'types/iso8601'
 
 module TrailerVote
   module MediaTypes
@@ -18,7 +19,7 @@ module TrailerVote
           attribute :products_listing do
             collection :items, allow_empty: true do
               attribute :title, AllowNil(String)
-              attribute :publish_date, AllowNil(String)
+              attribute :publish_date, AllowNil(Types::Iso8601)
 
               link :product
 

data/lib/trailer_vote/media_types/sentiment_feedback.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require_relative './base_text'
-require_relative './types/product_image_type'
-require_relative './partials/image_links'
+require_relative 'base_text'
+require_relative 'partials/image_links'
+require_relative 'types/product_image_type'
+require_relative 'types/iso8601'
 
 module TrailerVote
   module MediaTypes
@@ -19,7 +20,7 @@ module TrailerVote
             attribute :image, expected_type: AllowNil(::Hash), allow_empty: true, optional: true do
               attribute :_embedded do
                 attribute :identifier, String
-                attribute :updated_at, String
+                attribute :updated_at, Types::Iso8601
                 attribute :asset_type, Types::ProductImageType
 
                 merge Partials::IMAGE_LINKS
@@ -39,7 +40,7 @@ module TrailerVote
             attribute :images do
               collection :_embedded, allow_empty: true do
                 attribute :identifier, String
-                attribute :updated_at, String
+                attribute :updated_at, Types::Iso8601
                 attribute :asset_type, Types::ProductImageTypeV1
 
                 link :self

data/lib/trailer_vote/media_types/types/formatted_url.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module MediaTypes
+    module Types
+      module_function
+
+      class FormattedUrl
+
+        class UnexpectedFormatVariable < ::MediaTypes::Scheme::ValidationError
+          def initialize(variables:, actual:)
+            self.variables = variables
+            self.actual = actual
+          end
+
+          def message
+            format(
+              'Expected a formatted url only containing %<variables>s, instead got %<actual>s',
+              variables: variables,
+              actual: actual
+            )
+          end
+
+          private
+
+          attr_accessor :variables, :actual
+        end
+
+        def initialize(*variables)
+          @variables = variables.map { |variable| "{#{variable}}" }
+          variable_options = @variables.map { |variable| Regexp.escape(variable) }
+          sections_first = "(?>#{variable_options.push('[^\s\/$.?#\{\}]').join('|')})"
+          sections_not_first = "(?>#{variable_options.push('[^\\s\\{\\}]').join('|')})"
+
+          @test = %r{^https:\/\/#{sections_first}#{sections_not_first}*$}
+        end
+
+        def ===(other)
+          return true if @test.match?(other)
+          raise UnexpectedFormatVariable.new(variables: @variables, actual: other)
+        end
+      end
+
+      # noinspection RubyInstanceMethodNamingConvention
+      #
+      def makeFormattedUrl(*variables) # rubocop:disable Naming/MethodName
+        FormattedUrl.new(*variables)
+      end
+    end
+  end
+end

data/lib/trailer_vote/media_types/types/https_url.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module MediaTypes
+    module Types
+      # noinspection RubyConstantNamingConvention
+      #
+      # https://mathiasbynens.be/demo/url-regex
+      #
+      # RFC compliant for http, https and ftp:
+      # _^(?:(?:https?|ftp)://)(?:\S+(?::\S*)?@)?(?:(?!10(?:\.\d{1,3}){3})(?!127(?:\.\d{1,3}){3})
+      # (?!169\.254(?:\.\d{1,3}){2})(?!192\.168(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})
+      # (?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.
+      # (?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\x{00a1}-\x{ffff}0-9]+-?)*[a-z\x{00a1}-\x{ffff}0-9]+)(?:\.
+      # (?:[a-z\x{00a1}-\x{ffff}0-9]+-?)*[a-z\x{00a1}-\x{ffff}0-9]+)*(?:\.(?:[a-z\x{00a1}-\x{ffff}]{2,})))(?::\d{2,5})?
+      # (?:/[^\s]*)?$_iuS
+      #
+      # The one used here actually passes all valid urls, but just doesn't reject ALL invalid ones
+      #
+      HttpsUrl = %r{^https:\/\/[^\s\/$.?#].[^\s]*$} # rubocop:disable Naming/ConstantName
+    end
+  end
+end

data/lib/trailer_vote/media_types/types/influx_db_connection_url.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module MediaTypes
+    module Types
+      # noinspection RubyConstantNamingConvention
+      InfluxDbConnectionUrl = %r{^https:\/\/[^\s\/$.?#].[^\s]*$} # rubocop:disable Naming/ConstantName
+    end
+  end
+end

data/lib/trailer_vote/media_types/types/iso8601.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrailerVote
+  module MediaTypes
+    module Types
+      # noinspection RubyConstantNamingConvention
+      Iso8601 = /^([+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24:?00)([.,]\d+(?!:))?)?(\17[0-5]\d([.,]\d+)?)?([zZ]|([+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?$/ # rubocop:disable Naming/ConstantName
+    end
+  end
+end

data/lib/trailer_vote/media_types/version.rb

@@ -2,6 +2,6 @@
 
 module TrailerVote
   module MediaTypes
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

data/trailer_vote-media_types.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'media_types', '~> 0.5.5'
+  spec.add_runtime_dependency 'media_types', '~> 0.6.0'
 
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler', '~> 1.16'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailer_vote-media_types
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-04 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: media_types
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,10 @@ files:
 - lib/trailer_vote/media_types/products_listing.rb
 - lib/trailer_vote/media_types/sentiment_feedback.rb
 - lib/trailer_vote/media_types/types/boolean.rb
+- lib/trailer_vote/media_types/types/formatted_url.rb
+- lib/trailer_vote/media_types/types/https_url.rb
+- lib/trailer_vote/media_types/types/influx_db_connection_url.rb
+- lib/trailer_vote/media_types/types/iso8601.rb
 - lib/trailer_vote/media_types/types/product_data_type.rb
 - lib/trailer_vote/media_types/types/product_image_type.rb
 - lib/trailer_vote/media_types/types/product_movie_handler.rb