eipiai 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 877a72bd72e8b2b172a6f1d5e534c938b12dc675
-  data.tar.gz: 3b11eae2304fa9a61a2ccb45e78eb0c2a1be17ff
+  metadata.gz: 11411b6b54cd8d262763b931fd39c8cc07267b01
+  data.tar.gz: b0fd69f854bee571d6a064c594e44ccfea576b98
 SHA512:
-  metadata.gz: ea7009b9c493cb4e757c5ee6f3a19a0db3ead47df7c5dcd555acf73e01565e97469529a596f031924331821029241d3ccbab328092b0caade6cb7d5c7b896f75
-  data.tar.gz: 5a1a3e46d6ed34468c386d1388315a9d2d2235563bbfa1c9b0e00906d97958b7cfa87ef5aecffaec29f8647723bac4e234d8046a637737d0baab520319d37975
+  metadata.gz: 9e819fa5def0aa433c40fb91a170f0b18215e460132dd4c7c75987fcf3e169ac594b3d30e3f58461cc398239c37b060721f8b5201c2f790ac23bda0122e1999d
+  data.tar.gz: 6644c4fb34968fcb2bb987929852d223f1a24e0404e2ada895578de0da41b5a9dff53fa6289d317cb6e75316efbd2ed46ddea81d4c93ff540f09fdfa6dd5b416

data/.gitignore

@@ -3,6 +3,7 @@ _cache
 _projects
 _steps
 .bundle
+.DS_Store
 .yardoc
 *.gem
 doc/

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# CHANGELOG
+
+## [v0.1.0](https://github.com/blendle/eipiai/tree/v0.1.0) (2015-12-12)
+**Merged pull requests:**
+
+- initial implementation [\#1](https://github.com/blendle/eipiai/pull/1) ([JeanMertz](https://github.com/JeanMertz))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -1,4 +1,4 @@
-# `/ˌeɪ.piˈaɪ/` – The JSON API Framework
+# `/ˌeɪ.piˈaɪ/` – The JSON API Framework [![wercker status](https://app.wercker.com/status/afba12ab733cdd8a55cb39db0b68c275/s/master "wercker status")](https://app.wercker.com/project/bykey/afba12ab733cdd8a55cb39db0b68c275)
 
 Opinionated JSON-API stack to get the job done.
 

data/features/support/app.rb

@@ -3,16 +3,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'eipiai'
 require 'webmachine/adapters/rack'
-require_relative '../../support/fixtures/webmachine/app'
+require_relative '../../support/fixtures/app'
 
-include Eipiai::Webmachine::TestApp
+include Eipiai::TestApp
 
-App = Webmachine::Application.new do |app|
+WebmachineApp = Webmachine::Application.new do |app|
   app.routes do
     add ['api'], Eipiai::ApiResource
 
     add ['items'], ItemsResource
     add ['item', :item_uid], ItemResource
+    add ['users'], UsersResource
+    add ['user', :user_uid], UserResource
   end
 
   app.configure do |config|
@@ -23,5 +25,5 @@ App = Webmachine::Application.new do |app|
 end
 
 def app
-  App.adapter
+  WebmachineApp.adapter
 end

data/features/validation.feature

@@ -0,0 +1,48 @@
+Feature: Object validation
+
+  When accepting external requests to create objects
+  I want to validate the requests
+  So that invalid requests are caught correctly
+
+  Scenario: Invalid user
+    Given the client provides the header "Content-Type: application/json"
+    When the client does a POST request to the "users" resource with the following content:
+      """json
+      {
+        "first_name": "Bart"
+      }
+      """
+    Then the status code should be "422" (Unprocessable Entity)
+    And the response should be JSON:
+      """json
+      {
+        "_errors": [
+          {
+            "id": "MissingUid",
+            "message": "missing uid"
+          }
+        ]
+      }
+      """
+
+  Scenario: Uniqueness constraint
+    Given the user with uid "bartsimpson" exists
+    Given the client provides the header "Content-Type: application/json"
+    When the client does a POST request to the "users" resource with the following content:
+      """json
+      {
+        "uid": "bartsimpson"
+      }
+      """
+    Then the status code should be "422" (Unprocessable Entity)
+    And the response should be JSON:
+      """json
+      {
+        "_errors": [
+          {
+            "id": "ResourceExists",
+            "message": "resource exists"
+          }
+        ]
+      }
+      """

data/features/webmachine.feature

@@ -2,7 +2,7 @@ Feature: Webmachine CRUD operations
 
   When a new JSON API service needs to be developed
   I want to use Eipiai's default CRUD setup
-  So that the basic API operations are quick and easyi to implement
+  So that the basic API operations are quick and easy to implement
 
   Scenario: List main API endpoint
     When the client does a GET request to "/api"
@@ -23,6 +23,13 @@ Feature: Webmachine CRUD operations
           "item": {
             "templated": true,
             "href": "https://example.org/item/{item_uid}"
+          },
+          "users": {
+            "href": "https://example.org/users"
+          },
+          "user": {
+            "templated": true,
+            "href": "https://example.org/user/{user_uid}"
           }
         }
       }
@@ -71,7 +78,7 @@ Feature: Webmachine CRUD operations
 
   Scenario: Update resource
     Given the item with uid "hello" and the price "10" exists
-    Given the client provides the header "Content-Type: application/json"
+    And the client provides the header "Content-Type: application/json"
     When the client does a PUT request to the "item" resource with the template variable "item_uid" set to "hello" and the following content:
       """json
       {
@@ -112,18 +119,7 @@ Feature: Webmachine CRUD operations
               "href": "https://example.org/item/hello"
             }
           ]
-        },
-        "b:items": [
-          {
-            "_links": {
-              "self": {
-                "href": "https://example.org/item/hello"
-              }
-            },
-            "uid": "hello",
-            "price": 10
-          }
-        ]
+        }
       }
       """
 

data/lib/eipiai/validation/concerns/formatted_errors.rb

@@ -0,0 +1,38 @@
+# FormattedErrors
+#
+# copy/paste of the https://github.com/blendle/formatted_errors gem, until that
+# gem is made open source.
+#
+module FormattedErrors
+  class << self
+    def parse(*errors)
+      # First check for array, don't switch these lines as the hash is converted to
+      # an array
+      errors = errors.flatten(1) if errors.length == 1 && errors.first.is_a?(Array)
+      errors = errors.first if errors.length == 1 && errors.first.is_a?(Hash)
+
+      errors = errors.map do |key, value|
+        parse_single(key, **value || {})
+      end
+
+      { _errors: errors }
+    end
+
+    private
+
+    def parse_single(error, **properties)
+      {
+        id: capitalize(error.to_s),
+        message: humanize(error.to_s)
+      }.merge(properties)
+    end
+
+    def capitalize(string)
+      string.split('_').map(&:capitalize).join
+    end
+
+    def humanize(string)
+      string.split('_').join(' ').downcase
+    end
+  end
+end

data/lib/eipiai/validation/validators/base.rb

@@ -0,0 +1,94 @@
+module Eipiai
+  # Validator
+  #
+  # default module used for validation and error handling. Any validator should
+  # always inherit from this validator.
+  #
+  module Validator
+    NotImplementedError = Class.new(StandardError)
+
+    # valid?
+    #
+    # runs validators and returns `true` if no validations failed, otherwise
+    # returns `false`.
+    #
+    # @example successful validation
+    #   Item.new(uid: 'valid').extend(ItemValidator).valid? # => true
+    #
+    # @example failed validation
+    #   Item.new.extend(ItemValidator).valid? # => false
+    #
+    # @return [true, false] status of validators
+    #
+    def valid?
+      validate
+    end
+
+    # invalid?
+    #
+    # @see #valid?
+    # @return [true, false] opposite return value of #valid?
+    #
+    def invalid?
+      !valid?
+    end
+
+    # validate
+    #
+    # This method needs to be implemented in any validators that include this
+    # base validator.
+    #
+    # If the validator does not define this method, a `NotImplementedError`
+    # error is raised.
+    #
+    # @example return NotImplementedError
+    #   Item.new.extend(InvalidValidator).validate
+    #     # => raise Eipiai::Validator::NotImplementedError, "#validate required"
+    #
+    # @return [void]
+    #
+    def validate
+      fail NotImplementedError, '#validate required'
+    end
+
+    # errors
+    #
+    # Set of errors filled during validation. To set errors, see `#add_error`.
+    #
+    # @example
+    #   item = Item.new.extend(ItemValidator)
+    #   item.valid?
+    #   item.errors.to_a # => [:missing_uid]
+    #
+    # @return [Set] set of errors
+    #
+    def errors
+      @errors ||= Set.new
+    end
+
+    # add_error
+    #
+    # given an object, the object is added to the set of errors.
+    #
+    # The method always returns `false`. This can be used to easily check for
+    # errors and add an error message in one go:
+    #
+    #   uid.present? || add_error(:uid_missing)
+    #
+    # The above example will return true if the uid exists, or add the error and
+    # return false to indicate the validation check failed.
+    #
+    # @example
+    #   item = Item.new.extend(ItemValidator)
+    #   item.add_error(:hello_world) # => false
+    #   item.errors.to_a # => [:hello_world]
+    #
+    # @param [Object] error object to add to the errors set
+    # @return [false]
+    #
+    def add_error(error)
+      errors << error
+      false
+    end
+  end
+end

data/lib/eipiai/validation/validators/sequel.rb

@@ -0,0 +1,46 @@
+require 'eipiai/validation/validators/base'
+
+module Eipiai
+  # SequelValidator
+  #
+  # provides default validators specific for Sequel-backed models.
+  #
+  # This validator expects each model to have a `uid` attribute, which
+  # represents the "public" unique identifier of the object.
+  #
+  module SequelValidator
+    include Validator
+
+    # valid_uid?
+    #
+    # validates the presence of the object uid.
+    #
+    # @example valid uid
+    #   Item.new(uid: 'valid').extend(ItemSequelValidator).valid_uid? # => true
+    #
+    # @example invalid uid
+    #   Item.new.extend(ItemSequelValidator).valid_uid? # => false
+    #
+    # @return [true, false] validation status of resource's uid attribute
+    #
+    def valid_uid?
+      uid.present? || add_error(:missing_uid)
+    end
+
+    # unique?
+    #
+    # returns `true` if an object with the same `uid` already exists.
+    #
+    # @example
+    #   item = Item.new(uid: 'hello').extend(ItemSequelValidator)
+    #   item.unique? # => true
+    #   item.save
+    #   item.unique? # => false
+    #
+    # @return [true, false] uniqueness status of object, based on uid attribute
+    #
+    def unique?
+      self.class.first(uid: uid).blank? || add_error(:resource_exists)
+    end
+  end
+end

data/lib/eipiai/validation.rb

@@ -0,0 +1,4 @@
+require 'eipiai/validation/concerns/formatted_errors'
+
+require 'eipiai/validation/validators/base'
+require 'eipiai/validation/validators/sequel'

data/lib/eipiai/version.rb

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

data/lib/eipiai/webmachine/ext/request.rb

@@ -7,6 +7,30 @@ module Webmachine
   # @see http://git.io/vWZFi
   #
   class Request
+    # json?
+    #
+    # returns `true` if the Content-Type header is of type `application/json`.
+    #
+    # @example Content-Type: application/json
+    #   post('/items', '{}', 'Content-Type': 'application/json')
+    #   resource.request.json? # => true
+    #
+    # @example Content-Type: application/json; charset=utf-8
+    #   post('/items', '{}', 'Content-Type': 'application/json; charset=utf-8')
+    #   resource.request.json? # => true
+    #
+    # @example unset Content-Type header
+    #   post('/items', '{}')
+    #   resource.request.json? # => false
+    #
+    # @return [true, false]
+    #
+    def json?
+      return false unless content_type
+
+      Webmachine::MediaType.parse(content_type).type_matches?('application/json')
+    end
+
     # URIReplacement
     #
     # Swaps `Webmachine::Request#uri` from `URI` to `Addressable::URI`.

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

@@ -29,6 +29,50 @@ module Eipiai
       base.extend(ClassMethods)
     end
 
+    # malformed_request?
+    #
+    # return `true` if content_type is of type `application/json`, and the JSON
+    # request body cannot be parsed.
+    #
+    # @example valid JSON payload
+    #   post('/items', '{ "uid": "hello" }', 'Content-Type': 'application/json')
+    #   resource.malformed_request? # => false
+    #
+    # @example invalid JSON payload
+    #   post('/items', '{ invalid! }', 'Content-Type': 'application/json')
+    #   resource.malformed_request? # => true
+    #
+    # @return [true, false]
+    #
+    def malformed_request?
+      return false unless request.json? && request.body.to_s.present?
+
+      JSON.parse(request.body.to_s) && false
+    rescue JSON::ParserError
+      json_error_body(:invalid_json)
+    end
+
+    # unprocessable_entity?
+    #
+    # return `true` if content_type is of type `application/json`, and the newly
+    # generated object reports back as "invalid".
+    #
+    # @example invalid object
+    #   post('/users', '{}', 'Content-Type': 'application/json')
+    #   resource.unprocessable_entity? # => true
+    #
+    # @example valid object
+    #   post('/users', '{ "uid": "bartsimpson" }', 'Content-Type': 'application/json')
+    #   resource.unprocessable_entity? # => false
+    #
+    # @return [true, false]
+    #
+    def unprocessable_entity?
+      return false unless request.json? && new_object.respond_to?(:invalid?)
+
+      new_object.invalid? && json_error_body(*new_object.errors)
+    end
+
     def content_types_provided
       [['application/hal+json', :to_json]]
     end
@@ -182,6 +226,12 @@ module Eipiai
       nil
     end
 
+    def json_error_body(errors)
+      response.headers['Content-Type'] = 'application/json'
+      response.body = FormattedErrors.parse(errors).to_json
+      true
+    end
+
     # ClassMethods
     #
     # These methods will be defined on the class in which this module is

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

@@ -15,12 +15,6 @@ module Eipiai
       %w(GET POST)
     end
 
-    # TODO(JeanMertz): enable when validators are implemented.
-    #
-    # def unprocessable_entity?
-    #   super && json_error_body(*new_object.errors)
-    # end
-
     def post_is_create?
       true
     end
@@ -36,8 +30,8 @@ module Eipiai
     private
 
     def content_type_handler
-      content_type = response.headers[::Webmachine::CONTENT_TYPE]
-      media_type   = ::Webmachine::MediaType.parse(content_type)
+      content_type = response.headers[Webmachine::CONTENT_TYPE]
+      media_type   = Webmachine::MediaType.parse(content_type)
 
       content_types_provided.find { |ct, _| media_type.type_matches?(ct) }.last
     end

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

@@ -19,15 +19,6 @@ module Eipiai
       %w(GET PUT DELETE)
     end
 
-    # TODO(JeanMertz): enable when validators are implemented.
-    #
-    # def unprocessable_entity?
-    #   return unless super
-    #   return if request.put? && new_object.errors.include?(:resource_exists)
-    #
-    #   json_error_body(*new_object.errors)
-    # end
-
     def resource_exists?
       object.present?
     end

data/lib/eipiai.rb

@@ -1,2 +1,3 @@
 require 'eipiai/roar'
+require 'eipiai/validation'
 require 'eipiai/webmachine'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eipiai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jean Mertz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-12 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -231,6 +231,7 @@ files:
 - ".hubbit.yml"
 - ".rubocop.yml"
 - ".wercker.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -238,10 +239,15 @@ files:
 - features/support/app.rb
 - features/support/db.rb
 - features/support/env.rb
+- features/validation.feature
 - features/webmachine.feature
 - lib/eipiai.rb
 - lib/eipiai/roar.rb
 - lib/eipiai/roar/representers/api.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/version.rb
 - lib/eipiai/webmachine.rb
 - lib/eipiai/webmachine/ext/decision.rb