sinatra-rest-helpers 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Cyril Rohr
+Copyright (c) 2009 INRIA Rennes - Bretagne Atlantique
+
+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.rdoc

@@ -0,0 +1,19 @@
+= sinatra-rest-helpers
+
+A set of helpers for sinatra apps that expose REST resources.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Cyril Rohr. See LICENSE for details.
+Copyright (c) 2009 INRIA Rennes - Bretagne Atlantique. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-rest-helpers"
+    gem.summary = %Q{Adds useful helpers for REST applications developed with Sinatra.}
+    gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "cyril.rohr@gmail.com"
+    gem.homepage = "http://github.com/cryx/sinatra-rest-helpers"
+    gem.authors = ["Cyril Rohr"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sinatra/rest_helpers.rb

@@ -0,0 +1,41 @@
+require 'rack'
+
+module Sinatra
+  module RestHelpers
+    INFINITY = 1/0.0
+    # e.g.:
+    #   get '/x/y/z' do
+    #     provides "application/json", :xml, :zip, "text/html;level=5"
+    #   end
+    def provides *formats
+      generate_type_hash = Proc.new{ |header| 
+        type, *params = header.split(/;\s*/)
+        Hash[*params.map{|p| p.split(/\s*=\s*/)}.flatten].merge("type" => type)
+      }
+      supported_formats = formats.map do |f| 
+        # selects the correct mime type if a symbol is given
+        f.is_a?(Symbol) ? ::Rack::Mime::MIME_TYPES[".#{f.to_s}"] : f
+      end.compact.map do |f|
+        generate_type_hash.call(f)
+      end
+      accepted_formats = request.accept.split(/,\s*/).map do |f| 
+        generate_type_hash.call(f)
+      end
+      selected_format = supported_formats.detect{ |supported_format| 
+        !accepted_formats.detect{ |accepted_format| 
+          accepted_format["type"] == supported_format["type"] && 
+          (accepted_format["level"] || INFINITY).to_f >= (supported_format["level"] || 0).to_f
+        }.nil?
+      }      
+      if selected_format.nil?
+        halt 406, supported_formats.map{|f| 
+          output = f["type"]
+          output += ";level=#{f["level"]}" if f.has_key?("level")
+        }.join(", ")
+      else
+        response.headers['Content-Type'] = "#{selected_format["type"]}#{selected_format["level"].nil? ? "" : ";level=#{selected_format["level"]}"}"
+      end
+    end
+  end
+
+end

data/spec/sinatra-rest-helpers_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+class App
+  include Sinatra::RestHelpers
+  
+  attr_accessor :request, :response
+  def initialize(request)
+    @request = request
+    @response = OpenStruct.new(:headers => {})
+  end
+  
+  def test_provides!(*params)
+    provides *params
+  end
+end
+
+def mime(ext, type)
+  ext = ".#{ext}" unless ext.to_s[0] == ?.
+  Rack::Mime::MIME_TYPES[ext.to_s] = type
+end
+
+describe "SinatraRestHelpers" do
+  before(:each) do
+    Rack::Mime::MIME_TYPES.clear
+  end
+  it "should throw a 406 if the client requested only unsupported formats" do
+    request = mock("request", :accept => "application/json")
+    app = App.new(request)
+    app.should_receive(:halt).with(406, "")
+    app.test_provides!(:json)
+  end
+  it "should not throw a 406 if the client requested a supported format" do
+    request = mock("request", :accept => "application/json")
+    mime :json, "application/json"
+    app = App.new(request)
+    app.should_not_receive(:halt)
+    app.test_provides!(:json)
+    app.response.headers['Content-Type'].should == "application/json"
+  end
+  it "should not accept a request with a type level lower than what is supported" do
+    request = mock("request", :accept => "application/json;level=1")
+    app = App.new(request)
+    app.should_receive(:halt).with(406, "application/json;level=3, application/json;level=2")
+    app.test_provides!("application/json;level=3", "application/json;level=2")
+  end
+  it "should accept a request having a supported mime type, but with no level" do
+    request = mock("request", :accept => "application/json")
+    app = App.new(request)
+    app.should_not_receive(:halt)
+    app.test_provides!("application/json;level=2")
+    app.response.headers['Content-Type'].should == "application/json;level=2"
+  end
+  it "should select the first type matching the criteria" do
+    request = mock("request", :accept => "application/json;level=2, application/xml, application/vnd.fr.grid5000.api.Cluster+json;level=2")
+    app = App.new(request)
+    app.should_not_receive(:halt)
+    app.test_provides!("application/json;level=3", "application/vnd.fr.grid5000.api.Cluster+json;level=2")
+    app.response.headers['Content-Type'].should == "application/vnd.fr.grid5000.api.Cluster+json;level=2"
+  end
+  it "should accept requests with a level, even if the developer didn't explicitely defined one" do
+    request = mock("request", :accept => "application/json;level=1")
+    app = App.new(request)
+    app.should_not_receive(:halt)
+    app.test_provides!("application/json")
+    app.response.headers['Content-Type'].should == "application/json"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'sinatra/rest_helpers'
+require 'spec'
+require 'spec/autorun'
+
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-rest-helpers
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cyril Rohr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: A set of helpers for sinatra apps that expose REST resources.
+email: cyril.rohr@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sinatra/rest_helpers.rb
+- spec/sinatra-rest-helpers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/crohr/sinatra-rest-helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Adds useful helpers for REST applications developed with Sinatra.
+test_files: 
+- spec/sinatra-rest-helpers_spec.rb
+- spec/spec_helper.rb