roy 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in roy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    roy (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (2.6.1)
+    rack (1.3.4)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rack-test
+  roy!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009-2011 François "madx" Vaux <madx@yapok.org>
+
+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,83 @@
+Roy
+===
+
+Roy is a tiny module that aims to make any Ruby object Rack-friendly and provite
+it with a REST-like interface.
+
+Roy tries to be as less invasive as possible. In provides your objects with a
+`#call` method that takes a Rack environment and dispatchs to a regular method
+named after the HTTP method you want to catch.
+
+## Tests
+
+You can run the tests by running `rake test`. They are written with Minitest.
+
+## Example
+
+``` ruby
+class MessageQueue
+  include Roy
+
+  roy allow: [:get, :post, :delete]
+
+  def initialize
+    @stack = []
+  end
+
+  def get
+    @stack.inspect
+  end
+
+  def post
+    halt 403 unless roy.params[:item]
+    @stack << roy.params[:item].strip
+    get
+  end
+
+  def delete
+    @stack.shift.inspect
+  end
+end
+```
+
+## Docs
+
+### Configuration
+
+The `roy` class method is used to define access control and method prefix. The
+following example should be self-explanatory enough:
+
+``` ruby
+class Example
+  include Roy
+  roy allow: [:get], prefix: :http_
+
+  def http_get(*args)
+    "get"
+  end
+end
+```
+
+### Environement
+
+Inside your handler methods, you have access to a `roy` readable attribute which
+is a struct containing the following fields:
+
+* `env`: the Rack environment
+* `response`: a `Rack::Response` object that will be returned by `call`
+* `request`: a `Rack::Request` build from the environment
+* `header`: a hash of headers that is part of `response`
+* `params`: parameters extracted from the query string and the request body
+* `conf`: the configuration set via `::roy`
+
+The keys for `params` can be accessed either via a `String` or a `Symbol`
+
+### Control flow
+
+Your handler methods are run inside a `catch` block which will catch the `:halt`
+symbol. You can then use `throw` to abort a method but you must return an array
+composed of a status code and a message.
+
+Roy provides a `halt` method that takes a status code and an optional message.
+If there is no message it uses the default message from
+`Rack::Utils::HTTP_STATUS_CODES`

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+end

data/lib/roy.rb

@@ -0,0 +1,67 @@
+require 'set'
+require 'rack'
+require 'roy/version'
+
+module Roy
+  Env = Struct.new(:env, :request, :response, :headers, :params, :conf)
+
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  attr_reader :roy
+
+  def call(env)
+    @roy = Env.new.tap { |e|
+      e.env      = env
+      e.request  = Rack::Request.new(env)
+      e.response = Rack::Response.new
+      e.headers  = e.response.header
+      e.params   = e.request.GET.merge(e.request.POST)
+      e.params.default_proc = proc do |hash, key|
+        hash[key.to_s] if Symbol === key
+      end
+      e.conf = self.class.conf
+    }
+
+    method = roy.env['REQUEST_METHOD'].downcase.to_sym
+    args = roy.env['PATH_INFO'].sub(/^\/+/, '').split(/\/+/).map { |arg|
+      Rack::Utils.unescape(arg)
+    }
+
+    method, was_head = :get, true if method == :head
+
+    roy.response.status, body = catch(:halt) do
+      halt(405) unless roy.conf.allow.include?(method)
+      prefixed_method = :"#{roy.conf.prefix}#{method}"
+      [roy.response.status, send(prefixed_method, *args)]
+    end
+
+    roy.response.write(body) unless was_head
+    roy.response.finish
+  end
+
+  def halt(code, message=nil)
+    throw :halt, [code, message || Rack::Utils::HTTP_STATUS_CODES[code]]
+  end
+
+  module ClassMethods
+    attr_reader :conf
+
+    def roy(options={})
+      @conf       ||= Struct.new(:allow, :prefix).new
+      conf.allow  ||= Set.new
+      conf.prefix ||= :''
+
+      options.each do |k,v|
+        case k
+        when :allow
+          conf.allow.merge(v)
+          conf.allow.add(:head) if v.member?(:get)
+        when :prefix
+          conf.prefix = v
+        end
+      end
+    end
+  end
+end

data/lib/roy/version.rb

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

data/roy.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "roy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "roy"
+  s.version     = Roy::VERSION
+  s.authors     = ["madx"]
+  s.email       = ["madx@yapok.org"]
+  s.homepage    = "https://github.com/madx/roy"
+  s.summary     = 'make your objects REST-friendly'
+  s.description =
+    "roy is a small library which allows every Ruby object to be used\n" <<
+    "as a Rack application."
+
+  s.rubyforge_project = "roy"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "rack-test"
+  # s.add_runtime_dependency "rest-client"
+end

data/test/base_test.rb

@@ -0,0 +1,91 @@
+require_relative 'helper'
+
+class RemoteLog
+  include Roy
+
+  attr_reader :history
+
+  def initialize
+    @history = []
+  end
+
+  roy allow: [:get, :put, :custom]
+
+  def get(*args)
+    history.inspect
+  end
+
+  def put(*args)
+    Roy.halt 400 unless roy.params[:body]
+    history << roy.params[:body]
+    history << roy.params[:foo] if roy.params[:foo]
+    get
+  end
+
+  def custom(*args)
+    args.join('+')
+  end
+end
+
+class RoyTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    RemoteLog.new
+  end
+
+  def test_provide_call
+    assert_respond_to app, :call
+  end
+
+  def test_provide_roy
+    assert_respond_to app.class, :roy
+  end
+
+  def test_forward_allowed_methods
+    get '/'
+    ok!
+    assert_equal app.get, last_response.body
+  end
+
+  def test_block_forbidden_methods
+    post '/'
+    fail!
+    assert_equal 405, last_response.status
+  end
+
+
+  def test_set_allowed_methods
+    assert_includes app.class.conf.allow, :get
+    assert_includes app.class.conf.allow, :put
+    refute_includes app.class.conf.allow, :post
+  end
+
+  def test_allowing_get_allows_head
+    assert_includes app.class.conf.allow, :head
+  end
+
+  def test_roy_halt
+    assert_throws :halt do
+      app.halt 200
+    end
+  end
+
+  def test_head_does_not_have_contents
+    head '/'
+    ok!
+    assert_equal '', last_response.body
+  end
+
+  def test_params
+    put '/?foo=bar', :body => 'hello'
+    ok!
+    assert_equal %w(hello bar).inspect, last_response.body
+  end
+
+  def test_path_components_as_method_arguments
+    request '/a/b/c', :method => 'CUSTOM'
+    ok!
+    assert_equal 'a+b+c', last_response.body
+  end
+end

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'bundler'
+Bundler.require(:default, :development)
+
+require 'minitest/autorun'
+require 'rack/test'
+require 'roy'
+
+module CustomTestMethods
+  private
+
+  def ok!
+    assert_predicate last_response, :ok?
+  end
+
+  def fail!
+    refute_predicate last_response, :ok?
+  end
+end
+
+Rack::Test::Methods.send(:include, CustomTestMethods)

data/test/prefix_test.rb

@@ -0,0 +1,24 @@
+require_relative 'helper'
+
+class TestObject
+  include Roy
+
+  roy allow: [:get], prefix: :http_
+
+  def http_get(*args)
+    'success'
+  end
+end
+
+class PrefixTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    TestObject.new
+  end
+
+  def test_prefixing
+    get '/'
+    assert_equal 'success', last_response.body
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: roy
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- madx
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: |-
+  roy is a small library which allows every Ruby object to be used
+  as a Rack application.
+email: 
+- madx@yapok.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/roy.rb
+- lib/roy/version.rb
+- roy.gemspec
+- test/base_test.rb
+- test/helper.rb
+- test/prefix_test.rb
+homepage: https://github.com/madx/roy
+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: roy
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: make your objects REST-friendly
+test_files: 
+- test/base_test.rb
+- test/helper.rb
+- test/prefix_test.rb