repia 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58b009fb035768295085359fa8691131240bc972
-  data.tar.gz: cca0b9c1a35e7c92a489fe24362cae9128a019a8
+  metadata.gz: 49ce47f5fd78ab42d146e3609a18d5a4f52131e8
+  data.tar.gz: 650e067cdeccb5b2d1eb89543232a5017b64784b
 SHA512:
-  metadata.gz: 8ac3b531337a59b00877e1e80ef38cf046bb0131db0a053971b64f1dca261219872dfa72b74525424f3504fcac9c02e024978aad4082c78fcea595d9d6b676ae
-  data.tar.gz: e9a7c31828bdecbae836a3a53e9abba1c26ada136a7f046a53d21aa8fabbc2a92a4f55d14ce81dae5259a0843c5ac4e7ac7a4ccd0bf11fd30edf5ee4a4c4777b
+  metadata.gz: 52c031db5fd4279284e87cf72c6633feb8af94516ff0df899cb25b119c03ed074bbad07911749081bd6b61992300336028d962ba741ebf2d9d09e2ac47aaf59f
+  data.tar.gz: 85c3846603cf84ad6d20a2843ea4bbb7de5cf7e10534847f6478a01e2bdb603263c924c6ad1981b8c8ea33f1836ce47c2e27484ac45aa8fd31945f7265f3e333

data/README.md

@@ -16,7 +16,7 @@ Add `gem 'repia'` to your project `Gemfile`.
 
 Edit `application_controller.rb` as the following:
 
-    class ApplicationController < Repia::BaseController
+    class ApplicationController < Repia::Controller::Base
     end
 
 This will allow all controllers in the project to inherit from
@@ -26,13 +26,13 @@ pre-defined HTTP errors.
 Next, update all models that need UUID as a primary identifier:
 
     class Something < ActiveRecord::Base
-      include Repia::UUIDModel
+      include Repia::Support::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
+    class CreateSomethings < ActiveRecord::Migration[5.0]
       def change
         create_table :somethings, id: false do |t|
           t.string :uuid, primary_key: true, null: false
@@ -59,7 +59,7 @@ 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
+Routing errors can be caught using `Repia::Controller::Base#exceptions_app`. To
 configure it, add this to `config/application.rb`:
 
     config.exceptions_app = lambda {|env| ApplicationController.action(:exceptions_app).call(env)}

data/lib/repia.rb

@@ -1,8 +1,8 @@
-require 'repia/errors'
-require 'repia/middlewares'
-require 'repia/uuid_model'
-require 'repia/base_helper'
-require 'repia/base_controller'
+require_relative 'repia/errors'
+require_relative 'repia/middlewares'
+require_relative 'repia/support'
+require_relative 'repia/helper'
+require_relative 'repia/controller'
 
 module Repia
 end

data/lib/repia/controller.rb

@@ -0,0 +1 @@
+require_relative 'controller/base'

data/lib/repia/controller/base.rb

@@ -0,0 +1,32 @@
+require 'json'
+require_relative '../errors'
+require_relative '../helper/base'
+
+module Repia
+  module Controller
+    ##
+    # This controller is a base controller for RESTful API. Two primary
+    # features:
+    #
+    # - Error (exception) handling
+    # - Options request handling
+    #
+    class Base < ActionController::Base
+      include Helper::Base
+
+      # 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
+end

data/lib/repia/helper.rb

@@ -0,0 +1 @@
+require_relative 'helper/base'

data/lib/repia/helper/base.rb

