dandy 0.12.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 47781859a32ae38be5a82a4548ee099ce2c745ea
-  data.tar.gz: b8488633a66da4c980fb3532df442713ae35747c
+SHA256:
+  metadata.gz: 10c1d06be946e67fdc9c9e2dd27e37015aa5c315006f153364f6a729eecadc8c
+  data.tar.gz: eb3055e8a23b44e78661f7ae89896bb96748fb71bb2dbd9122f5f9f6a4271a94
 SHA512:
-  metadata.gz: b9ca968a3acd135a2656309c9ca2dd28d4c426b82a7d1b683c502201eeddd2f66772e74e75dfbbb8c1fdd03f50e81323842034e85b59d303da4441bc1a189eb5
-  data.tar.gz: 7e802942e16d29e0de61a6c501bc62be98d5b1588028f2f1692894d2c633d6822de706d9a693c9d54dce750b317ca9b6aae5b5725f2161db87b8f26b00f0377f
+  metadata.gz: 40389e9152244e5949e539d18caa4fd35604286721d327543bc2e20765d078e4888f2da0225bd052f54ec0e817e4cef7b50b5cf1092afdd09e5aed9364da66e3
+  data.tar.gz: d6966b353e974d10a755677b84a1a5943a59cf2335eeec2a396203df118a03161fec03bd7f72b63a83467595d92ab019aac30c1d82412a9b5017e553bd8e43ae

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.4
+  - 2.6
+before_install: gem install bundler

data/README.md

@@ -2,7 +2,7 @@
 
 Dandy is a minimalistic web API framework. Its main idea is to implement an approach 
 from Clean Architecture principles - "web is just a delivery mechanism". 
-Dandy is build on top of IoC container Hypo and forces to use dependency injection 
+Dandy is build on top of IoC container [Hypo](https://github.com/cylon-v/hypo) and forces to use dependency injection 
 approach everywhere.  
 
 ## Basic Concepts
@@ -109,13 +109,14 @@ or just
     $ rackup -p 8000 config.ru
 ```
 
-4. Using a browser, go to http://localhost:8000 and you'll see: 
+4. Run curl command `curl http://localhost:8000 -H "Accept: application/json"` and you'll see: 
 
 ```json
   {"message": "Welcome to dandy-app!"}
 ```
+Please take attention - HTTP header "Accept: application/json" is a mandatory.
 
-5. Investigate example application code, it will explain most of Dandy aspects.
+5. Investigate example application code, it explains most of Dandy aspects.
 6. For more details visit our [Wiki](https://github.com/cylon-v/dandy/wiki).
 
 ## Development

data/dandy.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'hypo', '~> 0.9.0'
-  spec.add_dependency 'rack', '~> 2.0.3'
+  spec.add_dependency 'hypo', '~> 1.0.0'
+  spec.add_dependency 'rack', '~> 2.2.3'
   spec.add_dependency 'thor', '~> 0.20.0'
   spec.add_dependency 'treetop', '~> 1.6.8'
   spec.add_dependency 'jbuilder', '~> 2.7.0'
@@ -40,8 +40,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'awrence', '~> 1.0.0'
   spec.add_dependency 'plissken', '~> 1.2.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-mocks', '~> 3.6'
   spec.add_development_dependency  'simplecov', '~> 0.15'

data/lib/dandy/app.rb

@@ -9,9 +9,9 @@ require 'dandy/request'
 require 'dandy/template_registry'
 require 'dandy/view_builder_registry'
 require 'dandy/view_factory'
-require 'dandy/chain_factory'
 require 'dandy/view_builders/json'
 require 'dandy/routing/routing'
+require 'dandy/safe_executor'
 
 module Dandy
   class App
@@ -27,7 +27,7 @@ module Dandy
     end
 
     def call(env)
-      request = Request.new(@route_matcher, @container, @chain_factory, @view_factory)
+      request = Request.new(@route_matcher, @container, @safe_executor)
       request.handle(env)
     end
 
@@ -46,7 +46,8 @@ module Dandy
     def register_dependencies
       instances = {
         config_file_path: 'dandy.yml',
-        dandy_env: ENV['DANDY_ENV'] || 'development'
+        dandy_env: ENV['DANDY_ENV'] || 'development',
+        env: ENV
       }
 
       instances.keys.each do |name|
@@ -61,12 +62,12 @@ module Dandy
         template_registry: TemplateRegistry,
         view_builder_registry: ViewBuilderRegistry,
         view_factory: ViewFactory,
-        chain_factory: ChainFactory,
         file_reader: Routing::FileReader,
         syntax_parser: SyntaxParser,
         syntax_error_interpreter: Routing::SyntaxErrorInterpreter,
         routes_builder: Routing::Builder,
-        route_parser: Routing::Parser
+        route_parser: Routing::Parser,
+        safe_executor: SafeExecutor
       }
 
       singletons.keys.each do |name|
@@ -76,11 +77,12 @@ module Dandy
     end
 
     def load_basic_dependencies
-      @chain_factory = @container.resolve(:chain_factory)
+      @dandy_config = @container.resolve(:dandy_config)
       @view_factory = @container.resolve(:view_factory)
       @dependency_loader = @container.resolve(:dependency_loader)
       @view_builder_registry = @container.resolve(:view_builder_registry)
       @route_parser = @container.resolve(:route_parser)
+      @safe_executor = @container.resolve(:safe_executor)
 
       @dependency_loader.load_components
     end

data/lib/dandy/chain.rb

@@ -2,46 +2,23 @@ require 'timeout'
 
 module Dandy
   class Chain
-    def initialize(container, dandy_config, commands, last_command, catch_command = nil)
-      @commands = commands
-      @last_command = last_command
+    def initialize(container, dandy_config)
       @container = container
-      @catch_command = catch_command
       @async_timeout = dandy_config[:action][:async_timeout]
     end
 
-    def execute
-      if @catch_command.nil?
-        run_commands
-      else
-        begin
-          run_commands
-        rescue Exception => error
-          @container
-            .register_instance(error, :dandy_error)
-            .using_lifetime(:scope)
-            .bound_to(:dandy_request)
-
-          action = @container.resolve(@catch_command.name.to_sym)
-          action.call
-        end
-      end
-    end
-
-    private
-
-    def run_commands
+    def run_commands(commands, last_command)
       threads = []
       Thread.abort_on_exception = true
 
       result = nil
-      @commands.each_with_index do |command, index|
+      commands.each_with_index do |command, index|
         if command.sequential?
           # all previous parallel commands should be done before the current sequential
           threads.each {|t| t.join}
           threads = []
 
-          if @last_command && (command.name == @last_command.name)
+          if last_command && (command.name == last_command.name)
             result = run_command(command)
           else
             run_command(command)
@@ -49,7 +26,7 @@ module Dandy
         else
           thread = Thread.new {
             Timeout::timeout(@async_timeout) {
-              if @last_command && (command.name == @last_command.name)
+              if last_command && (command.name == last_command.name)
                 result = run_command(command)
               else
                 run_command(command)
@@ -60,7 +37,7 @@ module Dandy
         end
 
         # if it's last item in chain then wait until parallel commands are done
-        if index == @commands.length - 1
+        if index == commands.length - 1
           threads.each {|t| t.join}
         end
       end
@@ -68,6 +45,8 @@ module Dandy
       result
     end
 
+    private
+
     def run_command(command)
       if command.entity?
         entity = @container.resolve(command.entity_name.to_sym)

data/lib/dandy/generators/cli.rb

@@ -19,16 +19,19 @@ module Dandy
         copy_file 'templates/Gemfile_jet_set', "#{name}/Gemfile"
         copy_file 'templates/db/mapping.rb', "#{name}/db/mapping.rb"
         copy_file 'templates/actions/common/open_db_session.rb', "#{name}/app/actions/common/open_db_session.rb"
+        copy_file 'templates/actions/common/close_db_session.rb', "#{name}/app/actions/common/close_db_session.rb"
+        copy_file 'templates/actions/common/handle_errors_jet_set.rb', "#{name}/app/actions/common/handle_errors.rb"
+        copy_file 'templates/app/app.jet_set.routes', "#{name}/app/app.routes"
       else
         copy_file 'templates/app/app.rb', "#{name}/app/app.rb"
         copy_file 'templates/Gemfile', "#{name}/Gemfile"
+        copy_file 'templates/actions/common/handle_errors.rb', "#{name}/app/actions/common/handle_errors.rb"
+        copy_file 'templates/app/app.routes', "#{name}/app/app.routes"
       end
 
-      copy_file 'templates/app/app.routes', "#{name}/app/app.routes"
       copy_file 'templates/dandy.yml', "#{name}/dandy.yml"
       copy_file 'templates/config.ru', "#{name}/config.ru"
       copy_file 'templates/views/show_welcome.json.jbuilder', "#{name}/app/views/show_welcome.json.jbuilder"
-      copy_file 'templates/actions/common/handle_errors.rb', "#{name}/app/actions/common/handle_errors.rb"
       template 'templates/actions/welcome.tt', "#{name}/app/actions/welcome.rb", {app_name: name}
 
       if options[:jet_set]

data/lib/dandy/generators/templates/actions/common/close_db_session.rb

@@ -0,0 +1,12 @@
+require 'sequel'
+require 'jet_set'
+
+class CloseDbSession
+  def initialize(sequel)
+    @sequel = sequel
+  end
+
+  def call
+    @sequel.disconnect
+  end
+end

data/lib/dandy/generators/templates/actions/common/handle_errors_jet_set.rb

@@ -0,0 +1,20 @@
+class HandleErrors < Dandy::HandleErrors
+  def initialize(container, dandy_error, sequel)
+    super(container, dandy_error)
+
+    @sequel = sequel
+  end
+
+  def call
+    @sequel.disconnect
+
+    # implement your own error handling logic here.
+    # by default let's print the error to standard output
+    puts @dandy_error.message
+    puts @dandy_error.backtrace
+
+    # use preferred HTTP status code for different cases
+    # i.e. set_http_status(403) for authorization issue
+    set_http_status(500)
+  end
+end

data/lib/dandy/generators/templates/app/app.jet_set.routes

@@ -0,0 +1,7 @@
+:receive
+    .->
+        :before -> common/open_db_session
+        :after -> common/close_db_session
+
+        GET -> message@welcome -> :respond <- show_welcome
+:catch -> common/handle_errors

data/lib/dandy/loaders/type_loader.rb

@@ -9,8 +9,8 @@ module Dandy
       @directories.each do |directory|
         dir = File.join(directory, '**/*')
         files = Dir.glob(dir).reject {|file_path| File.directory?(file_path)}
-
-        files.each do |file|
+        test_patterns = %w(_spec.rb .spec.rb _test.rb .test.rb)
+        files.select {|f| !f.end_with?(*test_patterns)}.each do |file|
           path = File.join(Dir.pwd, file)
           require path
           file_name = File.basename(file).gsub(File.extname(file), '')

data/lib/dandy/request.rb

@@ -1,21 +1,19 @@
 require 'json'
+require 'awrence'
+require 'plissken'
 require 'rack/multipart'
 require 'dandy/extensions/hash'
-require 'dandy/chain_factory'
 require 'dandy/view_factory'
-require 'awrence'
-require 'plissken'
-
+require 'dandy/chain'
 
 module Dandy
   class Request
     include Hypo::Scope
 
-    def initialize(route_matcher, container, chain_factory, view_factory)
+    def initialize(route_matcher, container, safe_executor)
       @container = container
       @route_matcher = route_matcher
-      @chain_factory = chain_factory
-      @view_factory = view_factory
+      @safe_executor = safe_executor
     end
 
     def handle(rack_env)
@@ -31,42 +29,38 @@ module Dandy
            .collect {|k, v| [k.split('_').collect(&:capitalize).join('-'), v]}
            .flatten
       ]
-      register_params(headers, :dandy_headers)
+
+      register_context(headers, :dandy_headers)
 
       if match.nil?
         result = [404, {'Content-Type' => headers['Accept']}, []]
+        release
       else
+        status = match.route.http_status || default_http_status(match.route.http_verb)
+        register_params(match.params)
+        register_status(status)
+
         query = Rack::Utils.parse_nested_query(rack_env['QUERY_STRING']).to_snake_keys.symbolize_keys
-        register_params(query, :dandy_query)
+        register_context(query, :dandy_query)
 
         data = rack_env['rack.parser.result'] ? rack_env['rack.parser.result'].to_snake_keys.deep_symbolize_keys! : {}
-        register_params(data, :dandy_data)
+        register_context(data, :dandy_data)
 
         multipart = Rack::Multipart.parse_multipart(rack_env) || {}
-        register_params(multipart.values, :dandy_files)
-
-        chain = @chain_factory.create(match)
-        chain_result = chain.execute
-
-        if match.route.view
-          body = @view_factory.create(match.route.view, headers['Accept'], {keys_format: headers['Keys-Format'] || 'snake'})
-        else
-          if chain_result.is_a?(String)
-            body = chain_result
-          else # generate JSON when nothing other is requested
-            if headers['Keys-Format'] == 'camel' && chain_result
-              chain_result = chain_result.to_camelback_keys
-            end
-
-            body = JSON.generate(chain_result)
-          end
+        register_context(multipart.values, :dandy_files)
+
+        body = @safe_executor.execute(match.route, headers)
+
+        begin
+          release
+        rescue Exception => error
+          body = @safe_executor.handle_error(match.route, headers, error)
         end
 
         status = @container.resolve(:dandy_status)
-        result = [status, {'Content-Type' => headers['Accept']}, [body]]
+        result = [status, {'Content-Type' => 'application/json'}, [body]]
       end
 
-      release
 
       result
     end
@@ -80,12 +74,32 @@ module Dandy
         .bound_to(self)
     end
 
-    def register_params(params, name)
+    def register_context(params, name)
       unless params.nil?
         @container.register_instance(params, name)
           .using_lifetime(:scope)
           .bound_to(:dandy_request)
       end
     end
+
+    def register_params(params)
+      params.keys.each do |key|
+        @container
+          .register_instance(params[key], key.to_sym)
+          .using_lifetime(:scope)
+          .bound_to(:dandy_request)
+      end
+    end
+
+    def register_status(status)
+      @container
+        .register_instance(status, :dandy_status)
+        .using_lifetime(:scope)
+        .bound_to(:dandy_request)
+    end
+
+    def default_http_status(http_verb)
+      http_verb == 'POST' ? 201 : 200
+    end
   end
 end

data/lib/dandy/response.rb

@@ -0,0 +1,11 @@
+module Dandy
+  class Response
+    def self.format(result, headers)
+      if headers['Keys-Format'] == 'camel' && result
+        result = result.to_camelback_keys
+      end
+
+      JSON.generate(result)
+    end
+  end
+end

data/lib/dandy/safe_executor.rb

@@ -0,0 +1,39 @@
+require 'dandy/response'
+
+module Dandy
+  class SafeExecutor
+    def initialize(container, dandy_config, view_factory)
+      @container = container
+      @dandy_config = dandy_config
+      @view_factory = view_factory
+    end
+
+    def execute(route, headers)
+      chain = Chain.new(@container, @dandy_config)
+
+      begin
+        result = chain.run_commands(route.commands, route.last_command)
+        if route.view
+          result = @view_factory.create(route.view, headers['Accept'], {keys_format: headers['Keys-Format'] || 'snake'})
+        end
+
+        body = result.is_a?(String) ? result : Response.format(result, headers)
+      rescue Exception => error
+        p error
+        body = handle_error(route, headers, error)
+      end
+
+      body
+    end
+
+    def handle_error(route, headers, error)
+      @container
+        .register_instance(error, :dandy_error)
+        .using_lifetime(:scope)
+        .bound_to(:dandy_request)
+
+      action = @container.resolve(route.catch.name.to_sym)
+      Response.format(action.call, headers)
+    end
+  end
+end

data/lib/dandy/version.rb

@@ -1,3 +1,3 @@
 module Dandy
-  VERSION = '0.12.0'.freeze
+  VERSION = '1.0.3'
 end

data/lib/dandy/view_factory.rb

@@ -12,8 +12,14 @@ module Dandy
 
     def create(name, content_type, options = {})
       type = content_type ? content_type.split('/')[1] : 'json'
-      template = @template_registry.get(name, type)
       builder = @view_builder_registry.get(type)
+
+      if builder.nil?
+        type = 'json'
+        builder = @view_builder_registry.get(type)
+      end
+
+      template = @template_registry.get(name, type)
       view = builder.new(template, @container, options)
       view.process
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dandy
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Vladimir Kalinkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hypo
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 2.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.3
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -142,28 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -230,7 +230,6 @@ files:
 - lib/dandy/app.rb
 - lib/dandy/base/handle_errors.rb
 - lib/dandy/chain.rb
-- lib/dandy/chain_factory.rb
 - lib/dandy/config.rb
 - lib/dandy/errors/dandy_error.rb
 - lib/dandy/errors/syntax_error.rb
@@ -240,9 +239,12 @@ files:
 - lib/dandy/generators/templates/.gitignore
 - lib/dandy/generators/templates/Gemfile
 - lib/dandy/generators/templates/Gemfile_jet_set
+- lib/dandy/generators/templates/actions/common/close_db_session.rb
 - lib/dandy/generators/templates/actions/common/handle_errors.rb
+- lib/dandy/generators/templates/actions/common/handle_errors_jet_set.rb
 - lib/dandy/generators/templates/actions/common/open_db_session.rb
 - lib/dandy/generators/templates/actions/welcome.tt
+- lib/dandy/generators/templates/app/app.jet_set.routes
 - lib/dandy/generators/templates/app/app.rb
 - lib/dandy/generators/templates/app/app.routes
 - lib/dandy/generators/templates/app/app_jet_set.rb
@@ -254,6 +256,7 @@ files:
 - lib/dandy/loaders/template_loader.rb
 - lib/dandy/loaders/type_loader.rb
 - lib/dandy/request.rb
+- lib/dandy/response.rb
 - lib/dandy/routing/builder.rb
 - lib/dandy/routing/file_reader.rb
 - lib/dandy/routing/match.rb
@@ -288,6 +291,7 @@ files:
 - lib/dandy/routing/syntax/view.rb
 - lib/dandy/routing/syntax_error_interpreter.rb
 - lib/dandy/routing/syntax_grammar.tt
+- lib/dandy/safe_executor.rb
 - lib/dandy/template_registry.rb
 - lib/dandy/version.rb
 - lib/dandy/view_builder.rb
@@ -314,8 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Dandy is a minimalistic web API framework.

data/lib/dandy/chain_factory.rb

@@ -1,39 +0,0 @@
-require 'dandy/chain'
-
-module Dandy
-  class ChainFactory
-    def initialize(container, dandy_config)
-      @container = container
-      @dandy_config = dandy_config
-    end
-
-    def create(match)
-      status = match.route.http_status || default_http_status(match.route.http_verb)
-      register_params(match.params)
-      register_status(status)
-      Chain.new(@container, @dandy_config, match.route.commands, match.route.last_command, match.route.catch)
-    end
-
-    private
-
-    def register_params(params)
-      params.keys.each do |key|
-        @container
-          .register_instance(params[key], key.to_sym)
-          .using_lifetime(:scope)
-          .bound_to(:dandy_request)
-      end
-    end
-
-    def register_status(status)
-      @container
-        .register_instance(status, :dandy_status)
-        .using_lifetime(:scope)
-        .bound_to(:dandy_request)
-    end
-
-    def default_http_status(http_verb)
-      http_verb == 'POST' ? 201 : 200
-    end
-  end
-end