hal_decorator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fdb9a14bc7ef54528db8017406dd28708f6543b
+  data.tar.gz: 3daea7984ca3962708d013f493c5f913a6308551
+SHA512:
+  metadata.gz: e572bb50f4e82435f9760cb19cfcece75f68810ae2d517c83a6e8876751918d822cae1d90f9e5b0371ca9ab12c89ea9f2f6b3b687a59112763b02a2459a0cebb
+  data.tar.gz: d891bc22668258cc50a0e0863338245ed9d24c4e9e73dd4948a9752e31b972731043e22c9b4f5eeba9282d586f1d4061c4eaf1fb84fd9a53227b0a479be2c2c2

data/lib/hal_decorator/attributes.rb

@@ -0,0 +1,15 @@
+require 'hal_decorator/property'
+
+module HALDecorator
+  module Attributes
+    def attribute(*args, &block)
+      @_attributes ||= []
+      @_attributes << Property.new(*args, &block)
+    end
+
+    def attributes
+      @_attributes ||= []
+      @_attributes.dup
+    end
+  end
+end

data/lib/hal_decorator/collection.rb

@@ -0,0 +1,29 @@
+require 'hal_decorator/property'
+
+module HALDecorator
+  module Collection
+
+    attr_reader :collection_name
+
+    class CollectionParameters
+      include Attributes
+      include Links
+      include Curies
+
+      attr_reader :name
+
+      def initialize(name, &block)
+        @name = name
+        instance_exec(&block)
+      end
+    end
+
+    def collection(of:, &block)
+      @_parameters = CollectionParameters.new(of, &block)
+    end
+
+    def collection_parameters
+      @_parameters ||= nil
+    end
+  end
+end

data/lib/hal_decorator/curies.rb

@@ -0,0 +1,18 @@
+require 'hal_decorator/property'
+
+module HALDecorator
+  module Curies
+    def curie(rel, value = nil, &block)
+      if value.nil? && !block_given?
+        raise 'curie must be called with non nil value or be given a block'
+      end
+      @_curies ||= []
+      @_curies << Property.new(rel, value, &block)
+    end
+
+    def curies
+      @_curies ||= []
+      @_curies.dup
+    end
+  end
+end

data/lib/hal_decorator/deserializer.rb

@@ -0,0 +1,86 @@
+require 'json'
+
+module HALDecorator
+
+  module Deserializer
+
+    class Error < StandardError; end
+
+    def from_hal(payload, resource = nil)
+      hash = JSON.parse(payload)
+      from_hash(hash, resource)
+    end
+
+    protected
+
+    def from_hash(hash, resource)
+      as_collection = deserialize_as_collection?(hash)
+
+      if resource.nil?
+        model = HALDecorator.lookup_model self
+        raise Error, "No model for #{self.class}" unless model
+        resource = as_collection ? [] : model.new
+      elsif as_collection
+        resource.clear
+      end
+
+      if as_collection
+        deserialize_collection(hash, resource)
+      else
+        deserialize_attributes(hash, resource)
+        deserialize_embedded(hash, resource)
+      end
+      resource
+    end
+
+    def deserialize_attributes(hash, resource)
+      attributes.each do |attribute|
+        setter_method = setter_method_name(attribute.name)
+        next unless resource.respond_to? setter_method
+        resource.send(setter_method, hash[attribute.name.to_s])
+      end
+    end
+
+    def deserialize_embedded(hash, resource)
+      embedded.each do |embed|
+        setter_method = setter_method_name(embed.name) or next
+        next unless resource.respond_to? setter_method
+        decorator = embed.decorator_class or next
+
+        embedded_hash = hash.dig('_embedded', embed.name.to_s)
+        next unless embedded_hash&.any?
+
+        embedded_resource = resource.send(embed.name)
+        embedded_resource = 
+          if embedded_hash.is_a? Array
+            embedded_hash.map { |h| decorator.from_hash(h, embedded_resource) }
+          else
+            decorator.from_hash(embedded_hash, embedded_resource)
+          end
+        resource.send(setter_method, embedded_resource)
+      end
+    end
+
+    def deserialize_collection(hash, resource)
+      hash['_embedded'][collection_parameters.name].each do |resource_hash|
+        resource << from_hash(resource_hash, nil)
+      end
+    end
+
+    private
+
+    def deserialize_as_collection?(hash)
+      name = collection_parameters&.name
+      # return true/false (Hash#key? returns nil if not found..)
+      name && hash['_embedded']&.key?(name) || false
+    end
+
+    def setter_method_name(attr)
+      "#{attr}=".to_sym
+    end
+
+  end
+end
+
+
+

data/lib/hal_decorator/embedded.rb

@@ -0,0 +1,24 @@
+require 'hal_decorator/property'
+
+module HALDecorator
+  module Embedded
+    class Embed < HALDecorator::Property
+      attr_reader :decorator_class
+
+      def initialize(name, value = nil, decorator_class: nil, &block)
+        super(name, value, &block)
+        @decorator_class = decorator_class
+      end
+    end
+
+    def embed(*args, &block)
+      @_embedded ||= []
+      @_embedded << Embed.new(*args, &block)
+    end
+
+    def embedded
+      @_embedded ||= []
+      @_embedded.dup
+    end
+  end
+end

data/lib/hal_decorator/links.rb

@@ -0,0 +1,27 @@
+require 'hal_decorator/property'
+
+module HALDecorator
+  module Links
+
+    class Link < HALDecorator::Property
+      attr_reader :http_method
+      def initialize(rel, value = nil, http_method: nil, &block)
+        if value.nil? && !block_given?
+          raise 'link must be called with non nil value or be given a block'
+        end
+        @http_method = http_method
+        super(rel, value, &block)
+      end
+    end
+
+    def link(rel, value = nil, method: nil, methods: nil, &block)
+      @_links ||= []
+      @_links << Link.new(rel, value, http_method: method || methods, &block)
+    end
+
+    def links
+      @_links ||= []
+      @_links.dup
+    end
+  end
+end

data/lib/hal_decorator/model.rb

@@ -0,0 +1,28 @@
+module HALDecorator
+  @decorators = {}
+
+  def HALDecorator.register(model:, decorator:)
+    @decorators[decorator] = model
+  end
+
+  def HALDecorator.unregister(decorator)
+    @decorators.delete_if { |d,_| d == decorator }
+  end
+
+  def HALDecorator.lookup_model(decorator)
+    @decorators[decorator]
+  end
+
+  def HALDecorator.lookup_decorator(model)
+    clazz = model.class == Class ? model : model.class
+    decorators = @decorators.select { |d, m| m == clazz }.keys.compact
+    decorators.empty? ? nil : decorators
+  end
+
+  module Model
+    def model(clazz)
+      HALDecorator.register(model: clazz, decorator: self)
+    end
+  end
+end
+

data/lib/hal_decorator/property.rb

@@ -0,0 +1,50 @@
+module HALDecorator
+  class Property
+    attr_reader :name, :resource, :options
+
+    alias :resources :resource
+
+    def initialize(name, value = nil, &block)
+      @name = name
+      @value = value
+      @scope = nil
+      return unless block_given?
+      @scope = eval 'self', block.binding
+      define_singleton_method(:value_from_block, &block)
+    end
+
+    def value(resource = nil, options = {})
+      @resource = resource
+      @options = options
+      if @scope
+        value_from_block
+      elsif resource && @value.nil?
+        resource.public_send(name) if resource.respond_to?(name)
+      else
+        @value
+      end
+    ensure
+      reset
+    end
+
+    def method_missing(method, *args, &block)
+      if @scope&.respond_to? method
+        define_singleton_method(method) { |*a, &b| @scope.send method, *a, &b }
+        return send(method, *args, &block)
+      end
+      super
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      return true if @scope&.respond_to? method
+      super
+    end
+
+    private
+
+    def reset
+      @resource = nil
+      @options = nil
+    end
+  end
+end

data/lib/hal_decorator/serializer.rb

@@ -0,0 +1,111 @@
+require 'json'
+
+module HALDecorator
+
+  module Serializer
+
+    class Error < StandardError; end
+
+    def to_hal(resource, options = {})
+      hash = to_hash(resource, options)
+      JSON.generate(hash)
+    end
+
+    def to_hash(object, options, embed: true)
+      {}.tap do |serialized|
+        serialized.merge! serialize_attributes(object, options)
+        serialized.merge! serialize_links(object, options)
+        serialized.merge! serialize_embedded(object, options) if embed
+      end
+    end
+
+    def to_collection(resources, options = {})
+      parameters = collection_parameters
+      if parameters.nil?
+        raise Error,
+          "Trying to serialize a collection using #{self} which has no collection info. " \
+          "Add a 'collection' spec to the serializer or use another serializer"
+      end
+      links = parameters.links
+      curies = parameters.curies
+      serialized = _serialize_attributes(parameters.attributes, resources, options)
+      serialized.merge! _serialize_links(links, curies, resources, options)
+
+      serialized_resources = resources.map do |resource|
+        to_hash(resource, embed: false)
+      end
+      serialized[:_embedded] = { parameters.name => serialized_resources }
+      JSON.generate(serialized)
+    end
+
+    protected
+
+    def serialize_attributes(object, options)
+      _serialize_attributes(attributes, object, options)
+    end
+
+    def serialize_links(object, options)
+      _serialize_links(links, curies, object, options)
+    end
+
+    def serialize_curies(object, options)
+      _serialize_curies(curies, object, options)
+    end
+
+    def serialize_embedded(object, options)
+      _serialize_embedded(embedded, object, options)
+    end
+
+    private
+
+    def _serialize_attributes(attributes, object, options)
+      attributes.each_with_object({}) do |attribute, hash|
+        hash[attribute.name] = attribute.value(object, options)
+      end
+    end
+
+    def _serialize_links(links, curies, object, options)
+      serialized = links.each_with_object({}) do |link, hash|
+        value = link.value(object, options) or next
+        hash[link.name] = { href: value }.tap do |s|
+          s[:method] = link.http_method if link.http_method
+        end
+      end
+      curies = _serialize_curies(curies, object, options)
+      serialized[:curies] = curies if curies.any?
+      return {} if serialized.empty?
+      { _links: serialized }
+    end
+
+    def _serialize_curies(curies, object, options)
+      curies.each_with_object([]) do |curie, array|
+        array << {
+          name: curie.name,
+          href: curie.value(object, options),
+          templated: true
+        }
+      end
+    end
+
+    def _serialize_embedded(embedded, object, options)
+      serialized = embedded.each_with_object({}) do |embed, hash|
+        resource = embed.value(object, options) or next
+        decorator = embed.decorator_class
+        hash[embed.name] = 
+          if resource.respond_to? :each
+            decorator ||= HALDecorator.lookup_decorator(resource.first).first
+            resource.map do |resrc|
+              decorator.to_hash(resrc, options, embed: false)
+            end
+          else
+            decorator ||= HALDecorator.lookup_decorator(resource).first
+            decorator.to_hash(resource, options, embed: false)
+          end
+      end
+      return {} if serialized.empty?
+      { _embedded: serialized }
+    end
+  end
+end
+
+

data/lib/hal_decorator.rb

@@ -0,0 +1,47 @@
+require 'hal_decorator/attributes'
+require 'hal_decorator/embedded'
+require 'hal_decorator/links'
+require 'hal_decorator/curies'
+require 'hal_decorator/model'
+require 'hal_decorator/serializer'
+require 'hal_decorator/deserializer'
+require 'hal_decorator/collection'
+
+
+module HALDecorator
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    include HALDecorator::Attributes
+    include HALDecorator::Links
+    include HALDecorator::Curies
+    include HALDecorator::Embedded
+    include HALDecorator::Collection
+    include HALDecorator::Model
+    include HALDecorator::Serializer
+    include HALDecorator::Deserializer
+  end
+
+  def self.to_hal(resource, options = {})
+    raise Serializer::Error, "Resource is nil" if resource.nil?
+    decorator = options.delete(:decorator)
+    decorator ||= HALDecorator.lookup_decorator(resource)&.first
+    raise Serializer::Error, "No decorator for #{resource}" unless decorator
+    decorator.to_hal(resource, options)
+  end
+
+  def self.to_collection(resources, options = {})
+    raise Serializer::Error, "resources is nil" if resources.nil?
+    decorator = options.delete(:decorator)
+    decorator ||= HALDecorator.lookup_decorator(resources.first)&.first
+    raise Serializer::Error, "No decorator for #{resources.first}" unless decorator
+    decorator.to_collection(resources, options)
+  end
+
+  def self.from_hal(decorator, payload, resource = nil)
+    decorator.from_hal(payload, resource)
+  end
+end

