media_types-serialization 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737a38bc10cd0c3aff8fa9bc33c3c192098709eb331f7c35706840410ff3d280
-  data.tar.gz: d6311d9a1b27329e4164cb7bf3b8e839ce96419b05e9a9e42d033d7ba2942a50
+  metadata.gz: f668e10a02f800afc30da2c1438f99e4a50fb2b726cc829d490998f2f1997933
+  data.tar.gz: f0d711b09c45a03c7cfbac9238ac6f1e6f6f24b701d631f236b1986f19d80ca2
 SHA512:
-  metadata.gz: c6fad7b09ecc516290fb5e0393ee5a790c128a75402cdb977c396b6dac01b30748b63f5631b001b7eaa9d9c1b8007e814200d9be7766afa757d1c93785bc34f8
-  data.tar.gz: ea95bb41414b2125ac3af7efe42ff9c5e521f36a7bae2930760dd52fdee3e58e1175e5aaa8f03d3eb27bf5022d089f0542f4bc51b418cee05ae3724ba3756779
+  metadata.gz: 9f6e2dec7c6409279f226dc0c6b3dff609273bd72330f055397c0e2f7be54eab5b032d33192590486f898d9cca3f8cedd69c6c1a519e104a56942a40ae4b2565
+  data.tar.gz: bda722326eca550e19cc8ab656896423f092a8b8c14436a37b4e51c88f0c5191b85a3b682dc3ead1c9e38b277e5a233c4741eb6cddeff5af68b89c3ed0a22230

data/.github/workflows/ci.yml

@@ -13,21 +13,20 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        ruby-version: [2.7.x, 2.6.x]
+        ruby-version: [2.7.x, 2.6.x, 2.5.x]
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby ${{ matrix.ruby-version }}
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake
+      - uses: actions/checkout@v1
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.3.5
+
+- 🐛 Upgrade media-types library so Ruby 2.5 and 2.6 work again
+
 ## 1.3.4
 
 - Same as `1.3.3`

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (1.3.4)
+    media_types-serialization (1.3.5)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
-      media_types (>= 2.1.0, < 3.0.0)
+      media_types (>= 2.1.1, < 3.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -66,7 +66,7 @@ GEM
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (1.0.1)
-    media_types (2.1.0)
+    media_types (2.1.1)
     method_source (1.0.0)
     mini_mime (1.1.0)
     minitest (5.14.4)
@@ -75,7 +75,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.12.3-x86_64-linux)
       racc (~> 1.4)
-    oj (3.13.1)
+    oj (3.13.2)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
@@ -96,7 +96,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.1)
       loofah (~> 2.3)
     railties (5.2.6)
       actionpack (= 5.2.6)
@@ -134,4 +134,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.2.7
+   2.2.17

data/README.md

@@ -224,7 +224,7 @@ There are convenience methods for serializing arrays of objects based on a templ
 #### Indexes
 
 An index is a collection of urls that point to members of the array.
-The index method automatically generates it based on the self links defined in the default view of the same version.
+The index method automatically generates it based on the `self` links defined in the default view (`view: nil`) of the given version.
 
 ```ruby
 class BookSerializer < MediaTypes::Serialization::Base
@@ -264,6 +264,88 @@ BookSerializer.serialize([book], BookValidator.view(:index).version(3), context:
 #    }
 ```
 
+##### How to validate?
+
+The `index` dsl does _not_ exist in the validation gem. This is how you validate indices:
+
+```ruby
+class BookValidator
+  include MediaTypes::Dsl
+
+  def self.organisation
+    'acme'
+  end
+
+  use_name 'book'
+
+  validations do
+    view :index do
+      version 3 do
+        attribute :books do
+          link :self
+          
+          collection :_index, allow_empty: true do
+            attribute :href, String
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+If the `:self` link contains _more attributes_, they will show up here too.
+
+```ruby
+class BookSerializer < MediaTypes::Serialization::Base
+  validator BookValidator
+
+  output versions: [1, 2, 3] do |obj, version, context|
+    attribute :book do
+      link :self, href: context.book_url(obj), isbn: obj.isbn if version >= 3
+
+      attribute :title, obj.title
+      attribute :description, obj.description if version >= 2
+    end
+  end
+
+  output view: :index, version: 3 do |arr, version, context|
+    attribute :books do
+      link :self, href: context.book_index_url
+
+      index arr, version: version
+    end
+  end
+end
+```
+
+```ruby
+class BookValidator
+  include MediaTypes::Dsl
+
+  def self.organisation
+    'acme'
+  end
+
+  use_name 'book'
+
+  validations do
+    view :index do
+      version 3 do
+        attribute :books do
+          link :self
+          
+          collection :_index, allow_empty: true do
+            attribute :href, String
+            attribute :isbn, AllowNil(String)
+          end
+        end
+      end
+    end
+  end
+end
+```
+
 #### Collections
 
 A collection inlines the member objects.
@@ -321,6 +403,37 @@ BookSerializer.serialize([book], BookValidator.view(:collection).version(3), con
 #    }
 ```
 
