angus 0.0.13.beta3 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0186f917aedde0df96b6f5691bbeaf4ffd186d31
-  data.tar.gz: b98f2b08e8316181f8d800e99ba54b299d07d398
+  metadata.gz: 53c6533eb8c6aabf5133445668c3e81ccd7eae54
+  data.tar.gz: 755b9b7b34752eef87997c145b0d917f160ae382
 SHA512:
-  metadata.gz: 223c68ba16e11933c76a47605da7369741909bce4290cd37645a586b7a96fc57b76caebfae7a65bdc6e702438d1f205194c542538c0e31b4771a1b404216d849
-  data.tar.gz: 4741ca50f180b0b28c929d4df6501004399830aa951cf74d4028062c625c61211acb5bb1eecfa75b8800279b264354cf28eb329692a91fe1e67e6607c8285919
+  metadata.gz: 1805ca73f7cdc9a3a32dcb0ff4467a271520505224f9442462db7049d578163304c7d328a3a6edf908569df37b0d86d0698fa5c0e2a06e94576c87057f4cb3b4
+  data.tar.gz: 4c32905edd8769db1e4d1ad5067749749868d84f322e22f6187527eeca9476413ad9490fce3f4d6c3f15ee066869bfe8967cfd1aade3bf90f36e0864f99ac48c

data/lib/angus/base.rb

@@ -33,11 +33,14 @@ module Angus
 
     attr_accessor :default_doc_language
     attr_accessor :validate_params
+    attr_accessor :path_prefix
+    attr_accessor :root_path
 
     def initialize
       super
 
       @resources_definitions  = []
+      @root_path              ||= ''
       @version                = FIRST_VERSION
       @name                   = self.class.name.downcase
       @configured             = false
@@ -91,7 +94,15 @@ module Angus
     def configure!
       raise 'Already configured' if configured?
 
-      @definitions = Angus::SDoc::DefinitionsReader.service_definition('definitions')
+      definitions_path = if @root_path.empty?
+                           'definitions'
+                         else
+                           File.join(@root_path, 'definitions')
+                         end
+
+      @definitions = Angus::SDoc::DefinitionsReader.service_definition(definitions_path)
+
+      self.path_prefix ||= @definitions.code_name
 
       configure
 
@@ -107,13 +118,13 @@ module Angus
     end
 
     def register(resource_name, options = {})
-      resource_definition = ResourceDefinition.new(resource_name, @definitions)
+      resource_definition = ResourceDefinition.new(@root_path, resource_name, @definitions)
 
       @resources_definitions << resource_definition
     end
 
     def base_path
-      "/#{service_code_name}"
+      "/#@path_prefix"
     end
 
     def register_resource_routes(resource_definition)

data/lib/angus/base_resource.rb

@@ -1,7 +1,10 @@
 require 'yaml'
 
+require_relative 'request/json_params'
+
 module Angus
   class BaseResource
+    include Angus::Request::JsonParams
 
     def self.inherited(subclass)
       self._before_filers.each { |before_filer| subclass._before_filers << before_filer }

data/lib/angus/commands/server_command.rb

@@ -1,8 +1,14 @@
 module Angus
   class ServerCommand < Thor::Group
+    include Thor::Actions
+
+    class_option :port, desc: 'use PORT (default: 9292)', type: :string, required: false, default: '9292'
+    class_option :host, desc: 'listen on HOST (default: localhost)', type: :string, required: false, default: '0.0.0.0'
 
     def server
-      command_processor.run('rackup', verbose: false)
+      port_option = "-p #{options[:port]}" || ''
+      host_option = "--host #{options[:host]}" || ''
+      command_processor.run("rackup #{port_option} #{host_option}", verbose: false)
     end
 
     private

data/lib/angus/exceptions/invalid_request_format.rb

@@ -0,0 +1,11 @@
+module Angus
+  module Exceptions
+
+    class InvalidRequestFormat < StandardError
+      def message
+        'Invalid request format'
+      end
+    end
+
+  end
+end

data/lib/angus/exceptions/invalid_value_error.rb

@@ -0,0 +1,16 @@
+module Angus
+  module Exceptions
+
+    class InvalidValueError < StandardError
+      def initialize(param = nil, value = nil)
+        @param = param
+        @value = value
+      end
+
+      def message
+        "Invalid value #@value for param #@param"
+      end
+    end
+
+  end
+end

data/lib/angus/exceptions/missing_parameter_error.rb

@@ -0,0 +1,16 @@
+module Angus
+  module Exceptions
+
+    class MissingParameterError < StandardError
+
+      def initialize(parameter_name = nil)
+        @parameter_name = parameter_name
+      end
+
+      def message
+        "The parameter #@parameter_name is missing."
+      end
+    end
+
+  end
+end

data/lib/angus/middleware/exception_handler.rb

@@ -88,6 +88,8 @@ module Angus
       def additional_message_attributes(error)
         error_definition = error_definition(error)
 
+        return {} unless error_definition
+
         error_definition.fields.inject({}) do |attributes, field|
           attributes.merge!({ field.name => error.send(field.name)})
         end
@@ -133,4 +135,4 @@ module Angus
 
     end
   end
-end
+end

data/lib/angus/request/json_params.rb

@@ -0,0 +1,86 @@
+require_relative '../exceptions/invalid_request_format'
+require_relative '../exceptions/invalid_value_error'
+require_relative '../exceptions/missing_parameter_error'
+
+module Angus
+  module Request
+    module JsonParams
+
+      # Returns the json read from the request body.
+      #
+      # The keys for the json are symbolized.
+      #
+      # @return [Hash] The parsed request body.
+      #
+      # @raise [InvalidRequestFormat] When an invalid json is received.
+      def json_body
+        @json_body ||= JSON(request.body.read, :symbolize_names => true)
+      rescue JSON::ParserError
+        raise Angus::Exceptions::InvalidRequestFormat
+      end
+
+      # Parses a time param.
+      #
+      # @param [String, Symbol] param Parameter name.
+      # @param [Boolean] required When true, raises a MissingParameterError if param does not exist.
+      #
+      # @raise (see #get_json_param)
+      # @raise [InvalidValueError] when datetime is not parseable.
+      #
+      # @return [Time]
+      def get_json_datetime(param, required = false)
+        value = get_json_param(param, required)
+        Time.parse(value)
+      rescue ArgumentError
+        raise Angus::Exceptions::InvalidValueError.new(param, value)
+      end
+
+      # Parses an integer param.
+      #
+      # @param [String, Symbol] param Parameter name.
+      # @param [Boolean] required When true, raises a MissingParameterError if param does not exist.
+      #
+      # @raise (see #get_json_param)
+      # @raise [InvalidValueError] when value is not parseable.
+      #
+      # @return [Numeric]
+      def get_json_integer(param, required = false)
+        value = get_json_param(param, required)
+        Integer(value)
+      rescue ArgumentError
+        raise Angus::Exceptions::InvalidValueError.new(param, value)
+      end
+
+      # Returns the value of a given param.
+      #
+      # @param [Symbol] param Param name
+      #
+      # @raise [MissingParameterError] when required param not found
+      #
+      # @return Param's value
+      def get_json_param(param, required = false)
+        value = json_body[param.to_sym]
+
+        raise Angus::Exceptions::MissingParameterError.new(param) if required && value.blank?
+
+        value
+      end
+
+      # Parses a boolean param.
+      #
+      # @param [String, Symbol] param Parameter name.
+      # @param [Boolean] required When true, raises a MissingParameterError if param does not exist.
+      #
+      # @return [Boolean]
+      def get_json_boolean(param, required = true)
+        value = json_body[param.to_sym]
+
+
+        raise Angus::Exceptions::MissingParameterError.new(param) if required && value.nil?
+
+        value == 'true' || value == true
+      end
+
+    end
+  end
+end

data/lib/angus/resource_definition.rb

@@ -3,10 +3,11 @@ require 'yaml'
 module Angus
   class ResourceDefinition
 
-    def initialize(resource_name, representations)
-      @resource_name       = resource_name
-      @resource_class_name = classify_resource(resource_name)
-      @representations     = representations || {}
+    def initialize(root_path, resource_name, representations)
+      @root_path            = root_path
+      @resource_name        = resource_name
+      @resource_class_name  = classify_resource(resource_name)
+      @representations      = representations || {}
     end
 
     def operations
@@ -25,7 +26,13 @@ module Angus
     end
 
     def resource_path
-      File.join('resources', canonical_name)
+      resource_path = File.join('resources', canonical_name)
+
+      if @root_path.empty?
+        resource_path
+      else
+        File.join(@root_path, resource_path)
+      end
     end
 
     def build_response_metadata(response_representation)

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

@@ -36,6 +36,24 @@ RSpec::Matchers.define :be_success do
   end
 end
 
+RSpec::Matchers.define :be_unauthorized do
+  match do |operation_response|
+    operation_response.unauthorized?
+  end
+
+  failure_message_for_should do |operation_response|
+    "expected that (#{operation_response.http_status_code}, #{operation_response.status}) would be (401, unauthorized)"
+  end
+
+  failure_message_for_should_not do |operation_response|
+    "expected that (#{operation_response.http_status_code}, #{operation_response.status}) would not be (401, unauthorized)"
+  end
+
+  description do
+    'be a (401, unauthorized) response'
+  end
+end
+
 RSpec::Matchers.define :be_forbidden do
   match do |operation_response|
     operation_response.forbidden?
@@ -58,7 +76,7 @@ RSpec::Matchers.define :contain_message do |level = nil, key = nil, description
   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?

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

@@ -23,27 +23,32 @@ class OperationResponse
   end
 
   def success?
-    @parsed_response['status'] == 'success' && 
+    @parsed_response['status'] == 'success' &&
       http_status_code == Angus::Responses::HTTP_STATUS_CODE_OK
   end
 
+  def unauthorized?
+    @parsed_response['status'] == 'error' &&
+      http_status_code == Angus::Responses::HTTP_STATUS_CODE_UNAUTHORIZED
+  end
+
   def forbidden?
-    @parsed_response['status'] == 'error' && 
+    @parsed_response['status'] == 'error' &&
       http_status_code == Angus::Responses::HTTP_STATUS_CODE_FORBIDDEN
   end
 
   def not_found?
-    @parsed_response['status'] == 'error' && 
+    @parsed_response['status'] == 'error' &&
       http_status_code == Angus::Responses::HTTP_STATUS_CODE_NOT_FOUND
   end
 
   def conflict?
-    @parsed_response['status'] == 'error' && 
+    @parsed_response['status'] == 'error' &&
       http_status_code == Angus::Responses::HTTP_STATUS_CODE_CONFLICT
   end
 
   def unprocessable_entity?
-    @parsed_response['status'] == 'error' && 
+    @parsed_response['status'] == 'error' &&
       http_status_code == Angus::Responses::HTTP_STATUS_CODE_UNPROCESSABLE_ENTITY
   end
 

data/lib/angus/status_codes.rb

@@ -4,6 +4,7 @@ module Angus
     # TODO remove HTTP_STATUS from all constants
     HTTP_STATUS_CODE_OK                     = 200
 
+    HTTP_STATUS_CODE_UNAUTHORIZED           = 401
     HTTP_STATUS_CODE_FORBIDDEN              = 403
     HTTP_STATUS_CODE_NOT_FOUND              = 404
     HTTP_STATUS_CODE_CONFLICT               = 409

data/lib/angus/version.rb

@@ -1,3 +1,3 @@
 module Angus
-  VERSION = '0.0.13.beta3'
+  VERSION = '0.0.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: angus
 version: !ruby/object:Gem::Version
-  version: 0.0.13.beta3
+  version: 0.0.14
 platform: ruby
 authors:
 - Pablo Ifran
@@ -12,10 +12,11 @@ authors:
 - Guzman Iglesias
 - Martin Cabrera
 - Marcelo Casiraghi
+- Lucas Aragno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -207,6 +208,9 @@ files:
 - lib/angus/commands/server_command.rb
 - lib/angus/definition_reader.rb
 - lib/angus/exceptions.rb
+- lib/angus/exceptions/invalid_request_format.rb
+- lib/angus/exceptions/invalid_value_error.rb
+- lib/angus/exceptions/missing_parameter_error.rb
 - lib/angus/generator/templates/Gemfile.erb
 - lib/angus/generator/templates/README.md
 - lib/angus/generator/templates/config.ru.erb
@@ -228,6 +232,7 @@ files:
 - lib/angus/renders/base.rb
 - lib/angus/renders/html_render.rb
 - lib/angus/renders/json_render.rb
+- lib/angus/request/json_params.rb
 - lib/angus/request_handler.rb
 - lib/angus/resource_definition.rb
 - lib/angus/response.rb
