respond_with 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+.rvmrc
+.rbenv-version
+*.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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  #- jruby-19mode
+  - rbx-19mode
+  - ruby-head
+script: "ruby -Itest:lib test/all.rb"

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in respond_with.gemspec
+gemspec
+
+group :test do
+  gem "rack-test"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dane Harrigan
+
+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,42 @@
+# RespondWith [![Test Status](https://secure.travis-ci.org/daneharrigan/respond_with.png)][2]
+
+The `respond_with` gem is an extension of Sinatra. It is intended to
+make API responses dead simple.
+
+## Installation
+
+`respond_with` relies on the serialize gem which is still in development
+so you'll need to install that from git.
+
+Add these lines to your application's Gemfile:
+
+    gem 'respond_with', :git => 'git://github.com/daneharrigan/respond_with.git'
+    gem 'serialize',    :git => 'git://github.com/daneharrigan/serialize.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+    require "sinatra"
+    require "respond_with"
+
+    # in a sinatra app
+    get "/resources/:id.?:format?" do
+      @resource = Resource.find(params[:id])
+      respond_with ResourceSerializer.new(@resource)
+    end
+
+Notice we're using a `ResourceSerializer`. This is built with the
+[serialize][1] gem.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]: https://github.com/heroku/serialize
+[2]: https://secure.travis-ci.org/daneharrigan/respond_with

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default do
+  exec "ruby -Itest:lib test/all.rb"
+end

data/lib/respond_with/helpers.rb

@@ -0,0 +1,12 @@
+module RespondWith
+  module Helpers
+    def respond_with(obj)
+      RespondWith::Response.new({
+        :object  => obj,
+        :params  => params,
+        :request => request,
+        :app     => self
+      }).render
+    end
+  end
+end

data/lib/respond_with/response.rb

@@ -0,0 +1,59 @@
+module RespondWith
+  class Response
+    attr :app
+    attr :params
+    attr :object
+    attr :request
+
+    def initialize(options={})
+      @app     = options[:app]
+      @params  = options[:params]
+      @object  = options[:object]
+      @request = options[:request]
+    end
+
+    def render
+      response_type = Negotiator.pick(request_types.join(", "), available_responses)
+
+      if response_type.nil?
+        @app.halt 406
+      else
+        @app.content_type(response_type)
+        @object.to(response_type)
+      end
+    end
+
+    def request_types
+      format = params.delete "format"
+      content_type = MIME::Types.type_for(format).first.to_s if format
+
+      if content_type && request.accept.first != content_type
+        request.accept.delete content_type
+        request.accept.unshift content_type
+      end
+
+      return request.accept
+    end
+
+    private :request_types
+
+    def available_responses
+      responses = request_types.map do |request_type|
+        if @object.responses.include?(request_type)
+          [request_type, 1.0]
+        end
+      end.compact
+
+      if request_types.include? "*/*"
+        @object.responses.each do |response_type|
+          response_rating = [response_type, 1.0]
+          responses << response_rating unless responses.include? response_rating
+        end
+      end
+
+      Hash[responses]
+    end
+
+    private :available_responses
+  end
+end

data/lib/respond_with/version.rb

@@ -0,0 +1,3 @@
+module RespondWith
+  VERSION = "0.0.1"
+end

data/lib/respond_with.rb

@@ -0,0 +1,9 @@
+require "sinatra/base"
+require "negotiator"
+require "mime/types"
+require "serialize"
+require "respond_with/version"
+require "respond_with/response"
+require "respond_with/helpers"
+
+Sinatra::Base.helpers RespondWith::Helpers

data/respond_with.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/respond_with/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dane Harrigan"]
+  gem.email         = ["dane.harrigan@gmail.com"]
+  gem.description   = %q{Make API responses hella simple}
+  gem.summary       = %q{Make API responses hella simple}
+  gem.homepage      = "https://github.com/daneharrigan/respond_with"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "respond_with"
+  gem.require_paths = ["lib"]
+  gem.version       = RespondWith::VERSION
+  gem.add_runtime_dependency "sinatra"
+  gem.add_runtime_dependency "negotiator"
+  gem.add_runtime_dependency "mime-types"
+  gem.add_runtime_dependency "serialize"
+end

data/test/all.rb

