grape 0.0.0.alpha.2 → 0.1.0

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --format=nested
---backtrace
+--fail-fast

data/Gemfile

@@ -1,8 +1,10 @@
 gem 'rack'
-gem 'rack-mount'
+gem 'rack-mount', '~> 0.6.13'
 gem 'rack-jsonp'
 
-gem 'activesupport', '~> 3.0.0'
+gem 'json'
+gem 'multi_json'
+gem 'multi_xml'
 
 group :development do
   gem 'rake'
@@ -10,7 +12,7 @@ group :development do
 end
 
 group :test do
-  gem 'rspec', '>= 2.0.0.beta.19'
   gem 'rack-test'
+  gem 'rspec', '>= 2.1.0'
   gem 'cucumber', '>= 0.8.5'
 end

data/Gemfile.lock

@@ -1,6 +1,5 @@
 GEM
   specs:
-    activesupport (3.0.0)
     builder (2.1.2)
     cucumber (0.8.5)
       builder (~> 2.1.2)
@@ -17,22 +16,25 @@ GEM
       gemcutter (>= 0.1.0)
       git (>= 1.2.5)
       rubyforge (>= 2.0.0)
+    json (1.4.6)
     json_pure (1.4.3)
+    multi_json (0.0.4)
+    multi_xml (0.0.1)
     rack (1.2.1)
     rack-jsonp (1.0.0)
-    rack-mount (0.6.9)
+    rack-mount (0.6.13)
       rack (>= 1.0.0)
     rack-test (0.5.4)
       rack (>= 1.0)
     rake (0.8.7)
-    rspec (2.0.0.beta.19)
-      rspec-core (= 2.0.0.beta.19)
-      rspec-expectations (= 2.0.0.beta.19)
-      rspec-mocks (= 2.0.0.beta.19)
-    rspec-core (2.0.0.beta.19)
-    rspec-expectations (2.0.0.beta.19)
-      diff-lcs (>= 1.1.2)
-    rspec-mocks (2.0.0.beta.19)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
     rubyforge (2.0.4)
       json_pure (>= 1.1.7)
     term-ansicolor (1.0.5)
@@ -42,12 +44,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3.0.0)
   cucumber (>= 0.8.5)
   jeweler
+  json
+  multi_json
+  multi_xml
   rack
   rack-jsonp
-  rack-mount
+  rack-mount (~> 0.6.13)
   rack-test
   rake
-  rspec (>= 2.0.0.beta.19)
+  rspec (>= 2.1.0)

data/README.rdoc

@@ -4,7 +4,7 @@
 
 Grape is a REST-like API micro-framework for Ruby. It is built to complement existing web application frameworks such as Rails and Sinatra by providing a simple DSL to easily provide APIs. It has built-in support for common conventions such as multiple formats, subdomain/prefix restriction, and versioning.
 
-    class Twitter < Grape::Base
+    class Twitter::API < Grape::Base
       subdomain 'api'
       version '1'
       formats :xml, :json
@@ -30,6 +30,15 @@ Grape is a REST-like API micro-framework for Ruby. It is built to complement exi
       end
     end
     
+    # Rack endpoint
+    Twitter::API.statuses.timelines.get(:public_timeline)
+    
+    class Twitter::API::User < Grape::Resource::ActiveRecord
+      represents ::User
+      
+      property :status, lambda{|u| u.latest_status}, Twitter::API::Status
+    end
+    
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.0.alpha.2
+0.1.0

data/grape.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grape}
-  s.version = "0.0.0.alpha.2"
+  s.version = "0.1.0"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Bleigh"]
-  s.date = %q{2010-08-30}
+  s.date = %q{2010-11-13}
   s.description = %q{A Ruby framework for rapid API development with great conventions.}
   s.email = %q{michael@intridea.com}
   s.extra_rdoc_files = [
@@ -30,18 +30,26 @@ Gem::Specification.new do |s|
      "autotest/discover.rb",
      "grape.gemspec",
      "lib/grape.rb",
+     "lib/grape/api.rb",
+     "lib/grape/endpoint.rb",
+     "lib/grape/middleware/auth/basic.rb",
      "lib/grape/middleware/auth/oauth2.rb",
      "lib/grape/middleware/base.rb",
      "lib/grape/middleware/error.rb",
      "lib/grape/middleware/formatter.rb",
      "lib/grape/middleware/prefixer.rb",
      "lib/grape/middleware/versioner.rb",
+     "lib/grape/middleware_stack.rb",
+     "spec/grape/api_spec.rb",
+     "spec/grape/endpoint_spec.rb",
+     "spec/grape/middleware/auth/basic_spec.rb",
      "spec/grape/middleware/auth/oauth2_spec.rb",
      "spec/grape/middleware/base_spec.rb",
      "spec/grape/middleware/error_spec.rb",
      "spec/grape/middleware/formatter_spec.rb",
      "spec/grape/middleware/prefixer_spec.rb",
      "spec/grape/middleware/versioner_spec.rb",
+     "spec/grape/middleware_stack_spec.rb",
      "spec/grape_spec.rb",
      "spec/spec_helper.rb"
   ]
@@ -51,12 +59,16 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby framework for rapid API development.}
   s.test_files = [
-    "spec/grape/middleware/auth/oauth2_spec.rb",
+    "spec/grape/api_spec.rb",
+     "spec/grape/endpoint_spec.rb",
+     "spec/grape/middleware/auth/basic_spec.rb",
+     "spec/grape/middleware/auth/oauth2_spec.rb",
      "spec/grape/middleware/base_spec.rb",
      "spec/grape/middleware/error_spec.rb",
      "spec/grape/middleware/formatter_spec.rb",
      "spec/grape/middleware/prefixer_spec.rb",
      "spec/grape/middleware/versioner_spec.rb",
+     "spec/grape/middleware_stack_spec.rb",
      "spec/grape_spec.rb",
      "spec/spec_helper.rb"
   ]
@@ -67,24 +79,30 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rack>, [">= 0"])
-      s.add_runtime_dependency(%q<rack-mount>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-mount>, ["~> 0.6.13"])
       s.add_runtime_dependency(%q<rack-jsonp>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_xml>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
       s.add_dependency(%q<rack>, [">= 0"])
-      s.add_dependency(%q<rack-mount>, [">= 0"])
+      s.add_dependency(%q<rack-mount>, ["~> 0.6.13"])
       s.add_dependency(%q<rack-jsonp>, [">= 0"])
-      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<multi_json>, [">= 0"])
+      s.add_dependency(%q<multi_xml>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
     s.add_dependency(%q<rack>, [">= 0"])
-    s.add_dependency(%q<rack-mount>, [">= 0"])
+    s.add_dependency(%q<rack-mount>, ["~> 0.6.13"])
     s.add_dependency(%q<rack-jsonp>, [">= 0"])
-    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<multi_json>, [">= 0"])
+    s.add_dependency(%q<multi_xml>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
   end

data/lib/grape.rb

@@ -1,10 +1,22 @@
 require 'rack'
 require 'rack/builder'
 
-require 'grape/middleware/base'
-require 'grape/middleware/prefixer'
-require 'grape/middleware/versioner'
-require 'grape/middleware/formatter'
-require 'grape/middleware/error'
-
-require 'grape/middleware/auth/oauth2'
+module Grape
+  autoload :API, 'grape/api'
+  autoload :Endpoint, 'grape/endpoint'
+  autoload :MiddlewareStack, 'grape/middleware_stack'
+  autoload :Client, 'grape/client'
+  
+  module Middleware
+    autoload :Base,      'grape/middleware/base'
+    autoload :Prefixer,  'grape/middleware/prefixer'
+    autoload :Versioner, 'grape/middleware/versioner'
+    autoload :Formatter, 'grape/middleware/formatter'
+    autoload :Error,     'grape/middleware/error'
+    
+    module Auth
+      autoload :OAuth2, 'grape/middleware/auth/oauth2'
+      autoload :Basic,  'grape/middleware/auth/basic'
+    end
+  end
+end

data/lib/grape/api.rb

@@ -0,0 +1,174 @@
+require 'rack/mount'
+require 'rack/auth/basic'
+
+module Grape
+  class API
+    module Helpers; end
+    
+    class << self
+      attr_reader :route_set
+      
+      def reset!
+        @settings = [{}]
+        @route_set = Rack::Mount::RouteSet.new
+        @prototype = nil
+      end
+      
+      def call(env)
+        puts "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
+        route_set.freeze.call(env)
+      end
+      
+      # Settings are a stack, so when we
+      # want to access them they are merged
+      # in the order pushed.
+      def settings
+        @settings.inject({}){|f,h| f.merge!(h); f}
+      end
+      
+      def settings_stack
+        @settings
+      end
+      
+      def set(key, value)
+        @settings.last[key.to_sym] = value
+      end
+      
+      # Define a root prefix for your entire
+      # API. For instance, if you had an api
+      # that you wanted to be namespaced at
+      # `/api/` you would do this:
+      # 
+      #   prefix '/api'
+      def prefix(prefix = nil)
+        prefix ? set(:root_prefix, prefix) : settings[:root_prefix]
+      end
+      
+      def version(*new_versions, &block)
+        new_versions.any? ? nest(block){ set(:version, new_versions) } : settings[:version]
+      end
+      
+      def default_format(new_format = nil)
+        new_format ? set(:default_format, new_format.to_sym) : settings[:default_format]
+      end
+
+      # Add helper methods that will be accessible from any
+      # endpoint within this namespace (and child namespaces).
+      #
+      #    class ExampleAPI
+      #      helpers do
+      #        def current_user
+      #          User.find_by_id(params[:token])
+      #        end
+      #      end
+      #    end
+      def helpers(&block)
+        if block_given?
+          m = settings_stack.last[:helpers] || Module.new
+          m.class_eval &block
+          set(:helpers, m)
+        else
+          m = Module.new
+          settings_stack.each do |s|
+            m.send :include, s[:helpers] if s[:helpers]
+          end
+          m
+        end
+      end
+      
+      def auth(type = nil, options = {}, &block)
+        if type
+          set(:auth, {:type => type.to_sym, :proc => block}.merge(options))
+        else
+          settings[:auth]
+        end
+      end
+      
+      # Add HTTP Basic authorization to the API.
+      #
+      # @param [Hash] options A hash of options.
+      # @option options [String] :realm "API Authorization" The HTTP Basic realm.
+      def http_basic(options = {}, &block)
+        options[:realm] ||= "API Authorization"
+        auth :http_basic, options, &block
+      end
+      
+      def route_set
+        @route_set ||= Rack::Mount::RouteSet.new
+      end
+      
+      def compile_path(path)
+        parts = []
+        parts << prefix if prefix
+        parts << ':version' if version
+        parts << namespace if namespace
+        parts << path
+        Rack::Mount::Utils.normalize_path(parts.join('/'))
+      end
+
+      def route(method, path_info, &block)
+        route_set.add_route(build_endpoint(&block), 
+          :path_info => Rack::Mount::Strexp.compile(compile_path(path_info)), 
+          :request_method => method
+        )
+      end
+      
+      def build_endpoint(&block)
+        
+        b = Rack::Builder.new
+        b.use Grape::Middleware::Error
+        b.use Rack::Auth::Basic, settings[:auth][:realm], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_basic
+        b.use Grape::Middleware::Prefixer, :prefix => prefix if prefix        
+        b.use Grape::Middleware::Versioner, :versions => (version if version.is_a?(Array)) if version
+        b.use Grape::Middleware::Formatter, :default_format => default_format || :json
+        
+        endpoint = Grape::Endpoint.new(&block)
+        endpoint.send :extend, helpers
+        b.run endpoint
+        
+        b.to_app
+      end
+      
+      def get(path_info = '', &block); route('GET', path_info, &block) end
+      def post(path_info = '', &block); route('POST', path_info, &block) end
+      def put(path_info = '', &block); route('PUT', path_info, &block) end
+      def head(path_info = '', &block); route('HEAD', path_info, &block) end
+      def delete(path_info = '', &block); route('DELETE', path_info, &block) end
+      
+      def namespace(space = nil, &block)
+        if space || block_given?
+          nest(block) do
+            set(:namespace, space.to_s) if space
+          end
+        else
+          Rack::Mount::Utils.normalize_path(settings_stack.map{|s| s[:namespace]}.join('/'))
+        end
+      end
+      
+      # Execute first the provided block, then each of the
+      # block passed in. Allows for simple 'before' setups
+      # of settings stack pushes.
+      def nest(*blocks, &block)
+        blocks.reject!{|b| b.nil?}
+        if blocks.any?
+          settings_stack << {}
+          instance_eval &block
+          blocks.each{|b| instance_eval &b}
+          settings_stack.pop
+        else
+          instance_eval &block
+        end
+      end
+      
+      alias_method :group, :namespace
+      alias_method :resource, :namespace
+      alias_method :resources, :namespace
+      
+      def inherited(subclass)
+        subclass.reset!
+      end
+    end  
+    
+    reset! 
+  end
+end

data/lib/grape/endpoint.rb

@@ -0,0 +1,65 @@
+require 'rack'
+require 'grape'
+
+module Grape
+  # An Endpoint is the proxy scope in which all routing
+  # blocks are executed. In other words, any methods
+  # on the instance level of this class may be called
+  # from inside a `get`, `post`, etc. block.
+  class Endpoint
+    def initialize(&block)
+      @block = block
+    end
+    
+    attr_reader :env, :request
+    
+    def params
+      @params ||= request.params.merge(env['rack.routing_args'] || {}).inject({}) do |h,(k,v)|
+        h[k.to_s] = v
+        h[k.to_sym] = v
+        h
+      end
+    end
+    
+    def version; env['api.version'] end
+    
+    def error!(message, status=403)
+      throw :error, :message => message, :status => status
+    end
+    
+    # Set or retrieve the HTTP status code.
+    def status(status = nil)
+      if status
+        @status = status
+      else
+        return @status if @status
+        case request.request_method.to_s.upcase
+          when 'POST'
+            201
+          else
+            200
+        end
+      end        
+    end
+    
+    # Set an individual header or retrieve
+    # all headers that have been set.
+    def header(key = nil, val = nil)
+      if key
+        val ? @header[key.to_s] = val : @header.delete(key.to_s)
+      else
+        @header
+      end
+    end
+    
+    def call(env)
+      @env = env
+      @request = Rack::Request.new(@env)
+      @header = {}
+      
+      response_text = instance_eval &@block
+      
+      [status, header, [response_text]]
+    end
+  end
+end