omniauth-figshare 0.0.1

data/README.rdoc

@@ -0,0 +1,93 @@
+= omniauth-figshare
+
+* https://github.com/jdleesmiller/omniauth-figshare
+
+An OmniAuth Strategy for the figshare API. You can use it to authenticate users
+against the figshare API in your ruby on rails / sinatra / other rack-based web
+application.
+
+=== Usage
+
+Add this strategy to your Gemfile:
+
+  gem 'omniauth-figshare'
+
+Then add the strategy as Rack middleware. In rails, you can add an initializer
++config/initializers/omniauth.rb+ containing 
+
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :figshare,
+      ENV['FIGSHARE_CONSUMER_KEY'],
+      ENV['FIGSHARE_CONSUMER_SECRET'],
+  end
+
+where the consumer key and secret are obtained from your figshare app's
+settings and stored in environmental variables.
+
+Then create routes 
+
+  match '/auth/figshare/callback', to: 'authentications#create'
+  match '/auth/failure', to: 'authentications#failure'
+
+and an +AuthenticationController+ to handle the postback from figshare upon
+successful (or failed) authentication:
+
+  class AuthenticationsController < ApplicationController
+    #
+    # We use this only to connect oauth accounts to existing wL accounts, at
+    # present.
+    #
+    def create
+      auth = env["omniauth.auth"]
+      # ...
+      # You should store
+      #   auth.credentials.token
+      #   auth.credentials.secret
+      # for future authentication against the figshare API. auth[:uid] is the
+      # user's figshare user id.
+      #
+      # hint: check env['omniauth.origin'] to redirect the user to wherever they
+      # were trying to get to before connecting
+    end
+  end
+
+For more information, see
+
+* https://github.com/intridea/omniauth/wiki -- the official OmniAuth docs
+* http://railscasts.com/episodes/241-simple-omniauth -- for background
+* http://railscasts.com/episodes/235-omniauth-part-1 -- for integration with devise
+* http://railscasts.com/episodes/235-omniauth-part-2 -- for integration with devise 
+
+=== Notes
+
+Figshare supports OAuth 1.0, so this is just a light wrapper over the standard
+OmniAuth OAuth strategy.
+
+This is an extraction from writeLaTeX, the online scientific writing platform
+(www.writelatex.com).
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2013 John Lees-Miller
+
+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/lib/omniauth-figshare.rb

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

data/lib/omniauth-figshare/version.rb

@@ -0,0 +1,8 @@
+module OmniAuth
+  module Figshare
+    VERSION_MAJOR = 0
+    VERSION_MINOR = 0
+    VERSION_PATCH = 1
+    VERSION = [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH].join('.')
+  end
+end

data/lib/omniauth/strategies/figshare.rb

@@ -0,0 +1,37 @@
+require 'omniauth-oauth'
+
+#
+# Fix a minor non-conformity in the figshare API: from request_token, it should
+# return
+#   oauth_callback_confirmed=true
+# (small t on true) but it returns
+#   oauth_callback_confirmed=True
+# (big T on True). This is enough to cause omniauth-oauth not to pass the
+# oauth_verifier back to access_token, which breaks authentication.
+#
+module OAuth
+  class RequestToken
+    def figshare_callback_confirmed?
+      params[:oauth_callback_confirmed].casecmp("true") == 0
+    end
+
+    alias_method :original_callback_confirmed?, :callback_confirmed?
+    alias_method :callback_confirmed?, :figshare_callback_confirmed?
+  end
+end
+
+module OmniAuth
+  module Strategies
+    class Figshare < OmniAuth::Strategies::OAuth
+      option :name, 'figshare'
+      
+      option :client_options, {
+        :site => 'http://api.figshare.com/v1/pbl'
+      }
+
+      uid {
+        access_token.params['xoauth_figshare_id']
+      }
+    end
+  end
+end

data/test/omniauth-figshare/omniauth-figshare_test.rb

@@ -0,0 +1,9 @@
+require 'omniauth-figshare'
+require 'test/unit'
+
+class TestOmniAuthFigshare < Test::Unit::TestCase
+  def test_omniauth_figshare
+    # no tests yet :(
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-figshare
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- John Lees-Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-29 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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: gemma
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: An OmniAuth Strategy for the figshare API. You can use it to authenticate
+  users against the figshare API in your ruby on rails / sinatra / other rack-based
+  web application.
+email:
+- jdleesmiller
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/omniauth-figshare/version.rb
+- lib/omniauth-figshare.rb
+- lib/omniauth/strategies/figshare.rb
+- README.rdoc
+- test/omniauth-figshare/omniauth-figshare_test.rb
+homepage: https://github.com/jdleesmiller
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+- --title
+- omniauth-figshare-0.0.1 Documentation
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -805240337
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -805240337
+requirements: []
+rubyforge_project: omniauth-figshare
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: An OmniAuth strategy for the figshare API.
+test_files:
+- test/omniauth-figshare/omniauth-figshare_test.rb
+has_rdoc: