collection_json_serializer 0.0.1

data/lib/collection_json_serializer/support.rb

@@ -0,0 +1,36 @@
+module CollectionJson
+  class Serializer
+    module Support
+      def extract_value_from(resource, method)
+        begin
+          value = resource.send(method)
+        rescue NoMethodError
+          # ignore unknown attributes
+        end
+
+        value if value
+      end
+
+      def parse_url(url, object)
+        segments = url.split("/")
+
+        segments.each_with_index do |segment, index|
+          if has_placeholder?(segment)
+            action = segment.gsub(/[{}]/, "")
+            segments[index] = object.send(action)
+          end
+        end if segments_with_placeholder?(segments)
+
+        segments.join("/")
+      end
+
+      def segments_with_placeholder?(segments)
+        segments.any? { |s| has_placeholder?(s) }
+      end
+
+      def has_placeholder?(string)
+        string.chars.first.eql?("{") && string.chars.last.eql?("}")
+      end
+    end
+  end
+end

data/lib/collection_json_serializer/validator/url.rb

@@ -0,0 +1,22 @@
+module CollectionJson
+  class Serializer
+    class Validator
+      class Url
+        # Stolen from https://github.com/eparreno/ruby_regex/blob/master/lib/ruby_regex.rb
+        VALID = /(\A\z)|(\A(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?\z)/ix
+
+        def initialize(value)
+          @uri = value
+        end
+
+        def valid?
+          true unless VALID.match(@uri).nil?
+        end
+
+        def invalid?
+          true unless valid?
+        end
+      end
+    end
+  end
+end

data/lib/collection_json_serializer/validator/value.rb

@@ -0,0 +1,28 @@
+module CollectionJson
+  class Serializer
+    class Validator
+      class Value
+        VALID = %w(
+          String
+          Fixnum
+          Float
+          TrueClass
+          FalseClass
+          NilClass
+        )
+
+        def initialize(value)
+          @value = value
+        end
+
+        def valid?
+          VALID.include? @value.class.to_s
+        end
+
+        def invalid?
+          !valid?
+        end
+      end
+    end
+  end
+end

data/lib/collection_json_serializer/validator.rb

@@ -0,0 +1,131 @@
+module CollectionJson
+  class Serializer
+    class Validator
+      include CollectionJson::Serializer::Support
+
+      attr_accessor :errors
+
+      def initialize(serializer)
+        @serializer = serializer
+        @errors = {}
+        validate
+      end
+
+      def valid?
+        !invalid?
+      end
+
+      def invalid?
+        @errors.any?
+      end
+
+      private
+
+      def validate
+        [
+          :attributes,
+          :href,
+          :links,
+          :template
+        ].each { |m| send("validate_#{m}") }
+      end
+
+      def validate_attributes
+        @serializer.attributes.each do |attr|
+          params = attr.extract_params
+
+          @serializer.resources.each do |resource|
+            val = extract_value_from(resource, params[:name])
+            if value_is_invalid? val
+              error_for :value, root: :attributes, path: [params[:name]]
+            end
+          end
+
+          params[:properties].each do |key, value|
+            if value_is_invalid? value
+              error_for :value, root: :attributes, path: [params[:name], key]
+            end
+          end if params[:properties]
+
+        end if @serializer.attributes.any?
+      end
+
+      def validate_href
+        href = @serializer.href
+        case href
+        when String
+          error_for :url, root: :href if url_is_invalid? href
+        when Hash
+          href.each do |key, value|
+            error_for :url, root: :href, path: [key] if url_is_invalid? value
+          end
+        end
+      end
+
+      def validate_links
+        @serializer.links.first.each do |k, link|
+          unless link.key? :href
+            error_for :missing_attribute, root: :links, path: [k, :href]
+
+            next
+          end
+
+          link.each do |key, value|
+            case key
+            when :href
+              if url_is_invalid? link[:href]
+                error_for :url, root: :links, path: [k, key]
+              end
+            else
+              if value_is_invalid? value
+                error_for :value, root: :links, path: [k, key]
+              end
+            end
+          end
+        end if @serializer.links.present?
+      end
+
+      def validate_template
+        @serializer.template.each do |attr|
+          params = attr.extract_params
+
+          params[:properties].each do |key, value|
+            if value_is_invalid? value
+              error_for :value, root: :template, path: [params[:name], key]
+            end
+          end if params[:properties]
+
+        end if @serializer.template.any?
+      end
+
+      def value_is_invalid?(value)
+        v = CollectionJson::Serializer::Validator::Value.new(value)
+        v.invalid?
+      end
+
+      def url_is_invalid?(value)
+        v = CollectionJson::Serializer::Validator::Url.new(value)
+        v.invalid?
+      end
+
+      def error_for(kind, root:, path: [])
+        case kind.to_sym
+        when :url
+          ending = " is an invalid URL"
+        when :value
+          ending = " is an invalid value"
+        when :missing_attribute
+          ending = " is missing"
+        else
+          ending = " is an invalid value"
+        end
+
+        @errors[root] = [] unless @errors.key? root
+        e = "#{@serializer.class} #{root}"
+        e << ":" + path.join(":") if path.any?
+        e << ending
+        @errors[root] << e
+      end
+    end
+  end
+end

data/lib/collection_json_serializer/version.rb

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

data/lib/collection_json_serializer.rb

@@ -0,0 +1,18 @@
+require "collection_json_serializer/version"
+
+require "collection_json_serializer/core_ext/hash"
+require "collection_json_serializer/core_ext/symbol"
+
+require "collection_json_serializer/support"
+
+require "collection_json_serializer/serializer"
+
+require "collection_json_serializer/builder"
+
+require "collection_json_serializer/validator"
+require "collection_json_serializer/validator/url"
+require "collection_json_serializer/validator/value"
+
+require "collection_json_serializer/objects/item"
+
+require "collection_json_serializer/objects/template"

data/test/builder/builder_test.rb

@@ -0,0 +1,157 @@
+require "minitest_helper"
+
+module CollectionJson
+  class Serializer
+    class Builder
+      class TestBuilder < Minitest::Test
+        def setup
+          @user1 = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+          @user2 = User.new(name: "Aina Jove", email: "hola@example.com")
+          @account = Account.new(id: 1, name: "My Account", created_at: Time.now)
+          @user1.account = @account
+        end
+
+        def test_response_format_with_one_resource
+          user_serializer = UserSerializer.new(@user1)
+          builder = Builder.new(user_serializer)
+          expected = {
+            collection: {
+              version: "1.0",
+              href: "http://example.com/users",
+              items: [
+                {
+                  href: "http://example.com/users/#{@user1.id}",
+                  data: [
+                    {
+                      name: "name",
+                      value: "Carles Jove"
+                    },
+                    {
+                      name: "email",
+                      value: "hola@carlus.cat"
+                    }
+                  ],
+                  links: [
+                    {
+                      name: "dashboard",
+                      href: "http://example.com/my-dashboard"
+                    }
+                  ]
+                }
+              ],
+              template: {
+                data: [
+                  {
+                    name: "name",
+                    value: ""
+                  },
+                  {
+                    name: "email",
+                    value: "",
+                    prompt: "My email"
+                  }
+                ]
+              }
+            }
+          }
+
+          assert_equal expected.to_json, builder.to_json
+        end
+
+        def test_response_format_with_multiple_resources
+          user_serializer = UserSerializer.new([@user1, @user2])
+          builder = Builder.new(user_serializer)
+          expected = {
+            collection: {
+              version: "1.0",
+              href: "http://example.com/users",
+              items: [
+                {
+                  href: "http://example.com/users/#{@user1.id}",
+                  data: [
+                    {
+                      name: "name",
+                      value: "Carles Jove"
+                    },
+                    {
+                      name: "email",
+                      value: "hola@carlus.cat"
+                    }
+                  ],
+                  links: [
+                    {
+                      name: "dashboard",
+                      href: "http://example.com/my-dashboard"
+                    }
+                  ]
+                },
+                {
+                  href: "http://example.com/users/#{@user2.id}",
+                  data: [
+                    {
+                      name: "name",
+                      value: "Aina Jove"
+                    },
+                    {
+                      name: "email",
+                      value: "hola@example.com"
+                    }
+                  ],
+                  links: [
+                    {
+                      name: "dashboard",
+                      href: "http://example.com/my-dashboard"
+                    }
+                  ]
+                }
+              ],
+              template: {
+                data: [
+                  {
+                    name: "name",
+                    value: ""
+                  },
+                  {
+                    name: "email",
+                    value: "",
+                    prompt: "My email"
+                  }
+                ]
+              }
+            }
+          }
+
+          assert_equal expected.to_json, builder.to_json
+        end
+
+        def test_that_any_attributes_can_be_passed_to_template
+          custom_serializer = CustomTemplateSerializer.new(@user1)
+          builder = Builder.new(custom_serializer)
+
+          expected = {
+            collection: {
+              version: "1.0",
+              template: {
+                data: [
+                  { name: "name", value: "" },
+                  { name: "email", value: "", prompt: "My email", anything: "at all", whatever: "really" }
+                ]
+              }
+            }
+          }
+
+          assert_equal expected.to_json, builder.to_json
+        end
+
+        def test_that_an_invalid_serializer_raises_an_error
+          invalid_serializer = InvalidSerializer.new(@user1)
+          builder = Builder.new(invalid_serializer)
+
+          assert_raises Exception do
+            builder.pack
+          end
+        end
+      end
+    end
+  end
+end

data/test/fixtures/models.rb

@@ -0,0 +1,3 @@
+# Models we'll be using in tests
+User = Class.new(Model)
+Account = Class.new(Model)

data/test/fixtures/poro.rb

@@ -0,0 +1,26 @@
+# Base class for pseudo Models
+#
+# Create a model:
+# User = Class.new(Model)
+# 
+# and then populate it in your tests:
+# @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+class Model
+  def initialize(hash = {})
+    @attributes = hash
+  end
+
+  def id
+    @attributes[:id] || @attributes["id"] || object_id
+  end
+
+  def method_missing(method, *args)
+    if method.to_s =~ /^(.*)=$/
+      @attributes[$1.to_sym] = args[0]
+    elsif @attributes.key?(method)
+      @attributes[method]
+    else
+      super
+    end
+  end
+end

data/test/fixtures/serializers/custom_item_links_serializer.rb

@@ -0,0 +1,7 @@
+class CustomItemLinksSerializer < CollectionJson::Serializer
+  links dashboard: {
+    href: "/my-dashboard",
+    anything: "at all",
+    whatever: "really"
+    }
+end