hellhound 0.0.1 → 0.0.2

data/README.md

@@ -0,0 +1,86 @@
+hellhound
+=========
+
+Hellhound is a Sinatra application gem to connect to facebook, twitter adn in the future other service. 
+
+It use memcached to store the user if the variable hellhound_cache is enable
+
+How to use it
+-------------
+
+Configure the gem for facebook: 
+
+    configure do      
+      set :fb_api_key,   'your key'
+      set :fb_app_secret, 'your secret'
+      
+      enable :hellhound_cache
+    end
+
+Configure the gem for twitter: 
+
+    configure do
+      include Rack::OAuth::Methods        
+      use Rack::OAuth, :key => 'your key',
+                       :secret => 'your secret',
+                       :site => 'http://twitter.com'
+
+      enable :hellhound_cache
+    end
+
+
+There are two more things that you should do include the helpers methods and implement get_user that is a method that retrieve the user from your data store
+
+helpers do
+  include Sinatra::Hellhound::TwitterHelpers
+  
+  def get_user id
+    # i.e. using DataMapper
+    User.fist :twitter_id => session[:user]
+  end    
+end
+
+
+You will need to override the method get user. This method will search the user in the database in case that the user is not in the cache or the cache was not enabled
+
+    def get_user id
+      User.search(:twitter_id => id)
+    end
+
+
+Hellhound provides some helpers: 
+
+* current_user
+* logged_in?
+* logout!
+
+
+* create_or_retrive_xxx_user(&block)
+** create_or_retrieve_twitter_user(&block)
+** create_or_retrieve_facebook_user(&block)
+** ... (more in the future)
+
+Also provide some routes
+
+    get /oauth_login   # => redirect to /oauth_complete         (twitter)
+    get /auth/facebook # => redirect to /auth/facebook/callback (facebook)
+
+Both of the redirect the user to /oauth_complete
+
+    # The block should return the user in case the cache is on.                
+    get "/oauth_complete" do
+      create_or_retrieve_twitter_user do |user_data|
+        User.first_or_create({
+          :user_name    => user_data["name"],
+          :screen_name  => user_data["screen_name"],
+          :twitter_id   => user_data["id"]
+        })    
+      end
+      redirect "/oauth_login"
+    end
+
+
+
+== Copyright
+
+Copyright (c) 2010 Pedro Del Gallego. See LICENSE for details.

data/VERSION

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

data/examples/facebook-app.rb

@@ -6,8 +6,8 @@ require File.expand_path(File.join(File.dirname(__FILE__), "../lib/hellhound.rb"
 
 configure do
 
-  set :fb_api_key,   '85b58936a196dcf2b57b863e2f3f6a37'
-  set :fb_app_secret, 'd596ecc4fdc2d7753c15b2c920d50100'
+  set :fb_api_key,   'your key'
+  set :fb_app_secret, 'your secret'
 
   enable :hellhound_cache
 end

data/examples/twitter-app.rb

@@ -5,10 +5,12 @@
 
 configure do
   include Rack::OAuth::Methods        
-  use Rack::OAuth, :key => '97DyOmKn7gn1ki0wlyoGA',
-                   :secret => 'bBYIkLEEsdbLFEflWOV2fqaCieiBmYwzV4gXdvwwk',
+
+  use Rack::OAuth, :key => 'your key',
+                   :secret => 'your secret',
                    :site => 'http://twitter.com'
 
+
   enable :hellhound_cache
 end
 

data/hellhound.gemspec

@@ -1,46 +1,44 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{hellhound}
-  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 = ["Pedro Del Gallego"]
-  s.date = %q{2010-05-17}
+  s.date = %q{2010-11-21}
   s.email = %q{pedro.delgallego@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "TAGS",
-     "VERSION",
-     "examples/facebook-app.rb",
-     "examples/twitter-app.rb",
-     "hellhound.gemspec",
-     "lib/hellhound.rb",
-     "spec/hellhound_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "TAGS",
+    "VERSION",
+    "examples/facebook-app.rb",
+    "examples/twitter-app.rb",
+    "hellhound.gemspec",
+    "lib/hellhound.rb",
+    "spec/hellhound_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/pedrodelgallego/hellhound}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{An authentication system based in third oauth party providers.}
   s.test_files = [
+    "examples/facebook-app.rb",
+    "examples/twitter-app.rb",
     "spec/hellhound_spec.rb",
-     "spec/spec_helper.rb",
-     "examples/twitter-app.rb",
-     "examples/facebook-app.rb"
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/hellhound.rb

@@ -21,6 +21,15 @@ module Sinatra
         end
       end
       
+      ##
+      # Returns the current_user, it's an instance of <tt>user</tt> model
+      # 
+      def refresh_current_user        
+        if session[:user]
+          CACHE.set("user-#{session[:user]}", get_user(session[:user])) if options.hellhound_cache
+        end
+      end
+      
       ##
       # Returns true if +current_user+ is logged and active.
       #
@@ -39,7 +48,17 @@ module Sinatra
       end
       
     end
-    
+
+    module GithubHelpers
+      def get_credentials
+        raise Exception "Github support is not yet implemented"
+      end
+
+      def create_or_retrieve_github_user
+        raise Exception "Github support is not yet implemented"
+      end
+    end
+        
     module TwitterHelpers
       ##
       # Retrieve the user from the database or create a new one if it
@@ -69,7 +88,9 @@ module Sinatra
       #      
       def get_credentials
         user_data = JSON.parse(get_access_token.get('/account/verify_credentials.json').body)
-      end      
+      end
+
+      
     end
 
     module FacebookHelpers      
@@ -115,11 +136,18 @@ module Sinatra
         JSON.parse(access_token.get('/me'))
       end
       
-      def client
+      def facebook_client
         OAuth2::Client.new(options.fb_api_key, options.fb_app_secret, :site => 'https://graph.facebook.com')
       end
       
-      def redirect_uri
+      def github_redirect_uri
+        uri = URI.parse(request.url)
+        uri.path = '/auth/github/callback'
+        uri.query = nil
+        uri.to_s
+      end
+      
+      def facebook_redirect_uri
         uri = URI.parse(request.url)
         uri.path = '/auth/facebook/callback'
         uri.query = nil
@@ -133,10 +161,17 @@ module Sinatra
       app.enable  :sessions
       app.disable :hellhound_cache
       app.helpers
+
+      app.get '/auth/github' do
+        redirect github_client.web_server.authorize_url(
+          :redirect_uri => github_redirect_uri,
+          :scope => 'email,offline_access'
+        )                
+      end     
       
       app.get '/auth/facebook' do
-        redirect client.web_server.authorize_url(
-          :redirect_uri => redirect_uri,
+        redirect facebook_client.web_server.authorize_url(
+          :redirect_uri => facebook_redirect_uri,
           :scope => 'email,offline_access'
         )        
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hellhound
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Pedro Del Gallego
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-17 00:00:00 +02:00
+date: 2010-11-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,12 +56,11 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
-- .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - TAGS
 - VERSION
@@ -77,8 +76,8 @@ homepage: http://github.com/pedrodelgallego/hellhound
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -107,7 +106,7 @@ signing_key:
 specification_version: 3
 summary: An authentication system based in third oauth party providers.
 test_files: 
+- examples/facebook-app.rb
+- examples/twitter-app.rb
 - spec/hellhound_spec.rb
 - spec/spec_helper.rb
-- examples/twitter-app.rb
-- examples/facebook-app.rb

data/.gitignore

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

data/README.rdoc

@@ -1,41 +0,0 @@
-= hellhound
-
-Description goes here.
-
-
-== How to use it ==
-
-You will need to override the method get user. This method will search the user in the database in case that the user is not in the cache or the cache was not enabled
-
-=code
-  def get_user id
-    User.search(:twitter_id => id)
-  end
-=
-
-Hellhound provides some helpers: 
-
-* current_user
-* logged_in?
-* logout!
-
-
-* create_or_retrive_xxx_user(&block)
-** create_or_retrive_twitter_user(&block)
-** create_or_retrive_facebook_user(&block)
-** ...
-
-
-== 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 Pedro Del Gallego. See LICENSE for details.