twitter-login 0.4.2 → 0.4.3

data/README.markdown

@@ -1,7 +1,7 @@
 Drop-in login functionality for your webapp
 ===========================================
 
-Drop this Rack middleware in your web application to enable user logins through Twitter.
+Mount this Rack endpoint in your web application to enable user logins through Twitter.
 
 
 How to use
@@ -12,62 +12,58 @@ the <i>"Yes, use Twitter for login"</i> option. You can put anything as <i>"Call
 URL"</i> since the real callback URL is provided dynamically, anyway. Note down your
 OAuth consumer key and secret.
 
-Next, install this library:
-
-    [sudo] gem install twitter-login
-
 You have to require 'twitter/login' in your app. If you're using Bundler:
 
     ## Gemfile
-    clear_sources
-    source 'http://gemcutter.org'
-    gem 'twitter-login', :require_as => 'twitter/login'
-
-Now configure your app to use the middleware. This might be different across web
-frameworks. For Sinatra this would be:
+    gem 'twitter-login', '~> 0.4.1', :require => 'twitter/login'
 
-    ## Sinatra
-    enable :sessions
-    use Twitter::Login, :consumer_key => 'KEY', :secret => 'SECRET'
-    helpers Twitter::Login::Helpers
+Now mount the Rack endpoint in your application. In **Rails 3** this would be:
 
-In Rails:
-
-    ## Rails
-    # Gemfile (if using Bundler)
-    gem 'twitter-login', '~> 0.2.1', :require => 'twitter/login'
+    ## application.rb:
+    config.twitter_login = Twitter::Login.new \
+      :consumer_key => 'CONSUMER_KEY', :secret => 'SECRET'
+    
+    
+    ## routes.rb
+    twitter = YourApp::Application.config.twitter_login
+    twitter_endpoint = twitter.login_handler(:return_to => '/')
     
-    # environment.rb:
-    # (config.gem only in case you're not using Bundler)
-    config.gem 'twitter-login', :version => '~> 0.2.1', :lib => 'twitter/login'
-    config.middleware.use 'Twitter::Login', :consumer_key => 'KEY', :secret => 'SECRET'
+    mount twitter_endpoint => 'login', :as => :login
     
-    # application_controller.rb
+    
+    ## application_controller.rb
     include Twitter::Login::Helpers
+    
+    def logged_in?
+      !!session[:twitter_user]
+    end
+    helper_method :logged_in?
+    
 
 Fill in the `:consumer_key`, `:secret` placeholders with real values. You're done.
 
+It is less trivial to mount a Rack endpoint in **Rails 2** or Sinatra.
+This library was once Rack *middleware*, and if you prefer to use that, install the 0.3.x
+version and [check out the "middleware-0.3" branch][middleware].
+
 
 What it does
 ------------
 
-This middleware handles GET requests to "/login" resource of your app. Make a login
-link that points to "/login" and you're all set to receive logins from Twitter.
-
-The user will first be redirected to Twitter to approve your application. After that he
-or she is redirected back to "/login" with an OAuth verifier GET parameter. The
-middleware then identifies the authenticating user, saves this info to session and
-redirects to the root of your website.
+The user will first get redirected to Twitter to approve your application. After that he
+or she is redirected back to your app with an OAuth verifier GET parameter. Then, the
+authenticating user is identified, this info is saved to session and the user is sent back
+to the root path of your website.
 
 
 Configuration
 -------------
 
-Available options for `Twitter::Login` middleware are:
+Available options for `Twitter::Login` are:
 
 * `:consumer_key` -- OAuth consumer key *(required)*
 * `:secret` -- OAuth secret *(required)*
-* `:login_path` -- where user goes to login (default: "/login")
+* `:site` -- the API endpoint that is used (default: "http://api.twitter.com")
 * `:return_to` -- where user goes after login (default: "/")
 
 
@@ -79,8 +75,7 @@ The `Twitter::Login::Helpers` module (for Sinatra, Rails) adds these methods to
 * `twitter_user` (Hashie::Mash) -- Info about authenticated user. Check this object to
   know whether there is a currently logged-in user. Access user data like `twitter_user.screen_name`
 * `twitter_logout` -- Erases info about Twitter login from session, effectively logging-out the Twitter user
-* `twitter_client` (Twitter::Base) -- An OAuth consumer client from ["twitter" gem][gem].
-  With it you can query anything on behalf of authenticated user, e.g. `twitter_client.friends_timeline`
+* `twitter_client` (OAuth::AccessToken) -- A consumer token able to query the API, e.g. `twitter_client.get('/1/path')`
 
 [register]: http://twitter.com/apps/new
-[gem]: http://rdoc.info/projects/jnunemaker/twitter
+[middleware]: https://github.com/mislav/twitter-login/tree/middleware-0.3#readme

data/lib/twitter/login.rb

@@ -87,10 +87,6 @@ class Twitter::Login
       url << path
     end
     
-    def xhr?
-      !(env['HTTP_X_REQUESTED_WITH'] !~ /XMLHttpRequest/i)
-    end
-    
     def wants?(mime_type)
       env['HTTP_ACCEPT'].to_s.include? mime_type
     end

data/spec/login_spec.rb

@@ -25,9 +25,10 @@ describe Twitter::Login do
       builder.run main_app
       builder.to_app
     end
-  end
+  end if false
   
   before(:each) do
+    pending "specs are old (since middleware era), need to update those"
     @request = Rack::MockRequest.new(@app)
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: twitter-login
 version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
+  hash: 9
+  prerelease: 
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-19 00:00:00 +01:00
+date: 2011-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,7 +72,7 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
@@ -98,7 +98,7 @@ dependencies:
         version: 1.2.8
   type: :development
   version_requirements: *id005
-description: Rack middleware for Sinatra, Rails, and other web frameworks that provides user login functionality through Twitter.
+description: 
 email: mislav.marohnic@gmail.com
 executables: []
 
@@ -140,9 +140,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Rack middleware to provide login functionality through Twitter
+summary: Rack endpoint to provide login with Twitter functionality
 test_files: []