openstax_accounts 2.0.0 → 3.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmE5M2NiMTk1MWUzMTg1OTY1MDA5MzVjMGExNzEwMmVlMDY2NTFiMA==
+    MjM3YTQ1MzUyNzQ1ZDcxY2U4OWJhMTEzNzlhOTZhMDAwNDk5YzI1Ng==
   data.tar.gz: !binary |-
-    MmMwMGI2MTRkYTkzZDg2NTlhZmE2Njc5NjZjOTgyMTUyNDJkZDU5MA==
+    ZTQ1NjI3MTRiMTk0YjQ0N2M4OTRhZmMzYTg2YjNjODYyMWViMjFmMA==
 SHA512:
   metadata.gz: !binary |-
-    NmZhOWE1OTA5Y2U5M2ViZTJlNzQzMjNjYmUwM2FkMmFlNTczNDU5ZDVmZmEz
-    NjFmNmI4NGU4OGRiNDE2OTI2ZDRhYTdiNjFlMjc1NTA3ZWFiM2E4NWM4OTY3
-    YTZhZTVlYjVjODhkY2YzMmYxZGRhZWQxNmM1YmUyNzE0MmJhOGE=
+    YTJiNWU0ZmVlYzI4NjhmMjY4YjNlYjhjMTk0NjNjM2MwYmU5YTcyMDRkYTQ4
+    MzEyN2YyMTFlMDM3MTBhYTEwYmVmMTZlOTkxNWY2MDhmYmU2NGZiMTQ0MmQz
+    ZTkyNmJjMDNjMGI5ZGExZjM5YTBlNjQzMmE3N2E4YmI3NWQ5MWM=
   data.tar.gz: !binary |-
-    NmJiODkwZGVjZTRlNzZmNGMwNDJmNWJkMTE1ZTE2MjQzNDc2YWM5YjRmYzlk
-    MjVjODkyYTNmNDZmMjQ4NTQyMDliY2YxYmY4MWNhMmY4NzA1OTcwMzNlNmFm
-    YTQwOTQxOWE5Y2NlYzJiMmQ2ZDdjYjBkYTZkOTg1ZTIxZTc2YTU=
+    ZGFjNDAwZmU3NGUyNThlMTMwMjI3ZjFiYWQzYzY3MWNiM2RjN2I0NzY4MWYy
+    M2NlYWU5MmFlOGJhOGZhZDViZDQzOTMwMTBhNGI2MDA5OGNmOTcyYTgyNDBk
+    YmVkYTEzYTZmM2I5YmUzOWVlNjA2ZTFkMDVjMWZlM2U1ZmRhZDg=

data/README.md