@@ -0,0 +1,3 @@
+require 'test_helper'
+
+Dir["**/*_test.rb"].each { |path| require File.expand_path(path) }

data/test/respond_with_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+
+class RespondWithTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def setup
+    @item_hash = { name: "Item", type: "Sample", size: 42 }
+  end
+
+  def test_invalid_extention_renders_406
+    get "/item.invalid"
+    assert_equal 406, last_response.status
+  end
+
+  def test_invalid_accept_header_renders_406
+    header "Accept", "invalid/type"
+    get "/item"
+    assert_equal 406, last_response.status
+  end
+
+  # JSON
+  def test_request_with_json_extension
+    get "/item.json"
+    assert_equal @item_hash.to_json, last_response.body
+  end
+
+  def test_request_with_json_accept_header
+    header "Accept", "application/json"
+    get "/item"
+
+    assert_equal @item_hash.to_json, last_response.body
+  end
+
+  def test_application_json_content_type
+    get "/item.json"
+    assert_equal "application/json;charset=utf-8", last_response.content_type
+  end
+
+  # XML
+  def test_request_with_xml_and_json_accept_header
+    header "Accept", "application/xml, applicaiton/json"
+    get "/item"
+    xml = @item_hash.to_xml(root: "mock-item")
+
+    assert_equal xml, last_response.body
+  end
+
+  def test_request_with_xml_extension
+    get "/item.xml"
+    xml = @item_hash.to_xml(root: "mock-item")
+
+    assert_equal xml, last_response.body
+  end
+
+  def test_request_with_xml_accept_header
+    header "Accept", "application/xml"
+    get "/item"
+    xml = @item_hash.to_xml(root: "mock-item")
+
+    assert_equal xml, last_response.body
+  end
+
+  def test_application_xml_content_type
+    get "/item.xml"
+    assert_equal "application/xml;charset=utf-8", last_response.content_type
+  end
+
+  def app
+    MyApp
+  end
+end
+
+class MyApp < Sinatra::Base
+  get "/item" do
+    respond_with ItemSerializer.new(MockItem.new)
+  end
+
+  get "/item.:format" do
+    respond_with ItemSerializer.new(MockItem.new)
+  end
+end

data/test/support/item_serializer.rb

@@ -0,0 +1,9 @@
+class ItemSerializer < Serialize
+  structure do
+    {
+      name: name,
+      type: type,
+      size: size
+    }
+  end
+end

data/test/support/mock_item.rb

@@ -0,0 +1,11 @@
+class MockItem
+  attr :name
+  attr :type
+  attr :size
+
+  def initialize
+    @name = "Item"
+    @type = "Sample"
+    @size = 42
+  end
+end

data/test/support/sample_application.rb

@@ -0,0 +1,9 @@
+require "sinatra/base"
+require "respond_with"
+
+class SampleApplication < Sinatra::Base
+  get "/item.json" do
+    @item = MockItem.new
+    respond_with(ItemSerializer.new(@item))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "rack/test"
+
+require "respond_with"
+require "serialize"
+
+require "support/mock_item"
+require "support/item_serializer"
+require "support/sample_application"
+
+ENV["RACK_ENV"] = "test"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: respond_with
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dane Harrigan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70118407496880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118407496880
+- !ruby/object:Gem::Dependency
+  name: negotiator
+  requirement: &70118407496380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118407496380
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &70118407495840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118407495840
+- !ruby/object:Gem::Dependency
+  name: serialize
+  requirement: &70118407495200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70118407495200
+description: Make API responses hella simple
+email:
+- dane.harrigan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/respond_with.rb
+- lib/respond_with/helpers.rb
+- lib/respond_with/response.rb
+- lib/respond_with/version.rb
+- respond_with.gemspec
+- test/all.rb
+- test/respond_with_test.rb
+- test/support/item_serializer.rb
+- test/support/mock_item.rb
+- test/support/sample_application.rb
+- test/test_helper.rb
+homepage: https://github.com/daneharrigan/respond_with
+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.11
+signing_key: 
+specification_version: 3
+summary: Make API responses hella simple
+test_files:
+- test/all.rb
+- test/respond_with_test.rb
+- test/support/item_serializer.rb
+- test/support/mock_item.rb
+- test/support/sample_application.rb
+- test/test_helper.rb