+The `collection` dsl is _not_ the same as the one in the validation gem. This is how you could validate collections:
+
+```ruby
+class BookValidator
+  include MediaTypes::Dsl
+
+  def self.organisation
+    'acme'
+  end
+
+  use_name 'book'
+
+  validations do
+    view :collection do
+      version 3 do
+        attribute :books do
+          link :self
+          
+          collection :_embedded, allow_empty: true do
+            link :self
+
+            attribute :title, String
+            attribute :description, AllowNil(String)
+          end
+        end
+      end
+    end
+  end
+end
+```
+
 ### Input deserialization
 
 You can mark a media type as something that's allowed to be sent along with a PUT request as follows:
@@ -460,6 +573,9 @@ While this is not a good practise as this makes it hard to add new fields or rem
 class BookSerializer < MediaTypes::Serialization::Base
   validator BookValidator
 
+  # applicaton/vnd.acme.book.v3+json
+  # applicaton/vnd.acme.book.v2+json
+  # applicaton/vnd.acme.book.v1+json
   output versions: [1, 2, 3] do |obj, version, context|
     attribute :book do
       link :self, href: context.book_url(obj) if version >= 3
@@ -468,8 +584,18 @@ class BookSerializer < MediaTypes::Serialization::Base
       attribute :description, obj.description if version >= 2
     end
   end
-  output_alias 'application/json' # maps application/json to to applicaton/vnd.acme.book.v1+json
+  
+  # applicaton/vnd.acme.book+json
+  output version: nil do |obj, version, context|
+    attribute :book do
+      attribute :title, obj.title
+    end
+  end
+  output_alias 'application/json' # maps application/json to to applicaton/vnd.acme.book+json
 
+  # applicaton/vnd.acme.book.v3.create+json
+  # applicaton/vnd.acme.book.v2.create+json
+  # applicaton/vnd.acme.book.v1.create+json
   input view: :create, versions: [1, 2, 3] do |json, version, context|
     book = Book.new
     book.title = json['book']['title']
@@ -479,10 +605,20 @@ class BookSerializer < MediaTypes::Serialization::Base
     # Make sure not to save here but only save in the controller
     book
   end
-  input_alias 'application/json', view: :create # maps application/json to to applicaton/vnd.acme.book.v1+json
+  
+  # applicaton/vnd.acme.book.create+json
+  input view: :create, version: nil do |json, version, context|
+    book = Book.new
+    book.title = json['book']['title']
+    book.description = 'Not available'
+
+    # Make sure not to save here but only save in the controller
+    book
+  end
+  input_alias 'application/json', view: :create # maps application/json to to applicaton/vnd.acme.book.create+json
 ```
 
-Validation will be done using the remapped validator. Aliasses map to version `nil` if that is available or `1` otherwise. It is not possible to configure this version.
+Validation will be done using the remapped validator. Aliasses map to version `nil`. It is not possible to configure this version.
 
 ### HTML
 

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '1.3.4'.freeze
+    VERSION = '1.3.5'.freeze
   end
 end

data/media_types-serialization.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '>= 4.0.0'
   spec.add_dependency 'activesupport', '>= 4.0.0'
-  spec.add_dependency 'media_types', '>= 2.1.0', '< 3.0.0'
+  spec.add_dependency 'media_types', '>= 2.1.1', '< 3.0.0'
 
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -45,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -55,7 +55,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.1.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0