angus 0.0.9 → 0.0.10

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTQ5Yzg0NjIyMTE1Y2MyMTA3MjkwM2VlMTFkOTNkMGY0NDIyYmYwNw==
+  data.tar.gz: !binary |-
+    NzEzOTg0NzJjZGY5NjA3ZmVkNTg1MGFhNTExZDU0Yzk5OTQ3OTlhNw==
+SHA512:
+  metadata.gz: !binary |-
+    OGJkNzEyZWYzMWNhM2U1OGE5NmNiM2U3MDc4NGQ2Yzc2ZTY2OWI3MmZlN2Nm
+    ZmZjNjUyZjNlMDY3YTkwZTg5ODNiMjZjMjQ5YmI1NjE0ZTk2M2E3MmQzN2Jj
+    ZGFjZTAwMGFhN2U1OTM4NjQ5ZjA4OWQ3NDQzYmZmNGUzNDZiMTc=
+  data.tar.gz: !binary |-
+    MjVjMTQ5ZmRmYWE2NzMzYTJkNzAwYzc2MmQ3N2RhNjE2ODU4MzliMTYzYjcx
+    ODM5Njk0YmJhNDkyY2ZlYTgxZTE3ZTg1ZmY2YTc3ODQyMjM4OWU1Yjc4MmZl
+    YzQ1M2E0MmM1NTkwMzM1N2RiZDA3YWQ2Mzg5ZjlmZDM2MzdhY2I=

data/lib/angus/base.rb

@@ -12,6 +12,8 @@ require_relative 'base_actions'
 require_relative 'proxy_actions'
 require_relative 'definition_reader'
 
+require_relative 'utils/params_validator'
+
 require 'angus/sdoc'
 
 module Angus
@@ -120,11 +122,12 @@ module Angus
         response_metadata = resource_definition.build_response_metadata(operation.response_elements)
 
         router.on(method, op_path) do |env, params|
-          request = Rack::Request.new(env)
-          params = Params.indifferent_params(params)
+          request  = Rack::Request.new(env)
+          params   = Params.indifferent_params(params)
           response = Response.new
 
-          resource = resource_definition.resource_class.new(request, params)
+          resource = resource_definition.resource_class.new(request, params, operation)
+          resource.run_validations!
 
           op_response = resource.send(operation.code_name)
           op_response = {} unless op_response.is_a?(Hash)

data/lib/angus/base_proxy.rb

@@ -0,0 +1,20 @@
+module Angus
+
+  class BaseProxy
+
+    def initialize(request_handler, definition_block)
+      @request_handler = request_handler
+      @definition_block = definition_block
+    end
+
+    def call(env)
+      @request_handler.dup.call!(env)
+    end
+
+    def definitions
+      @definition_block.call
+    end
+
+  end
+
+end

data/lib/angus/base_resource.rb

@@ -5,9 +5,14 @@ module Angus
 
     attr_reader :request, :params
 
-    def initialize(request, params)
-      @request = request
-      @params = params
+    def initialize(request, params, operation)
+      @request   = request
+      @params    = params
+      @operation = operation
+    end
+
+    def run_validations!
+      ParamsValidator.new(@operation).valid?(@params)
     end
 
   end

data/lib/angus/generator/templates/definitions/operations.yml.erb

@@ -17,8 +17,10 @@
       required: <%= response_required(action_name) %>
       type: <%= response_type(action_name) %>
 
+  <% if is_demo? %>
   messages:
     - key: <%= message_key(action_name) %>
       description: '<%= message_description(action_name) %>'
+  <% end %>
 <% end %>
 <% end %>

data/lib/angus/generator/templates/resources/resource.rb.erb

@@ -3,9 +3,9 @@ class <%= classify(resource_name) %> < Angus::BaseResource
 <% actions.each do |action_name| %>
   def <%= action_name %>
   <% if is_demo? -%>
-  { users: [{ id: 1, name: 'User one' }, { id: 2, name: 'User two' }] }
+  { users: [{ id: 1, name: 'Bon Scott' }, { id: 2, name: 'Brian Johnson' }] }
   <% end -%>
 end
 <% end %>
 <% end -%>
-end
+end

data/lib/angus/generator/thor/resource.rb

@@ -11,7 +11,7 @@ class Thor
     #
     # @example
     #
-    #   resource 'user', 'resouces', 'definitions'
+    #   resource 'user', 'resources', 'definitions'
     #
     def resource(name, actions, config = {})
       action Resource.new(self, name, actions, config)

data/lib/angus/middleware/exception_handler.rb

@@ -8,9 +8,9 @@ module Angus
     class ExceptionHandler
       include Angus::StatusCodes
 
-      def initialize(app, definitions = nil)
+      def initialize(app)
         @app = app
