rack-service_api_versioning 0.1.0

data/lib/rack/service_api_versioning/encoded_api_version_data.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require 'prolog/dry_types'
+
+require_relative './encoded_api_version_data/input_data'
+require_relative './encoded_api_version_data/return_data'
+require_relative './encoded_api_version_data/invalid_base_url_error'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Builds an API Version data hash and encodes as JSON, for injection into a
+    # Rack environment, normally with the key "COMPONENT_API_VERSION_DATA".
+    class EncodedApiVersionData
+      def self.call(api_version:, data:)
+        new(api_version, data).call
+      end
+
+      def call
+        JSON.dump(version_data.to_hash)
+      end
+
+      protected
+
+      def initialize(api_version, input_data)
+        @api_version = api_version.to_sym
+        @data_obj = InputData.new api_version: api_version,
+                                  input_data: input_data
+        self
+      end
+
+      private
+
+      extend Forwardable
+      def_delegators :@data_obj, :base_url, :name, :vendor_org
+
+      attr_reader :api_version
+
+      def raise_invalid_base_url_error(original_error)
+        raise InvalidBaseUrlError.new base_url, original_error
+      end
+
+      def return_data_params
+        { api_version: api_version, base_url: base_url, name: name,
+          vendor_org: vendor_org }
+      end
+
+      def version_data
+        ReturnData.new return_data_params
+      rescue Dry::Struct::Error => original_error
+        raise_invalid_base_url_error original_error
+      end
+
+      private_constant :InputData
+      private_constant :ReturnData
+    end # class EncodedApiVersionData
+  end
+end

data/lib/rack/service_api_versioning/http_error_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'rack/response'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Builds Rack::Response with specified status code and body message.
+    class HttpErrorResponse
+      def call
+        Rack::Response.new(message, code).finish
+      end
+
+      protected
+
+      def initialize(code, message)
+        @code = code.to_i
+        @message = Array(message)
+        self
+      end
+
+      private
+
+      attr_reader :code, :message
+    end # class Rack::ServiceApiVersioning::HttpErrorResponse
+  end
+end

data/lib/rack/service_api_versioning/input_env.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Wrapper around JSON encoding of object in environment with defaulted key.
+    class InputEnv
+      DEFAULT_INPUT_KEY = 'COMPONENT_DESCRIPTION'
+
+      def initialize(env, input_key = DEFAULT_INPUT_KEY)
+        @env = env
+        @key = input_key
+        self
+      end
+
+      def any?
+        !input_str.empty?
+      end
+
+      def data
+        JSON.parse input_str, symbolize_names: true
+      end
+
+      private
+
+      attr_reader :env, :key
+
+      def input_str
+        input_value.strip
+      end
+
+      def input_value
+        env[key].to_s
+      end
+    end # class Rack::ServiceApiVersioning::InputEnv
+  end
+end

data/lib/rack/service_api_versioning/input_is_invalid.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative './report_invalid_description'
+require_relative './report_not_found'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Validates input for AcceptContentTypeSelector. If input passes checks,
+    # returns `nil`. Returns a Rack::Response instance if any validation step
+    # failed.
+    class InputIsInvalid
+      def self.call(input)
+        Internals.verify_input(input) || Internals.verify_api_versions(input)
+      end
+
+      # Stateless methods
+      module Internals
+        def self._api_versions?(input)
+          input.data[:api_versions].any?
+        end
+
+        def self.verify_api_versions(input)
+          return ReportNotFound.call unless _api_versions?(input)
+          nil
+        end
+
+        def self.verify_input(input)
+          return ReportInvalidDescription.call unless input.any?
+          nil
+        end
+      end
+    end # class Rack::ServiceApiVersioning::InputIsInvalid
+  end
+end

data/lib/rack/service_api_versioning/match_header_against_api_versions.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'rack/utils'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Matches content of HTTP Accept header against presently-available API
+    # Versions. Returns either a symbolic value (e.g., `:v2`) on success or
+    # `nil` on failure.
+    class MatchHeaderAgainstApiVersions
+      def self.call(accept_header:, api_versions:)
+        new(accept_header, api_versions).call
+      end
+
+      def call
+        best_match
+      end
+
+      protected
+
+      def initialize(accept_header, api_versions)
+        @accept_header = accept_header
+        @api_versions = api_versions
+        self
+      end
+
+      private
+
+      attr_reader :accept_header, :api_versions
+
+      def all_matches
+        api_versions.select { |_, version| best_type?(version) }
+      end
+
+      def all_types
+        api_versions.values.map { |version| version[:content_type] }
+      end
+
+      def best_match
+        all_matches.keys.first
+      end
+
+      def best_type
+        Rack::Utils.best_q_match(accept_header, all_types)
+      end
+
+      def best_type?(version)
+        version[:content_type] == best_type
+      end
+    end # class Rack::ServiceApiVersioning::MatchHeaderAgainstApiVersions
+  end
+end

data/lib/rack/service_api_versioning/report_invalid_description.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative './http_error_response'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Builds Rack::Response to halt request execution with an HTTP status code
+    # of 400 ("Bad Request").
+    class ReportInvalidDescription < HttpErrorResponse
+      DEFAULT_MESSAGE = 'Invalid value for COMPONENT_DESCRIPTION'
+
+      def self.call(code: 400, message: DEFAULT_MESSAGE)
+        new(code, message).call
+      end
+    end # class Rack::ServiceApiVersioning::ReportInvalidDescription
+  end
+end

data/lib/rack/service_api_versioning/report_no_matching_version.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative './http_error_response'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Builds Rack::Response to halt request execution with an HTTP status code
+    # of 406 ("Not Acceptable") when no presently available API Version has been
+    # specified in an HTTP `Accept` header.
+    class ReportNoMatchingVersion < HttpErrorResponse
+      def self.call(api_versions:, code: 406)
+        new(code, Internals.message_data(api_versions)).call
+      end
+
+      # Stateless methods.
+      module Internals
+        def self.all_types_as_string(api_versions, separator = ', ')
+          all_types = api_versions.values.map do |version|
+            version[:content_type]
+          end
+          all_types.join(separator)
+        end
+
+        def self.message_data(api_versions)
+          types = all_types_as_string(api_versions)
+          JSON.dump('supported-media-types': types)
+        end
+      end
+      private_constant :Internals
+    end # class Rack::ServiceApiVersioning::ReportNoMatchingVersion
+  end
+end

data/lib/rack/service_api_versioning/report_not_found.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative './http_error_response'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Builds Rack::Response to halt request execution, responding with a 404.
+    class ReportNotFound < HttpErrorResponse
+      DEFAULT_MESSAGE = 'Invalid value for COMPONENT_DESCRIPTION'
+
+      def self.call(code: 404, message: DEFAULT_MESSAGE)
+        new(code, message).call
+      end
+    end # class Rack::ServiceApiVersioning::ReportNotFound
+  end
+end

data/lib/rack/service_api_versioning/service_component_describer/report_service_not_found.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'rack/response'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Middlware to query and encode data on a named service, making it available
+    # to later entries in the middleware chain via an environment variable.
+    class ServiceComponentDescriber
+      # Builds Rack::Result to halt request execution, responding with a 404.
+      class ReportServiceNotFound
+        def self.call(service_name)
+          new(service_name).call
+        end
+
+        def call
+          new_response.finish
+        end
+
+        protected
+
+        def initialize(service_name)
+          @service_name = service_name
+          self
+        end
+
+        private
+
+        attr_reader :service_name
+
+        def body
+          %(Service not found: "#{service_name}")
+        end
+
+        def new_response
+          Rack::Response.new(Array(body), 404)
+        end
+      end # class ServiceComponentDescriber::ReportServiceNotFound
+    end # class ServiceComponentDescriber
+  end
+end

data/lib/rack/service_api_versioning/service_component_describer.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'rack'
+require 'rack/response'
+
+require_relative './service_component_describer/report_service_not_found'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Middleware that, given a "service name" parameter, will read descriptive
+    # data from a supplied repository regarding the named service, format that
+    # data as a JSON string, assign it to the `COMPONENT_DESCRIPTION`
+    # environment variable, and pass the updated environment along to the next
+    # link in the Rack call chain (app or more middleware). If there is no data
+    # for the named service in the repository, this middleware will halt
+    # execution with a 404 (Not Found).
+    #
+    # Also bear in mind that both usual parameters (`repository` and
+    # `service_name`) are supplied *by the AVIDA,* which should know what those
+    # "ought" to be.
+    class ServiceComponentDescriber
+      DEFAULT_ENV_KEYS = { result: 'COMPONENT_DESCRIPTION' }.freeze
+
+      def initialize(app, repository:, service_name:,
+                     env_keys: DEFAULT_ENV_KEYS)
+        @app = app
+        @env_keys = env_keys
+        @repository = repository
+        @service_name = service_name
+        self
+      end
+
+      def call(env)
+        env = update_env(env)
+        verify_datum_set(env) { |app_env| app.call app_env }
+      end
+
+      private
+
+      attr_reader :app, :env_keys, :repository, :service_name
+
+      def first_record
+        repository.find(name: service_name).first
+      end
+
+      def result_key
+        env_keys[:result]
+      end
+
+      def update_env(env)
+        datum = first_record
+        env[result_key] = JSON.dump(datum) if datum
+        env
+      end
+
+      def verify_datum_set(env)
+        verify_found(env) || yield(env)
+      end
+
+      def verify_found(env)
+        return nil if env[result_key]
+        ReportServiceNotFound.call(service_name)
+      end
+    end
+  end
+end

data/lib/rack/service_api_versioning/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  module ServiceApiVersioning
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/service_api_versioning.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rack/service_api_versioning/version'
+require 'rack/service_api_versioning/accept_content_type_selector'
+require 'rack/service_api_versioning/api_version_redirector'
+require 'rack/service_api_versioning/service_component_describer'
+
+# All(?) Rack code is namespaced within this module.
+module Rack
+  # Module includes our middleware components for managing service API versions.
+  module ServiceApiVersioning
+    # Your code goes here...
+  end
+end

data/lib/tasks/flog_task_patch.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rake/tasklib'
+require 'flog'
+require 'flog_task'
+
+# Redefinition of standard task's Rake invocation. Because we don't like
+# inconsistency in option settings.
+class FlogTask < Rake::TaskLib
+  # Reek bitches that this is a :reek:Attribute (writable). That's the *point*.
+  attr_accessor :methods_only
+end

data/rack-service_api_versioning.gemspec

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/service_api_versioning/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-service_api_versioning"
+  spec.version       = Rack::ServiceApiVersioning::VERSION
+  spec.authors       = ["Jeff Dickey"]
+  spec.email         = ["jdickey@seven-sigma.com"]
+
+  spec.summary       = %q{Rack middleware for API Version-specific Component Service redirection.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/jdickey/rack-service_api_versioning"
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "prolog-dry_types", '0.3.3'
+  spec.add_dependency "rack", '2.0.1'
+
+  spec.add_development_dependency "bundler", '1.14.6'
+  spec.add_development_dependency "rake", '12.0.0'
+  spec.add_development_dependency "minitest", '5.10.1'
+
+  spec.add_development_dependency "minitest-matchers", '1.4.1'
+  spec.add_development_dependency "minitest-reporters", '1.1.14'
+  spec.add_development_dependency "minitest-tagz", '1.5.2'
+  spec.add_development_dependency "flay", '2.8.1'
+  spec.add_development_dependency "flog", '4.6.1'
+  spec.add_development_dependency "reek", '4.5.6'
+  spec.add_development_dependency "rubocop", '0.47.1'
+  spec.add_development_dependency "simplecov", '0.14.1'
+  spec.add_development_dependency "pry-byebug", '3.4.2'
+  spec.add_development_dependency "pry-doc", '0.10.0'
+  spec.add_development_dependency "awesome_print", '1.7.0'
+  spec.add_development_dependency "colorator", '1.1.0'
+
+  spec.add_development_dependency 'guard', '2.14.1'
+  spec.add_development_dependency 'guard-livereload', '2.5.2'
+  spec.add_development_dependency 'guard-minitest', '2.4.6'
+  spec.add_development_dependency 'guard-rake', '1.0.0'
+  spec.add_development_dependency 'guard-reek', '1.0.2'
+  spec.add_development_dependency 'guard-rubocop', '1.2.0'
+  spec.add_development_dependency 'guard-rubycritic', '2.9.3'
+end

data/tmp/gemsets/setup-and-bundle.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env zsh
+
+RBVER=`rbenv version | cut -f 1 -d ' '`
+GEMSETBASE="./tmp/gemsets/$RBVER"
+rm -rf .rbenv-gemsets $GEMSETBASE/{dev,extras,runtime}
+mkdir -p $RBENV_ROOT/versions/$RBVER/gemsets/.project-gemsets/rack-service_api_versioning-dummy
+rm -rf $RBENV_ROOT/versions/$RBVER/gemsets/.project-gemsets/*rack-service_api_versioning*
+
+mkdir -p $GEMSETBASE
+rbenv gemset init $GEMSETBASE/runtime
+gem install prolog-dry_types -v 0.3.3
+gem install rack -v 2.0.1
+
+rbenv gemset init $GEMSETBASE/dev
+echo "$GEMSETBASE/dev\n$GEMSETBASE/runtime" > .rbenv-gemsets
+gem install rake -v 12.0.0
+gem install minitest -v 5.10.1
+gem install minitest-matchers -v 1.4.1
+gem install minitest-reporters -v 1.1.14
+gem install minitest-tagz -v 1.5.2
+
+gem install flay -v 2.8.1
+gem install flog -v 4.6.1
+gem install pry-byebug -v 3.4.2
+gem install pry-doc -v 0.10.0
+gem install reek -v 4.5.6
+gem install rubocop -v 0.47.1
+gem install simplecov -v 0.14.1
+
+gem install awesome_print -v 1.7.0
+gem install colorator -v 1.1.0
+
+gem install guard -v 2.14.1
+gem install guard-livereload -v 2.5.2
+gem install guard-minitest -v 2.4.6
+gem install guard-rake -v 1.0.0
+gem install guard-reek -v 1.0.2
+gem install guard-rubocop -v 1.2.0
+gem install guard-rubycritic -v 2.9.3
+# gem install guard-shell -v 0.7.1
+
+# gem install fury -v 0.0.5
+rbenv gemset init $GEMSETBASE/extras
+echo "$GEMSETBASE/extras\n$GEMSETBASE/dev\n$GEMSETBASE/runtime" > .rbenv-gemsets
+unset RBVER
+rbenv rehash
+
+bundle install --local