omniauth-github-team-member 1.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ac1491bf37b9186f206e2fe303e55090a1835f981dfe93519db775c38d21ad2
+  data.tar.gz: 41d42aa061dff7acee04796abf49425ad3b6dd4245e513c4a02a57b6f9b3f10a
+SHA512:
+  metadata.gz: e4b226fa970d2d5a63ebf4e764021b10b049081bdcb63f2f9cea347fba279451f2236c9d472363509e41458ca06b22ec246ce56c139bffa43fc2131fd97d1474
+  data.tar.gz: f51c34abc78c5434471d684d67a281ca4c2513e4916af5b1b4a7e59caa6d016d60c7d5a5094e8ee0c5f23d5d9448d986b418b2dd251ef975b8fc1448f10d880c

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jonathan Hoyt
+
+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

@@ -1,8 +1,8 @@
-# OmniAuth GitHubber Auth
+# OmniAuth GitHub Team Auth
 
-This is the official OmniAuth strategy for authenticating to GitHub. To
-use it, you'll need to sign up for an OAuth2 Application ID and Secret
-on the [GitHub Applications Page](https://github.com/settings/applications).
+This is an OmniAuth strategy for authenticating to GitHub and ensuring the user belongs to a specific team. This strategy is useful for building web apps that should only be administered by specific teams. I adapted this from an internal gem at GitHub.
+
+To use it, you'll need to sign up for an OAuth2 Application ID and Secret on the [GitHub Applications Page](https://github.com/settings/applications).
 
 ## Installing
 
@@ -12,23 +12,31 @@ 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
 
+In the examples below, `42634` is the id of the team we are checking against. You can find the id of a team via the GitHub API, either by [listing all teams for the parent org](https://developer.github.com/v3/orgs/teams/#list-teams) or [finding all of the team memberships for a user who is on the team you are looking for](https://developer.github.com/v3/orgs/teams/#get-team-membership).
+
 Usage in Rails:
 
 ```ruby
+# config/initializers/github_omniauth.rb
+
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :github_team_member, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET'], :scope => 'user'
+  provider :githubteammember,
+    ENV['GITHUB_CLIENT_ID'],
+    ENV['GITHUB_CLIENT_SECRET'],
+    scope: 'read:org',
+    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.
+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.
 
 ```ruby
 class SessionsController
@@ -50,7 +58,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,19 +80,35 @@ Usage in Sinatra:
 
 ```ruby
 use OmniAuth::Builder do
-  provider :github_team_member, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET']
+  provider :githubteammember,
+    ENV['GITHUB_CLIENT_ID'],
+    ENV['GITHUB_CLIENT_SECRET'],
+    scope: 'read:org',
+    teams: {
+      "mentors_team_member?" => 426344
+    }
 end
 ```
 
 ### Scopes
 
-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 :github_team_member, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET'], :scope => 'user'
-end
-```
+You must require the `read:org` scope to be able to access the team data associated with the authenticated user.
 
 More info on [Scopes](http://developer.github.com/v3/oauth/#scopes).
+
+## Contributing
+
+1. [Fork it](https://help.github.com/articles/fork-a-repo)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](https://help.github.com/articles/using-pull-requests)
+
+## Contributors
+
+* [Garrett Bjerkhoel](https://github.com/dewski)
+* [Jonathan Hoyt](https://github.com/jonmagic)
+* [Arthur Chiu](https://github.com/achiu)
+* [Tim Clem](https://github.com/tclem)
+* [Jessie Young](https://github.com/jessieay)
+* [Paul Schreiber](https://github.com/paulschreiber)

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

@@ -1,5 +1,5 @@
 module OmniAuth
   module GitHubTeamMember
-    VERSION = '1.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/omniauth/strategies/github_team_member.rb

@@ -4,18 +4,31 @@ 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["email"] = email_addresses
+          base
+        end
       end
 
-      def github_team_member?(id)
-        team_members = access_token.get("/teams/#{id}/members").parsed
-        !!team_members.detect { |member| member['login'] == raw_info['login'] }
+      def email_addresses
+        response = access_token.get("/user/emails")
+        response.status == 200 && response.parsed.map{|user| user["email"]}
       rescue ::OAuth2::Error
         false
       end
 
-      def team_id
-        ENV["GITHUB_TEAM_ID"]
+      def team_member?(team_id)
+        response = access_token.get("/teams/#{team_id}/memberships/#{raw_info['login']}")
+        response.status == 200 && response.parsed["state"] == "active"
+      rescue ::OAuth2::Error
+        false
+      end
+
+      def booleanize_method_name(method_name)
+        return method_name if method_name =~ /\?$/
+        return "#{method_name}?"
       end
     end
   end

data/omniauth-github-team-member.gemspec

@@ -2,8 +2,8 @@
 require File.expand_path('../lib/omniauth-github-team-member/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Jonathan Hoyt']
-  gem.email         = ['jonmagic@gmail.com']
+  gem.authors       = ['Garrett Bjerkhoel', 'Jonathan Hoyt']
+  gem.email         = ['me@garrettbjerkhoel.com', 'jonmagic@gmail.com']
   gem.description   = %q{OmniAuth strategy for GitHub Team Auth.}
   gem.summary       = %q{OmniAuth strategy for GitHub Team Auth.}
   gem.homepage      = 'https://github.com/jonmagic/omniauth-github-team-member'

metadata

@@ -1,107 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-github-team-member
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
+- Garrett Bjerkhoel
 - Jonathan Hoyt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-github
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: OmniAuth strategy for GitHub Team Auth.
 email:
+- me@garrettbjerkhoel.com
 - jonmagic@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Guardfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/omniauth-github-team-member.rb
@@ -113,27 +105,25 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/jonmagic/omniauth-github-team-member
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: OmniAuth strategy for GitHub Team Auth.
 test_files:
 - spec/omniauth/strategies/github_spec.rb