bamboo-id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4e7c1e3eda03ee309dd4302dfee5a67beedf598
+  data.tar.gz: 4c6089b7a0cfa21b6f9a4a84a6c2a9741b6bc43c
+SHA512:
+  metadata.gz: 7f51afe7ae438c5b85baf85e05d2d072bdb9d4cebc853d6573b9440cf531f7be461e11cd656798d36ab3bee88b788267cd8fa81107b6077890b8ed073172c216
+  data.tar.gz: d410e30713314f49ca531965ed792450a1886b9c8957761966ef9e7a746c11245444393619f1363cb4397e8a34c435599aeab5285e6c7f99e254446504116108

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

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 joncodes+github@gmail.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bamboo_id.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jon Evans
+
+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,62 @@
+# BambooId
+
+Makes connecting to BambooHR with OpenID easier.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bamboo-id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bamboo-id
+
+## Usage
+
+### Configuration
+
+`Bamboo::Configuration.redirect_url` must be set.
+
+The following environment variables are also required:
+- `BAMBOO_APPLICATION_KEY`
+- `BAMBOO_CLIENT_ID`
+- `BAMBOO_CLIENT_SECRET`
+
+### Authorizing
+
+To get the initial authorization URL, use `BambooId::Urls::AuthUrl.new(subdomain).to_s`
+
+In the callback controller, you can use `BambooId::ApiKeyFetcher` to get an API key
+using the code passed to you like so:
+
+```ruby
+::BambooId::ApiKeyFetcher.new(
+  code: params[:code],
+  integration: current_company.user_management_integration
+).fetch
+```
+
+This will either return an api key or `false` with an `error` attribute set.
+
+## 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/bonusly/bamboo-id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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/bamboo_id.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bamboo_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bamboo-id"
+  spec.version       = BambooId::VERSION
+  spec.authors       = ["Jon Evans"]
+  spec.email         = ["joncodes@gmail.com"]
+
+  spec.summary       = %q{Wrapper classes around the OpenID connect process.}
+  spec.description   = %q{Easily connect your Ruby application to BambooHR through OpenID.}
+  spec.homepage      = "https://www.github.com/bonusly/bamboo-id"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency 'httparty'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bamboo_id"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/bamboo_id.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), 'bamboo_id', '**', '*.rb')].each { |file| require file }

data/lib/bamboo_id/api_key_fetcher.rb

@@ -0,0 +1,45 @@
+module BambooId
+  class ApiKeyFetcher
+    attr_reader :error
+
+    def initialize(code:, subdomain:)
+      self.code      = code
+      self.subdomain = subdomain
+      self.error     = nil
+    end
+
+    def fetch
+      unless access_token_request.successful?
+        self.error = "Could not get access token: #{access_token_request.error}"
+        return false
+      end
+
+      unless api_key_request.successful?
+        self.error = "Could not get API key."
+        return false
+      end
+
+      api_key_request.key
+    end
+
+
+    private
+
+    attr_accessor :code, :subdomain
+    attr_writer :error
+
+    def access_token_request
+      @access_token_request ||= Requests::AccessTokenRequest.new(
+        temporary_code: code,
+        subdomain: subdomain
+      )
+    end
+
+    def api_key_request
+      @api_key_request ||= Requests::ApiKeyRequest.new(
+        id_token: access_token_request.id_token,
+        subdomain: subdomain
+      )
+    end
+  end
+end

data/lib/bamboo_id/configuration.rb

@@ -0,0 +1,25 @@
+module BambooId
+  class Configuration
+    @@redirect_url = nil
+
+    def self.redirect_url
+      @@redirect_url || raise('No redirect_url set')
+    end
+
+    def self.redirect_url=(url)
+      @@redirect_url = url
+    end
+
+    def self.application_key
+      ENV['BAMBOO_APPLICATION_KEY']
+    end
+
+    def self.client_id
+      ENV['BAMBOO_CLIENT_ID']
+    end
+
+    def self.client_secret
+      ENV['BAMBOO_CLIENT_SECRET']
+    end
+  end
+end

data/lib/bamboo_id/requests/access_token_request.rb

