openstax_accounts 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6c2574a839a5d9ac9bca06bd2d2f4ec74c684b6
-  data.tar.gz: 352c193b6685610b0025a67253ffc2313f84b9ca
+  metadata.gz: ce623db44c0708f64ebd6296553c9bb9baa85155
+  data.tar.gz: 912df21908f79486466243da03c45ac7a9640967
 SHA512:
-  metadata.gz: 4d27f3a0211633e06103c3e2c033c43f6e0a421def89a601b7405e4ecc58610b4959333fc2e1da6aaecccd886416e72dfe63882ea6ffd2a9e38b5d0e55ad0b84
-  data.tar.gz: 8847dcc227f640e2d76009919e16ed9aab8d0687083598be9f0df1979b5eeb3315524ba9d6f2df540218108d6027fb1b8e51a799182b19f33e03c2851c19dd50
+  metadata.gz: bdf7d0019ee853afc6cd0b295d7fc452749c61824b3ea75c1b5c3d5c10ad840b183e781e04833c720b31ff69df1e2f1c3279d5d5398fc5fc3f6618adaba7869d
+  data.tar.gz: 38d12dd367e42997e21f2a0be678decd4e6c1fe90c937a02c9c569a45b75520485e25436e6dd5c83fae273b4cc43c9a925cde39e7d7c70164e62e2447b348d2d

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

@@ -24,9 +24,11 @@ module OpenStax::Accounts
                           :confirmed_faculty, :rejected_faculty]
 
     after_initialize :set_default_faculty_status
-
     validates :faculty_status, presence: true
 
+    enum role: [:unknown_role, :student, :instructor, :administrator, :librarian, :designer, :other]
+    validates :role, presence: true
+
     validates :openstax_uid, uniqueness: { allow_nil: true }
     validates :username, uniqueness: { allow_nil: true }
 

data/app/representers/openstax/accounts/api/v1/account_representer.rb

@@ -68,6 +68,22 @@ module OpenStax
                      }"
                    }
 
+          property :role,
+                   as: :self_reported_role,
+                   type: String,
+                   schema_info: {
+                      description: "The user's uncorroborated role, one of [#{
+                        OpenStax::Accounts::Account.roles.keys.map(&:to_s).join(', ')
+                      }]",
+                      required: true
+                   }
+
+          property :uuid,
+                   type: String,
+                   schema_info: {
+                     description: "The UUID as set by Accounts"
+                   }
+
         end
       end
     end

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

@@ -8,7 +8,7 @@ module OpenStax
 
       def exec(email: nil, username: nil, password: nil,
                first_name: nil, last_name: nil, full_name: nil, title: nil,
-               salesforce_contact_id: nil, faculty_status: nil)
+               salesforce_contact_id: nil, faculty_status: nil, role: nil)
         raise ArgumentError,
               'You must specify either an email address or a username (and an optional password)' \
                 if email.nil? && username.nil?
@@ -21,7 +21,8 @@ module OpenStax
           response = Api.find_or_create_account(
             email: email, username: username, password: password,
             first_name: first_name, last_name: last_name, full_name: full_name,
-            salesforce_contact_id: salesforce_contact_id, faculty_status: faculty_status)
+            salesforce_contact_id: salesforce_contact_id, faculty_status: faculty_status,
+            role: role)
           fatal_error(code: :invalid_inputs) unless (200..202).include?(response.status)
 
           struct = OpenStruct.new

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

@@ -8,7 +8,7 @@ module OpenStax
     class SyncAccounts
 
       SYNC_ATTRIBUTES = ['username', 'first_name', 'last_name', 'full_name', 'title',
-                         'faculty_status', 'salesforce_contact_id']
+                         'faculty_status', 'salesforce_contact_id', 'uuid', 'role']
 
       lev_routine transaction: :no_transaction
 

data/db/migrate/9_add_uuid_and_role_to_accounts_accounts.rb

@@ -0,0 +1,9 @@
+class AddUuidAndRoleToAccountsAccounts < ActiveRecord::Migration
+  def change
+    add_column :openstax_accounts_accounts, :uuid, :string
+    add_index :openstax_accounts_accounts, :uuid, unique: true
+
+    add_column :openstax_accounts_accounts, :role, :integer, default: 0, null: false
+    add_index :openstax_accounts_accounts, :role
+  end
+end

data/lib/openstax/accounts/api.rb

@@ -74,12 +74,14 @@ module OpenStax
 
       # Retrieves information about accounts that have been
       # recently updated.
-      # Results are limited to accounts that have used the current app.
+      # Results are limited to accounts that have used the current app, and
+      # limited in quantity per call by a configuration parameter.
       # Takes an options hash.
       # On failure, throws an Exception, just like the request method.
       # On success, returns an OAuth2::Response object.
       def self.get_application_account_updates(options = {})
-        request(:get, 'application_users/updates', options)
+        limit = OpenStax::Accounts.configuration.max_user_updates_per_request
+        request(:get, "application_users/updates#{ '?limit=' + limit.to_s if !limit.blank? }", options)
       end
 
       # Marks account updates as "read".

data/lib/openstax/accounts/configuration.rb

@@ -64,6 +64,13 @@ module OpenStax
       # Which params are forwarded on the accounts login path
       attr_accessor :forwardable_login_param_keys
 
