cheapskate 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f4d0d8936e75eacf28e812848025458e408a858
-  data.tar.gz: 5d6a36c1f6e59a973442b599cceefc895d5cd9a0
+  metadata.gz: ef6c244f9a38e352da8495c6bf0536d25e5995bc
+  data.tar.gz: 2244b1698ae888983ede85a9737d6364deb550e5
 SHA512:
-  metadata.gz: 254b473de825e643c2a2ed9b76ac427803c3e907552f8f58790789bf120597a0797156b7093c189b3d860e7c92607f97af19d0b4213a5779764c891d18b4e498
-  data.tar.gz: 548124543f1b39b3a7c72ab6181b30f61c05b3bce9b74261fa1f651e77db72e14567f23fc03eb179b482edb2e1040c6752ddf2340ae93c6657fe9fd1c5db94e0
+  metadata.gz: 435e98b5eaf0b0e832c8da619616af2952f66671d78a8895186db85f6529e7251a265e4fa70c8c662ad20b175bea86044d995fb557da5861b20c3e2a27bfbd71
+  data.tar.gz: e2946684506aa93d6a3e3cd0404204aa9a35ac55c46207e2b3b7f20e3d5a8cf492d8de7fc87be9dddbe8ee95b1526f29a5372dc133ebdf3dde406ff0f315d023

data/README.md

@@ -29,18 +29,21 @@ The gem provides its own Rails engine, which adds the following to your app:
 
 ### Customization
 
-Both the **/logged_in** and **/registered** routes redirect back to `Cheapskate::ROOT_PATH`, which
-defaults to `"/"`.
+Both the **/logged_in** and **/registered** routes redirect back to `Cheapskate::CONFIG['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
+`Cheapskate::Client` module. You can include this module and override any of these methods if you
 want:
 
-- `create_user(params)`
-- `find_user(params)`
+- `create_user(params)` - will create user from `params[:user]` with keys `:name` and `:email` (and
+  password w/ confirmation) by default
+- `find_user(params)` - will look up user by `params[:email]` by default
 - `authenticate_user(user, params)`
 - `user_name(user)`
-- `store_user_in_session(user, session)`
+- `store_user_in_session(user, session)` - will set `session[:user_id] = user.id` by default
+- `alert_notice(controller, message)` - uses `flash[:notice]` by default
+- `alert_error(controller, message)` - uses `flash[:notice]` by default
 
-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.)
+If you implement your own client (by defining a class that includes `Cheapskate::Client`),
+Cheapskate will automatically use your implementation.

data/app/controllers/cheapskate/application_controller.rb

@@ -14,43 +14,43 @@ module Cheapskate
     end
 
     def complete_registration
-      alert_and_redirect("Thank you for registering.", Cheapskate::ROOT_PATH)
+      alert_and_redirect("Thank you for registering.", Cheapskate::CONFIG['ROOT_PATH'])
     end
 
     def login
       user = @client.find_user(params)
       if user.nil?
-        return alert_and_redirect('That user does not exist.', login_path)
+        return alert_and_redirect('That user does not exist.', login_path, :error)
       end
 
       if !@client.authenticate_user(user, params)
-        return alert_and_redirect('You have entered an incorrect password.', login_path)
+        return alert_and_redirect('You have entered an incorrect password.', login_path, :error)
       end
 
-      login = @client.create_single_use_login!(user)
+      login = SingleUseLogin.create!(:user => 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])
+      login = SingleUseLogin.find_by_token(params[:token])
       if login.nil?
-        alert_and_redirect('Unable to verify login. Try again?', login_path)
+        alert_and_redirect('Unable to verify login. Try again?', login_path, :error)
       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)
+      alert_and_redirect("Welcome, #{@client.user_name(user)}!", Cheapskate::CONFIG['ROOT_PATH'])
     end
 
     protected
 
-    def alert_and_redirect(message, path)
+    def alert_and_redirect(message, path, alert_type=:notice)
       uri = URI(path)
       if uri.absolute? && uri.host != request.host
-        notice = @client.create_single_use_notice!(message)
+        notice = SingleUseNotice.create!(:message => message)
         uri.query = add_to_query(uri.query, :notice => notice.token)
       else
-        flash[:notice] = message
+        @client.send(:"alert_#{alert_type}", self, message)
       end
 
       logger.info("CHEAPSKATE - Redirecting...")
@@ -70,13 +70,13 @@ module Cheapskate
     private
 
     def initialize_client
-      @client = Cheapskate::CLIENT_CLASS.new
+      @client = Cheapskate::CONFIG['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!
+        @notification = SingleUseNotice.find_by_token(params.delete(:notice))
+        @client.alert_notice(self, @notification.get_message_and_destroy!)
 
         redirect_to(request.path, params)
       end

data/app/helpers/cheapskate/application_helper.rb

@@ -1,19 +1,13 @@
 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
+      prefix = protocol.to_s.upcase
+
+      {
+        :protocol => Cheapskate::CONFIG["#{prefix}_PROTOCOL"],
+        :host     => Cheapskate::CONFIG["#{prefix}_HOST"],
+        :port     => Cheapskate::CONFIG["#{prefix}_PORT"]
+      }
     end
   end
 end

data/lib/cheapskate.rb

@@ -1,15 +1,17 @@
-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
+  CONFIG = {
+    '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
+    '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      = '/'
+    'ROOT_PATH'      => '/'
+  }
 end
+
+require "cheapskate/client"
+require "cheapskate/client/default"
+require "cheapskate/engine"

data/lib/cheapskate/client.rb

@@ -1,5 +1,9 @@
 module Cheapskate
-  class Client
+  module Client
+    def self.included(client_class)
+      Cheapskate::CONFIG['CLIENT_CLASS'] = client_class
+    end
+
     def create_user(params)
       User.create!(params.require(:user).permit(:name, :email, :password, :password_confirmation))
     end
@@ -20,20 +24,12 @@ module Cheapskate
       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)
+    def alert_notice(controller, message)
+      controller.flash[:notice] = message
     end
 
-    def get_single_use_notice(token)
-      SingleUseNotice.find_by_token(token)
+    def alert_error(controller, message)
+      alert_notice(controller, message)
     end
   end
 end

data/lib/cheapskate/client/default.rb

@@ -0,0 +1,7 @@
+module Cheapskate
+  module Client
+    class Default
+      include Cheapskate::Client
+    end
+  end
+end

data/lib/cheapskate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheapskate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dan Tao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,19 +45,19 @@ 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
+- app/helpers/cheapskate/application_helper.rb
+- app/models/single_use_login.rb
+- app/models/single_use_notice.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/default.rb
 - lib/cheapskate/client.rb
 - lib/cheapskate/engine.rb
-- lib/tasks/cheapskate_tasks.rake
+- lib/cheapskate/version.rb
 - lib/cheapskate.rb
-- LICENSE.txt
+- lib/tasks/cheapskate_tasks.rake
 - Rakefile
 - README.md
 homepage: https://github.com/dtao/cheapskate
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Seamlessly jump to a separate domain for HTTPS login and then back

data/LICENSE.txt

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