cheapskate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f4d0d8936e75eacf28e812848025458e408a858
+  data.tar.gz: 5d6a36c1f6e59a973442b599cceefc895d5cd9a0
+SHA512:
+  metadata.gz: 254b473de825e643c2a2ed9b76ac427803c3e907552f8f58790789bf120597a0797156b7093c189b3d860e7c92607f97af19d0b4213a5779764c891d18b4e498
+  data.tar.gz: 548124543f1b39b3a7c72ab6181b30f61c05b3bce9b74261fa1f651e77db72e14567f23fc03eb179b482edb2e1040c6752ddf2340ae93c6657fe9fd1c5db94e0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Tao
+
+MIT License
+
+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.md

@@ -0,0 +1,46 @@
+# Cheapskate
+
+Seamlessly jump to a separate domain for HTTPS login and then back.
+
+## Note
+
+The below information is a work in progress. Don't use this yet; it isn't ready.
+
+## Usage
+
+OK, here's how this works. First, obviously, you add cheapskate to your Gemfile:
+
+    gem 'cheapskate'
+
+The gem provides its own Rails engine, which adds the following to your app:
+
+### Routes
+
+    POST /login
+    GET  /logged_in
+
+    POST /register
+    GET  /registered
+
+### Models
+
+- `SingleUseLogin`
+- `SingleUseNotice`
+
+### Customization
+
+Both the **/logged_in** and **/registered** routes redirect back to `Cheapskate::ROOT_PATH`, which
+defaults to `"/"`.
+
+Internally much of the logic where the gem hooks into your application is found in the
+`Cheapskate::Client` class. You can inherit from this class and override any of these methods if you
+want:
+
+- `create_user(params)`
+- `find_user(params)`
+- `authenticate_user(user, params)`
+- `user_name(user)`
+- `store_user_in_session(user, session)`
+
+If you implement your own client, then you must set the `Cheapskate::CLIENT_CLASS` constant
+accordingly. (Yeah, I know that's bad. Will think more on this.)

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cheapskate'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/cheapskate/application_controller.rb

@@ -0,0 +1,85 @@
+module Cheapskate
+  class ApplicationController < ActionController::Base
+    # Typically (or so I read) you would make this a controller method and expose it via #helper;
+    # HOWEVER, I want this method to be available both to me (ApplicationController) and the client
+    # app. I'm guessing this is not the right approach. But step 1 is just getting it all to work.
+    include Cheapskate::ApplicationHelper
+
+    before_filter :initialize_client
+    before_filter :check_for_notification
+
+    def register
+      user = @client.create_user(params)
+      redirect_to(registered_url(url_options_for_protocol(:http)))
+    end
+
+    def complete_registration
+      alert_and_redirect("Thank you for registering.", Cheapskate::ROOT_PATH)
+    end
+
+    def login
+      user = @client.find_user(params)
+      if user.nil?
+        return alert_and_redirect('That user does not exist.', login_path)
+      end
+
+      if !@client.authenticate_user(user, params)
+        return alert_and_redirect('You have entered an incorrect password.', login_path)
+      end
+
+      login = @client.create_single_use_login!(user)
+      redirect_to(logged_in_url(url_options_for_protocol(:http).merge(:token => login.token)))
+    end
+
+    def complete_login
+      login = @client.get_single_use_login(params[:token])
+      if login.nil?
+        alert_and_redirect('Unable to verify login. Try again?', login_path)
+      end
+
+      user = login.get_user_and_destroy!
+      @client.store_user_in_session(user, session)
+      alert_and_redirect("Welcome, #{@client.user_name(user)}!", Cheapskate::ROOT_PATH)
+    end
+
+    protected
+
+    def alert_and_redirect(message, path)
+      uri = URI(path)
+      if uri.absolute? && uri.host != request.host
+        notice = @client.create_single_use_notice!(message)
+        uri.query = add_to_query(uri.query, :notice => notice.token)
+      else
+        flash[:notice] = message
+      end
+
+      logger.info("CHEAPSKATE - Redirecting...")
+      logger.info("CHEAPSKATE - FROM: #{request.path}")
+      logger.info("CHEAPSKATE - TO:   #{path}")
+      logger.info("CHEAPSKATE - =>:   #{uri})")
+
+      redirect_to(uri.to_s)
+    end
+
+    def add_to_query(query, parameters)
+      query ||= ''
+      start = query.length > 0 ? '&' : ''
+      query + start + parameters.map { |name, value| "#{URI.escape(name)}=#{URI.escape(value)}" }.join('&')
+    end
+
+    private
+
+    def initialize_client
+      @client = Cheapskate::CLIENT_CLASS.new
+    end
+
+    def check_for_notification
+      if params.include?(:notice)
+        @notification = get_single_use_notice(params.delete(:notice))
+        flash[:notice] = @notification.get_message_and_destroy!
+
+        redirect_to(request.path, params)
+      end
+    end
+  end
+end

data/app/helpers/cheapskate/application_helper.rb

@@ -0,0 +1,19 @@
+module Cheapskate
+  module ApplicationHelper
+    def url_options_for_protocol(protocol)
+      if protocol == :https
+        {
+          :protocol => Cheapskate::HTTPS_PROTOCOL,
+          :host     => Cheapskate::HTTPS_HOST,
+          :port     => Cheapskate::HTTPS_PORT
+        }
+      else
+        {
+          :protocol => Cheapskate::HTTP_PROTOCOL,
+          :host     => Cheapskate::HTTP_HOST,
+          :port     => Cheapskate::HTTP_PORT
+        }
+      end
+    end
+  end
+end

data/app/models/single_use_login.rb

@@ -0,0 +1,19 @@
+require 'randy'
+
+class SingleUseLogin < ActiveRecord::Base
+  belongs_to :user
+
+  validates_presence_of :user_id
+
+  before_create :generate_token
+
+  def generate_token
+    self.token ||= Randy.string(30)
+  end
+
+  def get_user_and_destroy!
+    return self.user
+  ensure
+    self.destroy!
+  end
+end

data/app/models/single_use_notice.rb

@@ -0,0 +1,17 @@
+require 'randy'
+
+class SingleUseNotice < ActiveRecord::Base
+  validates_presence_of :message
+
+  before_create :generate_token
+
+  def generate_token
+    self.token ||= Randy.string(30)
+  end
+
+  def get_message_and_destroy!
+    return self.message
+  ensure
+    self.destroy!
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+Cheapskate::Engine.routes.draw do
+  post 'register'   => 'application#register'
+  get  'registered' => 'application#complete_registration'
+  post 'login'      => 'application#login'
+  get  'logged_in'  => 'application#complete_login'
+end

data/db/migrate/20130808161902_create_single_use_logins.rb

@@ -0,0 +1,10 @@
+class CreateSingleUseLogins < ActiveRecord::Migration
+  def change
+    create_table :single_use_logins do |t|
+      t.integer :user_id
+      t.string  :token
+    end
+
+    add_index :single_use_logins, :token
+  end
+end

data/db/migrate/20130808161920_create_single_use_notices.rb

@@ -0,0 +1,10 @@
+class CreateSingleUseNotices < ActiveRecord::Migration
+  def change
+    create_table :single_use_notices do |t|
+      t.string :message
+      t.string :token
+    end
+
+    add_index :single_use_notices, :token
+  end
+end

data/lib/cheapskate/client.rb

@@ -0,0 +1,39 @@
+module Cheapskate
+  class Client
+    def create_user(params)
+      User.create!(params.require(:user).permit(:name, :email, :password, :password_confirmation))
+    end
+
+    def find_user(params)
+      User.find_by_email(params[:email])
+    end
+
+    def authenticate_user(user, params)
+      user.authenticate(params[:password])
+    end
+
+    def user_name(user)
+      user.name
+    end
+
+    def store_user_in_session(user, session)
+      session[:user_id] = user.id
+    end
+
+    def create_single_use_login!(user)
+      SingleUseLogin.create!(:user => user)
+    end
+
+    def get_single_use_login(token)
+      SingleUseLogin.find_by_token(token)
+    end
+
+    def create_single_use_notice!(message)
+      SingleUseNotice.create!(:message => message)
+    end
+
+    def get_single_use_notice(token)
+      SingleUseNotice.find_by_token(token)
+    end
+  end
+end

data/lib/cheapskate/engine.rb

@@ -0,0 +1,5 @@
+module Cheapskate
+  class Engine < ::Rails::Engine
+    isolate_namespace Cheapskate
+  end
+end

data/lib/cheapskate/version.rb

@@ -0,0 +1,3 @@
+module Cheapskate
+  VERSION = "0.0.1"
+end

data/lib/cheapskate.rb

@@ -0,0 +1,15 @@
+require "cheapskate/client"
+require "cheapskate/engine"
+
+module Cheapskate
+  HTTP_PROTOCOL  = 'http'
+  HTTP_HOST      = Rails.env.development? && 'localhost' || nil
+  HTTP_PORT      = Rails.env.development? && 3000 || nil
+
+  HTTPS_PROTOCOL = Rails.env.development? && 'http' || 'https'
+  HTTPS_HOST     = Rails.env.development? && 'localhost' || nil
+  HTTPS_PORT     = Rails.env.development? && 8000 || nil
+
+  CLIENT_CLASS   = Cheapskate::Client
+  ROOT_PATH      = '/'
+end

data/lib/tasks/cheapskate_tasks.rake

@@ -0,0 +1,8 @@
+namespace :cheapskate do
+  desc 'Check if everything is set up properly for Cheapskate to work'
+  task :check => :environment do
+    puts "Checking Cheapskate..."
+    puts "#{SingleUseLogin.table_name} doesn't exist!" if !SingleUseLogin.table_exists?
+    puts "#{SingleUseNotice.table_name} doesn't exist!" if !SingleUseNotice.table_exists?
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: cheapskate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Tao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: randy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HTTPS login from a separate domain
+email:
+- daniel.tao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/single_use_notice.rb
+- app/models/single_use_login.rb
+- app/helpers/cheapskate/application_helper.rb
+- app/controllers/cheapskate/application_controller.rb
+- config/routes.rb
+- db/migrate/20130808161902_create_single_use_logins.rb
+- db/migrate/20130808161920_create_single_use_notices.rb
+- lib/cheapskate/version.rb
+- lib/cheapskate/client.rb
+- lib/cheapskate/engine.rb
+- lib/tasks/cheapskate_tasks.rake
+- lib/cheapskate.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+homepage: https://github.com/dtao/cheapskate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Seamlessly jump to a separate domain for HTTPS login and then back
+test_files: []