sinatra-jsend 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Alex Beregszaszi
+
+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,65 @@
+Sinatra::JSend
+==============
+
+JSend output helper for [Sinatra](http://sinatrarb.com). Extends Sinatra to support the [JSend proprosal](http://labs.omniti.com/labs/jsend).
+
+Depends on the Sinatra::JSON helper from Sinatra-Contrib.
+
+
+Installation
+------------
+
+System install
+
+```bash
+gem install sinatra-jsend
+```
+
+Gemfile
+
+```ruby
+gem 'sinatra-jsend', :require => 'sinatra/jsend'
+```
+
+Usage
+-----
+
+Classic:
+
+```ruby
+require "sinatra"
+require "sinatra/jsend"
+
+get '/' do
+  jsend_fail({ :title => "A title is required" }) if params[:title] == nil
+  jsend_success({ :post => { :id => 1, :title => "First entry" } })
+end
+```
+
+Modular:
+
+```ruby
+require "sinatra/base"
+require "sinatra/jsend"
+
+class MyApp < Sinatra::Base
+  helpers Sinatra::JSend
+
+  get '/' do
+    jsend_fail({ :title => "A title is required" }) if params[:title] == nil
+    jsend_success({ :post => { :id => 1, :title => "First entry" } })
+  end
+end
+```
+
+Links
+-----
+
+* [Sinatra](http://www.sinatrarb.com)
+* [Sinatra-Contrib](http://github.com/sinatra/sinatra-contrib)
+* [JSend](http://labs.omniti.com/labs/jsend)
+
+License
+-------
+
+See LICENSE for details.

data/Rakefile

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

data/lib/sinatra/jsend.rb

@@ -0,0 +1,31 @@
+require 'sinatra/base'
+require 'sinatra/json'
+
+module Sinatra
+  module JSend
+    include Sinatra::JSON
+
+    def jsend_success(data)
+      json ({ :status => "success", :data => data })
+    end
+    alias jsend_ok jsend_success
+
+    def jsend_fail(data)
+      jsend_stop(json ({ :status => "fail", :data => data }))
+    end
+
+    def jsend_error(message, code = nil, data = nil)
+      jsend_stop(json({ :status => "error", :message => message, :code => code, :data => data }.keep_if{|_,v| v != nil }))
+    end
+
+    private
+
+    # XXX: probably there is a better way in Sinatra?
+    def jsend_stop(ret)
+      response.body = ret
+      halt 200 # as far as HTTP is concerned we are successful
+    end
+  end
+
+  helpers JSend
+end

data/spec/jsend_spec.rb

@@ -0,0 +1,57 @@
+require 'backports'
+require_relative 'spec_helper'
+require 'json'
+
+describe Sinatra::JSend do
+  before do
+    mock_app do
+      helpers Sinatra::JSend
+      set :json_encoder, JSON
+
+      get '/success' do
+        jsend_success({ :post => { :id => 1 } })
+      end
+      get '/fail' do
+        jsend_fail({ :title => "A title is required" })
+      end
+      get '/error' do
+        jsend_error("We have to fail")
+      end
+      get '/combined' do
+        jsend_fail({ :title => "A title is required" }) if params[:title] == nil
+        jsend_error("We have to fail") if params[:title] != "correct"
+        jsend_success({ :post => { :id => 1 } })
+      end
+    end
+  end
+
+  it "should return success" do
+    get '/success'
+    body.should == '{"status":"success","data":{"post":{"id":1}}}'
+  end
+
+  it "should return failure" do
+    get '/fail'
+    body.should == '{"status":"fail","data":{"title":"A title is required"}}'
+  end
+
+  it "should return error" do
+    get '/error'
+    body.should == '{"status":"error","message":"We have to fail"}'
+  end
+
+  it "should return failure if title is not supplied" do
+    get '/combined'
+    body.should == '{"status":"fail","data":{"title":"A title is required"}}'
+  end
+
+  it "should return error if title is not supported" do
+    get '/combined?title=invalid'
+    body.should == '{"status":"error","message":"We have to fail"}'
+  end
+
+  it "should return success if title is supported" do
+    get '/combined?title=correct'
+    body.should == '{"status":"success","data":{"post":{"id":1}}}'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'sinatra/contrib'
+require 'sinatra/jsend'
+
+RSpec.configure do |config|
+  config.expect_with :rspec, :stdlib
+  config.include Sinatra::TestHelpers
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-jsend
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alex Beregszaszi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra-contrib
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: JSend helper for Sinatra
+email: alex@rtfs.hu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sinatra/jsend.rb
+- spec/jsend_spec.rb
+- spec/spec_helper.rb
+- README.md
+- Rakefile
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/axic/sinatra-jsend
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: JSend helper for Sinatra
+test_files: []
+