repia 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48cc1f107f305100b05ac5988d7b423c39c59871
-  data.tar.gz: d72b0acc3d21385ffceb17fd4da2b7e6779048ee
+  metadata.gz: 58b009fb035768295085359fa8691131240bc972
+  data.tar.gz: cca0b9c1a35e7c92a489fe24362cae9128a019a8
 SHA512:
-  metadata.gz: 41f69c5cb1c7312a558da4e468a60cdcbdace45c11819a3410caa493e71096151d7f1fa3f4eaa161f973bb36c2082205f525b146fba10590baeac5d2ba1d0c6f
-  data.tar.gz: d854fb71bcedadac0a6d28bb7b65cf26c0d40cc0e1178ca4aef7f8c47b19c450370f60a97c537289dafda9441c5c6cff1381595ddf99b0e3fd34f9e566306356
+  metadata.gz: 8ac3b531337a59b00877e1e80ef38cf046bb0131db0a053971b64f1dca261219872dfa72b74525424f3504fcac9c02e024978aad4082c78fcea595d9d6b676ae
+  data.tar.gz: e9a7c31828bdecbae836a3a53e9abba1c26ada136a7f046a53d21aa8fabbc2a92a4f55d14ce81dae5259a0843c5ac4e7ac7a4ccd0bf11fd30edf5ee4a4c4777b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David An
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# repia
+
+[![Build Status](https://travis-ci.org/davidan1981/repia.svg?branch=master)](https://travis-ci.org/davidan1981/repia)
+[![Coverage Status](https://coveralls.io/repos/github/davidan1981/repia/badge.svg?branch=master)](https://coveralls.io/github/davidan1981/repia?branch=master)
+[![Code Climate](https://codeclimate.com/github/davidan1981/repia/badges/gpa.svg)](https://codeclimate.com/github/davidan1981/repia)
+[![Gem Version](https://badge.fury.io/rb/repia.svg)](https://badge.fury.io/rb/repia)
+
+Rails Essential Plug-in for API (or repia) is a Rails plugin that serves as
+a collection of features that are useful for RESTful API development.
+
+## Install
+
+Add `gem 'repia'` to your project `Gemfile`.
+
+## How to Use Repia
+
+Edit `application_controller.rb` as the following:
+
+    class ApplicationController < Repia::BaseController
+    end
+
+This will allow all controllers in the project to inherit from
+`Repia::BaseController`, which gracefully handles all _code_ errors using
+pre-defined HTTP errors. 
+
+Next, update all models that need UUID as a primary identifier:
+
+    class Something < ActiveRecord::Base
+      include Repia::UUIDModel
+    end
+
+This will trigger UUID generation before a record object is created. Note
+that migration must look similar to this:
+
+    class CreateSomethings < ActiveRecord::Migration
+      def change
+        create_table :somethings, id: false do |t|
+          t.string :uuid, primary_key: true, null: false
+          t.string :name
+          t.timestamps null: false
+        end
+      end
+    end
+
+## Middleware
+
+When developing a JSON API, it is annoying to see non-JSON error responses
+from a middleware. There are two prominent cases: `405 Method Not Allowed`
+and `404 Not Found`. The former occurs when the request method is invalid
+and the latter happens when the route does not match any controller or
+action. Since these are caught within middleware, `rescue_from` does not
+really help. So repia provides two useful components for this.
+
+### Method Not Allowed
+
+This class is a middleware that can be inserted (preferrably after
+`ActionDispatch::RequestId`) to catch 405 errors. Instead of using a view
+template, it will return a simple JSON response with a status of 405.
+
+### Routing Error
+
+Routing errors can be caught using `BaseController#exceptions_app`. To
+configure it, add this to `config/application.rb`:
+
+    config.exceptions_app = lambda {|env| ApplicationController.action(:exceptions_app).call(env)}
+
+*NOTE*: To enable this feature in development and in test,
+`config/environments/development.rb` and `config/environments/test.rb` must
+have 
+
+    config.consider_all_requests_local = false

data/Rakefile

@@ -28,6 +28,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
 

data/lib/repia/base_controller.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'repia/errors'
+require 'repia/base_helper'
+
+module Repia
+
+  ##
+  # This controller is a base controller for RESTful API. Two primary
+  # features: 
+  #
+  # - Error (exception) handling
+  # - Options request handling
+  # 
+  class BaseController < ActionController::Base
+    include BaseHelper
+
+    # This is a catch-all.
+    rescue_from StandardError do |exception|
+      logger.error exception.message
+      render_error 500, "Unknown error occurred: #{exception.message}"
+    end
+
+    # Catch all manually thrown HTTP errors (predefined by repia)
+    rescue_from Errors::HTTPError do |exception|
+      status_code = exception.class.const_get("STATUS_CODE")
+      message = exception.message || exception.class::MESSAGE
+      logger.error "#{status_code} - #{message}"
+      render_error status_code, message
+    end
+
+  end
+
+end

data/lib/repia/{core.rb → base_helper.rb}

@@ -1,41 +1,26 @@
-require 'json'
 require 'repia/errors'
 
 module Repia
 
   ##
-  # This module is a mixin that allows the model to use UUIDs instead of
-  # normal IDs. By including this module, the model class declares that the
-  # primary key is called "uuid" and an UUID is generated right before
-  # save(). You may assign an UUID prior to save, in which case, no new UUID
-  # will be generated.
+  # This helper module includes methods that are essential for building a
+  # RESTful API.
   #
-  module UUIDModel
-
-    ##
-    # Triggered when this module is included.
-    #
-    def self.included(klass)
-      klass.primary_key = "uuid"
-      klass.before_create :generate_uuid
-    end
-
-    ##
-    # Generates an UUID for the model object.
-    #
-    def generate_uuid()
-      self.uuid = UUIDTools::UUID.timestamp_create().to_s if self.uuid.nil?
-    end
-  end
-
   module BaseHelper
 
     ##
     # Use this as an action triggered by exceptions_app to return a JSON
-    # response to any middleware level exceptions
+    # response to any middleware level exceptions.
+    #
+    # For example,
+    #
+    # config.exceptions_app = lambda { |env| 
+    #   ApplicationController.action(:exceptions_app).call(env)
+    # }
     #
     def exceptions_app
-      status = ActionDispatch::ExceptionWrapper.new(env, @exception).status_code.to_i
+      ex_wrapper = ActionDispatch::ExceptionWrapper.new(Rails.env, @exception)
+      status = ex_wrapper.status_code.to_i
       error = Errors::STATUS_CODE_TO_ERROR[status]
       if error
         message = error::MESSAGE
@@ -76,6 +61,7 @@ module Repia
       render json: {errors: msgs}, status: status
     end
 
+    # undef :find_object if method_defined? :find_object
     ##
     # Finds an object by model and UUID and throws an error (which will be
     # caught and re-thrown as an HTTP error) if the object does not exist.
@@ -94,31 +80,4 @@ module Repia
     end
 
   end
-
-  ##
-  # This controller is a base controller for RESTful API. Two primary
-  # features: 
-  #
-  # - Error (exception) handling
-  # - Options request handling
-  # 
-  class BaseController < ActionController::Base
-    include BaseHelper
-
-    # This is a catch-all.
-    rescue_from StandardError do |exception|
-      logger.error exception.message
-      render_error 500, "Unknown error occurred: #{exception.message}"
-    end
-
-    # Catch all manually thrown HTTP errors (predefined by repia)
-    rescue_from Errors::HTTPError do |exception|
-      status_code = exception.class.const_get("STATUS_CODE")
-      message = exception.message || exception.class::MESSAGE
-      logger.error "#{status_code} - #{message}"
-      render_error status_code, message
-    end
-
-  end
-
 end

data/lib/repia/uuid_model.rb

@@ -0,0 +1,28 @@
+
+module Repia
+
+  ##
+  # This module is a mixin that allows the model to use UUIDs instead of
+  # normal IDs. By including this module, the model class declares that the
+  # primary key is called "uuid" and an UUID is generated right before
+  # save(). You may assign an UUID prior to save, in which case, no new UUID
+  # will be generated.
+  #
+  module UUIDModel
+
+    ##
+    # Triggered when this module is included.
+    #
+    def self.included(klass)
+      klass.primary_key = "uuid"
+      klass.before_create :generate_uuid
+    end
+
+    ##
+    # Generates an UUID for the model object.
+    #
+    def generate_uuid()
+      self.uuid = UUIDTools::UUID.timestamp_create().to_s if self.uuid.nil?
+    end
+  end
+end

data/lib/repia/version.rb

@@ -1,3 +1,3 @@
 module Repia
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/repia.rb

@@ -1,6 +1,8 @@
 require 'repia/errors'
 require 'repia/middlewares'
-require 'repia/core'
+require 'repia/uuid_model'
+require 'repia/base_helper'
+require 'repia/base_controller'
 
 module Repia
 end

data/test/dummy/app/models/unique_model.rb

@@ -1,3 +1,4 @@
 class UniqueModel < ActiveRecord::Base
   include Repia::UUIDModel
 end
+

data/test/dummy/config/application.rb

@@ -20,7 +20,7 @@ module Dummy
     # config.i18n.default_locale = :de
 
     # Do not swallow errors in after_commit/after_rollback callbacks.
-    config.active_record.raise_in_transactional_callbacks = true
+    # config.active_record.raise_in_transactional_callbacks = true
   end
 end
 

data/test/dummy/config/environments/test.rb

@@ -13,8 +13,8 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static file server for tests with Cache-Control for performance.
-  config.serve_static_files   = true
-  config.static_cache_control = 'public, max-age=3600'
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
 
   # Show full error reports and disable caching.
   config.consider_all_requests_local       = true