omniauth-github-team-member 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b57ef3a388ead6fcc8fe8e8190157e89c0214b0
-  data.tar.gz: 0328b20840eb90b73774516125f8724964c1300e
+  metadata.gz: fd56a1c1350f2da23440fde9b04103163727691b
+  data.tar.gz: 72709aa891100174dc2a369f0e6d9e80d1d31429
 SHA512:
-  metadata.gz: 0acd2c26505f320260aa89476ae7945b4fb414462213e105ac375f7e77b86d76fce1ce2ec78bd5883210c237ba0a832807624fb64e20f87b4de65f5437ac951d
-  data.tar.gz: 1aabfb8da8538066f3dfb94628bf9e82c51c19d956ee7c003bdb4c0693ca1b5a8438940fdd59582e671d59ba73f119a00d42a87515926e31f4889e7b179dd487
+  metadata.gz: 7c92a7366027c23158365de7b382c36185da38ee4a1ff4bfd5dfb0a7a86daa7265cdd6a9d862b0e2863d4d6a7d8eb495ea112ce4daccec27e1b972ecef79a230
+  data.tar.gz: 929e2d0914a8febbdf477b2bcedf9bfef78896ade2b072add6522cb87deca722acabef17db81acb694c83d675f6b4f84672e1e5c7aa1c514147a63b30dc54138

data/README.md

@@ -12,7 +12,7 @@ Add the gem to your Gemfile and bundle.
 gem "omniauth-github-team-member"
 ```
 
-Add the **GITHUB_TEAM_ID** variable to your environment, in addition to GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET. For local development I recommend the [dotenv](https://github.com/bkeepers/dotenv) gem.
+I like to store the GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET in my environment, but you don't have to if you have a preferred place to put keys and secrets. For local development I recommend the [dotenv](https://github.com/bkeepers/dotenv) gem for setting environment variables.
 
 ## Basic Usage
 
@@ -20,12 +20,18 @@ Usage in Rails:
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :githubteammember, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET'], :scope => 'user'
+  provider :githubteammember,
+    ENV['GITHUB_CLIENT_ID'],
+    ENV['GITHUB_CLIENT_SECRET'],
+    :scope => 'user',
+    :teams => {
+      "mentors_team_member?" => 426344
+    }
 end
 ```
 
-During the callback phase, you can check to see if the authed user is an employee or not
-by checking the returned credentials object `request.env['omniauth.auth'].credentials.team_member?`.
+During the callback phase, you can check to see if the authed user is on the mentors team or not
+by checking the returned credentials object `request.env['omniauth.auth'].credentials.mentors_team_member?`.
 
 An example of how to integrate this strategy with OmniAuth is below. Do note that these
 examples are just guidelines, you will most likely need to change each example to match your application's needs.
@@ -50,7 +56,7 @@ class User < ActiveRecord::Base
     # Prevents past team members from logging into existing accounts they
     # created when they were previously a team member. Also ensures
     # new accounts can't be created unless they are a team member.
-    return false unless access_token.credentials.team_member?
+    return false unless access_token.credentials.mentors_team_member?
 
     info = access_token.info
     github_id = access_token.uid
@@ -72,7 +78,13 @@ Usage in Sinatra:
 
 ```ruby
 use OmniAuth::Builder do
-  provider :githubteammember, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET']
+  provider :githubteammember,
+    ENV['GITHUB_CLIENT_ID'],
+    ENV['GITHUB_CLIENT_SECRET'],
+    :scope => 'user',
+    :teams => {
+      "mentors_team_member?" => 426344
+    }
 end
 ```
 
@@ -81,12 +93,6 @@ end
 You must require the user scope to be able to access the team data associated with
 the authenticated user.
 
-```ruby
-use OmniAuth::Builder do
-  provider :githubteammember, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET'], :scope => 'user'
-end
-```
-
 More info on [Scopes](http://developer.github.com/v3/oauth/#scopes).
 
 ## Contributing

data/lib/omniauth-github-team-member/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module GitHubTeamMember
-    VERSION = '1.0.2'
+    VERSION = '2.0.0'
   end
 end

data/lib/omniauth/strategies/github_team_member.rb

@@ -4,18 +4,23 @@ module OmniAuth
   module Strategies
     class GitHubTeamMember < OmniAuth::Strategies::GitHub
       credentials do
-        { 'team_member?' => github_team_member?(team_id) }
+        options['teams'].inject({}) do |base, key_value_pair|
+          method_name, team_id = key_value_pair
+          base[booleanize_method_name(method_name)] = team_member?(team_id)
+          base
+        end
       end
 
-      def github_team_member?(id)
-        response = access_token.get("/teams/#{id}/members/#{raw_info['login']}")
+      def team_member?(team_id)
+        response = access_token.get("/teams/#{team_id}/members/#{raw_info['login']}")
         response.status == 204
       rescue ::OAuth2::Error
         false
       end
 
-      def team_id
-        ENV["GITHUB_TEAM_ID"]
+      def booleanize_method_name(method_name)
+        return method_name if method_name =~ /\?$/
+        return "#{method_name}?"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-github-team-member
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Garrett Bjerkhoel