omniauth-slack 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56fa690c9ed21986df0a47a898a9e384946e727d
-  data.tar.gz: 5792269667716d39e2022f3e895fa04a7e1463be
+  metadata.gz: b291a4ae7bb944ff8ca89710650f99ab928a2143
+  data.tar.gz: 7cc3ed52232e9a2fd8877e1f28c03ec833fca132
 SHA512:
-  metadata.gz: 1ab14ed8bd87c3a0d2ffdefce23977d8c564e7ac54c08ccc7570336e41b3705ed96f5d4730142cc74e2cad2fdbadccc876e41e74e1de32ea7a23c18a16558c5d
-  data.tar.gz: 1d4954fbc14dfe249020306288afd937eedad65a5f159517e818eb7bb6bd77a2353c7e58f7e5d5b3615b16fc981f1cd35cbadc659e8b3424e4b151be3f71bc13
+  metadata.gz: 8c04b6dfc85fc63c4bdecca97783bdd8b514590b5b7adf76a2ec7c16e986660e3ff11ceb698deefedd2ee1236aaea715cb958574c7f660bb66ce0ad34655179d
+  data.tar.gz: 468d6b8e90e61be21dd9aed38cead230b9021347f73e1405d48daaff08b5c460edfbce23b58135402d6ce5acee0abf85ec34fbb2b48394fadb362db8c909f40a

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/

data/README.md

@@ -1,24 +1,90 @@
 # Omniauth::Slack
 
-TODO: Write a gem description
+This Gem contains the Slack strategy for OmniAuth.
 
-## Installation
+## Before You Begin
 
-Add this line to your application's Gemfile:
+You should have already installed OmniAuth into your app; if not, read the [OmniAuth README](https://github.com/intridea/omniauth) to get started.
 
-    gem 'omniauth-slack'
 
-And then execute:
+Now sign into the [Slack application dashboard](https://api.slack.com/applications) and create an application. Take note of your API keys.
 
-    $ bundle
 
-Or install it yourself as:
+## Using This Strategy
 
-    $ gem install omniauth-slack
+First start by adding this gem to your Gemfile:
 
-## Usage
+```ruby
+gem 'omniauth-slack'
+```
 
-TODO: Write usage instructions here
+If you need to use the latest HEAD version, you can do so with:
+
+```ruby
+gem 'omniauth-slack', github: 'kmrshntr/omniauth-slack'
+```
+
+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, "API_KEY", "API_SECRET", scope: "client"
+end
+```
+
+Replace `"API_KEY"` and `"API_SECRET"` with the appropriate values you obtained [earlier](https://api.slack.com/applications).
+
+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 :slack, ENV["SLACK_APP_ID"], ENV["SLACK_APP_SECRET"], scope: 'client'
+
+  # other stuff...
+end
+```
+
+Slack lets you choose from a [few different scopes](https://api.slack.com/docs/oauth#auth_scopes).
+
+
+## Authentication Options
+
+### State
+
+> *unique string to be passed back upon completion*
+
+> The state parameter should be used to avoid forgery attacks by passing in a value that's unique to the user you're authenticating and checking it when auth completes.
+
+for a logged in user, you might want to include state, for example with devise:
+
+`https://www.yourapp.com/users/auth/slack?state=1234-foobutter`
+
+creates an auth session with `state`
+
+After a successful auth, the callback request will include `request.env["omniauth.params"]` hash
+
+```ruby
+class CallbackController < ApplicationController
+  def slack
+    request.env["omniauth.params"]["state"]
+    # => "1234-foobutter"
+  end
+end
+```
+
+### Team
+
+> If you don't pass a team param, the user will be allowed to choose which team they are authenticating against. Passing this param ensures the user will auth against an account on that particular team.
+
+If you need to ensure that the users use the team whose team_id is 'XXXXXXXX', you can do so by passing `:team` option in your `config/initializers/omniauth.rb` like this:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :slack, "API_KEY", "API_SECRET", scope: "identify,read,post", team: 'XXXXXXXX'
+end
+```
 
 ## Contributing
 
@@ -27,3 +93,6 @@ TODO: Write usage instructions here
 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
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/kmrshntr/omniauth-slack/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/lib/omniauth/strategies/slack.rb

@@ -6,7 +6,7 @@ module OmniAuth
 
       option :name, "slack"
 
-      option :authorize_options, [ :scope, :team ]      
+      option :authorize_options, [ :scope, :team ]
 
       option :client_options, {
         site: "https://slack.com",
@@ -22,6 +22,13 @@ module OmniAuth
 
       info do
         {
+          name: user_info['user']['profile']['real_name_normalized'],
+          email: user_info['user']['profile']['email'],
+          nickname: raw_info['user'],
+          first_name: user_info['user']['profile']['first_name'],
+          last_name: user_info['user']['profile']['last_name'],
+          description: user_info['user']['profile']['title'],
+          image: user_info['user']['profile']['image_192'],
           team: raw_info['team'],
           user: raw_info['user'],
           team_id: raw_info['team_id'],
@@ -30,13 +37,17 @@ module OmniAuth
       end
 
       extra do
-        {:raw_info => raw_info}
+        {:raw_info => raw_info, :user_info => user_info}
+      end
+
+      def user_info
+        @user_info ||= access_token.get("/api/users.info?user=#{raw_info['user_id']}").parsed
       end
 
       def raw_info
-        @raw_info ||= access_token.get('/api/auth.test').parsed
+        @raw_info ||= access_token.get("/api/auth.test").parsed
       end
 
     end
   end
-end
+end

data/lib/omniauth-slack/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Slack
-    VERSION = "1.0.1"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-slack
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - kimura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-24 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: OmniAuth strategy for Slack