accounts 0.0.1

data/lib/accounts/helpers.rb

@@ -0,0 +1,90 @@
+# Copyright Westside Consulting LLC, Ann Arbor, MI, USA, 2012
+
+module Accounts
+  module Helpers
+    class ::Accounts::AccountsError < Exception
+      attr_accessor :code
+      attr_accessor :message
+
+      def initialize(code, message)
+        @code = code
+        @message = message
+      end
+
+      def return_error_page
+        [ @code, @message ]
+      end
+    end
+
+    def site
+      scheme = request.env['rack.url_scheme']
+      host = request.env['HTTP_HOST'] # includes port number
+      "#{scheme}://#{host}"
+    end
+
+    def send_change_password_link(account)
+      tok = ::Accounts::ActionToken.create({ :account => account, :action => 'reset password' })
+      link = "#{site}/response-token/#{tok.id}"
+      Accounts.deliver_change_password_link[account.email, link]
+    end
+
+    def send_change_email_confirmation(account, new_email)
+      tok = ::Accounts::ActionToken.create({ 
+        :account => account,
+        :action => 'change email',
+        :params => {:new_email => new_email}
+      })
+      link = "#{site}/response-token/#{tok.id}"
+      Accounts.deliver_change_email_confirmation[account.email, new_email, link]
+    end
+
+    def on_email_confirmed(account)
+      account.status << :email_confirmed
+      account.taint! :status  # taint!() defined in model.rb
+      account.save
+      Accounts.deliver_new_account_admin_notification[account.email]
+    end
+
+    def respond_to_token(id)
+      token = ::Accounts::ActionToken.get(id)
+
+      raise ::Accounts::AccountsError.new 404, %Q{Page not found.  Go to <a href="/">home page</a>.} \
+        unless token
+
+      begin
+        on_email_confirmed token.account \
+          unless token.account.status.include? :email_confirmed
+
+        case token.action
+        when 'change email' then
+          token.account.email = token.params[:new_email]
+          token.account.save or return "We are unable to change your e-mail right now.  Try again later."
+          session[:account_id] = token.account.id # this visitor is authenticated
+          redirect to("/logon?email=#{token.params[:new_email]}")
+        when 'reset password' then
+          session[:account_id] = token.account.id # this visitor is authenticated
+          redirect '/change-password'
+        else
+          nil
+        end
+      ensure
+        token.destroy or raise "Failed to destroy token #{token.id}"
+      end
+    end
+
+    def authenticate!(email, password)
+      account = ::Accounts::Account.first(:email => email) \
+        or return false
+      account.confirm_password(password) or return false
+      session[:account_id] = account.id
+    end
+
+    def register_new_account(email)
+      account = ::Accounts::Account.create ({ :email => email })
+      account.saved? or return "We are unable to register you at this time.  Please try again later."
+      tok = ::Accounts::ActionToken.create({ :account => account, :action => 'reset password' })
+      link = "#{site}/response-token/#{tok.id}"
+      Accounts.deliver_registration_confirmation[account.email, link]
+    end
+  end
+end

data/lib/accounts/model.rb

@@ -0,0 +1,126 @@
+# Copyright Westside Consulting LLC, Ann Arbor, MI, USA, 2012
+
+require 'data_mapper'
+require 'dm-types/enum'
+require 'dm-types/flag'
+require 'digest/sha2'
+
+DataMapper.setup(:default, ENV['DATABASE_URL'] || 'postgres:accounts')
+DataMapper::Property::String.length(255)
+DataMapper::Property::Boolean.allow_nil(false)
+DataMapper::Property::Boolean.default(false)
+
+#DataMapper::Model.raise_on_save_failure = true
+
+#=begin
+# Override definition in dm-core / lib / dm-core / resource.rb
+# http://github.com/datamapper/dm-core/blob/master/lib/dm-core/resource.rb
+# Get it to log messages when there is a problem saving.
+module DataMapper
+  module Resource
+
+    #@@logger = Logger.new(STDOUT)
+
+    # override .save
+    # @see http://blog.jayfields.com/2006/12/ruby-alias-method-alternative.html
+    base_save = self.instance_method(:save)
+
+    define_method(:save) do |*a|
+      result = base_save.bind(self).call(*a)
+
+      if !result then
+        STDERR.puts "Cannot save #{self.class.to_s}"
+        STDERR.puts self.pretty_inspect
+        self.errors.each {|e| STDERR.puts e.to_s}
+      end
+      result
+    end
+  end
+end
+#=end
+
+# modified from https://gist.github.com/763374
+module DataMapper
+  module Resource
+    def taint! property
+      self.persistence_state = PersistenceState::Dirty.new(self) \
+        unless self.persistence_state.kind_of?(PersistenceState::Dirty)
+      self.persistence_state.original_attributes[properties[property]] = Object.new
+    end
+  end
+end
+
+# Example:
+# my_resource.array_prop << 123
+# my_resource.taint! :array_prop
+# my_resource.save
+
+module Accounts
+
+  class Account
+    include DataMapper::Resource
+    property :id, Serial
+    property :email, String, :unique => true
+    property :password, String, :required => false # a hash
+    property :status, Flag[:suspended, :email_confirmed]
+    property :last_logon, DateTime, :required => false
+    timestamps :created_at
+    timestamps :updated_at
+
+    def set_password(arg)
+      self.update :password => self.class.hashpasswd(arg)
+    end
+
+    def confirm_password(arg)
+      self.class.hashpasswd(arg) == self.password
+    end
+
+    private
+
+    @@digest = Digest::SHA2.new
+    SALT = 'b593b7bf01cd29d9cc15d11f9d81f586e255fd252fab264129e6046934876c23' # random
+
+    # Can't name this "hash".  Name already taken.
+    def self.hashpasswd(arg)
+      @@digest.hexdigest(SALT + arg)
+    end
+  end
+
+  # An action-token represents permission for the agent to perform an action on behalf of a user.
+  class ActionToken
+    include DataMapper::Resource
+
+    @@digest = Digest::SHA2.new
+
+    property :id, String, :key => true, :default => lambda { |res, tok| @@digest.hexdigest(rand.to_s) }
+    property :action, String, :unique => :account 
+    property :params, Object, :allow_nil => true # a hash of key => value
+    belongs_to :account
+    property :expires, DateTime, :default => Time.new + 24 * 3600 # one day
+
+    # override .save
+    # @see http://blog.jayfields.com/2006/12/ruby-alias-method-alternative.html
+    base_save = self.instance_method(:save)
+
+    define_method(:save) do |*args|
+      # If there is a previous instance, delete it
+      if self.class.count(:action => self.action, :account => self.account)  then
+        self.class.destroy
+      end
+      result = base_save.bind(self).call(*args)
+      #STDERR.puts "#{self.inspect}.save returned #{result}"
+    end
+
+    base_destroy = self.instance_method(:destroy)
+
+    define_method(:destroy) do |*args|
+      # If there is a previous instance, delete it
+      result = base_destroy.bind(self).call(*args)
+      #STDERR.puts "#{self.inspect}.destroy returned #{result}"
+    end
+  end
+
+end
+
+DataMapper.finalize
+DataMapper.auto_upgrade!  # preserve existing database

data/lib/accounts/version.rb

@@ -0,0 +1,5 @@
+module Accounts
+  module Gem
+    VERSION = "0.0.1"
+  end
+end

data/spec/user_model_spec.rb

