rails_apps_testing 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c3a18df6166437a1557963004ae0c6e3da97fec
-  data.tar.gz: 357132f19d4edf9391de5c6320b11fad349efcdd
+  metadata.gz: a45babcf9e91ec332bf11ecdb5f63e59c635cdf4
+  data.tar.gz: 53d894e50a66f4ef042edab27d2e611432dc5c59
 SHA512:
-  metadata.gz: 6cf291f48860bf10376e0a8f9f36a2162c5e8a9b423a67ce32319c2e5347c43d618bc06fadad4f80525071434c1474e28166f1bcea3bb6c99913ded2432b0f85
-  data.tar.gz: cdfe5507e1b5c86fd9925012b9d5cc3ce34645f62c0c5fb19ca2c764e604741ce7191346fd2281c1e0a9932d27580e6705d1b7b4687fe82d37fae6398d53e79d
+  metadata.gz: 77482fbc848d257bac0d573e23b24b337401406fba4a84178084316805f1daefdc509bfa99fb03f61e1225914dfc4372959d7ee26e0b274f462eb1626259c90e
+  data.tar.gz: 6c301191cb4e2cdda94315187fc4f48d010d4e270cbdc23f616f6a7323bda1866e044a8d148c25dabda4335bc29bdc5908d14e187f4b90bf8b172e41422deb7d

data/CHANGELOG.textile

@@ -1,5 +1,10 @@
 h1. CHANGELOG
 
+h3. 0.3.0 June 6, 2014
+
+* add a suite of tests for OmniAuth
+* add a suite of tests for Devise
+
 h3. 0.2.4 June 4, 2014
 
 * for RSpec 3.0., modify '.rspec' file to include '--require rails_helper'

data/README.textile

@@ -19,6 +19,8 @@ Use this gem to set up a testing framework. The gem modifies a Rails application
 
 This suite of gems is popular for testing Rails applications. Typically, a developer makes several small configuration changes when setting up a test framework with these gems. The configuration changes are easy to make manually, but this gem provides a generator to make the changes, for ease of use with an automated process such as an application template.
 
+The gem also offers options to install test suites for Devise or OmniAuth.
+
 RailsApps Testing is a utility gem to use during development. You can remove it after setting up your test framework. It was originally written for use by the "Rails Composer":http://railsapps.github.io/rails-composer/ tool. Use Rails Composer to build any of the "RailApps example applications":http://railsapps.github.io/ for use as starter apps.
 
 If you like the RailsApps Testing gem, you might be interested in the "RailsLayout gem":https://github.com/RailsApps/rails_layout which generates Rails application layout files for various front-end frameworks such as Bootstrap and Foundation.
@@ -91,10 +93,11 @@ h3. RSpec Configuration
 
 The RailsApps Testing generator will remove the legacy *test/* folder if it exists (it is not needed for RSpec).
 
-The RailsApps Testing generator will run @rails generate rspec:install@ to create two files and a folder:
+The RailsApps Testing generator will run @rails generate rspec:install@ to create three files and a folder:
 
 * *.rspec*
 * *spec/*
+* *spec/spec_helper.rb*
 * *spec/rails_helper.rb*
 
 Then the RailsApps Testing generator will configure RSpec.
@@ -103,6 +106,7 @@ It will modify the file *.rspec* to add:
 
 <pre>
 --format documentation
+--require rails_helper
 </pre>
 
 and will remove:
@@ -111,6 +115,8 @@ and will remove:
 --warnings
 </pre>
 
+Prior to RSpec 3.0, every RSpec test file had to include @require 'spec_helper'@. With RSpec 3.0 and later versions, an additional @require 'rails_helper'@ became necessary. Fortunately, starting with RSpec 3.0, to eliminate clutter and duplication, these requirements can be specified in the project setting *.rspec* file.
+
 It will modify the file *config/application.rb* to suppress creation of stub files that many developers don't use:
 
 <pre>
@@ -178,24 +184,22 @@ RSpec.configure do |config|
 end
 </pre>
 
-h3. Devise Configuration
+h3. Install Devise Tests
 
-If Devise in installed in your application, the generator will add a file *spec/support/devise.rb*:
+If you want to install tests for Devise, you can run:
 
 <pre>
-RSpec.configure do |config|
-  config.include Devise::TestHelpers, :type => :controller
-end
+$ rails generate testing:configure devise
 </pre>
 
-If you want to install the file *spec/support/devise.rb* independently of the other changes, you can run:
+h3. Install OmniAuth Tests
+
+If you want to install tests for OmniAuth, you can run:
 
 <pre>
-$ rails generate testing:configure devise
+$ rails generate testing:configure omniauth
 </pre>
 
-This is helpful for application templates that install RSpec before installing Devise, allowing you to run the generator again to install support for Devise after Devise is installed.
-
 h2. Issues
 
 Any issues? Please create an "issue":http://github.com/RailsApps/rails_apps_testing/issues on GitHub. Reporting issues (and patching!) helps everyone.

data/lib/generators/testing/configure/configure_generator.rb

@@ -24,11 +24,24 @@ module Testing
             gsub_file 'spec/rails_helper.rb', /config.use_transactional_fixtures = true/, "config.use_transactional_fixtures = false"
             copy_file 'database_cleaner.rb', 'spec/support/database_cleaner.rb'
             copy_file 'factory_girl.rb', 'spec/support/factory_girl.rb'
-            if File.exists?('config/initializers/devise.rb')
-              copy_file 'devise.rb', 'spec/support/devise.rb'
-            end
           when 'devise'
-            copy_file 'devise.rb', 'spec/support/devise.rb'
+            copy_file 'spec/devise/support/devise.rb', 'spec/support/devise.rb'
+            copy_file 'spec/devise/support/helpers/session_helpers.rb', 'spec/support/helpers/session_helpers.rb'
+            copy_file 'spec/devise/support/helpers.rb', 'spec/support/helpers.rb'
+            copy_file 'spec/devise/factories/users.rb', 'spec/factories/users.rb'
+            copy_file 'spec/devise/features/users/sign_in_spec.rb', 'spec/features/users/sign_in_spec.rb'
+            copy_file 'spec/devise/features/users/sign_out_spec.rb', 'spec/features/users/sign_out_spec.rb'
+            copy_file 'spec/devise/features/users/user_delete_spec.rb', 'spec/features/users/user_delete_spec.rb'
+            copy_file 'spec/devise/features/users/user_edit_spec.rb', 'spec/features/users/user_edit_spec.rb'
+            copy_file 'spec/features/users/user_index_spec.rb', 'spec/features/users/user_index_spec.rb'
+            copy_file 'spec/features/users/user_show_spec.rb', 'spec/features/users/user_show_spec.rb'
+            copy_file 'spec/devise/features/visitors/sign_up_spec.rb', 'spec/features/visitors/sign_up_spec.rb'
+          when 'omniauth'
+            copy_file 'spec/omniauth/support/helpers/omniauth.rb', 'spec/support/helpers/omniauth.rb'
+            copy_file 'spec/omniauth/support/helpers.rb', 'spec/support/helpers.rb'
+            copy_file 'spec/omniauth/features/users/sign_in_spec.rb', 'spec/features/users/sign_in_spec.rb'
+            copy_file 'spec/omniauth/features/users/sign_out_spec.rb', 'spec/features/users/sign_out_spec.rb'
+            copy_file 'spec/omniauth/controllers/sessions_controller_spec.rb', 'spec/controllers/sessions_controller_spec.rb'
         end
       end
 

data/lib/generators/testing/configure/templates/spec/devise/factories/users.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :user do
+    name "Test User"
+    email "test@example.com"
+    password "please123"
+  end
+end

data/lib/generators/testing/configure/templates/spec/devise/features/users/sign_in_spec.rb

@@ -0,0 +1,49 @@
+# Feature: Sign in
+#   As a user
+#   I want to sign in
+#   So I can visit protected areas of the site
+feature 'Sign in', :devise do
+
+  # Scenario: User cannot sign in if not registered
+  #   Given I do not exist as a user
+  #   When I sign in with valid credentials
+  #   Then I see an invalid credentials message
+  scenario 'user cannot sign in if not registered' do
+    signin('test@example.com', 'please123')
+    expect(page).to have_content 'Invalid email or password.'
+  end
+
+  # Scenario: User can sign in with valid credentials
+  #   Given I exist as a user
+  #   And I am not signed in
+  #   When I sign in with valid credentials
+  #   Then I see a success message
+  scenario 'user can sign in with valid credentials' do
+    user = FactoryGirl.create(:user)
+    signin(user.email, user.password)
+    expect(page).to have_content 'Signed in successfully.'
+  end
+
+  # Scenario: User cannot sign in with wrong email
+  #   Given I exist as a user
+  #   And I am not signed in
+  #   When I sign in with a wrong email
+  #   Then I see an invalid email message
+  scenario 'user cannot sign in with wrong email' do
+    user = FactoryGirl.create(:user)
+    signin('invalid@email.com', user.password)
+    expect(page).to have_content 'Invalid email or password.'
+  end
+
+  # Scenario: User cannot sign in with wrong password
+  #   Given I exist as a user
+  #   And I am not signed in
+  #   When I sign in with a wrong password
+  #   Then I see an invalid password message
+  scenario 'user cannot sign in with wrong password' do
+    user = FactoryGirl.create(:user)
+    signin(user.email, 'invalidpass')
+    expect(page).to have_content 'Invalid email or password.'
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/devise/features/users/sign_out_spec.rb

@@ -0,0 +1,21 @@
+# Feature: Sign out
+#   As a user
+#   I want to sign out
+#   So I can protect my account from unauthorized access
+feature 'Sign out', :devise do
+
+  # Scenario: User signs out successfully
+  #   Given I am signed in
+  #   When I sign out
+  #   Then I see a signed out message
+  scenario 'user signs out successfully' do
+    user = FactoryGirl.create(:user)
+    signin(user.email, user.password)
+    expect(page).to have_content 'Signed in successfully.'
+    click_link 'Sign out'
+    expect(page).to have_content 'Signed out successfully.'
+  end
+
+end
+
+

data/lib/generators/testing/configure/templates/spec/devise/features/users/user_delete_spec.rb

@@ -0,0 +1,32 @@
+include Warden::Test::Helpers
+Warden.test_mode!
+
+# Feature: User delete
+#   As a user
+#   I want to delete my user profile
+#   So I can close my account
+feature 'User delete', :devise, :js do
+
+  after(:each) do
+    Warden.test_reset!
+  end
+
+  # Scenario: User can delete own account
+  #   Given I am signed in
+  #   When I delete my account
+  #   Then I should see an account deleted message
+  scenario 'user can delete own account' do
+    skip 'skip a slow test'
+    user = FactoryGirl.create(:user)
+    login_as(user, :scope => :user)
+    visit edit_user_registration_path(user)
+    click_button 'Cancel my account'
+    page.driver.browser.switch_to.alert.accept
+    expect(page).to have_content 'Bye! Your account was successfully cancelled. We hope to see you again soon.'
+  end
+
+end
+
+
+
+

data/lib/generators/testing/configure/templates/spec/devise/features/users/user_edit_spec.rb

@@ -0,0 +1,41 @@
+include Warden::Test::Helpers
+Warden.test_mode!
+
+# Feature: User edit
+#   As a user
+#   I want to edit my user profile
+#   So I can change my email address
+feature 'User edit', :devise do
+
+  after(:each) do
+    Warden.test_reset!
+  end
+
+  # Scenario: User changes email address
+  #   Given I am signed in
+  #   When I change my email address
+  #   Then I see an account updated message
+  scenario 'user changes email address' do
+    user = FactoryGirl.create(:user)
+    login_as(user, :scope => :user)
+    visit edit_user_registration_path(user)
+    fill_in 'Email', :with => 'newemail@example.com'
+    fill_in 'Current password', :with => user.password
+    click_button 'Update'
+    expect(page).to have_content 'You updated your account successfully.'
+  end
+
+  # Scenario: User cannot edit another user's profile
+  #   Given I am signed in
+  #   When I try to edit another user's profile
+  #   Then I see my own 'edit profile' page
+  scenario "user cannot cannot edit another user's profile", :me do
+    me = FactoryGirl.create(:user)
+    other = FactoryGirl.create(:user, email: 'other@example.com')
+    login_as(me, :scope => :user)
+    visit edit_user_registration_path(other)
+    expect(page).to have_content 'Edit User'
+    expect(page).to have_field('Email', with: me.email)
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/devise/features/users/user_index_spec.rb

@@ -0,0 +1,25 @@
+include Warden::Test::Helpers
+Warden.test_mode!
+
+# Feature: User index page
+#   As a user
+#   I want to see a list of users
+#   So I can see who has registered
+feature 'User index page', :devise do
+
+  after(:each) do
+    Warden.test_reset!
+  end
+
+  # Scenario: User listed on index page
+  #   Given I am signed in
+  #   When I visit the user index page
+  #   Then I see my own email address
+  scenario 'user sees own email address' do
+    user = FactoryGirl.create(:user)
+    login_as(user, scope: :user)
+    visit users_path
+    expect(page).to have_content user.email
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/devise/features/users/user_show_spec.rb

@@ -0,0 +1,39 @@
+include Warden::Test::Helpers
+Warden.test_mode!
+
+# Feature: User profile page
+#   As a user
+#   I want to visit my user profile page
+#   So I can see my personal account data
+feature 'User profile page', :devise do
+
+  after(:each) do
+    Warden.test_reset!
+  end
+
+  # Scenario: User sees own profile
+  #   Given I am signed in
+  #   When I visit the user profile page
+  #   Then I see my own email address
+  scenario 'user sees own profile' do
+    user = FactoryGirl.create(:user)
+    login_as(user, :scope => :user)
+    visit user_path(user)
+    expect(page).to have_content 'User'
+    expect(page).to have_content user.email
+  end
+
+  # Scenario: User cannot see another user's profile
+  #   Given I am signed in
+  #   When I visit another user's profile
+  #   Then I see an 'access denied' message
+  scenario "user cannot see another user's profile" do
+    me = FactoryGirl.create(:user)
+    other = FactoryGirl.create(:user, email: 'other@example.com')
+    login_as(me, :scope => :user)
+    Capybara.current_session.driver.header 'Referer', root_path
+    visit user_path(other)
+    expect(page).to have_content 'Access denied.'
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/devise/features/visitors/sign_up_spec.rb

@@ -0,0 +1,61 @@
+# Feature: Sign up
+#   As a visitor
+#   I want to sign up
+#   So I can visit protected areas of the site
+feature 'Sign Up', :devise do
+
+  # Scenario: Visitor can sign up with valid email address and password
+  #   Given I am not signed in
+  #   When I sign up with a valid email address and password
+  #   Then I see a successful sign up message
+  scenario 'visitor can sign up with valid email address and password' do
+    sign_up_with('test@example.com', 'please123', 'please123')
+    expect(page).to have_content 'Welcome! You have signed up successfully.'
+  end
+
+  # Scenario: Visitor cannot sign up with invalid email address
+  #   Given I am not signed in
+  #   When I sign up with an invalid email address
+  #   Then I see an invalid email message
+  scenario 'visitor cannot sign up with invalid email address' do
+    sign_up_with('bogus', 'please123', 'please123')
+    expect(page).to have_content 'Email is invalid'
+  end
+
+  # Scenario: Visitor cannot sign up without password
+  #   Given I am not signed in
+  #   When I sign up without a password
+  #   Then I see a missing password message
+  scenario 'visitor cannot sign up without password' do
+    sign_up_with('test@example.com', '', '')
+    expect(page).to have_content "Password can't be blank"
+  end
+
+  # Scenario: Visitor cannot sign up with a short password
+  #   Given I am not signed in
+  #   When I sign up with a short password
+  #   Then I see a 'too short password' message
+  scenario 'visitor cannot sign up with a short password' do
+    sign_up_with('test@example.com', 'please', 'please')
+    expect(page).to have_content "Password is too short"
+  end
+
+  # Scenario: Visitor cannot sign up without password confirmation
+  #   Given I am not signed in
+  #   When I sign up without a password confirmation
+  #   Then I see a missing password confirmation message
+  scenario 'visitor cannot sign up without password confirmation' do
+    sign_up_with('test@example.com', 'please123', '')
+    expect(page).to have_content "Password confirmation doesn't match"
+  end
+
+  # Scenario: Visitor cannot sign up with mismatched password and confirmation
+  #   Given I am not signed in
+  #   When I sign up with a mismatched password confirmation
+  #   Then I should see a mismatched password message
+  scenario 'visitor cannot sign up with mismatched password and confirmation' do
+    sign_up_with('test@example.com', 'please123', 'mismatch')
+    expect(page).to have_content "Password confirmation doesn't match"
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/devise/support/helpers.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include Features::SessionHelpers, type: :feature
+end

data/lib/generators/testing/configure/templates/spec/devise/support/helpers/session_helpers.rb

@@ -0,0 +1,18 @@
+module Features
+  module SessionHelpers
+    def sign_up_with(email, password, confirmation)
+      visit new_user_registration_path
+      fill_in 'Email', with: email
+      fill_in 'Password', with: password
+      fill_in 'Password confirmation', :with => confirmation
+      click_button 'Sign up'
+    end
+
+    def signin(email, password)
+      visit new_user_session_path
+      fill_in 'Email', with: email
+      fill_in 'Password', with: password
+      click_button 'Sign in'
+    end
+  end
+end

data/lib/generators/testing/configure/templates/spec/omniauth/controllers/sessions_controller_spec.rb

@@ -0,0 +1,45 @@
+describe SessionsController, :omniauth do
+
+  before do
+    request.env['omniauth.auth'] = auth_mock
+  end
+
+  describe "#create" do
+
+    it "creates a user" do
+      expect {post :create, provider: :twitter}.to change{ User.count }.by(1)
+    end
+
+    it "creates a session" do
+      expect(session[:user_id]).to be_nil
+      post :create, provider: :twitter
+      expect(session[:user_id]).to_not be_nil
+    end
+
+    it "redirects the user to the user profile" do
+      post :create, provider: :twitter
+      expect(response).to redirect_to edit_user_path(1)
+    end
+
+  end
+
+  describe "#destroy" do
+
+    before do
+      post :create, provider: :twitter
+    end
+
+    it "resets the session" do
+      session[:user_id].should_not be_nil
+      delete :destroy
+      expect(session[:user_id]).to be_nil
+    end
+
+    it "redirects to the home page" do
+      delete :destroy
+      expect(response).to redirect_to root_url
+    end
+
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/omniauth/features/users/sign_in_spec.rb

@@ -0,0 +1,31 @@
+# Feature: Sign in
+#   As a user
+#   I want to sign in
+#   So I can visit protected areas of the site
+feature 'Sign in', :omniauth do
+
+  # Scenario: User can sign in with valid account
+  #   Given I have a valid account
+  #   And I am not signed in
+  #   When I sign in
+  #   Then I see a success message
+  scenario "user can sign in with valid account" do
+    signin
+    page.should have_content("test@example.com")
+    page.should have_content("Sign out")
+  end
+
+  # Scenario: User cannot sign in with invalid account
+  #   Given I have no account
+  #   And I am not signed in
+  #   When I sign in
+  #   Then I see an authentication error message
+  scenario 'user cannot sign in with invalid account' do
+    OmniAuth.config.mock_auth[:twitter] = :invalid_credentials
+    visit root_path
+    page.should have_content("Sign in")
+    click_link "Sign in"
+    page.should have_content('Authentication error')
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/omniauth/features/users/sign_out_spec.rb

@@ -0,0 +1,17 @@
+# Feature: Sign out
+#   As a user
+#   I want to sign out
+#   So I can protect my account from unauthorized access
+feature 'Sign out', :omniauth do
+
+  # Scenario: User signs out successfully
+  #   Given I am signed in
+  #   When I sign out
+  #   Then I see a signed out message
+  scenario 'user signs out successfully' do
+    signin
+    click_link 'Sign out'
+    expect(page).to have_content 'Signed out'
+  end
+
+end

data/lib/generators/testing/configure/templates/spec/omniauth/support/helpers.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.include Omniauth::Mock
+  config.include Omniauth::SessionHelpers, type: :feature
+end
+OmniAuth.config.test_mode = true

data/lib/generators/testing/configure/templates/spec/omniauth/support/helpers/omniauth.rb

@@ -0,0 +1,31 @@
+module Omniauth
+
+  module Mock
+    def auth_mock
+      OmniAuth.config.mock_auth[:twitter] = {
+        'provider' => 'twitter',
+        'uid' => '123545',
+        'user_info' => {
+          'name' => 'mockuser',
+          'image' => 'mock_user_thumbnail_url'
+        },
+        'credentials' => {
+          'token' => 'mock_token',
+          'secret' => 'mock_secret'
+        }
+      }
+    end
+  end
+
+  module SessionHelpers
+    def signin
+      visit root_path
+      page.should have_content("Sign in")
+      click_link "Sign in"
+      auth_mock
+      fill_in 'user_email', with: 'test@example.com'
+      click_button "Sign in"
+    end
+  end
+
+end

data/lib/rails_apps_testing/version.rb

@@ -1,3 +1,3 @@
 module RailsAppsTesting
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_apps_testing
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Kehoe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,8 +57,23 @@ files:
 - lib/generators/testing/configure/templates/application.rb
 - lib/generators/testing/configure/templates/capybara.rb
 - lib/generators/testing/configure/templates/database_cleaner.rb
-- lib/generators/testing/configure/templates/devise.rb
 - lib/generators/testing/configure/templates/factory_girl.rb
+- lib/generators/testing/configure/templates/spec/devise/factories/users.rb
+- lib/generators/testing/configure/templates/spec/devise/features/users/sign_in_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/features/users/sign_out_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/features/users/user_delete_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/features/users/user_edit_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/features/users/user_index_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/features/users/user_show_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/features/visitors/sign_up_spec.rb
+- lib/generators/testing/configure/templates/spec/devise/support/devise.rb
+- lib/generators/testing/configure/templates/spec/devise/support/helpers.rb
+- lib/generators/testing/configure/templates/spec/devise/support/helpers/session_helpers.rb
+- lib/generators/testing/configure/templates/spec/omniauth/controllers/sessions_controller_spec.rb
+- lib/generators/testing/configure/templates/spec/omniauth/features/users/sign_in_spec.rb
+- lib/generators/testing/configure/templates/spec/omniauth/features/users/sign_out_spec.rb
+- lib/generators/testing/configure/templates/spec/omniauth/support/helpers.rb
+- lib/generators/testing/configure/templates/spec/omniauth/support/helpers/omniauth.rb
 - lib/rails_apps_testing.rb
 - lib/rails_apps_testing/version.rb
 - rails_apps_testing.gemspec