API Operations
Documentation for <%= version%>
versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_presenter.rb 0000644 0000041 0000041 00000000054 13273750405 031620 0 ustar www-data www-data class <%= module_name %>::BasePresenter
end
versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_presenter_spec.rb 0000644 0000041 0000041 00000000131 13273750405 032626 0 ustar www-data www-data require '<%= @rspec_require_file %>'
describe <%= module_name %>::BasePresenter do
end
././@LongLink 0000644 0000000 0000000 00000000150 00000000000 011577 L ustar root root versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_controller_functional_test.rb versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_controller_functional_test0000644 0000041 0000041 00000000270 13273750405 034653 0 ustar www-data www-data require 'test_helper'
class <%= module_name %>::BaseControllerTest < ActionController::TestCase
# Replace this with your real tests.
test "the truth" do
assert true
end
end
versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_controller_spec.rb 0000644 0000041 0000041 00000000132 13273750405 033003 0 ustar www-data www-data require '<%= @rspec_require_file %>'
describe <%= module_name %>::BaseController do
end
versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_presenter_test_rails_5.rb 0000644 0000041 0000041 00000000264 13273750405 034300 0 ustar www-data www-data require 'test_helper'
class <%= module_name %>::BasePresenterTest < ActiveSupport::TestCase
# Replace this with your real tests.
test "the truth" do
assert true
end
end
././@LongLink 0000644 0000000 0000000 00000000160 00000000000 011600 L ustar root root versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_controller_functional_test_rails_5.rb versionist-1.7.0/lib/generators/versionist/new_api_version/templates/base_controller_functional_test0000644 0000041 0000041 00000000275 13273750405 034660 0 ustar www-data www-data require 'test_helper'
class <%= module_name %>::BaseControllerTest < ActionDispatch::IntegrationTest
# Replace this with your real tests.
test "the truth" do
assert true
end
end
versionist-1.7.0/lib/generators/versionist/new_api_version/new_api_version_generator.rb 0000644 0000041 0000041 00000015241 13273750405 032062 0 ustar www-data www-data module Versionist
class NewApiVersionGenerator < Rails::Generators::Base
include InflectorFixes
include RspecHelper
desc "creates the infrastructure for a new API version"
source_root File.expand_path('../templates', __FILE__)
argument :version, :type => :string
argument :module_name, :type => :string
class_option :default, :type => :boolean
class_option :header, :type => :hash, :group => :header
class_option :parameter, :type => :hash, :group => :parameter
class_option :path, :type => :hash, :group => :path
class_option :defaults, :type => :hash, :group => :defaults
def verify_options
raise "Must specify at least one versioning strategy option" if !['header', 'parameter', 'path'].any? {|strategy| options.has_key?(strategy)}
if options.has_key?("header")
raise "Must specify name and value for header versioning strategy" if !options["header"].has_key?("name") || !options["header"].has_key?("value")
end
if options.has_key?("parameter")
raise "Must specify name and value for parameter versioning strategy" if !options["parameter"].has_key?("name") || !options["parameter"].has_key?("value")
end
if options.has_key?("path")
raise "Must specify value for path versioning strategy" if !options["path"].has_key?("value")
end
end
def add_routes
in_root do
api_version_block = /api_version.*:module\s*(=>|:)\s*("|')#{module_name_for_route(module_name)}("|')/
matching_version_blocks = File.readlines("config/routes.rb").grep(api_version_block)
raise "API version already exists in config/routes.rb" if !matching_version_blocks.empty?
route_string = "api_version(:module => \"#{module_name_for_route(module_name)}\""
['header', 'parameter', 'path'].each do |versioning_strategy|
if options.has_key?(versioning_strategy)
options[versioning_strategy].symbolize_keys!
route_string << ", :#{versioning_strategy} => {#{options[versioning_strategy].to_s.gsub(/[\{\}]/, '').gsub('=>', ' => ')}}"
end
end
if options.has_key?('defaults')
options['defaults'].symbolize_keys!
route_string << ", :defaults => {#{options['defaults'].to_s.gsub(/[\{\}]/, '').gsub('=>', ' => ')}}"
end
if options.has_key?('default')
route_string << ", :default => true"
end
route_string << ") do\n end"
route route_string
end
end
def add_controller_base
in_root do
empty_directory "app/controllers/#{module_name_for_path(module_name)}"
template 'base_controller.rb', File.join("app", "controllers", "#{module_name_for_path(module_name)}", "base_controller.rb")
end
end
# due to the inflector quirks we can't use hook_for :test_framework
def add_controller_base_tests
in_root do
case Versionist.configuration.configured_test_framework
when :test_unit
empty_directory "test/#{Versionist.test_path}/#{module_name_for_path(module_name)}"
empty_directory "test/integration/#{module_name_for_path(module_name)}"
if Versionist.older_than_rails_5?
template 'base_controller_integration_test.rb', File.join("test", "integration", "#{module_name_for_path(module_name)}", "base_controller_test.rb")
template 'base_controller_functional_test.rb', File.join("test", "#{Versionist.test_path}", "#{module_name_for_path(module_name)}", "base_controller_test.rb")
else
template 'base_controller_functional_test_rails_5.rb', File.join("test", "#{Versionist.test_path}", "#{module_name_for_path(module_name)}", "base_controller_test_rails_5.rb")
end
when :rspec
@rspec_require_file = rspec_helper_filename
empty_directory "spec/controllers/#{module_name_for_path(module_name)}"
template 'base_controller_spec.rb', File.join("spec", "controllers", "#{module_name_for_path(module_name)}", "base_controller_spec.rb"), :assigns => { :rspec_require_file => @rspec_require_file }
empty_directory "spec/requests/#{module_name_for_path(module_name)}"
template 'base_controller_spec.rb', File.join("spec", "requests", "#{module_name_for_path(module_name)}", "base_controller_spec.rb"), :assigns => { :rspec_require_file => @rspec_require_file }
else
say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
end
end
end
def add_presenters_base
in_root do
empty_directory "app/presenters/#{module_name_for_path(module_name)}"
template 'base_presenter.rb', File.join("app", "presenters", "#{module_name_for_path(module_name)}", "base_presenter.rb")
end
end
def add_presenter_test
in_root do
case Versionist.configuration.configured_test_framework
when :test_unit
empty_directory "test/presenters/#{module_name_for_path(module_name)}"
if Versionist.older_than_rails_5?
template 'base_presenter_test.rb', File.join("test", "presenters", "#{module_name_for_path(module_name)}", "base_presenter_test.rb")
else
template 'base_presenter_test_rails_5.rb', File.join("test", "presenters", "#{module_name_for_path(module_name)}", "base_presenter_test_rails_5.rb")
end
when :rspec
@rspec_require_file = rspec_helper_filename
empty_directory "spec/presenters/#{module_name_for_path(module_name)}"
template 'base_presenter_spec.rb', File.join("spec", "presenters", "#{module_name_for_path(module_name)}", "base_presenter_spec.rb"), :assigns => { :rspec_require_file => @rspec_require_file }
else
say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
end
end
end
def add_helpers_dir
in_root do
empty_directory "app/helpers/#{module_name_for_path(module_name)}"
end
end
def add_helpers_test_dir
in_root do
case Versionist.configuration.configured_test_framework
when :test_unit
empty_directory "test/helpers/#{module_name_for_path(module_name)}"
when :rspec
empty_directory "spec/helpers/#{module_name_for_path(module_name)}"
else
say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
end
end
end
def add_documentation_base
in_root do
empty_directory "public/docs/#{version}"
template 'docs_index.rb', File.join("public", "docs", "#{version}", "index.html")
template 'docs_style.rb', File.join("public", "docs", "#{version}", "style.css")
end
end
end
end
versionist-1.7.0/lib/generators/versionist/new_api_version/USAGE 0000644 0000041 0000041 00000001450 13273750405 025064 0 ustar www-data www-data Description:
Creates the infrastructure for a new API version.
Example:
rails generate versionist:new_api_version v2.0.0 V2_0_0 header:Accept value:application/vnd.mycompany.com-v2.0.0
This will create:
route api_version(:module => "V2__0__0", :header=>"Accept", :value=>"application/vnd.mycompany.com-v2.0.0") do
end
create app/controllers/v2_0_0
create app/controllers/v2_0_0/base_controller.rb
create app/presenters/v2_0_0
create app/presenters/v2_0_0/base_presenter.rb
create public/docs/v2.0.0
create public/docs/v2.0.0/index.html
create public/docs/v2.0.0/style.css
In addition this will create tests for base_controller.rb and base_presenter.rb using the test_framework currently configured in your Rails app.
versionist-1.7.0/lib/generators/versionist/new_controller/ 0000755 0000041 0000041 00000000000 13273750405 024142 5 ustar www-data www-data versionist-1.7.0/lib/generators/versionist/new_controller/new_controller_generator.rb 0000644 0000041 0000041 00000005544 13273750405 031601 0 ustar www-data www-data module Versionist
class NewControllerGenerator < Rails::Generators::NamedBase
include InflectorFixes
include RspecHelper
desc "creates a new controller for an existing API version"
source_root File.expand_path('../templates', __FILE__)
argument :module_name, :type => :string
def new_controller
in_root do
raise "API module namespace #{module_name} doesn't exist. Please run \'rails generate versionist:new_api_version\' generator first" if !File.exists?("app/controllers/#{module_name_for_path(module_name)}")
template 'new_controller.rb', File.join("app", "controllers", "#{module_name_for_path(module_name)}", "#{file_name}_controller.rb")
api_version_block = /api_version.*:?module\s*(=>|:)\s*("|')#{module_name_for_route(module_name)}("|')/
new_route = " resources :#{file_name}\n"
matching_version_blocks = File.readlines("config/routes.rb").grep(api_version_block)
if matching_version_blocks.empty?
raise "API version doesn't exist in config/routes.rb. Please run \'rails generate versionist:new_api_version\' generator first"
elsif matching_version_blocks.size > 1
raise "API version is duplicated in config/routes.rb"
else
version_block = matching_version_blocks.first
inject_into_file "config/routes.rb", "#{new_route}", {:after => version_block, :verbose => false}
end
end
end
# due to the inflector quirks we can't use hook_for :test_framework
def new_controller_tests
in_root do
case Versionist.configuration.configured_test_framework
when :test_unit
if Versionist.older_than_rails_5?
template 'new_controller_integration_test.rb', File.join("test", "integration", "#{module_name_for_path(module_name)}", "#{file_name}_controller_test.rb")
template 'new_controller_functional_test.rb', File.join("test", "#{Versionist.test_path}", "#{module_name_for_path(module_name)}", "#{file_name}_controller_test.rb")
else
template 'new_controller_functional_test_rails_5.rb', File.join("test", "#{Versionist.test_path}", "#{module_name_for_path(module_name)}", "#{file_name}_controller_test_rails_5.rb")
end
when :rspec
@rspec_require_file = rspec_helper_filename
template 'new_controller_spec.rb', File.join("spec", "controllers", "#{module_name_for_path(module_name)}", "#{file_name}_controller_spec.rb"), :assigns => { :rspec_require_file => @rspec_require_file }
template 'new_controller_spec.rb', File.join("spec", "requests", "#{module_name_for_path(module_name)}", "#{file_name}_controller_spec.rb"), :assigns => { :rspec_require_file => @rspec_require_file }
else
say "Unsupported test_framework: #{Versionist.configuration.configured_test_framework}"
end
end
end
end
end
versionist-1.7.0/lib/generators/versionist/new_controller/templates/ 0000755 0000041 0000041 00000000000 13273750405 026140 5 ustar www-data www-data versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_spec.rb 0000644 0000041 0000041 00000000146 13273750405 032534 0 ustar www-data www-data require '<%= @rspec_require_file %>'
describe <%= module_name %>::<%= class_name%>Controller do
end
././@LongLink 0000644 0000000 0000000 00000000147 00000000000 011605 L ustar root root versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_integration_test.rb versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_integration_test.0000644 0000041 0000041 00000000312 13273750405 034633 0 ustar www-data www-data require 'test_helper'
class <%= module_name %>::<%= class_name%>ControllerTest < ActionDispatch::IntegrationTest
# Replace this with your real tests.
test "the truth" do
assert true
end
end
././@LongLink 0000644 0000000 0000000 00000000146 00000000000 011604 L ustar root root versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_functional_test.rb versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_functional_test.r0000644 0000041 0000041 00000000305 13273750405 034636 0 ustar www-data www-data require 'test_helper'
class <%= module_name %>::<%= class_name%>ControllerTest < ActionController::TestCase
# Replace this with your real tests.
test "the truth" do
assert true
end
end
versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller.rb 0000644 0000041 0000041 00000000136 13273750405 031521 0 ustar www-data www-data class <%= module_name %>::<%= class_name%>Controller < <%= module_name %>::BaseController
end
././@LongLink 0000644 0000000 0000000 00000000156 00000000000 011605 L ustar root root versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_functional_test_rails_5.rb versionist-1.7.0/lib/generators/versionist/new_controller/templates/new_controller_functional_test_r0000644 0000041 0000041 00000000312 13273750405 034715 0 ustar www-data www-data require 'test_helper'
class <%= module_name %>::<%= class_name%>ControllerTest < ActionDispatch::IntegrationTest
# Replace this with your real tests.
test "the truth" do
assert true
end
end
versionist-1.7.0/lib/generators/versionist/new_controller/USAGE 0000644 0000041 0000041 00000000562 13273750405 024734 0 ustar www-data www-data Description:
Creates a new controller class with the given name under the given module namespace
Example:
rails generate versionist:new_controller test V2_0_0
This will create:
app/controllers/V2_0_0/test_controller.rb
In addition this will create a test for the new controller using the test_framework currently configured in your Rails app.
versionist-1.7.0/lib/generators/versionist/rspec_helper.rb 0000644 0000041 0000041 00000000472 13273750405 024111 0 ustar www-data www-data module Versionist
module RspecHelper
# Gets the name of the helper file to require in spec files
# Accounting for rspec-rails 2 vs rspec-rails 3
def rspec_helper_filename
if File.exists? "spec/rails_helper.rb"
"rails_helper"
else
"spec_helper"
end
end
end
end
versionist-1.7.0/lib/versionist.rb 0000644 0000041 0000041 00000002130 13273750405 017256 0 ustar www-data www-data require 'active_support/dependencies/autoload'
module Versionist
extend ActiveSupport::Autoload
autoload :Configuration
autoload :InflectorFixes, "generators/versionist/inflector_fixes"
autoload :RspecHelper, "generators/versionist/rspec_helper"
autoload :CopyApiVersionGenerator, "generators/versionist/copy_api_version/copy_api_version_generator"
autoload :NewApiVersionGenerator, "generators/versionist/new_api_version/new_api_version_generator"
autoload :NewControllerGenerator, "generators/versionist/new_controller/new_controller_generator"
autoload :NewPresenterGenerator, "generators/versionist/new_presenter/new_presenter_generator"
autoload :VersioningStrategy, "versionist/versioning_strategy"
autoload :Middleware
autoload :Routing
def self.configuration
@@configuration ||= Configuration.new
end
def self.older_than_rails_5?
defined?(Rails) && Rails.version.to_i < 5
end
def self.test_path
return "test/functional" if older_than_rails_5?
"test/controllers"
end
end
require 'versionist/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
versionist-1.7.0/lib/versionist/ 0000755 0000041 0000041 00000000000 13273750405 016735 5 ustar www-data www-data versionist-1.7.0/lib/versionist/version.rb 0000644 0000041 0000041 00000000052 13273750405 020744 0 ustar www-data www-data module Versionist
VERSION = '1.7.0'
end
versionist-1.7.0/lib/versionist/railtie.rb 0000644 0000041 0000041 00000001072 13273750405 020713 0 ustar www-data www-data require 'rails/railtie'
module Versionist
class Railtie < Rails::Railtie
config.versionist = ActiveSupport::OrderedOptions.new
initializer 'versionist.configure' do |app|
ActionDispatch::Routing::Mapper.send :include, Versionist::Routing
end
config.app_middleware.use Versionist::Middleware
config.after_initialize do
generators = config.respond_to?(:app_generators) ? config.app_generators : config.generators
Versionist.configuration.configured_test_framework = generators.options[:rails][:test_framework]
end
end
end
versionist-1.7.0/lib/versionist/routing.rb 0000644 0000041 0000041 00000007675 13273750405 020770 0 ustar www-data www-data require 'active_support/core_ext/hash/keys'
module Versionist
module Routing
# Allows you to constrain routes to specific versions of your api using versioning strategies.
# Supported formats:
#
# HTTP Header
# api_version(:module => "V1", :header => {:name => "Accept", :value => "application/vnd.mycompany.com; version=1"}})
#
# Path
# api_version(:module => "V1", :path => {:value => "v1"}})
#
# Request Parameter
# api_version(:module => "V1", :parameter => {:name => "version", :value => "1"}})
#
# Specifying default version:
# api_version(:module => "V1", :default => true, :header => {:name => "Accept", :value => "application/vnd.mycompany.com; version=1"}})
#
# Multiple Strategies per version
# api_version(:module => "V1", :header => {:name => "Accept", :value => "application/vnd.mycompany.com; version=1"}, :path => {:value => "v1"})
def api_version(config, &block)
raise ArgumentError, "you must pass a configuration Hash to api_version" if config.nil? || !config.is_a?(Hash)
config.symbolize_keys!
raise ArgumentError, "you must specify :header, :path, or :parameter in configuration Hash passed to api_version" if !config.has_key?(:header) && !config.has_key?(:path) && !config.has_key?(:parameter)
[:header, :path, :parameter].each do |s|
raise ArgumentError, "#{s} key in configuration Hash passed to api_version must point to a Hash" if config.has_key?(s) && !config[s].is_a?(Hash)
end
raise ArgumentError, "you must specify :module in configuration Hash passed to api_version" if !config.has_key?(:module)
raise ArgumentError, ":defaults must be a Hash" if config.has_key?(:defaults) && !config[:defaults].is_a?(Hash)
rails_quirks(config, &block)
configure_header(config, &block) if config.has_key?(:header)
configure_path(config, &block) if config.has_key?(:path)
configure_parameter(config, &block) if config.has_key?(:parameter)
configure_default(config, &block) if config.has_key?(:default) && config[:default]
end
private
def configure_header(config, &block)
header = Versionist::VersioningStrategy::Header.new(config)
route_hash = {:module => config[:module], :constraints => header}
route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
scope(route_hash, &block)
end
def configure_path(config, &block)
config[:path][:value].slice!(0) if config[:path][:value] =~ /^\//
path = Versionist::VersioningStrategy::Path.new(config)
# Use the :as option and strip out non-word characters from the path to avoid this:
# https://github.com/rails/rails/issues/3224
route_hash = {:module => config[:module], :as => config[:path][:value].gsub(/\W/, '_')}
route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
namespace(config[:path][:value], route_hash, &block)
end
def configure_parameter(config, &block)
parameter = Versionist::VersioningStrategy::Parameter.new(config)
route_hash = {:module => config[:module], :constraints => parameter}
route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
scope(route_hash, &block)
end
def configure_default(config, &block)
default = Versionist::VersioningStrategy::Default.new(config)
route_hash = {:module => config[:module], :constraints => default, :as => 'default'}
route_hash.merge!({:defaults => config[:defaults]}) if config.has_key?(:defaults)
scope(route_hash, &block)
end
# deals with quirks in routing among the various Rails versions
def rails_quirks(config, &block)
# Rails 4 no longer allows constant syntax in routing.
# https://github.com/bploetz/versionist/issues/39
# call underscore on the module so it adheres to this convention
config[:module] = config[:module].underscore if Rails::VERSION::MAJOR >= 4
end
end
end
versionist-1.7.0/lib/versionist/configuration.rb 0000644 0000041 0000041 00000001174 13273750405 022134 0 ustar www-data www-data module Versionist
class Configuration
attr_accessor :versioning_strategies
attr_accessor :default_version
attr_accessor :header_versions
attr_accessor :parameter_versions
attr_accessor :path_versions
attr_accessor :configured_test_framework
def initialize
@versioning_strategies ||= Array.new
@header_versions ||= Array.new
@parameter_versions ||= Array.new
@path_versions ||= Array.new
end
def clear!
@versioning_strategies.clear
@default_version = nil
@header_versions.clear
@parameter_versions.clear
@path_versions.clear
end
end
end
versionist-1.7.0/lib/versionist/versioning_strategy/ 0000755 0000041 0000041 00000000000 13273750405 023042 5 ustar www-data www-data versionist-1.7.0/lib/versionist/versioning_strategy/default.rb 0000644 0000041 0000041 00000002234 13273750405 025014 0 ustar www-data www-data module Versionist
module VersioningStrategy
# Implements the default version handling strategy.
class Default < Base
attr_accessor :strategies
attr_accessor :module
def initialize(config)
super
@module = config[:module]
raise ArgumentError, "[VERSIONIST] attempt to set more than one default api version" if !Versionist.configuration.default_version.nil? && Versionist.configuration.default_version != self
Versionist.configuration.default_version = self
end
def matches?(request)
!header_matches?(request) && !parameter_matches?(request)
end
def ==(other)
super
return false if !other.is_a?(Versionist::VersioningStrategy::Default)
return self.module == other.module
end
private
def header_matches?(request)
Versionist.configuration.header_versions && Versionist.configuration.header_versions.any? {|v| v.matches?(request)}
end
def parameter_matches?(request)
Versionist.configuration.parameter_versions && Versionist.configuration.parameter_versions.any? {|v| v.matches?(request)}
end
end
end
end
versionist-1.7.0/lib/versionist/versioning_strategy/header.rb 0000644 0000041 0000041 00000003436 13273750405 024625 0 ustar www-data www-data module Versionist
module VersioningStrategy
# Implements the header versioning strategy.
class Header < Base
# Creates a new Header VersioningStrategy object. config must contain the following keys:
# - :header the header hash to inspect
def initialize(config)
super
raise ArgumentError, "you must specify :name in the :header configuration Hash" if !config[:header].has_key?(:name)
raise ArgumentError, "you must specify :value in the :header configuration Hash" if !config[:header].has_key?(:value)
Versionist.configuration.header_versions << self if !Versionist.configuration.header_versions.include?(self)
end
def matches?(request)
header_string = request.headers[config[:header][:name]].to_s
if !header_string.blank?
potential_matches = Versionist.configuration.header_versions.select {|hv| header_string.include?(hv.config[:header][:value])}
if !potential_matches.empty?
if potential_matches.include?(self)
if potential_matches.size == 1
return true
else
# when finding multiple potential matches, the match with the longest value wins
# (i.e. v2.1 trumps v2), as one is a subset of the other
longest = potential_matches.max {|a,b| a.config[:header][:value].length <=> b.config[:header][:value].length}
return longest == self
end
end
end
end
false
end
def ==(other)
super
return false if !other.is_a?(Versionist::VersioningStrategy::Header)
return config[:header][:name] == other.config[:header][:name] && self.config[:header][:value] == other.config[:header][:value]
end
end
end
end
versionist-1.7.0/lib/versionist/versioning_strategy/base.rb 0000644 0000041 0000041 00000001206 13273750405 024300 0 ustar www-data www-data require 'active_support/core_ext/hash/keys'
module Versionist
module VersioningStrategy
class Base
attr_reader :config
def initialize(config={})
raise ArgumentError, "you must pass a configuration Hash" if config.nil? || !config.is_a?(Hash)
@config = config
@config.symbolize_keys!
Versionist.configuration.versioning_strategies << self if !Versionist.configuration.versioning_strategies.include?(self)
end
def ==(other)
return false if other.nil? || !other.is_a?(Versionist::VersioningStrategy::Base)
return self.config == other.config
end
end
end
end
versionist-1.7.0/lib/versionist/versioning_strategy/parameter.rb 0000644 0000041 0000041 00000002267 13273750405 025356 0 ustar www-data www-data module Versionist
module VersioningStrategy
# Implements the parameter versioning strategy.
class Parameter < Base
# Creates a new Parameter VersioningStrategy object. config must contain the following keys:
# - :parameter the parameter hash to inspect
def initialize(config)
super
raise ArgumentError, "you must specify :name in the :parameter configuration Hash" if !config[:parameter].has_key?(:name)
raise ArgumentError, "you must specify :value in the :parameter configuration Hash" if !config[:parameter].has_key?(:value)
Versionist.configuration.parameter_versions << self if !Versionist.configuration.parameter_versions.include?(self)
end
def matches?(request)
parameter_string = request.params[config[:parameter][:name]].to_s
return !parameter_string.blank? && parameter_string == config[:parameter][:value]
end
def ==(other)
super
return false if !other.is_a?(Versionist::VersioningStrategy::Parameter)
return config[:parameter][:name] == other.config[:parameter][:name] && self.config[:parameter][:value] == other.config[:parameter][:value]
end
end
end
end
versionist-1.7.0/lib/versionist/versioning_strategy/path.rb 0000644 0000041 0000041 00000001466 13273750405 024332 0 ustar www-data www-data module Versionist
module VersioningStrategy
# Implements the path versioning strategy. It expects the following path format:
# GET /