@@ -305,58 +310,58 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A web services summary
 test_files:
+- spec/spec_helper.rb
 - spec/angus/middleware/exception_handler_spec.rb
 - spec/angus/request_handler_spec.rb
 - spec/angus/rspec/examples/describe_errors_spec.rb
-- spec/functional/basic/definitions/messages.yml
-- spec/functional/basic/definitions/representations.yml
-- spec/functional/basic/definitions/service.yml
-- spec/functional/basic/definitions/users/operations.yml
-- spec/functional/basic/exceptions/user_errors.rb
-- spec/functional/basic/models/user.rb
-- spec/functional/basic/resources/users.rb
-- spec/functional/basic/services/basic.rb
+- spec/support/matchers/have_in_message_matcher.rb
+- spec/support/matchers/have_error_response_matcher.rb
+- spec/support/matchers/have_success_response_matcher.rb
 - spec/functional/basic_spec.rb
-- spec/functional/empty_resource/definitions/messages.yml
-- spec/functional/empty_resource/definitions/representations.yml
-- spec/functional/empty_resource/definitions/service.yml
-- spec/functional/empty_resource/definitions/users/operations.yml
-- spec/functional/empty_resource/resources/users.rb
-- spec/functional/empty_resource/services/empty_resource.rb
-- spec/functional/empty_resource_spec.rb
+- spec/functional/filters/resources/users.rb
+- spec/functional/filters/models/user.rb
+- spec/functional/filters/exceptions/user_errors.rb
 - spec/functional/filters/definitions/messages.yml
-- spec/functional/filters/definitions/representations.yml
 - spec/functional/filters/definitions/service.yml
 - spec/functional/filters/definitions/users/operations.yml
-- spec/functional/filters/exceptions/user_errors.rb
-- spec/functional/filters/models/user.rb
-- spec/functional/filters/resources/users.rb
+- spec/functional/filters/definitions/representations.yml
 - spec/functional/filters/services/filters.rb
-- spec/functional/filters_spec.rb
-- spec/functional/no_resources/definitions/messages.yml
-- spec/functional/no_resources/definitions/representations.yml
-- spec/functional/no_resources/definitions/service.yml
-- spec/functional/no_resources/services/no_resources.rb
-- spec/functional/no_resources_spec.rb
-- spec/functional/type_validation/definitions/admins/operations.yml
+- spec/functional/type_validation/resources/admins.rb
+- spec/functional/type_validation/models/admin.rb
 - spec/functional/type_validation/definitions/messages.yml
-- spec/functional/type_validation/definitions/representations.yml
+- spec/functional/type_validation/definitions/admins/operations.yml
 - spec/functional/type_validation/definitions/service.yml
-- spec/functional/type_validation/models/admin.rb
-- spec/functional/type_validation/resources/admins.rb
+- spec/functional/type_validation/definitions/representations.yml
 - spec/functional/type_validation/services/type_validation.rb
+- spec/functional/empty_resource_spec.rb
+- spec/functional/basic/resources/users.rb
+- spec/functional/basic/models/user.rb
+- spec/functional/basic/exceptions/user_errors.rb
+- spec/functional/basic/definitions/messages.yml
+- spec/functional/basic/definitions/service.yml
+- spec/functional/basic/definitions/users/operations.yml
+- spec/functional/basic/definitions/representations.yml
+- spec/functional/basic/services/basic.rb
 - spec/functional/type_validation_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/have_error_response_matcher.rb
-- spec/support/matchers/have_in_message_matcher.rb
-- spec/support/matchers/have_success_response_matcher.rb
+- spec/functional/no_resources_spec.rb
+- spec/functional/no_resources/definitions/messages.yml
+- spec/functional/no_resources/definitions/service.yml
+- spec/functional/no_resources/definitions/representations.yml
+- spec/functional/no_resources/services/no_resources.rb
+- spec/functional/filters_spec.rb
+- spec/functional/empty_resource/resources/users.rb
+- spec/functional/empty_resource/definitions/messages.yml
+- spec/functional/empty_resource/definitions/service.yml
+- spec/functional/empty_resource/definitions/users/operations.yml
+- spec/functional/empty_resource/definitions/representations.yml
+- spec/functional/empty_resource/services/empty_resource.rb