omniauth-flowdock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcdce5ae5ea73899c2933fef64613f98195d8d09
+  data.tar.gz: d1b9810190b40317ed5be4b8e11b386c213863ce
+SHA512:
+  metadata.gz: 882333535dc370287e5015fb67af7b42158d0efb68edc0e62d02f1f14e61968a02d28a82273a3311ce81999c137cd023564ff71f0e08399d085ae0f479b8233f
+  data.tar.gz: aacc831d8caf2426d741ef90682c5dfae1ae33092f36a83bbd4005399ee925cdbe0e9f83700271038c2d53e8d21473e9cfbd1db0cd6eba5d7878ec4d5d6b7777

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-flowdock.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rally Software Development Corp.
+
+MIT License
+
+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,53 @@
+# OmniAuth Flowdock Strategy [![Build Status](https://travis-ci.org/flowdock/omniauth-flowdock.png)](https://travis-ci.org/flowdock/omniauth-flowdock)
+
+Flowdock OAuth 2.0 Strategy for OmniAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-flowdock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-flowdock
+
+## Usage
+
+You should have already installed OmniAuth into your app; if not, read the
+[OmniAuth README](https://github.com/intridea/omniauth) to get started.
+
+Then, you need to [create an Flowdock OAuth 2.0 application](https://www.flowdock.com/account/authorized_applications).
+The application ID and consumer secret are needed. Ensure that your callback URL
+is properly configured, e.g. `https://example.com/auth/flowdock/callback`.
+
+Then, register the Flowdock provider. For example, your
+`config/initializers/omniauth.rb` might look like following:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :flowdock, ENV['FLOWDOCK_CLIENT_ID'], ENV['FLOWDOCK_CLIENT_SECRET']
+end
+```
+
+If you need more access than just user profile, change the scope field accordingly.
+For example, to post to user's flows
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :flowdock, ENV['FLOWDOCK_CLIENT_ID'], ENV['FLOWDOCK_CLIENT_SECRET'], scope: 'flow'
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task default: :spec

data/lib/omniauth-flowdock.rb

@@ -0,0 +1 @@
+require 'omniauth/flowdock'

data/lib/omniauth/flowdock.rb

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

data/lib/omniauth/flowdock/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Flowdock
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/flowdock.rb

@@ -0,0 +1,30 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Flowdock < OmniAuth::Strategies::OAuth2
+      option :name, :flowdock
+
+      option :client_options, {
+        site: "https://api.flowdock.com",
+        authorize_url: "/oauth/authorize"
+      }
+
+      option :scope, 'profile'
+
+      uid { raw_info["id"].to_s }
+
+      info do
+        {
+          email: raw_info["email"],
+          name: raw_info["name"],
+          nickname: raw_info["nick"]
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('user').parsed
+      end
+    end
+  end
+end

data/omniauth-flowdock.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/flowdock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-flowdock"
+  spec.version       = Omniauth::Flowdock::VERSION
+  spec.authors       = ["Ville Lautanala"]
+  spec.email         = ["lautis@gmail.com"]
+  spec.summary       = %q{Flowdock OAuth 2.0 Strategy for OmniAuth}
+  spec.description   = %q{Flowdock OAuth 2.0 Strategy for OmniAuth}
+  spec.homepage      = "https://github.com/flowdock/omniauth-flowdock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth-oauth2", "~> 1.1"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/omniauth/strategies/flowdock_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+
+describe OmniAuth::Strategies::Flowdock do
+  let(:access_token) { double('AccessToken', options: {}) }
+  let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
+  let(:parsed_response) { double('ParsedResponse') }
+  let(:response) { double('Response', parsed: parsed_response) }
+
+  subject do
+    args = ['client-id', 'client-secret', {}].compact
+    OmniAuth::Strategies::Flowdock.new(*args).tap do |strategy|
+      allow(strategy).to receive(:request).and_return(request)
+    end
+  end
+
+  describe 'client options' do
+    it 'has correct name' do
+      expect(subject.options.name).to eq(:flowdock)
+    end
+
+    it 'has correct site' do
+      expect(subject.options.client_options.site).to eq('https://api.flowdock.com')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('/oauth/authorize')
+    end
+  end
+
+  describe '#uid' do
+    before do
+      allow(subject).to receive(:raw_info).and_return({'id' => 123 })
+    end
+
+    it "stringifies user id" do
+      expect(subject.uid).to eq("123")
+    end
+  end
+
+  describe '#user_info' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(
+        {
+          'name' => 'John Doe',
+          'email' => 'jdoe@example.com',
+          'nick' => 'John'
+        }
+      )
+    end
+
+    it 'has name' do
+      expect(subject.info[:name]).to eq('John Doe')
+    end
+
+    it 'has nickname' do
+      expect(subject.info[:nickname]).to eq('John')
+    end
+
+    it 'has email' do
+      expect(subject.info[:email]).to eq('jdoe@example.com')
+    end
+  end
+
+  context "#raw_info" do
+    it "requests raw info from /user" do
+      allow(subject).to receive(:access_token).and_return(access_token)
+      access_token.should_receive(:get).with('user').and_return(response)
+      expect(subject.raw_info).to eq(parsed_response)
+    end
+  end
+
+  describe '#authorize_params' do
+    before :each do
+      allow(subject).to receive(:session).and_return({})
+    end
+
+    it 'sets default scope' do
+      expect(subject.authorize_params['scope']).to eq('profile')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'omniauth'
+require 'omniauth-flowdock'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-flowdock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Flowdock OAuth 2.0 Strategy for OmniAuth
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-flowdock.rb
+- lib/omniauth/flowdock.rb
+- lib/omniauth/flowdock/version.rb
+- lib/omniauth/strategies/flowdock.rb
+- omniauth-flowdock.gemspec
+- spec/omniauth/strategies/flowdock_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/flowdock/omniauth-flowdock
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Flowdock OAuth 2.0 Strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/flowdock_spec.rb
+- spec/spec_helper.rb