@@ -0,0 +1,82 @@
+require_relative '../errors'
+
+module Repia
+  module Helper
+    ##
+    # This helper module includes methods that are essential for building a
+    # RESTful API.
+    #
+    module Base
+
+      ##
+      # Use this as an action triggered by exceptions_app to return a JSON
+      # response to any middleware level exceptions.
+      #
+      # For example,
+      #
+      # config.exceptions_app = lambda { |env|
+      #   ApplicationController.action(:exceptions_app).call(env)
+      # }
+      #
+      def exceptions_app
+        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
+        else
+          # :nocov:
+          status = 500
+          message = "Unknown error"
+          # :nocov:
+        end
+        render_error status, message
+      end
+
+      ##
+      # Renders a generic OPTIONS response. The actual controller must
+      # override this action if desired to have specific OPTIONS handling
+      # logic.
+      #
+      def options
+        # echo back access-control-request-headers
+        if request.headers["Access-Control-Request-Headers"]
+          response["Access-Control-Allow-Headers"] =
+              request.headers["Access-Control-Request-Headers"]
+        end
+        render body: "", status: 200
+      end
+
+      ##
+      # Renders a single error.
+      #
+      def render_error(status, msg)
+        render json: {errors: [msg]}, status: status
+      end
+
+      ##
+      # Renders multiple errors
+      #
+      def render_errors(status, msgs)
+        render json: {errors: msgs}, status: status
+      end
+
+      ##
+      # 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.
+      # The error can be optionally suppresed by specifying nil to error.
+      #
+      # An Repia::Errors::NotFound is raised if specified to do so when
+      # the object could not be found using the uuid.
+      #
+      def find_object(model, uuid, error: Errors::NotFound)
+        logger.debug("Attempting to get #{model.name} #{uuid}")
+        obj = model.find_by_uuid(uuid)
+        if obj.nil? && !error.nil?
+          raise error, "#{model.name} #{uuid} cannot be found"
+        end
+        return obj
+      end
+    end
+  end
+end

data/lib/repia/middlewares.rb

@@ -1,30 +1 @@
-module Repia
-  ##
-  # This class serves as a middleware to handle Method Not Allowed error
-  # (which is not handled by show_exceptions for some reason).
-  #
-  # Code was excerpted from https://gist.github.com/viola/1243572 and was
-  # modified to serve a JSON response.
-  #
-  # Add it after ActionDispatch::RequestId to keep the request ID in the
-  # response headers.
-  #
-  class HttpMethodNotAllowed
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      if !ActionDispatch::Request::HTTP_METHODS.include?(env["REQUEST_METHOD"].upcase)
-        Rails.logger.info("ActionController::UnknownHttpMethod: #{env.inspect}")
-        [405, 
-         {"Content-Type" => "application/json; charset=utf-8"},
-         [JSON.generate({errors: ["Method not allowed"]})]
-        ]
-      else
-        @status, @headers, @response = @app.call(env)
-        [@status, @headers, @response]
-      end
-    end
-  end
-end
+require_relative 'middlewares/http_method_not_allowed'

data/lib/repia/middlewares/http_method_not_allowed.rb

@@ -0,0 +1,32 @@
+module Repia
+  module Middlewares
+    ##
+    # This class serves as a middleware to handle Method Not Allowed error
+    # (which is not handled by show_exceptions for some reason).
+    #
+    # Code was excerpted from https://gist.github.com/viola/1243572 and was
+    # modified to serve a JSON response.
+    #
+    # Add it after ActionDispatch::RequestId to keep the request ID in the
+    # response headers.
+    #
+    class HttpMethodNotAllowed
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if !ActionDispatch::Request::HTTP_METHODS.include?(env["REQUEST_METHOD"].upcase)
+          Rails.logger.info("ActionController::UnknownHttpMethod: #{env.inspect}")
+          [405,
+           {"Content-Type" => "application/json; charset=utf-8"},
+           [JSON.generate({errors: ["Method not allowed"]})]
+          ]
+        else
+          @status, @headers, @response = @app.call(env)
+          [@status, @headers, @response]
+        end
+      end
+    end
+  end
+end

data/lib/repia/support.rb

@@ -0,0 +1 @@
+require_relative 'support/uuid_model'

data/lib/repia/support/uuid_model.rb

@@ -0,0 +1,31 @@
+
+module Repia
+
+  module Support
+
+    ##
+    # 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
+end

data/lib/repia/version.rb

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

data/test/dummy/app/controllers/application_controller.rb

@@ -1,4 +1,4 @@
-class ApplicationController < Repia::BaseController
+class ApplicationController < Repia::Controller::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception

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

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

data/test/repia_middlewares_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 class RepiaTest < ActiveSupport::TestCase
   test "HttpMethodNotAllowed middleware throws 405 for invalid HTTP method" do
     app = lambda {|env| [200, {}, [""]]}
-    stack = Repia::HttpMethodNotAllowed.new(app)
+    stack = Repia::Middlewares::HttpMethodNotAllowed.new(app)
     request = Rack::MockRequest.new(stack)
     response = request.request("DOESNOTEXIST", "/users")
     assert response.headers["Content-Type"].include?("application/json")
@@ -12,7 +12,7 @@ class RepiaTest < ActiveSupport::TestCase
 
   test "HttpMethodNotAllowed middleware does not throw 405 for valid HTTP method" do
     app = lambda {|env| [200, {}, [""]]}
-    stack = Repia::HttpMethodNotAllowed.new(app)
+    stack = Repia::Middlewares::HttpMethodNotAllowed.new(app)
     request = Rack::MockRequest.new(stack)
     response = request.request("GET", "/users")
     assert_equal 200, response.status.to_i

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repia
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David An
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2016-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -92,11 +92,15 @@ files:
 - README.md
 - Rakefile
 - lib/repia.rb
-- lib/repia/base_controller.rb
-- lib/repia/base_helper.rb
+- lib/repia/controller.rb
+- lib/repia/controller/base.rb
 - lib/repia/errors.rb
+- lib/repia/helper.rb
+- lib/repia/helper/base.rb
 - lib/repia/middlewares.rb
-- lib/repia/uuid_model.rb
+- lib/repia/middlewares/http_method_not_allowed.rb
+- lib/repia/support.rb
+- lib/repia/support/uuid_model.rb
 - lib/repia/version.rb
 - lib/tasks/repia_tasks.rake
 - test/dummy/README.rdoc
@@ -137,7 +141,6 @@ files:
 - test/dummy/db/migrate/20160423030023_create_unique_models.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -175,54 +178,53 @@ signing_key:
 specification_version: 4
 summary: Rails Essential Plug-in for API
 test_files:
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/javascripts/dummies.js
+- test/test_helper.rb
+- test/repia_unique_model_test.rb
+- test/dummy/README.rdoc
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/models/unique_model.rb
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/assets/stylesheets/dummies.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/dummies.js
 - test/dummy/app/helpers/dummies_helper.rb
-- test/dummy/app/models/unique_model.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/Rakefile
+- test/dummy/public/500.html
+- test/dummy/public/404.html
+- test/dummy/public/favicon.ico
+- test/dummy/public/422.html
+- test/dummy/config/locales/en.yml
 - test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/routes.rb
 - test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/cookies_serializer.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/filter_parameter_logging.rb
 - test/dummy/config/secrets.yml
-- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
 - test/dummy/db/development.sqlite3
+- test/dummy/db/test.sqlite3
 - test/dummy/db/migrate/20160423030023_create_unique_models.rb
 - test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/dummy/test/controllers/dummies_controller_test.rb
+- test/dummy/config.ru
 - test/dummy/test/fixtures/unique_models.yml
 - test/dummy/test/models/unique_model_test.rb
-- test/repia_base_controller_test.rb
-- test/repia_middlewares_test.rb
+- test/dummy/test/controllers/dummies_controller_test.rb
+- test/dummy/bin/bundle
+- test/dummy/bin/rails
+- test/dummy/bin/setup
+- test/dummy/bin/rake
 - test/repia_test.rb
-- test/repia_unique_model_test.rb
-- test/test_helper.rb
+- test/repia_middlewares_test.rb
+- test/repia_base_controller_test.rb