config_server_agent 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cba5de75917c2c406b472c604ce084f0c051625c5e24b547b57fe594ca03c2f1
+  data.tar.gz: 72c253ecbf9ef983bcfec697c57847eb7945d997a3a9ca151fd50672278d51ba
+SHA512:
+  metadata.gz: 5b928f1c843ea560eea1568c672008e5efe9e2fa6b0d0168603664b4d884acc8dd36b1fab9ed5e5ab57627618ba95da64a5076b4f03789782a4efa7359ef4e2b
+  data.tar.gz: 0defd64e147843af7ad7d79ff38326c06d5d83d3f4d9e81f0cf439e88dc152379ea0f34d31865aa87f8edb435f509a5e3a920316236b0eb02cd9b389f02bbe60

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.17.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+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.1.0 - 2018-12-06
+### Added
+- Initial commit

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 TODO: Write your email address. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in config_server_agent.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Aidan Samuel
+
+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,83 @@
+# ConfigServerAgent
+
+This is a client for the Config Server project. It allows you to retrieve configuration for your Ruby project.
+
+The first time `get_config` is called, `ConfigServerAgent` will request your config pack from the configured Config Server. This will be cached and returned on subsequent calls to `get_config`, without further requests being made to the Config Server.
+
+Call `clear` to clear the cache. The next call to `get_config` will cause the Config Server to be contacted again.
+
+It is thread safe.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'config_server_agent'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install config_server_agent
+
+## Usage
+
+`ConfigServerAgent` requires six parameters to operate correctly. These parameters can either be explicitly provided to theq constructor, or they will be pulled from environment variables. An `ArgumentError` will be raised if the parameters are not available for either source. Parameters supplied to the constructor will take precedence over environment variables.
+
+```ruby
+# Providing explicitly:
+client = ConfigServerAgent.new(
+	auth0_client_id: '4F4l7leKKigMN8CziKpgjvXGKrihih1F',
+	auth0_client_secret: '3SrKmNAdKNzFBA3Lb6fgnTDyyFOQLt7hREWSlcU9QGc1SMKNKRL9DqmxyXQerS0E',
+	auth0_host: 'yourdomain.au.auth0.com',
+	config_server_audience: 'https://yourdomain.com',
+	config_server_api_key: 'Rd5N9hQlbkK7pYxMZGGsQAv...snip...C2OpRq9hEIGtp4Aw6OpEOsec5==',
+	config_server_host: 'https://your.config.server.com'
+)
+
+# Using environment variables:
+client = ConfigServerAgent.new
+# ConfigServerAgent will raise an exception if any of the following environment variables are not set:
+# AUTH0_CLIENT_ID
+# AUTH0_CLIENT_SECRET
+# AUTH0_HOST
+# CONFIG_SERVER_AUDIENCE
+# CONFIG_SERVER_API_KEY
+# CONFIG_SERVER_HOST
+
+client.get_config
+# => [{"id"=>"2481ea78-7699-4f59-8639-7992a6440c0f",
+#   "value"=>"Braintree",
+#   "name"=>"default_gateway",
+#   "area"=>"Payments",
+#   "created_at"=>"2018-12-06T00:39:12.236Z",
+#   "updated_at"=>"2018-12-06T00:39:12.236Z"},
+#  {"id"=>"02c74435-5309-4b7f-9a83-353cbf43e8cf",
+#   "value"=>false,
+#   "name"=>"payments_enabled",
+#   "area"=>"Payments",
+#   "created_at"=>"2018-12-06T00:39:12.240Z",
+#   "updated_at"=>"2018-12-06T00:39:12.240Z"},
+#  {"id"=>"17a0abc2-a0ac-4a2a-bfad-45a4e2afc00f",
+#   "value"=>"L68Wh+[foZCVW/y3h",
+#   "name"=>"account_password",
+#   "area"=>"Payments",
+#   "created_at"=>"2018-11-27T06:49:37.841Z",
+#   "updated_at"=>"2018-11-27T06:49:37.841Z"}]
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `rake console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+To experiment with that code, run `rake console` for an interactive prompt.
+
+## 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,15 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+	t.libs << "test"
+	t.libs << "lib"
+	t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc "Run an interactive Pry console"
+task :console do
+	exec 'pry -I ./lib -r config_server_agent'
+end

data/config_server_agent.gemspec

@@ -0,0 +1,53 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "config_server_agent/version"
+
+Gem::Specification.new do |spec|
+	spec.name          = "config_server_agent"
+	spec.version       = ConfigServerAgent::VERSION
+	spec.authors       = ["Aidan Samuel"]
+	spec.email         = ["aidan.samuel@supporterhub.com"]
+
+	spec.summary       = "A thread-safe caching client for Config Server"
+	spec.description   = <<-EOM.gsub(/[\n\s]+/, ' ')
+		Use this client to retrieve your configuration from a Config Server.
+		The required parameters can either be supplied to the constructor, or
+		they will be pulled from environment variables. An ArgumentError will
+		be raised if the parameters are not available for either source.
+		Parameters supplied to the constructor will take precedence over environment
+		variables.
+	EOM
+	spec.homepage      = "https://bitbucket.org/supporterhub/"
+	spec.license       = "MIT"
+
+	# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+	# to allow pushing to a single host or delete this section to allow pushing to any host.
+	if spec.respond_to?(:metadata)
+		spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+		spec.metadata["homepage_uri"] = spec.homepage
+		spec.metadata["source_code_uri"] = "https://bitbucket.org/supporterhub/config_server_agent"
+		spec.metadata["changelog_uri"] = "https://bitbucket.org/supporterhub/config_server_agent/srv/master/CHANGELOG.md"
+	else
+		raise "RubyGems 2.0 or newer is required to protect against " \
+			"public gem pushes."
+	end
+
+	# 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('..', __FILE__)) 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 = ["lib"]
+
+	spec.required_ruby_version = '>= 2.3.0'
+
+	spec.add_development_dependency "bundler", "~> 1.17"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "minitest", "~> 5.0"
+	spec.add_development_dependency "pry", "~> 0.10"
+	spec.add_development_dependency "webmock", "~> 2.0"
+end

data/lib/config_server_agent.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "config_server_agent/version"
+require "net/http"
+require "json"
+
+class ConfigServerAgent
+	class Error < StandardError; end
+
+	def initialize(
+		auth0_client_id:        ENV['AUTH0_CLIENT_ID'],
+		auth0_client_secret:    ENV['AUTH0_CLIENT_SECRET'],
+		auth0_host:             ENV['AUTH0_HOST'],
+		config_server_audience: ENV['CONFIG_SERVER_AUDIENCE'],
+		config_server_api_key:  ENV['CONFIG_SERVER_API_KEY'],
+		config_server_host:     ENV['CONFIG_SERVER_HOST']
+	)
+		@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"
+		@auth0_host             = auth0_host             or raise ArgumentError, "Missing auth0_host parameter"
+		@config_server_audience = config_server_audience or raise ArgumentError, "Missing config_server_audience parameter"
+		@config_server_api_key  = config_server_api_key  or raise ArgumentError, "Missing config_server_api_key parameter"
+		@config_server_host     = config_server_host     or raise ArgumentError, "Missing config_server_host parameter"
+		@config = nil
+		@mutex = Mutex.new
+	end
+
+	def get_config
+		return @config if @config
+		@mutex.synchronize do
+			@config ||= _get_config
+		end
+	end
+
+	def clear
+		@config = nil
+	end
+
+	private
+
+	def _get_config
+
+		token = get_token
+
+		url  = URI "#{@config_server_host}/api/config_pack"
+		http = Net::HTTP.new url.host, url.port
+		http.use_ssl = url.scheme == 'https'
+
+		request = Net::HTTP::Post.new url
+		request['content-type']  = 'application/json'
+		request['authorization'] = "Bearer #{token}"
+		request['accept']        = 'application/json'
+		request.body = { api_key: @config_server_api_key }.to_json
+
+		response = http.request request
+		JSON.parse response.read_body
+	end
+
+	def get_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['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
+		JSON.parse(response.read_body)["access_token"] or raise Error, "No token from #{@auth0_host}"
+
+	rescue JSON::ParserError
+		raise Error, "Invalid response from #{@auth0_host}"
+
+	end
+
+end

data/lib/config_server_agent/version.rb

@@ -0,0 +1,3 @@
+class ConfigServerAgent
+	VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: config_server_agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Samuel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: " Use this client to retrieve your configuration from a Config Server.
+  The required parameters can either be supplied to the constructor, or they will
+  be pulled from environment variables. An ArgumentError will be raised if the parameters
+  are not available for either source. Parameters supplied to the constructor will
+  take precedence over environment variables. "
+email:
+- aidan.samuel@supporterhub.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config_server_agent.gemspec
+- lib/config_server_agent.rb
+- lib/config_server_agent/version.rb
+homepage: https://bitbucket.org/supporterhub/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://bitbucket.org/supporterhub/
+  source_code_uri: https://bitbucket.org/supporterhub/config_server_agent
+  changelog_uri: https://bitbucket.org/supporterhub/config_server_agent/srv/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A thread-safe caching client for Config Server
+test_files: []