eipiai 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ea1d2843bc6b4a1b1ed2e268f3a287cdb6c591d
-  data.tar.gz: 72f7c6c496142c5dc5caed1faf5a5c83b1bb810f
+  metadata.gz: 3caaef63d30433d05c9c5dff0b84ca61f641f1b8
+  data.tar.gz: 274f803c8f29821db1379cfeb87b3ad78642d828
 SHA512:
-  metadata.gz: 88c91bbeb2dc81e6337069fd9053c8c5c262a0a43fd7b70a865c544dedb67061c58648ab2ec14cb93982e6bb1d1fa23df259ce2f5fe97c033fc19fbc04560747
-  data.tar.gz: 5a109aac02025614a11feb80a853f12ad980f6c0537e8fef5b77ea3acae12555b09df0d2fc455ab86d70d49298bd147151f4d3bdda479860ab1aa0b0f00c3c8b
+  metadata.gz: cb59e4936e0cfeb9c76e6e86aba56122866a729641c780e08dc5dc6599937fc3dafc24ff02a3071fdbdd869e84330217915b412535b1fa84288c49f2c18f6a67
+  data.tar.gz: 4e0b204b1adc63678bbd9c2a854f25d3a6f6bcf0c39936486ca722e2e6e8d2da20554a46d3a59fb63b9ed2e026811cfc8ebd2648911a73c89a5012e04ff5952e

data/CHANGELOG.md

@@ -1,5 +1,32 @@
 # CHANGELOG
 
