eipiai 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0629a9a7ce30f972af6469dccc21f41afb350bbd
-  data.tar.gz: 9cedc4a8d4edebf85ca77daac499dc60ce07aed1
+  metadata.gz: 9ae6cef8a01a687e9de4ca1a6cf889b9ce3f476f
+  data.tar.gz: bd8cd1327cb8b859c8b5f09518ccf0700fcbb3c5
 SHA512:
-  metadata.gz: e40edbacb00400a7feeda253f4d211a06246db177d306d6aea94919a8efee8d6188cfdba7a3767f687c2bf9cbd085c3400157886113767ddd0a981c39cf9b815
-  data.tar.gz: f8e8583a01787c39a248025f435fa5fa9f93b112638624fcf3a446ce262a511ee4225af0f7ef4ad229d54c25582453f77748ce78f3e5847430de8f60b80b238a
+  metadata.gz: b5971360e6f2b6f1c220dab71e7ecb7cd647406477b25310fdffef98655db324450e930f4018596263fd72099423bf27d8733babf46e1392af8cd36d334ef59d
+  data.tar.gz: cbf9e28a0ce0e4df1eba0465ba4bf18a7ef6f6455a3fda7536c19d9074bb1267b4cd7c05d6e88078c4a7e7038032c71c17737df7c26df48411dd62048970e1fb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## [v0.3.0](https://github.com/blendle/eipiai/tree/v0.3.0) (2015-12-13)
+[Full Changelog](https://github.com/blendle/eipiai/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- initial Roar representers abstraction [\#4](https://github.com/blendle/eipiai/pull/4) ([JeanMertz](https://github.com/JeanMertz))
+
 ## [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)
 

data/features/support/app.rb

@@ -27,3 +27,8 @@ end
 def app
   WebmachineApp.adapter
 end
+
+Eipiai.configure do |config|
+  config.base_uri   = 'https://example.org'
+  config.curie_uris = { b: 'https://api.example.org/rel/{rel}' }
+end

data/features/webmachine.feature

@@ -118,6 +118,13 @@ Feature: Webmachine CRUD operations
             {
               "href": "https://example.org/item/hello"
             }
+          ],
+          "curies": [
+            {
+              "name": "b",
+              "href": "https://api.example.org/rel/{rel}",
+              "templated": true
+            }
           ]
         }
       }

data/lib/eipiai/roar/ext/hal.rb

@@ -0,0 +1,59 @@
+require 'roar/json'
+require 'set'
+
+module Roar
+  module JSON
+    module HAL
+      # @see http://git.io/v085U
+      module Resources
+        # ToHashExt
+        #
+        # Adds a superset of functions on top of the default
+        # `Roar::JSON::HAL::Resources#to_hash`.
+        #
+        module ToHashExt
+          # to_hash
+          #
+          # taps into the default `Roar::JSON::HAL::Resources#to_hash` and adds
+          # `curies` links to the hash, if a curied object is present.
+          #
+          # The configuration value `curie_uris` needs to be defined, and be a
+          # hash of `{ curie => url }`. If your links contains a key `b:items`,
+          # then the curie link will be taken from the `curie_uris` hash, with
+          # key matching `b`:
+          #
+          #   Eipiai.configuration.curie_uris = { b: 'https://example.com/' }
+          #
+          # `_links` key `b:items` will result in a curie pointing to the above
+          # address.
+          #
+          # @example
+          #   post('/items', '{ "uid": "hello" }', 'Content-Type': 'application/json')
+          #   items = Struct.new(:dataset).new(Item.dataset)
+          #   Eipiai.configuration.curie_uris = { b: 'https://example.com/{rel}' }
+          #
+          #   ItemsRepresenter.new(items).to_hash['_links']['curies']
+          #     # => [{ name: "b", href: "https://example.com/{rel}", templated: true }]
+          #
+          # @return [Hash] hash representation of the represented object
+          #
+          def to_hash(*)
+            super.tap do |hash|
+              curies = Set.new
+              hash.fetch('_links', {}).each do |name, _|
+                next unless (curie = name[/(\S+):/, 1])
+                next unless (curie_href = Eipiai.configuration.curie_uris[curie.to_sym])
+
+                curies.add(name: curie, href: curie_href, templated: true)
+              end
+
+              hash['_links']['curies'] = curies.to_a if curies.any?
+            end
+          end
+        end
+
+        prepend ToHashExt
+      end
+    end
+  end
+end

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

@@ -23,8 +23,9 @@ module Eipiai
     end
 
     def self.add_route(route, options)