+      # max_user_updates_per_request
+      # When the user profile sync operation is called, this parameter will limit
+      # the number of returned profile updates from Accounts; helpful when all
+      # accounts have been marked as updated on Accounts so that we don't get
+      # overloaded.
+      attr_accessor :max_user_updates_per_request
+
       def logout_redirect_url(request)
         (@logout_redirect_url.is_a?(Proc) ?
            @logout_redirect_url.call(request) :
@@ -99,6 +106,7 @@ module OpenStax
         @logout_redirect_url = nil
         @return_to_url_approver = nil
         @forwardable_login_param_keys = [:signup_at, :go]
+        @max_user_updates_per_request = 250
         super
       end
 

data/lib/openstax/accounts/version.rb

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

data/spec/dummy/db/schema.rb

@@ -25,6 +25,8 @@ ActiveRecord::Schema.define(version: 1001) do
     t.datetime "updated_at",                        null: false
     t.integer  "faculty_status",        default: 0, null: false
     t.string   "salesforce_contact_id"
+    t.string   "uuid"
+    t.integer  "role",                  default: 0, null: false
   end
 
   add_index "openstax_accounts_accounts", ["access_token"], name: "index_openstax_accounts_accounts_on_access_token", unique: true
@@ -33,8 +35,10 @@ ActiveRecord::Schema.define(version: 1001) do
   add_index "openstax_accounts_accounts", ["full_name"], name: "index_openstax_accounts_accounts_on_full_name"
   add_index "openstax_accounts_accounts", ["last_name"], name: "index_openstax_accounts_accounts_on_last_name"
   add_index "openstax_accounts_accounts", ["openstax_uid"], name: "index_openstax_accounts_accounts_on_openstax_uid", unique: true
+  add_index "openstax_accounts_accounts", ["role"], name: "index_openstax_accounts_accounts_on_role"
   add_index "openstax_accounts_accounts", ["salesforce_contact_id"], name: "index_openstax_accounts_accounts_on_salesforce_contact_id"
   add_index "openstax_accounts_accounts", ["username"], name: "index_openstax_accounts_accounts_on_username", unique: true
+  add_index "openstax_accounts_accounts", ["uuid"], name: "index_openstax_accounts_accounts_on_uuid", unique: true
 
   create_table "openstax_accounts_group_members", force: :cascade do |t|
     t.integer  "group_id",   null: false

data/spec/dummy/log/development.log

@@ -6068,3 +6068,382 @@ Migrating to CreateOwnerships (1001)
             WHERE name='index_users_on_account_id' AND type='index'
 
   ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to AddUuidAndRoleToAccountsAccounts (9)
+   (0.0ms)  begin transaction
+   (0.4ms)  ALTER TABLE "openstax_accounts_accounts" ADD "uuid" varchar
+   (0.0ms)  select sqlite_version(*)
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+
+   (0.3ms)  CREATE UNIQUE INDEX "index_openstax_accounts_accounts_on_uuid" ON "openstax_accounts_accounts" ("uuid")
+   (0.1ms)  ALTER TABLE "openstax_accounts_accounts" ADD "role" integer NOT NULL
+   (1.0ms)  rollback transaction
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to AddUuidAndRoleToAccountsAccounts (9)
+   (0.0ms)  begin transaction
+   (0.5ms)  ALTER TABLE "openstax_accounts_accounts" ADD "uuid" varchar
+   (0.0ms)  select sqlite_version(*)
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+
+   (0.3ms)  CREATE UNIQUE INDEX "index_openstax_accounts_accounts_on_uuid" ON "openstax_accounts_accounts" ("uuid")
+   (0.2ms)  ALTER TABLE "openstax_accounts_accounts" ADD "role" integer DEFAULT 0 NOT NULL
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_uuid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_uuid' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+
+   (0.1ms)  CREATE  INDEX "index_openstax_accounts_accounts_on_role" ON "openstax_accounts_accounts" ("role")
+  SQL (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "9"]]
+   (1.1ms)  commit transaction
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_role' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_role' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_uuid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_uuid' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_salesforce_contact_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_faculty_status' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_full_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_last_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_first_name' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_access_token' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_username' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_accounts_on_openstax_uid' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_group_members_on_user_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_group_members_on_user_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_group_members_on_group_id_and_user_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_group_members_on_group_id_and_user_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_group_nestings_on_container_group_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_group_nestings_on_container_group_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_group_nestings_on_member_group_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_group_nestings_on_member_group_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_group_owners_on_user_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_group_owners_on_user_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_group_owners_on_group_id_and_user_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_group_owners_on_group_id_and_user_id' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_groups_on_is_public' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_groups_on_is_public' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_openstax_accounts_groups_on_openstax_uid' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_openstax_accounts_groups_on_openstax_uid' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_ownerships_on_owner_id_and_owner_type' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_ownerships_on_owner_id_and_owner_type' AND type='index'
+
+   (0.1ms)              SELECT sql
+            FROM sqlite_master
+            WHERE name='index_users_on_account_id' AND type='index'
+            UNION ALL
+            SELECT sql
+            FROM sqlite_temp_master
+            WHERE name='index_users_on_account_id' AND type='index'
+