rack_content_type_default 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eeb07d130a6bfcafad8b67813d926fcbff1ade28d569556ab6fac578537fd0c9
+  data.tar.gz: a5bcefef85708443b8b4f9da0eb56b641f7793530a88800a20bbfc59ee3a1a03
+SHA512:
+  metadata.gz: 71e6316f50a15373b8488e0e23c77dce1baab823a47c85a3c1397e26edbb10d6763b00696e24934ad2d7a0762e006afa7cf83334b05ff23f54f1d5312e05df76
+  data.tar.gz: ced08988af4f4bed2b09d3ae279ea23c0439d596fdd8dee3af1d2c3cd5a2dac2176e4db43ccc01f13ac6e5c9365e555a214b60c7fcd67cd6a23162537354390e

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+coverage/

data/.travis.yml

@@ -0,0 +1,24 @@
+dist: focal
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
+
+before_install:
+  - gem update --system --force -N > /dev/null && echo "Rubygems version $(gem --version)"
+  - gem install bundler --force -N && bundle --version
+
+install: BUNDLE_JOBS=4 bundle install
+
+script: bundle exec rspec
+
+deploy:
+  edge: true # opt in to dpl v2
+  provider: rubygems
+  on:
+    tags: true
+    condition: $TRAVIS_RUBY_VERSION == 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.1.0
+- Refresh code/specs and publish to rubygems.org.
+
+# 0.0.0 (tagged `v1.0.0`)
+- Initial release.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014-2021 Medidata Solutions Worldwide
+
+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,47 @@
+# Rack::ContentTypeDefault
+
+Rack::ContentTypeDefault is a tiny piece of middleware that sets default `CONTENT-TYPE:` header when it isn't present
+for specific requests. It checks if a content type is set and does not override the existing one.
+
+The following options may be specified:
+
+1. Request method(s) on which the content type is applied. The default value is post.
+2. Desired content type. The default value is 'application/json'.
+3. Paths on which the content type is applied. The default is all paths when none are specified.
+4. A boolean value to indicate whether or not to apply 'application/xml' or 'application/json' if the path ends in .xml
+    or .json, respectively. The default value is false.
+
+
+The code has been copied and adapted from https://gist.github.com/tstachl/6264249
+
+## Installation
+
+Add the following line to your application's Gemfile:
+
+```ruby
+gem 'rack_content_type_default', '~> 1.0'
+```
+
+## Usage
+
+Examples:
+
+```ruby
+require 'rack/content-type-default'
+config.middleware.use Rack::ContentTypeDefault, :post, 'application/x-www-form-urlencoded'
+```
+
+```ruby
+require 'rack/content-type-default'
+config.middleware.use Rack::ContentTypeDefault, [:get, :post], 'application/xml', '/authenticate.xml'
+```
+
+```ruby
+require 'rack/content-type-default'
+config.middleware.use Rack::ContentTypeDefault, :post, 'application/json', ['/authenticate.json', '/show'], true
+```
+
+## Why
+
+It is useful if you want to make your application opinionated about the content type it expects from clients when not
+provided. In addition it bridges a gap between test and production environments if the clients differ.

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/lib/rack/content_type_default.rb

@@ -0,0 +1,52 @@
+# This is a simple Rack Middleware to set the request content type for specific routes. It checks if a content type is
+# set and does not override the existing one. The options allow you to specify the request methods and the content type
+# to be set. The options also allow you to set a default content type only on select paths. In addition, the options
+# allow  you to set content type to to application/json or application/xml if possible based on the path ending.
+# Copied and adapted from https://gist.github.com/tstachl/6264249
+module Rack
+  class ContentTypeDefault
+    def initialize(app, methods = [:post], content_type = 'application/json', paths = 'all', use_path_hint = false)
+      @app = app
+      @methods = [*methods].map { |item| item.to_s.upcase }
+      @content_type = content_type
+      @paths = [*paths]
+      @use_path_hint = use_path_hint
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      if override_content_type?(req)
+        env['CONTENT_TYPE'] = @use_path_hint ? determine_content_type(req.env['PATH_INFO']) : @content_type
+      end
+      @app.call(env)
+    end
+
+    private
+
+    # Determine whether or not to override content type
+    def override_content_type?(req)
+      (req.content_type.nil? || req.content_type.empty?) && match_method?(req.request_method) &&
+        match_path?(req.env['PATH_INFO'])
+    end
+
+    # Match the method on the request with the methods specified or the default.
+    # If @methods was provided as empty, content type will not be set.
+    def match_method?(method)
+      @methods.include?(method)
+    end
+
+    # Match the path on the request with the paths specified. Content type is set only if a match is found.
+    # If @paths was provided with 'all' as the first element (default), content type will be set for all requests.
+    # If @paths was explicitly set to empty, content type will not be set.
+    def match_path?(filter)
+      @paths.first == 'all' || @paths.any? { |path| /#{path}$/.match?(filter) || /#{path}\./.match?(filter) }
+    end
+
+    # Determine if content type can be set to application/json or application/xml based on the path ending.
+    # If the path does not end in xml or json, content type is set to the given default.
+    def determine_content_type(path_info)
+      inferred = path_info.split('.').last
+      %w[json xml].include?(inferred) ? "application/#{inferred}" : @content_type
+    end
+  end
+end

data/lib/rack/content_type_default/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rack
+  class ContentTypeDefault
+    VERSION = '1.1.0'
+  end
+end

data/rack_content_type_default.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rack/content_type_default/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'rack_content_type_default'
+  s.version               = Rack::ContentTypeDefault::VERSION
+  s.authors               = ['Purnima Mavinkurve', 'Connor Savage']
+  s.email                 = ['pmavinkurve@mdsol.com']
+  s.homepage              = 'https://github.com/mdsol/rack_content_type_default'
+  s.summary               = 'Rack Middleware for setting content type when not provided'
+  s.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'rack'
+
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rack_content_type_default
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Purnima Mavinkurve
+- Connor Savage
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- pmavinkurve@mdsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rack/content_type_default.rb
+- lib/rack/content_type_default/version.rb
+- rack_content_type_default.gemspec
+homepage: https://github.com/mdsol/rack_content_type_default
+licenses: []
+metadata: {}
+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.2
+signing_key: 
+specification_version: 4
+summary: Rack Middleware for setting content type when not provided
+test_files: []