omniauth-groupme 0.0.7

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+
+gem 'rake'
+# Specify your gem's dependencies in omniauth-foursquare.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (C) 2012 GroupMe Inc.
+
+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,6 @@
+# OmniAuth GroupMe
+
+This gem contains the GroupMe strategy for OmniAuth.
+
+Lots yanked from [github.com/arunagw/omniauth-foursquare](https://github.com/arunagw/omniauth-foursquare),
+but it's ok because it's MIT licensed, MOM.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/omniauth-groupme.rb

@@ -0,0 +1,8 @@
+require "omniauth-groupme/version"
+require "omniauth/strategies/groupme"
+
+module Omniauth
+  module GroupMe
+    # Your code goes here...
+  end
+end

data/lib/omniauth-groupme/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module GroupMe
+    VERSION = "0.0.7"
+  end
+end

data/lib/omniauth/strategies/groupme.rb

@@ -0,0 +1,58 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class GroupMe < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        :site => 'https://groupme.com',
+        :authorize_url => '/oauth/authorize',
+        :token_url => '/oauth/access_token'
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        first_name, last_name = raw_info['name'].split(/\s+/)
+        {
+          :first_name => first_name,
+          :last_name  => last_name,
+          :name       => raw_info['name'],
+          :email      => raw_info['email'],
+          :image      => raw_info['avatar_url'],
+          :location   => raw_info['country']
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def request_phase
+        options[:authorize_params] = client_params.merge(options[:authorize_params])
+        super
+      end
+
+      def auth_hash
+        OmniAuth::Utils.deep_merge(super, client_params.merge({
+          :grant_type => 'authorization_code'}))
+      end
+
+      def raw_info
+        access_token.options[:mode] = :query
+        access_token.options[:param_name] = :oauth_token
+        response = access_token.get('https://v2.groupme.com/users/me').parsed['response']
+        @raw_info ||= response['user']
+      end
+
+      private
+
+      def client_params
+        {
+          :client_id => options[:client_id],
+          :redirect_uri => callback_url,
+          :response_type => "code"
+        }
+      end
+    end
+  end
+end

data/omniauth-groupme.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-groupme/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-groupme"
+  s.version     = Omniauth::GroupMe::VERSION
+  s.authors     = ["Pat Nakajima"]
+  s.email       = ["pat@groupme.com"]
+  s.homepage    = "https://github.com/groupme/omniauth-groupme"
+  s.summary     = %q{GroupMe OAuth strategy for OmniAuth}
+  s.description = %q{GroupMe OAuth strategy for OmniAuth}
+
+  s.rubyforge_project = "omniauth-groupme"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'omniauth', '~> 1.0'
+  s.add_dependency 'omniauth-oauth2', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/groupme_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'omniauth-groupme'
+
+describe OmniAuth::Strategies::GroupMe do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+  end
+
+  subject do
+    OmniAuth::Strategies::GroupMe.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct GroupMe site' do
+      subject.client.site.should eq('https://groupme.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/oauth/access_token')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      @raw_info = {
+        'name' => 'Fred Smith',
+        'email' => 'fred@example.com',
+        'avatar_url' => 'https://img-s.groupme.com/userpix_thumbs/blank_boy.jpg',
+        'country' => 'Chicago'
+      }
+      subject.stub(:raw_info) { @raw_info }
+    end
+
+    context 'when data is present in raw info' do
+      it 'returns the combined name' do
+        subject.info[:name].should eq('Fred Smith')
+      end
+
+      it 'returns the first name' do
+        subject.info[:first_name].should eq('Fred')
+      end
+
+      it 'returns the last name' do
+        subject.info[:last_name].should eq('Smith')
+      end
+
+      it 'returns the email' do
+        subject.info[:email].should eq('fred@example.com')
+      end
+
+      it 'returns the user image' do
+        subject.info[:image].should eq('https://img-s.groupme.com/userpix_thumbs/blank_boy.jpg')
+      end
+
+      it 'returns the user location' do
+        subject.info[:location].should eq('Chicago')
+      end
+    end
+  end
+
+  describe '#credentials' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      @access_token.stub(:token)
+      @access_token.stub(:expires?)
+      @access_token.stub(:expires_at)
+      @access_token.stub(:refresh_token)
+      subject.stub(:access_token) { @access_token }
+    end
+
+    it 'returns a Hash' do
+      subject.credentials.should be_a(Hash)
+    end
+
+    it 'returns the token' do
+      @access_token.stub(:token) { '123' }
+      subject.credentials['token'].should eq('123')
+    end
+
+    it 'returns the expiry status' do
+      @access_token.stub(:expires?) { true }
+      subject.credentials['expires'].should eq(true)
+
+      @access_token.stub(:expires?) { false }
+      subject.credentials['expires'].should eq(false)
+    end
+
+    it 'returns the refresh token and expiry time when expiring' do
+      ten_mins_from_now = (Time.now + 360).to_i
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { '321' }
+      @access_token.stub(:expires_at) { ten_mins_from_now }
+      subject.credentials['refresh_token'].should eq('321')
+      subject.credentials['expires_at'].should eq(ten_mins_from_now)
+    end
+
+    it 'does not return the refresh token when it is nil and expiring' do
+      @access_token.stub(:expires?) { true }
+      @access_token.stub(:refresh_token) { nil }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+
+    it 'does not return the refresh token when not expiring' do
+      @access_token.stub(:expires?) { false }
+      @access_token.stub(:refresh_token) { 'XXX' }
+      subject.credentials['refresh_token'].should be_nil
+      subject.credentials.should_not have_key('refresh_token')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification 
+name: omniauth-groupme
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 7
+  version: 0.0.7
+platform: ruby
+authors: 
+- Pat Nakajima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: omniauth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: omniauth-oauth2
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 7
+        version: "2.7"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: GroupMe OAuth strategy for OmniAuth
+email: 
+- pat@groupme.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-groupme.rb
+- lib/omniauth-groupme/version.rb
+- lib/omniauth/strategies/groupme.rb
+- omniauth-groupme.gemspec
+- spec/omniauth/strategies/groupme_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/groupme/omniauth-groupme
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: omniauth-groupme
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: GroupMe OAuth strategy for OmniAuth
+test_files: 
+- spec/omniauth/strategies/groupme_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+has_rdoc: