api_versioner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 357247c1ecd0b2e666c8bdbbdac1b3eb9a22522308c699bf29ae91c7dd865747
+  data.tar.gz: a0f4129bf5aa8268bca4bf5402c1adb5162c18f0b7113475e1cf5058efa6cd04
+SHA512:
+  metadata.gz: f5ca13ee2c3708845606d16e762cbc59f75271ddb44966e5290fb8b0d5b514834226a8c8111ccd05509b28a39356aab975907c56f33e0c7e9557ee5a90d9fe1e
+  data.tar.gz: e2e7a61081408844376ee544880f60164160956d24a32d934f2918a170e5864a7582d4d28e6581d85f3f52f37c3dc695dd54b5106dee0be64e920f345125fdcf

data/.devcontainer/Dockerfile

@@ -0,0 +1,19 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.194.3/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3.0"
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="none"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install additional gems.
+# RUN gem install <your-gem-names-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,32 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.194.3/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6
+			"VARIANT": "2.7",
+			// Options
+			"NODE_VERSION": "none"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "ruby --version",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.reek.yml

@@ -0,0 +1,17 @@
+---
+detectors:
+  Attribute:
+    enabled: false
+
+  ControlParameter:
+    enabled: false
+
+  IrresponsibleModule:
+    enabled: false
+
+  UtilityFunction:
+    enabled: false
+
+  UncommunicativeVariableName:
+    accept:
+      - e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,77 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  CacheRootDirectory: tmp
+  Exclude:
+    - bin/*
+    - vendor/**/*
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/AbcSize:
+  Exclude:
+    - db/migrate/*
+    - config/initializers/auto_inject/*
+
+Metrics/BlockLength:
+  Exclude:
+    - config/environments/*
+    - config/initializers/auto_inject/*
+    - config/routes.rb
+    - config/routes/*
+    - db/**/*
+    - lib/tasks/**/*
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - db/migrate/*
+
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/*
+    - config/initializers/auto_inject/*
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/requests/**/*
+
+RSpec/EmptyExampleGroup:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Exclude:
+    - spec/**/*
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/ScatteredSetup:
+  Exclude:
+    - spec/integration/**/*
+
+RSpec/VariableName:
+  IgnoredPatterns:
+    - Authorization
+
+Style/Documentation:
+  Enabled: false
+
+Style/LambdaCall:
+  EnforcedStyle: braces
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - lib/**/*
+  EnforcedStyle: compact
+
+Style/SafeNavigation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

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 agureiev@shakuro.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in versioner.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    api_versioner (1.0.0)
+      semantic (~> 1.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    kwalify (0.7.2)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    reek (6.0.6)
+      kwalify (~> 0.7.0)
+      parser (~> 3.0.0)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.12.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.12.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    semantic (1.6.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_versioner!
+  reek (~> 6.0)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.4)
+  rubocop-performance (~> 1.5, >= 1.5.2)
+  rubocop-rails (~> 2.2)
+  rubocop-rspec (~> 2.0)
+  simplecov (~> 0.21.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Aleksey Gureiev
+
+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,137 @@
+# API Versioner
+
+API Versioner is a tiny focused gem that provides support for semantic versioning to API apps. The idea is as follows:
+
+- Backend has its current API version that it exposes in the `X-API-Server-Version` response header by default
+- Client requests a certain API version by sending it in the `X-API-Client-Version` request header by default
+- Before processing the request, backend checks the requested version against the current version using some policy and terminates with an error if the version is unsupported.
+
+All moving parts (headers names, the policy and the handler) are configurable.
+
+## Middlewares
+
+During initialization if the gem sees it's used in a Rails app, it installs two middlewares:
+- `ApiVersioner::ServerVersionMiddleware` places the current version in the response header (defaults to `X-API-Server-Version`). The header name and the current version is configurable.
+- `ApiVersioner::ClientVersionMiddleware` analyzes the version in the said request header (defaults to `X-API-Client-Version`) and checks it against the current server version using a specified policy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_versioner'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install versioner
+
+## Usage
+
+```ruby
+# config/initializers/versioner.rb
+
+Versioner.configure do |config|
+  # Current version of the application
+  config.current_version = '1.2.3'
+
+  # The name of the header to set the current server API version
+  # Default: 'X-API-Server-Version'
+  config.server_version_header = 'X-API-Server-Version'
+
+  # The header to look for the API version required by the client
+  # Default: 'X-API-Client-Version'
+  config.client_version_header = 'X-API-Client-Version'
+
+  # A callable object to check version policy. It's called with current server version
+  # and the requested version from the request header (`client_version_header`).
+  # If the requested version is unsupported, the `ApiVersioner::UnsupportedVersion` error should be raised.
+  config.version_policy = ApiVersioner::DefaultPolicy.new
+
+  # A callable object to handle the `ApiVersioner::UnsupportedVersion` error in a way
+  # specific to your application. It's called with the error and the configuration.
+  # The default implementation renders JSON like below and returns it with error code 400.
+  config.unsupported_version_handler = ApiVersioner::DefaultHandler.new
+end
+```
+
+## Policy
+
+A policy is a callable object with two arguments, like below:
+
+```ruby
+class CustomPolicy
+  def call(current_version, requested_version)
+    raise ApiVersioner::UnsupportedVersion, "This version is ..." if some_condition?
+  end
+end
+```
+
+A policy should raise the `ApiVersioner::UnsupportedVersion` error if the requested version is unsupported.
+
+The default implementation (`ApiVersioner::DefaultPolicy`) passes for:
+- unspecified versions
+- equal versions
+- requested versions that are lower than current on minor and/or patch levels
+
+Raises errors for:
+- requested versions that are **lower than current on major level**
+- requested versions that are higher than current
+
+## UnsupportedVersion error
+
+`ApiVersioner::UnsupportedVersion` error has `reason` field that is not initialized by default. You can initialize it with your own value as necessary. This value is returned in the error meta-section by the `ApiVersioner::DefaultHandler` as shown in the next section.
+
+## Handler
+
+The handler is a callable object that generates the response when an unsupported version is detected.
+
+```ruby
+class CustomHandler
+  def call(error, config)
+    [200, {}, ['Version error']]
+  end
+end
+```
+
+The default implementation (`ApiVersioner::DefaultHandler`):
+- Returns status 400 (Bad Request)
+- Renders JSON content as follows:
+
+```json
+{
+  "errors": [
+    {
+      "title": "Error message ...",
+      "status": 400,
+      "code": "UNSUPPORTED_VERSION",
+      "meta": {
+        "reason": <error.reason>
+      }
+    }
+  ]
+}
+```
+
+Default policy reason codes are:
+- `TOO_LOW` - major number of the requested version is lower than current
+- `TOO_HIGH` - requested version is higher than current on any level
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/versioner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/versioner/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/api_versioner.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/api_versioner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'api_versioner'
+  spec.version       = ApiVersioner::VERSION
+  spec.authors       = ['Aleksey Gureiev']
+  spec.email         = %w[agureiev@shakuro.com]
+
+  spec.summary       = 'A simple gem to add semantic versioning support to API applications.'
+  spec.homepage      = 'https://github.com/alg/api_versioner'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/alg/api_versioner'
+  spec.metadata['changelog_uri'] = 'https://github.com/alg/api_versioner/CHANGELOG'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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 = %w[lib]
+
+  spec.add_dependency 'semantic', '~> 1.6.1'
+
+  spec.add_development_dependency 'reek', '~> 6.0'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rubocop', '~> 1.4'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5', '>= 1.5.2'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "versioner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/api_versioner/client_version_middleware.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'semantic'
+require 'api_versioner/unsupported_version'
+
+module ApiVersioner
+  class ClientVersionMiddleware
+    def initialize(app, config = nil)
+      @app = app
+      @config = config || Versioner.config
+    end
+
+    def call(env)
+      check_version(env)
+      @app.(env)
+    rescue ApiVersioner::UnsupportedVersion => e
+      @config.unsupported_version_handler.(e, @config)
+    end
+
+    def check_version(env)
+      return unless checking_versions?
+
+      @config.version_policy.(@config.current_version, client_version(env))
+    end
+
+    def checking_versions?
+      @config.client_version_header &&
+        @config.current_version &&
+        @config.version_policy &&
+        @config.unsupported_version_handler
+    end
+
+    def client_version(env)
+      header_name = convert_to_rack_header(@config.client_version_header)
+      ver = env[header_name]
+
+      ver && Semantic::Version.new(ver)
+    rescue ArgumentError
+      nil
+    end
+
+    def convert_to_rack_header(header)
+      "HTTP_#{header.strip.tr('-', '_').upcase}"
+    end
+  end
+end

data/lib/api_versioner/configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'semantic'
+require_relative 'default_policy'
+require_relative 'default_handler'
+
+module ApiVersioner
+  # :reek:TooManyInstanceVariables
+  class Configuration
+    DEFAULT_SERVER_VERSION_HEADER = 'X-API-Server-Version'
+    DEFAULT_CLIENT_VERSION_HEADER = 'X-API-Client-Version'
+    DEFAULT_VERSION_POLICY = DefaultPolicy.new
+    DEFAULT_UNSUPPORTED_VERSION_HANDLER = DefaultHandler.new
+
+    attr_accessor :version_policy, :unsupported_version_handler
+    attr_reader :current_version, :server_version_header, :client_version_header
+
+    def initialize
+      @current_version = nil
+      @server_version_header = DEFAULT_SERVER_VERSION_HEADER
+      @client_version_header = DEFAULT_CLIENT_VERSION_HEADER
+      @version_policy = DEFAULT_VERSION_POLICY
+      @unsupported_version_handler = DEFAULT_UNSUPPORTED_VERSION_HANDLER
+    end
+
+    def current_version=(version)
+      ver = version.to_s.strip
+      @current_version = ver.empty? ? nil : Semantic::Version.new(ver)
+    end
+
+    def server_version_header=(name)
+      val = name.to_s.strip
+      @server_version_header = val.empty? ? nil : val
+    end
+
+    def client_version_header=(name)
+      val = name.to_s.strip
+      @client_version_header = val.empty? ? nil : val
+    end
+  end
+end

data/lib/api_versioner/default_handler.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ApiVersioner
+  class DefaultHandler
+    BLANK_RE = /\A[[:space:]]*\z/.freeze
+
+    def call(error, _config)
+      [400, {}, [JSON.generate(errors: [formatted_error(error)])]]
+    end
+
+    private
+
+    def formatted_error(error)
+      {
+        title: error.message,
+        status: 400,
+        code: 'UNSUPPORTED_VERSION'
+      }.tap do |json|
+        reason = error.reason
+        next if !reason || BLANK_RE.match?(reason)
+
+        json[:meta] = { reason: reason }
+      end
+    end
+  end
+end

data/lib/api_versioner/default_policy.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'api_versioner/unsupported_version'
+
+module ApiVersioner
+  class DefaultPolicy
+    class VersionTooLow < UnsupportedVersion
+      def initialize(msg)
+        super(msg, reason: 'TOO_LOW')
+      end
+    end
+
+    class VersionTooHigh < UnsupportedVersion
+      def initialize(msg)
+        super(msg, reason: 'TOO_HIGH')
+      end
+    end
+
+    def call(current_version, requested_version)
+      return on_version_unspecified unless requested_version
+
+      on_lower(current_version, requested_version) if requested_version.major < current_version.major
+      on_higher(current_version, requested_version) if requested_version > current_version
+
+      true
+    end
+
+    private
+
+    def on_version_unspecified
+      # Ignore
+    end
+
+    def on_lower(current_version, requested_version)
+      raise VersionTooLow,
+        "Requested version (#{requested_version}) is significantly lower than current version (#{current_version})"
+    end
+
+    def on_higher(current_version, requested_version)
+      raise VersionTooHigh,
+        "Requested version (#{requested_version}) is higher than current version (#{current_version})"
+    end
+  end
+end

data/lib/api_versioner/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# :nocov:
+require_relative './client_version_middleware'
+require_relative './server_version_middleware'
+
+module ApiVersioner
+  class Railtie < Rails::Railtie
+    initializer 'versioner.configure_rails_initialization' do |app|
+      app.middleware.use ServerVersionMiddleware
+      app.middleware.insert_after ServerVersionMiddleware, ClientVersionMiddleware
+    end
+  end
+end

data/lib/api_versioner/server_version_middleware.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ApiVersioner
+  class ServerVersionMiddleware
+    def initialize(app, config = nil)
+      @app = app
+      @config = config || ApiVersioner.config
+    end
+
+    def call(env)
+      status, headers, response = @app.(env)
+
+      add_version_header(headers)
+
+      [status, headers, response]
+    end
+
+    private
+
+    def add_version_header(headers)
+      return unless adding_versions?
+
+      headers[@config.server_version_header] = @config.current_version.to_s
+    end
+
+    def adding_versions?
+      @config.current_version &&
+        @config.server_version_header
+    end
+  end
+end

data/lib/api_versioner/unsupported_version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ApiVersioner
+  class UnsupportedVersion < StandardError
+    attr_reader :reason
+
+    def initialize(msg = nil, reason: nil)
+      super(msg)
+
+      @reason = reason
+    end
+  end
+end

data/lib/api_versioner/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# :nocov:
+module ApiVersioner
+  VERSION = '1.0.0'
+end

data/lib/api_versioner.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'api_versioner/version'
+
+module ApiVersioner
+  autoload :Configuration, 'api_versioner/configuration'
+
+  class << self
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end
+
+# :nocov:
+require 'api_versioner/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: api_versioner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aleksey Gureiev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description:
+email:
+- agureiev@shakuro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_versioner.gemspec
+- bin/console
+- bin/setup
+- lib/api_versioner.rb
+- lib/api_versioner/client_version_middleware.rb
+- lib/api_versioner/configuration.rb
+- lib/api_versioner/default_handler.rb
+- lib/api_versioner/default_policy.rb
+- lib/api_versioner/railtie.rb
+- lib/api_versioner/server_version_middleware.rb
+- lib/api_versioner/unsupported_version.rb
+- lib/api_versioner/version.rb
+homepage: https://github.com/alg/api_versioner
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alg/api_versioner
+  source_code_uri: https://github.com/alg/api_versioner
+  changelog_uri: https://github.com/alg/api_versioner/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A simple gem to add semantic versioning support to API applications.
+test_files: []