empower 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2782888b01254d986dcbd3a706e08b1994d45cdf
-  data.tar.gz: 2aab9ecb3661ad2c5ff7bdcab61e5229bc0a86c1
+  metadata.gz: 988f2741acc65aa587d283a981fb51a6f3b1d847
+  data.tar.gz: 644900fd7cf1e5428c0738dfe7c87be5cf378b42
 SHA512:
-  metadata.gz: 524c661d0a6349e3cfd9918f353ae381ce9b81077c523f1e9891ea26c5e032cdb49ffefd82df17c3c72e6ba0d9aa8622f894a81434ad374b767dd88872405221
-  data.tar.gz: ea32ccae2f1ba249afe45af175bd8bf57ac708467e280b7c5eb33cd7a83edf84b3332dce744e07517322a7e62cc20d245cb687859c97d143e543bd82685805e9
+  metadata.gz: c6efa48565eac7d21db4fc6b961ddab361754f968b36ff8c935ee06f3a5cfce74ebdc1c0eed13d69a6353a5e568be5e51e59859c36cb0c8d0b7874a200173734
+  data.tar.gz: fdf99f3c3c694a03545889d65488405a5645bf112348970fddf4020b557b9542caf820389716230cabb0409ef29ba79ca4629b92787c0636d2f27f27d5360a3b

data/.gitignore

@@ -1,14 +1,8 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -1,4 +1,14 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in empower.gemspec
+# Declare your gem's dependencies in empower.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
 gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    empower (0.1.0)
+      devise
+      omniauth-facebook
+      rails (~> 4.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.10)
+      actionpack (= 4.1.10)
+      actionview (= 4.1.10)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.10)
+      actionview (= 4.1.10)
+      activesupport (= 4.1.10)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.10)
+      activesupport (= 4.1.10)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.10)
+      activesupport (= 4.1.10)
+      builder (~> 3.1)
+    activerecord (4.1.10)
+      activemodel (= 4.1.10)
+      activesupport (= 4.1.10)
+      arel (~> 5.0.0)
+    activesupport (4.1.10)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    bcrypt (3.1.10)
+    builder (3.2.2)
+    devise (3.4.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      responders
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    erubis (2.7.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.4.1)
+    hike (1.2.3)
+    i18n (0.7.0)
+    json (1.8.2)
+    jwt (1.4.1)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    omniauth (1.2.2)
+      hashie (>= 1.2, < 4)
+      rack (~> 1.0)
+    omniauth-facebook (2.0.1)
+      omniauth-oauth2 (~> 1.2)
+    omniauth-oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      multi_json (~> 1.3)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    orm_adapter (0.5.0)
+    rack (1.5.2)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.1.10)
+      actionmailer (= 4.1.10)
+      actionpack (= 4.1.10)
+      actionview (= 4.1.10)
+      activemodel (= 4.1.10)
+      activerecord (= 4.1.10)
+      activesupport (= 4.1.10)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.10)
+      sprockets-rails (~> 2.0)
+    railties (4.1.10)
+      actionpack (= 4.1.10)
+      activesupport (= 4.1.10)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    responders (1.1.2)
+      railties (>= 3.2, < 4.2)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    warden (1.2.3)
+      rack (>= 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  empower!

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,4 @@
-Copyright (c) 2015 Sean C Davis
-
-MIT License
+Copyright 2015 YOURNAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,30 +1,91 @@
-# Empower
+Empower
+==========
 
-TODO: Write a gem description
+Empower is a pre-configured OmniAuth solution for Ruby on Rails applications.
+In contrast to something flexible, like
+[OmniAuth](https://github.com/intridea/omniauth), Empower aims to create the
+solution simply, quickly, and effectively.
 
-## Installation
+To make this happen, you need to understand what's required from you prior to
+using this gem. See below.
+
+> **Note: At this time, there are no configuration options, and Empower only
+> supports Facebook authentication.** This will change soon.
+
+Installation
+----------
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'empower'
+```text
+gem 'cambium'
 ```
 
 And then execute:
 
-    $ bundle
+```text
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install empower
+```text
+$ gem install cambium
+```
+
+Requirements
+----------
+
+There are two major prerequisites to using Empower:
+
+* Using/installing [Devise](https://github.com/plataformatec/devise)
+* Creating a `User` model
+
+Referencing [this section in the
+README](https://github.com/plataformatec/devise#getting-started), this means
+you should run the following commands:
+
+```text
+$ bundle exec rails g devise:install
+$ bundle exec rails g devise User
+```
+
+Usage
+----------
 
-## Usage
+Once Devise is setup and Empower is installed, you can run its generator:
 
-TODO: Write usage instructions here
+```text
+$ bundle exec rails g empower:install
+```
+
+Before you begin, replace the `APP_ID` and `APP_SECRET` in
+`config/initializers/devise.rb` with your Facebook's keys.
+
+> *Note: I suggest NOT tracking these keys with Git and hiding them someone
+> like an environment variable or a private settings file.*
+
+Restart your server and you're ready to go.
+
+Helpers
+----------
+
+There is one helper, and that is a Facebook sign in button.
+
+```erb
+<%= facebook_login_button %>
+```
+
+Otherwise, if you want to handle your own links, they would look like this:
+
+```erb
+<%= link_to 'Login', user_omniauth_authorize_path(:facebook) %>
+```
 
-## Contributing
+Contributing
+----------
 
-1. Fork it ( https://github.com/[my-github-username]/empower/fork )
+1. Fork it ( https://github.com/[my-github-username]/cambium/fork )
 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`)

data/Rakefile

@@ -1,2 +1,17 @@
-require "bundler/gem_tasks"
+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    = 'Empower'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/empower/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/empower/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/empower/application_controller.rb

@@ -0,0 +1,4 @@
+module Empower
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/empower/omniauth_callbacks_controller.rb

@@ -0,0 +1,29 @@
+require_dependency "empower/application_controller"
+
+module Empower
+  class OmniauthCallbacksController < ApplicationController
+
+    def facebook
+      @user = User.from_omniauth(request.env["omniauth.auth"])
+
+      if @user.persisted?
+        if request.env['omniauth.origin'].split('/').last == 'login'
+          sign_in @user #this will throw if @user is not activated
+          redirect_to main_app.root_path
+        else
+          sign_in_and_redirect @user
+        end
+      else
+        session["devise.facebook_data"] = request.env["omniauth.auth"]
+        redirect_to main_app.root_path
+      end
+    end
+
+    def failure
+      redirect_to(
+        (session[:redirect] || main_app.root_path),
+        :alert => "Could not authenticate your request."
+      )
+    end
+  end
+end

data/app/helpers/empower/application_helper.rb

@@ -0,0 +1,4 @@
+module Empower
+  module ApplicationHelper
+  end
+end

data/app/helpers/empower/omniauth_helper.rb

@@ -0,0 +1,13 @@
+module Empower
+  module OmniauthHelper
+
+    def facebook_login_button(text = 'Sign in with Facebook')
+      link_to(
+        text,
+        main_app.user_omniauth_authorize_path(:facebook),
+        :class => 'button facebook'
+      )
+    end
+
+  end
+end

data/app/views/layouts/empower/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Empower</title>
+  <%= stylesheet_link_tag    "empower/application", media: "all" %>
+  <%= javascript_include_tag "empower/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/empower/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Empower::Engine.routes.draw do
+end

data/empower.gemspec

@@ -1,23 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'empower/version'
+$:.push File.expand_path("../lib", __FILE__)
 
+# Maintain your gem's version:
+require "empower/version"
+
+# Describe your gem and declare its dependencies:
 Gem::Specification.new do |spec|
-  spec.name          = "empower"
-  spec.version       = Empower::VERSION
-  spec.authors       = ["Sean C Davis"]
-  spec.email         = ["scdavis41@gmail.com"]
-  spec.summary       = %q{}
-  spec.description   = %q{}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.name        = "empower"
+  spec.version     = Empower::VERSION
+  spec.authors     = ["Sean C Davis"]
+  spec.email       = ["scdavis41@gmail.com"]
+  spec.homepage    = "https://github.com/seancdavis/empower"
+  spec.summary     = ""
+  spec.description = ""
+  spec.license     = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   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.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rails", "~> 4.1.0"
+  spec.add_dependency "devise"
+  spec.add_dependency 'omniauth-facebook'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
 end

data/lib/empower.rb

@@ -1,5 +1,5 @@
-require "empower/version"
+require 'empower/engine'
+require 'empower/omniauth'
 
 module Empower
-  # Your code goes here...
 end

data/lib/empower/engine.rb

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

data/lib/empower/omniauth.rb

@@ -0,0 +1,52 @@
+module Empower
+  module OmniAuth
+    extend ActiveSupport::Concern
+
+    included do
+      devise :omniauthable, :omniauth_providers => [:facebook]
+    end
+
+    module ClassMethods
+      def from_omniauth(auth)
+        user = User.find_by_email(auth.info.email)
+        if user.nil?
+          user = User.create!(
+            :email => auth.info.email,
+            :password => Devise.friendly_token[0,20],
+          )
+          attrs = {}
+          if user.respond_to?(:name)
+            attrs[:name] = auth.info.name
+          end
+          if user.respond_to?(:image)
+            attrs[:image] = auth.info.image
+          end
+          if attrs.keys.size > 0
+            user.update_columns(attrs)
+          end
+        else
+          attrs = {}
+          if user.respond_to?(:name)
+            attrs[:name] = auth.info.name
+          end
+          if user.respond_to?(:image)
+            attrs[:image] = auth.info.image
+          end
+          if attrs.keys.size > 0
+            user.update_columns(attrs)
+          end
+        end
+        user
+      end
+
+      def new_with_session(params, session)
+        super.tap do |user|
+          if data = session["devise.facebook_data"] &&
+            session["devise.facebook_data"]["extra"]["raw_info"]
+              user.email = data["email"] if user.email.blank?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/empower/version.rb

@@ -1,3 +1,3 @@
 module Empower
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/generators/empower/install_generator.rb

@@ -0,0 +1,74 @@
+require 'rake'
+require 'rails/generators'
+
+module Empower
+  class InstallGenerator < Rails::Generators::Base
+    desc "Add OmniAuth config to Devise"
+
+    source_root File.expand_path('../../templates', __FILE__)
+
+    def verify_prereqs
+      perform_checks
+    end
+
+    def add_devise_config
+      insert_into_file(
+        'config/initializers/devise.rb',
+        "\n  config.omniauth :facebook, 'APP_ID', 'APP_SECRET'",
+        :after => 'Devise.setup do |config|'
+      )
+    end
+
+    def add_model_concern
+      insert_into_file(
+        'app/models/user.rb',
+        "\n\n  include Empower::OmniAuth",
+        :after => 'ActiveRecord::Base'
+      )
+    end
+
+    def add_gems
+      insert_into_file(
+        'Gemfile',
+        "\ngem 'omniauth-facebook'",
+        :after => /^source(.*)\n/
+      )
+    end
+
+    def add_routes
+      insert_into_file(
+        'config/routes.rb',
+        ', :controllers => { :omniauth_callbacks => "empower/omniauth_callbacks" }',
+        :after => 'devise_for :users'
+      )
+    end
+
+    def add_helper
+      insert_into_file(
+        'app/controllers/application_controller.rb',
+        "  helper Empower::OmniauthHelper\n",
+        :after => /class\ ApplicationController(.*)\n/
+      )
+    end
+
+    private
+
+      def perform_checks
+        # Devise config file
+        unless File.exists?("#{Rails.root}/config/initializers/devise.rb")
+          msg = "You need to run:\n    bundle exec rails g devise:install"
+          msg += "\nbefore running this generator."
+          raise_error(msg)
+        end
+        # User model
+        unless File.exists?("#{Rails.root}/app/models/user.rb")
+          raise_error('You must have a user model to use Empower')
+        end
+      end
+
+      def raise_error(msg)
+        raise msg
+      end
+
+  end
+end

data/lib/tasks/empower_tasks.rake

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

metadata

@@ -1,59 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: empower
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Sean C Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
+        version: 4.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: devise
+  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: rake
+  name: omniauth-facebook
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.6'
 description: ''
 email:
 - scdavis41@gmail.com
-executables: []
+executables:
+- rails
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE.txt
+- Gemfile.lock
+- LICENSE.md
 - README.md
 - Rakefile
+- app/assets/images/empower/.keep
+- app/assets/javascripts/empower/application.js
+- app/assets/stylesheets/empower/application.css
+- app/controllers/empower/application_controller.rb
+- app/controllers/empower/omniauth_callbacks_controller.rb
+- app/helpers/empower/application_helper.rb
+- app/helpers/empower/omniauth_helper.rb
+- app/views/layouts/empower/application.html.erb
+- bin/rails
+- config/routes.rb
 - empower.gemspec
 - lib/empower.rb
+- lib/empower/engine.rb
+- lib/empower/omniauth.rb
 - lib/empower/version.rb
-homepage: ''
+- lib/generators/empower/install_generator.rb
+- lib/tasks/empower_tasks.rake
+homepage: https://github.com/seancdavis/empower
 licenses:
 - MIT
 metadata: {}