@@ -0,0 +1,105 @@
+$: << '../lib'
+
+require 'rubygems'
+require 'rspec'
+
+# suppress excessive warnings from DataMapper libraries
+$VERBOSE=nil
+require 'accounts/model'
+$VERBOSE=false
+
+# Make sure we're still seeing warnings about our own code
+FOO=:bar
+FOO=:baz
+
+begin
+  DataMapper.auto_migrate!  # empty database
+  STDERR.puts "called DataMapper.auto_migrate!"
+end
+
+describe Accounts::Account do
+
+  it 'contains e-mails and passwords and flags' do
+    account = Accounts::Account.create :email => "stewie@family.guy"
+    account.should be_saved
+    account.password.should be_nil
+    account.status.should have(0).flags
+    account.last_logon.should be_nil
+    account.created_at.should_not be_nil
+    account.updated_at.should_not be_nil
+  end
+
+  it 'cannot create account with duplicate e-mail' do
+    account = Accounts::Account.create :email => "stewie@family.guy"
+    account.should_not be_saved
+  end
+
+  it 'new user e-mail is initially invalid' do
+    account = Accounts::Account.create :email => "lois@family.guy"
+    #puts account.status.inspect
+    account.status.include?(:email_confirmed).should be_false
+    account.status.include?(:suspended).should be_false
+  end
+
+  it 'responds to .set_password' do
+    account = Accounts::Account.create :email => "brian@family.guy"
+    account.should respond_to :set_password
+    account.set_password('hotforlois').should be_true
+  end
+
+  it 'can confirm password' do
+    account = Accounts::Account.create :email => "peter@family.guy"
+    account.set_password('notsosmart').should be_true
+    account.confirm_password('notsosmart').should be_true
+    account.confirm_password('notsobright').should be_false
+  end
+
+  it 'stores passwords as hashes' do
+    Accounts::Account.all.each do |acct|
+      if !acct.password.nil?
+        acct.password.should be_instance_of String
+        acct.password.length.should be == 64
+        acct.password.should_not match(/[^0-9a-f]/)
+      end
+    end
+  end
+end
+
+describe Accounts::ActionToken do
+  before :all do
+    @meg = Accounts::Account.create :email => 'meg@familyguy.com' 
+    @chris = Accounts::Account.create :email => 'chris@familyguy.com' 
+  end
+
+  it 'can create a token for a user to perform a specific action' do
+    tok = Accounts::ActionToken.create :account => @meg, :action => 'party' 
+    tok.should be_saved
+    tok.id.should be_instance_of String
+    tok.id.length.should be == 64
+    tok.id.should_not match(/[^0-9a-f]/)
+  end
+
+  it 'creating a new TokenAction for an action replaces any previous token' do
+    tas = Accounts::ActionToken.all(:account => @meg, :action => 'party')
+    tas.should_not be_nil
+    tas.should have(1).item
+
+    tok = Accounts::ActionToken.create :account => @meg, :action => 'party' 
+    tok.should be_saved
+    tok.id.should_not be == tas[0].id
+  end
+
+  it 'can return account and action given token' do
+    tok = Accounts::ActionToken.create :account => @chris, :action => 'act stupid' 
+    ta_found = Accounts::ActionToken.get(tok.id)
+    ta_found.account.should be == @chris
+    ta_found.action.should be == 'act stupid'
+  end
+
+  it 'has an expire date' do
+    Accounts::ActionToken.all.each do |tok|
+      tok.expires.should be_kind_of DateTime
+      tok.expires.should > DateTime.new
+    end
+  end
+end

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: accounts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Larry Siden, Westside Consulting LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &83116690 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83116690
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &83116290 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83116290
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &83115900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83115900
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &83115290 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83115290
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: &83048450 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83048450
+- !ruby/object:Gem::Dependency
+  name: mail-store-agent
+  requirement: &83047670 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83047670
+- !ruby/object:Gem::Dependency
+  name: mail-single_file_delivery
+  requirement: &83043620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83043620
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &83042990 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83042990
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &83041620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *83041620
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &83041110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83041110
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &83028320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83028320
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: &83027720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83027720
+- !ruby/object:Gem::Dependency
+  name: dm-types
+  requirement: &83027240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83027240
+- !ruby/object:Gem::Dependency
+  name: dm-timestamps
+  requirement: &83026620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83026620
+- !ruby/object:Gem::Dependency
+  name: dm-postgres-adapter
+  requirement: &83026060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83026060
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: &83025360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83025360
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: &83024820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83024820
+description: ! "\nAccounts::Server defines the following paths for your web-app:\n\n*
+  POST '/logon'\n* POST '/register'\n* POST '/forgot-password'\n* POST '/change-password'\n*
+  POST '/change-email'\n\nYour app must provide the pages and forms that will post
+  to these paths.\n  "
+email:
+- lsiden@westside-consulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.mkd
+- Rakefile
+- accounts.gemspec
+- demo/views/change_email.haml
+- demo/views/change_password.haml
+- demo/views/forgot_password.haml
+- demo/views/logon.haml
+- demo/views/register.haml
+- demo/web_app.rb
+- features/change-email.feature
+- features/change-password.feature
+- features/register.feature
+- features/step_definitions/steps.rb
+- features/step_definitions/web_steps.rb
+- features/support/env.rb
+- features/support/paths.rb
+- features/support/unused.rb
+- lib/accounts.rb
+- lib/accounts/configure.rb
+- lib/accounts/helpers.rb
+- lib/accounts/model.rb
+- lib/accounts/version.rb
+- spec/user_model_spec.rb
+homepage: https://github.com/lsiden/accounts
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: accounts
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ! '*accounts* is a website plug-in that offers than the basic user-account
+  management and authentication features that many sites need.'
+test_files: []