@@ -3,6 +3,7 @@ accounts-rails
 
 [![Gem Version](https://badge.fury.io/rb/openstax_accounts.svg)](http://badge.fury.io/rb/openstax_accounts)
 [![Build Status](https://travis-ci.org/openstax/accounts-rails.svg?branch=master)](https://travis-ci.org/openstax/accounts-rails)
+[![Code Climate](https://codeclimate.com/github/openstax/accounts-rails/badges/gpa.svg)](https://codeclimate.com/github/openstax/accounts-rails)
 
 A rails engine for interfacing with OpenStax's accounts server.
 

data/Rakefile

@@ -11,12 +11,12 @@ load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rake/testtask'
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-
-desc 'Run all specs in spec directory (excluding plugin specs)'
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+Rake::TestTask.new(:spec => 'app:db:test:prepare') do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
 
 task :default => :spec

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

@@ -1,39 +1,49 @@
-module OpenStax
-  module Accounts
+module OpenStax::Accounts
     class Account < ActiveRecord::Base
 
-      USERNAME_DISCARDED_CHAR_REGEX = /[^A-Za-z\d_]/
-      USERNAME_MAX_LENGTH = 50
+    USERNAME_DISCARDED_CHAR_REGEX = /[^A-Za-z\d_]/
+    USERNAME_MAX_LENGTH = 50
 
-      attr_accessor :syncing_with_accounts
+    has_many :group_owners, dependent: :destroy,
+             class_name: 'OpenStax::Accounts::GroupOwner',
+             primary_key: :openstax_uid, foreign_key: :user_id, inverse_of: :user
+    has_many :groups_as_owner, through: :group_owners, source: :group
 
-      validates :username, uniqueness: true, presence: true
-      validates :openstax_uid, uniqueness: true, presence: true
-      validates :access_token, uniqueness: true, allow_nil: true
+    has_many :group_members, dependent: :destroy,
+             class_name: 'OpenStax::Accounts::GroupMember',
+             primary_key: :openstax_uid, foreign_key: :user_id, inverse_of: :user
+    has_many :groups_as_member, through: :group_members, source: :group
 
-      attr_accessible :username, :first_name, :last_name, :full_name, :title
+    validates :openstax_uid, :presence => true, :uniqueness => true
+    validates :username, :presence => true, :uniqueness => true,
+                         :unless => :syncing_or_stubbing
+    validates :access_token, :presence => true, :uniqueness => true,
+                             :unless => :syncing_or_stubbing
 
-      before_update :update_openstax_accounts
+    before_update :update_openstax_accounts, :unless => :syncing_or_stubbing
 
-      def name
-        (first_name || last_name) ? [first_name, last_name].compact.join(" ") : username
-      end
+    def name
+      (first_name || last_name) ? [first_name, last_name].compact.join(" ") : username
+    end
 
-      def casual_name
-        first_name || username
-      end    
+    def casual_name
+      first_name || username
+    end    
 
-      def is_anonymous?
-        false
-      end
+    def is_anonymous?
+      false
+    end
 
-      def update_openstax_accounts
-        return if syncing_with_accounts || \
-                  OpenStax::Accounts.configuration.enable_stubbing?
+    protected
 
-        OpenStax::Accounts.update_account(self)
-      end
+    def syncing_or_stubbing
+      OpenStax::Accounts.syncing ||\
+      OpenStax::Accounts.configuration.enable_stubbing?
+    end
 
+    def update_openstax_accounts
+      OpenStax::Accounts.update_account(self)
     end
+
   end
 end

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

@@ -0,0 +1,7 @@
+module OpenStax
+  module Accounts
+    class ApplicationGroup
+      attr_accessor :id, :application_id, :group, :unread_updates
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+module OpenStax::Accounts
+  class Group < ActiveRecord::Base
+
+    serialize :cached_supertree_group_ids
+    serialize :cached_subtree_group_ids
+
+    attr_accessor :requestor
+
+    has_many :group_owners, dependent: :destroy,
+             class_name: 'OpenStax::Accounts::GroupOwner',
+             primary_key: :openstax_uid, inverse_of: :group
+    has_many :owners, through: :group_owners, source: :user
+
+    has_many :group_members, dependent: :destroy,
+             class_name: 'OpenStax::Accounts::GroupMember',
+             primary_key: :openstax_uid, inverse_of: :group
+    has_many :members, through: :group_members, source: :user
+
+    has_one :container_group_nesting, dependent: :destroy,
+            class_name: 'OpenStax::Accounts::GroupNesting', primary_key: :openstax_uid,
+            foreign_key: :member_group_id, inverse_of: :member_group
+    has_one :container_group, through: :container_group_nesting
+
+    has_many :member_group_nestings, dependent: :destroy,
+             class_name: 'OpenStax::Accounts::GroupNesting', primary_key: :openstax_uid,
+             foreign_key: :container_group_id, inverse_of: :container_group
+    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
+
+    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
+
+      includes(:group_members).includes(:group_owners)
+      .where{((is_public.eq true) |\
+               (group_members.user_id.eq my{account.id}) |\
+               (group_owners.user_id.eq my{account.id}))}
+    }
+
+    def has_owner?(account)
+      return false unless account.is_a? OpenStax::Accounts::Account
+      !group_owners.where(user_id: account.id).first.nil?
+    end
+
+    def has_direct_member?(account)
+      return false unless account.is_a? OpenStax::Accounts::Account
+      !group_members.where(user_id: account.id).first.nil?
+    end
+
+    def has_member?(account)
+      return false unless account.is_a? OpenStax::Accounts::Account
+      !account.group_members.where(group_id: subtree_group_ids).first.nil?
+    end
+
+    def add_owner(account)
+      return false unless account.is_a? OpenStax::Accounts::Account
+      go = GroupOwner.new
+      go.group = self
+      go.user = account
+      return false unless go.valid?
+      go.save if persisted?
+      group_owners << go
+    end
+
+    def add_member(account)
+      return false unless account.is_a? OpenStax::Accounts::Account
+      gm = GroupMember.new
+      gm.group = self
+      gm.user = account
+      return false unless gm.valid?
+      gm.save if persisted?
+      group_members << gm
+    end
+
+    def supertree_group_ids
+      return cached_supertree_group_ids unless cached_supertree_group_ids.nil?
+      return [] unless persisted?
+      reload
+
+      gids = [id] + (Group.includes(:member_group_nestings)
+                          .where(member_group_nestings: {member_group_id: openstax_uid})
+                          .first.try(:supertree_group_ids) || [])
+      update_column(:cached_supertree_group_ids, gids.to_yaml)
+      self.cached_supertree_group_ids = gids
+    end
+
+    def subtree_group_ids
+      return cached_subtree_group_ids unless cached_subtree_group_ids.nil?
+      return [] unless persisted?
+      reload
+
+      gids = [id] + Group.includes(:container_group_nesting)
+                         .where(container_group_nesting: {container_group_id: openstax_uid})
+                         .collect{|g| g.subtree_group_ids}.flatten
+      update_column(:cached_subtree_group_ids, gids.to_yaml)
+      self.cached_subtree_group_ids = gids
+    end
+
+    protected
+
+    def syncing_or_stubbing
+      OpenStax::Accounts.syncing ||\
+      OpenStax::Accounts.configuration.enable_stubbing?
+    end
+
+    def create_openstax_accounts_group
+      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
+
+      OpenStax::Accounts.create_group(requestor, self)
+    end
+
+    def update_openstax_accounts_group
+      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
+
+      OpenStax::Accounts.update_group(requestor, self)
+    end
+
+    def destroy_openstax_accounts_group
+      return if OpenStax::Accounts.syncing || OpenStax::Accounts.configuration.enable_stubbing?
+
+      OpenStax::Accounts.destroy_group(requestor, self)
+    end
+
+  end
+end

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

@@ -0,0 +1,40 @@
+module OpenStax::Accounts
+  class GroupMember < ActiveRecord::Base
+
+    attr_accessor :requestor
+
+    belongs_to :group, class_name: 'OpenStax::Accounts::Group',
+               primary_key: :openstax_uid, inverse_of: :group_members
+    belongs_to :user, class_name: 'OpenStax::Accounts::Account',
+               primary_key: :openstax_uid, inverse_of: :group_members
+
+    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
+
+    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?
+    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)
+    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)
+    end
+
+  end
+end

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

@@ -0,0 +1,62 @@
+module OpenStax::Accounts
+  class GroupNesting < ActiveRecord::Base
+
+    attr_accessor :requestor
+
+    belongs_to :container_group, class_name: 'OpenStax::Accounts::Group',
+               primary_key: :openstax_uid, inverse_of: :member_group_nestings
+    belongs_to :member_group, class_name: 'OpenStax::Accounts::Group',
+               primary_key: :openstax_uid, inverse_of: :container_group_nesting
+
+    validates_presence_of :container_group_id, :member_group_id
+    validates_uniqueness_of :member_group_id
+    validates_presence_of :container_group, :member_group, :requestor,
+                          :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 :update_group_caches, :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?
+    end
+
+    def no_loops
+      return if member_group.nil? ||\
+                !member_group.subtree_group_ids.include?(container_group_id)
+      errors.add(:base, 'would create a loop') if errors[:base].blank?
+      false
+    end
+
+    def update_group_caches
+      # Returns false if the update fails (aborting the save transaction)
+      UpdateGroupCaches.call(self).errors.none?
+    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)
+    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)
+    end
+
+  end
+end

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

@@ -0,0 +1,40 @@
+module OpenStax::Accounts
+  class GroupOwner < ActiveRecord::Base
+
+    attr_accessor :requestor
+
+    belongs_to :group, class_name: 'OpenStax::Accounts::Group',
+               primary_key: :openstax_uid, inverse_of: :group_owners
+    belongs_to :user, class_name: 'OpenStax::Accounts::Account',
+               primary_key: :openstax_uid, inverse_of: :group_owners
+
+    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
+
+    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?
+    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)
+    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)
+    end
+
+  end
+end

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

@@ -0,0 +1,25 @@
+module OpenStax
+  module Accounts
+    module Api
+      module V1
+        class ApplicationGroupRepresenter < Roar::Decorator
+          include Roar::Representer::JSON
+
+          property :id, 
+                   type: Integer
+
+          property :application_id,
+                   type: Integer
+
+          property :group,
+                   class: OpenStax::Accounts::Group,
+                   decorator: GroupRepresenter
+
+          property :unread_updates,
+                   type: Integer
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require 'representable/json/collection'
+
+module OpenStax
+  module Accounts
+    module Api
+      module V1
+        class ApplicationGroupsRepresenter < Roar::Decorator
+          include Representable::JSON::Collection
+
+          items class: OpenStax::Accounts::ApplicationGroup,
+                decorator: ApplicationGroupRepresenter
+        end
+      end
+    end
+  end
+end