config_server_agent 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 344ef40b40e8878b43c97010628fdc601e7cf743486105211c3ccf04d4a06c08
-  data.tar.gz: 24fcc8fd7e0316ce8bada8f5e7b51f5726fc38ea6ea953f900b38bc5b510d4e0
+  metadata.gz: 14de15ba41b3745d5e2bb54a29534d0a47aa58af4d5c029b2b9b611eec62865f
+  data.tar.gz: 9f45eb09fa4ee9d0b3b4c9d12e374b42e65350502cf5d4c27cbcbe95fff92cdd
 SHA512:
-  metadata.gz: 9b1eb8afd72531182a10cdd6db766ba94373fc0480283496a4575509e76cc42345d3c79d55f88eee83ac94a9cad25a329812d4e651b2e6c76a2ac57c273a289b
-  data.tar.gz: abf76b59135ce2368366c0a817741b22f8876451b19d7800eba97178cd90e39496c2ad1ae9cfe854ff2e88782b4a3a4c29513870ebea9b7415c0f9b68a03d8c5
+  metadata.gz: d5c12f02a2b353c43b38a62823c08b9f94ad138346544b660d127d5ec5bb1b40024c0e2e1ba8b9d942ff0ad95da85992605847cd1ed0a8ca73581dccccb56327
+  data.tar.gz: 9d47199e4a9df1f295bfd29c598cd9fc8c5f4d8b701251378744198107e6dbd4a34a12d47406bc37142c7415b97659413e5afae2762172ad7ae7fdb9a5165dd2

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.3.4 - 2019-06-12
+### Changed
+- Added optional token caching
+
 ## 0.3.3 - 2019-06-03
 ### Changed
 - Added get_selected_config helper method

data/config_server_agent.gemspec

@@ -44,6 +44,8 @@ Gem::Specification.new do |spec|
 
 	spec.required_ruby_version = '>= 2.3.0'
 
+	spec.add_dependency 'lockfile', '~> 2.1'
+
 	spec.add_development_dependency 'bundler', '~> 1.17'
 	spec.add_development_dependency 'rake', '~> 10.0'
 	spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/config_server_agent/version.rb

@@ -1,3 +1,3 @@
 class ConfigServerAgent
-	VERSION = "0.3.3"
+	VERSION = '0.3.4'
 end

data/lib/config_server_agent.rb

@@ -3,6 +3,8 @@
 require 'config_server_agent/version'
 require 'net/http'
 require 'json'
+require 'digest/sha1'
+require 'lockfile'
 
 class ConfigServerAgent
 	class Error < StandardError; end
@@ -16,7 +18,9 @@ class ConfigServerAgent
 		config_server_host:     ENV['CONFIG_SERVER_HOST'],
 		user_agent:             "ConfigServerAgent/#{ConfigServerAgent::VERSION}",
 		user_agent_comment:     nil,
-		token_ttl:              60 * 60 * 24
+		token_ttl:              nil,
+		use_cache:              false,
+		cache_file:             nil
 	)
 		@auth0_client_id        = auth0_client_id        or raise ArgumentError, 'Missing auth0_client_id parameter'
 		@auth0_client_secret    = auth0_client_secret    or raise ArgumentError, 'Missing auth0_client_secret parameter'
@@ -30,9 +34,13 @@ class ConfigServerAgent
 		@user_agent = user_agent
 		@user_agent += " (#{user_agent_comment})" if user_agent_comment
 
-		@token_birthday = nil
-		@token          = nil
-		@token_ttl      = token_ttl
+		@token_expires = nil
+		@token         = nil
+		@token_ttl     = token_ttl
+		@token_buffer  = 10
+
+		@use_cache     = use_cache
+		@cache_file    = cache_file || '/tmp/' + Digest::SHA1.hexdigest("#{auth0_client_id}/#{ConfigServerAgent::VERSION}") + '.json'
 	end
 
 	def get_config
@@ -107,30 +115,62 @@ class ConfigServerAgent
 	end
 
 	def get_token
-		if @token.nil? or @token_timestamp.nil? or @token_timestamp <= Time.now.to_i
-			url  = URI "https://#{@auth0_host}/oauth/token"
-			http = Net::HTTP.new url.host, url.port
-			http.use_ssl = url.scheme == 'https'
-
-			request = Net::HTTP::Post.new url
-			request['user-agent'] = @user_agent
-			request['content-type'] = 'application/json'
-			request.body = {
-				client_id:     @auth0_client_id,
-				client_secret: @auth0_client_secret,
-				audience:      @config_server_audience,
-				grant_type:    'client_credentials',
-			}.to_json
-
-			response = http.request request
-			@token = JSON.parse(response.read_body)["access_token"] or raise Error, "No token from #{@auth0_host}"
-			@token_timestamp = Time.now.to_i + @token_ttl
+		if @token.nil? and @use_cache
+			read_token_cache
+		end
+
+		if @token.nil? or (@token_expires and @token_expires < Time.now.to_i)
+			request_new_token
+			write_token_cache if @use_cache
 		end
 
+		@token
+	end
+
+	def request_new_token
+		url  = URI "https://#{@auth0_host}/oauth/token"
+		http = Net::HTTP.new url.host, url.port
+		http.use_ssl = url.scheme == 'https'
+
+		request = Net::HTTP::Post.new url
+		request['user-agent'] = @user_agent
+		request['content-type'] = 'application/json'
+		request.body = {
+			client_id:     @auth0_client_id,
+			client_secret: @auth0_client_secret,
+			audience:      @config_server_audience,
+			grant_type:    'client_credentials',
+		}.to_json
+
+		response = JSON.parse http.request(request).read_body
+		@token = response['access_token'] or raise Error, "No token from #{@auth0_host}"
+		@token_expires = Time.now.to_i + (@token_ttl || response['expires_in']) - @token_buffer
+
 		@token
 
 	rescue JSON::ParserError
 		raise Error, "Invalid response from #{@auth0_host}"
 	end
 
+	def read_token_cache
+		with_lock do
+			@token, @token_expires = JSON.parse(File.read @cache_file).values_at 'token', 'token_expires'
+		end if File.file? @cache_file
+	end
+
+	def write_token_cache
+		with_lock do
+			File.write(@cache_file, {
+				'token' => @token,
+				'token_expires' => @token_expires
+			}.to_json)
+		end
+	end
+
+	def with_lock
+		Lockfile.new("/var/lock/config_server_agent.rb.lock", retries: 3, poll_retries: 3) do
+			yield
+		end
+	end
+
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: config_server_agent
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Aidan Samuel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-03 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lockfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement