media_types 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faf9748b5c2757571da930bcebbf8216c9f639ca
-  data.tar.gz: 5918fdae5f969af80f14687214edbf396a8f3a22
+  metadata.gz: 51e9f9e92cf850d365ca58a68a04f6791b095c89
+  data.tar.gz: 9669e70024f81a716c39e8a494e1b653db29d761
 SHA512:
-  metadata.gz: 3168ce3f29ef159acb44c9abc5944b3cd3bb859b547760588a3b778edfb17f7ff2062a9ae64d76224a6fbbaf7286133e21b73b080904c15a773b399a9f15265f
-  data.tar.gz: 604fdfbd5753e3c1e6656e8e124be298e34402edab4dfa006bffe4ab7e19848824e2a09a9787175a333da5ab2fd7efd3fee849036ca09c85ded1ded2ced6cfdd
+  metadata.gz: 6580805136858569152b54e947a464791e67cb398c151f57fe3200fcc1274ab2305fddafe18c958c038c66bbd0667565870ca89e7d34f3a73b11ddbc15bcfdd0
+  data.tar.gz: 60606b31427128bbc4a5bdd13068e7f5d2af90db2d698f86d618acce8ca31989283112dfd08daae7d1cf6012635234745a97f0127e26a21157c79727c1f09565

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.6.0
+
+- Change default expected type for `attribute` to Object
+- Remove default `actionpack` calls for `.register`
+- Add integration for registering with `actionpack` (rails)
+- Add integration for registering with `http` (http.rb)
+- Fix stack overflow for cyclic schema
+
 # 0.5.5
 
 - Fix an issue with `attribute(optional:, &block)` not passing `optional:` to the created `collection`.

data/Gemfile.lock

@@ -1,16 +1,56 @@
 PATH
   remote: .
   specs:
-    media_types (0.5.5)
+    media_types (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     ansi (1.5.0)
     awesome_print (1.8.0)
     builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
     docile (1.3.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.7.1)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
     json (2.1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
     minitest (5.11.3)
     minitest-ci (3.4.0)
       minitest (>= 5.0.6)
@@ -19,6 +59,18 @@ GEM
       builder
       minitest (>= 5.0)
       ruby-progressbar
+    nokogiri (1.8.4-x64-mingw32)
+      mini_portile2 (~> 2.3.0)
+    oj (3.6.11)
+    public_suffix (3.0.3)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
     rake (10.5.0)
     ruby-progressbar (1.10.0)
     simplecov (0.16.1)
@@ -26,17 +78,26 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5-x64-mingw32)
 
 PLATFORMS
   x64-mingw32
 
 DEPENDENCIES
+  actionpack
   awesome_print
   bundler (~> 1.16)
+  http
   media_types!
   minitest (~> 5.0)
   minitest-ci
   minitest-reporters
+  oj
   rake (~> 10.0)
   simplecov
 

data/README.md

@@ -4,6 +4,8 @@
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) 
 [![Maintainability](https://api.codeclimate.com/v1/badges/6f2dc1fb37ecb98c4363/maintainability)](https://codeclimate.com/github/SleeplessByte/media-types-ruby/maintainability)
 
+Media Types based on  scheme, with versioning, views, suffixes and validations. Integrations available for [Rails](https://github.com/rails/rails) / ActionPack and [http.rb](https://github.com/httprb/http).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,8 +27,7 @@ Or install it yourself as:
 By default there are no media types registered or defined, except for an abstract base type.
 
 ## Definition
-You can define media types by inheriting from this base type, or create your own base type with a class method
-`.base_format` that is used to create the final media type string by injecting formatted parameters:
+You can define media types by inheriting from this base type, or create your own base type with a class method `.base_format` that is used to create the final media type string by injecting formatted parameters:
 
 - `%<type>s`: the type `media_type` received
 - `%<version>s`: the version, defaults to `:current_version`
@@ -104,7 +105,7 @@ Adds an attribute to the schema, if a +block+ is given, uses that to test agains
 |-------|------|-------------|
 | key | `Symbol` | the attribute name |
 | opts | `Hash` | options to pass to `Scheme` or `Attribute` |
-| type | `Class`, `===`, Scheme | The type of the value, can be anything that responds to `===`,  or scheme to use if no `&block` is given. Defaults to `String` without a `&block` and to Hash with a `&block`. |
+| type | `Class`, `===`, Scheme | The type of the value, can be anything that responds to `===`,  or scheme to use if no `&block` is given. Defaults to `Object` without a `&block` and to Hash with a `&block`. |
 | optional: | `TrueClass`, `FalseClass` | if true, key may be absent, defaults to `false` |
 | &block | `Block` | defines the scheme of the value of this attribute |
 
@@ -261,23 +262,6 @@ MyMedia.valid?({ _links: { self: { href: 'https://example.org/s' }, image: { hre
 # => true
 ```
 
-
-#### Link with extra attributes
-```Ruby
-class MyMedia
-  include MediaTypes::Dsl
-
-  validations do
-    link :image do
-      attribute :templated, TrueClass
-    end
-  end
-end
-
-MyMedia.valid?({ _links: { self: { href: 'https://example.org/s' }, image: { href: 'https://image.org/i' }} })
-# => true
-```
-
 #### Link with extra attributes
 ```Ruby
 class MyMedia
@@ -351,27 +335,48 @@ Venue.mime_type.view('active').to_s
 # => "application/vnd.mydomain.venue.v2.active+json"
 ```
 
-## Register in Rails or Rack
-Define a `registrations` block on your media type, indicating the symbol for the base type (`registrations :symbol do`)
-and inside use the registrations dsl to define which media types to register. `versions array_of_numbers` determines which versions, 
-`suffix name` adds a suffix, `type_alias name` adds an alias and `view name, symbol` adds a view.
+## Integrations
+The integrations are not loaded by default, so you need to require them:
+```ruby
+# For Rails / ActionPack
+require 'media_types/integrations/actionpack'
+
+# For HTTP.rb
+require 'media_types/integrations/http' 
+```
+
+Define a `registrations` block on your media type, indicating the symbol for the base type (`registrations :symbol do`) and inside use the registrations dsl to define which media types to register. `versions array_of_numbers` determines which versions, `suffix name` adds a suffix, `type_alias name` adds an alias and `view name, symbol` adds a view.
 
-As long as `action_dispatch` is available, you can register the mime type with `action_dispatch/http/mime_type`:
 ```Ruby
 Venue.register
-# => Mime type is now available using the symbol, or lookup the actual mimetype
 ```
 
-You can do this in the `mime_types` initializer, or anywhere before your controllers are instantiated. Yes, the symbol
-(by default `<type>_v<version>_<suffix>`) can now be used in your `format` blocks, or as extension in the url.
+### Rails
+Load the `actionpack` integration and call `.register` on all the media types you want to be available in Rails. You can do this in the `mime_types` initializer, or anywhere before your controllers are instantiated. Yes, the symbol (by default `<type>_v<version>_<suffix>`) can now be used in your `format` blocks, or as extension in the url.
+
+Rails only has a default serializer for `application/json`, and content with your `+json` media types (or different once) will not be deserialized by default. A way to overcome this is to set the JSON parameter parser for all new symbols. `.register` gives you back an array of `Registerable` objects that responds to `#to_sym` to get that symbol.
+
+```ruby
+symbols = Venue.register.map(&:to_sym)
+
+original_parsers = ActionDispatch::Request.parameter_parsers
+new_parser = original_parsers[Mime[:json].symbol]
+new_parsers = original_parsers.merge(Hash[*symbols.map { |s| [s, new_parser] }])
+ActionDispatch::Request.parameter_parsers = new_parsers
+```
+
+If you want to validate the content-type and not have your errors be `Rack::Error` but be handled by your controllers, leave this out and add a `before_action` to your controller that deserializes + validates for you.
+
+### HTTP.rb
+Load the `http` integration and call `.register` on all media types you want to be able to serialize and deserialize. The media type validations will run both before serialization and after deserialization.
+
+Currently uses `oj` under the hood and this can not be changed.
 
 ## 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.
+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`, call `bundle exec rake release` to create a new git tag, push git commits and tags, and
+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`, call `bundle exec rake release` to create a new git tag, push git commits and tags, and
 push the `.gem` file to rubygems.org.
 
 ## Contributing

data/lib/media_types.rb

@@ -8,30 +8,10 @@ require 'media_types/object'
 require 'media_types/scheme'
 require 'media_types/dsl'
 
-module MediaTypes
-  # Shortcut used by #collection to #view('collection')
-  COLLECTION_VIEW = 'collection'
-
-  # Shortcut used by #index to #view('index')
-  INDEX_VIEW = 'index'
-
-  # Shortcut used by #create to #view('create')
-  CREATE_VIEW = 'create'
-
-  module_function
+require 'media_types/views'
+require 'media_types/integrations'
 
-  ##
-  # Called when Registerar#register is called
-  # @param [Registerable] registerable
-  def register(registerable)
-    require 'action_dispatch/http/mime_type'
-
-    mime_type = registerable.to_s
-    symbol = registerable.to_sym
-    synonyms = registerable.aliases
-
-    Mime::Type.register(mime_type, symbol, synonyms)
-  end
+module MediaTypes
 end
 
 

data/lib/media_types/dsl.rb

@@ -59,21 +59,28 @@ module MediaTypes
                                                      .version(defaults.fetch(:version) { nil })
                                                      .suffix(defaults.fetch(:suffix) { nil })
                                                      .view(defaults.fetch(:view) { nil })
+        self
       end
 
       def defaults(&block)
         return media_type_constructable unless block_given?
         self.media_type_constructable = Defaults.new(to_constructable, &block).to_constructable
+
+        self
       end
 
       def registrations(symbol = nil, &block)
         return media_type_registrar unless block_given?
         self.media_type_registrar = Registrar.new(self, symbol: symbol, &block)
+
+        self
       end
 
       def validations(&block)
         return media_type_validations unless block_given?
         self.media_type_validations = Validations.new(to_constructable, &block)
+
+        self
       end
     end
   end

data/lib/media_types/integrations.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MediaTypes
+  INTEGRATION_METHODS = %i[register].freeze
+
+  module_function
+
+  def integrate(integration)
+    INTEGRATION_METHODS.each do |method|
+      next unless integration.respond_to?(method)
+      self.integrations = (integrations || {}).tap do |x|
+        x.merge!(method => (x[method] || []).concat([integration]))
+      end
+    end
+  end
+
+  # @!method register(registerable)
+  INTEGRATION_METHODS.each do |method|
+    define_singleton_method method do |*args, &block|
+      (integrations || {}).fetch(method) { [] }.each do |integration|
+        integration.send(method, *args, &block)
+      end
+    end
+
+  end
+
+  class << self
+    private
+
+    attr_accessor :integrations
+  end
+end

data/lib/media_types/integrations/actionpack.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'action_dispatch/http/mime_type'
+
+module MediaTypes
+  module ActionPackIntegration
+
+    module_function
+
+    def register(registerable)
+      mime_type = registerable.to_s
+      symbol = registerable.to_sym
+      synonyms = registerable.aliases
+
+      Mime::Type.register(mime_type, symbol, synonyms)
+    end
+  end
+
+  integrate ActionPackIntegration
+end
+

data/lib/media_types/integrations/http.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'http/mime_type'
+require 'oj'
+
+module MediaTypes
+  module HttpIntegration
+
+    module_function
+
+    def register(registerable)
+      mime_type = registerable.to_s
+
+      HTTP::MimeType.register_adapter mime_type, AdapterFor(registerable.media_type)
+      HTTP::MimeType.register_alias mime_type, registerable.to_sym
+
+      registerable.aliases.each do |alias_mime_type|
+        HTTP::MimeType.register_alias mime_type, alias_mime_type
+      end
+    end
+
+    class << self
+      private
+
+      # noinspection RubyInstanceMethodNamingConvention
+      def AdapterFor(media_type) # rubocop:disable Naming/MethodName
+        adapter_name = media_type.split(%r{[./_+-]}).map(&:capitalize).join('').tr('^A-z0-9', '_')
+
+        adapter = MediaTypes::HttpIntegration.const_set(adapter_name, Module.new)
+        adapter.define_singleton_method('encode') do |obj|
+          media_type.validate!(obj)
+          Oj.dump(obj, mode: :compat)
+        end
+
+        adapter.define_singleton_method('decode') do |str|
+          Oj.load(str, mode: :strict).tap do |result|
+            media_type.validate!(result)
+          end
+        end
+
+        adapter
+      end
+    end
+  end
+
+  integrate HttpIntegration
+end

data/lib/media_types/scheme.rb

@@ -115,7 +115,8 @@ module MediaTypes
     # @param key [Symbol] the attribute name
     # @param opts [Hash] options to pass to Scheme or Attribute
     # @param type [Class, #===, Scheme] The type of the value, can be anything that responds to #===,
-    #   or scheme to use if no +&block+ is given. Defaults to String without a +&block+ and to Hash with a +&block+.
+    #   or scheme to use if no +&block+ is given. Defaults to Object without a +&block+ and to Hash with a +&block+.
+    #   or scheme to use if no +&block+ is given. Defaults to Object without a +&block+ and to Hash with a +&block+.
     #
     # @see Scheme::Attribute
     # @see Scheme
@@ -148,7 +149,7 @@ module MediaTypes
     #   MyMedia.valid?({ foo: { bar: 'my-string' }})
     #   # => true
     #
-    def attribute(key, type = String, optional: false, **opts, &block)
+    def attribute(key, type = ::Object, optional: false, **opts, &block)
       if block_given?
         return collection(key, expected_type: ::Hash, optional: optional, **opts, &block)
       end

data/lib/media_types/scheme/rules.rb

@@ -88,6 +88,8 @@ module MediaTypes
 
       def inspect(indent = 0)
         prefix = '  ' * indent
+        return "#{prefix}[Error]Depth limit reached[/Error]" if indent > 5_000
+
         [
           "#{prefix}[Rules n=#{keys.length} optional=#{optional_keys.length}]",
           "#{prefix}  #{inspect_format_attribute(indent, '*', default)}",

data/lib/media_types/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MediaTypes
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

data/lib/media_types/views.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MediaTypes
+  # Shortcut used by #collection to #view('collection')
+  COLLECTION_VIEW = 'collection'
+
+  # Shortcut used by #index to #view('index')
+  INDEX_VIEW = 'index'
+
+  # Shortcut used by #create to #view('create')
+  CREATE_VIEW = 'create'
+end

data/media_types.gemspec

@@ -23,11 +23,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'actionpack'
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'http'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-ci'
   spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'oj'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: media_types
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +174,9 @@ files:
 - lib/media_types/dsl.rb
 - lib/media_types/formatter.rb
 - lib/media_types/hash.rb
+- lib/media_types/integrations.rb
+- lib/media_types/integrations/actionpack.rb
+- lib/media_types/integrations/http.rb
 - lib/media_types/minitest/assert_media_type_format.rb
 - lib/media_types/minitest/assert_media_types_registered.rb
 - lib/media_types/object.rb
@@ -154,6 +199,7 @@ files:
 - lib/media_types/scheme/validation_options.rb
 - lib/media_types/validations.rb
 - lib/media_types/version.rb
+- lib/media_types/views.rb
 - media_types.gemspec
 homepage: https://github.com/SleeplessByte/media-types-ruby
 licenses: []