-      link(options) do |request|
-        path = '/' + route.path_spec.map { |e| e.is_a?(Symbol) ? "{#{e}}" : e }.join('/')
+      link(options) do |context|
+        request = context[:request]
+        path    = '/' + route.path_spec.map { |e| e.is_a?(Symbol) ? "{#{e}}" : e }.join('/')
 
         request.present? ? Addressable::URI.parse(request.uri).merge(path: path).to_s : path
       end

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

@@ -39,6 +39,35 @@ module Eipiai
       File.join(*parts)
     end
 
+    # url
+    #
+    # The url of the object.
+    #
+    # Based on the input, the result can vary:
+    #
+    # @example as a relative path
+    #   user = User.new(uid: 'bartsimpson')
+    #   UserRepresenter.new(user).url # => '/user/bartsimpson'
+    #
+    # @example with url given as argument
+    #   user = User.new(uid: 'bartsimpson')
+    #   UserRepresenter.new(user).url('https://example.org')
+    #     # => 'https://example.org/user/bartsimpson'
+    #
+    # @example with url as global configuration
+    #   Eipiai.configuration.base_uri = 'https://base.org'
+    #   user = User.new(uid: 'bartsimpson')
+    #   UserRepresenter.new(user).url # => 'https://base.org/user/bartsimpson'
+    #
+    # @param [String] uri string to prepend to the object path
+    # @return [String] uri with path of object appended
+    #
+    def url(uri = nil)
+      uri ||= Eipiai.configuration.base_uri
+
+      File.join uri.to_s, path
+    end
+
     private
 
     # part_path
@@ -79,7 +108,8 @@ module Eipiai
     module ClassMethods
       include Roar::JSON::HAL
 
-      link(:self) do |request|
+      link(:self) do |context|
+        request = context[:request]
         request.present? ? Addressable::URI.parse(request.uri).merge(path: path).to_s : path
       end
     end

data/lib/eipiai/roar.rb

@@ -1,4 +1,6 @@
 require 'roar'
 
+require 'eipiai/roar/ext/hal'
+
 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.3.0'
+  VERSION = '0.4.0'
 end

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

@@ -101,14 +101,18 @@ module Eipiai
 
     # params
     #
-    # Returns a Hash object, representing the JSOM payload sent in the request
-    # object. Returns an empty hash if request body contains invalid JSON.
+    # Given a string in JSON format, returns the hash representation of that
+    # object.
+    #
+    # If the input is invalid JSON, an empty hash is returned.
+    #
+    # If no argument is given, `request.body` is used as the JSON input.
     #
     # @example Parse valid JSON request
-    #   resource.send :params, ('{ "hello": "world" }') # => { 'hello' => 'world' }
+    #   resource.params('{ "hello": "world" }') # => { 'hello' => 'world' }
     #
     # @example Parse invalid JSON request
-    #   resource.send :params, 'invalid' #=> {}
+    #   resource.params('invalid') #=> {}
     #
     # @param [String] body JSON provided as a string
     # @return [Hash] JSON string, converted to a hash
@@ -124,7 +128,7 @@ module Eipiai
     # Given an object, calls `#to_hash` on that object,
     #
     # If the object's `to_hash` implementation accepts any arguments, the
-    # `request` object is sent as its first argument.
+    # hash `{ request: request }` is sent as its first argument.
     #
     # In practice, this method is used without any parameters, causing the
     # method to call `represented`, which represents a Roar representer. This in
@@ -139,7 +143,7 @@ module Eipiai
     # @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)
+      o.method(:to_hash).arity.zero? ? o.to_hash : o.to_hash(request: request)
     end
 
     def to_json

data/lib/eipiai.rb

@@ -1,3 +1,41 @@
 require 'eipiai/roar'
 require 'eipiai/validation'
 require 'eipiai/webmachine'
+
+# Eipiai
+#
+# The main module for the library.
+#
+module Eipiai
+  class << self
+    attr_accessor :configuration
+
+    # configure
+    #
+    # Configure the library using this `configure` method, as follows:
+    #
+    #   Eipiai.configure do |config|
+    #     config.curie_uris = { b: 'https://api.blendle.com/rel/{rel}' }
+    #   end
+    #
+    # @return [void]
+    #
+    def configure
+      yield(configuration)
+    end
+  end
+
+  # Configuration
+  #
+  # The configuration store for the Eipiai library.
+  #
+  class Configuration
+    attr_accessor :base_uri, :curie_uris
+
+    def initialize
+      @curie_uris = {}
+    end
+  end
+
+  @configuration = Configuration.new
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jean Mertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-13 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,6 +243,7 @@ files:
 - features/webmachine.feature
 - lib/eipiai.rb
 - lib/eipiai/roar.rb
+- lib/eipiai/roar/ext/hal.rb
 - lib/eipiai/roar/representers/api.rb
 - lib/eipiai/roar/representers/base.rb
 - lib/eipiai/validation.rb