openstax_accounts 7.2.0 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee92a3b64d5e3e96b74bb4991cc34bd70ffafba
-  data.tar.gz: b8799ffbc096a017d7f2d084de72fef2e25bd3c7
+  metadata.gz: f6c2574a839a5d9ac9bca06bd2d2f4ec74c684b6
+  data.tar.gz: 352c193b6685610b0025a67253ffc2313f84b9ca
 SHA512:
-  metadata.gz: 842e2e8e5fa4200b2baf160a183409cdaace616495bfe614ae5da8b8de15097ca9e219e66881a404dc321114b4297aa9f0ea3f3dfed34fde2046b3a67039ab88
-  data.tar.gz: 69763b3c8b3d2d40a2a49e0f1986807c2e8b54c7784605848a45c9058cc582651c1ecdf7d6bfdaff33a0afa354de4a2cf01a39f61339e862bfa0d8a61ffdf95c
+  metadata.gz: 4d27f3a0211633e06103c3e2c033c43f6e0a421def89a601b7405e4ecc58610b4959333fc2e1da6aaecccd886416e72dfe63882ea6ffd2a9e38b5d0e55ad0b84
+  data.tar.gz: 8847dcc227f640e2d76009919e16ed9aab8d0687083598be9f0df1979b5eeb3315524ba9d6f2df540218108d6027fb1b8e51a799182b19f33e03c2851c19dd50

data/Rakefile

@@ -11,12 +11,12 @@ load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+begin
+  require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:spec => 'app:db:test:prepare') do |t|
-  t.libs << 'spec'
-  t.pattern = 'spec/**/*_spec.rb'
-  t.verbose = false
-end
+  RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
 
-task :default => :spec
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/app/controllers/openstax/accounts/sessions_controller.rb

@@ -10,7 +10,10 @@ module OpenStax
             store_url url: params[:return_to], key: :accounts_return_to, strategies: [:session]
           end
           store_fallback key: :accounts_return_to, strategies: [:session]
-          redirect_to openstax_login_path
+
+          forwardable_params =
+            params.slice(*configuration.forwardable_login_param_keys.map(&:to_s))
+          redirect_to openstax_login_path(forwardable_params)
         end
       end
 

data/app/models/openstax/accounts/account.rb

@@ -20,15 +20,17 @@ module OpenStax::Accounts
              inverse_of: :user
     has_many :groups_as_member, through: :group_members, source: :group
 
-    enum faculty_status: [:no_faculty_info, :pending_faculty, :confirmed_faculty, :rejected_faculty]
-    after_initialize { self.faculty_status ||= :no_faculty_info }
+    enum faculty_status: [:no_faculty_info, :pending_faculty,
+                          :confirmed_faculty, :rejected_faculty]
+
+    after_initialize :set_default_faculty_status
+
     validates :faculty_status, presence: true
 
-    validates :openstax_uid, presence: true, uniqueness: true
-    validates :username, presence: true, uniqueness: true,
-                         unless: :syncing_or_stubbing
+    validates :openstax_uid, uniqueness: { allow_nil: true }
+    validates :username, uniqueness: { allow_nil: true }
 
-    before_update :update_openstax_accounts, unless: :syncing_or_stubbing
+    before_update :update_openstax_accounts, if: :should_send_updates_to_accounts?
 
     def name
       (first_name || last_name) ? [first_name, last_name].compact.join(" ") : username
@@ -46,12 +48,24 @@ module OpenStax::Accounts
       !access_token.nil?
     end
 
+    def valid_openstax_uid?
+      !openstax_uid.nil? && openstax_uid > 0
+    end
+
     protected
 
-    def syncing_or_stubbing
+    def set_default_faculty_status
+      self.faculty_status ||= :no_faculty_info
+    end
+
+    def syncing_or_stubbing?
       syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 
+    def should_send_updates_to_accounts?
+      !syncing_or_stubbing? && valid_openstax_uid?
+    end
+
     def update_openstax_accounts
       OpenStax::Accounts::Api.update_account(self)
     end

data/app/models/openstax/accounts/group.rb

@@ -27,12 +27,12 @@ module OpenStax::Accounts
     has_many :member_groups, through: :member_group_nestings
 
     validates :openstax_uid, uniqueness: true, presence: true
-    validates_presence_of :requestor, unless: :syncing_or_stubbing
-    validates_uniqueness_of :name, allow_nil: true, unless: :syncing_or_stubbing
+    validates_presence_of :requestor, unless: :syncing_or_stubbing?
+    validates_uniqueness_of :name, allow_nil: true, unless: :syncing_or_stubbing?
 
