rack-api 0.3.1 → 1.0.0

data/.gitignore

@@ -2,3 +2,4 @@
 pkg
 tmp
 docs
+*.rdb

data/.rspec

@@ -1 +1 @@
---color --format documentation
+--color --format documentation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rack-api (0.3.1)
+    rack-api (1.0.0)
       activesupport (>= 3.0.0)
       rack (>= 1.0.0)
       rack-mount (>= 0.6.0)
@@ -9,18 +9,19 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.8)
+    activesupport (3.0.9)
     archive-tar-minitar (0.5.2)
-    columnize (0.3.2)
+    columnize (0.3.4)
     diff-lcs (1.1.2)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
-    rack (1.3.0)
-    rack-mount (0.8.1)
+    rack (1.3.2)
+    rack-mount (0.6.14)
       rack (>= 1.0.0)
     rack-test (0.5.7)
       rack (>= 1.0)
-    redis (2.2.0)
+    rake (0.9.2)
+    redis (2.2.1)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
@@ -46,6 +47,7 @@ PLATFORMS
 DEPENDENCIES
   rack-api!
   rack-test (~> 0.5.7)
+  rake (~> 0.9)
   redis (~> 2.2.0)
   rspec (~> 2.6)
   ruby-debug19

data/README.rdoc

@@ -127,7 +127,7 @@ Your <tt>Helpers</tt> module may look like this:
 == Helpers
 
 Every Rack::API action has several helper methods available through the
-Rack::API::App class. Here's some of them:
+Rack::API::Controller class. Here's some of them:
 
 === logger
 

data/Rakefile

@@ -4,7 +4,7 @@ Bundler::GemHelper.install_tasks
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
-require "rake/rdoctask"
+require "rdoc/task"
 Rake::RDocTask.new do |t|
   t.rdoc_dir = "docs"
   t.main = "README.rdoc"

data/examples/controller.rb

@@ -0,0 +1,22 @@
+$:.push(File.dirname(__FILE__) + "/../lib")
+
+# Just run `ruby examples/controller.rb` and then use something like
+# `curl http://localhost:2345/api/v1/`.
+
+require "rack/api"
+
+class Hello < Rack::API::Controller
+  def index
+    {:message => "Hello, awesome API!"}
+  end
+end
+
+Rack::API.app do
+  prefix "api"
+
+  version :v1 do
+    get "/", :to => "hello#index"
+  end
+end
+
+Rack::Handler::Thin.run Rack::API, :Port => 2345

data/examples/without_version_and_prefix.rb

@@ -0,0 +1,14 @@
+$:.push(File.dirname(__FILE__) + "/../lib")
+
+# Just run `ruby examples/without_version_and_prefix.rb` and then use something like
+# `curl http://localhost:2345/`.
+
+require "rack/api"
+
+Rack::API.app do
+  get "/" do
+    {:message => "Hello, awesome API!"}
+  end
+end
+
+Rack::Handler::Thin.run Rack::API, :Port => 2345

data/lib/rack/api.rb

@@ -2,13 +2,14 @@ require "rack"
 require "rack/mount"
 require "active_support/hash_with_indifferent_access"
 require "active_support/core_ext/object/to_query"
+require "active_support/core_ext/string/inflections"
 require "json"
 require "logger"
 require "forwardable"
 
 module Rack
   class API
-    autoload :App         , "rack/api/app"
+    autoload :Controller  , "rack/api/controller"
     autoload :Formatter   , "rack/api/formatter"
     autoload :Middleware  , "rack/api/middleware"
     autoload :Runner      , "rack/api/runner"

data/lib/rack/api/{app.rb → controller.rb}

@@ -1,10 +1,10 @@
 module Rack
   class API
-    class App
+    class Controller
       # Registered content types. If you want to use
       # a custom formatter that is not listed here,
       # you have to manually add it. Otherwise,
-      # Rack::API::App::DEFAULT_MIME_TYPE will be used
+      # Rack::API::Controller::DEFAULT_MIME_TYPE will be used
       # as the content type.
       #
       MIME_TYPES = {
@@ -19,7 +19,7 @@ module Rack
       }
 
       # Default content type. Will be used when a given format
-      # hasn't been registered on Rack::API::App::MIME_TYPES.
+      # hasn't been registered on Rack::API::Controller::MIME_TYPES.
       #
       DEFAULT_MIME_TYPE = "application/octet-stream"
 
@@ -169,7 +169,7 @@ module Rack
 
       # Return response content type based on extension.
       # If you're using an unknown extension that wasn't registered on
-      # Rack::API::App::MIME_TYPES, it will return Rack::API::App::DEFAULT_MIME_TYPE,
+      # Rack::API::Controller::MIME_TYPES, it will return Rack::API::Controller::DEFAULT_MIME_TYPE,
       # which defaults to <tt>application/octet-stream</tt>.
       #
       def content_type

data/lib/rack/api/runner.rb

@@ -87,7 +87,7 @@ module Rack
       end
 
       # Define the server endpoint. Will be used if you call the method
-      # Rack::API::App#url_for.
+      # Rack::API::Controller#url_for.
       #
       # The following options are supported:
       #
@@ -223,9 +223,42 @@ module Rack
       #     end
       #   end
       #
+      # You don't have to use +version+ or +prefix+.
+      #
+      #   class MyAPI < Rack::API
+      #     get "users(.:format)" do
+      #       # do something
+      #     end
+      #   end
+      #
+      # Alternatively, you can define your routes pretty much like Rails.
+      #
+      #   class MyAPI < Rack::API
+      #     get "users(.:format)", :to => "users#index"
+      #   end
+      #
+      # The route above will require a class +Users+ with an instance method +index+.
+      #
+      #   class Users < Rack::API::Controller
+      #     def index
+      #       # do something
+      #     end
+      #   end
+      #
+      # Note that your controller <b>must</b> inherit from Rack::API::Controller. Otherwise,
+      # your world will explode.
+      #
       def route(method, path, requirements = {}, &block)
         path = Rack::Mount::Strexp.compile mount_path(path), requirements, %w[ / . ? ]
-        route_set.add_route(build_app(block), :path_info => path, :request_method => method)
+        controller_class = Controller
+
+        if requirements[:to]
+          controller_name, action_name = requirements.delete(:to).split("#")
+          controller_class = controller_name.camelize.constantize
+          block = proc { __send__(action_name) }
+        end
+
+        route_set.add_route(build_app(controller_class, block), :path_info => path, :request_method => method)
       end
 
       HTTP_METHODS.each do |method|
@@ -258,8 +291,8 @@ module Rack
         (option(:formats).first || "json").to_s
       end
 
-      def build_app(handler) # :nodoc:
-        app = App.new({
+      def build_app(controller, handler) # :nodoc:
+        app = controller.new({
           :handler        => handler,
           :default_format => default_format,
           :version        => option(:version),
@@ -277,7 +310,7 @@ module Rack
         # Add middleware for format validation.
         builder.use Rack::API::Middleware::Format, default_format, option(:formats)
 
-        # Add middlewares to executation stack.
+        # Add middlewares to execution stack.
         option(:middlewares, :merge).each {|middleware| builder.use(*middleware)}
 
         # Apply helpers to app.

data/lib/rack/api/version.rb

@@ -1,9 +1,9 @@
 module Rack
   class API
     module Version
-      MAJOR = 0
-      MINOR = 3
-      PATCH = 1
+      MAJOR = 1
+      MINOR = 0
+      PATCH = 0
       STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
     end
   end

data/rack-api.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", "~> 2.6"
   s.add_development_dependency "rack-test", "~> 0.5.7"
   s.add_development_dependency "redis", "~> 2.2.0"
+  s.add_development_dependency "rake", "~> 0.9"
   s.add_development_dependency "ruby-debug19" if RUBY_VERSION >= "1.9"
 end

data/spec/rack-api/controller_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Rack::API do
+  before do
+    Rack::API.app do
+      get("/", :to => "my_controller#index")
+    end
+  end
+
+  it "renders action from MyApp" do
+    get "/", :name => "John"
+    last_response.body.should == {"name" => "John"}.to_json
+  end
+end

data/spec/rack-api/format_spec.rb

@@ -39,7 +39,7 @@ describe Rack::API, "Format" do
     end
 
     it "is set to the first respond_to value" do
-      Rack::API::App::MIME_TYPES["fffuuu"] = "application/x-fffuuu"
+      Rack::API::Controller::MIME_TYPES["fffuuu"] = "application/x-fffuuu"
 
       Rack::API.app do
         version :v2 do

data/spec/rack-api/rescue_from_spec.rb

@@ -62,7 +62,7 @@ describe Rack::API, "Rescue from exceptions" do
     end
 
     get "/v1/500"
-    last_response.body.should == "Rack::API::App"
+    last_response.body.should == "Rack::API::Controller"
   end
 
   it "yields the exception object" do

data/spec/rack-api/runner_spec.rb

@@ -50,7 +50,7 @@ describe Rack::API::Runner do
       :handler => proc {}
     }
 
-    Rack::API::App.should_receive(:new).with(hash_including(expected)).once
+    Rack::API::Controller.should_receive(:new).with(hash_including(expected)).once
     subject.version("v1") do
       respond_to :fffuuu
       prefix "api"

data/spec/rack-api/url_for_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
-describe Rack::API::App, "#url_for" do
-  subject { Rack::API::App.new(
+describe Rack::API::Controller, "#url_for" do
+  subject { Rack::API::Controller.new(
     :version => "v1",
     :url_options => {},
     :env => Rack::MockRequest.env_for("/v1")
@@ -22,7 +22,7 @@ describe Rack::API::App, "#url_for" do
   end
 
   it "sets default url options hash" do
-    subject = Rack::API::App.new(:version => "v1", :url_options => nil, :env => Rack::MockRequest.env_for("/v1"))
+    subject = Rack::API::Controller.new(:version => "v1", :url_options => nil, :env => Rack::MockRequest.env_for("/v1"))
 
     expect {
       subject.url_for(:things, 1)
@@ -59,13 +59,13 @@ describe Rack::API::App, "#url_for" do
 
   it "uses host from request" do
     env = Rack::MockRequest.env_for("/v1", "SERVER_NAME" => "mysite.com")
-    subject = Rack::API::App.new(:version => "v1", :env => env)
+    subject = Rack::API::Controller.new(:version => "v1", :env => env)
     subject.url_for.should == "http://mysite.com/v1"
   end
 
   it "uses port from request" do
     env = Rack::MockRequest.env_for("/v1", "SERVER_PORT" => "2345")
-    subject = Rack::API::App.new(:version => "v1", :env => env)
+    subject = Rack::API::Controller.new(:version => "v1", :env => env)
     subject.url_for.should == "http://example.org:2345/v1"
   end
 end

data/spec/support/mycontroller.rb

@@ -0,0 +1,5 @@
+class MyController < Rack::API::Controller
+  def index
+    {:name => params[:name]}
+  end
+end

metadata

@@ -1,104 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-api
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  version: 0.3.1
 platform: ruby
-authors: 
+authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70155088054880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rack-mount
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70155088054880
+- !ruby/object:Gem::Dependency
+  name: rack-mount
+  requirement: &70155088053900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70155088053900
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70155088053320 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70155088053320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70155088052440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70155088052440
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70155088067720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.5.7
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: redis
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70155088067720
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70155088067220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 2.2.0
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug19
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70155088067220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70155088066500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
-  version_requirements: *id007
-description: Create web app APIs that respond to one or more formats using an elegant DSL.
-email: 
+  prerelease: false
+  version_requirements: *70155088066500
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70155088065780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70155088065780
+description: Create web app APIs that respond to one or more formats using an elegant
+  DSL.
+email:
 - fnando.vieira@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -106,6 +114,7 @@ files:
 - README.rdoc
 - Rakefile
 - examples/basic_auth.rb
+- examples/controller.rb
 - examples/custom_class.rb
 - examples/custom_format.rb
 - examples/custom_headers.rb
@@ -116,8 +125,9 @@ files:
 - examples/params.rb
 - examples/rescue_from.rb
 - examples/simple.rb
+- examples/without_version_and_prefix.rb
 - lib/rack/api.rb
-- lib/rack/api/app.rb
+- lib/rack/api/controller.rb
 - lib/rack/api/formatter.rb
 - lib/rack/api/formatter/base.rb
 - lib/rack/api/formatter/jsonp.rb
@@ -131,6 +141,7 @@ files:
 - rack-api.gemspec
 - spec/rack-api/api_throttling_spec.rb
 - spec/rack-api/basic_auth_spec.rb
+- spec/rack-api/controller_spec.rb
 - spec/rack-api/format_spec.rb
 - spec/rack-api/headers_spec.rb
 - spec/rack-api/helpers_spec.rb
@@ -151,37 +162,43 @@ files:
 - spec/support/core_ext.rb
 - spec/support/helpers.rb
 - spec/support/myapp.rb
+- spec/support/mycontroller.rb
 - spec/support/zomg_middleware.rb
 homepage: http://rubygems.org/gems/rack-api
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3523925321348313927
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3523925321348313927
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Create web app APIs that respond to one or more formats using an elegant DSL.
-test_files: 
+summary: Create web app APIs that respond to one or more formats using an elegant
+  DSL.
+test_files:
 - spec/rack-api/api_throttling_spec.rb
 - spec/rack-api/basic_auth_spec.rb
+- spec/rack-api/controller_spec.rb
 - spec/rack-api/format_spec.rb
 - spec/rack-api/headers_spec.rb
 - spec/rack-api/helpers_spec.rb
@@ -202,4 +219,5 @@ test_files:
 - spec/support/core_ext.rb
 - spec/support/helpers.rb
 - spec/support/myapp.rb
+- spec/support/mycontroller.rb
 - spec/support/zomg_middleware.rb