omniauth-mediawiki 0.0.2 → 0.0.3

data/Changelog

@@ -0,0 +1,8 @@
+0.0.3 
+Added email to raw_info
+Simplify mediawiki authentication code
+
+0.0.2 
+Initial Version
+
+

data/README.md

@@ -25,13 +25,14 @@ Once these are in, you need to add the following to your `config/initializers/om
 
 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' }}
+    config.omniauth :mediawiki, "consumer_key", "consumer_secret", 
+                    {:client_options => {:site => 'https://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
+## Info about the MediaWiki OAuth extension
 
 In general see the pages around https://www.mediawiki.org/wiki/OAuth/For_Developers for more information
 
@@ -48,11 +49,29 @@ Internally the strategy has to use  `/w/index.php?title=`  paths like so:
     
 This is a workaround as the paths should all be like the authorize path.
 
+Note also that new proposed registrations on mediawiki.org will work with your mediawki user that you registered the application with but have to be approved by an admin user for them to be useable by other users. 
 
 ## 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' }
+    config.omniauth :mediawiki, "consumer_key", "consumer_secret",  
+                    :client_options => {:site => 'https://commons.wikimedia.org' }
 
 if no site is specified the www.mediawiki.org wiki will be used.
+
+## How to call the MediaWiki API via Omniauth
+
+Within a Devise / Omniauth setup, in the callback method, you can directly get an OAuth::AccessToken  via ```request.env["omniauth.auth"]["extra"]["access_token"]``` or you can get the token and secret from ```request.env["omniauth.auth"]["credentials"]["token"]``` and ```request.env["omniauth.auth"]["credentials"]["secret"]```
+
+Assuming these are stored in the user model, the following could be used to query the mediawiki API at a later date. In this example we are using the Wikimedia Commons API https://www.mediawiki.org/wiki/API:Main_page
+
+    @consumer = OAuth::Consumer.new "consumer_key",  "consumer_secret",  
+                        {:site=>"https://commons.wikimedia.org"}
+    @access_token = OAuth::AccessToken.new(@consumer, user.auth_token, user.auth_secret) 
+    uri = 'https://commons.wikimedia.org/w/api.php?action=query&meta=userinfo&uiprop=rights|editcount&format=json'
+    resp = @access_token.get(URI.encode(uri))
+    logger.debug resp.body.inspect
+    # {"query":{"userinfo":{"id":12345,"name":"WikiUser",
+    # "rights":["read","writeapi","purge","autoconfirmed","editsemiprotected","skipcaptcha"],
+    # "editcount":2323}}}

data/lib/omniauth-mediawiki/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Mediawiki
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/omniauth/strategies/mediawiki.rb

@@ -20,34 +20,9 @@ module OmniAuth
         :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"
+        :request_token_path => '/w/index.php?title=Special:OAuth/initiate'
       }
 
-      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
@@ -58,6 +33,7 @@ module OmniAuth
       info do
         {
           :name => raw_info["username"],
+          :email => raw_info["email"],
           :urls => {"server" => raw_info["iss"]}
         }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-mediawiki
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-23 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth
@@ -165,6 +165,7 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
+- Changelog
 - Gemfile
 - LICENSE.md
 - README.md
@@ -189,18 +190,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4372388317667068380
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4372388317667068380
 requirements: []
 rubyforge_project: omniauth-mediawiki
 rubygems_version: 1.8.25