omniauth-mediawiki 0.0.1

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+bundle
+.config
+.directory
+.elc
+.emacs.desktop
+.emacs.desktop.lock
+.redcar
+.yardoc
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+omniauth-mediawiki

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p547

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+notifications:
+  email:
+    - info@christophbuente.de

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+(Based on openstreetmap strategy by Copyright (c) 2011 Christoph Bünte)
+Copyright (c) 2011 Tim Waters
+
+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,58 @@
+# OmniAuth Mediawiki
+
+
+This gem contains the MediaWiki strategy for OmniAuth.
+
+MediaWiki uses the OAuth 1.0a extension, you can read about it here: https://www.mediawiki.org/wiki/Extension:OAuth
+
+## How To Use It
+
+Usage is as per any other OmniAuth 1.0 strategy. So let's say you're using Rails, you need to add the strategy to your `Gemfile` along side omniauth:
+
+    gem 'omniauth'
+    gem 'omniauth-mediawiki'
+
+Of course if one or both of these are unreleased, you may have to pull them in directly from github e.g.:
+
+    gem 'omniauth', :git => 'https://github.com/intridea/omniauth.git'
+    gem 'omniauth-mediawiki', :git => 'https://github.com/timwaters/omniauth-mediawiki.git'
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :mediawiki, "consumer_key", "consumer_secret"
+    end
+
+If you are using devise, this is how it looks like in your `config/initializers/devise.rb`:
+
+    config.omniauth :mediawiki, "consumer_key", "consumer_secret", {:client_options => {:site => 'http://commons.wikimedia.org' }}
+
+You will obviously have to put in your key and secret, which you get when you register your app on your particula Wiki.
+
+Now just follow the README at: https://github.com/intridea/omniauth
+
+## Info about the Medaiwiki OAuth extension
+
+In general see the pages around https://www.mediawiki.org/wiki/OAuth/For_Developers for more information
+
+When registering for a new OAuth consumer registration you need to specify the callback url properly. e.g. for development:
+
+    http://localhost:3000/u/auth/mediawiki/callback 
+    http://localhost:3000/users/auth/mediawiki/callback
+    
+Internally the strategy has to use  `/w/index.php?title=`  paths like so:
+
+    :authorize_path => '/wiki/Special:Oauth/authorize',
+    :access_token_path => '/w/index.php?title=Special:OAuth/token',
+    :request_token_path => '/w/index.php?title=Special:OAuth/initiate',
+    
+This is a workaround as the paths should all be like the authorize path.
+
+
+## Specifying Target Wiki
+
+If you would like to use this plugin against a wiki you should pass this you can use the environment variable WIKI_AUTH_SITE to set the server to connect to. Alternatively you can pass the site as a client_option to the omniauth config:
+
+    config.omniauth :mediawiki, "consumer_key", "consumer_secret",  :client_options => {:site => 'http://commons.wikimedia.org' }
+
+if no site is specified the www.mediawiki.org wiki will be used.

data/Rakefile

@@ -0,0 +1,11 @@
+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-mediawiki.rb

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

data/lib/omniauth-mediawiki/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Mediawiki
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/mediawiki.rb

@@ -0,0 +1,89 @@
+require 'omniauth-oauth'
+require 'rexml/document'
+require 'jwt'
+
+module OmniAuth
+  module Strategies
+    class Mediawiki < OmniAuth::Strategies::OAuth
+      option :name, "mediawiki"
+
+      def self.site
+        if ENV['WIKI_AUTH_SITE']
+          ENV['WIKI_AUTH_SITE']
+        else
+          "https://www.mediawiki.org"
+        end
+      end
+
+
+      option :client_options, {
+        :site => site,
+        :authorize_path => '/wiki/Special:Oauth/authorize',
+        :access_token_path => '/w/index.php?title=Special:OAuth/token',
+        :request_token_path => '/w/index.php?title=Special:OAuth/initiate',
+        :oauth_callback=> "oob"
+      }
+
+      def request_phase
+        request_token = consumer.get_request_token(:oauth_callback => callback_url)
+        session['oauth'] ||= {}
+        session['oauth'][name.to_s] = {'callback_confirmed' => request_token.callback_confirmed?, 'request_token' => request_token.token, 'request_secret' => request_token.secret}
+        r = Rack::Response.new
+
+        if request_token.callback_confirmed?
+          r.redirect(request_token.authorize_url(
+                       :oauth_consumer_key => consumer.key
+          ))
+        else
+          r.redirect(request_token.authorize_url(
+                       :oauth_callback => callback_url,
+                       :oauth_consumer_key => consumer.key
+          ))
+        end
+
+        r.finish
+      end
+
+      def callback_url
+        'oob'
+      end
+
+      # These are called after authentication has succeeded. If
+      # possible, you should try to set the UID without making
+      # additional calls (if the user id is returned with the token
+      # or as a URI parameter). This may not be possible with all
+      # providers.
+      uid{ raw_info["sub"] }
+
+      info do
+        {
+          :name => raw_info["username"],
+          :urls => {"server" => raw_info["iss"]}
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+
+      def raw_info
+        @raw_info ||= parse_info(access_token.get('/w/index.php?title=Special:OAuth/identify'))
+
+        @raw_info
+      end
+      
+      private
+      
+      def parse_info(jwt_data)
+        ident = jwt_data.body
+        payload, header = JWT.decode(ident, consumer.secret)
+        
+        payload
+      end
+
+    end
+  end
+end

data/omniauth-mediawiki.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-mediawiki/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = 'omniauth-mediawiki'
+  gem.version     = OmniAuth::Mediawiki::VERSION
+  gem.authors     = ["Tim Waters"]
+  gem.email       = 'tim@geothings.net'
+  gem.homepage    = 'https://github.com/timwaters/omniauth-mediawiki'
+  gem.description = %q{Mediawiki strategy for OmniAuth 1.0a}
+  gem.summary     = %q{Mediawiki strategy for OmniAuth 1.0a}
+  gem.license     = 'MIT'
+
+  gem.rubyforge_project = "omniauth-mediawiki"
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency "omniauth-oauth", "~> 1.0"
+  gem.add_runtime_dependency "jwt", "~> 1.0"
+
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'simplecov', '~> 0.5'
+  gem.add_development_dependency 'webmock', '~> 1.7'
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'sinatra'
+end

data/spec/integration.spec

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'OmniAuth::Strategies::Mediawiki Integration' do
+  pending 'write some tests yo'
+end

data/spec/omniauth/strategies/mediawiki_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Mediawiki do
+  subject do
+    OmniAuth::Strategies::Mediawiki.new({})
+  end
+
+  context 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq('mediawiki')
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://www.mediawiki.org')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_path).to eq('/wiki/Special:Oauth/authorize')
+    end
+
+    it 'should have correct access token url' do
+      expect(subject.options.client_options.access_token_path).to eq('/w/index.php?title=Special:OAuth/token')
+    end
+
+    it 'should have correct request token url' do
+      expect(subject.options.client_options.request_token_path).to eq('/w/index.php?title=Special:OAuth/initiate')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$:.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-mediawiki'
+
+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,211 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-mediawiki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tim Waters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 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: sinatra
+  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: Mediawiki strategy for OmniAuth 1.0a
+email: tim@geothings.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/omniauth-mediawiki.rb
+- lib/omniauth-mediawiki/version.rb
+- lib/omniauth/strategies/mediawiki.rb
+- omniauth-mediawiki.gemspec
+- spec/integration.spec
+- spec/omniauth/strategies/mediawiki_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/timwaters/omniauth-mediawiki
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4338702317791494363
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4338702317791494363
+requirements: []
+rubyforge_project: omniauth-mediawiki
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Mediawiki strategy for OmniAuth 1.0a
+test_files: []