angus 0.0.1 → 0.0.2

data/lib/angus/rspec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'angus'
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }

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

@@ -0,0 +1,64 @@
+require 'rspec'
+
+require_relative 'examples/describe_errors'
+
+# Describes an operation
+#
+# Builds a describe block that:
+# - includes Rack::Test::Methods
+# - defines <b>app</b> method that returns the service
+# - defines <b>response</b> method
+#
+# @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)
+
+  describe(operation) do
+    include Rack::Test::Methods
+
+    define_method :app do
+      service
+    end
+
+    define_method :method_missing do |m, *args, &block|
+      if m.to_s =~ /_path$/
+	      service.public_send m, *args, &block
+      else
+	      super(m, *args, &block)
+      end
+    end
+
+    def response
+      if @response && @response.wraps?(last_response)
+        return @response
+      else
+        @response = OperationResponse.new(last_response)
+      end
+    end
+
+
+    define_singleton_method :describe_errors do |errors_spec|
+      errors_spec.each do |e, status_code|
+
+        __caller = caller[2..-1]
+        it "raises #{e} with status = #{status_code}", :caller => __caller do
+
+          Angus::RSpec::Examples::DescribeErrors.mock_service(service, e, self) do
+            get '/'
+
+            if response.http_status_code != status_code
+              e = RSpec::Expectations::ExpectationNotMetError.new(
+                "Expected status: #{status_code}, got: #{response.http_status_code}"
+              )
+              e.set_backtrace(__caller)
+              raise e
+            end
+          end
+
+        end
+      end
+    end
+
+    instance_eval(&block)
+  end
+end

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

@@ -0,0 +1,36 @@
+module Angus
+  module RSpec
+    module Examples
+      module DescribeErrors
+
+        # Mock a base service by redefining .app method, yields the given block, and
+        #   restores the original .app method
+        #
+        # @param [Class] Class that responds to .get
+        # @param error Exception that will be raised when executing a get route
+        # @param [#app] example Runing example
+        def self.mock_service(base, error, example, &block)
+
+          mock = Class.new(base) do
+            get '/' do
+              raise error
+            end
+          end
+
+          example.define_singleton_method :app do
+            mock
+          end
+
+          begin
+            yield
+          ensure
+            example.define_singleton_method :app do
+              base
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/angus/rspec/support/matchers/operation_response_matchers.rb

@@ -0,0 +1,117 @@
+require 'rspec'
+
+RSpec::Matchers.define :have_no_data do
+  match do |operation_response|
+    operation_response.body == {}
+  end
+
+  failure_message_for_should do |operation_response|
+    "expected that #{operation_response.body} would be {}"
+  end
+
+  failure_message_for_should_not do |operation_response|
+    "expected that #{operation_response.body} would not be {}"
+  end
+
+  description do
+    "have no data"
+  end
+end
+
+RSpec::Matchers.define :be_success do
+  match do |operation_response|
+    operation_response.success?
+  end
+
+  failure_message_for_should do |operation_response|
+    "expected that (#{operation_response.http_status_code}, #{operation_response.status}) would be (200, success)"
+  end
+
+  failure_message_for_should_not do |operation_response|
+    "expected that (#{operation_response.http_status_code}, #{operation_response.status}) would not be (200, success)"
+  end
+
+  description do
+    "be a (200, success) response"
+  end
+end
+
+RSpec::Matchers.define :be_forbidden do
+  match do |operation_response|
+    operation_response.forbidden?
+  end
+
+  failure_message_for_should do |operation_response|
+    "expected that (#{operation_response.http_status_code}, #{operation_response.status}) would be (403, error)"
+  end
+
+  failure_message_for_should_not do |operation_response|
+    "expected that (#{operation_response.http_status_code}, #{operation_response.status}) would not be (403, error)"
+  end
+
+  description do
+    "be a (403, error) response"
+  end
+end
+
+RSpec::Matchers.define :contain_message do |level = nil, key = nil, description = nil|
+  match do |operation_response|
+    operation_response.messages.find do |message|
+      level_and_key_matches = message['level'] == level.to_s && message['key'] == key
+     
+      description_matches = true
+
+      if level_and_key_matches && description.present?
+        description_matches = message['dsc'] == description
+      end
+
+      level_and_key_matches && description_matches
+    end
+  end
+
+  failure_message_for_should do |operation_response|
+    "message expected to contain #{level}, #{key}, #{description}"
+  end
+
+  failure_message_for_should_not do |operation_response|
+    "message expected to not contain #{level}, #{key}, #{description}"
+  end
+
+  description do
+    "contains a message"
+  end
+end
+
+RSpec::Matchers.define :contain_element do |name, *value|
+  match do |operation_response|
+    if value.empty?
+      operation_response.body.include?(name.to_s)
+    else
+      # we only take into account the first received value
+      first_value = value.first
+      operation_response.body[name.to_s] == first_value
+    end
+  end
+
+  failure_message_for_should do |operation_response|
+    message = "response expected to contain #{name}"
+    if !value.empty?
+      message += " = #{value}"
+    end
+
+    message
+  end
+
+  failure_message_for_should_not do |operation_response|
+    message = "response expected not to contain #{name}"
+    if !value.empty?
+      message += " = #{value}"
+    end
+
+    message
+  end
+
+  description do
+    "contains an element"
+  end
+end

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

@@ -0,0 +1,57 @@
+require 'json'
+
+require 'angus/responses'
+
+# Wraps the response return from an operation invocation
+class OperationResponse
+
+  def initialize(rack_response)
+    @rack_response = rack_response
+    @parsed_response = JSON(rack_response.body)
+  end
+
+  def body
+    @parsed_response
+  end
+
+  def messages
+    @parsed_response['messages'] || []
+  end
+
+  def wraps?(rack_response)
+    @rack_response == rack_response
+  end
+
+  def success?
+    @parsed_response['status'] == 'success' && 
+      http_status_code == Angus::Responses::HTTP_STATUS_CODE_OK
+  end
+
+  def forbidden?
+    @parsed_response['status'] == 'error' && 
+      http_status_code == Angus::Responses::HTTP_STATUS_CODE_FORBIDDEN
+  end
+
+  def not_found?
+    @parsed_response['status'] == 'error' && 
+      http_status_code == Angus::Responses::HTTP_STATUS_CODE_NOT_FOUND
+  end
+
+  def conflict?
+    @parsed_response['status'] == 'error' && 
+      http_status_code == Angus::Responses::HTTP_STATUS_CODE_CONFLICT
+  end
+
+  def unprocessable_entity?
+    @parsed_response['status'] == 'error' && 
+      http_status_code == Angus::Responses::HTTP_STATUS_CODE_UNPROCESSABLE_ENTITY
+  end
+
+  def http_status_code
+    @rack_response.status
+  end
+
+  def status
+    @parsed_response['status']
+  end
+end

data/lib/angus/utils.rb

@@ -0,0 +1,2 @@
+require_relative 'utils/params'
+require_relative 'utils/string'

data/lib/angus/utils/params.rb

@@ -0,0 +1,24 @@
+module Angus
+  module Params
+
+    # Enable string or symbol key access to the nested params hash.
+    def self.indifferent_params(object)
+      case object
+        when Hash
+          new_hash = indifferent_hash
+          object.each { |key, value| new_hash[key] = indifferent_params(value) }
+          new_hash
+        when Array
+          object.map { |item| indifferent_params(item) }
+        else
+          object
+      end
+    end
+
+    # Creates a Hash with indifferent access.
+    def self.indifferent_hash
+      Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
+    end
+
+  end
+end

data/lib/angus/utils/string.rb

@@ -0,0 +1,27 @@
+module Angus
+  module String
+
+    class << self
+
+      def underscore(string)
+        string.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr('-', '_').
+          downcase
+      end
+
+      def camelize(term, uppercase_first_letter = true)
+        string = term.to_s
+        if uppercase_first_letter
+          string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        else
+          string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { $&.downcase }
+        end
+        string.gsub(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }.gsub('/', '::')
+      end
+
+    end
+
+  end
+end

data/lib/angus/version.rb

@@ -1,3 +1,3 @@
 module Angus
