sinatra-rabbit 0.0.1

data/COPYING

@@ -0,0 +1,176 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/lib/sinatra/rabbit/respond_to.rb

@@ -0,0 +1,249 @@
+# respond_to (The MIT License)
+
+# 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 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
+
+require 'rack/accept'
+
+puts "Loading repond_to"
+
+module Sinatra
+
+  module RespondTo
+
+    class MissingTemplate < Sinatra::NotFound; end
+
+    # Define all MIME types you want to support here.
+    # This conversion table will be used for auto-negotiation
+    # with browser in sinatra when no 'format' parameter is specified.
+
+    SUPPORTED_ACCEPT_HEADERS = {
+      :xml => [
+        'text/xml',
+        'application/xml'
+      ],
+      :html => [
+        'text/html',
+        'application/xhtml+xml'
+      ],
+      :json => [
+        'application/json'
+      ]
+    }
+
+    # We need to pass array of available response types to
+    # best_media_type method
+    def accept_to_array
+      SUPPORTED_ACCEPT_HEADERS.keys.collect do |key|
+        SUPPORTED_ACCEPT_HEADERS[key]
+      end.flatten
+    end
+
+    # Then, when we get best media type for response, we need
+    # to know which format to choose
+    def lookup_format_from_mime(mime)
+      SUPPORTED_ACCEPT_HEADERS.keys.each do |format|
+        return format if SUPPORTED_ACCEPT_HEADERS[format].include?(mime)
+      end
+    end
+
+    def self.registered(app)
+
+      app.helpers RespondTo::Helpers
+      use Rack::Accept
+
+      app.before do
+
+        # Skip development error image and static content
+        next if self.class.development? && request.path_info =~ %r{/__sinatra__/.*?.png}
+        next if options.static? && options.public? && (request.get? || request.head?) && static_file?(request.path_info)
+
+        # Remove extension from URI
+        # Extension will be available as a 'extension' method (extension=='txt')
+       
+        extension request.path_info.match(/\.([^\.\/]+)$/).to_a.first
+
+        # If ?format= is present, ignore all Accept negotiations because
+        # we are not dealing with browser
+        if request.params.has_key? 'format'
+          format params['format'].to_sym
+        end
+        
+        # Let's make a little exception here to handle
+        # /api/instance_states[.gv/.png] calls
+        if extension.eql?('gv')
+          format :gv
+        elsif extension.eql?('png')
+          format :png
+        end
+
+        # Get Rack::Accept::Response object and find best possible
+        # mime type to output.
+        # This negotiation works fine with latest rest-client gem:
+        #
+        # RestClient.get 'http://localhost:3001/api', {:accept => :json } =>
+        # 'application/json'
+        # RestClient.get 'http://localhost:3001/api', {:accept => :xml } =>
+        # 'application/xml'
+        #
+        # Also browsers like Firefox (3.6.x) and Chromium reporting
+        # 'application/xml+xhtml' which is recognized as :html reponse
+        # In browser you can force output using ?format=[format] parameter.
+
+        rack_accept = env['rack-accept.request']
+
+        if rack_accept.media_type.to_s.strip.eql?('Accept:')
+          format :xml
+        elsif is_chrome?
+          format :html
+        else
+          format lookup_format_from_mime(rack_accept.best_media_type(accept_to_array))
+        end
+
+      end
+
+      app.class_eval do
+
+        # Simple helper to detect Chrome based browsers
+        # which have screwed up they Accept headers.
+        # Set HTML as default output format here
+        def is_chrome?
+          true if env['HTTP_USER_AGENT'] =~ /Chrome/
+        end
+
+        # This code was copied from respond_to plugin
+        # http://github.com/cehoffman/sinatra-respond_to
+        # MIT License
+        alias :render_without_format :render
+        def render(*args, &block)
+          assumed_layout = args[1] == :layout
+          args[1] = "#{args[1]}.#{format}".to_sym if args[1].is_a?(::Symbol)
+          render_without_format *args, &block
+        rescue Errno::ENOENT => e
+          raise MissingTemplate, "#{args[1]}.#{args[0]}" unless assumed_layout
+          raise e
+        end
+        private :render
+      end
+
+      # This code was copied from respond_to plugin
+      # http://github.com/cehoffman/sinatra-respond_to
+      app.configure :development do |dev|
+        dev.error MissingTemplate do
+          content_type :html, :charset => 'utf-8'
+          response.status = request.env['sinatra.error'].code
+
+          engine = request.env['sinatra.error'].message.split('.').last
+          engine = 'haml' unless ['haml', 'builder', 'erb'].include? engine
+
+          path = File.basename(request.path_info)
+          path = "root" if path.nil? || path.empty?
+
+          format = engine == 'builder' ? 'xml' : 'html'
+
+          layout = case engine
+                   when 'haml' then "!!!\n%html\n  %body= yield"
+                   when 'erb' then "<html>\n  <body>\n    <%= yield %>\n  </body>\n</html>"
+                   end
+
+          layout = "<small>app.#{format}.#{engine}</small>\n<pre>#{escape_html(layout)}</pre>"
+
+          (<<-HTML).gsub(/^ {10}/, '')
+          <!DOCTYPE html>
+          <html>
+          <head>
+            <style type="text/css">
+            body { text-align:center;font-family:helvetica,arial;font-size:22px;
+              color:#888;margin:20px}
+            #c {margin:0 auto;width:500px;text-align:left;}
+            small {float:right;clear:both;}
+            pre {clear:both;text-align:left;font-size:70%;width:500px;margin:0 auto;}
+            </style>
+          </head>
+          <body>
+            <h2>Sinatra can't find #{request.env['sinatra.error'].message}</h2>
+            <img src='/__sinatra__/500.png'>
+            <pre>#{request.env['sinatra.error'].backtrace.join("\n")}</pre>
+            <div id="c">
+              <small>application.rb</small>
+              <pre>#{request.request_method.downcase} '#{request.path_info}' do\n  respond_to do |wants|\n    wants.#{format} { #{engine} :#{path} }\n  end\nend</pre>
+            </div>
+          </body>
+          </html>
+          HTML
+        end
+
+      end
+    end
+
+    module Helpers
+
+      # This code was copied from respond_to plugin
+      # http://github.com/cehoffman/sinatra-respond_to
+      def self.included(klass)
+        klass.class_eval do
+          alias :content_type_without_save :content_type
+          def content_type(*args)
+            content_type_without_save *args
+            @_format = args.first.to_sym
+            response['Content-Type']
+          end
+        end
+      end
+
+      def static_file?(path)
+        public_dir = File.expand_path(options.public)
+        path = File.expand_path(File.join(public_dir, unescape(path)))
+
+        path[0, public_dir.length] == public_dir && File.file?(path)
+      end
+
+
+      # Extension holds trimmed extension. This is extra usefull
+      # when you want to build original URI (with extension)
+      # You can simply call "#{request.env['REQUEST_URI']}.#{extension}"
+      def extension(val=nil)
+        @_extension ||= val
+        @_extension
+      end
+      
+      # This helper will holds current format. Helper should be
+      # accesible from all places in Sinatra
+      def format(val=nil)
+        @_format ||= val
+        @_format
+      end
+
+      def respond_to(&block)
+        wants = {}
+        
+        def wants.method_missing(type, *args, &handler)
+          self[type] = handler
+        end
+        
+        # Set proper content-type and encoding for
+        # text based formats
+        if [:xml, :gv, :html, :json].include?(format)
+          content_type format, :charset => 'utf-8'
+        end
+        yield wants
+        # Raise this error if requested format is not defined
+        # in respond_to { } block.
+        raise MissingTemplate if wants[format].nil?
+
+        wants[format].call
+      end
+
+    end
+
+  end
+end

data/lib/sinatra/rabbit/url_for.rb

@@ -0,0 +1,53 @@
+require 'uri'
+
+module Sinatra
+  module UrlForHelper
+    # Construct a link to +url_fragment+, which should be given relative to
+    # the base of this Sinatra app.  The mode should be either
+    # <code>:path_only</code>, which will generate an absolute path within
+    # the current domain (the default), or <code>:full</code>, which will
+    # include the site name and port number.  (The latter is typically
+    # necessary for links in RSS feeds.)  Example usage:
+    #
+    #   url_for "/"            # Returns "/myapp/"
+    #   url_for "/foo"         # Returns "/myapp/foo"
+    #   url_for "/foo", :full  # Returns "http://example.com/myapp/foo"
+    #--
+    # See README.rdoc for a list of some of the people who helped me clean
+    # up earlier versions of this code.
+    def url_for url_fragment, mode=:path_only
+      case mode
+      when :path_only
+        base = request.script_name
+      when :full
+        scheme = request.scheme
+        if (scheme == 'http' && request.port == 80 ||
+            scheme == 'https' && request.port == 443)
+          port = ""
+        else
+          port = ":#{request.port}"
+        end
+        request_host = HOSTNAME ? HOSTNAME : request.host
+        base = "#{scheme}://#{request_host}#{port}#{request.script_name}"
+      else
+        raise TypeError, "Unknown url_for mode #{mode}"
+      end
+      url_escape = URI.escape(url_fragment)
+      # Don't add the base fragment if url_for gets called more than once
+      # per url or the url_fragment passed in is an absolute url
+      if url_escape.match(/^#{base}/) or url_escape.match(/^http/)
+        url_escape
+      else
+        "#{base}#{url_escape}"
+      end
+    end
+
+    def root_url
+      url_for '/'
+    end
+  end
+
+
+
+  helpers UrlForHelper
+end

data/lib/sinatra/rabbit/validation.rb

@@ -0,0 +1,75 @@
+module Sinatra
+
+  module Rabbit
+
+    module Validation
+      class Failure < StandardError
+        attr_reader :param
+        def initialize(param, msg='')
+          super(msg)
+          @param = param
+        end
+
+        def name
+          param.name
+        end
+      end
+
+      class Param
+        attr_reader :name, :klass, :type, :options, :description
+
+        def initialize(args)
+          @name = args[0]
+          @klass = args[1] || :string
+          @type = args[2] || :optional
+          @options = args[3] || []
+          @description = args[4] || ''
+        end
+
+        def required?
+          type.eql?(:required)
+        end
+
+        def optional?
+          type.eql?(:optional)
+        end
+      end
+
+      def param(*args)
+        raise RabbitDuplicateParamException if params[args[0]]
+        p = Param.new(args)
+        params[p.name] = p
+      end
+
+      def params
+        @params ||= {}
+        @params
+      end
+
+      # Add the parameters in hash +new+ to already existing parameters. If
+      # +new+ contains a parameter with an already existing name, the old
+      # definition is clobbered.
+      def add_params(new)
+        # We do not check for duplication on purpose: multiple calls
+        # to add_params should be cumulative
+        new.each { |p|  @params[p.name] = p }
+      end
+
+      def each_param(&block)
+        params.each_value { |p| yield p }
+      end
+
+      def validate(values)
+        each_param do |p|
+          if p.required? and not values[p.name]
+            raise Failure.new(p, "Required parameter #{p.name} not found")
+          end
+          if values[p.name] and not p.options.empty? and
+              not p.options.include?(values[p.name])
+            raise Failure.new(p, "Parameter #{p.name} has value #{values[p.name]} which is not in #{p.options.join(", ")}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/rabbit.rb

@@ -0,0 +1,282 @@
+require 'sinatra/base'
+require 'sinatra/rabbit/url_for'
+require 'sinatra/rabbit/respond_to'
+require 'sinatra/rabbit/validation'
+
+module Sinatra
+
+  module Rabbit
+
+    class RabbitDuplicateParamException < Exception; end
+    class RabbitDuplicateOperationException < Exception; end
+    class RabbitDuplicateCollectionException < Exception; end
+
+    def self.registered(app)
+      app.helpers Rabbit::Helpers
+    end
+
+    class Operation
+      attr_reader :name, :method
+
+      include Rabbit::Validation
+
+      STANDARD = {
+        :index => { :method => :get, :member => false },
+        :show =>  { :method => :get, :member => true },
+        :create => { :method => :post, :member => false },
+        :update => { :method => :put, :member => true },
+        :destroy => { :method => :delete, :member => true }
+      }
+
+      def initialize(coll, name, opts, &block)
+        @name = name.to_sym
+        opts = STANDARD[@name].merge(opts) if standard?
+        @collection = coll
+        raise "No method for operation #{name}" unless opts[:method]
+        @method = opts[:method].to_sym
+        @member = opts[:member]
+        @description = ""
+        instance_eval(&block) if block_given?
+        generate_documentation
+      end
+
+      def standard?
+        STANDARD.keys.include?(name)
+      end
+
+      def description(text="")
+        return @description if text.blank?
+        @description = text
+      end
+
+      def generate_documentation
+        coll, oper = @collection, self
+        ::Sinatra::Application.get("/api/docs/#{@collection.name}/#{@name}") do
+          @collection, @operation = coll, oper
+          respond_to do |format|
+            format.html { haml :'docs/operation' }
+            format.xml { haml :'docs/operation' }
+          end
+        end
+      end
+
+      def control(&block)
+        op = self
+        @control = Proc.new do
+          op.validate(params)
+          instance_eval(&block)
+        end
+      end
+
+      def prefix
+        # FIXME: Make the /api prefix configurable
+        "/api"
+      end
+
+      def path(args = {})
+        l_prefix = args[:prefix] ? args[:prefix] : prefix
+        if @member
+          if standard?
+            "#{l_prefix}/#{@collection.name}/:id"
+          else
+            "#{l_prefix}/#{@collection.name}/:id/#{name}"
+          end
+        else
+          "#{l_prefix}/#{@collection.name}"
+        end
+      end
+
+      def generate
+        ::Sinatra::Application.send(@method, path, {}, &@control)
+        # Set up some Rails-like URL helpers
+        if name == :index
+          gen_route "#{@collection.name}_url"
+        elsif name == :show
+          gen_route "#{@collection.name.to_s.singularize}_url"
+        else
+          gen_route "#{name}_#{@collection.name.to_s.singularize}_url"
+        end
+      end
+
+      private
+      def gen_route(name)
+        route_url = path
+        if @member
+          ::Sinatra::Application.send(:define_method, name) do |id, *args|
+            url = query_url(route_url, args[0])
+            url_for url.gsub(/:id/, id.to_s), :full
+          end
+        else
+          ::Sinatra::Application.send(:define_method, name) do |*args|
+            url = query_url(route_url, args[0])
+            url_for url, :full
+          end
+        end
+      end
+    end
+
+    class Collection
+      attr_reader :name, :operations
+
+      def initialize(name, &block)
+        @name = name
+        @description = ""
+        @operations = {}
+        instance_eval(&block) if block_given?
+        generate_documentation
+      end
+
+      # Set/Return description for collection
+      # If first parameter is not present, full description will be
+      # returned.
+      def description(text='')
+        return @description if text.blank?
+        @description = text
+      end
+
+      def generate_documentation
+        coll, oper, features = self, @operations, features(name)
+        ::Sinatra::Application.get("/api/docs/#{@name}") do
+          @collection, @operations, @features = coll, oper, features
+          respond_to do |format|
+            format.html { haml :'docs/collection' }
+            format.xml { haml :'docs/collection' }
+          end
+        end
+      end
+
+      # Add a new operation for this collection. For the standard REST
+      # operations :index, :show, :update, and :destroy, we already know
+      # what method to use and whether this is an operation on the URL for
+      # individual elements or for the whole collection.
+      #
+      # For non-standard operations, options must be passed:
+      #  :method : one of the HTTP methods
+      #  :member : whether this is an operation on the collection or an
+      #            individual element (FIXME: custom operations on the
+      #            collection will use a nonsensical URL) The URL for the
+      #            operation is the element URL with the name of the operation
+      #            appended
+      #
+      # This also defines a helper method like show_instance_url that returns
+      # the URL to this operation (in request context)
+      def operation(name, opts = {}, &block)
+        raise DuplicateOperationException if @operations[name]
+        @operations[name] = Operation.new(self, name, opts, &block)
+      end
+
+      def generate
+        operations.values.each { |op| op.generate }
+        app = ::Sinatra::Application
+        collname = name # Work around Ruby's weird scoping/capture
+        app.send(:define_method, "#{name.to_s.singularize}_url") do |id|
+            url_for "/api/#{collname}/#{id}", :full
+        end
+
+        if index_op = operations[:index]
+          app.send(:define_method, "#{name}_url") do
+            url_for index_op.path.gsub(/\/\?$/,''), :full
+          end
+        end
+      end
+
+      def add_feature_params(features)
+        features.each do |f|
+          f.operations.each do |fop|
+            if cop = operations[fop.name]
+              fop.params.each_key do |k|
+                if cop.params.has_key?(k)
+                  raise DuplicateParamException, "Parameter '#{k}' for operation #{fop.name} defined by collection #{@name} and by feature #{f.name}"
+                else
+                  cop.params[k] = fop.params[k]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def collections
+      @collections ||= {}
+    end
+
+    # Create a new collection. NAME should be the pluralized name of the
+    # collection.
+    #
+    # Adds a helper method #{name}_url which returns the URL to the :index
+    # operation on this collection.
+    def collection(name, &block)
+      raise DuplicateCollectionException if collections[name]
+      return if collection_excluded?(name.to_sym)
+      collections[name] = Collection.new(name, &block)
+      collections[name].add_feature_params(features(name))
+      collections[name].generate
+    end
+
+    def collection_excluded?(name)
+      false
+    end
+
+    def features(collection_name)
+      []
+    end
+
+    # Generate a root route for API docs
+    get '/api/docs\/?' do
+      respond_to do |format|
+        format.html { haml :'docs/index' }
+        format.xml { haml :'docs/index' }
+      end
+    end
+
+    module Helpers
+      def query_url(url, params)
+        return url if params.nil? || params.empty?
+        url + "?#{URI.escape(params.collect{|k,v| "#{k}=#{v}"}.join('&'))}"
+      end
+
+      def entry_points
+        collections.values.inject([]) do |m, coll|
+          url = url_for coll.operations[:index].path, :full
+          m << [ coll.name, url ]
+        end
+      end
+    end
+  end
+end
+
+class String
+  # Rails defines this for a number of other classes, including Object
+  # see activesupport/lib/active_support/core_ext/object/blank.rb
+  def blank?
+      self !~ /\S/
+  end
+
+  # Title case.
+  #
+  #   "this is a string".titlecase
+  #   => "This Is A String"
+  #
+  # CREDIT: Eliazar Parra
+  # Copied from facets
+  def titlecase
+    gsub(/\b\w/){ $`[-1,1] == "'" ? $& : $&.upcase }
+  end
+
+  def pluralize
+    self + "s"
+  end
+
+  def singularize
+    self.gsub(/s$/, '')
+  end
+
+  def underscore
+      gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+  end
+end

data/sinatra-rabbit.gemspec

@@ -0,0 +1,49 @@
+#
+# Copyright (C) 2010  Red Hat, Inc.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+require 'rake'
+
+Gem::Specification.new do |s|
+  s.author = 'Red Hat, Inc.'
+  s.homepage = "http://incubator.apache.org/deltacloud"
+  s.email = 'deltacloud-dev@incubator.apache.org'
+  s.name = 'sinatra-rabbit'
+
+  s.description = <<-EOF
+    Rabbit is a Sinatra extension which can help you writing
+    a simple REST API using easy to undestand DSL.
+  EOF
+
+  s.version = '0.0.1'
+  s.date = Time.now
+  s.summary = %q{Sinatra REST API DSL}
+  s.files = FileList[
+    'lib/sinatra/*.rb',
+    'lib/sinatra/rabbit/*.rb',
+    'sinatra-rabbit.gemspec',
+  ].to_a
+
+  s.extra_rdoc_files = Dir["COPYING"]
+  s.required_ruby_version = '>= 1.8.1'
+
+  s.add_runtime_dependency 'sinatra', '>= 0.9.4'
+  s.add_runtime_dependency 'rack-accept', '>= 0.4.3'
+
+  s.add_dependency('haml', '>= 2.2.17')
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-rabbit
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Red Hat, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 9
+        - 4
+        version: 0.9.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-accept
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 4
+        - 3
+        version: 0.4.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 2
+        - 2
+        - 17
+        version: 2.2.17
+  type: :runtime
+  version_requirements: *id003
+description: "    Rabbit is a Sinatra extension which can help you writing\n    a simple REST API using easy to undestand DSL.\n"
+email: deltacloud-dev@incubator.apache.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- COPYING
+files: 
+- lib/sinatra/rabbit.rb
+- lib/sinatra/rabbit/respond_to.rb
+- lib/sinatra/rabbit/url_for.rb
+- lib/sinatra/rabbit/validation.rb
+- sinatra-rabbit.gemspec
+- COPYING
+has_rdoc: true
+homepage: http://incubator.apache.org/deltacloud
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 8
+      - 1
+      version: 1.8.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Sinatra REST API DSL
+test_files: []
+