collection_json_serializer 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f682b562eebc07619c02953ffa74bc78cbe6bd20
-  data.tar.gz: 9a23b69d8605c95f7faec47e86d2e14752dcb26d
+  metadata.gz: 2ec98d08e1b7a1d83f75d774fdee42b77895dfdd
+  data.tar.gz: 3e79907d1643600fe2ba316efdb65ab532bee250
 SHA512:
-  metadata.gz: f48bbd38d5c5b65b6cf3592d583379a3e8b67414468fa13ca1c5369179a225f6ecb9267556feded7fa9dc8fad4f50259457f683f44ebbd4be0f9982be9ce75f2
-  data.tar.gz: 4b2fe8dbb795bf652085a3d6f5c82bb76fdf839c97c8bd5580e42ee0b7f26b60d23bfc8f59b23745959623a1c4de20b86199ce938b5cec15c32ac855f92275de
+  metadata.gz: 7ed704824347ead480a3081c0be6ed6045880f348dc25dd19517aa4fc72ed86c9b58c12153363b49e5797bd9391ecb2f7d148167b6bc89114f325d507bf54968
+  data.tar.gz: d065ea2525e44d26844b4d864cd381a345904077e0e2562904a98b1bfba363f873798af779e23ff5d06137f52e5248daf14f38a24b0a782e887875fe3ed041d1

data/.gitignore

@@ -12,3 +12,7 @@
 *.o
 *.a
 mkmf.log
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.5
-  - 2.1.3
-  - 2.1.0
+  - 2
 before_install:
   - gem install bundler

data/README.md

@@ -2,12 +2,14 @@
 
 [![Build Status](https://travis-ci.org/carlesjove/collection_json_serializer.svg?branch=master)](https://travis-ci.org/carlesjove/collection_json_serializer)
 
-| :warning: ** This is _not finished_ yet, so you better do not use it ** |
----------------------------------------------------------------------------
+| :warning: This is _not finished_ yet, so use it at your own risk. |
+--------------------------------------------------------------------
 
 A Ruby gem to respond with Collection+JSON.
 
-CollectionJson::Serializer formats JSON responses following the Collection+JSON media type by Mike Amudsen. It also handles input data templates.
+CollectionJson::Serializer formats JSON responses following the Collection+JSON media type by Mike Amudsen.
+
+Please note that CollectionJson::Serializer only serializes data. You still need to set the proper Headers or media-types in your app.
 
 ## Installation
 
@@ -40,28 +42,39 @@ class UserSerializer < CollectionJson::Serializer
 
   # Please note that links can only be passed as hashes
   links dashboard: { href: "http://example.com/my-dashboard" }
+
+  queries search: {
+    href: "http://example.com/search",
+    name: false # Don't automatically include the name attribute
+  }, pagination: {
+    rel: "page",
+    href: "http://example.com/page",
+    prompt: "Select a page number",
+    data: [
+      { name: "page" }
+    ]
+  }
 end
 ```
 
 Then, you pass your objects to the serializer:
 
 ```ruby
-# Create your object as you wish
 @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
 
+# Pass it to the serializer
+user_serializer = UserSerializer.new(@user)
+
 # You can also pass an array of objects
 # user_serializer = UserSerializer.new([@user1, @user2, etc])
 
-# Pass it to the serializer
-user_serializer = UserSerializer.new(@user)
+# Pass the serializer to the builder
+collection = CollectionJson::Serializer::Builder.new(user_serializer)
+collection.to_json
 
-# Pass the serializer to the builder, and pack it as a hash
-builder = Builder.new(user_serializer)
-builder.pack
+# You can get the collection as a hash, too
+collection.pack
 # => { collection: { version: "1.0" } }
-
-# Get it as JSON
-builder.to_json
 ```
 
 This will generate this Collection+JSON response:
@@ -87,7 +100,19 @@ This will generate this Collection+JSON response:
         { "name": "name", "value": "" },
         { "name": "email", "value": "", "prompt": "My email" }
       ]
-    }
+    },
+    "queries": [{
+      "rel": "search",
+      "href": "http://example.com/search"
+    },{
+      "rel": "page",
+      "href": "http://example.com/page",
+      "name": "pagination",
+      "prompt": "Select a page number",
+      "data": [
+        { "name": "page", "value": "" }
+      ]
+    }]
   }
 }
 ```

data/lib/collection_json_serializer.rb

@@ -14,5 +14,5 @@ require "collection_json_serializer/validator/url"
 require "collection_json_serializer/validator/value"
 
 require "collection_json_serializer/objects/item"
-
 require "collection_json_serializer/objects/template"
+require "collection_json_serializer/objects/query"

data/lib/collection_json_serializer/builder.rb

@@ -28,6 +28,7 @@ module CollectionJson
         add_href if @serializer.href.respond_to? :key
         add_items if @serializer.attributes.present?
         add_template if @serializer.template.present?
+        add_queries if @serializer.queries.present?
       end
 
       def add_href
@@ -51,6 +52,15 @@ module CollectionJson
           new(@serializer)
         @collection[:template].store :data, template.create
       end
+
+      def add_queries
+        @collection.store :queries, Array.new
+        @serializer.queries.each_index do |i|
+          query = CollectionJson::Serializer::Objects::Query.
+            new(@serializer, item: i)
+          @collection[:queries] << query.create
+        end
+      end
     end
   end
 end

data/lib/collection_json_serializer/objects/item.rb

@@ -50,8 +50,9 @@ module CollectionJson
 
             start_object :links, Array.new
             @item[:links] << {
-              name: params[:name].to_s,
-              href: params[:properties][:href]
+              rel: set_rel(params),
+              href: params[:properties][:href],
+              name: params[:name].to_s
             }.merge!(params[:properties])
           end if @serializer.links.present?
         end
@@ -64,6 +65,14 @@ module CollectionJson
           url = @serializer.href[:self] || @serializer.href
           parse_url(url, @resource)
         end
+
+        def set_rel(params)
+          if params[:properties].key? :rel
+            params[:properties][:rel].to_s
+          else
+            params[:name].to_s
+          end
+        end
       end
     end
   end

data/lib/collection_json_serializer/objects/query.rb

@@ -0,0 +1,43 @@
+module CollectionJson
+  class Serializer
+    class Objects
+      class Query
+        def initialize(serializer, item: 0)
+          @serializer = serializer
+          @index = item >= 0 ? item : 0
+          @key = @serializer.queries.first.keys[@index]
+          @resource = @serializer.queries.first[@key]
+          @query = Hash.new
+        end
+
+        def create
+          @query[:rel]  = @resource[:rel] || @key
+          @query[:href] = @resource[:href]
+
+          # Optional fields
+          @query[:name]   = extract_name if name?
+          @query[:prompt] = @resource[:prompt] if @resource[:prompt]
+          @query[:data]   = add_data if @resource[:data]
+
+          @query
+        end
+
+        private
+
+        def extract_name
+          @resource[:name].present? ? @resource[:name] : @key
+        end
+
+        def add_data
+          @resource[:data].each_with_object([]) do |attr, data|
+            data << { name: attr[:name], value: nil.to_s }
+          end
+        end
+
+        def name?
+          @resource[:name] != false
+        end
+      end
+    end
+  end
+end

data/lib/collection_json_serializer/serializer.rb

@@ -5,6 +5,7 @@ module CollectionJson
       attr_accessor :attributes
       attr_accessor :template
       attr_accessor :links
+      attr_accessor :queries
     end
 
     def self.inherited(base)
@@ -12,6 +13,7 @@ module CollectionJson
       base.attributes = []
       base.template = []
       base.links = []
+      base.queries = []
     end
 
     def self.href(*attrs)
@@ -30,6 +32,10 @@ module CollectionJson
       @links.concat attrs
     end
 
+    def self.queries(*attrs)
+      @queries.concat attrs
+    end
+
     attr_accessor :resources
 
     def initialize(resource)
@@ -56,6 +62,10 @@ module CollectionJson
       self.class.links
     end
 
+    def queries
+      self.class.queries
+    end
+
     def invalid?
       Validator.new(self).invalid?
     end

data/lib/collection_json_serializer/validator.rb

@@ -26,7 +26,8 @@ module CollectionJson
           :attributes,
           :href,
           :links,
-          :template
+          :template,
+          :queries
         ].each { |m| send("validate_#{m}") }
       end
 
@@ -98,6 +99,42 @@ module CollectionJson
         end if @serializer.template.any?
       end
 
+      def validate_queries
+        @serializer.queries.each do |query|
+          params = query.extract_params
+
+          unless params[:properties].key? :href
+            error_for :missing_attribute,
+                      root: :queries,
+                      path: [params[:name], "href"]
+
+            next
+          end
+
+          if url_is_invalid? params[:properties][:href]
+            error_for :url, root: :queries, path: [params[:name], "href"]
+          end
+
+          params[:properties].each do |key, value|
+            next if key == :data || key == :href
+
+            if value_is_invalid?(value)
+              error_for :value, root: :queries, path: [params[:name], key]
+            end
+          end
+
+          if params[:properties].key?(:data)
+            params[:properties][:data].each do |hash|
+              if value_is_invalid?(hash[:name])
+                error_for :value,
+                          root: :queries,
+                          path: [params[:name], "data", "name"]
+              end
+            end
+          end
+        end if @serializer.queries.present?
+      end
+
       def value_is_invalid?(value)
         v = CollectionJson::Serializer::Validator::Value.new(value)
         v.invalid?
@@ -108,7 +145,7 @@ module CollectionJson
         v.invalid?
       end
 
-      def error_for(kind, root:, path: [])
+      def error_for(kind, root: root, path: [])
         case kind.to_sym
         when :url
           ending = " is an invalid URL"

data/lib/collection_json_serializer/version.rb

@@ -1,5 +1,5 @@
 module CollectionJson
   class Serializer
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end

data/test/builder/builder_test.rb

@@ -33,8 +33,9 @@ module CollectionJson
                   ],
                   links: [
                     {
-                      name: "dashboard",
-                      href: "http://example.com/my-dashboard"
+                      rel: "dashboard",
+                      href: "http://example.com/my-dashboard",
+                      name: "dashboard"
                     }
                   ]
                 }