-  VERSION = "0.0.1"
-end
+  VERSION = '0.0.2'
+end

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

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+require 'angus/rspec/support/examples/describe_errors'
+
+describe Angus::RSpec::Examples::DescribeErrors do
+
+  subject(:descriptor) { Angus::RSpec::Examples::DescribeErrors }
+
+  let(:base) do
+    Class.new do
+      def self.get(path, &block)
+        :get_v0
+      end
+    end
+  end
+
+  let(:error) { StandardError }
+
+  let(:example) { double(:example, :app => base) }
+
+  describe '.mock_service' do
+
+    it 'mocks app method' do
+      mocked_app = nil
+
+      descriptor.mock_service(base, error, example) do
+        mocked_app = example.app
+      end
+
+      mocked_app.should_not eq(base)
+    end
+
+    it 'binds to the original app method after running' do
+      example.app.should eq(base)
+      descriptor.mock_service(base, error, example) { }
+
+      example.app.should eq(base)
+    end
+
+    context 'when exception occurs' do
+      it 'binds to the original app method after running' do
+        example.app.should eq(base)
+
+        begin
+          descriptor.mock_service(base, error, example) do
+            raise StandardError
+          end
+        rescue
+        end
+
+        example.app.should eq(base)
+      end
+
+      it 'reraises the exception' do
+        expect {
+          descriptor.mock_service(base, error, example) do
+            raise StandardError
+          end
+        }.to raise_error(StandardError)
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+
+require 'simplecov-rcov'
+require 'simplecov-rcov-text'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::RcovFormatter,
+  SimpleCov::Formatter::RcovTextFormatter
+]
+
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+end

metadata

@@ -1,32 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: angus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
+- Pablo Ifran
 - Adrian Gomez
+- Gianfranco Zas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: angus-sdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: angus-router
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -43,22 +77,148 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Angus
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov-text
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: angus
 email:
-- adrian.gomez@moove-it.com
-executables: []
+- angus@moove-it.com
+executables:
+- angus
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- angus.gemspec
-- lib/angus.rb
+- lib/angus/responses.rb
+- lib/angus/marshallings/unmarshalling.rb
+- lib/angus/marshallings/marshalling.rb
+- lib/angus/marshallings/base.rb
+- lib/angus/generator.rb
 - lib/angus/version.rb
-homepage: ''
+- lib/angus/base_actions.rb
+- lib/angus/request_handler.rb
+- lib/angus/renders/html_render.rb
+- lib/angus/renders/base.rb
+- lib/angus/renders/json_render.rb
+- lib/angus/generator/templates/resources/resource.rb.erb
+- lib/angus/generator/templates/Gemfile
+- lib/angus/generator/templates/README.md
+- lib/angus/generator/templates/config.ru.erb
+- lib/angus/generator/templates/services/service.rb.erb
+- lib/angus/generator/templates/definitions/representations.yml
+- lib/angus/generator/templates/definitions/service.yml.erb
+- lib/angus/generator/templates/definitions/operations.yml.erb
+- lib/angus/generator/templates/definitions/messages.yml
+- lib/angus/base_resource.rb
+- lib/angus/command.rb
+- lib/angus/response.rb
+- lib/angus/rspec/support/examples/describe_errors.rb
+- lib/angus/rspec/support/matchers/operation_response_matchers.rb
+- lib/angus/rspec/support/operation_response.rb
+- lib/angus/rspec/support/examples.rb
+- lib/angus/rspec/spec_helper.rb
+- lib/angus/utils/string.rb
+- lib/angus/utils/params.rb
+- lib/angus/resource_definition.rb
+- lib/angus/utils.rb
+- lib/angus/base.rb
+- lib/angus.rb
+- spec/spec_helper.rb
+- spec/angus/rspec/examples/describe_errors_spec.rb
+- bin/angus
+homepage: http://mooveit.github.io/angus-sdoc
 licenses:
 - MIT
 post_install_message: 
@@ -82,5 +242,7 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Angus
-test_files: []
+summary: angus
+test_files:
+- spec/spec_helper.rb
+- spec/angus/rspec/examples/describe_errors_spec.rb