modern 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2758b166b5113cad1819574884d04dafe166f70033e87cfcf54fc0615a33b7f6
+  data.tar.gz: df1d24226b92fbfb1ec37a06e802390857a5a86d0cfc2ab56ac20dc669d49dc6
+SHA512:
+  metadata.gz: b3fdfd253b7f161a2f850a4a71dcd4effa39d0561b0ebbd1d2203a2fa7801c250d333fc4f9e69d7072f2dfa41d9937a112b97052f08bd030ec64a122dd4a0458
+  data.tar.gz: 23291ac933a23779d4d5b762020f1fc67a42e5585b05593801f760aee8b2ed6cd7f850b3a21bd6d26f8ed0080dfbdbf7db7fef0ea94ed197c169cf9497543fc9

data/.editorconfig

@@ -0,0 +1,8 @@
+[*]
+root = true
+tab_width = 2
+end_of_line = lf
+
+[*.rb]
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,173 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "*.gemspec"
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Metrics/BlockLength:
+  Enabled: false
+
+# Relaxed.Ruby.Style
+## Version 2.1
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styletrailingcommainliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ed@edropple.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in modern.gemspec
+gemspec
+
+group :development do
+  gem "openapi3_parser", git: "https://github.com/kevindew/openapi3_parser"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ed Ropple
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Modern #
+
+## Using Modern ##
+A detailed description is on the way. For now, please feel free to peruse our
+[test cases] and the beginnings of our [manual] to get an idea of Modern and how
+it works.
+
+## Versioning ##
+This project follows the [Semantic Versioning], version 2.0.0, with one
+addendum: until the project reaches the 1.0.0 mark, the minor version number
+(i.e., 0.y.*) denotes an API-breaking change.
+
+## Contributing ##
+Bug reports and pull requests are welcome [on GitHub]. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant] code of conduct.
+
+The best way to start contributing is to look for `TODO` comments in the code;
+they're sprinkled liberally wherever it didn't quite make sense to do something
+yet but some ideas might be lurking that describe how it could be handled. If
+not? File an issue and let's chat about it!
+
+## License ##
+The gem is available as open source under the terms of the [MIT License].
+
+## Code of Conduct ##
+Everyone interacting in the Modern project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of conduct].
+
+[test cases]: https://github.com/eropple/modern/tree/master/spec/modern
+[manual]: https://github.com/eropple/modern/tree/master/manual
+[Semantic Versioning]: https://semver.org/
+[on GitHub]: https://github.com/eropple/modern
+[Contributor Covenant]: http://contributor-covenant.org
+[MIT License]: https://opensource.org/licenses/MIT
+[code of conduct]: https://github.com/eropple/modern/blob/master/CODE_OF_CONDUCT.md

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: :spec
+
+task spec: [] do
+  Dir.chdir __dir__ do
+    sh "rspec --require spec_helper spec/**/*.rb"
+  end
+end

data/TODOS.md

@@ -0,0 +1,4 @@
+TODO: investigate the `oj` gem as a JSON replacement
+      Supposedly, if you use Ruby 2.4 and up, `oj` is a drop-in replacement for
+      the stock JSON gem. We already have it pulled in from a dependency, so
+      it's free.

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "modern"
+require "modern/app"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "puma"
+
+gem "rack-ougai"
+
+gem "modern", path: File.expand_path("#{__dir__}}/..")