data.tar.gz.sig

@@ -0,0 +1 @@
+���Ts��
��A����V�����pH*.�\n��)�]�c������6԰̾H��z��5yהcEp@�HN*أ�n�;_x��?A����?y(:"�֦��c�c��ŗ��4�C��>FJ� �*ɝk�m)F�.ӌw(B�ӯ �v���PK

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: hal_decorator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Sammy Henningsson
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRowGAYDVQQDDBFzYW1t
+  eS5oZW5uaW5nc3NvbjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+  LGQBGRYDY29tMB4XDTE3MDcwODE0MDUxOVoXDTE4MDcwODE0MDUxOVowSDEaMBgG
+  A1UEAwwRc2FtbXkuaGVubmluZ3Nzb24xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDET
+  MBEGCgmSJomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBAK+SDC1mfyhucJ6Va21rIHUGscEtQrdvyBqxFG1s2TgPMAv4RbqwdJVPa7kj
+  tbCzslADlUE1oru2C+rcJsMtVGX02ukMIPHT1OjTyy0/EMqLqSy3WeRI8APyDSxC
+  Vbe+h5BMf3zZnYfddR6AeG7ln09T1P/tX+9lTMc+I+DW1fUlQgY48CNUayvtJR61
+  svXvXMrhLhi29SQig1qmH6Zoe22/JgH+m2JksPndY5Ep3gqfDc6Imwu2vGvmGErJ
+  D63FB0XQ/wb4WVH4l7sHQSTfKDp8SImCt1xqNgIyjw578ZG2geGLoncuxgDrbQ/U
+  FIJ11lDZd4vLevMhnIxTSJpPr2cCAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+  DwQEAwIEsDAdBgNVHQ4EFgQUukjj1Cd2ea6IOHDLZe0ymzs2jWkwJgYDVR0RBB8w
+  HYEbc2FtbXkuaGVubmluZ3Nzb25AZ21haWwuY29tMCYGA1UdEgQfMB2BG3NhbW15
+  Lmhlbm5pbmdzc29uQGdtYWlsLmNvbTANBgkqhkiG9w0BAQUFAAOCAQEAGBReofO0
+  CDGI8uQNn/btde+zQBiCX0mONJMQ6An760MzOHMlWFi6VaVeeKmYj5xCpI2nWaJN
+  49ALW/v7GZ+JIW5YmbzWIuD8YfwHJYCFPoH0llzg3GCFCMxbYqI3nDtHX3dMxpOc
+  01A72okERe0ne/O5Z4Ym/fOECkyXr0fYondhDQcSuqxU22jsXs1ZjISN8IuHmVkA
+  GtGteOIqmA05lP+eCXGvyARGLg1GwZDTjnlH5OfpiT1Oy7Dghewi58Gn4/AlZ4bY
+  CNZdF8Vavp6xMQbPHZwqjaeZz2WRXYS7jyYSvCunjwa3OtvXtfbIEGEWE6IM+t9k
+  H1g6Q+B6qk9O6g==
+  -----END CERTIFICATE-----
+date: 2017-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: |
+  Serialize resources according to
+  HypertextApplicationLanguage.
+email: sammy.henningsson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hal_decorator.rb
+- lib/hal_decorator/attributes.rb
+- lib/hal_decorator/collection.rb
+- lib/hal_decorator/curies.rb
+- lib/hal_decorator/deserializer.rb
+- lib/hal_decorator/embedded.rb
+- lib/hal_decorator/links.rb
+- lib/hal_decorator/model.rb
+- lib/hal_decorator/property.rb
+- lib/hal_decorator/serializer.rb
+homepage: https://github.com/sammyhenningsson/hal_decorator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: HAL serializer
+test_files: []