omniauth-twitter 0.0.13 → 0.0.14

data/README.md

@@ -2,51 +2,53 @@
 
 This gem contains the Twitter strategy for OmniAuth.
 
-Twitter uses the OAuth 1.0a flow, you can read about it here: https://dev.twitter.com/docs/auth/oauth
+Twitter offers a few different methods of integration. This strategy implements the browser variant of the "[Sign in with Twitter](https://dev.twitter.com/docs/auth/implementing-sign-twitter)" flow.
 
-## How To Use It
+Twitter uses OAuth 1.0a. Twitter's developer area contains ample documentation on how it implements this, so if you are really interested in the details, go check that out for more.
 
-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`:
+## Before You Begin
 
-    gem 'omniauth-twitter'
+You should have already installed OmniAuth into your app; if not, read the [OmniAuth README](https://github.com/intridea/omniauth) to get started.
 
-You can pull them in directly from github e.g.:
+Now sign in into the [Twitter developer area](http://dev.twitter.com) and create an application. Take note of your Consumer Key and Consumer Secret (not the Access Token and Secret) because that is what your web application will use to authenticate against the Twitter API. Make sure to set a callback URL or else you may get authentication errors. (It doesn't matter what it is, just that it is set.)
 
-    gem 'omniauth-twitter', :git => 'https://github.com/arunagw/omniauth-twitter.git'
+## Using This Strategy
 
-Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+First start by adding this gem to your Gemfile:
 
-    Rails.application.config.middleware.use OmniAuth::Builder do
-      provider :twitter, "consumer_key", "consumer_secret" 
-    end
+    gem 'omniauth-twitter'
 
-You will obviously have to put in your key and secret, which you get when you register your app with Twitter (they call them API Key and Secret Key). 
+If you need to use the latest HEAD version, you can do so with:
 
-Twitter also optionally supports specifying a username when authenticating. This is handy when your application supports multiple twitter accounts since you can prompt the user to login to the correct account (and not defaulting to the current login). 
+    gem 'omniauth-twitter', :github => 'arunagw/omniauth-twitter'
 
-To use this, just add a querystring for screen_name. 
+Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
 
-	/auth/twitter?screen_name=scottw
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :twitter, "CONSUMER_KEY", "CONSUMER_SECRET"
+    end
 
-You can also specify ```force_login``` without specifying the screen_name to prompt the user to choose the twitter account they wish to use.
+Replace CONSUMER_KEY and CONSUMER_SECRET with the appropriate values you obtained from dev.twitter.com earlier.
 
-    /auth/twitter?force_login=true
+## Authentication Options
 
-Twitter also optionally supports specifying a x_auth_access_type when authenticating. This is handy when you need to specify special permission in some cases.
+Twitter supports a [few options](https://dev.twitter.com/docs/api/1/get/oauth/authenticate) when authenticating. Usually you would specify these options as query parameters to the Twitter API authentication url (`https://api.twitter.com/oauth/authenticate` by default). With OmniAuth, of course, you use `http://yourapp.com/auth/twitter` instead. Because of this, this OmniAuth provider will pick up the query parameters you pass to the `/auth/twitter` URL and re-use them when making the call to the Twitter API.
 
-To use this, just add a querystring for x_auth_access_type. 
+The options are:
 
-	/auth/twitter?x_auth_access_type=read	
+* **force_login** - This option sends the user to a sign-in screen to enter their Twitter credentials, even if they are already signed in. This is handy when your application supports multiple Twitter accounts and you want to ensure the correct user is signed in. *Example:* `http://yoursite.com/auth/twitter?force_login=true`
 
+* **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`
 
-Now just follow the README at: https://github.com/intridea/omniauth
+* **x_auth_access_type** - This option (described [here](https://dev.twitter.com/docs/api/1/post/oauth/request_token)) lets you request the level of access that your app will have to the Twitter account in question. *Example:* `http://yoursite.com/auth/twitter?x_auth_access_type=read`
+
+* **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`
 
 ## Watch the RailsCast
 
 Ryan Bates has put together an excellent RailsCast on OmniAuth:
 
-[![RailsCast #241](https://www.evernote.com/shard/s35/sh/479f2503-aefa-4542-a7b4-8f84fd22eafc/0571f5a3795a0be3d0b0814312a8d5b7/res/49b5478a-657c-4aff-ae58-dae08b9a46d5/Screen_Shot_2012-07-15_at_12.41.15_PM-20120715-125424.jpg.jpg "RailsCast #241 - Simple OmniAuth (revised)")](http://railscasts.com/episodes/241-simple-omniauth-revised)
-
+[![RailsCast #241](https://www.evernote.com/shard/s35/sh/479f2503-aefa-4542-a7b4-8f84fd22eafc/0571f5a3795a0be3d0b0814312a8d5b7/res/49b5478a-657c-4aff-ae58-dae08b9a46d5/Screen_Shot_2012-07-15_at_12.41.15_PM-20120715-125424.jpg "RailsCast #241 - Simple OmniAuth (revised)")](http://railscasts.com/episodes/241-simple-omniauth-revised)
 
 ## Supported Rubies
 
@@ -71,4 +73,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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-twitter.rb

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

data/lib/omniauth-twitter/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Twitter
-    VERSION = "0.0.13"
+    VERSION = "0.0.14"
   end
 end

data/lib/omniauth/strategies/twitter.rb

@@ -30,7 +30,7 @@ module OmniAuth
       end
 
       def raw_info
-        @raw_info ||= MultiJson.load(access_token.get('/1/account/verify_credentials.json').body)
+        @raw_info ||= MultiJson.load(access_token.get('/1.1/account/verify_credentials.json').body)
       rescue ::Errno::ETIMEDOUT
         raise ::Timeout::Error
       end
@@ -59,7 +59,7 @@ module OmniAuth
         else
           options.client_options.authorize_path = '/oauth/authenticate'
         end
-        
+
         old_request_phase
       end
 

data/omniauth-twitter.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 2.7'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'webmock'  
+  s.add_development_dependency 'webmock'
 end

data/spec/omniauth/strategies/twitter_spec.rb

@@ -5,17 +5,17 @@ describe OmniAuth::Strategies::Twitter do
     OmniAuth::Strategies::Twitter.new({})
   end
 
-  context "client options" do
+  context 'client options' do
     it 'should have correct name' do
-      subject.options.name.should eq("twitter")
+      expect(subject.options.name).to eq('twitter')
     end
 
     it 'should have correct site' do
-      subject.options.client_options.site.should eq('https://api.twitter.com')
+      expect(subject.options.client_options.site).to eq('https://api.twitter.com')
     end
 
     it 'should have correct authorize url' do
-      subject.options.client_options.authorize_path.should eq('/oauth/authenticate')
+      expect(subject.options.client_options.authorize_path).to eq('/oauth/authenticate')
     end
   end
 end

data/spec/spec_helper.rb

@@ -12,5 +12,7 @@ RSpec.configure do |config|
   config.include WebMock::API
   config.include Rack::Test::Methods
   config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-twitter
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2012-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -140,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1976515917874088627
+      hash: -2549198419643775481
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1976515917874088627
+      hash: -2549198419643775481
 requirements: []
 rubyforge_project: omniauth-twitter
 rubygems_version: 1.8.24