angus 0.0.9 → 0.0.10

data/spec/functional/type_validation/definitions/admins/operations.yml

@@ -0,0 +1,70 @@
+show:
+  name: Get information about a given user.
+  description: >
+    Returns all the information about a given user.
+
+  path: /admins/:id
+  method: get
+  uri:
+    - element: user_id
+      description: User identifier.
+
+  response:
+    - element: profile
+      description: User profile.
+      required: true
+      type: user
+
+index:
+  name: Gets a list of users.
+  description: >
+    Returns all the information about all users.
+
+  path: /admins
+  method: get
+  request:
+    - element: requester_id
+      type: integer
+      required: true
+      description: User identifier.
+
+  response:
+    - element: users
+      description: Perfil del usuario
+      required: true
+      elements_type: user
+
+create:
+  name: Create a user with the given parameters.
+  description: >
+    Returns the recently created user.
+
+  path: /admins
+  method: post
+  request:
+    - element: name
+      type: string
+      required: true
+      description: User name.
+    - element: age
+      type: integer
+      required: true
+      description: User age.
+    - element: favorite_decimal
+      type: decimal
+      required: true
+      description: User favorite decimal number.
+    - element: birth_date
+      type: date
+      required: true
+      description: The last time that the user signed in.
+    - element: last_signed_in_at
+      type: datetime
+      required: true
+      description: The last time that the user signed in.
+
+  response:
+    - element: user
+      description: Perfil del usuario
+      required: true
+      elements_type: user

data/spec/functional/type_validation/definitions/representations.yml

@@ -0,0 +1,9 @@
+user:
+  - field: id
+    description: User identifier
+    required: true
+    type: integer
+  - field: name
+    description: User name
+    required: true
+    type: string

data/spec/functional/type_validation/definitions/service.yml

@@ -0,0 +1,3 @@
+service:   'Type Validation'
+code_name: 'type_validation'
+version:   '0.1'

data/spec/functional/type_validation/models/admin.rb

@@ -0,0 +1 @@
+Admin = Struct.new(:id, :name, :age)

data/spec/functional/type_validation/resources/admins.rb

@@ -0,0 +1,35 @@
+require_relative '../models/admin'
+
+
+class Admins < Angus::BaseResource
+
+  ADMINS = [
+    Admin.new(1, 'John Smith', 33),
+    Admin.new(2, 'John Doe', 44)
+  ]
+
+  def show
+    user = ADMINS.find { |user| user[:id] == params[:id].to_i }
+
+    {:profile => user}
+  end
+
+  def index
+    { :users => ADMINS }
+  end
+
+  def create
+    user = Admin.new(last_id, params[:name], params[:age])
+
+    { :user => user }
+  end
+
+  protected
+
+  # This is not a good practice is only for testing propose. Use an
+  #   autogenerated id (using db features).
+  def last_id
+    ADMINS.map {|user| user['id'] }.max + 1
+  end
+
+end

data/spec/functional/type_validation/services/type_validation.rb

@@ -0,0 +1,13 @@
+require 'angus'
+
+module Spec
+  module Functional
+
+    class TypeValidation < Angus::Base
+      def configure
+        register :admins
+      end
+    end
+
+  end
+end

data/spec/functional/type_validation_spec.rb

