openstax_accounts 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89eaeece94bdba0b11a0f199af06eb5a81c3d7cf
-  data.tar.gz: 95b3ad8856ea3eab85788ee48e2b33ee909c416f
+  metadata.gz: 5c68309eb816447b9379cd570f95a2099ce13bfc
+  data.tar.gz: c598caec6b97bff42fe269e3bd8885b688842673
 SHA512:
-  metadata.gz: f299c3a422edf23b9528267f04006a31efa0f15748b5f0c20c3ce12035d0898426975f08776f61d510b1adb4c0a6f3e95e931afb7829112b47fe66287c57a9d0
-  data.tar.gz: 765d14c76d283b5dd0c1ded49117b2ae9c594ba9302c2f4988272e70d6570f25a282253721d676b9a4da29c1672f1f8eab7581324576ae3c956aea080381b4a8
+  metadata.gz: 969eaf95f5aa6a2d2cee9e19972ee2c0269abb4fa939ea32a3f49d7fb8b946cbddac8360b5b8438d62873c3672f6377a70cf3da88d01cde0418da682efb50a9c
+  data.tar.gz: 255d45ca40d05da9db31569db43b04bde685b534bc55efd3c9c5470f549c8a38ab34968993ba52c273bce5999c3520b28d72303a76611167b8c9f968f18d7290

data/README.md

@@ -136,7 +136,7 @@ Accounts API
 OpenStax Accounts provides convenience methods for accessing
 the Accounts server API.
 
-`OpenStax::Accounts.api_call(http_method, url, options = {})` provides a
+`OpenStax::Accounts::Api.request(http_method, url, options = {})` provides a
 convenience method capable of making API calls to Accounts. `http_method` can
 be any valid HTTP method, and `url` is the desired API URL, without the 'api/'
 prefix. Options is a hash that can contain any option that
@@ -144,6 +144,9 @@ OAuth2 requests accept, such as :headers, :params, :body, etc,
 plus the optional values :api_version (to specify an API version) and
 :access_token (to specify an OAuth access token).
 
+Individual methods to access each Accounts API, such as `search_accounts`,
+are also available. See lib/openstax/accounts/api.rb for more details.
+
 Example Application
 -------------------
 

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

@@ -1,7 +1,7 @@
 module OpenStax
   module Accounts
 
-    class ApplicationController < ActionController::Base
+    class ApplicationController < ::ActionController::Base
 
       include Lev::HandleWith
 

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

@@ -4,14 +4,20 @@ module OpenStax::Accounts
     USERNAME_DISCARDED_CHAR_REGEX = /[^A-Za-z\d_]/
     USERNAME_MAX_LENGTH = 50
 
+    attr_accessor :syncing
+
     has_many :group_owners, dependent: :destroy,
              class_name: 'OpenStax::Accounts::GroupOwner',
-             primary_key: :openstax_uid, foreign_key: :user_id, inverse_of: :user
+             primary_key: :openstax_uid,
+             foreign_key: :user_id,
+             inverse_of: :user
     has_many :groups_as_owner, through: :group_owners, source: :group
 
     has_many :group_members, dependent: :destroy,
              class_name: 'OpenStax::Accounts::GroupMember',
-             primary_key: :openstax_uid, foreign_key: :user_id, inverse_of: :user
+             primary_key: :openstax_uid,
+             foreign_key: :user_id,
+             inverse_of: :user
     has_many :groups_as_member, through: :group_members, source: :group
 
     validates :openstax_uid, :presence => true, :uniqueness => true
@@ -37,13 +43,12 @@ module OpenStax::Accounts
     protected
 
     def syncing_or_stubbing
-      OpenStax::Accounts.syncing ||\
-      OpenStax::Accounts.configuration.enable_stubbing?
+      syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 
     def update_openstax_accounts
-      OpenStax::Accounts.update_account(self)
+      OpenStax::Accounts::Api.update_account(self)
     end
 
   end
