sinatra-twitter-oauth 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nick Howard
+
+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/README.rdoc

@@ -0,0 +1,42 @@
+= sinatra-twitter-oauth
+
+A simple sinatra extension for using twitter oauth for login
+
+
+== Examples
+=== classic style
+  require 'sinatra'
+  require 'sinatra-twitter-oauth'
+  
+  set :twitter_oauth_config,  :key => 'foo-key',
+                              :secret   => 'foo-secret',
+                              :callback => 'example.com/foo/auth'
+  get '/' do
+    login_required
+  end
+=== using Sinatra::Base
+
+  require 'sinatra'
+  require 'sinatra-twitter-oauth'
+  class FooApp < Sinatra::Base
+    register Sinatra::TwitterOAuth
+    set :twitter_oauth_config,  :key => 'foo-key',
+                                :secret   => 'foo-secret',
+                                :callback => 'example.com/foo/auth'
+    get '/' do
+      login_required
+    end
+  end
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Nick Howard. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-twitter-oauth"
+    gem.summary = %Q{A Sinatra Extension that simplifies using twitter for login and authentication.}
+    gem.description = %Q{A Sinatra Extension that simplifies using twitter for login and authentication.}
+    gem.email = "ndh@baroquebobcat.com"
+    gem.homepage = "http://github.com/baroquebobcat/sinatra-twitter-oauth"
+    gem.authors = ["Nick Howard"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sinatra-twitter-oauth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/sinatra-twitter-oauth.rb

@@ -0,0 +1,70 @@
+require 'sinatra/base'
+require 'twitter_oauth'
+
+require 'sinatra-twitter-oauth/twitter_oauth_ext'
+require 'sinatra-twitter-oauth/helpers'
+#Sinatra::TwitterOAuth
+#
+# A sinatra extension that abstracts away most of
+# using twitter oauth for login
+#
+#twitter_oauth_config
+#options
+# key -- oauth consumer key
+# secret -- oauth consumer secret
+# callback -- oauth callback url. Must be absolute. e.g. http://example.com/auth
+# login_template -- a single entry hash with the engine as the key e.g. :login_template => {:haml => :login}
+module Sinatra
+  module TwitterOAuth
+  
+    DEFAULT_CONFIG = {
+      :key      => 'changeme',
+      :secret   => 'changeme',
+      :callback => 'changeme',
+      :login_template => {:text=>'<a href="/connect">Login using Twitter</a>'}
+    }
+  
+    def self.registered app
+    
+      app.helpers Helpers
+      app.enable :sessions
+      app.set :twitter_oauth_config, DEFAULT_CONFIG
+        
+      app.get '/login' do
+        redirect '/' if @user
+        
+        login_template = options.twitter_oauth_config[:login_template]
+        
+        engine = login_template.keys.first
+        
+        case engine
+        when :text
+          login_template[:text]
+        else
+          render engine, login_template[engine]
+        end
+      end
+      
+      app.get '/connect' do
+        redirect_to_twitter_auth_url
+      end
+
+      app.get '/auth' do
+        if authenticate!
+          redirect '/'
+        else
+          status 403
+          'Not Authenticated'
+        end
+      end
+      
+      app.get '/logout' do
+        clear_oauth_session
+        redirect '/login'
+      end
+    end
+    
+  end
+  
+  register TwitterOAuth
+end

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

@@ -0,0 +1,78 @@
+module Sinatra::TwitterOAuth
+  module Helpers
+    
+    def login_required
+      setup_client
+      
+      @user = ::TwitterOAuth::User.new(@client, session[:user]) if session[:user]
+      
+      @rate_limit_status = @client.rate_limit_status
+      
+      redirect '/login' unless @user
+    end
+    
+    def setup_client
+      @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
+    
+    def get_request_token
+      setup_client
+      
+      begin
+        @client.authentication_request_token(:oauth_callback=>options.twitter_oauth_config[:callback])
+      rescue StandardError => e
+        halt 500,'check your key & secret'
+      end
+    end
+    
+    def get_access_token
+      setup_client
+      
+      begin
+        @client.authorize(
+            session[:request_token],
+            session[:request_token_secret],
+            :oauth_verifier => params[:oauth_verifier]
+         )
+      rescue OAuth::Unauthorized => e
+        nil
+      end
+    end
+    
+    def redirect_to_twitter_auth_url
+      request_token = get_request_token
+    
+      session[:request_token] = request_token.token
+      session[:request_token_secret]= request_token.secret
+    
+      redirect request_token.authorize_url.gsub('authorize','authenticate')
+    end
+    
+    def authenticate!
+      access_token = get_access_token
+    
+      if @client.authorized?
+        session[:access_token] = access_token.token
+        session[:secret_token] = access_token.secret
+        session[:user] = @client.info
+
+        session[:user]
+      else
+        nil
+      end
+    end
+    
+    def clear_oauth_session
+      session[:user] = nil
+      session[:request_token] = nil
+      session[:request_token_secret] = nil
+      session[:access_token] = nil
+      session[:secret_token] = nil
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+
+#
+# Some additional domain model classes for twitter oauth.
+#
+module TwitterOAuth
+
+  class User
+    attr_accessor :client,:info
+    
+    def initialize client,info
+      self.client = client
+      self.info = info
+    end
+    
+    def lists
+      client.get_lists(screen_name)['lists'].map {|list| List.new client, list}
+    end
+    
+    def list list_name
+      List.new client, client.get_list(screen_name, list_name)
+    end
+    
+    def new_list list_name,options={}
+      List.new client, client.create_list(screen_name, list_name, options)
+    end
+    
+    def destroy_list list_name
+      client.delete_list screen_name, list_name
+    end
+    
+    def method_missing method, *args
+      info[method.to_s]
+    end
+  end
+  
+  
+  class List
+    
+    attr_accessor :client,:info
+    
+    #params:
+    #  client: instance of TwitterOAuth::Client
+    #  info: the result of client.get_list
+    def initialize client,info
+      self.info = info
+      self.client = client
+    end
+    
+    def add_member screen_name
+      client.add_member_to_list user['screen_name'],slug, client.show(screen_name)["id"]
+    end
+    
+    def add_members screen_names
+      screen_names.each {|name| add_member name }
+    end
+    
+    def remove_member screen_name
+      client.remove_member_from_list user['screen_name'],slug, client.show(screen_name)["id"]
+    end
+    
+    def remove_members screen_names
+      screen_names.each {|name| remove_member name }
+    end
+
+    def members
+      client.list_members(user['screen_name'], slug)['users'].map{|user| User.new(client,user)}
+    end
+    
+    def private?
+      mode == 'private'
+    end
+    
+    def method_missing method, *args
+      info[method.to_s]
+    end
+    
+  end
+end
+ 

data/sinatra-twitter-oauth.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-twitter-oauth}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Howard"]
+  s.date = %q{2010-03-11}
+  s.description = %q{A Sinatra Extension that simplifies using twitter for login and authentication.}
+  s.email = %q{ndh@baroquebobcat.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sinatra-twitter-oauth.rb",
+     "lib/sinatra-twitter-oauth/helpers.rb",
+     "lib/sinatra-twitter-oauth/twitter_oauth_ext.rb",
+     "sinatra-twitter-oauth.gemspec",
+     "spec/sinatra-twitter-oauth_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/baroquebobcat/sinatra-twitter-oauth}
+  s.rdoc_options = ["--charset=UTF-8"]
+  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.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/sinatra-twitter-oauth_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/sinatra-twitter-oauth_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+class TestApp < Sinatra::Base
+  register Sinatra::TwitterOAuth
+  
+  get '/' do
+    login_required
+    'hello world'
+  end
+end
+
+describe Sinatra::TwitterOAuth do
+
+  def app
+    TestApp
+  end
+  
+  before do 
+    @client=mock('client',
+        :rate_limit_status=>{
+          "remaining_hits"=>150,
+          "hourly_limit"=>150,
+          "reset_time_in_seconds"=>0,
+          "reset_time"=>"Sat Jan 01 00:00:00 UTC 2000"
+        })
+    TwitterOAuth::Client.stub!(:new).and_return(
+      @client=mock('client',
+      :rate_limit_status=>{"remaining_hits"=>150,"hourly_limit"=>150,"reset_time_in_seconds"=>0,"reset_time"=>"Sat Jan 01 00:00:00 UTC 2000"}))
+    
+    TwitterOAuth::User.stub!(:new).and_return(@user = mock('user'))
+    
+    @authed_session = {'rack.session'=>{:user => {'screen_name'=>'tester'}}}
+  end
+  
+  describe 'protected by login_required' do
+    it 'redirects to /login when unauthenticated' do
+      get '/'
+      last_response.should be_redirect
+      last_response.location.should == '/login'
+    end
+    
+    it 'lets you through if you are authed' do
+      @user.stub!(:lists).and_return [mock('list',:null_object=>true)]
+      get '/',{},@authed_session
+      last_response.location.should be_nil
+      last_response.should be_ok
+    end
+  end
+  
+  describe 'GET /login' do
+    it 'is never redirected' do
+      get '/login'
+      last_response.location.should be_nil
+      last_response.should be_ok
+    end
+  end
+  
+  
+  describe 'GET /connect' do
+    it 'gets a request token' do
+      @client.should_receive(:authentication_request_token).and_return(mock('request token',:authorize_url=>'http://example.com',:token=>'token',:secret=>'secret'))
+      get '/connect'
+    end
+    it "redirects to the request token's auth url" do
+      @client.stub!(:authentication_request_token).and_return(token = mock('request token',:token=>'token',:secret=>'secret'))
+      token.should_receive(:authorize_url).and_return 'http://example.com'
+      get '/connect'
+      last_response.location.should == 'http://example.com'
+    end
+  end
+  
+  describe 'GET /auth' do
+    describe "on auth denied" do
+      it "responds with 'Not Authenticated' and a 403" do
+        @client.stub!(:authorize).and_raise OAuth::Unauthorized.new
+        @client.stub!(:authorized?).and_return false
+        get '/auth'
+        last_response.status.should == 403
+        last_response.body.should == 'Not Authenticated'
+      end
+    end
+    describe 'on auth success' do
+      it "redirects to '/'" do
+        @client.stub!(:authorize).and_return(mock('access token',:null_object => true))
+        @client.stub!(:authorized?).and_return true
+        @client.stub!(:info).and_return(mock(:user))
+        get '/auth'
+        last_response.location.should == '/'
+      end
+    end
+  end
+  
+  describe "GET /logout" do
+    it "redirects to /login" do
+      get '/logout',{},@authed_session
+      last_response.location.should == '/login'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] = 'test'
+require 'rubygems'
+
+require File.expand_path('../lib/sinatra-twitter-oauth', File.dirname(__FILE__))
+
+require 'spec'
+require 'spec/interop/test'
+require 'rack/test'
+
+Test::Unit::TestCase.send :include, Rack::Test::Methods

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-twitter-oauth
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nick Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: A Sinatra Extension that simplifies using twitter for login and authentication.
+email: ndh@baroquebobcat.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sinatra-twitter-oauth.rb
+- lib/sinatra-twitter-oauth/helpers.rb
+- lib/sinatra-twitter-oauth/twitter_oauth_ext.rb
+- sinatra-twitter-oauth.gemspec
+- spec/sinatra-twitter-oauth_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/baroquebobcat/sinatra-twitter-oauth
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Sinatra Extension that simplifies using twitter for login and authentication.
+test_files: 
+- spec/spec_helper.rb
+- spec/sinatra-twitter-oauth_spec.rb