-        @definition_reader = Angus::DefinitionReader.new(definitions)
+        @definition_reader = Angus::DefinitionReader.new(app.base_middleware.definitions)
       end
 
       def call(env)

data/lib/angus/request_handler.rb

@@ -4,6 +4,7 @@ require_relative 'response'
 require_relative 'responses'
 require_relative 'middleware/exception_handler'
 require_relative 'exceptions'
+require_relative 'base_proxy'
 
 module Angus
   class RequestHandler
@@ -30,17 +31,16 @@ module Angus
     end
 
     def to_app
-      inner_app = lambda { |env| self.dup.call!(env) }
+      inner_app = BaseProxy.new(self, lambda { @definitions })
+
       @app ||= @middleware.reverse.inject(inner_app) do |app, middleware|
         klass, args, block = middleware
 
-        # HACK to improve performance for now, in reality Middleware::ExceptionHandler should get
-        # the doc from a know place or the documentation should be available to all middleware.
-        if klass == Middleware::ExceptionHandler
-          klass.new(app, @definitions)
-        else
-          klass.new(app, *args, &block)
+        app.class.send(:define_method, :base_middleware) do
+          inner_app
         end
+
+        klass.new(app, *args, &block)
       end
     end
 

data/lib/angus/rspec/support/examples.rb

@@ -11,7 +11,8 @@ require_relative 'examples/describe_errors'
 #
 # @param operation the operation being specified, ex: GET /profiles
 # @param service the Service (rack app) that exposes the operation
-def describe_operation(operation, service, &block)
+def describe_operation(operation, service_class, &block)
+  service = service_class.new
 
   describe(operation) do
     include Rack::Test::Methods
@@ -44,7 +45,7 @@ def describe_operation(operation, service, &block)
         it "raises #{e} with status = #{status_code}", :caller => __caller do
 
           Angus::RSpec::Examples::DescribeErrors.mock_service(service, e, self) do
-            get '/'
+            get '/error'
 
             if response.http_status_code != status_code
               e = RSpec::Expectations::ExpectationNotMetError.new(

data/lib/angus/rspec/support/examples/describe_errors.rb

@@ -8,17 +8,34 @@ module Angus
         #
         # @param [Class] Class that responds to .get
         # @param error Exception that will be raised when executing a get route
-        # @param [#app] example Runing example
+        # @param [#app] example Running example
         def self.mock_service(base, error, example, &block)
 
-          mock = Class.new(base) do
-            get '/' do
-              raise error
+          base_class = if base.is_a?(Class)
+                         base
+                       else
+                         base.class
+                       end
+
+          mock = Class.new(base_class) do
+            def initialize(base, error)
+              @base = base
+              @error = error
+
+              super()
+
+              router.on(:get, '/error') do
+                raise error
+              end
+            end
+
+            def class
+              @base
             end
           end
 
           example.define_singleton_method :app do
-            mock
+            mock.new(base_class, error)
           end
 
           begin
@@ -33,4 +50,4 @@ module Angus
       end
     end
   end
-end
+end

data/lib/angus/utils/exceptions/invalid_parameter_type.rb

@@ -0,0 +1,18 @@
+module Angus
+  class InvalidParameterType < StandardError
+
+    def initialize(field, param)
+      @field = field
+      @param = param
+    end
+
+    def error_key
+      'TODO define'
+    end
+
+    def message
+      'TODO define'
+    end
+
+  end
+end

data/lib/angus/utils/exceptions/required_parameter_not_fond.rb

@@ -0,0 +1,19 @@
+module Angus
+  class RequiredParameterNotFound < StandardError
+
+    attr_accessor :not_found_parameters
+
+    def initialize(not_found_parameters)
+      @not_found_parameters = not_found_parameters
+    end
+
+    def error_key
+      'TODO define'
+    end
+
+    def message
+      @not_found_parameters.map(&:name).join(', ')
+    end
+
+  end
+end

data/lib/angus/utils/params_validator.rb

@@ -0,0 +1,81 @@
+require_relative 'exceptions/required_parameter_not_fond'
+require_relative 'exceptions/invalid_parameter_type'
+
+module Angus
+  class ParamsValidator
+
+    DEFAULT_DATE_FORMAT     = '%Y-%m-%d'
+    DEFAULT_DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S%z'
+
+    def initialize(operation)
+      @operation        = operation
+      @request_elements = operation.request_elements
+    end
+
+    def valid?(params)
+      all_required_fields?(params)
+      all_valid_types?(params)
+    end
+
+    def all_required_fields?(params)
+      required_fields = @request_elements.select(&:required)
+
+      no_found_parameters = required_fields.select {|rf| !params.include?(rf.name.to_sym) }
+
+      unless no_found_parameters.empty?
+        raise RequiredParameterNotFound.new(no_found_parameters)
+      end
+    end
+
+    def all_valid_types?(params)
+      @request_elements.each do |field|
+        type = field.type
+        method_name = "valid_#{type}?"
+
+        if self.respond_to?(method_name)
+          param = params[field.name.to_sym]
+
+          valid = self.send(method_name, field, param)
+
+          raise InvalidParameterType.new(field, param) unless valid
+        else
+          # TODO handle complex types
+        end
+      end
+    end
+
+    # String are all ways valid
+    def valid_string?(field, param)
+      true
+    end
+
+    def valid_integer?(field, param)
+      !!(param =~ /^[-+]?[0-9]+$/)
+    end
+
+    def valid_decimal?(field, param)
+      !!(param =~/^[-+]?([0-9]+(\.[0-9]+)?$)/)
+    end
+
+    def valid_date?(field, param)
+      begin
+        Date.strptime(param, DEFAULT_DATE_FORMAT)
+
+        true
+      rescue ArgumentError
+        false
+      end
+    end
+
+    def valid_datetime?(field, param)
+      begin
+        DateTime.strptime(param, DEFAULT_DATETIME_FORMAT)
+
+        true
+      rescue ArgumentError
+        false
+      end
+    end
+
+  end
+end

data/spec/angus/middleware/exception_handler_spec.rb

@@ -1,11 +1,26 @@
 require 'spec_helper'
 
+require 'angus/base_proxy'
 require 'angus/middleware/exception_handler'
 
 work_dir =  File.join(File.dirname(__FILE__), '..', '..', 'functional', 'basic')
 describe Angus::Middleware::ExceptionHandler, { :work_dir => work_dir } do
 
-  let(:app) { double(:app, :call => app_response) }
+  let(:request_handler) {
+    double(:request_handler, call: double(:app))
+  }
+
+  let(:definition_block) {
+    double(:definition_handler, call: nil)
+  }
+
+  let(:base_proxy) {
+    Angus::BaseProxy.new(request_handler, definition_block)
+  }
+
+  let(:app) {
+    double(:app, :call => app_response,
+                 :base_middleware => base_proxy) }
 
   let(:app_response) { :ok }
 

data/spec/angus/rspec/examples/describe_errors_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 
+require 'angus-router'
+
 require 'angus/rspec/support/examples/describe_errors'
 
 describe Angus::RSpec::Examples::DescribeErrors do
@@ -11,6 +13,10 @@ describe Angus::RSpec::Examples::DescribeErrors do
       def self.get(path, &block)
         :get_v0
       end
+
+      def router
+        @router ||= Angus::Router.new
+      end
     end
   end
 

data/spec/functional/basic_spec.rb

@@ -32,7 +32,7 @@ describe Spec::Functional::Basic, { :work_dir => "#{File.dirname(__FILE__ )}/bas
     end
 
     context 'when no format' do
-      it 'sets a html content type' do
+      it 'sets an html content type' do
         get '/basic/doc/0.1'
 
         last_response.header['Content-Type'].should eq('text/html;charset=utf-8')
@@ -63,7 +63,7 @@ describe Spec::Functional::Basic, { :work_dir => "#{File.dirname(__FILE__ )}/bas
       last_response.header['Content-Type'].should eq('application/json')
     end
 
-    context 'when a expected error happens' do
+    context 'when an expected error happens' do
       it 'sets the correct status code' do
         get '/basic/api/0.1/users/-1'
 

data/spec/functional/empty_resource_spec.rb

@@ -16,7 +16,7 @@ describe Spec::Functional::EmptyResource,
     last_response.status.should eq(200)
   end
 
-  describe 'when a unknown url' do
+  describe 'when an unknown url' do
 
     let(:url) { '/empty_resource/api/0.1/unknown' }
 
@@ -45,7 +45,7 @@ describe Spec::Functional::EmptyResource,
     end
 
     context 'when no format' do
-      it 'sets a html content type' do
+      it 'sets an html content type' do
         get url
 
         last_response.header['Content-Type'].should eq('text/html;charset=utf-8')

data/spec/functional/no_resources_spec.rb

@@ -16,7 +16,7 @@ describe Spec::Functional::NoResources,
     last_response.status.should eq(200)
   end
 
-  describe 'when a unknown url' do
+  describe 'when an unknown url' do
 
     let(:url) { '/no_resources/api/0.1/unknown' }
 
@@ -45,7 +45,7 @@ describe Spec::Functional::NoResources,
     end
 
     context 'when no format' do
-      it 'sets a html content type' do
+      it 'sets an html content type' do
         get url
 
         last_response.header['Content-Type'].should eq('text/html;charset=utf-8')