hellhound-twitter 0.0.3

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Pedro Del Gallego. 
+
+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/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'  
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'hellhound-twitter'
+    s.summary     = 'A auth system that relay in twitter oauth'
+    s.email       = 'pedro.delgallego@gmail.com'
+    s.homepage    = 'http://github.com/pedrodelgallego/hellhound-twitter'
+    s.version     = '0.0.3'
+    s.authors     = ["Pedro Del Gallego"]
+    s.files       = FileList['[A-Z]*', '{lib,spec,bin,examples}/**/*']
+
+    s.add_dependency 'rack'
+    s.add_dependency 'rack-oauth'
+    s.add_dependency 'sinatra'
+
+    s.extra_rdoc_files = %w( README.rdoc )     
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/examples/simple-login-twitter.rb

@@ -0,0 +1,42 @@
+%w( rubygems sinatra rack-oauth
+    json  haml dm-core memcached 
+  ).each {|gem| require gem}
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/hellhound-twitter.rb")) 
+
+configure do
+  use Rack::OAuth, :key => '',
+                   :secret => '',
+                   :site => 'http://twitter.com'
+
+  # If you want to use the cache just uncomment the next line
+  # Sinatra::Hellhound::CACHE = Memcached.new 
+  
+end
+
+helpers do
+  include Rack::OAuth::Methods
+  include Sinatra::Hellhound::Helpers
+
+  def get_user twitter_id
+    # The user is not in the cache so do something to get it from there
+    session[:user]
+  end    
+end
+
+get "/" do
+  logged_in? ?  "Hi #{current_user}! " : "Hi stranger"    
+end
+
+get "/oauth_complete" do
+  create_or_retrive_user do |user_data|
+    # Do something smart to create you user and return it to the method
+    user_data["name"]
+  end
+  redirect "/"
+end
+
+get "/logout" do
+  logout!
+  redirect "/"
+end

data/lib/hellhound-twitter.rb

@@ -0,0 +1,82 @@
+require 'sinatra/base'
+require 'rack-oauth'
+
+module Sinatra
+  module Hellhound
+    module Helpers
+      
+      ## 
+      # Returns the user from the database, it can be overwritten to
+      # adapat to the other strategies
+      #
+      def get_user twitter_id
+        raise Exception, "You need to override this method"
+      end
+      
+      ##
+      # Returns the current_user, it's an instance of <tt>user</tt> model
+      # 
+      def current_user
+        if session[:user]
+          Sinatra::Hellhound::CACHE ? Sinatra::Hellhound::CACHE.get("user-#{session[:user]}") : get_user(session[:user])
+        end
+      end
+      
+      ##
+      # Returns true if +current_user+ is logged and active.
+      #
+      def logged_in?
+        !! session[:user]
+      end
+
+      
+      ##
+      # Returns the user that logged out and remove user from the
+      # cache and the session
+      #
+      def logout!
+        user = session[:user]
+        session.clear        
+        user
+      end
+      
+      ##
+      # Retrive the user from the database or create a new one if it
+      # doesn't exists.
+      #
+      # If you want to store the user in memcached them you need to
+      # return the user at the end of the block
+      #
+      # I.e
+      #
+      #  create_or_retrive_user do |user_data|      #    
+      #    user = User.find :twitter_id => user_data["id"].to_s
+      #    User.create :twitter_id => user_data["id"].to_s unless user
+      #    user
+      #  end
+      #
+      def create_or_retrive_user(&block)
+        user_data = get_credentials        
+        session[:user] = user_data["id"].to_s
+        user = yield user_data
+        
+        Sinatra::Hellhound::CACHE.set "user-#{session[:user]}", user if Sinatra::Hellhound::CACHE
+      end
+      
+      ##
+      # Returns a Hash with the user data. 
+      #      
+      def get_credentials
+        user_data = JSON.parse(get_access_token.get('/account/verify_credentials.json').body)
+      end      
+    end 
+    
+    Sinatra::Hellhound::CACHE = nil
+    
+    def self.registered(app)
+      app.enable :sessions
+    end
+  end # Module Hellhound
+
+  register Hellhound  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: hellhound-twitter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Pedro Del Gallego
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: pedro.delgallego@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README
+- Rakefile
+- examples/simple-login-twitter.rb
+- lib/hellhound-twitter.rb
+has_rdoc: true
+homepage: http://github.com/pedrodelgallego/hellhound-twitter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A auth system that relay in twitter oauth
+test_files: 
+- examples/simple-login-twitter.rb