authkick 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7b96602af86fa1c26220bf719218b9fe4637861
+  data.tar.gz: c4fbf675f3b319592a10db3568f4ed1e1717f3a9
+SHA512:
+  metadata.gz: 9a1a0b1811fd76faa4136e68d2bc14b547ed960b4649db850fe12c176b4621af482cc4d448f442e4c0e0604ee92c423e8af9c04353aa24c8d1c7bae72fcc826a
+  data.tar.gz: 8ecdd06d8d4b11686a6c79a6407ab0b4a96b153411e087799b827e3348d4493e01c506f6656ce92addd78e1ad10eeb4856d2fc60b75a5b8632b8a6d1ea75d7d6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in authkick.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Kane
+
+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,119 @@
+# Authkick
+
+Lightweight authentication for OmniAuth
+
+:bangbang: Not ready for production use
+
+## Usage
+
+Authkick provides four methods:
+
+```ruby
+sign_in(user)
+sign_out
+current_user
+signed_in?
+```
+
+By default, users are remembered when returning for convenience.
+
+```ruby
+sign_in(user, remember: 1.year) # default
+sign_in(user, remember: false) # log out when browser is closed
+```
+
+## Installation
+
+First, select an OmniAuth strategy (or a few).
+
+Add it to your Gemfile
+
+```ruby
+gem "authkick"
+gem "omniauth-google-apps"
+```
+
+and create an initializer.
+
+```ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :google_apps
+end
+```
+
+Add `uid` and `provider` fields - both strings - to your `User` model.
+
+Next, create a `SessionsController` to manage the sign in and sign out actions.
+
+```ruby
+# app/controllers/sessions_controller.rb
+class SessionsController < ApplicationController
+  # prevent CSRF warnings
+  skip_before_filter :verify_authenticity_token, only: [:create]
+
+  def create
+    auth = request.env["omniauth.auth"]
+    user = User.where(provider: auth["provider"], uid: auth["uid"])
+            .first_or_create!(name: auth["info"]["name"])
+    sign_in user
+    redirect_to root_path
+  end
+
+  def destroy
+    sign_out
+    redirect_to root_path
+  end
+
+end
+```
+
+And hook up the routes
+
+```ruby
+# config/routes.rb
+post "/auth/:provider/callback" => "sessions#create"
+get "sign_out", :controller => "sessions", action: "destroy"
+```
+
+You now have authentication without the magic.
+
+To require authentication before an action, add:
+
+```ruby
+# app/controllers/application_controller.rb
+def authenticate!
+  redirect_to "/auth/facebook" if !signed_in?
+end
+```
+
+And do
+
+```ruby
+before_action :authenticate!
+```
+
+## Important
+
+Protect your users from [Firesheep](http://en.wikipedia.org/wiki/Firesheep) - use https. In Rails, use:
+
+```ruby
+# config/environments/production.rb
+config.force_ssl = true
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "authkick"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/authkick.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authkick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "authkick"
+  spec.version       = Authkick::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["acekane1@gmail.com"]
+  spec.description   = %q{Lightweight authentication for OmniAuth}
+  spec.summary       = %q{Lightweight authentication for OmniAuth}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/authkick.rb

@@ -0,0 +1,48 @@
+require "authkick/version"
+
+module Authkick
+
+  module ControllerMethods
+
+    def self.included(base)
+      base.helper_method :current_user
+      base.helper_method :signed_in?
+    end
+
+    def current_user
+      @current_user ||= begin
+        user = session[:user_id] ? User.find_by(id: session[:user_id]) : nil
+        if !user and cookies.encrypted[:user_id]
+          user = User.find_by(id: cookies.encrypted[:user_id])
+          if user
+            reset_session
+            session[:user_id] = user.id
+          end
+        end
+        user
+      end
+    end
+
+    def signed_in?
+      !!current_user
+    end
+
+    def sign_in(user, opts = {})
+      remember = opts.has_key?(:remember) ? opts[:remember] : 1.year
+      reset_session
+      session[:user_id] = user.id
+      @current_user = user
+      cookies.encrypted[:user_id] = {value: "#{user.id}", expires: remember.from_now, httponly: true} if remember
+    end
+
+    def sign_out
+      @current_user = nil
+      reset_session
+      cookies.delete(:user_id)
+    end
+
+  end
+
+end
+
+ActionController::Base.send(:include, Authkick::ControllerMethods) if defined?(ActionController::Base)

data/lib/authkick/version.rb

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: authkick
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Lightweight authentication for OmniAuth
+email:
+- acekane1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authkick.gemspec
+- lib/authkick.rb
+- lib/authkick/version.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Lightweight authentication for OmniAuth
+test_files: []