-    before_validation :create_openstax_accounts_group, on: :create, unless: :syncing_or_stubbing
-    before_update :update_openstax_accounts_group, unless: :syncing_or_stubbing
-    before_destroy :destroy_openstax_accounts_group, unless: :syncing_or_stubbing
+    before_validation :create_openstax_accounts_group, on: :create, unless: :syncing_or_stubbing?
+    before_update :update_openstax_accounts_group, unless: :syncing_or_stubbing?
+    before_destroy :destroy_openstax_accounts_group, unless: :syncing_or_stubbing?
 
     scope :visible_for, lambda { |account|
       next where(is_public: true) unless account.is_a? OpenStax::Accounts::Account
@@ -116,7 +116,7 @@ module OpenStax::Accounts
 
     protected
 
-    def syncing_or_stubbing
+    def syncing_or_stubbing?
       syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 

data/app/models/openstax/accounts/group_member.rb

@@ -10,14 +10,14 @@ module OpenStax::Accounts
 
     validates :group, presence: true
     validates :user, presence: true, uniqueness: { scope: :group }
-    validates :requestor, presence: true, unless: :syncing_or_stubbing
+    validates :requestor, presence: true, unless: :syncing_or_stubbing?
 
-    before_create :create_openstax_accounts_group_member, unless: :syncing_or_stubbing
-    before_destroy :destroy_openstax_accounts_group_member, unless: :syncing_or_stubbing
+    before_create :create_openstax_accounts_group_member, unless: :syncing_or_stubbing?
+    before_destroy :destroy_openstax_accounts_group_member, unless: :syncing_or_stubbing?
 
     protected
 
-    def syncing_or_stubbing
+    def syncing_or_stubbing?
       syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 

data/app/models/openstax/accounts/group_nesting.rb

@@ -10,18 +10,18 @@ module OpenStax::Accounts
 
     validates :container_group, presence: true
     validates :member_group, presence: true, uniqueness: true
-    validates :requestor, presence: true, unless: :syncing_or_stubbing
-    validate :no_loops, unless: :syncing_or_stubbing
+    validates :requestor, presence: true, unless: :syncing_or_stubbing?
+    validate :no_loops, unless: :syncing_or_stubbing?
 
     before_create :update_group_caches, unless: :syncing
     before_destroy :update_group_caches, unless: :syncing
 
-    before_create :create_openstax_accounts_group_nesting, unless: :syncing_or_stubbing
-    before_destroy :destroy_openstax_accounts_group_nesting, unless: :syncing_or_stubbing
+    before_create :create_openstax_accounts_group_nesting, unless: :syncing_or_stubbing?
+    before_destroy :destroy_openstax_accounts_group_nesting, unless: :syncing_or_stubbing?
 
     protected
 
-    def syncing_or_stubbing
+    def syncing_or_stubbing?
       syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 

data/app/models/openstax/accounts/group_owner.rb

@@ -10,14 +10,14 @@ module OpenStax::Accounts
 
     validates :group, presence: true
     validates :user, presence: true, uniqueness: { scope: :group }
-    validates :requestor, presence: true, unless: :syncing_or_stubbing
+    validates :requestor, presence: true, unless: :syncing_or_stubbing?
 
-    before_create :create_openstax_accounts_group_owner, unless: :syncing_or_stubbing
-    before_destroy :destroy_openstax_accounts_group_owner, unless: :syncing_or_stubbing
+    before_create :create_openstax_accounts_group_owner, unless: :syncing_or_stubbing?
+    before_destroy :destroy_openstax_accounts_group_owner, unless: :syncing_or_stubbing?
 
     protected
 
-    def syncing_or_stubbing
+    def syncing_or_stubbing?
       syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 

data/app/routines/openstax/accounts/dev/create_account.rb

@@ -6,15 +6,15 @@ module OpenStax
     module Dev
       class CreateAccount
         lev_routine
-              
+
         protected
 
         def exec(inputs={})
-          fatal_error(:code => :cannot_create_account_in_production) if Rails.env.production?
-          fatal_error(:code => :can_only_create_account_when_stubbing) if !OpenStax::Accounts.configuration.enable_stubbing?
+          fatal_error(code: :cannot_create_account_in_production) if Rails.env.production?
+          fatal_error(code: :can_only_create_account_when_stubbing) if !OpenStax::Accounts.configuration.enable_stubbing?
 
           username = inputs[:username]
-          while username.nil? || Account.where(username: username).exists? do 
+          while username.nil? || Account.where(username: username).exists? do
             username = SecureRandom.hex(3).to_s
           end
 

data/app/routines/openstax/accounts/sync_accounts.rb

@@ -22,7 +22,7 @@ module OpenStax
 
         app_accounts = []
         app_accounts_rep = OpenStax::Accounts::Api::V1::ApplicationAccountsRepresenter
-                           .new(app_accounts)
+                             .new(app_accounts)
         app_accounts_rep.from_json(response.body)
 
         return if app_accounts.empty?
@@ -30,7 +30,7 @@ module OpenStax
         updated_app_accounts = []
         app_accounts.each do |app_account|
           account = OpenStax::Accounts::Account.where(
-            :openstax_uid => app_account.account.openstax_uid
+            openstax_uid: app_account.account.openstax_uid
           ).first || app_account.account
           account.syncing = true
 

data/db/migrate/0_create_openstax_accounts_accounts.rb

@@ -9,7 +9,7 @@ class CreateOpenStaxAccountsAccounts < ActiveRecord::Migration
       t.string  :full_name
       t.string  :title
 
-      t.timestamps
+      t.timestamps null: false
     end
 
     add_index :openstax_accounts_accounts, :openstax_uid, unique: true

data/db/migrate/1_create_openstax_accounts_groups.rb

@@ -7,7 +7,7 @@ class CreateOpenStaxAccountsGroups < ActiveRecord::Migration
       t.text :cached_subtree_group_ids
       t.text :cached_supertree_group_ids
 
-      t.timestamps
+      t.timestamps null: false
     end
 
     add_index :openstax_accounts_groups, :openstax_uid, unique: true

data/db/migrate/2_create_openstax_accounts_group_members.rb

@@ -4,7 +4,7 @@ class CreateOpenStaxAccountsGroupMembers < ActiveRecord::Migration
       t.references :group, null: false
       t.references :user, null: false
 
-      t.timestamps
+      t.timestamps null: false
     end
 
     add_index :openstax_accounts_group_members, [:group_id, :user_id], unique: true

data/db/migrate/3_create_openstax_accounts_group_owners.rb

@@ -4,7 +4,7 @@ class CreateOpenStaxAccountsGroupOwners < ActiveRecord::Migration
       t.references :group, null: false
       t.references :user, null: false
 
-      t.timestamps
+      t.timestamps null: false
     end
 
     add_index :openstax_accounts_group_owners, [:group_id, :user_id], unique: true

data/db/migrate/4_create_openstax_accounts_group_nestings.rb

@@ -4,7 +4,7 @@ class CreateOpenStaxAccountsGroupNestings < ActiveRecord::Migration
       t.references :member_group, null: false
       t.references :container_group, null: false
 
-      t.timestamps
+      t.timestamps null: false
     end
 
     add_index :openstax_accounts_group_nestings, :member_group_id, unique: true

data/db/migrate/7_change_accounts_openstax_uid_to_be_nullable.rb

@@ -0,0 +1,5 @@
+class ChangeAccountsOpenStaxUidToBeNullable < ActiveRecord::Migration
+  def change
+    change_column_null :openstax_accounts_accounts, :openstax_uid, true
+  end
+end

data/db/migrate/8_change_accounts_username_to_be_nullable.rb

@@ -0,0 +1,5 @@
+class ChangeAccountsUsernameToBeNullable < ActiveRecord::Migration
+  def change
+    change_column_null :openstax_accounts_accounts, :username, true
+  end
+end

data/lib/openstax/accounts/action_controller/base.rb

@@ -4,7 +4,7 @@ module OpenStax
       module Base
 
         def self.included(base)
-          base.helper_method :current_user, :signed_in?
+          base.helper_method :current_user, :signed_in?, :openstax_accounts_login_path
         end
 
         # Returns the current user
@@ -39,6 +39,14 @@ module OpenStax
             OpenStax::Accounts::CurrentUserManager.new(request, session, cookies)
         end
 
+        def login_params
+          @login_params ||= {}
+        end
+
+        def openstax_accounts_login_path
+          openstax_accounts.login_path(login_params)
+        end
+
         def authenticate_user!
           account = current_account
 
@@ -48,7 +56,9 @@ module OpenStax
 
           respond_to do |format|
             format.json { head(:forbidden) }
-            format.any  { redirect_to openstax_accounts.login_url }
+            format.any  {
+              redirect_to openstax_accounts_login_path
+            }
           end
         end
 

data/lib/openstax/accounts/configuration.rb

@@ -60,6 +60,10 @@ module OpenStax
       # to the default Accounts logout URL.
       attr_writer :logout_redirect_url
 
+      # forwardable_login_param_keys
+      # Which params are forwarded on the accounts login path
+      attr_accessor :forwardable_login_param_keys
+
       def logout_redirect_url(request)
         (@logout_redirect_url.is_a?(Proc) ?
            @logout_redirect_url.call(request) :
@@ -94,6 +98,7 @@ module OpenStax
         @max_search_items = 10
         @logout_redirect_url = nil
         @return_to_url_approver = nil
+        @forwardable_login_param_keys = [:signup_at, :go]
         super
       end
 

data/lib/openstax/accounts/engine.rb

@@ -19,7 +19,7 @@ module OpenStax
   module Accounts
     class Engine < ::Rails::Engine
       isolate_namespace OpenStax::Accounts
-      
+
       initializer "openstax_accounts.factories",
         :after => "factory_girl.set_factory_paths" do
         FactoryGirl.definition_file_paths << File.join(root, 'spec', 'factories') if defined?(FactoryGirl)
@@ -33,13 +33,25 @@ module OpenStax
       end
 
       SETUP_PROC = lambda do |env|
-        env['omniauth.strategy'].options[:client_options][:site] = OpenStax::Accounts.configuration.openstax_accounts_url
+        # Useful link for how to pass params through omniauth/doorkeeper:
+        #  https://github.com/doorkeeper-gem/doorkeeper/wiki/Passing-parameters-from-a-devise-client-to-doorkeeper-(like-locale)
+
+        # request spec `env` doesn't honor "rack.request.query_hash" shortcut, so we fallback
+        # to manually parsing the query string.  Also make sure to use an extra fallback of an
+        # empty hash because setting the authorize_params to nil upsets Omniauth.
+        query_hash = env["rack.request.query_hash"] ||
+                     Rack::Utils.parse_nested_query(env["QUERY_STRING"]) ||
+                     {}
+        env['omniauth.strategy'].options.authorize_params = query_hash
+
+        env['omniauth.strategy'].options[:client_options][:site] =
+          OpenStax::Accounts.configuration.openstax_accounts_url
       end
 
       # Doesn't work to put this omniauth code in an engine initializer, instead:
       # https://gist.github.com/pablomarti/5243118
       middleware.use ::OmniAuth::Builder do
-        provider :openstax, 
+        provider :openstax,
                  OpenStax::Accounts.configuration.openstax_application_id,
                  OpenStax::Accounts.configuration.openstax_application_secret,
                  :setup => SETUP_PROC

data/lib/openstax/accounts/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Accounts
-    VERSION = "7.2.0"
+    VERSION = "7.3.0"
   end
 end

data/spec/controllers/openstax/accounts/forwards_params_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe "Forwards params", type: :request do
+
+  class ForwardsParamsController < OpenStax::Accounts::ApplicationController
+    before_filter :set_login_param
+    before_filter :authenticate_user!
+
+    def action_needing_authentication; end
+
+    def set_login_param
+      login_params[:signup_at] = "foo"
+      login_params[:go] = "bar"
+    end
+  end
+
+  before(:all) do
+    Rails.application.routes.send(:eval_block, Proc.new do
+      get '/forwards_params_route' => 'forwards_params#action_needing_authentication'
+    end)
+  end
+
+  it 'should forward signup_at' do
+    test_forwards(key: :signup_at, value: "foo")
+  end
+
+  it "should forward go" do
+    test_forwards(key: :go, value: "bar")
+  end
+
+  def test_forwards(key:, value:)
+    get '/forwards_params_route'
+
+    expect(redirect_path).to eq "/accounts/login"
+    expect(redirect_query_hash).to include(key => value)
+
+    with_stubbing(false) do
+      get redirect_path_and_query
+    end
+
+    expect(redirect_path).to eq "/accounts/auth/openstax"
+    expect(redirect_query_hash).to include(key => value)
+
+    get redirect_path_and_query
+
+    expect(redirect_path).to eq("/oauth/authorize")
+    expect(redirect_query_hash).to include(key => value)
+
+    # This last redirect was to Accounts, so we don't follow it
+  end
+
+  def redirect_path
+    redirect_uri.path
+  end
+
+  def redirect_path_and_query
+    "#{redirect_uri.path}?#{redirect_uri.query}"
+  end
+
+  def redirect_query_hash
+    Rack::Utils.parse_nested_query(redirect_uri.query).symbolize_keys
+  end
+
+  def redirect_uri
+    expect(response.code).to eq "302"
+    uri = URI.parse(response.headers["Location"])
+  end
+end