omniauth-snoonet 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bcdd10f2bf49c73cde78c0af48169c5f065c5c2
+  data.tar.gz: 114ef278b51c5b05e4354f0bb65e245c0b4548dd
+SHA512:
+  metadata.gz: f44a96aa5fe0a8f87a08647a221bceca174014691e929709e680a4e594bf7ac472ac47165e8060dc6c9847baa6195297b57ea0b6b34691f2f1b1d8bb038060be
+  data.tar.gz: 6e0660827363850f76dfe8bf2e7070a8807e170e55b8cc20a6aeb60e34804545250c541dd0835f387158fc4efd8ddb46ed7651b7de042cd4c609c12a9f0102bc

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,18 @@
+bundler_args: --without development
+gemfile:
+  - Gemfile
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'rack-test'
+  gem 'rspec', '~> 3.1.0'
+  gem 'simplecov', :require => false
+end
+
+gemspec

data/README.md

@@ -0,0 +1,100 @@
+omniauth-snoonet
+==============
+
+[![Gem Version](https://badge.fury.io/rb/omniauth-snoonet.png)](http://badge.fury.io/rb/omniauth-snoonet)
+[![Build Status](https://travis-ci.org/snoonetIRC/omniauth-snoonet.png?branch=master)](https://travis-ci.org/snoonetIRC/omniauth-snoonet)
+
+OmniAuth strategy to authenticate with Snoonet IRC services using OAuth 2.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-snoonet'
+```
+
+Then `bundle install`.
+
+
+## Usage
+
+`OmniAuth::Strategies::Snoonet` is simply Rack middleware. Read the OmniAuth docs for instructions: https://github.com/intridea/omniauth.
+
+An example what your `config/initializers/omniauth.rb` might look like:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :snoonet, ENV['SNOONET_CLIENT_ID'], ENV['SNOONET_CLIENT_SECRET']
+end
+```
+
+## Configuration
+
+Currently, there is only one configuration option that needs to be set:
+
+* `scope`: A comma-separated list of permissions you want to request from the user. The available permissions are as follows: `info`, `edit`.  Default: `info`
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :snoonet, ENV['SNOONET_CLIENT_ID'], ENV['SNOONET_CLIENT_SECRET'], :scope => 'info,edit'
+end
+
+```
+
+## Scope Details
+
+* `info`:	All NickServ info including the users email.
+* `edit`:	The ability to make changes to the users account.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'snoonet',
+  :uid => 'Nickname',
+  :info => {
+    :identifier => 'Nickname',
+    :registered => '2012-12-21 18:30:23',
+    :vhost => 'user/Nickname',
+    :lastquit => 'I quit.',
+    :options => ['Option', 'Other Option', 'Even Different Option'],
+    :email => 'john@example.com'
+  },
+  :credentials => {
+    :token => 'ABCDEF...',
+    :refresh_token => 'ABCDEF...',
+    :expires => true
+  },
+  :extra => {
+    :identifier => 'Nickname',
+    :info => {
+      :registered => {
+        :date => '2012-12-21 18:30:23',
+        :timezone_type => 3,
+        :timezone => 'UTC'
+      }
+      :vhost => 'user/Nickname',
+      :lastquit => 'I quit.',
+      :options => ['Option', 'Other Option', 'Even Different Option'],
+      :email => 'john@example.com'
+    }
+  }
+}
+```
+
+## Supported Ruby Versions
+`omniauth-snoonet` is tested under 1.9.2, 1.9.3, 2.0.0, 2.1.0, MRI Ruby HEAD, JRuby (1.9 mode and HEAD), and Rubinius
+(2.0 mode).
+
+## License
+
+Copyright (c) 2014 by Snoonet
+
+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/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+
+task :default => :spec

data/lib/omniauth-snoonet.rb

@@ -0,0 +1,2 @@
+require 'omniauth/snoonet/version'
+require 'omniauth/strategies/snoonet'

data/lib/omniauth/snoonet/version.rb

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

data/lib/omniauth/strategies/snoonet.rb

@@ -0,0 +1,46 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Snoonet < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'info'
+
+      option :client_options, :site          => 'https://oauth.snoonet.org',
+                              :authorize_url => 'https://oauth.snoonet.org/authorize',
+                              :token_url     => 'https://oauth.snoonet.org/access_token'
+
+      uid { raw_info['identifier'] }
+
+      info do
+        {
+          :identifier => raw_info['identifier'],
+          :registered => raw_info['info']['registered']['date'],
+          :vhost => raw_info['info']['vhost'],
+          :lastquit => raw_info['info']['lastQuit'],
+          :options => raw_info['info']['options'],
+          :email => raw_info['info']['email']
+        }
+      end
+
+      extra do
+        {
+          :raw_info => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/info').parsed || {}
+      end
+
+      def request_phase
+        options[:authorize_params] = {
+          :client_id     => options['client_id'],
+          :response_type => 'code',
+          :scope         => (options['scope'] || DEFAULT_SCOPE)
+        }
+
+        super
+      end
+    end
+  end
+end

data/omniauth-snoonet.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'omniauth/snoonet/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'omniauth-snoonet'
+  s.version       = OmniAuth::Snoonet::VERSION
+  s.authors       = ['Snoonet']
+  s.email         = ['operations@snoonet.org']
+  s.summary       = 'Snoonet strategy for OmniAuth'
+  s.description   = 'Snoonet strategy for OmniAuth'
+  s.homepage      = 'https://github.com/snoonetIRC/omniauth-snoonet'
+  s.license       = 'MIT'
+
+  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").collect { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth', '~> 1.2'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+
+  s.add_development_dependency 'dotenv', '~> 0'
+  s.add_development_dependency 'sinatra', '~> 0'
+end

data/spec/app.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'dotenv'
+require 'sinatra'
+require 'omniauth'
+require 'omniauth-snoonet'
+
+Dotenv.load
+
+enable :sessions
+
+use OmniAuth::Builder do
+  provider :snoonet, ENV['CLIENT_ID'], ENV['CLIENT_SECRET'] # , :scope => 'profile'
+end
+
+get '/' do
+  <<-HTML
+  <a href='/auth/snoonet'>Sign in with Snoonet</a>
+  HTML
+end
+
+get '/auth/failure' do
+  env['omniauth.error'].to_s
+end
+
+get '/auth/:name/callback' do
+  auth = request.env['omniauth.auth']
+
+  puts %(
+    >> UID
+      #{auth.uid.inspect}
+
+    >> CREDENTIALS
+      #{auth.credentials.inspect}
+
+    >> INFO
+      #{auth.info.inspect}
+      #
+    >> EXTRA
+      #{auth.extra.inspect}
+  )
+
+  'Check logs for user information.'
+end

data/spec/omniauth/strategies/snoonet_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Snoonet do
+  subject do
+    @subject ||= begin
+      @options ||= {}
+      args = ['client_id', 'client_secret', @options].compact
+      OmniAuth::Strategies::Snoonet.new(*args)
+    end
+  end
+
+  context 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq('snoonet')
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://oauth.snoonet.org')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://oauth.snoonet.org/authorize')
+    end
+
+    it 'should have correct access token url' do
+      expect(subject.options.client_options.token_url).to eq('https://oauth.snoonet.org/access_token')
+    end
+
+    it 'should indicate that the provider ignores the state parameter' do
+      expect(subject.options.provider_ignores_state).to eq false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rspec'
+require 'simplecov'
+SimpleCov.start
+
+require 'omniauth'
+require 'omniauth-snoonet'
+
+RSpec.configure do |config|
+  config.extend OmniAuth::Test::StrategyMacros, :type => :strategy
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-snoonet
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Snoonet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Snoonet strategy for OmniAuth
+email:
+- operations@snoonet.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-snoonet.rb
+- lib/omniauth/snoonet/version.rb
+- lib/omniauth/strategies/snoonet.rb
+- omniauth-snoonet.gemspec
+- spec/app.rb
+- spec/omniauth/strategies/snoonet_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/snoonetIRC/omniauth-snoonet
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Snoonet strategy for OmniAuth
+test_files:
+- spec/app.rb
+- spec/omniauth/strategies/snoonet_spec.rb
+- spec/spec_helper.rb