phenotype 0.1.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88fac70aca1a4fc9f4d1877d8a14b81f2644ea36
-  data.tar.gz: 5fde94d65d7dbc38e818edb36d71fb93cce8f375
+SHA256:
+  metadata.gz: a74f97d1b04b395d3808fcc466e4d61f4111ea3ec70719da1a21853c6e429de8
+  data.tar.gz: 302fdceb8bb12142e35aa5c3129dfe956b58239eaea5acf6f7464f5697a09359
 SHA512:
-  metadata.gz: 580a7073acd4bff168cbe82f8185ef39dac23b288cf593cc95c6d1ef53213eb4c91ded498b1204c8072747f8e1c4d50248b5a76e2c63a844ff59e22784b230ee
-  data.tar.gz: 99c51dadf8523327c509b3de9c7366638fd52fddbcda70f43282f2f21f4b32943b9d3933d87b1641ee5fc2ebeb08b14b827ec19f83d9f8528dd981352d3e42c9
+  metadata.gz: '09932bce3e0302a316b06a9125e458beb7ec36a08864bc7c5f70845e793f5ff8ca5ce7924816e85ae8fffb1f8a1e09a8e4ca0460467a90f4c39a6f0f1d16a673'
+  data.tar.gz: 2807a0e03379b19afdaceafd20b3ef0c038d7d1d1480121fe253667820650556565cf84a04247408a390d7ba6e6c63e6da460d83f97e043c734a3f5f6364381e

data/lib/phenotype.rb

@@ -1,4 +1,12 @@
-require 'require_all'
-require_rel 'strategies'
+# frozen_string_literal: true
+
 require 'rack'
-require 'versioned_app'
+require 'phenotype/strategies/accept_header_strategy'
+require 'phenotype/strategies/header_strategy'
+require 'phenotype/strategies/param_strategy'
+require 'phenotype/strategies/path_strategy'
+require 'phenotype/strategies/null_strategy'
+require 'phenotype/versioned_app'
+
+module Phenotype
+end

data/lib/phenotype/response_handler.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class ResponseHandler
+    attr_reader :response
+
+    def initialize(response)
+      @response = response
+    end
+
+    def retry?
+      valid_response? && not_found? && cascade?
+    end
+
+    private
+
+    def valid_response?
+      response.is_a?(Array) && rack_response?
+    end
+
+    def rack_response?
+      response[0].is_a?(Numeric) && response[1].is_a?(Hash) && response[2].is_a?(Array)
+    end
+
+    def not_found?
+      response.first.to_i == 404
+    end
+
+    def cascade?
+      response[1]['X-Cascade'].to_s == 'pass'
+    end
+  end
+end

data/lib/phenotype/route_handler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class RouteHandler
+    attr_reader :cascade, :block
+
+    def initialize(block:, cascade: false)
+      @cascade = cascade
+      @block = block
+    end
+
+    def cascade?
+      cascade
+    end
+  end
+end

data/lib/phenotype/strategies/accept_header_strategy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class AcceptHeaderStrategy
+    attr_reader :mime_type
+
+    def initialize(mime_type = 'application/vnd.rentpath.api+json')
+      @mime_type = mime_type
+    end
+
+    def version(env)
+      env['HTTP_ACCEPT'].to_s.match(/#{Regexp.quote(mime_type)};version=(?<version>\d+)/) { |match| match[:version] } ||
+        NullStrategy.new
+    end
+  end
+end

data/lib/phenotype/strategies/header_strategy.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class HeaderStrategy
+    attr_reader :header
+
+    def initialize(header: 'Sue')
+      @header = header
+    end
+
+    def version(env)
+      env["HTTP_#{header.upcase}"] || NullStrategy.new
+    end
+  end
+end

data/lib/phenotype/strategies/null_strategy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class NullStrategy
+    def version(_env)
+      self
+    end
+
+    def to_i
+      nil
+    end
+  end
+end

data/lib/phenotype/strategies/param_strategy.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class ParamStrategy
+    attr_reader :param
+
+    def initialize(param = 'v')
+      @param = param
+    end
+
+    def version(env)
+      Rack::Request.new(env).params[param] || NullStrategy.new
+    end
+  end
+end

data/lib/phenotype/strategies/path_strategy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Phenotype
+  class PathStrategy
+    attr_reader :version_pattern
+
+    def initialize(version_pattern = Regexp.new('^\/v(\d+)\/?'))
+      @version_pattern = version_pattern
+    end
+
+    def version(env)
+      match = Rack::Request.new(env).path.match(version_pattern)
+      match && match[1] || NullStrategy.new
+    end
+  end
+end

data/lib/phenotype/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Phenotype
+  VERSION = '0.4.3'
+end

data/lib/phenotype/versioned_app.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'versioner'
+require_relative 'route_handler'
+
+module Phenotype
+  class VersionedApp
+    attr_accessor :strategies, :routes
+
+    def initialize(strategies: [])
+      @routes = {}
+      @strategies = strategies
+    end
+
+    def add_strategy(strategy)
+      strategies.push(strategy)
+    end
+
+    def add_version(version:, cascade: false, &block)
+      raise 'Error - Phenotype version must be numeric' unless version.is_a?(Numeric)
+
+      routes[version] = RouteHandler.new(cascade: cascade, block: block)
+    end
+
+    def call(env)
+      Versioner.new(routes: routes, strategies: strategies, env: env).call
+    end
+  end
+end

data/lib/phenotype/versioner.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative 'response_handler'
+
+module Phenotype
+  class Versioner
+    attr_reader :routes, :versions, :strategies, :env
+
+    def initialize(routes: {}, strategies: [], env: {})
+      @routes = routes
+      @versions = routes.keys.sort.reverse
+      @strategies = strategies
+      @env = env
+    end
+
+    def call # rubocop:disable Metrics/AbcSize
+      return display_errors if errors?
+
+      cascading_versions.each do |v|
+        if strategies.first.instance_of?(PathStrategy) && version_mismatch?(v)
+          env['PATH_INFO'] = updated_versioned_path(env['PATH_INFO'], v)
+        end
+        route = call_route(v)
+        handler = ResponseHandler.new(route.block.call(env))
+        return handler.response unless route.cascade? && handler.retry?
+      end
+    end
+
+    private
+
+    def version_mismatch?(version)
+      path_version && (path_version != version.to_s)
+    end
+
+    def path_version
+      path = Rack::Request.new(env).path
+      match = path.match(strategies.first.version_pattern)
+      match&.captures&.first
+    end
+
+    def updated_versioned_path(path, version)
+      path.sub(path_version, version.to_s)
+    end
+
+    def errors?
+      strategies.empty? || too_many_strategies? || !supported_version?
+    end
+
+    def display_errors
+      return no_strategy_response.call(env) if strategies.empty?
+      return too_many_strategies_response.call(env) if too_many_strategies?
+      return version_not_found_response.call(env) unless supported_version?
+    end
+
+    def too_many_strategies?
+      @too_many_strategies ||= strategies.size > 1
+    end
+
+    def supported_version?
+      @supported_version ||= versions.include?(current_version)
+    end
+
+    def current_version
+      @current_version ||= strategies.detect { |strat| strat.version(env) }.version(env).to_i
+    end
+
+    def cascading_versions
+      @cascading_versions ||= versions.select { |el| el <= current_version }
+    end
+
+    def no_strategy_response
+      @no_strategy_response ||= default_response(406, 'No Strategies provided')
+    end
+
+    def too_many_strategies_response
+      @too_many_strategies_response ||= default_response(400, 'Too mant strategies provided, Supports only one')
+    end
+
+    def version_not_found_response(message = "Version: #{current_version} is not found")
+      default_response(406, message)
+    end
+
+    def call_route(version)
+      routes.fetch(
+        version,
+        version_not_found_response("Unable to satisfy request for Version: #{current_version}")
+      )
+    end
+
+    def default_response(status_code, message = '')
+      proc { [status_code, { 'Content-Type' => 'text/html' }, [message]] }
+    end
+  end
+end

metadata

@@ -1,102 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: phenotype
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Rentpath
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '10.5'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '3.4'
 description: versioning gem that works with rails and rack
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/phenotype.rb
-- lib/strategies/header_strategy.rb
-- lib/strategies/null_strategy.rb
-- lib/strategies/param_strategy.rb
-- lib/util/version.rb
-- lib/versioned_app.rb
-homepage: ''
+- lib/phenotype/response_handler.rb
+- lib/phenotype/route_handler.rb
+- lib/phenotype/strategies/accept_header_strategy.rb
+- lib/phenotype/strategies/header_strategy.rb
+- lib/phenotype/strategies/null_strategy.rb
+- lib/phenotype/strategies/param_strategy.rb
+- lib/phenotype/strategies/path_strategy.rb
+- lib/phenotype/version.rb
+- lib/phenotype/versioned_app.rb
+- lib/phenotype/versioner.rb
+homepage: https://github.com/rentpath/phenotype
 licenses:
-- NA
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -105,16 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: phenotype-0.1.0
+summary: phenotype-0.4.3
 test_files: []

data/lib/strategies/header_strategy.rb

@@ -1,22 +0,0 @@
-module Phenotype
-  class HeaderStrategy
-    attr_reader :header, :header_param, :env
-    def initialize(header: 'Sue')
-      @header = header
-    end
-
-    def get_version(env)
-      @env = env
-      version
-    end
-
-    def version
-      @version = env[header_key]
-    end
-
-    private
-    def header_key
-      "HTTP_#{header.upcase}"
-    end
-  end
-end

data/lib/strategies/null_strategy.rb

@@ -1,9 +0,0 @@
-module Phenotype 
-  class NullStrategy
-    def get_version(env)
-    end
-
-    def version
-    end
-  end
-end

data/lib/strategies/param_strategy.rb

@@ -1,18 +0,0 @@
-require 'rack'
-module Phenotype 
-  class ParamStrategy
-    attr_reader :param, :request
-    def initialize(param = 'v')
-      @param = param
-    end
-
-    def get_version(env)
-      @request = Rack::Request.new(env)
-      version
-    end
-
-    def version
-      @version ||= request.params[param]
-    end
-  end
-end

data/lib/util/version.rb

@@ -1,3 +0,0 @@
-module Phenotype
-  VERSION = '0.1.0'
-end

data/lib/versioned_app.rb

@@ -1,42 +0,0 @@
-module Phenotype 
-  class VersionedApp
-    attr_accessor :strategies, :default_routes, :routes
-    def initialize(strategies: [])
-      @routes = {}
-      @strategies = strategies
-      @default_routes = null_default 
-    end
-
-    def add_strategy(strat)
-      strategies.push(strat)
-    end
-
-    def add_version(version: nil, default: false, &block)
-      @default_routes = block if default
-      routes[version] = block
-    end
-
-    def call(env)
-      strategy = get_strategy(env)
-      return default_routes.call(env) unless strategy.version
-      call_route(strategy.version).call(env)
-    end
-
-    private
-    def null_default
-      Proc.new { [404, 
-        { 'Content-Type' => 'text/html', 'Content-Length' => "404".size.to_s},
-        ["404"]]
-      }
-    end
-
-    def call_route(version)
-      routes.fetch(version, default_routes)
-    end
-
-    def get_strategy(env)
-      strategy = strategies.find { |strat| strat.get_version(env) } 
-      strategy || NullStrategy.new 
-    end
-  end
-end