sinatra-twitter-oauth 0.0.1 → 0.0.2

data/README.rdoc

@@ -13,6 +13,7 @@ A simple sinatra extension for using twitter oauth for login
                               :callback => 'example.com/foo/auth'
   get '/' do
     login_required
+    "hello #{user}"
   end
 === using Sinatra::Base
 
@@ -25,6 +26,7 @@ A simple sinatra extension for using twitter oauth for login
                                 :callback => 'example.com/foo/auth'
     get '/' do
       login_required
+      "hello #{user}"
     end
   end
 == Note on Patches/Pull Requests

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/baroquebobcat/sinatra-twitter-oauth"
     gem.authors = ["Nick Howard"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.rdoc_options << "--main" << "README.rdoc"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/sinatra-twitter-oauth.rb

@@ -24,14 +24,14 @@ module Sinatra
       :login_template => {:text=>'<a href="/connect">Login using Twitter</a>'}
     }
   
-    def self.registered app
+    def self.registered app  # :nodoc:
     
       app.helpers Helpers
       app.enable :sessions
       app.set :twitter_oauth_config, DEFAULT_CONFIG
         
       app.get '/login' do
-        redirect '/' if @user
+        redirect '/' if user
         
         login_template = options.twitter_oauth_config[:login_template]
         

data/lib/sinatra-twitter-oauth/helpers.rb

@@ -1,6 +1,14 @@
 module Sinatra::TwitterOAuth
+  #Helpers exposed by the extension.
+  #
   module Helpers
     
+    # The current logged in user
+    def user
+      @user
+    end
+    
+    # Redirects to login unless there is an authenticated user
     def login_required
       setup_client
       
@@ -8,19 +16,20 @@ module Sinatra::TwitterOAuth
       
       @rate_limit_status = @client.rate_limit_status
       
-      redirect '/login' unless @user
+      redirect '/login' unless user
     end
     
-    def setup_client
+    
+    def setup_client # :nodoc:
       @client ||= ::TwitterOAuth::Client.new(
         :consumer_secret => options.twitter_oauth_config[:secret],
         :consumer_key => options.twitter_oauth_config[:key],
         :token  => session[:access_token],
         :secret => session[:secret_token]
       )
-    end
+    end 
     
-    def get_request_token
+    def get_request_token # :nodoc:
       setup_client
       
       begin
@@ -30,7 +39,7 @@ module Sinatra::TwitterOAuth
       end
     end
     
-    def get_access_token
+    def get_access_token # :nodoc:
       setup_client
       
       begin
@@ -44,6 +53,7 @@ module Sinatra::TwitterOAuth
       end
     end
     
+    # gets the request token and redirects to twitter's OAuth endpoint
     def redirect_to_twitter_auth_url
       request_token = get_request_token
     
@@ -53,6 +63,7 @@ module Sinatra::TwitterOAuth
       redirect request_token.authorize_url.gsub('authorize','authenticate')
     end
     
+    # attempts to get the access token(MUST be used after user has been redirected back from twitter)
     def authenticate!
       access_token = get_access_token
     
@@ -67,6 +78,7 @@ module Sinatra::TwitterOAuth
       end
     end
     
+    #removes all the session data defined by the extension
     def clear_oauth_session
       session[:user] = nil
       session[:request_token] = nil

data/sinatra-twitter-oauth.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra-twitter-oauth}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nick Howard"]
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/baroquebobcat/sinatra-twitter-oauth}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rdoc_options = ["--charset=UTF-8", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{A Sinatra Extension that simplifies using twitter for login and authentication.}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra-twitter-oauth
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nick Howard
@@ -51,6 +51,8 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement