eipiai 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11411b6b54cd8d262763b931fd39c8cc07267b01
-  data.tar.gz: b0fd69f854bee571d6a064c594e44ccfea576b98
+  metadata.gz: 0629a9a7ce30f972af6469dccc21f41afb350bbd
+  data.tar.gz: 9cedc4a8d4edebf85ca77daac499dc60ce07aed1
 SHA512:
-  metadata.gz: 9e819fa5def0aa433c40fb91a170f0b18215e460132dd4c7c75987fcf3e169ac594b3d30e3f58461cc398239c37b060721f8b5201c2f790ac23bda0122e1999d
-  data.tar.gz: 6644c4fb34968fcb2bb987929852d223f1a24e0404e2ada895578de0da41b5a9dff53fa6289d317cb6e75316efbd2ed46ddea81d4c93ff540f09fdfa6dd5b416
+  metadata.gz: e40edbacb00400a7feeda253f4d211a06246db177d306d6aea94919a8efee8d6188cfdba7a3767f687c2bf9cbd085c3400157886113767ddd0a981c39cf9b815
+  data.tar.gz: f8e8583a01787c39a248025f435fa5fa9f93b112638624fcf3a446ce262a511ee4225af0f7ef4ad229d54c25582453f77748ce78f3e5847430de8f60b80b238a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## [v0.2.0](https://github.com/blendle/eipiai/tree/v0.2.0) (2015-12-13)
+[Full Changelog](https://github.com/blendle/eipiai/compare/v0.1.0...v0.2.0)
+
+**Merged pull requests:**
+
+- add tests for malformed\_request? and unprocessable\_entity? [\#3](https://github.com/blendle/eipiai/pull/3) ([JeanMertz](https://github.com/JeanMertz))
+- initial validation implementation [\#2](https://github.com/blendle/eipiai/pull/2) ([JeanMertz](https://github.com/JeanMertz))
+
 ## [v0.1.0](https://github.com/blendle/eipiai/tree/v0.1.0) (2015-12-12)
 **Merged pull requests:**
 

data/lib/eipiai/roar/representers/api.rb

@@ -1,7 +1,4 @@
-require 'addressable/uri'
-require 'roar'
-require 'roar/decorator'
-require 'roar/json/hal'
+require 'eipiai/roar/representers/base'
 
 module Eipiai
   # ApiRepresenter
@@ -11,11 +8,7 @@ module Eipiai
   # tells the client if the route is templated or not.
   #
   class ApiRepresenter < Roar::Decorator
-    include Roar::JSON::HAL
-
-    link(:self) do |request|
-      request.present? ? Addressable::URI.parse(request.uri).merge(path: path).to_s : path
-    end
+    include Eipiai::Representer
 
     def self.populate_from_app(app)
       app.routes.each do |route|
@@ -36,9 +29,5 @@ module Eipiai
         request.present? ? Addressable::URI.parse(request.uri).merge(path: path).to_s : path
       end
     end
-
-    def path
-      '/api'
-    end
   end
 end

data/lib/eipiai/roar/representers/base.rb

@@ -0,0 +1,87 @@
+require 'addressable/uri'
+require 'roar'
+require 'roar/decorator'
+require 'roar/json/hal'
+
+module Eipiai
+  # Representer
+  #
+  # The base Representer which all representers should include.
+  #
+  module Representer
+    def self.included(base)
+      base.include(Roar::JSON::HAL)
+      base.include(ClassMethods)
+    end
+
+    # path
+    #
+    # The path of the represented object, based on the representer name, and the
+    # object being represented.
+    #
+    # Given `UserItemRepresenter`, the following parts are assembled:
+    # 	* '/user'
+    # 	* `/user/{user_uid}` if object responds to `user_uid`
+    # 	* `/user/{user_uid}/item` (or `/user/item`)
+    # 	* `/user/{user_uid}/item/{uid}` if object responds to `uid`
+    #
+    # @example
+    #   user = User.new(uid: 'bartsimpson')
+    #   UserRepresenter.new(user).path # => '/user/bartsimpson'
+    #
+    # @example
+    #   UserRepresenter.new(nil).path # => '/user'
+    #
+    # @return [String] the path of the represented object
+    #
+    def path
+      parts = path_parts.map { |part| part_path(part) }
+      File.join(*parts)
+    end
+
+    private
+
+    # part_path
+    #
+    # String representing the path of a "part".
+    #
+    # If part is "user", path_part will be `/user`, or `/user/{user_uid}` if the
+    # represented object responds to `user_uid`.
+    #
+    # @param [String] part of the object path
+    # @return [String] path of the part
+    #
+    def part_path(part)
+      var = (part == path_parts.last) ? 'uid' : "#{part}_uid"
+      uid = represented.respond_to?(var) ? represented.send(var) : nil
+
+      File.join(*['', part, uid].compact)
+    end
+
+    # path_parts
+    #
+    # Returns an array of "path parts", based on the representer name.
+    #
+    # If representer is named `UserItemRepresenter`, `path_parts` returns an
+    # array of `['user', 'item']`.
+    #
+    # @return [Array<String>] array of path parts
+    #
+    def path_parts
+      self.class.name.demodulize.chomp('Representer').underscore.split('_')
+    end
+
+    # ClassMethods
+    #
+    # These methods will be defined on the class in which this module is
+    # included.
+    #
+    module ClassMethods
+      include Roar::JSON::HAL
+
+      link(:self) do |request|
+        request.present? ? Addressable::URI.parse(request.uri).merge(path: path).to_s : path
+      end
+    end
+  end
+end

data/lib/eipiai/roar.rb

@@ -1,3 +1,4 @@
 require 'roar'
 
 require 'eipiai/roar/representers/api'
+require 'eipiai/roar/representers/base'

data/lib/eipiai/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean Mertz
@@ -244,6 +244,7 @@ files:
 - lib/eipiai.rb
 - lib/eipiai/roar.rb
 - lib/eipiai/roar/representers/api.rb
+- lib/eipiai/roar/representers/base.rb
 - lib/eipiai/validation.rb
 - lib/eipiai/validation/concerns/formatted_errors.rb
 - lib/eipiai/validation/validators/base.rb