omniauth-mailup 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brian Getting
+
+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,52 @@
+# OmniAuth Mailup
+
+MailUp OAuth2 Strategy for OmniAuth 1.0.
+
+## Installing
+
+Add the strategy to your `Gemfile`:
+
+    gem 'omniauth-mailup'
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::MailUp` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+```ruby
+use OmniAuth::Builder do
+  provider :mailup, ENV['MAILUP_CLIENT_ID'], ENV['MAILUP_CLIENT_SECRET']
+end
+```
+
+In Rails, you'll want to add to the middleware stack:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :mailup, ENV['MAILUP_CLIENT_ID'], ENV['MAILUP_CLIENT_SECRET']
+end
+```
+
+## Authentication Hash
+
+Here's an example _Authentication Hash_ available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'mailup',
+  :credentials => {
+    :token => 'adsf456lkj758klfdsg' # OAuth 2.0 access_token. Store and use to authenticate API requests.
+  }
+}
+```
+
+## License
+
+Copyright (c) 2013 by Brian Getting and MailUp 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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gem 'rack'
+gem 'sinatra'
+gem 'omniauth-mailup', :path => '../'

data/example/config.ru

@@ -0,0 +1,37 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-mailup'
+
+class App < Sinatra::Base
+  get '/' do
+    <<-HTML
+    <div>
+      Your credentials are :
+      <ul>
+        <li>client id : #{ENV["MAILUP_CLIENT_ID"]}</li>
+        <li>secret key : #{ENV["MAILUP_CLIENT_SECRET"]}</li>
+      </ul>
+    </div>
+    <a href='/auth/mailup'>Sign in with MailUp</a>
+    HTML
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'text/plain'
+    token = request.env['omniauth.auth']['credentials']['token']
+    "Access token is #{token}".inspect rescue "No data"
+  end
+
+  get '/auth/failure' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
+end
+
+use Rack::Session::Cookie, :secret => ENV['RACK_COOKIE_SECRET']
+
+use OmniAuth::Builder do
+  provider :mailup, ENV["MAILUP_CLIENT_ID"], ENV["MAILUP_CLIENT_SECRET"]
+end
+
+run App.new

data/lib/omniauth/strategies/mailup.rb

@@ -0,0 +1,35 @@
+require 'omniauth-oauth2'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class MailUp < OmniAuth::Strategies::OAuth2
+      
+      option :name, :mailup
+
+      option :client_options, {
+        :site => "https://services.mailup.com",
+        :authorize_url => "/Authorization/OAuth/LogOn",
+        :token_url => "/Authorization/OAuth/Token"
+      }
+      
+      # TODO: Do we need this?
+      #option :provider_ignores_state, true
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          :email => raw_info["email"]
+          # TODO: Whatever other info we want to return
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/API/v1/Console/User/Info.json').parsed
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'mailup', 'MailUp'

data/lib/omniauth-mailup/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module MailUp
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth-mailup.rb

@@ -0,0 +1,2 @@
+require "omniauth-mailup/version"
+require "omniauth/strategies/mailup"

data/omniauth-mailup.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-mailup/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-mailup"
+  gem.version       = Omniauth::MailUp::VERSION
+  gem.authors       = ["Brian Getting"]
+  gem.email         = ["brian@tatem.ae"]
+  gem.description   = %q{MailUp OAuth2 Strategy for OmniAuth 1.0.}
+  gem.summary       = %q{OAuth2 Strategy for OmniAuth 1.0 for connecting to the MailUp REST API.}
+  gem.homepage      = "https://github.com/tatemae-consultancy/omniauth-mailup"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.0'
+  
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+end

data/spec/omniauth/strategies/mailup_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+require 'omniauth-mailup'
+require 'base64'
+
+describe OmniAuth::Strategies::MailUp do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+  end
+  
+  subject do
+    OmniAuth::Strategies::MailUp.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+	describe '#client' do
+    it 'has correct MailUp api site' do
+      subject.options.client_options.site.should eq('https://services.mailup.com')
+    end
+
+    it 'has correct access token path' do
+      subject.options.client_options.token_url.should eq('/Authorization/OAuth/Token')
+    end
+
+    it 'has correct authorize url' do
+      subject.options.client_options.authorize_url.should eq('/Authorization/OAuth/LogOn')
+    end
+  end
+
+	describe '#callback_path' do
+    it 'should have the correct callback path' do
+      subject.callback_path.should eq('/auth/mailup/callback')
+    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
+  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 token params passed in the :token_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 :token_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,110 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-mailup
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Getting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rake
+  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: MailUp OAuth2 Strategy for OmniAuth 1.0.
+email:
+- brian@tatem.ae
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-mailup.rb
+- lib/omniauth-mailup/version.rb
+- lib/omniauth/strategies/mailup.rb
+- omniauth-mailup.gemspec
+- spec/omniauth/strategies/mailup_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/tatemae-consultancy/omniauth-mailup
+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.24
+signing_key: 
+specification_version: 3
+summary: OAuth2 Strategy for OmniAuth 1.0 for connecting to the MailUp REST API.
+test_files:
+- spec/omniauth/strategies/mailup_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb