rack-banken 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d8b79c7983910bb312279416974088cb82f2e08
+  data.tar.gz: 3c09e94c43c1de5ece72b6fdd7ca57612730e018
+SHA512:
+  metadata.gz: d50378b24bccc37ea15863a58af05eabab19ecc696c957d545765144d2d2e18874a174e833623dd5b092cdf2375eb75213cc45c640d291166b3c71e840f09e37
+  data.tar.gz: 3db03e3d5a73d85319b63ea80ce9da9f30cc1f4bcd5e3b76851f086d023b925c3d2b0c40a5db6b0f6922349803f326121bceb779d640cbd0b0af51a53a2cc2db

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-banken.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Arakaki Yuji
+
+MIT License
+
+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,33 @@
+# Rack::Banken
+
+Banken is Rack application for return error response by unified way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-banken', github: "Arakaki-Yuji/rack-banken"
+```
+
+And then execute:
+
+    $ bundle install
+
+## How to Setup
+
+If you use it no rails
+
+````ruby:config/application.rb
+
+.
+.
+.
+module MyApp
+  class Application < Rails::Application
+
+    config.middleware.insert(0, ::Rack::Banken::ExceptionHandler)
+  end
+end
+
+````

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rack/banken.rb

@@ -0,0 +1,14 @@
+require "rack/banken/version"
+
+module Rack
+  module Banken
+    require "rack"
+    require "json"
+
+    require "rack/banken/exception_handler"
+
+    require "rack/banken/exceptions/base"
+    require "rack/banken/exceptions/internal_server_error"
+    require "rack/banken/exceptions/validation_failed"
+  end
+end

data/lib/rack/banken/exception_handler.rb

@@ -0,0 +1,25 @@
+module Rack
+  module Banken
+    class ExceptionHandler
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        begin
+          @app.call(env)
+
+        rescue Exceptions::ValidationFailed => e
+          raise Exceptions::ValidationFailed, e.message
+
+        rescue => e
+          raise Exceptions::InternalServerError, e.message
+        end
+
+      rescue  Exceptions::Base => exception
+        exception.to_rack_response
+      end
+    end
+  end
+end

data/lib/rack/banken/exceptions/base.rb

@@ -0,0 +1,33 @@
+module Rack
+  module Banken
+    module Exceptions
+      class Base < StandardError
+        def to_rack_response
+          [status_code, headers, [body]]
+        end
+
+        private
+
+        def status_code
+          500
+        end
+
+        def headers
+          { "Content-Type" => "application/json" }
+        end
+
+        def body
+          { result: false, error: error_message }.to_json
+        end
+
+        def error_message
+          self.message
+        end
+
+        def type
+          self.class.to_s.split("::").last.underscore
+        end
+      end
+    end
+  end
+end

data/lib/rack/banken/exceptions/internal_server_error.rb

@@ -0,0 +1,8 @@
+module Rack
+  module Banken
+    module Exceptions
+      class InternalServerError < Base
+      end
+    end
+  end
+end

data/lib/rack/banken/exceptions/validation_failed.rb

@@ -0,0 +1,11 @@
+module Rack
+  module Banken
+    module Exceptions
+      class ValidationFailed < Base
+        def status_code
+          400
+        end
+      end
+    end
+  end
+end

data/lib/rack/banken/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Banken
+    VERSION = "0.0.1"
+  end
+end

data/rack-banken.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/banken/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-banken"
+  spec.version       = Rack::Banken::VERSION
+  spec.authors       = ["Arakaki Yuji"]
+  spec.email         = ["arakaki@ryukyu-i.co.jp"]
+  spec.summary       = %q{rack-banken is rack application for return error response.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rack", "~> 1.5.2"
+  spec.add_runtime_dependency "json", "~> 1.7"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+end

data/spec/rack_banken_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+RSpec.describe "Rack::Banken" do
+  include SpecHelper
+  include Rack::Test::Methods
+
+  let(:test_app) { SpecHelper::TestApplication.new }
+  let(:app) { Rack::Banken::ExceptionHandler.new(test_app) }
+
+  it "GET Access" do
+    get '/'
+
+    expect(last_response.status).to eq(200)
+    expect(last_response.body).to eq("test body")
+  end
+
+  describe "if Exception occured" do
+    let(:path){ '/runtime_error' }
+
+    it "response staus is 500" do
+      get path
+      expect(last_response.status).to eq(500)
+    end
+
+    it "response body is formated by Rack::Banken::Exceptions::Base.body" do
+      get path
+      json = JSON.parse(last_response.body)
+
+      expect(json['result']).to eq(false)
+      expect(json['error']).to be_kind_of(String)
+    end
+  end
+
+  describe "if Exception Rack::Banken::Exceptions::ValidationFailed occured" do
+    let(:path) { '/validation_failed' }
+
+    it "response status is 400" do
+      get path
+      expect(last_response.status).to eq(400)
+    end
+
+    it "response body is formated by Rack::Banken::Exceptions::ValidationFailed" do
+      get path
+      json = JSON.parse(last_response.body)
+
+      expect(json['result']).to eq(false)
+      expect(json['error']).to be_kind_of(String)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+ 
+%w(rubygems rack rack/test rack/banken rspec).each do |f|
+  require f
+end
+
+module SpecHelper
+  extend self
+
+  class TestApplication
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if request.path_info == '/runtime_error'
+        raise StandardError, 'runtime error is occured'
+      end
+
+      if request.path_info == '/validation_failed'
+        raise ::Rack::Banken::Exceptions::ValidationFailed, 'params is not valid.'
+      end
+
+      code = 200
+      body = ["test body"]
+      header = {
+        "Content-type" => "text/html;charset=utf-8"
+      }
+      [code, header, body]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rack-banken
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arakaki Yuji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- arakaki@ryukyu-i.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/banken.rb
+- lib/rack/banken/exception_handler.rb
+- lib/rack/banken/exceptions/base.rb
+- lib/rack/banken/exceptions/internal_server_error.rb
+- lib/rack/banken/exceptions/validation_failed.rb
+- lib/rack/banken/version.rb
+- rack-banken.gemspec
+- spec/rack_banken_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: rack-banken is rack application for return error response.
+test_files:
+- spec/rack_banken_spec.rb
+- spec/spec_helper.rb