+## [unreleased](https://github.com/blendle/eipiai/tree/unreleased) (2016-05-04)
+[Full Changelog](https://github.com/blendle/eipiai/compare/v0.7.0...unreleased)
+
+**Closed issues:**
+
+- make HealthCheck a singleton [\#19](https://github.com/blendle/eipiai/issues/19)
+
+## [v0.7.0](https://github.com/blendle/eipiai/tree/v0.7.0) (2016-05-03)
+[Full Changelog](https://github.com/blendle/eipiai/compare/v0.6.0...v0.7.0)
+
+**Closed issues:**
+
+- api.json should be opt-in, not out-out [\#13](https://github.com/blendle/eipiai/issues/13)
+- Rewrite auto API generator to use some kind of template [\#11](https://github.com/blendle/eipiai/issues/11)
+- Rename `handle\_post\_response` [\#5](https://github.com/blendle/eipiai/issues/5)
+
+**Merged pull requests:**
+
+- add new testing setup [\#23](https://github.com/blendle/eipiai/pull/23) ([JeanMertz](https://github.com/JeanMertz))
+- correctly handle PUT and POST on existing resources [\#22](https://github.com/blendle/eipiai/pull/22) ([JeanMertz](https://github.com/JeanMertz))
+- Tweaks and fixes v2 [\#21](https://github.com/blendle/eipiai/pull/21) ([JeanMertz](https://github.com/JeanMertz))
+- add `service\_available?` check by default [\#18](https://github.com/blendle/eipiai/pull/18) ([JeanMertz](https://github.com/JeanMertz))
+- add Eipiai::Resource::Representable module for resources [\#17](https://github.com/blendle/eipiai/pull/17) ([JeanMertz](https://github.com/JeanMertz))
+- minor tweaks and fixes [\#16](https://github.com/blendle/eipiai/pull/16) ([JeanMertz](https://github.com/JeanMertz))
+- Update Rubocop auto-correct issues [\#15](https://github.com/blendle/eipiai/pull/15) ([JeanMertz](https://github.com/JeanMertz))
+- Introduce options to better define resource link relations [\#14](https://github.com/blendle/eipiai/pull/14) ([JeanMertz](https://github.com/JeanMertz))
+
 ## [v0.6.0](https://github.com/blendle/eipiai/tree/v0.6.0) (2015-12-18)
 [Full Changelog](https://github.com/blendle/eipiai/compare/v0.5.1...v0.6.0)
 

data/Rakefile

@@ -3,24 +3,18 @@ require 'bundler/gem_tasks'
 require 'cucumber/rake/task'
 require 'rubocop/rake_task'
 require 'yard-doctest'
+require 'github_changelog_generator/task'
 
 task default: %w(rubocop features yard:doctest)
 
 RuboCop::RakeTask.new
 
-desc 'Update CHANGELOG.md'
-task 'changelog' do
-  args = %w(
-    --user=blendle
-    --project=eipiai
-    --header-label="# CHANGELOG"
-    --bug-labels=type/bug,bug
-    --enhancement-labels=type/enhancement,enhancement
-    --future-release=unreleased
-    --no-verbose
-  )
-
-  sh %(github_changelog_generator #{args.join(' ')})
+GitHubChangelogGenerator::RakeTask.new :changelog do |c|
+  c.user = 'blendle'
+  c.project = 'eipiai'
+  c.header = '# CHANGELOG'
+  c.future_release = 'unreleased'
+  c.release_branch = 'master'
 end
 
 YARD::Doctest::RakeTask.new do |task|

data/TODO.md

@@ -0,0 +1,13 @@
+# TODO
+
+Some notes and snippets on things we might want to do in the future:
+
+* [IRBWebmachine](https://github.com/generalassembly/irwebmachine)
+
+  Could potentially improve debugging. Hasn't been updated in a while, it looks
+  like some issues where created about it not working anymore. Duplicate some of
+  the basic functionality?
+
+* [http://dry-rb.org](http://dry-rb.org)
+
+  Some useful gems. Validation? Types?

data/eipiai.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'webmachine'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'cucumber'
   spec.add_development_dependency 'cucumber-blendle-steps'
+  spec.add_development_dependency 'cucumber'
   spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'github_changelog_generator'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rack'

data/features/resources/api.feature

@@ -52,6 +52,7 @@ Feature: Request entrypoint of API
 
     When the client does a GET request to "/api"
     Then the status code should be "200" (OK)
+    And the response contains the "Etag" header with value ""6566f445b1a56bc846ef9b95d5d79656""
     And the response should be HAL/JSON:
       """json
       {

data/features/resources/collection.feature

@@ -18,6 +18,7 @@ Feature: Request a collection of resources
     When the client provides the header "Accept: application/json"
     And the client does a GET request to the "items" resource
     Then the status code should be "200" (OK)
+    And the response contains the "Cache-Control" header with value "no-cache, no-store, must-revalidate, private"
     And the response should be JSON:
       """json
       {

data/features/resources/health.feature

@@ -25,3 +25,20 @@ Feature: Request entrypoint of API
         "healthy": false
       }
       """
+
+  Scenario: Return 503 on resources for an unhealthy service
+    Given the configuration "healthy" is set to "false"
+    And the following top-level resource at "/items":
+      """ruby
+      class ItemsResource < Webmachine::Resource
+        include Eipiai::Resource
+
+        def object
+          {}
+        end
+      end
+      """
+    When the client does a GET request to the "items" resource
+    Then the status code should be "503" (Service Unavailable)
+    And the response contains the "Retry-After" header with value "60"
+    And the response contains the "Cache-Control" header with value "no-cache, no-store, must-revalidate, private"

data/features/resources/singular.feature

@@ -19,6 +19,7 @@ Feature: Working with singular resources (GET, POST, PUT, DELETE)
     When the client provides the header "Accept: application/json"
     And the client does a GET request to the "item" resource with the template variable "item_uid" set to "hello"
     Then the status code should be "200" (OK)
+    And the response contains the "Cache-Control" header with value "no-cache, no-store, must-revalidate, private"
     And the response should be JSON:
       """json
       {

data/features/step_definitions/webmachine_steps.rb

@@ -54,5 +54,5 @@ After do
   # Remove links from ApiRepresenter
   #
   Eipiai.class_exec { remove_const(:ApiRepresenter) }
-  load 'eipiai/roar/representers/api.rb'
+  load 'eipiai/representers/api.rb'
 end

data/lib/eipiai.rb

@@ -2,6 +2,6 @@
 require 'eipiai/configuration'
 
 require 'eipiai/models'
-require 'eipiai/roar'
-require 'eipiai/validation'
-require 'eipiai/webmachine'
+require 'eipiai/representers'
+require 'eipiai/resources'
+require 'eipiai/validators'

data/lib/eipiai/representers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'roar'
+
+require 'eipiai/representers/ext/roar/hal'
+
+require 'eipiai/representers/api'
+require 'eipiai/representers/base'

data/lib/eipiai/{roar/representers → representers}/api.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'eipiai/roar/representers/base'
+require 'eipiai/representers/base'
 
 module Eipiai
   # ApiRepresenter

data/lib/eipiai/resources.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'webmachine'
+
+require 'eipiai/resources/concerns/objectifiable'
+require 'eipiai/resources/concerns/representable'
+
+require 'eipiai/resources/ext/webmachine/decision'
+require 'eipiai/resources/ext/webmachine/request'
+
+require 'eipiai/resources/api'
+require 'eipiai/resources/base'
+require 'eipiai/resources/collection'
+require 'eipiai/resources/health'
+require 'eipiai/resources/singular'

data/lib/eipiai/{webmachine/resources → resources}/api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require 'eipiai/webmachine/resources/base'
+require 'eipiai/resources/base'
 
+require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 require 'json'
 
@@ -22,15 +23,28 @@ module Eipiai
   class ApiResource < Webmachine::Resource
     include Resource
 
+    # `etag` is set once, and then re-used throughout the lifecycle of the
+    # application. Only a restart of the web server will reset its value.
+    #
+    mattr_accessor :etag
+
     def top_level_relation?
       true
     end
 
+    def service_available?
+      true
+    end
+
+    def generate_etag
+      self.class.etag ||= Digest::MD5.hexdigest(to_json)
+    end
+
     def allowed_methods
       %w(GET)
     end
 
-    def cache_header
+    def cache_control_header_value
       'public, max-age=600, s-maxage=86400'
     end
 

data/lib/eipiai/{webmachine/resources → resources}/base.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'eipiai/webmachine/resources/singular'
-require 'eipiai/webmachine/resources/collection'
+require 'eipiai/resources/singular'
+require 'eipiai/resources/collection'
 
 require 'active_support/core_ext/string/inflections'
 require 'json'
@@ -75,9 +75,23 @@ module Eipiai
       []
     end
 
+    # service_available?
+    #
+    # If the service is unavailable, this method should return false. By
+    # default, this method calls the `HealthCheck#healthy?` method, which in
+    # turn returns `true` or `false`, depending on the state of the service and
+    # its dependencies.
+    #
+    # When the service is unavailable, the `Cache-Control` header is set to not
+    # allow any caching by proxies/clients, and sets the `Retry-After` header to
+    # tell the client to retry again in 60 seconds.
+    #
+    # @return [true, false]
+    #
     def service_available?
       return true if Eipiai::HealthCheck.new.healthy?
 
+      response.headers['Cache-Control'] = 'no-cache, no-store, must-revalidate, private'
       response.headers['Retry-After'] = '60'
       false
     end
@@ -138,6 +152,10 @@ module Eipiai
       true
     end
 
+    def finish_request
+      response.headers['Cache-Control'] = cache_control_header_value
+    end
+
     # params
     #
     # Given a string in JSON format, returns the hash representation of that
@@ -225,6 +243,16 @@ module Eipiai
 
     private
 
+    # cache_control_header_value
+    #
+    # The default Cache-Control header value served by all resources.
+    #
+    # @return String default Cache-Control header value
+    #
+    def cache_control_header_value
+      'no-cache, no-store, must-revalidate, private'
+    end
+
     def json_error_body(errors)
       response.headers['Content-Type'] = 'application/json'
       response.body = FormattedErrors.parse(errors).to_json

data/lib/eipiai/{webmachine/resources → resources}/collection.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'eipiai/webmachine/resources/base'
+require 'eipiai/resources/base'
 
 module Eipiai
   # CollectionResource

data/lib/eipiai/{webmachine/resources → resources}/health.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'eipiai/webmachine/resources/base'
+require 'eipiai/resources/base'
 
 require 'active_support/core_ext/string/inflections'
 require 'json'
@@ -63,6 +63,10 @@ module Eipiai
       false
     end
 
+    def finish_request
+      response.headers['Cache-Control'] = 'no-cache, no-store, must-revalidate, private'
+    end
+
     def object
       HealthCheck.new
     end

data/lib/eipiai/{webmachine/resources → resources}/singular.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'eipiai/webmachine/resources/base'
+require 'eipiai/resources/base'
 
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/string/inflections'

data/lib/eipiai/validators.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'eipiai/validators/concerns/formatted_errors'
+
+require 'eipiai/validators/base'
+require 'eipiai/validators/sequel'

data/lib/eipiai/{validation/validators → validators}/sequel.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'eipiai/validation/validators/base'
+require 'eipiai/validators/base'
 
 module Eipiai
   # SequelValidator

data/lib/eipiai/version.rb

@@ -4,5 +4,5 @@
 # The current version of the Eipiai library.
 #
 module Eipiai
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/script/test

@@ -1,3 +1,5 @@
 #!/bin/sh
 
-bundle exec rake
+bundle exec cucumber --strict --no-source --order random --tags ~@wip "$@"
+yard doctest --pride
+bundle exec rubocop -DSE

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Jean Mertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: cucumber-blendle-steps
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber-blendle-steps
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -236,6 +250,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- TODO.md
 - eipiai.gemspec
 - features/resources/api.feature
 - features/resources/collection.feature
@@ -258,25 +273,25 @@ files:
 - 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
-- lib/eipiai/roar/representers/base.rb
-- lib/eipiai/validation.rb
-- lib/eipiai/validation/concerns/formatted_errors.rb
-- lib/eipiai/validation/validators/base.rb
-- lib/eipiai/validation/validators/sequel.rb
+- lib/eipiai/representers.rb
+- lib/eipiai/representers/api.rb
+- lib/eipiai/representers/base.rb
+- lib/eipiai/representers/ext/roar/hal.rb
+- lib/eipiai/resources.rb
+- lib/eipiai/resources/api.rb
+- lib/eipiai/resources/base.rb
+- lib/eipiai/resources/collection.rb
+- lib/eipiai/resources/concerns/objectifiable.rb
+- lib/eipiai/resources/concerns/representable.rb
+- lib/eipiai/resources/ext/webmachine/decision.rb
+- lib/eipiai/resources/ext/webmachine/request.rb
+- lib/eipiai/resources/health.rb
+- lib/eipiai/resources/singular.rb
+- lib/eipiai/validators.rb
+- lib/eipiai/validators/base.rb
+- lib/eipiai/validators/concerns/formatted_errors.rb
+- lib/eipiai/validators/sequel.rb
 - lib/eipiai/version.rb
-- lib/eipiai/webmachine.rb
-- lib/eipiai/webmachine/ext/decision.rb
-- lib/eipiai/webmachine/ext/request.rb
-- 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/concerns/representable.rb
-- lib/eipiai/webmachine/resources/health.rb
-- lib/eipiai/webmachine/resources/singular.rb
 - script/bootstrap
 - script/documentation
 - script/test
@@ -299,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Opinionated JSON-API stack to get the job done.

data/lib/eipiai/roar.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-require 'roar'
-
-require 'eipiai/roar/ext/hal'
-
-require 'eipiai/roar/representers/api'
-require 'eipiai/roar/representers/base'

data/lib/eipiai/validation.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-require 'eipiai/validation/concerns/formatted_errors'
-
-require 'eipiai/validation/validators/base'
-require 'eipiai/validation/validators/sequel'

data/lib/eipiai/webmachine.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-require 'webmachine'
-
-require 'eipiai/webmachine/ext/decision'
-require 'eipiai/webmachine/ext/request'
-
-require 'eipiai/webmachine/resources/concerns/objectifiable'
-require 'eipiai/webmachine/resources/concerns/representable'
-
-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'