data/example/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: /home/ed/Development/oapi3/modern
+  specs:
+    modern (0.2.0)
+      content-type (~> 0.0.1)
+      deep_dup (~> 0.0.3)
+      diff-lcs (~> 1.3)
+      docile (~> 1.3)
+      dry-struct (~> 0.4)
+      dry-validation (~> 0.11)
+      http (~> 3.0)
+      ice_nine (~> 0.11.2)
+      mime-types (~> 3.1)
+      mime-types-data (~> 3.2016)
+      ougai (~> 1.5)
+      rack (~> 2.0)
+      snake_camel (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.0.5)
+    content-type (0.0.1)
+      parslet (~> 1.5)
+    deep_dup (0.0.3)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.4)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.0)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (0.4.0)
+      dry-core (~> 0.4, >= 0.4.1)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 0.12, >= 0.12.2)
+      ice_nine (~> 0.11)
+    dry-types (0.12.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.2)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.12.0)
+    http (3.0.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (>= 2.0.0.pre.pre2, < 3)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.0.0)
+    http_parser.rb (0.6.0)
+    ice_nine (0.11.2)
+    inflecto (0.0.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    oj (3.4.0)
+    ougai (1.6.1)
+      oj (~> 3.4)
+    parslet (1.8.1)
+    public_suffix (3.0.2)
+    puma (3.11.2)
+    rack (2.0.4)
+    rack-ougai (0.2.1)
+      ougai (~> 1.5)
+      rack (~> 2.0)
+    snake_camel (1.1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  modern!
+  puma
+  rack-ougai
+
+BUNDLED WITH
+   1.16.1

data/example/config.ru

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rack/ougai'
+
+require 'modern/app'
+require_relative './example'
+
+use Rack::Ougai::Logger, Logger::INFO
+use Rack::Ougai::LogRequests
+
+run Modern::App.new(Example.descriptor)

data/example/example.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'modern/descriptor'
+
+module Example
+  # TODO: implement routes into the example descriptor
+  #       Modern was built specifically for a project I'm working on,
+  #       so an end-to-end example is still TBD(eveloped). However,
+  #       you can check out the tests for examples of how to write
+  #       routes and security schemes; all internal objects are built
+  #       with `dry-struct`
+  # TODO: implement with modern-dsl when that's done (or maybe have a
+  #       separate example for that?)
+  def self.descriptor
+    desc = Modern::Descriptor.new
+
+    desc
+  end
+end

data/lib/modern/app/error_handling.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Modern
+  class App
+    module ErrorHandling
+      private
+
+      def catch_web_error(response, err)
+        ret = {
+          message: err.message,
+          request_id: response.headers["X-Request-Id"]
+        }
+
+        # TODO: We maybe shouldn't hard-code a default to a JSON retval from a
+        # 404. On the other hand...maybe we should. Knowledgeable clients
+        # shouldn't be parsing a 404 unless the 404 is specified in a route's
+        # responses, and so this could just be garbage data except during
+        # development/debugging.
+        response.status = err.status;
+        response.json(ret)
+      end
+
+      def catch_unhandled_error(response, err)
+        ret = {
+          message: @configuration.show_errors ? err.message : "An error occurred.",
+          request_id: response.headers["X-Request-Id"]
+        }
+
+        if @configuration.show_errors
+          ret[:backtrace] = err.backtrace
+        end
+
+        logger.error "Unhandled exception caught by main loop.", err
+
+        # TODO: We maybe shouldn't hard-code a default to a JSON retval from a
+        # 404. On the other hand...maybe we should. Knowledgeable clients
+        # shouldn't be parsing a 404 unless the 404 is specified in a route's
+        # responses, and so this could just be garbage data except during
+        # development/debugging.
+        response.status = err.respond_to?(:status) ? err.status : 500;
+        response.json(ret)
+      end
+    end
+  end
+end

data/lib/modern/app/request_handling/input_handling.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'modern/errors/web_errors'
+
+module Modern
+  class App
+    module RequestHandling
+      module InputHandling
+        private
+
+        def parse_parameters(request, route)
+          match = route.path_matcher.match(request.path_info)
+          if match.nil?
+            {}
+          else
+            route_captures = match.names.map{ |n| [n.to_s, match[n]] }.to_h
+
+            route.parameters.map { |p| [p.name.to_sym, p.retrieve(request, route_captures)] }.to_h
+          end
+        end
+
+        def parse_request_body(request, route)
+          input_converter = determine_input_converter(request, route)
+          raise Modern::Errors::UnsupportedMediaTypeError if input_converter.nil?
+
+          raw = input_converter.converter.call(request.body)
+
+          t = route.request_body.type
+
+          if raw.nil?
+            nil
+          elsif t.nil?
+            raw
+          else
+            begin
+              if raw.is_a?(Hash)
+                raw = raw.map { |k, v| [k.respond_to?(:to_sym) ? k.to_sym : k, v] }.to_h
+              end
+
+              t[raw]
+            rescue Dry::Types::ConstraintError,
+                   Dry::Types::MissingKeyError,
+                   Dry::Struct::Error => err
+              request.logger.info("Struct parse error for route '#{route.id}'", err) \
+                   if @configuration.log_input_converter_errors
+              raise Modern::Errors::UnprocessableEntity, err.message
+            rescue StandardError => err
+              request.logger.warn("Unprocessable body for route '#{route.id}'", err) \
+                if @configuration.log_input_converter_errors
+              raise Modern::Errors::UnprocessableEntity
+            end
+          end
+        end
+
+        def determine_input_converter(request, route)
+          # RFC 2616; you MAY sniff content but SHOULD return application/octet-stream
+          # if the input Content-Type remains unknown. However, it seems like Rack may
+          # default to application/x-www-form-urlencoded; Rack::Test definitely does.
+          content_type = (request.content_type || "application/octet-stream").downcase.strip
+          route.input_converters_by_type[content_type]
+        end
+      end
+    end
+  end
+end