socialite 0.0.1.beta

data/lib/socialite/controller_support.rb

@@ -0,0 +1,136 @@
+module Socialite
+  module ControllerSupport
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :current_user, :user_signed_in?, :current_user?, :default_route
+    end
+
+    module InstanceMethods
+
+      # Set default route for redirect
+      #
+      # @param [String] the path for default redirects
+      # @return [String] the default path for redirect
+      # (see #default_route)
+      def default_route=(route)
+        @default_route = route
+      end
+
+      # Get default route for redirect
+      #
+      # @return [String] the default path for redirect
+      # (see #default_route=)
+      def default_route
+        @default_route ||= '/'
+      end
+
+      # Helper for supporting multiple flash messages per type
+      #
+      # @param [Symbol] the type of flash message. Common types are
+      # :success, :notice, :error
+      # @param [String] the message to attach to the flash type
+      # @return [Hash] all associated flash messages for this request
+      def flash_message(type, text)
+        flash[type.to_sym] ||= []
+        flash[type.to_sym] << text
+      end
+
+    protected
+
+      # Filters
+
+      # Conditional check to see ensure a current user exists
+      #
+      # @return [Boolean]
+      # (see #current_user?)
+      def ensure_user
+         current_user? || deny_access('You must be logged in to perform this action.')
+      end
+
+      # Conditional check to see ensure there is no current user
+      #
+      # @return [Boolean]
+      # (see #current_user?)
+      def ensure_no_user
+         !current_user? || redirect_back_or_default
+      end
+
+      # Utils
+
+      # Store the location URL in the session for later use.
+      #
+      # @return [Hash] the modified session object
+      def store_location
+        session[:return_to] = request.fullpath
+      end
+
+      # Stores the URL for the current requested action, then redirects to
+      # the login page.
+      #
+      # @param [String] optional flash message to pass to the user
+      # @note This method sets the redirect path, but does not return false.
+      # Meaning you can perform actions after this method is invoked.
+      def deny_access(message=nil)
+        store_location
+        flash_message :notice, message if message.present?
+        redirect_to login_path
+      end
+
+      # Conditional redirect to handle an empty return_to path. If return_to
+      # is empty, the request is redirected to the default path
+      #
+      # @param [String] path to use as the default redirect location
+      # @return [Hash] the modified session hash
+      def redirect_back_or_default(default=nil)
+        default = self.default_route
+        redirect_to(session[:return_to] || default)
+        session[:return_to] = nil
+      end
+
+      # Fetch the User model associated with the current session.
+      #
+      # @return [User]
+      # (see #current_user=)
+      def current_user
+        @current_user ||= if session[:user_id]
+                            User.find(session[:user_id])
+                          elsif cookies[:remember_token]
+                            User.find_by_remember_token(cookies[:remember_token])
+                          end
+      end
+
+      # Assign the User model associated with the current session.
+      #
+      # @return [User]
+      # (see #current_user)
+      def current_user=(user)
+        user.tap do |user|
+          user.remember_me!
+          session[:user_id]         = user.id
+          cookies[:remember_token]  = user.remember_token
+        end
+      end
+
+      # Accessor method for checking if a user is currently signed in
+      #
+      # @return [Boolean]
+      # (see #current_user)
+      def user_signed_in?
+        !!current_user
+      end
+      alias_method :current_user?, :user_signed_in?
+
+      # Destroy the current user session, effectively logging them out upon
+      # the next request.
+      #
+      # @return [Hash] the modified session object
+      def logout!
+        session[:user_id] = nil
+        session[:return_to] = nil
+        @current_user = nil
+        cookies.delete(:remember_token)
+      end
+    end
+  end
+end

data/lib/socialite/engine.rb

@@ -0,0 +1,32 @@
+require 'haml'
+require 'omniauth/core'
+require 'omniauth/oauth'
+
+module Socialite
+  class Engine < Rails::Engine
+    isolate_namespace Socialite
+
+    initializer 'socialite.load_middleware', :after => :load_config_initializers do
+      if Socialite.service_configs[:twitter]
+        middleware.use OmniAuth::Strategies::Twitter,
+          Socialite.service_configs[:twitter].app_key,
+          Socialite.service_configs[:twitter].app_secret
+      end
+
+      if Socialite.service_configs[:facebook]
+        middleware.use OmniAuth::Strategies::Facebook,
+          Socialite.service_configs[:facebook].app_key,
+          Socialite.service_configs[:facebook].app_secret,
+          Socialite.service_configs[:facebook].options
+      end
+    end
+
+    ActiveSupport.on_load(:action_controller) do
+      include Socialite::ControllerSupport
+    end
+
+    ActiveSupport.on_load(:action_view) do
+      include Socialite::AuthenticationHelper
+    end
+  end
+end

data/lib/socialite/service_config.rb

@@ -0,0 +1,14 @@
+require 'ostruct'
+
+module Socialite
+  class ServiceConfig < OpenStruct
+    # Set credentials and options for a given service, i.e. twitter
+    def initialize(app_key, app_secret, options)
+      super({
+        :app_key => app_key,
+        :app_secret => app_secret,
+        :options => options
+      })
+    end
+  end
+end

data/lib/socialite/version.rb

@@ -0,0 +1,3 @@
+module Socialite
+  VERSION = '0.0.1.beta'
+end

data/lib/socialite.rb

@@ -0,0 +1,37 @@
+require 'haml'
+require 'omniauth/core'
+require 'omniauth/oauth'
+
+module Socialite
+  autoload :BaseIdentity, 'socialite/base_identity'
+  autoload :ServiceConfig, 'socialite/service_config'
+
+  module ApiWrappers
+    autoload :Facebook, 'socialite/api_wrappers/facebook'
+    autoload :Twitter, 'socialite/api_wrappers/twitter'
+  end
+
+  mattr_accessor :service_configs, :root_path, :mount_prefix
+  @@service_configs = {}
+
+  def self.generate_token
+    SecureRandom.base64(15).tr('+/=lIO0', 'pqrsxyz')
+  end
+
+  def self.setup(entity = nil, &block)
+    block.call self if block_given?
+  end
+
+  # config.twitter APP_KEY, APP_SECRET, :scope => ['foo', 'bar']
+  def self.twitter(app_key, app_secret, options = {})
+    @@service_configs[:twitter] = ServiceConfig.new(app_key, app_secret, options)
+  end
+
+  # config.facebook APP_KEY, APP_SECRET, :scope => ['foo', 'bar']
+  def self.facebook(app_key, app_secret, options = {})
+    @@service_configs[:facebook] = ServiceConfig.new(app_key, app_secret, options)
+  end
+end
+
+require 'socialite/controller_support'
+require 'socialite/engine'

data/lib/tasks/cucumber.rake

@@ -0,0 +1,65 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
+  task 'db:test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/tasks/socialite_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :socialite do
+#   # Task goes here
+# end

data/script/cucumber

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+vendored_cucumber_bin = Dir["#{File.dirname(__FILE__)}/../vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+if vendored_cucumber_bin
+  load File.expand_path(vendored_cucumber_bin)
+else
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'cucumber'
+  load Cucumber::BINARY
+end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/socialite.gemspec

@@ -0,0 +1,39 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require 'socialite/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'socialite'
+  gem.version       = Socialite::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ['Justin Smestad']
+  gem.email         = 'justin.smestad@gmail.com'
+  gem.homepage      = 'http://github.com/jsmestad/socialite'
+  gem.summary       = 'Rails engine supporting multiple auth providers per user.'
+  gem.description   = 'Rails engine supporting multiple auth providers per user.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rails',       '~> 3.1.0'
+  gem.add_dependency 'sass-rails',  '~> 3.1.0'
+  gem.add_dependency 'simple_form', '~> 1.5.2'
+  gem.add_dependency 'haml',        '~> 3.1.2'
+  gem.add_dependency 'oa-core',     '~> 0.3.0.rc3'
+  gem.add_dependency 'oa-oauth',    '~> 0.3.0.rc3'
+  gem.add_dependency 'koala',       '~> 1.2.0beta4'
+  gem.add_dependency 'grackle',     '~> 0.1.10'
+
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'rdiscount'
+  gem.add_development_dependency 'rspec-rails', '~> 2.6.1'
+  gem.add_development_dependency 'factory_girl', '~> 2.1.0'
+  gem.add_development_dependency 'shoulda-matchers'
+  gem.add_development_dependency 'cucumber-rails', '~> 1.0.6'
+  gem.add_development_dependency 'database_cleaner', '>= 0.6.7'
+  gem.add_development_dependency 'selenium-webdriver', '>= 2.4.0'
+  gem.add_development_dependency 'launchy', '~> 2.0.5'
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,11 @@
+class HomeController < ApplicationController
+  before_filter :ensure_user, :only => [:show]
+
+  def index
+    render
+  end
+
+  def show
+    render
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/home/index.html.haml

@@ -0,0 +1,12 @@
+%h2 Unrestricted Dummy Homepage
+
+%a{:href => '/restricted'} Go to Restricted Page
+
+#authentication
+- if user_signed_in?
+  = link_to 'Sign out', socialite.logout_path
+- else
+  = link_to 'Sign in', socialite.login_path
+
+#user
+  = link_to 'User Profile', socialite.user_path

data/spec/dummy/app/views/home/show.html.haml

@@ -0,0 +1,6 @@
+%h1 Dummy App Sandbox
+
+%p You are viewing a page that should be restricted to logged in users only.
+
+%section
+  %h3 Login Status: #{user_signed_in? ? 'Logged In' : 'Logged Out'}

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<% flash.keys.each do |type| %>
+  <div class="flash <%= type.to_s %>"><%=h flash[type].join('<br/>') %></div>
+<% end %>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "socialite"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)
+
+###
+# Overiding the default boot.rb
+###
+# require 'rubygems'
+
+# # Set up gems listed in the Gemfile.
+# ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+# require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/database.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  timeout: 500
+
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  timeout: 500

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,30 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,60 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Don't fallback to assets pipeline if a precompiled asset is missed
+  config.assets.compile = false
+
+  # Generate digests for assets URLs
+  config.assets.digest = true
+
+  # Defaults to Rails.root.join("public/assets")
+  # config.assets.manifest = YOUR_PATH
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,42 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+
+  # Allow pass debug_assets=true as a query parameter to load pages with unpackaged assets
+  config.assets.allow_debugging = true
+end