sinatra-rabbit 0.0.2 → 0.9

data/lib/sinatra/rabbit/base.rb

@@ -0,0 +1,123 @@
+#
+# 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 'sinatra/rabbit/dsl'
+require 'sinatra/rabbit/param'
+require 'sinatra/rabbit/base_collection'
+require 'sinatra/rabbit/validator'
+
+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 }
+    }
+
+    def self.configure(&block)
+      instance_eval(&block)
+    end
+
+    # Automatically register the DSL to Sinatra::Base if this
+    # module is included:
+    #
+    # Example:
+    #
+    #     class MyApp << Sinatra::Base
+    #       include Sinatra::Rabbit
+    #     end
+    #
+    def self.included(base)
+      base.register(DSL)
+    end
+
+    class Collection < BaseCollection
+
+      def self.generate(name, &block)
+        @name = name.to_sym
+        class_eval(&block)
+        self
+      end
+
+      def self.path; @name; end
+
+      def self.description(text)
+        @description = text
+      end
+
+      def self.operation(operation_name, &block)
+        @operations ||= []
+        if operation_registred?(operation_name)
+          raise "Operation #{operation_name} already register in #{self.name} collection"
+        end
+        operation = operation_class(self, operation_name).generate(self, operation_name, &block)
+        send(http_method_for(operation_name), route_for(path, operation_name), {}, &operation.control)
+        self
+      end
+
+      def self.operations; @operations; end
+
+      class Operation
+
+        def self.generate(collection, name, &block)
+          @name, @params = name, []
+          class_eval(&block)
+          self
+        end
+
+        def self.description(text)
+          @description = text
+        end
+
+        def self.control(&block)
+          params_def = @params
+          @control ||= Proc.new do
+            begin
+              Rabbit::Validator.validate!(params, params_def)
+            rescue => e
+              if e.kind_of? Rabbit::Validator::ValidationError
+                status e.http_status_code
+                halt
+              else
+                raise e
+              end
+            end
+            instance_eval(&block)
+          end
+        end
+
+        def self.param(*args)
+          @params << Rabbit::Param.new(*args)
+        end
+      end
+
+      private
+
+      def self.operation_registred?(name)
+        @operations.any? { |o| o.name == name }
+      end
+
+      # Create an unique class name for all operations within Collection class
+      def self.operation_class(collection_klass, operation_name)
+        collection_klass.const_set(operation_name.to_s.camelize + 'Operation', Class.new(Operation))
+      end
+
+    end
+  end
+end
+

data/lib/sinatra/rabbit/base_collection.rb

@@ -0,0 +1,49 @@
+#
+# 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.
+
+module Sinatra
+  module Rabbit
+
+    class BaseCollection < Sinatra::Base
+      attr_accessor :name, :description
+      attr_accessor :operations
+
+      set :views, Proc.new { File.join(File::dirname(__FILE__), "..", "..", "views") }
+      enable :method_overide
+
+      def self.route_for(collection, operation_name=nil)
+        if operation_name
+          o = Sinatra::Rabbit::STANDARD_OPERATIONS[operation_name]
+          operation_path = (o && o[:member]) ? operation_name.to_s : nil
+          id_param = (o && o[:collection]) ? nil : ":id"
+          [route_for(collection), id_param, operation_path].compact.join('/')
+        else
+          "/#{collection}"
+        end
+      end
+
+      def self.http_method_for(operation_name)
+        o = Sinatra::Rabbit::STANDARD_OPERATIONS[operation_name]
+        (o && o[:method]) ? o[:method] : :get
+      end
+
+      def self.collection_class(name)
+        Sinatra::Rabbit.const_set(name.to_s.camelize + 'Collection', Class.new(Collection))
+      end
+
+    end
+  end
+end

data/lib/sinatra/rabbit/dsl.rb

@@ -0,0 +1,46 @@
+#
+# 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.
+
+module Sinatra
+  module Rabbit
+    module DSL
+
+      # Create DSL wrapper for creating a new collection
+      #
+      # Example:
+      #
+      #     collection :images do
+      #       description "Images collection"
+      #
+      #       operation :index do
+      #         ...
+      #       end
+      #     end
+      def collection(name, &block)
+        @collections ||= []
+        @collections << (current_collection = BaseCollection.collection_class(name).generate(name, &block))
+        use current_collection
+      end
+
+      # Return all defined collections
+      #
+      def collections
+        @collections
+      end
+
+    end
+  end
+end

data/lib/sinatra/rabbit/param.rb

@@ -0,0 +1,49 @@
+#
+# 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.
+
+module Sinatra
+  module Rabbit
+    class Param
+      attr_reader :name, :klass, :required, :values, :description
+
+      def initialize(*args)
+        args.reverse!
+        @name, @klass = args.pop, args.pop
+        raise "DSL: You need to specify the name and param type (#{@name})" unless @name or @klass
+        parse_params!(args)
+      end
+
+      def required?; @required == true; end
+      def optional?; !required?; end
+      def enum?; !@values.nil?; end
+      def number?; [:integer, :float].include?(@klass); end
+
+      private
+
+      def parse_params!(args)
+        if args.pop == :required
+          @required = true
+        else
+          @required = false
+        end
+        @values = args.pop if args.last.kind_of? Array
+        @description = args.pop
+      end
+
+    end
+
+  end
+end

data/lib/sinatra/rabbit/validator.rb

@@ -0,0 +1,59 @@
+#
+# 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.
+
+module Sinatra
+  module Rabbit
+    module Validator
+
+      class ValidationError < StandardError
+        attr_reader :http_status_code
+        def initialize(code, message)
+          @http_status_code = code
+          super(message)
+        end
+      end
+
+      class RequiredParameter < ValidationError
+        def initialize(param_def, current_params)
+          super(400, "Required parameter '%s' not found in [%s]" % [param_def.name, current_params.keys.join(',')])
+        end
+      end
+
+      class InvalidValue < ValidationError
+        def initialize(param_def, current_value)
+          super(400, "Parameter '%s' value '%s' not found in list of allowed values [%s]" % [param_def.name,
+                                                                                      current_value, 
+                                                                                      param_def.values.join(',')]
+               )
+        end
+      end
+
+      def self.validate!(current_params, operation_params)
+        operation_params.select { |p| p.required? }.each do |p|
+          unless current_params.keys.include?(p.name.to_s)
+            raise RequiredParameter.new(p, current_params)
+          end
+        end
+        operation_params.select { |p| p.enum? }.each do |p|
+          if p.enum? and !p.values.include?(current_params[p.name.to_s])
+            raise InvalidValue.new(p, current_params[p.name.to_s])
+          end
+        end
+      end
+
+    end
+  end
+end

data/sinatra-rabbit.gemspec

@@ -1,6 +1,4 @@
 #
-# 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
@@ -19,31 +17,31 @@
 require 'rake'
 
 Gem::Specification.new do |s|
-  s.author = 'Red Hat, Inc.'
+  s.author = 'The Apache Software Foundation'
   s.homepage = "http://github.com/mifo/sinatra-rabbit"
-  s.email = 'deltacloud-dev@incubator.apache.org'
+  s.email = 'dev@deltacloud.apache.org'
   s.name = 'sinatra-rabbit'
+  s.require_path = 'lib'
+  s.platform    = Gem::Platform::RUBY
 
   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.2'
+  s.version = '0.9'
   s.date = Time.now
   s.summary = %q{Sinatra REST API DSL}
   s.files = FileList[
     'lib/sinatra/*.rb',
     'lib/sinatra/rabbit/*.rb',
+    'LICENSE',
+    'README.md',
     'sinatra-rabbit.gemspec',
   ].to_a
 
-  s.extra_rdoc_files = Dir["COPYING"]
+  s.extra_rdoc_files = Dir["LICENSE"]
   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')
-
+  s.add_runtime_dependency 'sinatra', '>= 1.3.0'
 end

metadata

@@ -1,121 +1,66 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sinatra-rabbit
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: '0.9'
+  prerelease: 
 platform: ruby
-authors: 
-- Red Hat, Inc.
+authors:
+- The Apache Software Foundation
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-01 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sinatra
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70240995322640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 9
-        - 4
-        version: 0.9.4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
   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
+  version_requirements: *70240995322640
+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: 
-- COPYING
-files: 
+extra_rdoc_files:
+- LICENSE
+files:
 - lib/sinatra/rabbit.rb
-- lib/sinatra/rabbit/url_for.rb
-- lib/sinatra/rabbit/validation.rb
-- lib/sinatra/rabbit/respond_to.rb
+- lib/sinatra/rabbit/base.rb
+- lib/sinatra/rabbit/base_collection.rb
+- lib/sinatra/rabbit/dsl.rb
+- lib/sinatra/rabbit/param.rb
+- lib/sinatra/rabbit/validator.rb
+- LICENSE
+- README.md
 - sinatra-rabbit.gemspec
-- COPYING
-has_rdoc: true
 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.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Sinatra REST API DSL
 test_files: []
-