service_authenticator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cf407f740bb695d7cd924063d16cfc255afcf66
+  data.tar.gz: f2bf444ad455684920398d35ea4412d8ac8f042f
+SHA512:
+  metadata.gz: 43768479591d94e0221b0378daf3d970ca75deb9558c35464e6e48ab11ce171e840b263aa28259bc38a5e5428f27e84894e69a19588ea8cc0e95b6edf8b3168c
+  data.tar.gz: dc709311501a630d6558284d77aff2be10252f78050fe79f90906dbd5c9c7a53bfcaa94187fb2ba7ee7ba0fe7c63e16138f19661cbb29f63d68807d39d90a315

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in service_authenticator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryan Beckman
+
+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,85 @@
+# ServiceAuthenticator
+
+This is a lightweight gem built for the purposes of creating consistent configuration between services. Using this gem, you can store all service keys used for transactions between services on the ServiceAuthenticator::KeyChain and validate that any incoming requests to a service are using a valid key using ServiceAuthenticator::KeyValidator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'service_authenticator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_authenticator
+
+## Usage
+
+ServiceAuthenticator was built to make the actual implementation of the gem as flexible as possible. With that in mind, here are a few examples of how ServiceAuthenticator can be used in an application:
+
+1) Configuration of environment variables in a Rails initializer
+
+```ruby
+#config/initializers/client_keys.rb
+
+keychain_config = YAML.load(File.read(Rails.root.join('config', 'client_keys.yml')))[Rails.env].try(:deep_symbolize_keys!) || {
+  example_service_one: [ENV['EXAMPLE_SERVICE_ONE_CLIENT_KEY']],
+  example_service_two: [ENV['EXAMPLE_SERVICE_TWO_CLIENT_KEY']],
+}
+
+ServiceAuthenticator::KeyChain.add_keys do |keys|
+  keys.example_service_one = keychain_config[:example_service_one]
+  keys.example_service_two = keychain_config[:example_service_two]
+end
+```
+
+Those keys can later be accessed using
+```ruby
+ServiceAuthenticator::KeyChain.keys
+```
+
+2) Creating a controller concern to handle incoming client requests
+
+```ruby
+#app/controllers/concerns/client_key_validator.rb
+
+module ClientKeyValidator
+  def validate_client_key(client_service)
+    unless key_validator(client_service).valid_key?(key)
+      render json: { message: 'invalid client key' }, status: 401
+    end
+  end
+
+  private
+
+  def key
+    @key ||= request.env["HTTP_CLIENT_KEY"] || params[:client_key]
+  end
+
+  def key_validator(client_service)
+    @key_validator ||= ServiceAuthenticator::KeyValidator.new(client_service)
+  end
+end
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/service_authenticator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "service_authenticator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/service_authenticator/key_chain/key_chain_error/service_not_configured_error.rb

@@ -0,0 +1,27 @@
+require 'active_support/inflector'
+
+module ServiceAuthenticator
+  module KeyChain
+    module KeyChainError
+      class ServiceNotConfiguredError < StandardError
+        def initialize(service = nil)
+          @service = service
+        end
+
+        def to_s
+          if @service
+            "#{titleized_service} service key not configured"
+          else
+            "Service key not configured"
+          end
+        end
+
+        private
+
+        def titleized_service
+          @service.to_s.titleize
+        end
+      end
+    end
+  end
+end

data/lib/service_authenticator/key_chain.rb

@@ -0,0 +1,13 @@
+require 'ostruct'
+
+module ServiceAuthenticator
+  module KeyChain
+    def self.add_keys
+      yield keys
+    end
+
+    def self.keys
+      @keys ||= OpenStruct.new
+    end
+  end
+end

data/lib/service_authenticator/key_validator.rb

@@ -0,0 +1,22 @@
+module ServiceAuthenticator
+  class KeyValidator
+    KEY_CHAIN = KeyChain.keys
+
+    def initialize(external_service)
+      @external_service = external_service
+
+      raise KeyChain::KeyChainError::ServiceNotConfiguredError.new(@external_service) if service_key_set.nil?
+    end
+
+    def valid_key?(service_key)
+      return false if service_key.nil?
+      service_key_set.include?(service_key)
+    end
+
+    private
+
+    def service_key_set
+      KEY_CHAIN.public_send(@external_service)
+    end
+  end
+end

data/lib/service_authenticator/version.rb

@@ -0,0 +1,3 @@
+module ServiceAuthenticator
+  VERSION = "1.0.0"
+end

data/lib/service_authenticator.rb

@@ -0,0 +1,3 @@
+Gem.find_files("service_authenticator/**/*.rb").each { |path| require path }
+
+module ServiceAuthenticator; end

data/service_authenticator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_authenticator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_authenticator"
+  spec.version       = ServiceAuthenticator::VERSION
+  spec.authors       = ["Ryan Beckman"]
+  spec.email         = ["beckman.ryan@gmail.com"]
+
+  spec.summary       = %q{Simple authentication between services.}
+  spec.description   = %q{This allows for lightweight storage and authentication of API keys used between services.}
+  spec.homepage      = "https://github.com/zaldabus/service_authenticator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: service_authenticator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Beckman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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'
+description: This allows for lightweight storage and authentication of API keys used
+  between services.
+email:
+- beckman.ryan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/service_authenticator.rb
+- lib/service_authenticator/key_chain.rb
+- lib/service_authenticator/key_chain/key_chain_error/service_not_configured_error.rb
+- lib/service_authenticator/key_validator.rb
+- lib/service_authenticator/version.rb
+- service_authenticator.gemspec
+homepage: https://github.com/zaldabus/service_authenticator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Simple authentication between services.
+test_files: []