eipiai 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ae6cef8a01a687e9de4ca1a6cf889b9ce3f476f
-  data.tar.gz: bd8cd1327cb8b859c8b5f09518ccf0700fcbb3c5
+  metadata.gz: a3bfe7f33ca1682dcbcde9d21595b1bb6119bee8
+  data.tar.gz: 9e51991a96b67325b3add840f5512be6b769f4e5
 SHA512:
-  metadata.gz: b5971360e6f2b6f1c220dab71e7ecb7cd647406477b25310fdffef98655db324450e930f4018596263fd72099423bf27d8733babf46e1392af8cd36d334ef59d
-  data.tar.gz: cbf9e28a0ce0e4df1eba0465ba4bf18a7ef6f6455a3fda7536c19d9074bb1267b4cd7c05d6e88078c4a7e7038032c71c17737df7c26df48411dd62048970e1fb
+  metadata.gz: 3cab26999f86e06b1a37bbbd7fab0aa3c36a6bc199e3f325ca629b1e51625351c033f5450cca5279a88931a5bff02783010778814a83b187e8b5eee70e7d1056
+  data.tar.gz: a8f09782eb7b1d274509961a89f12546f30c6823fd462570200dc7186ccca1a288ff41d925be437bac77e9d5a39290e072efd3bb75c2c62647c993b6e7b28ef5

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## [v0.4.0](https://github.com/blendle/eipiai/tree/v0.4.0) (2015-12-14)
+[Full Changelog](https://github.com/blendle/eipiai/compare/v0.3.0...v0.4.0)
+
+**Merged pull requests:**
+
+- automated curies configuration [\#6](https://github.com/blendle/eipiai/pull/6) ([JeanMertz](https://github.com/JeanMertz))
+
 ## [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)
 

data/features/step_definitions/steps.rb

@@ -0,0 +1,3 @@
+Given(/^the configuration "([^"]*)" is set to "([^"]*)"$/) do |config, value|
+  Eipiai.configuration.send("#{config}=", value)
+end

data/features/support/app.rb

@@ -10,6 +10,7 @@ include Eipiai::TestApp
 WebmachineApp = Webmachine::Application.new do |app|
   app.routes do
     add ['api'], Eipiai::ApiResource
+    add ['health'], Eipiai::HealthResource
 
     add ['items'], ItemsResource
     add ['item', :item_uid], ItemResource
@@ -28,7 +29,10 @@ 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}' }
+Before do
+  Eipiai.configuration = Eipiai::Configuration.new
+  Eipiai.configure do |config|
+    config.base_uri   = 'https://example.org'
+    config.curie_uris = { b: 'https://api.example.org/rel/{rel}' }
+  end
 end

data/features/webmachine.feature

@@ -17,6 +17,9 @@ Feature: Webmachine CRUD operations
           "api": {
             "href": "https://example.org/api"
           },
+          "health": {
+            "href": "https://example.org/health"
+          },
           "items": {
             "href": "https://example.org/items"
           },
@@ -35,6 +38,28 @@ Feature: Webmachine CRUD operations
       }
       """
 
+  Scenario: Get service health
+    When the client does a GET request to "/health"
+    Then the status code should be "200" (OK)
+    And the response should be JSON:
+      """json
+      {
+        "healthy": true
+      }
+      """
+
+  Scenario: Get unhealthy service health
+    Given the configuration "healthy" is set to "false"
+    When the client does a GET request to "/health"
+    Then the status code should be "503" (Service Unavailable)
+    And the response contains the "Retry-After" header with value "60"
+    And the response should be JSON:
+      """json
+      {
+        "healthy": false
+      }
+      """
+
   Scenario: Create resource
     Given the client provides the header "Content-Type: application/json"
     When the client does a POST request to the "items" resource with the following content:

data/lib/eipiai/configuration.rb

@@ -0,0 +1,38 @@
+# 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, :healthy
+
+    def initialize
+      @healthy    = true
+      @curie_uris = {}
+    end
+  end
+
+  @configuration = Configuration.new
+end

data/lib/eipiai/version.rb

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

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

@@ -0,0 +1,81 @@
+require 'eipiai/webmachine/resources/base'
+
+require 'active_support/core_ext/string/inflections'
+require 'json'
+
+module Eipiai
+  # HealthCheck
+  #
+  # Class with a single method `healthy?`. Returns `true` by default.
+  #
+  class HealthCheck
+    # healthy?
+    #
+    # Can be overwritten with custom logic to determine health status.
+    #
+    # @return [true, false] health status of service
+    #
+    def healthy?
+      Eipiai.configuration.healthy == true
+    end
+
+    # to_hash
+    #
+    # Hash representation of the health status.
+    #
+    # @return [Hash] hash representation of health status
+    #
+    def to_hash
+      { 'healthy' => healthy? }
+    end
+  end
+
+  # ApiResource
+  #
+  # The base resource which can be included in regular Webmachine::Resource
+  # objects. It provides sensible defaults for a full-features REST API
+  # endpoint.
+  #
+  class HealthResource < Webmachine::Resource
+    include Resource
+
+    def allowed_methods
+      %w(GET)
+    end
+
+    def content_types_provided
+      [['application/json', :to_json]]
+    end
+
+    def service_available?
+      return true if healthy?
+
+      response.headers['Content-Type'] = 'application/json'
+      response.headers['Retry-After'] = '60'
+
+      response.body = to_json
+      false
+    end
+
+    def object
+      HealthCheck.new
+    end
+
+    def represented
+      object
+    end
+
+    private
+
+    # healthy?
+    #
+    # Returns true if `HealthCheck.new.healthy?` returns `true`, otherwise
+    # returns `false`.
+    #
+    # @return [true, false] health status of service
+    #
+    def healthy?
+      object.healthy?
+    end
+  end
+end

data/lib/eipiai/webmachine.rb

@@ -6,4 +6,5 @@ require 'eipiai/webmachine/ext/request'
 require 'eipiai/webmachine/resources/api'
 require 'eipiai/webmachine/resources/base'
 require 'eipiai/webmachine/resources/collection'
+require 'eipiai/webmachine/resources/health'
 require 'eipiai/webmachine/resources/singular'

data/lib/eipiai.rb

@@ -1,41 +1,5 @@
+require 'eipiai/configuration'
+
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jean Mertz
@@ -236,12 +236,14 @@ files:
 - README.md
 - Rakefile
 - eipiai.gemspec
+- features/step_definitions/steps.rb
 - features/support/app.rb
 - features/support/db.rb
 - features/support/env.rb
 - features/validation.feature
 - features/webmachine.feature
 - lib/eipiai.rb
+- lib/eipiai/configuration.rb
 - lib/eipiai/roar.rb
 - lib/eipiai/roar/ext/hal.rb
 - lib/eipiai/roar/representers/api.rb
@@ -257,6 +259,7 @@ files:
 - lib/eipiai/webmachine/resources/api.rb
 - lib/eipiai/webmachine/resources/base.rb
 - lib/eipiai/webmachine/resources/collection.rb
+- lib/eipiai/webmachine/resources/health.rb
 - lib/eipiai/webmachine/resources/singular.rb
 - script/bootstrap
 - script/documentation