omniauth-twitter 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e6626f2d76da338cfcc7a60eb7881276193d59f
+  data.tar.gz: 5a4b555f23c9bff6d3947d485d18b8f85ce9392f
+SHA512:
+  metadata.gz: 35bced171375fac4f94231679e3707afbba5912a672cb284a30cc82f796736b2e67f32ee9fdbccfa8b41c2ad53f0e4f0e88a2ca9cd42aa787c13e0574da6a515
+  data.tar.gz: 813b9096c7ed44a87530a4a7bdb162040809f4a4711baf5cd2cbab3af0ff16d09d5cdd5fdf1593627dfb40ebee6d004e5df64f3572cf1ecd62c7aed910b88a30

data/README.md

@@ -46,6 +46,8 @@ The options are:
 
 * **screen_name** - This option implies **force_login**, except the screen name field is pre-filled with a particular value. *Example:* `http://yoursite.com/auth/twitter?screen_name=jim`
 
+* **lang** - The language used in the Twitter prompt. This is useful for adding i18n support since the language of the prompt can be dynamically set for each user. *Example:* `http://yoursite.com/auth/twitter?lang=pt`
+
 * **secure_image_url** - Set to `true` to use https for the user's image url. Default is `false`.
 
 * **image_size**: This option defines the size of the user's image. Valid options include `mini` (24x24), `normal` (48x48), `bigger` (73x73) and `original` (the size of the image originally uploaded). Default is `normal`.
@@ -54,6 +56,94 @@ The options are:
 
 * **use_authorize** - There are actually two URLs you can use against the Twitter API. As mentioned, the default is `https://api.twitter.com/oauth/authenticate`, but you also have `https://api.twitter.com/oauth/authorize`. Passing this option as `true` will use the second URL rather than the first. What's the difference? As described [here](https://dev.twitter.com/docs/api/1/get/oauth/authenticate), with `authenticate`, if your user has already granted permission to your application, Twitter will redirect straight back to your application, whereas `authorize` forces the user to go through the "grant permission" screen again. For certain use cases this may be necessary. *Example:* `http://yoursite.com/auth/twitter?use_authorize=true`. *Note:* You must have "Allow this application to be used to Sign in with Twitter" checked in [your application's settings](https://dev.twitter.com/apps) - without it your user will be asked to authorize your application each time they log in.
 
+Here's an example of a possible configuration where the the user's original profile picture is returned over https, the user is always prompted to sign-in and the default language of the Twitter prompt is changed:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :twitter, ENV["TWITTER_KEY"], ENV["TWITTER_SECRET"],
+    {
+      :secure_image_url => 'true',
+      :image_size => 'original',
+      :authorize_params => {
+        :force_login => 'true',
+        :lang => 'pt'
+      }
+    }
+end
+```
+
+## Authentication Hash
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => "twitter",
+  :uid => "123456",
+  :info => {
+    :nickname => "johnqpublic",
+    :name => "John Q Public",
+    :location => "Anytown, USA",
+    :image => "http://si0.twimg.com/sticky/default_profile_images/default_profile_2_normal.png",
+    :description => "a very normal guy.",
+    :urls => {
+      :Website => nil,
+      :Twitter => "https://twitter.com/johnqpublic"
+    }
+  },
+  :credentials => {
+    :token => "a1b2c3d4...", # The OAuth 2.0 access token
+    :secret => "abcdef1234"
+  },
+  :extra => {
+    :access_token => "", # An OAuth::AccessToken object
+    :raw_info => {
+      :name => "John Q Public",
+      :listed_count" => 0,
+      :profile_sidebar_border_color" => "181A1E",
+      :url => nil,
+      :lang => "en",
+      :statuses_count => 129,
+      :profile_image_url => "http://si0.twimg.com/sticky/default_profile_images/default_profile_2_normal.png",
+      :profile_background_image_url_https => "https://twimg0-a.akamaihd.net/profile_background_images/229171796/pattern_036.gif",
+      :location => "Anytown, USA",
+      :time_zone => "Chicago",
+      :follow_request_sent => false,
+      :id => 123456,
+      :profile_background_tile => true,
+      :profile_sidebar_fill_color => "666666",
+      :followers_count => 1,
+      :default_profile_image => false,
+      :screen_name => "",
+      :following => false,
+      :utc_offset => -3600,
+      :verified => false,
+      :favourites_count => 0,
+      :profile_background_color => "1A1B1F",
+      :is_translator => false,
+      :friends_count => 1,
+      :notifications => false,
+      :geo_enabled => true,
+      :profile_background_image_url => "http://twimg0-a.akamaihd.net/profile_background_images/229171796/pattern_036.gif",
+      :protected => false,
+      :description => "a very normal guy.",
+      :profile_link_color => "2FC2EF",
+      :created_at => "Thu Jul 4 00:00:00 +0000 2013",
+      :id_str => "123456",
+      :profile_image_url_https => "https://si0.twimg.com/sticky/default_profile_images/default_profile_2_normal.png",
+      :default_profile => false,
+      :profile_use_background_image => false,
+      :entities => {
+        :description => {
+          :urls => []
+        }
+      },
+      :profile_text_color => "666666",
+      :contributors_enabled => false
+    }
+  }
+}
+```
+
 ## Watch the RailsCast
 
 Ryan Bates has put together an excellent RailsCast on OmniAuth:

data/lib/omniauth-twitter/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Twitter
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/omniauth/strategies/twitter.rb

@@ -5,6 +5,7 @@ module OmniAuth
   module Strategies
     class Twitter < OmniAuth::Strategies::OAuth
       option :name, 'twitter'
+
       option :client_options, {:authorize_path => '/oauth/authenticate',
                                :site => 'https://api.twitter.com',
                                :proxy => ENV['http_proxy'] ? URI(ENV['http_proxy']) : nil}
@@ -16,7 +17,7 @@ module OmniAuth
           :nickname => raw_info['screen_name'],
           :name => raw_info['name'],
           :location => raw_info['location'],
-          :image => image_url(options),
+          :image => image_url,
           :description => raw_info['description'],
           :urls => {
             'Website' => raw_info['url'],
@@ -38,26 +39,22 @@ module OmniAuth
       alias :old_request_phase :request_phase
 
       def request_phase
-        force_login = session['omniauth.params'] ? session['omniauth.params']['force_login'] : nil
-        screen_name = session['omniauth.params'] ? session['omniauth.params']['screen_name'] : nil
-        x_auth_access_type = session['omniauth.params'] ? session['omniauth.params']['x_auth_access_type'] : nil
-        if force_login && !force_login.empty?
-          options[:authorize_params] ||= {}
-          options[:authorize_params].merge!(:force_login => 'true')
-        end
-        if screen_name && !screen_name.empty?
-          options[:authorize_params] ||= {}
-          options[:authorize_params].merge!(:screen_name => screen_name)
+        %w[force_login lang screen_name].each do |v|
+          if request.params[v]
+            options[:authorize_params][v.to_sym] = request.params[v]
+          end
         end
-        if x_auth_access_type
-          options[:request_params] ||= {}
-          options[:request_params].merge!(:x_auth_access_type => x_auth_access_type)
+
+        %w[x_auth_access_type].each do |v|
+          if request.params[v]
+            options[:request_params][v.to_sym] = request.params[v]
+          end
         end
 
-        if session['omniauth.params'] && session['omniauth.params']["use_authorize"] == "true"
-          options.client_options.authorize_path = '/oauth/authorize'
+        if request.params['use_authorize'] == 'true'
+          options[:client_options][:authorize_path] = '/oauth/authorize'
         else
-          options.client_options.authorize_path = '/oauth/authenticate'
+          options[:client_options][:authorize_path] = '/oauth/authenticate'
         end
 
         old_request_phase
@@ -65,7 +62,7 @@ module OmniAuth
 
       private
 
-      def image_url(options)
+      def image_url
         original_url = options[:secure_image_url] ? raw_info['profile_image_url_https'] : raw_info['profile_image_url']
         case options[:image_size]
         when 'mini'

data/spec/omniauth/strategies/twitter_spec.rb

@@ -1,9 +1,15 @@
 require 'spec_helper'
 
 describe OmniAuth::Strategies::Twitter do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+
   subject do
     args = ['appid', 'secret', @options || {}].compact
-    OmniAuth::Strategies::Twitter.new(*args)
+    OmniAuth::Strategies::Twitter.new(*args).tap do |strategy|
+      strategy.stub(:request) {
+        request
+      }
+    end
   end
 
   describe 'client options' do
@@ -50,9 +56,9 @@ describe OmniAuth::Strategies::Twitter do
   describe 'request_phase' do
     context 'with no request params set and x_auth_access_type specified' do
       before do
-        subject.options[:request_params] = nil
-        subject.stub(:session).and_return(
-          {'omniauth.params' => {'x_auth_access_type' => 'read'}})
+        subject.stub(:request).and_return(
+          double('Request', {:params => {'x_auth_access_type' => 'read'}})
+        )
         subject.stub(:old_request_phase).and_return(:whatever)
       end
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-twitter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Arun Agrawal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,49 +55,43 @@ dependencies:
 - !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: simplecov
   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: webmock
   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: OmniAuth strategy for Twitter
@@ -129,33 +116,26 @@ files:
 homepage: https://github.com/arunagw/omniauth-twitter
 licenses:
 - MIT
+metadata: {}
 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: 248112754697321347
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 248112754697321347
 requirements: []
 rubyforge_project: omniauth-twitter
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: OmniAuth strategy for Twitter
 test_files:
 - spec/omniauth/strategies/twitter_spec.rb