omniauth-facebook-rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,43 @@
+[![Build Status](https://travis-ci.org/Helabs/omniauth-facebook-rails.png)](https://travis-ci.org/Helabs/omniauth-facebook-rails)
+
+##omniauth-facebook-rails
+This gem speeds up omniauth-facebook setup in Rails apps.
+
+##Getting started
+omniauth-facebook-rails works with Rails 3.2 onwards. You can add it to your Gemfile with:
+
+```ruby
+gem 'omniauth-facebook-rails'
+```
+
+Add the required environment variables:
+
+```
+export FACEBOOK_APP_KEY=123456
+export FACEBOOK_APP_SECRET=abcdef
+```
+
+It is heavily recommended for you to change railsties order in
+`config/application.rb`:
+
+```ruby
+config.railties_order = [OmniauthFacebookRails::Engine, :main_app, :all]
+```
+
+Otherwise, your `User` model won't load the Engine's  `User` model.
+
+##Features/Problems
+* It is in Portuguese.
+* You only are granted access to the person's  email.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+This project is released under the [MIT
+License](http://www.opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,32 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OmniauthFacebookRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+task :default => [:"db:migrate", "app:db:test:clone"] do
+  system 'bundle exec rspec spec'
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+class SessionsController < ApplicationController
+  skip_before_filter :save_return_path
+  def create
+    auth = request.env["omniauth.auth"]
+    user = User.find_or_create_with_omniauth(auth)
+    session[:user_id] = user.id
+    redirect_to redirect_path, :notice => "Bem Vindo! Você agora está logado."
+  end
+
+  def failure
+    redirect_to redirect_path, :alert => 'Não foi possível autenticar, tente novamente.'
+  end
+
+  def destroy
+    session[:user_id] = nil
+    redirect_to root_path, :notice => "Obrigado! Volte em breve."
+  end
+
+  private
+    def redirect_path
+      session[:return_path] || root_path
+    end
+end

data/app/models/user.rb

@@ -0,0 +1,8 @@
+class User < ActiveRecord::Base
+  def self.find_or_create_with_omniauth(auth)
+    user = self.find_or_create_by_provider_and_uid(auth["provider"], auth["uid"])
+    user.assign_attributes({:name => auth["info"]["name"], :email => auth["info"]["email"], :photo_url => auth["info"]["image"], :access_token => auth["credentials"]["token"], :extra => (auth["extra"]["raw_info"] rescue nil)}, :without_protection => true)
+    user.save(validate: false)
+    user
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  match "/auth/:provider/callback" => "sessions#create", as: :auth_callback
+  match "/auth/failure" => "sessions#failure", as: :auth_failure
+  match "/logout" => "sessions#destroy", as: :logout
+end

data/db/migrate/20121204171957_add_facebook_omniauth_fields.rb

@@ -0,0 +1,38 @@
+class AddFacebookOmniauthFields < ActiveRecord::Migration
+  if User.table_exists?
+    def self.up
+      change_table :users do |t|
+        create_user_fields_on(t)
+      end
+      add_email_index
+    end
+
+    def self.down
+      # By default, we don't want to make any assumption about how to roll back a migration when your
+      # model already existed. Please edit below which fields you would like to remove in this migration.
+      raise ActiveRecord::IrreversibleMigration
+    end
+  else
+    def change
+      create_table :users do |t|
+        create_user_fields_on(t)
+        t.timestamps
+      end
+      add_email_index
+    end
+  end
+
+  private
+  def add_email_index
+    add_index :users, :email
+  end
+  def create_user_fields_on(t)
+    t.string   "provider"
+    t.string   "uid"
+    t.string   "name"
+    t.string   "email"
+    t.string   "photo_url"
+    t.string   "access_token"
+    t.string   "extra"
+  end
+end

data/lib/omniauth-facebook-rails.rb

@@ -0,0 +1,8 @@
+require "omniauth-facebook-rails/engine"
+if Rails.env.to_s == "test"
+  require 'factory_girl'
+  require File.expand_path('../../spec/factories', __FILE__)
+end
+
+module OmniauthFacebookRails
+end

data/lib/omniauth-facebook-rails/engine.rb

@@ -0,0 +1,14 @@
+module OmniauthFacebookRails
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+    initializer "omniauth_facebok_rails.add_facebook" do |app|
+      require 'omniauth'
+      require 'omniauth/facebook'
+      app.middleware.use OmniAuth::Builder do
+        provider :facebook, ENV['FACEBOOK_APP_KEY'], ENV['FACEBOOK_APP_SECRET'], :scope => "email"
+      end
+    end
+  end
+end

data/lib/omniauth-facebook-rails/version.rb

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

data/lib/tasks/omniauth-facebook-rails_tasks.rake

@@ -0,0 +1,10 @@
+# desc "Explaining what the task does"
+# task :omniauth-facebook-rails do
+#   # Task goes here
+# end
+namespace :omniauth_facebook do
+  desc "Copies required user migration"
+  task setup: "omniauth_facebook_rails_engine:install:migrations" do
+    puts "Please run rake db:migrate after this."
+  end
+end

data/spec/controllers/sessions_controller_spec.rb

@@ -0,0 +1,83 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe SessionsController do
+  render_views
+  describe "GET create" do
+    def do_action
+      get :create, provider: 'facebook'
+    end
+    before(:each) do
+      @user = FactoryGirl.create(:user, :provider => 'facebook', :uid => '100003045769261')
+      request.env["omniauth.auth"] = {"provider"=>"facebook", "uid"=>"100003045769261", "credentials"=>{"token"=>"AAADvZADZBnlLABAMVZAUX1s7ptC0m9HZCaaIkMw8AMxFBtV3uZCmjflQDKba5PPt3kqZAgVlmZCeA6tXAUaBlLEInggas8lAGIzXzP4azfrsgZDZD"}, "info"=>{"nickname"=>nil, "email"=>"contato@startupdev.com.br", "first_name"=>"Dejurema", "last_name"=>"Jockifort", "name"=>"Dejurema Jockifort", "image"=>"http://graph.facebook.com/100003045769261/picture?type=square", "urls"=>{"Facebook"=>"http://www.facebook.com/profile.php?id=100003045769261", "Website"=>nil}}, "extra"=>{"user_hash"=>{"id"=>"100003045769261", "name"=>"Dejurema Jockifort", "first_name"=>"Dejurema", "last_name"=>"Jockifort", "link"=>"http://www.facebook.com/profile.php?id=100003045769261", "gender"=>"male", "email"=>"contato@startupdev.com.br", "timezone"=>-2, "locale"=>"pt_BR", "updated_time"=>"2011-10-18T15:01:20+0000"}}}
+    end
+    it "should set user id on session" do
+      do_action
+      session[:user_id].should == @user.id
+    end
+    it "should set flash message" do
+      do_action
+      flash[:notice].should == "Bem Vindo! Você agora está logado."
+    end
+    describe "redirect" do
+      context "no return_path" do
+        before do
+          session[:return_path] = nil
+          do_action
+        end
+        it { should redirect_to(root_path) }
+      end
+      context "return_path" do
+        before do
+          session[:return_path] = "/this/path"
+          do_action
+        end
+        it { should redirect_to("/this/path") }
+      end
+    end
+  end
+  describe "GET failure" do
+    def do_action
+      get :failure
+    end
+    it "should set flash message" do
+      do_action
+      flash[:alert].should == 'Não foi possível autenticar, tente novamente.'
+    end
+    describe "redirect" do
+      context "no return_path" do
+        before do
+          session[:return_path] = nil
+          do_action
+        end
+        it { should redirect_to(root_path) }
+      end
+      context "return_path" do
+        before do
+          session[:return_path] = "/this/path"
+          do_action
+        end
+        it { should redirect_to("/this/path") }
+      end
+    end
+
+  end
+  describe "GET destroy" do
+    def do_action
+      get :destroy
+    end
+    it "should nuliffy user_id on sessions" do
+      session[:user_id] = "1"
+      do_action
+      session[:user_id].should be_nil
+    end
+    it "should set flash message" do
+      do_action
+      flash[:notice].should == "Obrigado! Volte em breve."
+    end
+    it "should redirect to root_path" do
+      do_action
+      response.should redirect_to(root_path)
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.