omniauth-jama-connect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c35b1bf46713f46cad52ebab12a1827ad84e401d
+  data.tar.gz: 203ad7e1a64c1f99451b722fd762aa7a8c3109da
+SHA512:
+  metadata.gz: 21c38116d5d95c5b8e39bde2b45af46762e9886d65273964d05ee2a96e66823e4bcf8a68f8f6ba22d364debee5cb999d0f0f8a20e303a332aef14bf1bbd1c91f
+  data.tar.gz: f9be62c268c667d84eb21f53a47109fe060d463ce16b2cdd184f8283a79d5240b600706066b3c0dbac1aa22f0348afe46e16de5678658a058a1821d1354cf992

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Peter Mooney
+
+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,49 @@
+# OmniAuth Jama Connect
+
+Jama Connect OAuth2 Strategy for OmniAuth
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-jama-connect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-jama-connect
+
+## Usage
+
+Here's a quick example for adding the middleware to a Rails application (in `config/initializers/omniauth.rb`):
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :jama_connect, ENV["JAMA_CONNECT_CLIENT_ID"], ENV["JAMA_CONNECT_CLIENT_SECRET"], host: "https://YOUR_COMPANY.jamaland.com"
+end
+```
+
+This will add an endpoint to your application at `/auth/jama_connect` that will being the OAuth flow.
+
+In the callback controller, you can find the `token` and `refresh_token` on the Hash: `request.env['omniauth.auth']['credentials']`. Store these values for subsequent requests to the Jama Connect API.
+
+**Note:** The `JAMA_CONNECT_CLIENT_ID` and `JAMA_CONNECT_CLIENT_SECRET` values mentioned in the above example are NOT the same values that you would receive through the "Set API Credentials" Web interface. Those credentials do not have the proper authorization to administer authorization codes or refresh tokens against the Jama Connect OAuth system. Instead, you must contact Jama Software to setup an OAuth client, and they will provide you these values.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/JamaSoftware/omniauth-jama-connect.
+
+## 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,10 @@
+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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/jama/connect"
+
+# 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/omniauth-jama-connect.rb

@@ -0,0 +1 @@
+require 'omniauth/jama-connect'

data/lib/omniauth/jama-connect.rb

@@ -0,0 +1,2 @@
+require 'omniauth/strategies/jama-connect'
+require 'omniauth/jama-connect/version'

data/lib/omniauth/jama-connect/version.rb

@@ -0,0 +1,7 @@
+module OmniAuth
+  module Jama
+    module Connect
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/omniauth/strategies/jama-connect.rb

@@ -0,0 +1,54 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class JamaConnect < OmniAuth::Strategies::OAuth2
+      option :name, 'jama_connect'
+      option :scope, 'token_information'
+      option :origin_param, 'redirect_uri'
+      option :client_options, {
+        auth_scheme: :basic_auth,
+      }
+
+      # Connect is multi-tenant, so the host needs to be set by the implementer.
+      option :host, nil
+
+      uid do
+        request.params['code']
+      end
+
+      def request_phase
+        raise NoHostError if options[:host].nil?
+
+        options.client_options[:authorize_url] = options[:host] += '/authorize.req'
+        super
+      end
+
+      def callback_phase
+        raise NoHostError if options[:host].nil?
+
+        options.client_options[:token_url] = options[:host] += '/rest/oauth/token'
+        super
+      end
+
+      def query_string
+        # Need to override query_string here or else Connect complains about
+        # a mismatch URI. The query string is non-determinate, and omniauth
+        # adds it for the third leg of the journey
+        ''
+      end
+    end
+
+    class NoHostError < StandardError
+      def initialize
+        super(
+          'No host option set. Make sure you add the host option when you'\
+          ' initialize the strategy, or use a setup Proc for dynamically setting'\
+          ' the host.'
+        )
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'jama_connect', 'JamaConnect'

data/omniauth-jama-connect.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth/jama-connect/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-jama-connect"
+  spec.version       = OmniAuth::Jama::Connect::VERSION
+  spec.authors       = ["Peter Mooney"]
+  spec.email         = ["pmooney@jamasoftware.com"]
+
+  spec.summary       = "Omniauth Strategy for Jama Connect"
+  spec.homepage      = "https://github.com/jamasoftware/omniauth-jama-connect"
+  spec.license       = "MIT"
+
+  # 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.add_runtime_dependency 'omniauth-oauth2', '>= 1.2'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-jama-connect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Mooney
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+description: 
+email:
+- pmooney@jamasoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-jama-connect.rb
+- lib/omniauth/jama-connect.rb
+- lib/omniauth/jama-connect/version.rb
+- lib/omniauth/strategies/jama-connect.rb
+- omniauth-jama-connect.gemspec
+homepage: https://github.com/jamasoftware/omniauth-jama-connect
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Omniauth Strategy for Jama Connect
+test_files: []