-end
+end

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

@@ -21,4 +21,4 @@ module OpenStax
 
     end
   end
-end
+end

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

@@ -1,7 +1,8 @@
 module OpenStax
   module Accounts
     class ApplicationAccount
-      attr_accessor :id, :application_id, :account, :unread_updates, :default_contact_info_id
+      attr_accessor :id, :application_id, :account,
+                    :unread_updates, :default_contact_info_id
     end
   end
 end

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

@@ -4,7 +4,7 @@ module OpenStax::Accounts
     serialize :cached_supertree_group_ids
     serialize :cached_subtree_group_ids
 
-    attr_accessor :requestor
+    attr_accessor :requestor, :syncing
 
     has_many :group_owners, dependent: :destroy,
              class_name: 'OpenStax::Accounts::GroupOwner',
@@ -28,12 +28,15 @@ module OpenStax::Accounts
 
     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_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_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
@@ -110,26 +113,25 @@ module OpenStax::Accounts
     protected
 
     def syncing_or_stubbing
-      OpenStax::Accounts.syncing ||\
-      OpenStax::Accounts.configuration.enable_stubbing?
+      syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 
     def create_openstax_accounts_group
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
+      return false unless requestor
 
-      OpenStax::Accounts.create_group(requestor, self)
+      OpenStax::Accounts::Api.create_group(requestor, self)
     end
 
     def update_openstax_accounts_group
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
+      return false unless requestor
 
-      OpenStax::Accounts.update_group(requestor, self)
+      OpenStax::Accounts::Api.update_group(requestor, self)
     end
 
     def destroy_openstax_accounts_group
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
+      return false unless requestor
 
-      OpenStax::Accounts.destroy_group(requestor, self)
+      OpenStax::Accounts::Api.destroy_group(requestor, self)
     end
 
   end

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

@@ -1,7 +1,7 @@
 module OpenStax::Accounts
   class GroupMember < ActiveRecord::Base
 
-    attr_accessor :requestor
+    delegate :requestor, :syncing, to: :group
 
     belongs_to :group, class_name: 'OpenStax::Accounts::Group',
                primary_key: :openstax_uid, inverse_of: :group_members
@@ -10,30 +10,30 @@ module OpenStax::Accounts
 
     validates_presence_of :user_id, :group_id
     validates_uniqueness_of :user_id, scope: :group_id
-    validates_presence_of :group, :user, :requestor, :unless => :syncing_or_stubbing
+    validates_presence_of :group, :user, :requestor,
+                          :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
-      OpenStax::Accounts.syncing ||\
-      OpenStax::Accounts.configuration.enable_stubbing?
+      syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 
     def create_openstax_accounts_group_member
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
       return false unless requestor
 
-      OpenStax::Accounts.create_group_member(requestor, self)
+      OpenStax::Accounts::Api.create_group_member(requestor, self)
     end
 
     def destroy_openstax_accounts_group_member
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
       return false unless requestor
 
-      OpenStax::Accounts.destroy_group_member(requestor, self)
+      OpenStax::Accounts::Api.destroy_group_member(requestor, self)
     end
 
   end

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

@@ -1,7 +1,7 @@
 module OpenStax::Accounts
   class GroupNesting < ActiveRecord::Base
 
-    attr_accessor :requestor
+    delegate :requestor, :syncing, to: :container_group
 
     belongs_to :container_group, class_name: 'OpenStax::Accounts::Group',
                primary_key: :openstax_uid, inverse_of: :member_group_nestings
@@ -14,22 +14,18 @@ module OpenStax::Accounts
                           :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 :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 :update_group_caches, :destroy_openstax_accounts_group_nesting,
+    before_destroy :destroy_openstax_accounts_group_nesting,
                    :unless => :syncing_or_stubbing
 
     protected
 
-    def syncing?
-      OpenStax::Accounts.syncing
-    end
-
     def syncing_or_stubbing
-      syncing? || OpenStax::Accounts.configuration.enable_stubbing?
+      syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 
     def no_loops
@@ -45,17 +41,15 @@ module OpenStax::Accounts
     end
 
     def create_openstax_accounts_group_nesting
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
       return false unless requestor
 
-      OpenStax::Accounts.create_group_nesting(requestor, self)
+      OpenStax::Accounts::Api.create_group_nesting(requestor, self)
     end
 
     def destroy_openstax_accounts_group_nesting
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
       return false unless requestor
 
-      OpenStax::Accounts.destroy_group_nesting(requestor, self)
+      OpenStax::Accounts::Api.destroy_group_nesting(requestor, self)
     end
 
   end

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

@@ -1,7 +1,7 @@
 module OpenStax::Accounts
   class GroupOwner < ActiveRecord::Base
 
-    attr_accessor :requestor
+    delegate :requestor, :syncing, to: :group
 
     belongs_to :group, class_name: 'OpenStax::Accounts::Group',
                primary_key: :openstax_uid, inverse_of: :group_owners
@@ -10,30 +10,30 @@ module OpenStax::Accounts
 
     validates_presence_of :user_id, :group_id
     validates_uniqueness_of :user_id, scope: :group_id
-    validates_presence_of :group, :user, :requestor, :unless => :syncing_or_stubbing
+    validates_presence_of :group, :user, :requestor,
+                          :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
-      OpenStax::Accounts.syncing ||\
-      OpenStax::Accounts.configuration.enable_stubbing?
+      syncing || OpenStax::Accounts.configuration.enable_stubbing?
     end
 
     def create_openstax_accounts_group_owner
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
       return false unless requestor
 
-      OpenStax::Accounts.create_group_owner(requestor, self)
+      OpenStax::Accounts::Api.create_group_owner(requestor, self)
     end
 
     def destroy_openstax_accounts_group_owner
-      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
       return false unless requestor
 
-      OpenStax::Accounts.destroy_group_owner(requestor, self)
+      OpenStax::Accounts::Api.destroy_group_owner(requestor, self)
     end
 
   end

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

@@ -1,14 +1,15 @@
 # A representer for Accounts
 #
-# This representer can be used directly or subclassed for an object that delegates
-# openstax_uid, username, first_name, last_name, full_name and title to an account
+# This representer can be used directly or subclassed for an object that
+# delegates openstax_uid, username, first_name, last_name, full_name and
+# title to an account
 
 module OpenStax
   module Accounts
     module Api
       module V1
         class AccountRepresenter < Roar::Decorator
-          include Roar::Representer::JSON
+          include Roar::JSON
 
           property :openstax_uid,
                    as: :id,

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

@@ -3,7 +3,7 @@ module OpenStax
     module Api
       module V1
         class ApplicationAccountRepresenter < Roar::Decorator
-          include Roar::Representer::JSON
+          include Roar::JSON
 
           property :id, 
                    type: Integer
@@ -14,7 +14,12 @@ module OpenStax
           property :account,
                    as: :user,
                    class: OpenStax::Accounts::Account,
-                   decorator: AccountRepresenter
+                   decorator: AccountRepresenter,
+                   instance: ->(*) {
+                     a = OpenStax::Accounts::Account.new
+                     a.syncing = true
+                     a
+                   }
 
           property :unread_updates,
                    type: Integer

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

@@ -1,5 +1,3 @@
-require 'representable/json/collection'
-
 module OpenStax
   module Accounts
     module Api

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

@@ -3,7 +3,7 @@ module OpenStax
     module Api
       module V1
         class ApplicationGroupRepresenter < Roar::Decorator
-          include Roar::Representer::JSON
+          include Roar::JSON
 
           property :id, 
                    type: Integer
@@ -13,7 +13,12 @@ module OpenStax
 
           property :group,
                    class: OpenStax::Accounts::Group,
-                   decorator: GroupRepresenter
+                   decorator: GroupRepresenter,
+                   instance: ->(*) {
+                     g = OpenStax::Accounts::Group.new
+                     g.syncing = true
+                     g
+                   }
 
           property :unread_updates,
                    type: Integer

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

@@ -1,5 +1,3 @@
-require 'representable/json/collection'
-
 module OpenStax
   module Accounts
     module Api

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

@@ -3,7 +3,7 @@ module OpenStax
     module Api
       module V1
         class GroupNestingRepresenter < Roar::Decorator
-          include Roar::Representer::JSON
+          include Roar::JSON
 
           property :container_group_id,
                    type: Integer

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

@@ -3,7 +3,7 @@ module OpenStax
     module Api
       module V1
         class GroupRepresenter < Roar::Decorator
-          include Roar::Representer::JSON
+          include Roar::JSON
 
           property :openstax_uid,
                    as: :id,

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

@@ -3,7 +3,7 @@ module OpenStax
     module Api
       module V1
         class GroupUserRepresenter < Roar::Decorator
-          include Roar::Representer::JSON
+          include Roar::JSON
 
           property :group_id,
                    type: Integer

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

@@ -21,7 +21,7 @@ module OpenStax
         if !OpenStax::Accounts.configuration.enable_stubbing? && \
            query =~ /email:/
           # Delegate to Accounts
-          response = OpenStax::Accounts.search_application_accounts(query)
+          response = OpenStax::Accounts::Api.search_application_accounts(query)
           OpenStax::Accounts::Api::V1::AccountSearchRepresenter \
             .new(outputs).from_json(response.body)
         else

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

@@ -16,43 +16,40 @@ module OpenStax
       
       def exec(options={})
 
-        begin
-          OpenStax::Accounts.syncing = true
+        return if OpenStax::Accounts.configuration.enable_stubbing?
 
-          return if OpenStax::Accounts.configuration.enable_stubbing?
+        response = OpenStax::Accounts::Api.get_application_account_updates
 
-          response = OpenStax::Accounts.get_application_account_updates
+        app_accounts = []
+        app_accounts_rep = OpenStax::Accounts::Api::V1::ApplicationAccountsRepresenter
+                           .new(app_accounts)
+        app_accounts_rep.from_json(response.body)
 
-          app_accounts = []
-          app_accounts_rep = OpenStax::Accounts::Api::V1::ApplicationAccountsRepresenter
-                             .new(app_accounts)
-          app_accounts_rep.from_json(response.body)
+        return if app_accounts.empty?
 
-          return if app_accounts.empty?
+        updated_app_accounts = []
+        app_accounts.each do |app_account|
+          account = OpenStax::Accounts::Account.where(
+            :openstax_uid => app_account.account.openstax_uid
+          ).first || app_account.account
+          account.syncing = true
 
-          updated_app_accounts = []
-          app_accounts.each do |app_account|
-            account = OpenStax::Accounts::Account.where(
-                        :openstax_uid => app_account.account.openstax_uid).first ||\
-                        app_account.account
-
-            if account != app_account.account
-              SYNC_ATTRIBUTES.each do |attribute|
-                account.send("#{attribute}=", app_account.account.send(attribute))
-              end
+          if account != app_account.account
+            SYNC_ATTRIBUTES.each do |attribute|
+              account.send("#{attribute}=", app_account.account.send(attribute))
             end
-
-            next unless account.save
-
-            updated_app_accounts << {user_id: account.openstax_uid,
-                                    read_updates: app_account.unread_updates}
           end
 
-          OpenStax::Accounts.mark_account_updates_as_read(updated_app_accounts)
-        ensure
-          OpenStax::Accounts.syncing = false
+          next unless account.save
+
+          updated_app_accounts << {user_id: account.openstax_uid,
+                                  read_updates: app_account.unread_updates}
         end
 
+        OpenStax::Accounts::Api.mark_account_updates_as_read(
+          updated_app_accounts
+        )
+
       end
 
     end