ubiquitous_user 0.1.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 J. Pablo Fernández
+
+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,150 @@
+= ubiquitous_user
+
+Many web applications required you to log in before being able to interact with
+them; which poses a real barer of entry for new users. You need users to have
+accounts for many tasks, but you don't need those accounts to be any more than
+an id. No username, no password, no profile.
+
+This library is an implementation of that. You add the Usable mixin to your
+ApplicationController and after that call user to get a user, or user! to get a
+user that exists on the database (it'll be stored if needed).
+
+When a user log ins what you have to do is set the user, which is just doing
+user = userObject.
+
+This library also provides an authorize method, to use as a filter for those
+actions that really require a logged in user.
+
+An important consideration is that users should be mergeable now. If you have
+a user with an account, and that user comes back a month latter, he may start
+to operate your site with the new ghost account and only log in latter on. At
+that moment the ghost account and the real account will be merged, basically by
+calling real_account.merge(ghost_account_id)
+
+== Installation
+
+This gem is provided through Gemcutter so you need to have gem configured to
+pull gems from Gemcutter.
+
+=== Enabling Gemcutter
+
+A properly configured environment would be like this:
+
+  $ gem sources
+  *** CURRENT SOURCES ***
+  
+  http://gemcutter.org
+  http://gems.rubyforge.org/
+  http://gems.github.com
+
+If you don't have http://gemcutter.org in your sources then you need to add. I
+know two ways to do. One is installing Gemcutter and running gem tumble:
+
+  $ sudo gem install gemcutter
+  $ gem tumble
+
+Be careful that gem tumble will remove Gemcutter from your repositories if it's
+already there.
+
+The other way is by hand like this:
+
+  $ gem source -a http://gemcutter.org
+
+I'm not sure if there's any difference. I think there isn't one.
+
+=== Installing ubiquitous_user manually
+
+It's simple a matter of running:
+
+  $ gem install ubiquitous_user
+
+and that's it. Let me know if something breaks.
+
+=== Installing through your Ruby on Rails project
+
+In the +environment.rb+ file of your Ruby on Rails project you'll have some
+commented out lines like this:
+
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+After those you can just add
+
+  config.gem "ubiquitous_user"
+
+and then run
+
+  $ rake gems:install
+
+and you'll get this and all the gems your Rails project need installed.
+Configuring your Rails project like that is something you'll need anyway, so
+this is my recommended way.
+
+== How to use it
+
+In your application_controller.rb be sure to add the mixin to
+ApplicationController, like this:
+
+  class ApplicationController < ActionController::Base
+    include Usable
+    
+    #...
+  end
+
+After that you can use user and user! anywhere, for example:
+
+  @item.recommender = user!
+  
+  <%=h user.name %>
+
+You can use user= and authorize in the controllers, for example:
+
+  class SessionsController < ApplicationController
+    def destroy
+      self.user = nil
+      # ...
+    end
+    
+    def create
+      # ...
+      self.user = user
+    end
+    
+    # ...
+  end
+  
+  class ProfilesController < ApplicationController
+    before_filter :authorize
+    # ...
+  end
+
+== Customize
+
+ubiquitous_user expects your user model to be named User. That's not
+configurable yet. What is configurable is the two methods it calls on user. You
+can do this kind of configuration in config/initializers/ubiquitous_user.rb for
+example:
+
+  Usable::UserModelSave = :save_bypassing_non_essential_validation
+  Usable::UserModelName = :name_or_else
+
+== API Documentation
+
+Up to date api documentation should be automatically generated on
+http://rdoc.info/projects/pupeno/ubiquitous_user
+
+== 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) 2009 J. Pablo Fernández. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ubiquitous_user"
+    gem.summary = "Helpers to get and retrieve users ubiquitously"
+    gem.description = "Create accounts for users right away, even when they are anonymous."
+    gem.email = "pupeno@pupeno.com"
+    gem.homepage = "http://github.com/pupeno/ubiquitous_user"
+    gem.authors = ["J. Pablo Fernández"]
+    gem.add_dependency "actionpack", ">= 2.0.0"
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Ubiquitous User #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ubiquitous_user.rb

@@ -0,0 +1,52 @@
+module UsableHelpers
+  # Helper method to get the current user. It will always return a user but the
+  # user may not be in the database. If options[:create] is true, then the user
+  # will be in the database (although it may be a ghost user).
+  def user(options = {:create => false})
+    # If we already have a user object, return that.
+    return @ubiquitous_user if @ubiquitous_user != nil
+    
+    # Try to find the user in the database if session[:user_id] is defined.
+    @ubiquitous_user = User.find(session[:user_id]) if session[:user_id] != nil
+    return @ubiquitous_user if @ubiquitous_user != nil
+    
+    # Create a new user object.
+    @ubiquitous_user = User.new()
+    if options[:create]
+      # Save the user in the database and set the session user_id for latter.
+      # TODO use UsableConfig::UserModelSave
+      @ubiquitous_user.send(Usable::UserModelSave)
+      session[:user_id] = @ubiquitous_user.id
+    end
+    return @ubiquitous_user
+  end
+  
+  # Helper method to get a user that for sure exists on the database.
+  def user!
+    return user(:create => true)
+  end
+end
+
+ActionController::Base.class_eval do
+  helper UsableHelpers
+end
+
+module Usable
+  include UsableHelpers
+  
+  UserModelSave = :save
+  UserModelName = :name
+  
+  def user=(u)
+    session[:user_id] = u != nil ? u.id : nil
+    session[:user_name] = u != nil ? u.send(UserModelName) : nil
+    user
+  end
+  
+  def authorize
+    unless User.find_by_id(session[:user_id]) and session[:user_name] != nil
+      flash[:notice] = "Please log in."
+      redirect_to new_session_url
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+require 'active_support'
+require 'action_pack'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ubiquitous_user'
+
+class Test::Unit::TestCase
+end

data/test/test_ubiquitous-user.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestUbiquitousUser < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: ubiquitous_user
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "J. Pablo Fern\xC3\xA1ndez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-29 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Create accounts for users right away, even when they are anonymous.
+email: pupeno@pupeno.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ubiquitous_user.rb
+- test/helper.rb
+- test/test_ubiquitous-user.rb
+has_rdoc: true
+homepage: http://github.com/pupeno/ubiquitous_user
+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: Helpers to get and retrieve users ubiquitously
+test_files: 
+- test/helper.rb
+- test/test_ubiquitous-user.rb