@@ -0,0 +1,283 @@
+require 'spec_helper'
+require 'rack/test'
+require 'functional/type_validation/services/type_validation'
+
+working_dir = "#{File.dirname(__FILE__ )}/type_validation"
+
+describe Spec::Functional::TypeValidation, { :work_dir => working_dir } do
+  include Rack::Test::Methods
+
+  subject(:app) { Rack::Lint.new(Spec::Functional::TypeValidation.new) }
+
+  describe 'required fields validation' do
+    it 'responds correctly if all required fields are given' do
+      get '/type_validation/api/0.1/admins?requester_id=1'
+
+      response = JSON(last_response.body)
+
+      expect(response['status']).to eq('success')
+    end
+
+    it 'responds with an error when a required field is not present' do
+      get '/type_validation/api/0.1/admins'
+
+      expect(last_response).to have_error_response
+      expect(last_response).to have_in_message({
+        'level' => 'error',
+        'key'   => 'TODO define',
+        'dsc'   => 'requester_id'
+      })
+    end
+  end
+
+  describe 'type fields validation' do
+    let(:valid_params) {
+      {
+        'name'              => 'Britney Watson',
+        'age'               => 22,
+        'favorite_decimal'  => 21.3,
+        'birth_date'        => Date.today.iso8601,
+        'last_signed_in_at' => DateTime.now.iso8601
+      }
+    }
+
+    context 'string type' do
+      it 'should be valid if a number is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'name' => 22
+        })
+
+        expect(last_response).to have_success_response
+      end
+
+      it 'should be valid if a text is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'name' => 'Example Text'
+        })
+
+        expect(last_response).to have_success_response
+      end
+
+      it 'should be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'name' => Date.today
+        })
+
+        expect(last_response).to have_success_response
+      end
+    end
+
+    context 'integer type' do
+      it 'should be valid if a number is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'age' => 22
+        })
+
+        expect(last_response).to have_success_response
+      end
+
+      it 'should not be valid if a decimal is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'age' => 22.1
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a text is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'age' => 'Example Text'
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'age' => Date.today
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+    end
+
+    context 'decimal type' do
+      it 'should be valid if a number is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'favorite_decimal' => 22
+        })
+
+        expect(last_response).to have_success_response
+      end
+
+      it 'should be valid if a decimal is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'favorite_decimal' => 22.1
+        })
+
+        expect(last_response).to have_success_response
+      end
+
+      it 'should not be valid if a text is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'favorite_decimal' => 'Example Text'
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'favorite_decimal' => Date.today
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+    end
+
+    context 'date type' do
+      it 'should be valid if a number is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'birth_date' => 22
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should be valid if a decimal is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'birth_date' => 22.1
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a text is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'birth_date' => 'Example Text'
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'birth_date' => Date.today.iso8601
+        })
+
+        expect(last_response).to have_success_response
+      end
+
+      it 'should not be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'birth_date' => DateTime.now.iso8601
+        })
+
+        expect(last_response).to have_success_response
+      end
+    end
+
+    context 'datetime type' do
+      it 'should be valid if a number is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'last_signed_in_at' => 22
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should be valid if a decimal is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'last_signed_in_at' => 22.1
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a text is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'last_signed_in_at' => 'Example Text'
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'last_signed_in_at' => Date.today.iso8601
+        })
+
+        expect(last_response).to have_error_response
+        expect(last_response).to have_in_message({
+          'level' => 'error',
+          'key'   => 'TODO define',
+          'dsc'   => 'TODO define'
+        })
+      end
+
+      it 'should not be valid if a date is given' do
+        post '/type_validation/api/0.1/admins', valid_params.merge({
+          'last_signed_in_at' => DateTime.now.iso8601
+        })
+
+        expect(last_response).to have_success_response
+      end
+    end
+  end
+
+end

data/spec/support/matchers/have_error_response_matcher.rb

@@ -0,0 +1,40 @@
+RSpec::Matchers.define :have_error_response do
+
+  match do |response|
+    begin
+      @json = JSON(response.body)
+
+      is_valid_response?
+    rescue JSON::ParserError => exception
+      @error = "Error will parsing response: #{exception.message}"
+    end
+  end
+
+  description do
+    'have error response'
+  end
+
+  failure_message_for_should do
+    if @error
+      @error
+    elsif @json && @json['status']
+      "expect #{@json['status']} to be error\n#{@json.inspect}"
+    else
+      "expect #{@json} to include status in it's keys"
+    end
+  end
+
+  failure_message_for_should_not do
+    if @error
+      @error
+    elsif @json && @json['status']
+      "expect #{@json['status']} to not be error\n#{@json.inspect}"
+    else
+      "expect #{@json} to include status in it's keys"
+    end
+  end
+
+  def is_valid_response?
+    @json && @json['status'] == 'error'
+  end
+end