rack-kibo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b982b98f4e456ec37e1e59aebbc440a3f19630ee
+  data.tar.gz: f695548f4440427ef8730bef04f73a965af596dc
+SHA512:
+  metadata.gz: 92940a0b476087f8b4825d66f9ca6e925bf40054cc4935653a88717ca2dab721912f6d4683de987676b1d197c37bd0130a0a786ffdf92e9325618ff371878081
+  data.tar.gz: 0928cdafff8f26ae35ea25031f26350ecaabbad447be192156157fce1c03104a4fbfa42b120a8a6e187236be9aaacf939e5e3a4a0869f1673a9651ede5a03424

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marshall Mickelson
+
+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,112 @@
+# Rack::Kibo
+
+A Rack Middleware to present structured JSON responses
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-kibo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-kibo
+
+## What Kibo Does
+
+Kibo will wrap any request for,or response containing the JSON
+Content-Type `application/json` in a simple structured JSON object:
+
+```javascript
+{
+  "success": true,
+  "responded_at": 'utc date of response',
+  "version": 1,
+  "location": "/location/of/resource/requested",
+  "body": {
+    // your server's response object
+  }
+}
+```
+
+Kibo will always return a successful HTTP Status code (anything less
+than 400) unless there was an error within Kibo itself. If the response
+from your server is an error code, Kibo returns HTTP 200, with the
+`success` property of `false`
+
+
+## Getting Started
+
+### Rackup-based apps
+
+Add the middleware to your Rack app
+
+```ruby
+use Rack::Kibo
+```
+
+### Options
+
+You can control how Kibo returns errors by supplying an `:expose_errors`
+item in the initialization of your middleware
+
+```ruby
+use Rack::Kibo, :expose_errors => true
+```
+
+`:expose_errors` defaults to `false`
+
+Setting this value to `true` will return exception messages back to the
+browser, potentially exposing your API's implementation. In addition to
+exposing the error message, the original server response will be
+returned.
+
+### API Version Computation
+
+Kibo looks for request path segments that contain `api/{version}` where
+`version` is a number, or a number preceeded by either a lowercase `v`
+or uppercase 'V'
+
+```ruby
+"/some/api/1/order/get"
+=> 1
+
+"/some/api/v2/order/get"
+=> 2
+
+"/api/V3/order/get"
+=> 3
+```
+
+Kibo works for any request path, but will return a version of `0` if it
+does not find version information from the request path
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## TODO
+
+- [ ] Optionally allow servers response code to be returned by Kibo
+instead of returning 200 for errors
+- [ ] Optionally allow additional `Content-Type`'s to trigger Kibo
+response wrapping (ex: `application/vnd+customJSON`)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/marshallmick007/rack-kibo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/kibo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack/kibo.rb

@@ -0,0 +1,2 @@
+require "rack/kibo/version"
+require "rack/kibo/kibo"

data/lib/rack/kibo/kibo.rb

@@ -0,0 +1,163 @@
+require 'rack'
+require 'json'
+
+class SomethingTest
+
+end
+
+module Rack
+  ##
+  # Rack Middleware which presents a clean API to JSON responses
+  class Kibo
+    ##
+    # Regex to locate an API version in the path. Able to find the following
+    # - /path/api/1/something => 1
+    # - /path/api/V2/something => 2
+    # - /api/v13/omething => 13
+    # - /something/else/134/ => 0
+    API_PARSE_REGEX = /.*\/api\/[vV]?(\d*)\/?/
+    ##
+    # Standard JSON content-type
+    JSON_CONTENT_TYPE = "application/json"
+
+    ##
+    # Creates a new instance of the CleanApi middleware
+    # +app+: The rack app
+    # +options+: Hash of options to pass to the middleware
+    def initialize(app, options={})
+      @app = app
+      @options = options
+    end
+
+    ##
+    # Rack Middleware entry-point
+    def call(env)
+      result = @app.call(env)
+      wrap_response env, result
+    rescue StandardError => e
+      wrap_response env, create_error_response(e, env, result)
+    end
+
+    private
+
+    ##
+    # Fetches the 'HTTP_ACCEPT' option from +env+
+    def request_accept(env)
+      env["HTTP_ACCEPT"]
+    end
+
+    ##
+    # Fetches the 'PATH_INFO' rack variable from +env+
+    # Optionally will find and prioritize the 'REQUEST_PATH' 
+    # if available
+    def request_path(env)
+      env["REQUEST_PATH"] || env["PATH_INFO"]
+    end
+
+    ##
+    # Takes the output from the rack app and optionally
+    # wraps the +response+ with a simple JSON API structure
+    def wrap_response(env, response)
+      return response unless should_wrap_response?(env, response)
+      rs = {
+        :success => is_successful_http_status_code?(response[0]),
+        :responded_at => Time.now.utc,
+        :version => parse_api_version(env),
+        :location => request_path(env),
+        :body => create_payload(response[2])
+      }
+      response[2] = [ rs.to_json ]
+      response[1]["Content-Length"] = response[2][0].length.to_s
+
+      # TODO: support an option to allow user to emit original status codes
+      
+      response[0] = 200 unless rs[:success]
+      response
+    end
+
+    ##
+    # Convert exceptions into a proper response
+    def create_error_response(error, env, result)
+      rsp_env = {}
+      response = 'Error'
+      if should_wrap_response?(env, result)
+        server_result = nil
+        if result
+          env = result[1]
+          server_result = result[2]
+        end
+        response = create_error_json(error, server_result)
+      end
+      error_result = [500, rsp_env, [response]]
+    end
+
+    ##
+    # Generates the 'payload' element of the API response
+    def create_payload(response_data)
+      payload = []
+      response_data.each do |data|
+        payload << JSON.parse(data)
+      end
+
+      nil if payload.length == 0
+      payload if payload.length > 1
+      payload[0] if payload.length == 1
+    end
+
+    ##
+    # Parses the API version from the request path
+    def parse_api_version(env)
+      matches = API_PARSE_REGEX.match(request_path(env))
+      return 0 unless matches
+      matches.captures[0].to_i
+    end
+
+    ##
+    # Generates an error response payload
+    def create_error_json(error, data)
+      result = {
+        :error => {
+          :message => 'Error'
+        }
+      }
+      if @options[:expose_errors]
+        result[:error][:message] = error.message
+        result[:error][:data] = data
+      end
+      result.to_json
+    end
+
+    ##
+    # Determines if the HTTP Status code is considered
+    # a successful response
+    def is_successful_http_status_code?(code)
+      code < 400
+    end
+
+    ##
+    # Determines if the response should be wrapped in
+    # the CleanApi object
+    def should_wrap_response?(env, response)
+      client_request = is_supported_content_type? request_accept(env)
+      server_response = response_should_be_json? response
+      server_response || client_request
+    end
+
+    ##
+    # Determines if the response Content-Type is supposed
+    # to be wrapped in the CleanApi object
+    def response_should_be_json?(response)
+      return false unless response
+      is_supported_content_type? response[1]["Content-Type"]
+    end
+
+    ##
+    # Determines if the +content_type+ dictates that the
+    # response should be wrapped in the CleanApi
+    def is_supported_content_type?(content_type)
+      # TODO: Should we allow user-defined accept-encodings?
+      content_type == JSON_CONTENT_TYPE
+    end
+
+  end
+end

data/lib/rack/kibo/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Kibo
+    VERSION = "0.1.0"
+  end
+end

data/rack-kibo.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/kibo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-kibo"
+  spec.version       = Rack::Kibo::VERSION
+  spec.authors       = ["Marshall Mickelson"]
+  spec.email         = ["rubygems@0x07.com"]
+
+  spec.summary       = %q{A Rack Middleware to present structured JSON responses}
+  spec.homepage      = "https://github.com/marshallmick007/rack-kibo"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rack-kibo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marshall Mickelson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- rubygems@0x07.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/kibo.rb
+- lib/rack/kibo/kibo.rb
+- lib/rack/kibo/version.rb
+- rack-kibo.gemspec
+homepage: https://github.com/marshallmick007/rack-kibo
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Rack Middleware to present structured JSON responses
+test_files: []