@@ -0,0 +1,31 @@
+require_relative 'base_access_token_request.rb'
+
+module BambooId
+  module Requests
+    class AccessTokenRequest
+      include BaseAccessTokenRequest
+
+      def initialize(temporary_code:, subdomain:, grant_type: 'authorization_code')
+        self.temporary_code = temporary_code
+        self.subdomain      = subdomain
+        self.grant_type     = grant_type
+      end
+
+      def id_token
+        response.id_token
+      end
+
+      private
+
+      attr_accessor :subdomain
+
+      def url
+        @url ||= Urls::OauthTokenUrl.new(
+          temporary_code: temporary_code,
+          subdomain:      subdomain,
+          grant_type:     grant_type
+        )
+      end
+    end
+  end
+end

data/lib/bamboo_id/requests/api_key_request.rb

@@ -0,0 +1,35 @@
+module BambooId
+  module Requests
+    class ApiKeyRequest
+      include BasicRequestHandling
+
+      def initialize(subdomain:, id_token:)
+        self.subdomain = subdomain
+        self.id_token  = id_token
+      end
+
+      def successful?
+        response.success
+      end
+
+      def key
+        response.key
+      end
+
+      private
+
+      attr_accessor :subdomain, :id_token
+
+      def url
+        Urls::ApiKeyUrl.new(subdomain: subdomain, id_token: id_token)
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/x-www-form-urlencoded',
+          'Accept'       => 'application/json'
+        }
+      end
+    end
+  end
+end

data/lib/bamboo_id/requests/base_access_token_request.rb

@@ -0,0 +1,31 @@
+require_relative 'basic_request_handling.rb'
+
+module BambooId
+  module Requests
+    module BaseAccessTokenRequest
+      def self.included(base)
+        base.send(:include, BasicRequestHandling)
+      end
+
+      def access_token
+        response.access_token
+      end
+
+      def refresh_token
+        response.refresh_token
+      end
+
+      def successful?
+        error.nil?
+      end
+
+      def error
+        response.error
+      end
+
+      private
+
+      attr_accessor :temporary_code, :grant_type
+    end
+  end
+end

data/lib/bamboo_id/requests/basic_request_handling.rb

@@ -0,0 +1,26 @@
+require 'httparty'
+
+module BambooId
+  module Requests
+    module BasicRequestHandling
+      def self.included(base)
+        base.send :include, HTTParty
+        base.send :format, :json
+      end
+
+      private
+
+      def response
+        @response ||= OpenStruct.new(self.class.post(url.to_s, body: url.params, headers: headers))
+      end
+
+      def headers
+        {}
+      end
+
+      def url
+        raise NotImplementedError, 'Please implement #url'
+      end
+    end
+  end
+end

data/lib/bamboo_id/state_code.rb

@@ -0,0 +1,15 @@
+module BambooId
+  class StateCode
+    def initialize(subdomain)
+      self.subdomain = subdomain
+    end
+
+    def to_s
+      Digest::MD5.hexdigest([Configuration.client_id, subdomain].join(''))
+    end
+
+    private
+
+    attr_accessor :subdomain
+  end
+end

data/lib/bamboo_id/urls/api_key_url.rb

@@ -0,0 +1,25 @@
+module BambooId
+  module Urls
+    class ApiKeyUrl
+      def initialize(subdomain:, id_token:)
+        self.subdomain = subdomain
+        self.id_token  = id_token
+      end
+
+      def to_s
+        "https://api.bamboohr.com/api/gateway.php/#{subdomain}/v1/oidcLogin"
+      end
+
+      def params
+        {
+          id_token: id_token,
+          applicationKey: Configuration.application_key
+        }
+      end
+
+      private
+
+      attr_accessor :subdomain, :id_token
+    end
+  end
+end

data/lib/bamboo_id/urls/auth_url.rb

@@ -0,0 +1,51 @@
+require_relative 'bamboo_url.rb'
+require_relative 'base_auth_url.rb'
+
+# URL for getting initial authorization from Bamboo.
+#
+# If user authorizes access to their Bamboo account, we get back
+# an authorization code code which is then fed to OauthTokenUrl for getting
+# the OAuth access token.
+#
+module BambooId
+  module Urls
+    class AuthUrl
+      include BambooUrl
+      include BaseAuthUrl
+
+      def initialize(subdomain)
+        self.subdomain = subdomain
+      end
+
+      private
+
+      attr_accessor :subdomain
+
+      def additional_params
+        {
+          request: 'authorize'
+        }
+      end
+
+      def base_url
+        "https://#{subdomain}.bamboohr.com/authorize.php"
+      end
+
+      def param_strings
+        params.map { |key, value| "#{key}=#{value}" }
+      end
+
+      def scope
+        'openid email'
+      end
+
+      def redirect_uri
+        CGI.escape(Configuration.redirect_url)
+      end
+
+      def state_code
+        StateCode.new(subdomain).to_s
+      end
+    end
+  end
+end

data/lib/bamboo_id/urls/bamboo_url.rb

@@ -0,0 +1,20 @@
+module BambooId
+  module Urls
+    module BambooUrl
+
+      private
+
+      def client_id
+        Configuration.client_id
+      end
+
+      def base_url
+        raise NotImplementedError
+      end
+
+      def params
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/bamboo_id/urls/base_auth_url.rb

@@ -0,0 +1,41 @@
+# First step of OAuth 2 is getting an authorization code via an authorization grant.
+# Then we use the code in a second request to get the access token.
+#
+# https://tools.ietf.org/html/rfc6749#section-1.3
+
+module BambooId
+  module Urls
+    module BaseAuthUrl
+      def to_s
+        [
+          base_url,
+          param_strings.join('&')
+        ].join('?')
+      end
+
+      private
+
+      def param_strings
+        params.map { |key, value| "#{key}=#{value}" }
+      end
+
+      def params
+        base_params.merge(additional_params)
+      end
+
+      def base_params
+        {
+          client_id:     client_id,
+          scope:         scope,
+          response_type: 'code',
+          state:         state_code,
+          redirect_uri:  redirect_uri
+        }
+      end
+
+      def additional_params
+        {}
+      end
+    end
+  end
+end

data/lib/bamboo_id/urls/base_oauth_token_url.rb

@@ -0,0 +1,35 @@
+module BambooId
+  module Urls
+    module BaseOauthTokenUrl
+      def to_s
+        base_url
+      end
+
+      def params
+        {
+          client_id:     client_id,
+          client_secret: client_secret,
+          grant_type:    grant_type,
+          redirect_uri:  redirect_uri,
+          scope:         scope
+        }.tap do |parameters|
+          parameters[refresh? ? :refresh_token : :code] = temporary_code
+        end.select do |_key, value|
+          value != nil && value != ''
+        end
+      end
+
+      private
+
+      attr_accessor :temporary_code, :grant_type
+
+      def scope
+        nil
+      end
+
+      def refresh?
+        grant_type == 'refresh_token'
+      end
+    end
+  end
+end

data/lib/bamboo_id/urls/oauth_token_url.rb

@@ -0,0 +1,34 @@
+module BambooId
+  module Urls
+    class OauthTokenUrl
+      include BambooUrl
+      include BaseOauthTokenUrl
+
+      def initialize(temporary_code:, subdomain:, grant_type: 'authorization_code')
+        self.temporary_code = temporary_code
+        self.subdomain      = subdomain
+        self.grant_type     = grant_type
+      end
+
+      private
+
+      attr_accessor :subdomain
+
+      def base_url
+        "https://#{subdomain}.bamboohr.com/token.php?request=token"
+      end
+
+      def client_secret
+        Configuration.client_secret
+      end
+
+      def redirect_uri
+        Configuration.redirect_url
+      end
+
+      def scope
+        'openid email'
+      end
+    end
+  end
+end

data/lib/bamboo_id/version.rb

@@ -0,0 +1,3 @@
+module BambooId
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: bamboo-id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Evans
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily connect your Ruby application to BambooHR through OpenID.
+email:
+- joncodes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bamboo_id.gemspec
+- bin/console
+- bin/setup
+- lib/bamboo_id.rb
+- lib/bamboo_id/api_key_fetcher.rb
+- lib/bamboo_id/configuration.rb
+- lib/bamboo_id/requests/access_token_request.rb
+- lib/bamboo_id/requests/api_key_request.rb
+- lib/bamboo_id/requests/base_access_token_request.rb
+- lib/bamboo_id/requests/basic_request_handling.rb
+- lib/bamboo_id/state_code.rb
+- lib/bamboo_id/urls/api_key_url.rb
+- lib/bamboo_id/urls/auth_url.rb
+- lib/bamboo_id/urls/bamboo_url.rb
+- lib/bamboo_id/urls/base_auth_url.rb
+- lib/bamboo_id/urls/base_oauth_token_url.rb
+- lib/bamboo_id/urls/oauth_token_url.rb
+- lib/bamboo_id/version.rb
+homepage: https://www.github.com/bonusly/bamboo-id
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Wrapper classes around the OpenID connect process.
+test_files: []