➕ version_gem (extracted from oauth2)

Author: pboling

CHANGELOG.md

@@ -13,12 +13,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
-## [0.6.0] 2022-05-04
+## [0.6.0] 2022-08-23
 ### Added
-* Made a new option `body_hash_enabled` which defaults to true to maintain backward compatibility with prior releases. Setting to `false` disables generation of a `oauth_body_hash` component as part of the signature computation.
-* Improved documentation of support policy
+* New option `body_hash_enabled` which defaults to true to maintain backward compatibility with prior releases. Setting to `false` disables generation of a `oauth_body_hash` component as part of the signature computation.
+* Improved documentation of support policy via Tidelift
 * Stop testing against active_support v2
 
+### Changed
+* Utilize version_gem extracted from oauth2 gem for VERSION
+  * Added new `OAuth::Version` namespace
+  * VERSION constant now at `OAuth::Version::VERSION`
+
 ### Removed
 * Ruby 2.0, 2.1, 2.2, and 2.3 are no longer valid install targets
 
@@ -297,7 +302,7 @@ The "Can it be the end of the line for 0.5.x?" Release
 
 ## [0.3.4] 2009-05-06
 ### Changed
-* OAuth::Client::Helper uses OAuth::VERSION (chadisfaction)
+* OAuth::Client::Helper uses OAuth::Version::VERSION (chadisfaction)
 
 ### Fixed
 * Fix OAuth::RequestProxy::ActionControllerRequest's handling of params (Tristan Groléat)

lib/oauth.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-root = File.dirname(__FILE__)
-$LOAD_PATH << root unless $LOAD_PATH.include?(root)
+# third party gems
+require "version_gem"
 
 require "oauth/version"
 
@@ -13,3 +13,7 @@
 require "oauth/signature/hmac/sha256"
 require "oauth/signature/rsa/sha1"
 require "oauth/request_proxy/mock_request"
+
+OAuth::Version.class_eval do
+  extend VersionGem::Basic
+end

lib/oauth/cli/version_command.rb

@@ -4,7 +4,7 @@ module OAuth
   class CLI
     class VersionCommand < BaseCommand
       def run
-        puts "OAuth Gem #{OAuth::VERSION}"
+        puts "OAuth Gem #{OAuth::Version::VERSION}"
       end
     end
   end

lib/oauth/client/helper.rb

@@ -71,7 +71,7 @@ def hash_body
       end
 
       def amend_user_agent_header(headers)
-        @oauth_ua_string ||= "OAuth gem v#{OAuth::VERSION}"
+        @oauth_ua_string ||= "OAuth gem v#{OAuth::Version::VERSION}"
         # Net::HTTP in 1.9 appends Ruby
         if headers["User-Agent"] && headers["User-Agent"] != "Ruby"
           headers["User-Agent"] += " (#{@oauth_ua_string})"

lib/oauth/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module OAuth
-  VERSION = "0.6.0"
+  module Version
+    VERSION = "0.6.0"
+  end
 end

oauth.gemspec

@@ -3,8 +3,10 @@
 require_relative "lib/oauth/version"
 
 Gem::Specification.new do |spec|
+  spec.add_dependency("version_gem", "~> 1.1")
+
   spec.name    = "oauth"
-  spec.version = OAuth::VERSION
+  spec.version = OAuth::Version::VERSION
   spec.license = "MIT"
 
   spec.authors     = ["Pelle Braendgaard", "Blaine Cook", "Larry Halff", "Jesse Clark", "Jon Crosby",

test/units/cli_test.rb

@@ -69,7 +69,7 @@ def test_help
   def test_version
     out = run_command(%w[version])
 
-    assert_equal "OAuth Gem #{OAuth::VERSION}\n", out
+    assert_equal "OAuth Gem #{OAuth::Version::VERSION}\n", out
   end
 
   def test_query_empty

test/units/net_http_client_test.rb

@@ -91,15 +91,15 @@ def test_that_version_is_added_to_existing_user_agent
     request.set_form_data(@request_parameters)
     request.oauth!(@http, @consumer, @token, { nonce: @nonce, timestamp: @timestamp })
 
-    assert_equal "MyApp (OAuth gem v#{OAuth::VERSION})", request["User-Agent"]
+    assert_equal "MyApp (OAuth gem v#{OAuth::Version::VERSION})", request["User-Agent"]
   end
 
   def test_that_version_is_set_when_no_user_agent
     request = Net::HTTP::Post.new(@request_uri.path)
     request.set_form_data(@request_parameters)
     request.oauth!(@http, @consumer, @token, { nonce: @nonce, timestamp: @timestamp })
 
-    assert_equal "OAuth gem v#{OAuth::VERSION}", request["User-Agent"]
+    assert_equal "OAuth gem v#{OAuth::Version::VERSION}", request["User-Agent"]
   end
 
   def test_that_using_get_params_works