omniauth-github-team-member 1.0.0

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-github.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch('omniauth-githubber.gemspec')
+end

data/README.md

@@ -0,0 +1,90 @@
+# OmniAuth GitHubber 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).
+
+## Installing
+
+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.
+
+## Basic Usage
+
+Usage in Rails:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :github_team_member, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET'], :scope => 'user'
+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?`.
+
+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
+  def create
+    @user = User.find_for_github_team_oauth(request.env['omniauth.auth'])
+
+    if @user && @user.persisted?
+      redirect_to root_path
+    else
+      redirect_to no_access_path
+    end
+  end
+end
+```
+
+```ruby
+class User < ActiveRecord::Base
+  def self.find_for_github_team_oauth(access_token, signed_in_resource=nil)
+    # 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?
+
+    info = access_token.info
+    github_id = access_token.uid
+    user = find_or_initialize_by_github_id(github_id)
+
+    if user.new_record?
+      user.name = info.name
+      user.email = info.email
+      user.github_identifier = info.nickname
+      user.save
+    end
+
+    user
+  end
+end
+```
+
+Usage in Sinatra:
+
+```ruby
+use OmniAuth::Builder do
+  provider :github_team_member, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET']
+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
+```
+
+More info on [Scopes](http://developer.github.com/v3/oauth/#scopes).

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Run specs'
+task :default => :spec

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

@@ -0,0 +1,2 @@
+require 'omniauth-github-team-member/version'
+require 'omniauth/strategies/github_team_member'

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

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

data/lib/omniauth/strategies/github_team_member.rb

@@ -0,0 +1,24 @@
+require 'omniauth-github'
+
+module OmniAuth
+  module Strategies
+    class GitHubTeamMember < OmniAuth::Strategies::GitHub
+      credentials do
+        { 'team_member?' => github_team_member?(team_id) }
+      end
+
+      def github_team_member?(id)
+        team_members = access_token.get("/teams/#{id}/members").parsed
+        !!team_members.detect { |member| member['login'] == raw_info['login'] }
+      rescue ::OAuth2::Error
+        false
+      end
+
+      def team_id
+        ENV["GITHUB_TEAM_ID"]
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization "githubteammember", "GitHubTeamMember"

data/omniauth-github-team-member.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-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.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'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'omniauth-github-team-member'
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::GitHubTeamMember::VERSION
+
+  gem.add_dependency 'omniauth-github'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/github_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::GitHub do
+  subject do
+    OmniAuth::Strategies::GitHub.new({})
+  end
+
+  context "client options" do
+    it 'should have correct site' do
+      subject.options.client_options.site.should eq("https://api.github.com")
+    end
+
+    it 'should have correct authorize url' do
+      subject.options.client_options.authorize_url.should eq('https://github.com/login/oauth/authorize')
+    end
+
+    it 'should have correct token url' do
+      subject.options.client_options.token_url.should eq('https://github.com/login/oauth/access_token')
+    end
+  end
+end

data/spec/omniauth/strategies/github_team_member_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::GitHubTeamMember do
+  subject do
+    OmniAuth::Strategies::GitHubTeamMember.new({})
+  end
+
+  context 'client options' do
+    it 'should have correct site' do
+      subject.options.client_options.site.should eq('https://api.github.com')
+    end
+
+    it 'should have correct authorize url' do
+      subject.options.client_options.authorize_url.should eq('https://github.com/login/oauth/authorize')
+    end
+
+    it 'should have correct token url' do
+      subject.options.client_options.token_url.should eq('https://github.com/login/oauth/access_token')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth-github'
+require 'omniauth-github-team-member'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-github-team-member
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Hoyt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 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:
+- jonmagic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/omniauth-github-team-member.rb
+- lib/omniauth-github-team-member/version.rb
+- lib/omniauth/strategies/github_team_member.rb
+- omniauth-github-team-member.gemspec
+- spec/omniauth/strategies/github_spec.rb
+- spec/omniauth/strategies/github_team_member_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jonmagic/omniauth-github-team-member
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: OmniAuth strategy for GitHub Team Auth.
+test_files:
+- spec/omniauth/strategies/github_spec.rb
+- spec/omniauth/strategies/github_team_member_spec.rb
+- spec/spec_helper.rb