omniauth-hipchat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56bdb1a63c254d724a89ab0ea19f4cf4df8c9ad0
+  data.tar.gz: 279e2b03788cee9f1f242eb9a374b926ccbf2822
+SHA512:
+  metadata.gz: f9d7c38fe5b5ce2f6bea4370947146445f7313f10f572d43669adee55814e8fca1892a87ce5db200ce0e532220432019a33387dca6328a1e61cf61693cd1db5d
+  data.tar.gz: 465a07860ba71f1c13f08730b666491090115568c0ded4757899ec0efad56a9f57c41121489214a2a53fdcb023bf8027c6d05f49941e293d91bf5a6bf18dc4b6

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+.ruby-version
+.ruby-gemset

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Maciej Paruszewski
+
+MIT License
+
+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,61 @@
+# Omniauth::Hipchat
+
+This Gem contains the HipChat strategy for OmniAuth.
+
+[![Gem Version](https://badge.fury.io/rb/omniauth-hipchat.svg)](http://badge.fury.io/rb/omniauth-hipchat)
+
+## Before You Begin
+
+You should have already installed OmniAuth into your app; if not, read the [OmniAuth README](https://github.com/intridea/omniauth) to get started.
+
+Now read documentation about [HipChat integrations](https://www.hipchat.com/docs/apiv2/addons) and create an application. Take note of your API keys.
+
+## Using This Strategy
+
+First start by adding this gem to your Gemfile:
+
+```ruby
+gem 'omniauth-hipchat'
+```
+
+If you need to use the latest HEAD version, you can do so with:
+
+```ruby
+gem 'omniauth-hipchat', github: 'pinoss/omniauth-hipchat'
+```
+
+Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :hipchat, "API_KEY", "API_SECRET", scope: "view_group admin_group"
+end
+```
+
+Replace `"API_KEY"` and `"API_SECRET"` with the appropriate values you obtained [earlier](https://www.hipchat.com/docs/apiv2/addons).
+
+If you are using [Devise](https://github.com/plataformatec/devise) then it will look like this:
+
+```ruby
+Devise.setup do |config|
+  # other stuff...
+
+  config.omniauth :hipchat, ENV["HIPCHAT_APP_ID"], ENV["HIPCHAT_APP_SECRET"], scope: 'view_group admin_group'
+
+  # other stuff...
+end
+```
+
+HipChat lets you combine and choose from a [few different scopes](https://www.hipchat.com/docs/apiv2/auth#scopes).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Special Thanks
+
+Many thanks to the [omniauth-slack](https://github.com/CanCanCommunity/cancancan/contributors) and [omniauth-reddit contributors](https://github.com/CanCanCommunity/cancancan/contributors). This strategy was inspired by Omniauth Slack and Reddit strategies.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+end
+
+task :default => :test

data/lib/omniauth-hipchat.rb

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

data/lib/omniauth-hipchat/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Hipchat
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/hipchat.rb

@@ -0,0 +1,80 @@
+require 'omniauth/strategies/oauth2'
+require 'base64'
+
+module OmniAuth
+  module Strategies
+    class Hipchat < OmniAuth::Strategies::OAuth2
+      option :name, 'hipchat'
+
+      option :authorize_options, [:scope]
+
+      option :client_options, {
+        site: 'https://api.hipchat.com',
+        token_url: '/v2/oauth/token',
+        authorize_url: 'https://www.hipchat.com/users/authorize'
+      }
+
+      uid { raw_info['owner']['id'] }
+
+      info do
+        {
+          name: raw_info['owner'].to_h['name'],
+          email: user_info['email'],
+          mention_name: raw_info['owner'].to_h['mention_name'],
+          roles: user_info['roles'],
+          client_name: raw_info['client'].to_h['name'],
+          room: raw_info['client'].to_h['room'],
+          title: user_info['title'],
+          image: user_info['photo_url'],
+          group_avatar: group_info['avatar_url'],
+          group_domain: group_info['subdomain'],
+          group_id: access_token['group_id'],
+          group: group_info['name'],
+          plan: group_info['plan'].to_h['type'],
+          user_id: raw_info['owner'].to_h['id'],
+          is_group_admin: user_info['is_group_admin'],
+          xmpp_jid: user_info['xmpp_jid'],
+          time_zone: user_info['timezone']
+        }
+      end
+
+      extra do
+        {
+          raw_info: raw_info,
+          user_info: user_info,
+          group_info: group_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/v2/oauth/token/#{access_token.token}").parsed
+      end
+
+      def user_info
+        return {} unless group_info_allowed?
+        @user_info ||= access_token.get("/v2/user/#{raw_info['owner']['id']}").parsed
+      end
+
+      def group_info
+        return {} unless group_info_allowed?
+        @group_info ||= access_token.get("/v2/group/#{access_token['group_id']}").parsed
+      end
+
+      def build_access_token
+        options.token_params.merge!(:headers => {'Authorization' => basic_auth_header })
+        super
+      end
+
+      def basic_auth_header
+        "Basic " + Base64.strict_encode64("#{options[:client_id]}:#{options[:client_secret]}")
+      end
+
+      def group_info_allowed?
+        return false unless options['scope']
+        group_info_scopes = ['view_room']
+        scopes = options['scope'].split(' ')
+        (scopes & group_info_scopes).any?
+      end
+    end
+  end
+end

data/omniauth-hipchat.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+require File.expand_path('../lib/omniauth-hipchat/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-hipchat"
+  spec.version       = Omniauth::Hipchat::VERSION
+  spec.authors       = ["Maciej Paruszewski"]
+  spec.email         = ["maciek.paruszewski@gmail.com"]
+  spec.description   = %q{OmniAuth strategy for HipChat}
+  spec.summary       = %q{OmniAuth strategy for HipChat}
+  spec.homepage      = "https://github.com/pinoss/omniauth-hipchat.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', "~> 1.3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+end

data/test/helper.rb

@@ -0,0 +1,56 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "mocha/setup"
+require "omniauth/strategies/hipchat"
+
+OmniAuth.config.test_mode = true
+
+module BlockTestHelper
+  def test(name, &blk)
+    method_name = "test_#{name.gsub(/\s+/, "_")}"
+    raise "Method already defined: #{method_name}" if instance_methods.include?(method_name.to_sym)
+    define_method method_name, &blk
+  end
+end
+
+module CustomAssertions
+  def assert_has_key(key, hash, msg = nil)
+    msg = message(msg) { "Expected #{hash.inspect} to have key #{key.inspect}" }
+    assert hash.has_key?(key), msg
+  end
+
+  def refute_has_key(key, hash, msg = nil)
+    msg = message(msg) { "Expected #{hash.inspect} not to have key #{key.inspect}" }
+    refute hash.has_key?(key), msg
+  end
+end
+
+class TestCase < Minitest::Test
+  extend BlockTestHelper
+  include CustomAssertions
+end
+
+class StrategyTestCase < TestCase
+  def setup
+    @request = stub("Request")
+    @request.stubs(:params).returns({})
+    @request.stubs(:cookies).returns({})
+    @request.stubs(:env).returns({})
+    @request.stubs(:scheme).returns({})
+    @request.stubs(:ssl?).returns(false)
+
+    @client_id = "123"
+    @client_secret = "53cr3tz"
+  end
+
+  def strategy
+    @strategy ||= begin
+      args = [@client_id, @client_secret, @options].compact
+      OmniAuth::Strategies::Hipchat.new(nil, *args).tap do |strategy|
+        strategy.stubs(:request).returns(@request)
+      end
+    end
+  end
+end
+
+Dir[File.expand_path("../support/**/*", __FILE__)].each &method(:require)

data/test/support/shared_examples.rb

@@ -0,0 +1,85 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+module OAuth2StrategyTests
+  def self.included(base)
+    base.class_eval do
+      include ClientTests
+      include AuthorizeParamsTests
+      include CSRFAuthorizeParamsTests
+      include TokenParamsTests
+    end
+  end
+
+  module ClientTests
+    extend BlockTestHelper
+
+    test "should be initialized with symbolized client_options" do
+      @options = { :client_options => { "authorize_url" => "https://example.com" } }
+      assert_equal "https://example.com", strategy.client.options[:authorize_url]
+    end
+  end
+
+  module AuthorizeParamsTests
+    extend BlockTestHelper
+
+    test "should include any authorize params passed in the :authorize_params option" do
+      @options = { :authorize_params => { :foo => "bar", :baz => "zip" } }
+      assert_equal "bar", strategy.authorize_params["foo"]
+      assert_equal "zip", strategy.authorize_params["baz"]
+    end
+
+    test "should include top-level options that are marked as :authorize_options" do
+      @options = { :authorize_options => [:scope, :foo], :scope => "bar", :foo => "baz" }
+      assert_equal "bar", strategy.authorize_params["scope"]
+      assert_equal "baz", strategy.authorize_params["foo"]
+    end
+
+    test "should exclude top-level options that are not passed" do
+      @options = { :authorize_options => [:bar] }
+      refute_has_key :bar, strategy.authorize_params
+      refute_has_key "bar", strategy.authorize_params
+    end
+  end
+
+  module CSRFAuthorizeParamsTests
+    extend BlockTestHelper
+
+    test "should store random state in the session when none is present in authorize or request params" do
+      assert_includes strategy.authorize_params.keys, "state"
+      refute_empty strategy.authorize_params["state"]
+      refute_empty strategy.session["omniauth.state"]
+      assert_equal strategy.authorize_params["state"], strategy.session["omniauth.state"]
+    end
+
+    test "should not store state in the session when present in authorize params vs. a random one" do
+      @options = { :authorize_params => { :state => "bar" } }
+      refute_empty strategy.authorize_params["state"]
+      refute_equal "bar", strategy.authorize_params[:state]
+      refute_empty strategy.session["omniauth.state"]
+      refute_equal "bar", strategy.session["omniauth.state"]
+    end
+
+    test "should not store state in the session when present in request params vs. a random one" do
+      @request.stubs(:params).returns({ "state" => "foo" })
+      refute_empty strategy.authorize_params["state"]
+      refute_equal "foo", strategy.authorize_params[:state]
+      refute_empty strategy.session["omniauth.state"]
+      refute_equal "foo", strategy.session["omniauth.state"]
+    end
+  end
+
+  module TokenParamsTests
+    extend BlockTestHelper
+
+    test "should include any authorize params passed in the :token_params option" do
+      @options = { :token_params => { :foo => "bar", :baz => "zip" } }
+      assert_equal "bar", strategy.token_params["foo"]
+      assert_equal "zip", strategy.token_params["baz"]
+    end
+
+    test "should include top-level options that are marked as :token_options" do
+      @options = { :token_options => [:scope, :foo], :scope => "bar", :foo => "baz" }
+      assert_equal "bar", strategy.token_params["scope"]
+      assert_equal "baz", strategy.token_params["foo"]
+    end
+  end
+end

data/test/test.rb

@@ -0,0 +1,100 @@
+require "helper"
+require "omniauth-hipchat"
+
+class StrategyTest < StrategyTestCase
+  include OAuth2StrategyTests
+end
+
+class ClientTest < StrategyTestCase
+  test "has correct HipChat site" do
+    assert_equal "https://api.hipchat.com", strategy.client.site
+  end
+
+  test "has correct authorize url" do
+    assert_equal "https://www.hipchat.com/users/authorize", strategy.client.options[:authorize_url]
+  end
+
+  test "has correct token url" do
+    assert_equal "/v2/oauth/token", strategy.client.options[:token_url]
+  end
+end
+
+class CallbackUrlTest < StrategyTestCase
+  test "returns the default callback url" do
+    url_base = "http://auth.request.com"
+    @request.stubs(:url).returns("#{url_base}/some/page")
+    strategy.stubs(:script_name).returns("") # as not to depend on Rack env
+    assert_equal "#{url_base}/auth/hipchat/callback", strategy.callback_url
+  end
+
+  test "returns path from callback_path option" do
+    @options = { :callback_path => "/auth/hipchat/done"}
+    url_base = "http://auth.request.com"
+    @request.stubs(:url).returns("#{url_base}/page/path")
+    strategy.stubs(:script_name).returns("") # as not to depend on Rack env
+    assert_equal "#{url_base}/auth/hipchat/done", strategy.callback_url
+  end
+end
+
+class UidTest < StrategyTestCase
+  def setup
+    super
+    strategy.stubs(:raw_info).returns("owner" => { "id" => "1231234" })
+  end
+
+  test "returns the user ID from raw_info" do
+    assert_equal "1231234", strategy.uid
+  end
+end
+
+class CredentialsTest < StrategyTestCase
+  def setup
+    super
+    @access_token = stub("OAuth2::AccessToken")
+    @access_token.stubs(:token)
+    @access_token.stubs(:expires?)
+    @access_token.stubs(:expires_at)
+    @access_token.stubs(:refresh_token)
+    strategy.stubs(:access_token).returns(@access_token)
+  end
+
+  test "returns a Hash" do
+    assert_kind_of Hash, strategy.credentials
+  end
+
+  test "returns the token" do
+    @access_token.stubs(:token).returns("123")
+    assert_equal "123", strategy.credentials["token"]
+  end
+
+  test "returns the expiry status" do
+    @access_token.stubs(:expires?).returns(true)
+    assert strategy.credentials["expires"]
+
+    @access_token.stubs(:expires?).returns(false)
+    refute strategy.credentials["expires"]
+  end
+
+  test "returns the refresh token and expiry time when expiring" do
+    ten_mins_from_now = (Time.now + 600).to_i
+    @access_token.stubs(:expires?).returns(true)
+    @access_token.stubs(:refresh_token).returns("321")
+    @access_token.stubs(:expires_at).returns(ten_mins_from_now)
+    assert_equal "321", strategy.credentials["refresh_token"]
+    assert_equal ten_mins_from_now, strategy.credentials["expires_at"]
+  end
+
+  test "does not return the refresh token when test is nil and expiring" do
+    @access_token.stubs(:expires?).returns(true)
+    @access_token.stubs(:refresh_token).returns(nil)
+    assert_nil strategy.credentials["refresh_token"]
+    refute_has_key "refresh_token", strategy.credentials
+  end
+
+  test "does not return the refresh token when not expiring" do
+    @access_token.stubs(:expires?).returns(false)
+    @access_token.stubs(:refresh_token).returns("XXX")
+    assert_nil strategy.credentials["refresh_token"]
+    refute_has_key "refresh_token", strategy.credentials
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-hipchat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maciej Paruszewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-16 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.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  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: mocha
+  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: OmniAuth strategy for HipChat
+email:
+- maciek.paruszewski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-hipchat.rb
+- lib/omniauth-hipchat/version.rb
+- lib/omniauth/strategies/hipchat.rb
+- omniauth-hipchat.gemspec
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb
+homepage: https://github.com/pinoss/omniauth-hipchat.git
+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.4.6
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for HipChat
+test_files:
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb