hellhound 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 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/README.rdoc

@@ -0,0 +1,41 @@
+= 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.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hellhound"
+    gem.summary = %Q{An authentication system based in third oauth party providers.}
+    # gem.description = %Q{}
+    gem.email = "pedro.delgallego@gmail.com"
+    gem.homepage = "http://github.com/pedrodelgallego/hellhound"
+    gem.authors = ["Pedro Del Gallego"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0" 
+    # 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
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/TAGS

@@ -0,0 +1,6 @@
+Exception	lib/hellhound.rb	12
+expand_path	examples/facebook-app.rb	/^require File.expand_path(File.join(File.dirname(__/
+expand_path	spec/hellhound_spec.rb	/^require File.expand_path(File.dirname(__FILE__) + /
+key	examples/twitter-app.rb	8
+Rack::OAuth	examples/twitter-app.rb	8
+unshift	spec/spec_helper.rb	/^$LOAD_PATH.unshift(File.dirname(__FILE__))$/

data/VERSION

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

data/examples/facebook-app.rb

@@ -0,0 +1,44 @@
+%w( rubygems sinatra 
+    json memcached 
+  ).each {|gem| require gem}
+
+require File.expand_path(File.join(File.dirname(__FILE__), "../lib/hellhound.rb")) 
+
+configure do
+
+  set :fb_api_key,   '85b58936a196dcf2b57b863e2f3f6a37'
+  set :fb_app_secret, 'd596ecc4fdc2d7753c15b2c920d50100'
+
+  enable :hellhound_cache
+end
+
+helpers do
+  include Sinatra::Hellhound::FacebookHelpers
+  
+  def get_user facebook_id
+    # If 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 '/auth/facebook/callback' do
+  create_or_retrieve_facebook_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
+
+get '/me' do
+  photos = JSON.parse(current_access_token.get('/me/photos'))
+  "#{photos.inspect}"
+end

data/examples/twitter-app.rb

@@ -0,0 +1,39 @@
+%w( rubygems sinatra rack-oauth json
+    memcached hellhound ).each {|gem| require gem}
+
+# require File.expand_path(File.join(File.dirname(__FILE__), "../lib/hellhound.rb"))
+
+configure do
+  include Rack::OAuth::Methods        
+  use Rack::OAuth, :key => '97DyOmKn7gn1ki0wlyoGA',
+                   :secret => 'bBYIkLEEsdbLFEflWOV2fqaCieiBmYwzV4gXdvwwk',
+                   :site => 'http://twitter.com'
+
+  enable :hellhound_cache
+end
+
+helpers do
+  include Sinatra::Hellhound::TwitterHelpers
+  
+  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_retrieve_twitter_user do |user_data|
+    # Do something smart to create you user and return it to the method
+    user_data["name"]
+  end
+  redirect "/oauth_login"
+end
+
+get "/logout" do
+  logout!
+  redirect "/"
+end

data/hellhound.gemspec

@@ -0,0 +1,62 @@
+# 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{hellhound}
+  s.version = "0.0.1"
+
+  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.email = %q{pedro.delgallego@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  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"
+  ]
+  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 = [
+    "spec/hellhound_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/twitter-app.rb",
+     "examples/facebook-app.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/hellhound.rb

@@ -0,0 +1,150 @@
+require 'sinatra/base'
+require 'oauth2'
+
+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 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]
+          options.hellhound_cache ? 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
+      
+    end
+    
+    module TwitterHelpers
+      ##
+      # Retrieve 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_retrieve_twitter_user(&block)
+        user_data = get_credentials        
+        session[:user] = user_data["id"].to_s
+        user = yield user_data
+        
+        CACHE.set "user-#{session[:user]}", user if options.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
+
+    module FacebookHelpers      
+      ##
+      # Returns the current_user, it's an instance of <tt>user</tt> model
+      # 
+      def current_access_token
+        client.web_server.access_token(session[:user_code], :redirect_uri => redirect_uri)        
+      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_retrieve_facebook_user(&block)
+        access_token = client.web_server.access_token(params[:code], :redirect_uri => redirect_uri)        
+        session[:user_code] = params[:code]
+        
+        user_data = JSON.parse(access_token.get('/me'))        
+        session[:user] = user_data["id"].to_s
+        
+        user = yield user_data        
+        
+        CACHE.set "user-#{session[:user]}", user if options.hellhound_cache
+      end
+      
+      ##
+      # Returns a Hash with the user data. 
+      #      
+      def get_credentials        
+        access_token = client.web_server.access_token(params[:code], :redirect_uri => redirect_uri)
+        JSON.parse(access_token.get('/me'))
+      end
+      
+      def client
+        OAuth2::Client.new(options.fb_api_key, options.fb_app_secret, :site => 'https://graph.facebook.com')
+      end
+      
+      def redirect_uri
+        uri = URI.parse(request.url)
+        uri.path = '/auth/facebook/callback'
+        uri.query = nil
+        uri.to_s
+      end
+    end
+         
+    CACHE = Memcached.new
+    
+    def self.registered(app)
+      app.enable  :sessions
+      app.disable :hellhound_cache
+      app.helpers
+      
+      app.get '/auth/facebook' do
+        redirect client.web_server.authorize_url(
+          :redirect_uri => redirect_uri,
+          :scope => 'email,offline_access'
+        )        
+      end
+      
+    end
+    
+  end
+  register Hellhound
+  
+  helpers Hellhound::Helpers
+end

data/spec/hellhound_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Hellhound" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hellhound'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: hellhound
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Pedro Del Gallego
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: pedro.delgallego@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://github.com/pedrodelgallego/hellhound
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An authentication system based in third oauth party providers.
+test_files: 
+- spec/hellhound_spec.rb
+- spec/spec_helper.rb
+- examples/twitter-app.rb
+- examples/facebook-app.rb