omniauth-slack_signin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eeb5f4995a2c816d515a65d12a4cef6200db8a23
+  data.tar.gz: a2bf12ef2222e922cb36962e376874e2123ecc9b
+SHA512:
+  metadata.gz: ed31d4c046b02548626fa026a735cdd4dac16ddac578829f5cee7455dd56bc075a973e42e5b3694934368a89aa475ebeb8509f4d11605f3881e88e62b124888e
+  data.tar.gz: 328609e8a9fefac2adae32850a628a978abce1864dbb59d72f9364cdb908e0363ade451c2165ba19d1790804258ed6247cf0887d450c424a350891f8f3ec47e4

data/.gitignore

@@ -0,0 +1,82 @@
+# Created by https://www.gitignore.io/api/osx,ruby
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    omniauth-slack_signin (0.1.0)
+      omniauth-oauth2 (~> 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.4.4)
+    jwt (1.5.1)
+    metaclass (0.0.4)
+    minitest (5.8.4)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.3.1)
+      hashie (>= 1.2, < 4)
+      rack (>= 1.0, < 3)
+    omniauth-oauth2 (1.3.1)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    rack (1.6.4)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  minitest
+  mocha
+  omniauth-slack_signin!
+  rake
+
+BUNDLED WITH
+   1.12.2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 shia
+
+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,41 @@
+# Omniauth::SlackSignin
+
+This Gem contains the Signin with Slack strategy for OmniAuth.
+
+We already have [good strategy for slack](https://github.com/kmrshntr/omniauth-slack), however, this gem is not work well.
+
+In addition, if we want to implement that, we need to be blind. Meaning to say, we should assume `identify.basic` scope is applied or not by returned params. One more thing. Maybe some clever developer handle this problem in the future, but I can't bear to retrieve user name with `auth.info.nickname.name` with `identify` scope. lol.
+
+so this gem only support about Sign-In feature with Slack. If you want another api, then just go [origin gem](https://github.com/kmrshntr/omniauth-slack) and use it. It is not hard as you know, isn't it?
+
+## How to use
+
+First start by adding this gem to your Gemfile:
+
+```ruby
+gem 'omniauth-slack_signin', github: 'riseshia/omniauth-slack_signin'
+```
+
+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 :slack_signin, "AUTH_KEY", "AUTH_SECRET", scope: "identity:basic"
+end
+```
+
+Replace `"AUTH_KEY"` and `"AUTH_SECRET"` with the appropriate values you obtained from [weirdx](not yet).
+
+If you are using [Devise](https://github.com/plataformatec/devise) then it will look like this:
+
+```ruby
+Devise.setup do |config|
+  # ...
+  config.omniauth :slack, ENV["AUTH_KEY"], ENV["AUTH_SECRET"], scope: 'identity:basic'
+  # ...
+end
+```
+
+## About API
+
+Follow this [link](https://api.slack.com/methods/users.identity).

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-slack_signin.rb

@@ -0,0 +1,2 @@
+require "omniauth-slack_signin/version"
+require "omniauth/strategies/slack_signin"

data/lib/omniauth-slack_signin/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Omniauth
+  module SlackSignin
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/omniauth/strategies/slack_signin.rb

@@ -0,0 +1,69 @@
+require "omniauth/strategies/oauth2"
+require "uri"
+require "rack/utils"
+
+module OmniAuth
+  module Strategies
+    class SlackSignin < OmniAuth::Strategies::OAuth2
+      option :name, "slack_signin"
+
+      option :authorize_options, [:scope, :team]
+
+      option :client_options, {
+        site: "https://slack.com",
+        token_url: "/api/oauth.access"
+      }
+
+      option :auth_token_params, {
+        mode: :query,
+        param_name: "token"
+      }
+
+      uid { raw_info["user"]["id"] }
+
+      info do
+        {
+          team: team_info,
+          user: user_info
+        }
+      end
+
+      def user_info
+        return nil if raw_info["user"].nil?
+        {
+          id: raw_info["user"]["id"],
+          name: raw_info["user"]["name"],
+          email: raw_info["user"]["email"],
+          image_24: raw_info["user"]["image_24"],
+          image_32: raw_info["user"]["image_32"],
+          image_48: raw_info["user"]["image_48"],
+          image_72: raw_info["user"]["image_72"],
+          image_192: raw_info["user"]["image_192"],
+          image_512: raw_info["user"]["image_512"]
+        }
+      end
+
+      def team_info
+        return nil if raw_info["user"].nil?
+        {
+          id: raw_info["team"]["id"],
+          name: raw_info["team"]["name"]
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/api/users.identity").parsed
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope team].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/omniauth-slack_signin.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+require File.expand_path('../lib/omniauth-slack_signin/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-slack_signin'
+  spec.version       = Omniauth::SlackSignin::VERSION
+  spec.authors       = ['Shia']
+  spec.email         = ['rise.shia@gmail.com']
+  spec.description   = 'OmniAuth strategy for Signin with Slack'
+  spec.summary       = 'OmniAuth strategy for Signin with Slack'
+  spec.homepage      = 'https://github.com/riseshia/omniauth-slack_signin.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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/slack_signin"
+
+OmniAuth.config.test_mode = true
+
+module BlockTestHelper
+  def test(name, &blk)
+    method_name = "test_#{name.gsub(/\s+/, "_")}"
+    fail "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 = "cid"
+    @client_secret = "1fndn123nadfa"
+  end
+
+  def strategy
+    @strategy ||= begin
+      args = [@client_id, @client_secret, @options].compact
+      OmniAuth::Strategies::SlackSignin.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-slack_signin"
+
+class StrategyTest < StrategyTestCase
+  include OAuth2StrategyTests
+end
+
+class ClientTest < StrategyTestCase
+  test "has correct Slack site" do
+    assert_equal "https://slack.com", strategy.client.site
+  end
+
+  test "has correct authorize url" do
+    assert_equal "/oauth/authorize", strategy.client.options[:authorize_url]
+  end
+
+  test "has correct token url" do
+    assert_equal "/api/oauth.access", 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/slack_signin/callback", strategy.callback_url
+  end
+
+  test "returns path from callback_path option" do
+    @options = { :callback_path => "/auth/slack_signin/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/slack_signin/done", strategy.callback_url
+  end
+end
+
+class UidTest < StrategyTestCase
+  def setup
+    super
+    strategy.stubs(:raw_info).returns("user" => { "id" => "misha" })
+  end
+
+  test "returns the user ID from raw_info" do
+    assert_equal "misha", 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("tooooken")
+    assert_equal "tooooken", 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("re_toooooken")
+    @access_token.stubs(:expires_at).returns(ten_mins_from_now)
+    assert_equal "re_toooooken", 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,130 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-slack_signin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-19 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 Signin with Slack
+email:
+- rise.shia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-slack_signin.rb
+- lib/omniauth-slack_signin/version.rb
+- lib/omniauth/strategies/slack_signin.rb
+- omniauth-slack_signin.gemspec
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb
+homepage: https://github.com/riseshia/omniauth-slack_signin.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.5.1
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Signin with Slack
+test_files:
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb