sinatra-rabbit 1.0 → 1.0.1

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/mifo/sinatra-rabbit.png?branch=master)](http://travis-ci.org/mifo/sinatra-rabbit)
+
 Sinatra::Rabbit
 =============
 
@@ -17,6 +19,9 @@ as well as in Deltacloud.
 
 Full documentation: [rubydoc.info/github/mifo/sinatra-rabbit](http://rubydoc.info/github/mifo/sinatra-rabbit/master)
 
+An example application (modular Deltacloud API) can be found here:
+[github.com/mifo/deltacloud-modular](https://github.com/mifo/deltacloud-modular)
+
 Features
 -------
 

data/lib/sinatra/rabbit/base.rb

@@ -32,10 +32,31 @@ module Sinatra
   module Rabbit
 
     STANDARD_OPERATIONS = {
-      :create => { :member => false, :method => :post, :collection => true },
-      :show => { :member => false, :method => :get },
-      :destroy => { :member => false, :method => :delete },
-      :index => { :member => false, :method => :get, :collection => true }
+      :create => {
+        :member => false,
+        :method => :post,
+        :collection => true
+      },
+      :show => {
+        :member => false,
+        :method => :get,
+        :required_params => [ :id ]
+      },
+      :destroy => {
+        :member => false,
+        :method => :delete,
+        :required_params => [ :id ]
+      },
+      :index => {
+        :member => false,
+        :method => :get,
+        :collection => true
+      },
+      :update => {
+        :member => false,
+        :method => :patch,
+        :required_params => [ :id ] 
+      }
     }
 
     def self.configure(&block)
@@ -156,6 +177,7 @@ module Sinatra
         Rabbit::Documentation.for_collection(self, operations)
       end
 
+
       def self.operation(operation_name, opts={}, &block)
         @operations ||= []
         # Return operation when no block is given
@@ -167,7 +189,8 @@ module Sinatra
         end
 
         # Create operation class
-        @operations << (operation = operation_class(self, operation_name).generate(self, operation_name, &block))
+        operation = operation_class(self, operation_name).generate(self, operation_name, &block)
+        @operations << operation
 
         # Generate HEAD routes
         unless Rabbit.disabled? :head_routes
@@ -187,8 +210,13 @@ module Sinatra
         # Make the full_path method on operation return currect operation path
         operation.set_route(root_path + route_for(path, operation_name, :id_name => @with_id || ':id'))
 
+        # Change the HTTP method to POST automatically for 'action' operations
+        if opts[:http_method]
+          operation.http_method(opts.delete(:http_method))
+        end
+
         # Define Sinatra::Base route
-        base_class.send(http_method_for(operation_name), operation.full_path, opts, &operation.control)
+        base_class.send(operation.http_method || http_method_for(operation_name), operation.full_path, opts, &operation.control)
 
         # Generate OPTIONS routes
         unless Rabbit.disabled? :options_routes
@@ -199,6 +227,11 @@ module Sinatra
         self
       end
 
+      def self.action(action_name, opts={}, &block)
+        opts.merge!(:http_method => :post)
+        operation(action_name, opts, &block)
+      end
+
       def self.operations; @operations; end
 
       class Operation
@@ -207,6 +240,10 @@ module Sinatra
           @operation_path = path
         end
 
+        def self.http_method(method=nil)
+          @method ||= method || BaseCollection.http_method_for(@name)
+        end
+
         def self.generate(collection, name, &block)
           @name, @params, @collection = name, [], collection
           @collection.features.select { |f| f.operations.map { |o| o.name}.include?(@name) }.each do |feature|
@@ -214,7 +251,14 @@ module Sinatra
               instance_eval(&o.params)
             end
           end
+          if Sinatra::Rabbit::STANDARD_OPERATIONS.has_key? name
+            required_params = Sinatra::Rabbit::STANDARD_OPERATIONS[name][:required_params]
+            required_params.each do |p|
+              param p, :required, :string, "The #{p} parameter"
+            end unless required_params.nil?
+          end
           class_eval(&block)
+          description "#{name.to_s.capitalize} operation on #{@collection.name} collection" if description.nil?
           self
         end
 

data/sinatra-rabbit.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
     a simple REST API using easy to undestand DSL.
   EOF
 
-  s.version = '1.0'
+  s.version = '1.0.1'
   s.date = Time.now
   s.summary = %q{Sinatra REST API DSL}
   s.files = FileList[

metadata

@@ -1,46 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sinatra-rabbit
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 1.0.1
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  version: "1.0"
 platform: ruby
-authors: 
+authors:
 - The Apache Software Foundation
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-14 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sinatra
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70156043073960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :runtime
-  version_requirements: *id001
-description: "    Rabbit is a Sinatra extension which can help you writing\n    a simple REST API using easy to undestand DSL.\n"
+  prerelease: false
+  version_requirements: *70156043073960
+description: ! "    Rabbit is a Sinatra extension which can help you writing\n    a
+  simple REST API using easy to undestand DSL.\n"
 email: dev@deltacloud.apache.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
-files: 
+files:
 - lib/sinatra/rabbit.rb
 - lib/sinatra/rabbit/base.rb
 - lib/sinatra/rabbit/base_collection.rb
@@ -53,38 +42,26 @@ files:
 - sinatra-rabbit.gemspec
 homepage: http://github.com/mifo/sinatra-rabbit
 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 
-      hash: 53
-      segments: 
-      - 1
-      - 8
-      - 1
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.1
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Sinatra REST API DSL
 test_files: []
-