@@ -51,7 +52,13 @@ module CollectionJson
                     prompt: "My email"
                   }
                 ]
-              }
+              },
+              queries: [
+                {
+                  rel: "search",
+                  href: "http://example.com/search"
+                }
+              ]
             }
           }
 
@@ -80,8 +87,9 @@ module CollectionJson
                   ],
                   links: [
                     {
-                      name: "dashboard",
-                      href: "http://example.com/my-dashboard"
+                      rel: "dashboard",
+                      href: "http://example.com/my-dashboard",
+                      name: "dashboard"
                     }
                   ]
                 },
@@ -99,8 +107,9 @@ module CollectionJson
                   ],
                   links: [
                     {
-                      name: "dashboard",
-                      href: "http://example.com/my-dashboard"
+                      rel: "dashboard",
+                      href: "http://example.com/my-dashboard",
+                      name: "dashboard"
                     }
                   ]
                 }
@@ -117,7 +126,13 @@ module CollectionJson
                     prompt: "My email"
                   }
                 ]
-              }
+              },
+              queries: [
+                {
+                  rel: "search",
+                  href: "http://example.com/search"
+                }
+              ]
             }
           }
 

data/test/fixtures/serializers/user_serializer.rb

@@ -4,4 +4,15 @@ class UserSerializer < CollectionJson::Serializer
   attributes :name, :email
   template :name, email: { prompt: "My email" }
   links dashboard: { href: "http://example.com/my-dashboard" }
+  queries search: {
+    href: "http://example.com/search",
+    name: false
+  }, pagination: {
+    rel: "page",
+    href: "http://example.com/page",
+    prompt: "Select a page number",
+    data: [
+      { name: "page" }
+    ]
+  }
 end

data/test/minitest_helper.rb

@@ -9,3 +9,16 @@ Dir.glob(File.dirname(__FILE__) + "/fixtures/serializers/**/*.rb") { |file| requ
 
 require "active_support/json"
 require "active_support/inflector"
+
+module TestHelper
+  def empty_serializer_for(object)
+    serializer = CollectionJson::Serializer.new(object)
+    serializer.class.attributes = []
+    serializer.class.href = []
+    serializer.class.links = []
+    serializer.class.template = []
+    serializer.class.queries = []
+
+    serializer
+  end
+end

data/test/objects/item_test.rb

@@ -5,6 +5,8 @@ module CollectionJson
     class Objects
       class Item
         class TestItem < Minitest::Test
+          include TestHelper
+
           def setup
             @user1 = User.new(name: "Carles Jove", email: "hola@carlus.cat")
             @user2 = User.new(name: "Aina Jove", email: "hola@example.com")
@@ -12,6 +14,17 @@ module CollectionJson
             @item = Item.new(@user_serializer)
           end
 
+          def test_that_rel_will_beadded_from_the_name_when_missing
+            serializer = empty_serializer_for(@user1)
+            serializer.class.attributes = [:name]
+            serializer.class.links = [dashboard: { href: "http://example.com" }]
+            item = Item.new(serializer)
+            actual = item.create[:links].first
+
+            assert actual.include? :rel
+            assert_equal "dashboard", actual[:rel]
+          end
+
           def test_that_an_item_can_be_build
             expected = {
               href: "http://example.com/users/#{@user1.id}",
@@ -20,7 +33,11 @@ module CollectionJson
                 { name: "email", value: "hola@carlus.cat" }
               ],
               links: [
-                { name: "dashboard", href: "http://example.com/my-dashboard" }
+                {
+                  rel: "dashboard",
+                  href: "http://example.com/my-dashboard",
+                  name: "dashboard"
+                }
               ]
             }
 
@@ -38,7 +55,11 @@ module CollectionJson
                 { name: "email", value: "hola@example.com" }
               ],
               links: [
-                { name: "dashboard", href: "http://example.com/my-dashboard" }
+                {
+                  rel: "dashboard",
+                  href: "http://example.com/my-dashboard",
+                  name: "dashboard"
+                }
               ]
             }
 
@@ -50,9 +71,12 @@ module CollectionJson
             item = Item.new(custom_serializer)
 
             expected = {
-              data: [
-                { name: "name", value: "Carles Jove", anything: "at all", whatever: "really" },
-              ]
+              data: [{
+                name: "name",
+                value: "Carles Jove",
+                anything: "at all",
+                whatever: "really"
+              }]
             }
             assert_equal expected.to_json, item.create.to_json
           end
@@ -62,9 +86,13 @@ module CollectionJson
             item = Item.new(custom_serializer)
 
             expected = {
-              links: [
-                { name: "dashboard", href: "/my-dashboard", anything: "at all", whatever: "really" }
-              ]
+              links: [{
+                rel: "dashboard",
+                name: "dashboard",
+                href: "/my-dashboard",
+                anything: "at all",
+                whatever: "really"
+              }]
             }
 
             assert_equal expected[:links], item.create[:links]

data/test/objects/queries_test.rb

@@ -0,0 +1,41 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class Objects
+      class Query
+        class TestQuery < Minitest::Test
+          def setup
+            @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+            @user_serializer = UserSerializer.new(@user)
+          end
+
+          def test_that_a_query_can_be_build
+            query = Query.new(@user_serializer, item: 0)
+            expected = {
+              rel: "search",
+              href: "http://example.com/search"
+            }
+
+            assert_equal expected.to_json, query.create.to_json
+          end
+
+          def test_that_a_query_can_include_optional_fields
+            query = Query.new(@user_serializer, item: 1)
+            expected = {
+              rel: "page",
+              href: "http://example.com/page",
+              name: "pagination",
+              prompt: "Select a page number",
+              data: [
+                { name: "page", value: "" }
+              ]
+            }
+
+            assert_equal expected.to_json, query.create.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/test/serializer/href_test.rb

@@ -3,6 +3,8 @@ require "minitest_helper"
 module CollectionJson
   class Serializer
     class TestHref < Minitest::Test
+      include TestHelper
+
       def setup
         @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
         @user_serializer = UserSerializer.new(@user)
@@ -23,10 +25,8 @@ module CollectionJson
       end
 
       def test_that_a_placeholder_can_be_used_for_urls
-        user_serializer = CollectionJson::Serializer.new(@user)
+        user_serializer = empty_serializer_for(@user)
         user_serializer.class.attributes = [:name]
-        user_serializer.class.links = []
-        user_serializer.class.template = []
         user_serializer.class.href = [self: "http://example.com/users/{id}"]
         builder = Builder.new(user_serializer)
 

data/test/serializer/queries_test.rb

@@ -0,0 +1,31 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class TestQueries < Minitest::Test
+      def setup
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user_serializer = UserSerializer.new(@user)
+      end
+
+      def test_template_attributes
+        expected = [
+          search: {
+            href: "http://example.com/search",
+            name: false
+          },
+          pagination: {
+            rel: "page",
+            href: "http://example.com/page",
+            prompt: "Select a page number",
+            data: [
+              { name: "page" }
+            ]
+          }
+        ]
+
+        assert_equal expected, @user_serializer.class.queries
+      end
+    end
+  end
+end

data/test/validator/invalid_test.rb

@@ -4,6 +4,8 @@ module CollectionJson
   class Serializer
     class Validator
       class TestInvalid < Minitest::Test
+        include TestHelper
+
         def setup
           @user = User.new(
             name: "Carles Jove",
@@ -23,14 +25,10 @@ module CollectionJson
             []
           ]
 
-          @invalid = CollectionJson::Serializer.new(@user)
-          @invalid.class.attributes = []
-          @invalid.class.href = []
-          @invalid.class.links = []
-          @invalid.class.template = []
+          @invalid = empty_serializer_for(@user)
         end
 
-        # href
+        # Href
         def test_that_href_generates_errors
           @invalid.class.href = [self: "/users/1", collection: "www.users.com"]
 
@@ -49,7 +47,7 @@ module CollectionJson
                   include? "href is an invalid URL"
         end
 
-        # links
+        # Links
         def test_that_links_generates_errors
           @invalid.class.links = [dashboard: { href: "/my-dashboard" }]
           assert @invalid.invalid?
@@ -77,7 +75,7 @@ module CollectionJson
                   include? "links:dashboard:href is missing"
         end
 
-        # attributes
+        # Attributes
         def test_that_invalid_attributes_return_values_generate_errors
           @invalid.class.attributes = [:name]
 
@@ -112,7 +110,7 @@ module CollectionJson
           end
         end
 
-        # template
+        # Template
         def test_that_template_values_validate
           @invalid_value_types.each do |invalidate|
             @invalid.class.template = [
@@ -132,6 +130,62 @@ module CollectionJson
                     include? "template:name:name is an invalid value"
           end
         end
+
+        # Queries
+        def test_that_queries_validate_href_format
+          @invalid.class.queries = [
+            search: {
+              href: "not-valid"
+            }
+          ]
+
+          assert @invalid.invalid?,
+                 "not-valid should be invalid"
+          assert @invalid.errors.include?(:queries),
+                 "not-valid should be invalid"
+          assert @invalid.errors[:queries][0].
+                  include? "queries:search:href is an invalid URL"
+        end
+
+        def test_that_queries_href_is_required
+          @invalid.class.queries = [
+            search: {
+              name: "missing href"
+            }
+          ]
+
+          assert @invalid.invalid?
+          assert @invalid.errors.include?(:queries),
+                 "should include queries errors"
+          assert @invalid.errors[:queries][0].
+                  include? "queries:search:href is missing"
+        end
+
+        def test_that_queries_values_are_validated
+          @invalid_value_types.each do |invalidate|
+            @invalid.class.queries = [
+              search: {
+                href: "http://example.com/",
+                name: invalidate,
+                rel: invalidate,
+                data: [
+                  name: invalidate
+                ]
+              }
+            ]
+
+            assert @invalid.invalid?,
+                    "#{invalidate} should be invalid"
+            assert @invalid.errors.include?(:queries),
+                   "should include errors for queries"
+            assert @invalid.errors[:queries][0].
+                    include? "queries:search:name is an invalid value"
+            assert @invalid.errors[:queries][1].
+                    include? "queries:search:rel is an invalid value"
+            assert @invalid.errors[:queries][2].
+                    include? "queries:search:data:name is an invalid value"
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collection_json_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Carles Jove i Buxeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,7 @@ files:
 - lib/collection_json_serializer/core_ext/hash.rb
 - lib/collection_json_serializer/core_ext/symbol.rb
 - lib/collection_json_serializer/objects/item.rb
+- lib/collection_json_serializer/objects/query.rb
 - lib/collection_json_serializer/objects/template.rb
 - lib/collection_json_serializer/serializer.rb
 - lib/collection_json_serializer/support.rb
@@ -106,10 +107,12 @@ files:
 - test/fixtures/serializers/valid_serializer.rb
 - test/minitest_helper.rb
 - test/objects/item_test.rb
+- test/objects/queries_test.rb
 - test/objects/template_test.rb
 - test/serializer/data_test.rb
 - test/serializer/href_test.rb
 - test/serializer/links_test.rb
+- test/serializer/queries_test.rb
 - test/serializer/template_test.rb
 - test/support/ext_test.rb
 - test/support/support_test.rb
@@ -155,10 +158,12 @@ test_files:
 - test/fixtures/serializers/valid_serializer.rb
 - test/minitest_helper.rb
 - test/objects/item_test.rb
+- test/objects/queries_test.rb
 - test/objects/template_test.rb
 - test/serializer/data_test.rb
 - test/serializer/href_test.rb
 - test/serializer/links_test.rb
+- test/serializer/queries_test.rb
 - test/serializer/template_test.rb
 - test/support/ext_test.rb
 - test/support/support_test.rb