eipiai 0.6.0 → 0.7.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'eipiai/webmachine/resources/base'
 
 require 'active_support/core_ext/string/inflections'
@@ -6,7 +7,8 @@ require 'json'
 module Eipiai
   # HealthCheck
   #
-  # Class with a single method `healthy?`. Returns `true` by default.
+  # Class with a `#healthy?` method. If this method returns `true`, the service
+  # is expected to be available and ready to serve requests.
   #
   class HealthCheck
     # healthy?
@@ -19,26 +21,30 @@ module Eipiai
       Eipiai.configuration.healthy == true
     end
 
-    # to_hash
+    # to_h
     #
     # Hash representation of the health status.
     #
     # @return [Hash] hash representation of health status
     #
-    def to_hash
+    def to_h
       { 'healthy' => healthy? }
     end
   end
 
-  # ApiResource
+  # HealthResource
   #
-  # The base resource which can be included in regular Webmachine::Resource
-  # objects. It provides sensible defaults for a full-features REST API
-  # endpoint.
+  # Provides basic health checking of the API. This resource can be configured
+  # to validate a working service, and return the correct availability to the
+  # client.
   #
   class HealthResource < Webmachine::Resource
     include Resource
 
+    def top_level_relation?
+      true
+    end
+
     def allowed_methods
       %w(GET)
     end
@@ -51,7 +57,7 @@ module Eipiai
       return true if healthy?
 
       response.headers['Content-Type'] = 'application/json'
-      response.headers['Retry-After'] = '60'
+      response.headers['Retry-After']  = '60'
 
       response.body = to_json
       false
@@ -65,8 +71,8 @@ module Eipiai
 
     # healthy?
     #
-    # Returns true if `HealthCheck.new.healthy?` returns `true`, otherwise
-    # returns `false`.
+    # Returns true if `HealthCheck#healthy?` returns `true`, otherwise returns
+    # `false`.
     #
     # @return [true, false] health status of service
     #

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'eipiai/webmachine/resources/base'
 
 require 'active_support/core_ext/object/blank'
@@ -16,32 +17,30 @@ module Eipiai
   #
   module SingularResource
     def allowed_methods
-      %w(GET PUT DELETE)
+      %w(GET POST PUT DELETE)
     end
 
     def resource_exists?
       object.present?
     end
 
+    def create_path
+      request.uri.path
+    end
+
     def delete_resource
       object.destroy
+      @object = nil
+
       true
     end
 
     def from_json
-      delete_resource if (exists = object.present?)
-      new_object.save
-
-      response.headers['Location'] = request.uri.to_s
-      exists ? 204 : 201
+      request.put? ? put_from_json : post_from_json
     end
 
     private
 
-    def params
-      @merged_params ||= super.merge('uid' => object_uid)
-    end
-
     def object
       @object ||= object_class.first(uid: object_uid) if object_class
     end
@@ -49,5 +48,41 @@ module Eipiai
     def object_uid
       request.path_info[:"#{object_class_name.downcase}_uid"]
     end
+
+    alias uid object_uid
+
+    # put_from_json
+    #
+    # When `from_json` is called, and the request is using the `PUT` method,
+    # this method is called.
+    #
+    # Deletes the existing record, if it exists, and saves the newly created
+    # record. Triggers `handle_post_or_put_with_optional_content`, with
+    # `created` set to `true` unless the new record replaced an old one.
+    #
+    # @return [Integer] either 200, 201 or 204. See `#handle_post_or_put_with_optional_content`
+    #
+    def put_from_json
+      delete_resource if (exists = object.present?)
+      new_object.save
+
+      handle_post_or_put_with_optional_content(created: exists.blank?)
+    end
+
+    # post_from_json
+    #
+    # When `from_json` is called, and the request is using the `POST` method,
+    # this method is called.
+    #
+    # calls #save on the existing object, and triggers
+    # `handle_post_or_put_with_optional_content`, with `created` set to `false`.
+    #
+    # @return [Integer] either 200, 201 or 204. See `#handle_post_or_put_with_optional_content`
+    #
+    def post_from_json
+      object.save
+
+      handle_post_or_put_with_optional_content(created: false)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Jean Mertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -230,15 +230,26 @@ files:
 - ".gitignore"
 - ".hubbit.yml"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".wercker.yml"
 - CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - eipiai.gemspec
+- features/resources/api.feature
+- features/resources/collection.feature
+- features/resources/collection/get.feature
+- features/resources/collection/post.feature
+- features/resources/health.feature
+- features/resources/singular.feature
+- features/resources/singular/delete.feature
+- features/resources/singular/get.feature
+- features/resources/singular/post.feature
+- features/resources/singular/put.feature
 - features/step_definitions/steps.rb
+- features/step_definitions/webmachine_steps.rb
 - features/support/app.rb
-- features/support/db.rb
 - features/support/env.rb
 - features/validation.feature
 - features/webmachine.feature
@@ -263,6 +274,7 @@ files:
 - lib/eipiai/webmachine/resources/base.rb
 - lib/eipiai/webmachine/resources/collection.rb
 - lib/eipiai/webmachine/resources/concerns/objectifiable.rb
+- lib/eipiai/webmachine/resources/concerns/representable.rb
 - lib/eipiai/webmachine/resources/health.rb
 - lib/eipiai/webmachine/resources/singular.rb
 - script/bootstrap
@@ -287,7 +299,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Opinionated JSON-API stack to get the job done.

data/features/support/db.rb

@@ -1,8 +0,0 @@
-require 'database_cleaner'
-require 'database_cleaner/cucumber'
-
-DatabaseCleaner.clean_with(:truncation)
-DatabaseCleaner.strategy = :transaction
-
-Before { DatabaseCleaner.start }
-After { DatabaseCleaner.clean }