eipiai 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77b1cb59846fc5bde66cd2a8a1ac8afaca678780
-  data.tar.gz: 123cc1037faf9288fc0f910fe13ac00a36dced22
+  metadata.gz: 34136d9503bd1cfed3341367129e8c7ff9ccfb9d
+  data.tar.gz: 1ec6acd5d189963b9cd0efe1d8649d4c282edca2
 SHA512:
-  metadata.gz: dc2303a764828ed2a40072a55f9c7eb050c01f335b08ddebf209ee799c259b1584311913d397b46159dbc6391bee76993bacfd136a3dbffaa12e8a4eb3b5d473
-  data.tar.gz: ff6259a0874cce63d6a7c172b6ed93893fbc3c6bce45613ac3047f0d4a5b1f2f760df7a6dc6b48a4d374f590668073815dfef30e02dcc3dd17e95586b305db39
+  metadata.gz: 3adf462831a8f4c9287acbea3bb93d66b31dc8c3e862052d152a7ba091a8611989da4130d35d5f0f2623d115ebefa05d64df378545933e98e552a93b8cb6edfb
+  data.tar.gz: 3a8ab95d17d35671725ea6edbebbd94f599126ce5f073e3350fc2733bbf3fc53935ea9febd22361d5a53b94d1769c250dd643b6c0acaac68a29f88bda379f72e

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## [v0.5.1](https://github.com/blendle/eipiai/tree/v0.5.1) (2015-12-14)
+[Full Changelog](https://github.com/blendle/eipiai/compare/v0.5.0...v0.5.1)
+
+**Merged pull requests:**
+
+- improve curied links matching regex [\#9](https://github.com/blendle/eipiai/pull/9) ([JeanMertz](https://github.com/JeanMertz))
+
 ## [v0.5.0](https://github.com/blendle/eipiai/tree/v0.5.0) (2015-12-14)
 [Full Changelog](https://github.com/blendle/eipiai/compare/v0.4.0...v0.5.0)
 

data/lib/eipiai.rb

@@ -1,5 +1,6 @@
 require 'eipiai/configuration'
 
+require 'eipiai/models'
 require 'eipiai/roar'
 require 'eipiai/validation'
 require 'eipiai/webmachine'

data/lib/eipiai/models.rb

@@ -0,0 +1,2 @@
+require 'eipiai/models/collection'
+require 'eipiai/models/representable'

data/lib/eipiai/models/collection.rb

@@ -0,0 +1,13 @@
+module Eipiai
+  # Collection
+  #
+  # Module used in classes that represent a collection of objects.
+  #
+  module Collection
+    attr_reader :dataset
+
+    def initialize(dataset)
+      @dataset = dataset
+    end
+  end
+end

data/lib/eipiai/models/representable.rb

@@ -0,0 +1,69 @@
+module Eipiai
+  # Representable
+  #
+  # Module used to make a model "representable".
+  #
+  # When including this module into a class, it is expected that a similar
+  # class with a suffix "Representer" exists.
+  #
+  module Representable
+    # represented
+    #
+    # Return the represented version of the object.
+    #
+    # @example
+    #   item = Item.new.extend(Eipiai::Representable)
+    #   item.represented.class # => ItemRepresenter
+    #
+    # @return [Object] Representer instance based on current model
+    #
+    def represented
+      "#{self.class.name}Representer".constantize.new(self)
+    end
+
+    # to_hash
+    #
+    # call `#to_hash` on the representer belonging to the object.
+    #
+    # @example
+    #   item = Item.new.extend(Eipiai::Representable)
+    #   item.to_hash # => { '_links' => { 'self' => { 'href' => '/item' } } }
+    #
+    # @param [Hash] options to be used inside the representer
+    # @return [Hash] hash representation of the object
+    #
+    def to_hash(options = {})
+      represented.to_hash(options)
+    end
+
+    # from_hash
+    #
+    # call `#from_hash` on the representer belonging to the object.
+    #
+    # @example
+    #   item = Item.new.extend(Eipiai::Representable)
+    #   item.from_hash('uid' => 'hello').uid # => 'hello'
+    #
+    # @param [Hash] hash to be used to set the object attributes
+    # @return [Object] the object itself
+    #
+    def from_hash(hash = {})
+      represented.from_hash(hash)
+    end
+
+    # path
+    #
+    # The "path" to access the model. This method calls the representer's `path`
+    # method.
+    #
+    # @example
+    #   item = Item.new(uid: 'hello').extend(Eipiai::Representable)
+    #   item.path # => '/item/hello'
+    #
+    # @return [String] path to the objects resource
+    #
+    def path
+      represented.path
+    end
+  end
+end

data/lib/eipiai/version.rb

@@ -3,5 +3,5 @@
 # The current version of the Eipiai library.
 #
 module Eipiai
-  VERSION = '0.5.1'
+  VERSION = '0.6.0'
 end

data/lib/eipiai/webmachine.rb

@@ -3,6 +3,8 @@ require 'webmachine'
 require 'eipiai/webmachine/ext/decision'
 require 'eipiai/webmachine/ext/request'
 
+require 'eipiai/webmachine/resources/concerns/objectifiable'
+
 require 'eipiai/webmachine/resources/api'
 require 'eipiai/webmachine/resources/base'
 require 'eipiai/webmachine/resources/collection'

data/lib/eipiai/webmachine/resources/api.rb

@@ -4,7 +4,13 @@ require 'active_support/core_ext/string/inflections'
 require 'json'
 
 module Eipiai
+  # Api
+  #
+  # A noop class that exists to satisfy the needs of the Eipiai resource
+  # handler.
+  #
   class Api
+    include Eipiai::Representable
   end
 
   # ApiResource

data/lib/eipiai/webmachine/resources/base.rb

@@ -12,6 +12,8 @@ module Eipiai
   # endpoint.
   #
   module Resource
+    include Objectifiable
+
     # Includes the correct resource into the class, depending on its name.
     #
     # If the resource is called `ItemResource`, the `Item` part is considered
@@ -81,24 +83,6 @@ module Eipiai
       [['application/json', :from_json]]
     end
 
-    # new_object
-    #
-    # Return the instantiated object, based on the representer provided by
-    # `singular_representer_class` and the parameters provided by `params`.
-    #
-    # See `Object#new_object` for the version without using representers.
-    #
-    # @example
-    #   resource.new_object.class # => Item
-    #
-    # @return [Class, nil] instantiated representer, or nil if not found
-    #
-    def new_object
-      return if singular_representer_class.nil? || object_class.nil?
-
-      @new_object ||= singular_representer_class.new(object_class.new).from_hash(params)
-    end
-
     # params
     #
     # Given a string in JSON format, returns the hash representation of that
@@ -137,98 +121,40 @@ module Eipiai
     #
     # @example
     #   item = Item.new(uid: 'hello')
-    #   resource.to_hash(item) # => { uid: 'hello' }
+    #   get('/item/hello')
+    #   resource.to_hash(item)['uid'] # => 'hello'
     #
-    # @param [Object] o = represented to call #to_hash on
+    # @param [Object] obj to call #to_hash on
     # @return [Hash] hash representation of the object
     #
-    def to_hash(o = represented)
-      o.method(:to_hash).arity.zero? ? o.to_hash : o.to_hash(request: request)
+    def to_hash(obj = object)
+      obj.method(:to_hash).arity.zero? ? obj.to_hash : obj.to_hash(request: request)
     end
 
     def to_json
       to_hash.to_json
     end
 
-    private
-
-    # object_class_name
-    #
-    # String representation of the "object class", based on the current
-    # resource name.
-    #
-    # If the resource is called `ItemsResource`, object_class_name will be
-    # `Item`. It is expected that this name represents the class of the object
-    # the resource provides access to through the API.
-    #
-    # @example
-    #   resource.send :object_class_name # => 'Item'
-    #
-    # @return [String] name of object class
-    #
-    def object_class_name
-      self.class.name.chomp('Resource').demodulize.singularize
-    end
-
-    # object_class
+    # new_object
     #
-    # Same as `object_class_name`, except this method will return a constant
-    # _and_ keeps the namespace intact.
+    # New object, instantiated by passing the provided `params` into the
+    # object's `#from_hash` method.
     #
-    # Returns `nil` if constant does not exist.
+    # The only requirement is that the object responds to `#from_hash`, that
+    # method accepts a hash of parameters, and it returns the object itself.
     #
     # @example
-    #   resource.send :object_class # => Item
+    #   resource.new_object.class # => Item
     #
-    # @return [Class, nil] object class, or nil if not found
+    # @return [Object, nil] instantiated object, or nil if not found
     #
-    def object_class
-      self.class.name.chomp('Resource').singularize.constantize
-    rescue NameError
-      nil
-    end
+    def new_object
+      return if object_class.nil?
 
-    # singular_representer_class
-    #
-    # Constant, representing the representer belonging to the defined
-    # `object`.
-    #
-    # If the resource is called `ItemResource`, the representer will be
-    # `ItemRepresenter`.
-    #
-    # Returns `nil` if constant does not exist.
-    #
-    # @example
-    #   resource.send :singular_representer_class # => ItemRepresenter
-    #
-    # @return [Class, nil] representer class, or nil if not found
-    #
-    def singular_representer_class
-      "#{object_class}Representer".constantize
-    rescue NameError
-      nil
+      @new_object ||= object_class.new.from_hash(params)
     end
 
-    # collection_representer_class
-    #
-    # Constant, representing the representer belonging to the defined
-    # collection of `object`s.
-    #
-    # If the resource is called `ItemResource`, the representer will be
-    # `ItemsRepresenter`.
-    #
-    # Returns `nil` if constant does not exist.
-    #
-    # @example
-    #   resource.send :collection_representer_class # => ItemsRepresenter
-    #
-    # @return [Class, nil] representer class, or nil if not found
-    #
-    def collection_representer_class
-      "#{object_class.to_s.pluralize}Representer".constantize
-    rescue NameError
-      nil
-    end
+    private
 
     def json_error_body(errors)
       response.headers['Content-Type'] = 'application/json'

data/lib/eipiai/webmachine/resources/collection.rb

@@ -20,7 +20,7 @@ module Eipiai
     end
 
     def create_path
-      singular_representer_class.new(new_object).path
+      new_object.path
     end
 
     def from_json
@@ -41,16 +41,14 @@ module Eipiai
       true
     end
 
-    def object
-      @object ||= Struct.new(:dataset).new(object_class.dataset) if object_class
+    def to_hash
+      super(request.get? ? object : new_object)
     end
 
-    def representer_class
-      request.get? ? collection_representer_class : singular_representer_class
-    end
+    def object
+      return unless collection_class && object_class
 
-    def represented
-      representer_class.new(request.get? ? object : new_object)
+      @object ||= collection_class.new(object_class.dataset)
     end
   end
 end

data/lib/eipiai/webmachine/resources/concerns/objectifiable.rb

@@ -0,0 +1,105 @@
+module Eipiai
+  module Resource
+    # Objectifiable
+    #
+    # When included in a resource, provides basic methods to get to the "object"
+    # that the resource provides access to.
+    #
+    # Provided methods are:
+    #
+    # * resource_name         # ItemRepresenter => 'Item'
+    # * object_class_name     # ItemRepresenter => 'Item'
+    # * collection_class_name # ItemRepresenter => 'Items'
+    # * object_class          # ItemRepresenter => Item
+    # * collection_class      # ItemRepresenter => Items
+    #
+    module Objectifiable
+      private
+
+      # resource_name
+      #
+      # Take the resource class name, and strip `Resource` part from the name.
+      #
+      # @example
+      #   resource.send :resource_name # => 'Eipiai::TestApp::Items'
+      #
+      # @return [String] resource name
+      #
+      def resource_name
+        self.class.name.chomp('Resource')
+      end
+
+      # object_class_name
+      #
+      # String representation of the "object class", based on the current
+      # resource name.
+      #
+      # If the resource is called `ItemsResource`, object_class_name will be
+      # `Item`. It is expected that this name represents the class of the object
+      # the resource provides access to through the API.
+      #
+      # @example
+      #   resource.send :object_class_name # => 'Item'
+      #
+      # @return [String] name of object class
+      #
+      def object_class_name
+        resource_name.demodulize.singularize
+      end
+
+      # object_class
+      #
+      # Same as `object_class_name`, except this method will return a constant
+      # _and_ keeps the namespace intact.
+      #
+      # Returns `nil` if constant does not exist.
+      #
+      # @example
+      #   resource.send :object_class # => Item
+      #
+      # @return [Class, nil] object class, or nil if not found
+      #
+      def object_class
+        resource_name.singularize.constantize
+      rescue NameError
+        nil
+      end
+
+      # collection_class_name
+      #
+      # String representation of the "collection class", based on the current
+      # resource name.
+      #
+      # If the resource is called `ItemResource`, collection_class_name will be
+      # `Items`. It is expected that this name represents a collection of `Item`
+      # objects.
+      #
+      # @example
+      #   resource.send :collection_class_name # => 'Items'
+      #
+      # @return [String] name of collection class
+      #
+      def collection_class_name
+        resource_name.demodulize.pluralize
+      end
+
+      # collection_class
+      #
+      # Same as `collection_class_name`, except this method will return a
+      # constant _and_ keeps the namespace intact.
+      #
+      # Returns `nil` if constant does not exist.
+      #
+      # @example
+      #   resource.send :collection_class # => Items
+      #
+      # @return [Class, nil] collection class, or nil if not found
+      #
+      def collection_class
+        resource_name.pluralize.constantize
+      rescue NameError
+        nil
+      end
+    end
+  end
+end

data/lib/eipiai/webmachine/resources/health.rb

@@ -61,10 +61,6 @@ module Eipiai
       HealthCheck.new
     end
 
-    def represented
-      object
-    end
-
     private
 
     # healthy?

data/lib/eipiai/webmachine/resources/singular.rb

@@ -42,10 +42,6 @@ module Eipiai
       @merged_params ||= super.merge('uid' => object_uid)
     end
 
-    def represented
-      singular_representer_class.new(object)
-    end
-
     def object
       @object ||= object_class.first(uid: object_uid) if object_class
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jean Mertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -244,6 +244,9 @@ files:
 - features/webmachine.feature
 - lib/eipiai.rb
 - lib/eipiai/configuration.rb
+- lib/eipiai/models.rb
+- lib/eipiai/models/collection.rb
+- lib/eipiai/models/representable.rb
 - lib/eipiai/roar.rb
 - lib/eipiai/roar/ext/hal.rb
 - lib/eipiai/roar/representers/api.rb
@@ -259,6 +262,7 @@ files:
 - lib/eipiai/webmachine/resources/api.rb
 - lib/eipiai/webmachine/resources/base.rb
 - lib/eipiai/webmachine/resources/collection.rb
+- lib/eipiai/webmachine/resources/concerns/objectifiable.rb
 - lib/eipiai/webmachine/resources/health.rb
 - lib/eipiai/webmachine/resources/singular.rb
 - script/bootstrap