Build Status

Sinatra::Rabbit

Sinatra::Rabbit is a Sinatra extensions that makes designing a REST API much easier and more fun.

Rabbit maps REST resources to 'collections'. Every collection then could define CRUD and other operations to manipulate with resource. Rabbit will handle parameter validation and capability checks for you, so you can focus on the structure and design of your REST API.

Once your REST API is designed, Rabbit will make it available as modular Sinatra application thus mountable to any Rack compatible container (Rails, Padrino...)

Original Rabbit idea has been taken from the Deltacloud API project. However this is an complete rewrite of the original Deltacloud Rabbit. The goal is to make Rabbit highly modular, so it can be used in other projects as well as in Deltacloud.

Full documentation: rubydoc.info/github/mifo/sinatra-rabbit

An example application (modular Deltacloud API) can be found here: github.com/mifo/deltacloud-modular

Features

  • Automatically generate proper path and use the right HTTP method for all CRUD operations:
    • operation :create is being mapped as 'POST /:collection'
    • operation :index is being mapped as 'GET /:collection'
    • operation :show is being mapped as 'GET /:collection/:id'
    • operation :update is being mapped as 'PATCH /:collection/:id'
    • operation :destroy is being mapped as 'DELETE /:collection/:id'
    • action :reboot is being mapped as 'POST /:collection/:id/reboot'
  • Automatically set the :id parameter for routes like :show or :destroy
  • Automatically validates the request parameter values
  • Allow to change the HTTP method (action :reboot, :http_method => :post)

  • Allow to check if operation is supported by the current resource

    
check_capability :for => lambda { |m| driver.respond_to? m }

collection :vms do
  action :stop, :with_capability => :stop do
    control do
      # ...
    end
  end
end

  • Allow to define groups of parameters as features and make them available if the current resource support them

  • Support the 'sub-collections' that might be defined on resouce

    
collection :buckets do
  collection :blobs, :with_id => :bucket_id do

    # GET /buckets/:bucket_id/blobs/:id
    operation :show do
      control { #... }
    end
  end

  # GET /buckets/:id
  operation :show do
    control { #... }
  end
end

  • Generate HEAD routes for all operations and collections to check if the route is available

  • Generate OPTIONS routes for all operations and collections

    • OPTIONS /:collection will return list of all operations (using 'Allow' header)
    • OPTIONS /:collection/:operation will return list of parameters defined for given operation (using 'Allow' header)

  • Allow to manipulate with the REST structure programmatically, to generate documentation or collect statistics

  • Include bunch of tests to prove it all works correctly

Configuration

Rabbit behavior can be customized using configure method:

Sinatra::Rabbit.configure do
  disable :head_routes      # This will disable automatic generation of HEAD routes
  disable :options_routes   # This will disable automatic generation of OPTIONS routes
  disable :documentation    # This will disable automatic generation of documentation routes
end

Operation specific 'features'

In some specific use-cases, you would like to have different set of parameters for operation, based on some condition of your system. To give you and example, in Deltacloud API project, we have support for different drivers. The project aims to give user full cross-cloud abstraction layer, however for some cloud providers the full abstraction is not possible and in this case we need to handle this using 'features'. It mean that some particular operations can have 'feature' assigned. If this 'feature' is supported by underlaying driver, then we add new parameters to that operations.

In sinatra-rabbit, you can define features for every model in this way:

class Sample < Sinatra::Base
  include Sinatra::Rabbit
  include Sinatra::Rabbit::Features

  features do
    feature :user_name, :for => :instances do
      operation :create do
        param :user_name, :string, :optional, "Allow to define user-defined name"
      end
    end
  end
end

You can also wrap features into 'if' block or put some conditions on top of this block to make it more flexible.

Tests

Project include set of minitest files located under 'tests/' directory. You can launch them by typing:

$ rake test:all

If you want to run just DSL tests:

$ rake test:dsl

If you want to test if Sinatra::Base works on your system correctly with Rabbit:

$ rake test:app

If you want to see code coverage, you must install the simplecov gem:

$ gem install simplecov
$ rake coverage

NOTE: The coverage reports are supported only on Ruby 1.9

TODO

  • Add documentation generation and routes for Rabbit based applications

Installation

  • gem install sinatra-rabbit

Usage

require 'sinatra/base'
require 'sinatra/rabbit'

class MySinatraApp < Sinatra::Base
  include Sinatra::Rabbit

  collection :images do
    description "Images description"

    collection :subcollection do
      description "Images subcollection"

      operation :index do
        description "Hello world"
        control do
          status 200
        end
      end
    end

    operation :index, :if => lambda { 1 == 1} do
      description "Index operation description"
      control do
        status 200
        "Hello from index operation"
      end
    end

    operation :show do
      description "Index operation description"
      param :id,  :string, :required
      param :r1,  :string, :optional, "Optional parameter"
      param :v1,  :string, :optional, [ 'test1', 'test2', 'test3' ], "Optional parameter"
      param :v2,  :string, :optional, "Optional parameter"
      control do
        "Hey #{params[:id]}"
      end
    end
  end
end

MySinatraApp.run!

License

                            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