sinatra-jsonapi 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kyle Drake
+
+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,67 @@
+# Sinatra::JSONAPI
+
+This is an extension for Sinatra that makes the Base class return JSON for 404 and 500 errors, and gives you api\_response and api\_error for quick JSON responses.
+
+## Caveats
+
+Does not automatically try to convert response. You need to use api\_response or api\_error, or halt with proper JSON like such:
+
+    get '/ping' do
+      halt {response: 'pong'}.to_json
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-jsonapi', require: 'sinatra/jsonapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-jsonapi
+
+## Usage
+
+For classy apps:
+
+    require 'sinatra'
+    require 'sinatra/jsonapi'
+
+    class MyCoolAPI < Sinatra::Base
+      register Sinatra::JSONAPI
+
+      get '/hello' do
+        api_response response: 'world!'
+      end
+      
+      # Returns:
+      # {"response":"world!"}
+      
+      get '/break' do
+        api_error :your_error_type, 'human readable version of error message'
+      end
+      
+      # Returns:
+      # {"error":{"error_type":"your_error_type", "message":"human readable version of your error message"}}
+    end
+
+For classic style apps (no class), registration of the extension happens automatically:
+
+    require 'sinatra'
+    require 'sinatra/jsonapi'
+
+    get '/hello' do
+      api_response response: 'world!'
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+# To run tests in the order of a seed: bundle exec rake test TESTOPTS="--seed=987"
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_spec.rb'
+end
+
+task :default => :test

data/lib/sinatra/jsonapi.rb

@@ -0,0 +1,61 @@
+require 'sinatra'
+require 'json'
+require './lib/sinatra/jsonapi/version.rb'
+
+module Sinatra
+  module JSONAPI
+    def self.registered(app)
+      app.disable :show_exceptions
+      app.disable :raise_errors
+      app.disable :protection
+      app.enable :raise_errors if test?
+
+      app.before do
+        content_type :json
+      end
+
+      app.error do
+        api_error 'unexpected_error', 'An unexpected error has occured, please try your request again later'
+      end
+
+      # Disables Sinatra's internal HTML error message for development mode.
+      app.error Sinatra::NotFound do
+        not_found
+      end
+
+      app.not_found do
+        # If 404 body is not the default "Not Found" message, we can return it without processing.
+        return response if response.body.first != "<h1>Not Found</h1>"
+
+        api_error 'not_found', "The requested method was not found: #{request.path}"
+      end
+      
+      app.helpers do
+        def api_error(type, message)
+          payload = {error: {type: type, message: message}}
+          halt process_payload(payload)
+        end
+
+        def api_response(payload)
+          halt process_payload(payload)
+        end
+
+        def _jsonapi_to_json(input)
+          JSON.unparse input
+        end
+
+        def process_payload(payload)
+          if params[:callback]
+            response_body = "#{params[:callback]}({\n"+
+                            "  #{_jsonapi_to_json payload}\n"+
+                            "})"
+          else
+            response_body = _jsonapi_to_json payload
+          end
+        end
+      end
+    end
+  end
+
+  register JSONAPI
+end

data/lib/sinatra/jsonapi/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module JSONAPI
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-jsonapi.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/jsonapi/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-jsonapi"
+  gem.version       = Sinatra::JSONAPI::VERSION
+  gem.authors       = ["Kyle Drake"]
+  gem.email         = ["kyledrake@gmail.com"]
+  gem.description   = %q{Turns a Sinatra Base class into a JSON api}
+  gem.summary       = %q{This gem makes it easy to make a JSON api by converting some HTML-esque things in Sinatra into JSON}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'json'
+  gem.add_dependency 'sinatra'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'pry'
+end

data/test/jsonapi_spec.rb

@@ -0,0 +1,95 @@
+require 'bundler/setup'
+ENV['RACK_ENV'] = 'test'
+require 'minitest/autorun'
+require 'rack/test'
+require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'sinatra', 'jsonapi.rb')
+
+include Rack::Test::Methods
+
+class TestApp < Sinatra::Base
+  register Sinatra::JSONAPI
+end
+
+def mock_app(&block)
+  @app = Sinatra.new TestApp, &block
+end
+
+def app
+  @app
+end
+
+def as_json(hash)
+  hash.to_json
+end
+
+describe Sinatra::JSONAPI do
+  it 'should return 404 JSON on unknown request' do
+    mock_app {
+      register Sinatra::JSONAPI
+    }
+    get '/notfound'
+    last_response.body.wont_equal '<h1>Not Found</h1>'
+    last_response.body.must_equal(as_json(error: {type: 'not_found', message: 'The requested method was not found: /notfound'}))
+  end
+  
+  it 'should return generic 500 JSON on uncaught exception' do
+    mock_app {
+      disable :raise_errors
+      get '/error' do
+        raise 'Hell!'
+      end
+    }
+
+    get '/error'
+
+    error_msg = {error: {type: 'unexpected_error', message: 'An unexpected error has occured, please try your request again later'}}
+
+    last_response.body.must_equal error_msg.to_json
+  end
+  
+  it 'should return custom 500 JSON error' do
+    mock_app {
+      get '/custom' do
+        api_error 'wrong_argument', 'no arguments'
+      end
+    }
+
+    get '/custom'
+    last_response.body.must_equal(as_json(error: {type: 'wrong_argument', message: 'no arguments'}))
+  end
+
+  it 'should return hello world json' do
+
+    mock_app {
+      get '/hello' do
+        api_response response: 'hello'
+      end
+    }
+
+    get '/hello'
+    last_response.body.must_equal(as_json(response: 'hello'))
+  end
+
+  it 'should return jsonp when requested' do
+    mock_app {
+      get '/' do
+        api_response response: 'hello'
+      end
+    }
+
+    get '/?callback=abc123'
+
+    expected = "abc123({\n"+
+               "  #{as_json(response: 'hello')}\n"+
+               "})"
+
+    last_response.body.must_equal expected
+  end
+  
+  it 'should return error with jsonp' do
+    mock_app
+    get '/sdfsdfsd?callback=abcd123'
+    last_response.body.must_match /abcd123\(\{/
+    last_response.body.must_match /not found/
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Turns a Sinatra Base class into a JSON api
+email:
+- kyledrake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra/jsonapi.rb
+- lib/sinatra/jsonapi/version.rb
+- sinatra-jsonapi.gemspec
+- test/jsonapi_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem makes it easy to make a JSON api by converting some HTML-esque things
+  in Sinatra into JSON
+test_files:
+- test/jsonapi_spec.rb
+has_rdoc: