roy 0.3.4 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roy (0.3.4)
+    roy (0.4.0)
       rack
 
 GEM

data/README.md

@@ -30,7 +30,7 @@ class MessageQueue
   end
 
   def post(_)
-    halt 403 unless roy.params[:item]
+    roy.halt 403 unless roy.params[:item]
     @stack << roy.params[:item].strip
     get
   end
@@ -62,12 +62,12 @@ end
 ### Environment
 
 Inside your handler methods, you have access to a `roy` readable attribute which
-is a Struct containing the following fields:
+is an OpenStruct containing at least 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`
+* `headers`: 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`
 
@@ -79,7 +79,7 @@ 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.
+Roy provides a `roy.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/lib/roy.rb

@@ -1,71 +1 @@
-require 'set'
-require 'rack'
-require 'ostruct'
-require 'roy/version'
-require 'roy/plugins'
-
-module Roy
-  Env = Struct.new(:env, :request, :response, :headers, :params, :conf)
-  Defaults = OpenStruct.new(allow: Set.new, prefix: :'')
-
-  def self.included(base)
-    base.send(:extend, ClassMethods)
-  end
-
-  def roy
-    @roy ||= Env.new.tap {|e|
-      e.conf = self.class.conf
-    }
-  end
-
-  def call(env)
-    roy.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
-    }
-
-    method = roy.env['REQUEST_METHOD'].downcase.to_sym
-    roy.env['PATH_INFO'].sub!(/^([^\/])/, '/\1')
-
-    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, roy.env['PATH_INFO'])]
-    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 self.extended(base)
-      base.instance_eval { @conf ||= Defaults.dup }
-    end
-
-    def roy(options={})
-      options.each do |k,v|
-        case k
-        when :allow
-          conf.allow.merge(v)
-          conf.allow.add(:head) if v.member?(:get)
-        else
-          conf.send(:"#{k}=", v)
-        end
-      end
-    end
-  end
-end
+require 'roy/base'

data/lib/roy/after.rb

@@ -0,0 +1,10 @@
+module Roy
+  module After
+    def call(env)
+      status, header, body = super
+      resp = Rack::Response.new(body, status, header)
+      (roy.conf.after || lambda {|x| x }).(resp)
+      resp.finish
+    end
+  end
+end

data/lib/roy/base.rb

@@ -0,0 +1,84 @@
+# external dependencies
+require 'rack'
+
+# stdlib dependencies
+require 'set'
+require 'ostruct'
+
+# local dependencies
+require 'roy/version'
+
+module Roy
+  Defaults = OpenStruct.new(allow: Set.new, prefix: :'')
+
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  def roy
+    @roy ||= OpenStruct.new.tap {|r|
+      r.app  = self
+      r.conf = self.class.conf
+
+      def r.halt(code, message=nil)
+        throw :halt, [code, message || Rack::Utils::HTTP_STATUS_CODES[code]]
+      end
+    }
+  end
+
+  def call(env)
+    roy.tap { |r|
+      r.env      = env
+      r.request  = Rack::Request.new(env)
+      r.response = Rack::Response.new
+      r.headers  = r.response.header
+      r.params   = r.request.GET.merge(r.request.POST)
+      r.params.default_proc = proc do |hash, key|
+        hash[key.to_s] if Symbol === key
+      end
+    }
+
+    method = roy.env['REQUEST_METHOD'].downcase.to_sym
+    roy.env['PATH_INFO'].sub!(/^([^\/])/, '/\1')
+
+    method, was_head = :get, true if method == :head
+
+    roy.response.status, body = catch(:halt) do
+      roy.halt(405) unless roy.conf.allow.include?(method)
+      prefixed_method = :"#{roy.conf.prefix}#{method}"
+      [roy.response.status, send(prefixed_method, roy.env['PATH_INFO'])]
+    end
+
+    roy.response.write(body) unless was_head
+    roy.response.finish
+  end
+
+  module ClassMethods
+    attr_reader :conf
+
+    def self.extended(base)
+      base.instance_eval { @conf ||= Defaults.dup }
+    end
+
+    def roy(options={})
+      options.each do |key,value|
+        case key
+        when :allow
+          conf.allow.merge(value)
+          conf.allow.add(:head) if value.member?(:get)
+        when :use
+          value.each do |name|
+            if name.is_a?(Symbol)
+              require "roy/#{name}"
+              const = "#{name}".capitalize.gsub(/_(\w)/) {|m| m[1].upcase }.to_sym
+              name = Roy.const_get(const)
+            end
+            include name
+          end
+        else
+          conf.send(:"#{key}=", value)
+        end
+      end
+    end
+  end
+end

data/lib/roy/basic_auth.rb

@@ -0,0 +1,20 @@
+module Roy
+  module BasicAuth
+    def protected!(data=nil)
+      unless authorized?(data)
+        realm = roy.conf.auth && roy.conf.auth[:realm] || 'Realm'
+        roy.response['WWW-Authenticate'] = %(Basic realm="#{realm}")
+        roy.halt 401
+      end
+    end
+
+    def authorized?(data=nil)
+      auth = Rack::Auth::Basic::Request.new(roy.request.env)
+
+      auth.provided? && auth.basic? && auth.credentials &&
+        (roy.conf.auth[:logic] || ->(data, u, p) {
+          %w(admin password) == [u, p]
+         }).(data, *auth.credentials)
+    end
+  end
+end

data/lib/roy/before.rb

@@ -0,0 +1,8 @@
+module Roy
+  module Before
+    def call(env)
+      (roy.conf.before || lambda {|x| x }).(env)
+      super
+    end
+  end
+end

data/lib/roy/render.rb

@@ -0,0 +1,25 @@
+require 'tilt'
+
+module Roy
+  module Render
+
+    def initialize
+      super
+      class << roy
+        def render(engine, view_or_string, params={}, &block)
+          options = conf.render || {}
+          template = case view_or_string
+            when Symbol
+              file = [view_or_string.to_s, engine].map(&:to_s).join('.')
+              dir = conf.views || 'views'
+              Tilt.new(File.join(dir, file), nil, options)
+            else
+              Tilt[engine].new(nil, nil, options) { view_or_string.to_s }
+            end
+
+          template.render(app, params, &block)
+        end
+      end
+    end
+  end
+end

data/lib/roy/version.rb

@@ -1,3 +1,3 @@
 module Roy
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 end

data/test/base_test.rb

@@ -16,7 +16,7 @@ class BaseTestObject
   end
 
   def put(path)
-    Roy.halt 400 unless roy.params[:body]
+    roy.halt 400 unless roy.params[:body]
     history << roy.params[:body]
     history << roy.params[:foo] if roy.params[:foo]
     get(path)
@@ -74,7 +74,7 @@ class BaseTest < MiniTest::Unit::TestCase
 
   def test_roy_halt
     assert_throws :halt do
-      app.halt 200
+      app.roy.halt 200
     end
   end
 

data/test/custom_options_test.rb

@@ -1,4 +1,3 @@
-
 require_relative 'helper'
 
 class CustomOptionsTestObject

data/test/plugins/after_test.rb

@@ -1,11 +1,9 @@
 require_relative '../helper'
-require 'roy/plugin/after'
 
 class AfterTestObject
   include Roy
-  include Roy::Plugin::After
 
-  roy allow: [:get],
+  roy use: [:after], allow: [:get],
       after: lambda { |response|
         response.header['Content-Type'] = 'text/plain'
       }

data/test/plugins/basic_auth_test.rb

@@ -1,11 +1,9 @@
 require_relative '../helper'
-require 'roy/plugin/basic_auth'
 
 class BasicAuthTestObject
   include Roy
-  include Roy::Plugin::BasicAuth
 
-  roy allow: [:get],
+  roy use: [:basic_auth], allow: [:get],
       auth: {
         realm: "Custom",
         logic: ->(_, u, p) { %w(user password) == [u, p] }

data/test/plugins/before_test.rb

@@ -1,11 +1,9 @@
 require_relative '../helper'
-require 'roy/plugin/before'
 
 class BeforeTestObject
   include Roy
-  include Roy::Plugin::Before
 
-  roy allow: [:get],
+  roy use: [:before], allow: [:get],
       before: lambda { |env|
         env['REQUEST_METHOD'] = 'GET'
       }

data/test/plugins/plugins_test.rb

@@ -1,12 +1,10 @@
 require_relative '../helper'
-require 'roy/plugins'
-require 'roy/plugin/before'
+require 'roy/before'
 
 class PluginsTestObject
   include Roy
-  include Roy::Plugins(Plugin::Before, :after)
 
-  roy allow: [:get],
+  roy use: [Before, :after], allow: [:get],
       before: lambda { |env|
         env['REQUEST_METHOD'] = 'GET'
       },

data/test/plugins/render_test.rb

@@ -1,5 +1,4 @@
 require_relative '../helper'
-require 'roy/plugin/render'
 
 Templates = {
   simple: %q(<%= "Hello world!" %>),
@@ -10,28 +9,28 @@ Templates = {
 
 class RenderTestObject
   include Roy
-  include Roy::Plugin::Render
 
   roy allow: [:get],
-      views: 'test/views'
+      views: 'test/views',
+      use: [:render]
 
   def get(path)
     case path
     when '/template'
-      render :erb, :test
+      roy.render :erb, :test
     when '/template_layout'
-      render :erb, :layout do
-        render :erb, :test
+      roy.render :erb, :layout do
+        roy.render :erb, :test
       end
     when '/inline'
-      render :erb, Templates[:simple]
+      roy.render :erb, Templates[:simple]
     when '/locals'
-      render :erb, Templates[:locals], person: 'Bob'
+      roy.render :erb, Templates[:locals], person: 'Bob'
     when '/scope'
-      render :erb, Templates[:scope]
+      roy.render :erb, Templates[:scope]
     when '/yield'
-      render :erb, Templates[:yield] do
-        render :erb, Templates[:simple]
+      roy.render :erb, Templates[:yield] do
+        roy.render :erb, Templates[:simple]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roy
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-21 00:00:00.000000000 Z
+date: 2012-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &22715480 !ruby/object:Gem::Requirement
+  requirement: &6178220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22715480
+  version_requirements: *6178220
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &22714940 !ruby/object:Gem::Requirement
+  requirement: &6177760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22714940
+  version_requirements: *6177760
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &22714460 !ruby/object:Gem::Requirement
+  requirement: &6177200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22714460
+  version_requirements: *6177200
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &22713940 !ruby/object:Gem::Requirement
+  requirement: &6176320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22713940
+  version_requirements: *6176320
 description: ! 'roy is a small library which allows every Ruby object to be used
 
   as a Rack application.'
@@ -70,11 +70,11 @@ files:
 - README.md
 - Rakefile
 - lib/roy.rb
-- lib/roy/plugin/after.rb
-- lib/roy/plugin/basic_auth.rb
-- lib/roy/plugin/before.rb
-- lib/roy/plugin/render.rb
-- lib/roy/plugins.rb
+- lib/roy/after.rb
+- lib/roy/base.rb
+- lib/roy/basic_auth.rb
+- lib/roy/before.rb
+- lib/roy/render.rb
 - lib/roy/version.rb
 - roy.gemspec
 - test/base_test.rb
@@ -126,3 +126,4 @@ test_files:
 - test/prefix_test.rb
 - test/views/layout.erb
 - test/views/test.erb
+has_rdoc: 

data/lib/roy/plugin/after.rb

@@ -1,12 +0,0 @@
-module Roy
-  module Plugin
-    module After
-      def call(env)
-        status, header, body = super
-        resp = Rack::Response.new(body, status, header)
-        (roy.conf.after || lambda {|x| x }).(resp)
-        resp.finish
-      end
-    end
-  end
-end

data/lib/roy/plugin/basic_auth.rb

@@ -1,22 +0,0 @@
-module Roy
-  module Plugin
-    module BasicAuth
-      def protected!(data=nil)
-        unless authorized?(data)
-          realm = roy.conf.auth && roy.conf.auth[:realm] || 'Realm'
-          roy.response['WWW-Authenticate'] = %(Basic realm="#{realm}")
-          halt 401
-        end
-      end
-
-      def authorized?(data=nil)
-        auth = Rack::Auth::Basic::Request.new(roy.request.env)
-
-        auth.provided? && auth.basic? && auth.credentials &&
-          (roy.conf.auth[:logic] || ->(data, u, p) {
-            %w(admin password) == [u, p]
-           }).(data, *auth.credentials)
-      end
-    end
-  end
-end

data/lib/roy/plugin/before.rb

@@ -1,10 +0,0 @@
-module Roy
-  module Plugin
-    module Before
-      def call(env)
-        (roy.conf.before || lambda {|x| x }).(env)
-        super
-      end
-    end
-  end
-end

data/lib/roy/plugin/render.rb

@@ -1,23 +0,0 @@
-require 'tilt'
-
-module Roy
-  module Plugin
-    module Render
-
-      def render(engine, view_or_string, params={}, &block)
-        options = roy.conf.render || {}
-        template = case view_or_string
-          when Symbol
-            file = [view_or_string.to_s, engine].map(&:to_s).join('.')
-            dir = roy.conf.views || 'views'
-            Tilt.new(File.join(dir, file), nil, options)
-          else
-            Tilt[engine].new(nil, nil, options) { view_or_string.to_s }
-          end
-
-        template.render(self, params, &block)
-      end
-
-    end
-  end
-end

data/lib/roy/plugins.rb

@@ -1,17 +0,0 @@
-module Roy
-  module Plugin; end
-
-  def self.Plugins(*names)
-    return Module.new.tap do |mod|
-      names.each do |name|
-        if name.is_a?(Symbol)
-          require "roy/plugin/#{name}"
-          const = "#{name}".capitalize.gsub(/_(\w)/) {|m| m[1].upcase }.to_sym
-          name = Roy::Plugin.const_get(const)
-        end
-        mod.send(:include, name)
-      end
-    end
-  end
-end
-