openstax_accounts 2.0.0 → 3.0.0

data/lib/openstax/accounts/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Accounts
-    VERSION = "2.0.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/openstax_accounts.rb

@@ -2,6 +2,7 @@ require 'openstax/accounts/version'
 require 'openstax/accounts/engine'
 require 'openstax/accounts/default_account_user_mapper'
 require 'openstax/accounts/current_user_manager'
+require 'openstax/accounts/has_many_through_groups'
 require 'openstax_utilities'
 
 require 'oauth2'
@@ -14,6 +15,8 @@ module OpenStax
 
     class << self
 
+      mattr_accessor :syncing
+
       ###########################################################################
       #
       # Configuration machinery.
@@ -143,6 +146,20 @@ module OpenStax
         api_call(:get, 'users', options)
       end
 
+      # Updates a user account in the Accounts server.
+      # The account is determined by the OAuth access token.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def update_account(account, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version,
+                   :body => account.attributes.slice('username', 'first_name',
+                              'last_name', 'full_name', 'title').to_json}
+        api_call(:put, 'user', options)
+      end
+
       # Performs an account search in the Accounts server.
       # Results are limited to accounts that have used the current app.
       # Takes a query parameter and an optional API version parameter.
@@ -166,29 +183,166 @@ module OpenStax
       end
 
       # Marks account updates as "read".
-      # The uid_map parameter is a hash that maps account openstax_uid's
-      # to the value of the last received unread_updates for that uid.
-      # Can only be called for accounts that have used the current app.
+      # The application_users parameter is an array of hashes.
+      # Each hash has 2 required fields: 'id', which should contain the
+      # application_user's id, and 'read_updates', which should contain
+      # the last received value of unread_updates for that application_user.
+      # Can only be called for application_users that belong to the current app.
       # On failure, throws an Exception, just like api_call.
       # On success, returns an OAuth2::Response object.
-      def mark_updates_as_read(uid_map, version = DEFAULT_API_VERSION)
+      def mark_account_updates_as_read(application_users, version = DEFAULT_API_VERSION)
         options = {:api_version => version,
-                   :body => {:application_users => uid_map}}
+                   :body => application_users.to_json}
         api_call(:put, 'application_users/updated', options)
       end
 
-      # Updates the current account in the Accounts server.
-      # The current account is determined by the OAuth access token.
+      # Retrieves information about groups that have been
+      # recently updated.
+      # Results are limited to groups that users of the current app have access to.
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def get_application_group_updates(version = DEFAULT_API_VERSION)
+        options = {:api_version => version}
+        api_call(:get, 'application_groups/updates', options)
+      end
+
+      # Marks group updates as "read".
+      # The application_groups parameter is an array of hashes.
+      # Each hash has 2 required fields: 'id', which should contain the
+      # application_group's id, and 'read_updates', which should contain
+      # the last received value of unread_updates for that application_group.
+      # Can only be called for application_groups that belong to the current app.
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def mark_group_updates_as_read(application_groups, version = DEFAULT_API_VERSION)
+        options = {:api_version => version,
+                   :body => application_groups.to_json}
+        api_call(:put, 'application_groups/updated', options)
+      end
+
+      # Creates a group in the Accounts server.
+      # The given account will be the owner of the group.
       # Also takes an optional API version parameter.
       # API version currently defaults to :v1 (may change in the future).
       # On failure, throws an Exception, just like api_call.
       # On success, returns an OAuth2::Response object.
-      def update_account(account, version = DEFAULT_API_VERSION)
+      def create_group(account, group, version = DEFAULT_API_VERSION)
         options = {:access_token => account.access_token,
                    :api_version => version,
-                   :body => account.attributes.slice('username', 'first_name',
-                              'last_name', 'full_name', 'title').to_json}
-        api_call(:put, 'user', options)
+                   :body => group.attributes.slice('name', 'is_public').to_json}
+        response = ActiveSupport::JSON.decode(api_call(
+                     :post, 'groups', options).body)
+        group.openstax_uid = response['id']
+        response
+      end
+
+      # Updates a group in the Accounts server.
+      # The given account must own the group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def update_group(account, group, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version,
+                   :body => group.attributes.slice('name', 'is_public').to_json}
+        api_call(:put, "groups/#{group.openstax_uid}", options)
+      end
+
+      # Deletes a group from the Accounts server.
+      # The given account must own the group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def destroy_group(account, group, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:delete, "groups/#{group.openstax_uid}", options)
+      end
+
+      # Creates a group_member in the Accounts server.
+      # The given account must own the group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def create_group_member(account, group_member, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:post,
+                 "groups/#{group_member.group_id}/members/#{group_member.user_id}",
+                 options)
+      end
+
+      # Deletes a group_member from the Accounts server.
+      # The given account must own the group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def destroy_group_member(account, group_member, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:delete,
+                 "groups/#{group_member.group_id}/members/#{group_member.user_id}",
+                 options)
+      end
+
+      # Creates a group_owner in the Accounts server.
+      # The given account must own the group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def create_group_owner(account, group_owner, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:post,
+                 "groups/#{group_owner.group_id}/owners/#{group_owner.user_id}",
+                 options)
+      end
+
+      # Deletes a group_owner from the Accounts server.
+      # The given account must own the group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def destroy_group_owner(account, group_owner, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:delete,
+                 "groups/#{group_owner.group_id}/owners/#{group_owner.user_id}",
+                 options)
+      end
+
+      # Creates a group_nesting in the Accounts server.
+      # The given account must own both groups.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def create_group_nesting(account, group_nesting, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:post,
+                 "groups/#{group_nesting.container_group_id}/nestings/#{group_nesting.member_group_id}",
+                 options)
+      end
+
+      # Deletes a group_nesting from the Accounts server.
+      # The given account must own either group.
+      # Also takes an optional API version parameter.
+      # API version currently defaults to :v1 (may change in the future).
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def destroy_group_nesting(account, group_nesting, version = DEFAULT_API_VERSION)
+        options = {:access_token => account.access_token,
+                   :api_version => version}
+        api_call(:delete,
+                 "groups/#{group_nesting.container_group_id}/nestings/#{group_nesting.member_group_id}",
+                 options)
       end
 
       protected

data/spec/controllers/openstax/accounts/dev/accounts_controller_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module OpenStax::Accounts
   module Dev
-    describe AccountsController do
+    describe AccountsController, type: :controller do
       routes { Engine.routes }
 
       let!(:account) { FactoryGirl.create :openstax_accounts_account,

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module OpenStax::Accounts
-  describe SessionsController do
+  describe SessionsController, type: :controller do
     routes { Engine.routes }
 
     let!(:account) { FactoryGirl.create :openstax_accounts_account,

data/spec/dummy/app/controllers/api/application_groups_controller.rb

@@ -0,0 +1,11 @@
+module Api
+  class ApplicationGroupsController < DummyController
+    def updates
+      dummy(:updates)
+    end
+
+    def updated
+      dummy(:updated)
+    end
+  end
+end

data/spec/dummy/app/controllers/api/dummy_controller.rb

@@ -1,10 +1,11 @@
 module Api
   class DummyController < ApplicationController
-    class << self; attr_accessor :last_action, :last_params end
+    class << self; attr_accessor :last_action, :last_params, :last_json end
 
     def dummy(action_name = :dummy)
       self.class.last_action = action_name
       self.class.last_params = params
+      self.class.last_json = ActiveSupport::JSON.decode(request.body.read) rescue nil
       render :json => { :head => :no_content }
     end
   end

data/spec/dummy/app/controllers/api/group_members_controller.rb

@@ -0,0 +1,11 @@
+module Api
+  class GroupMembersController < DummyController
+    def create
+      dummy(:create)
+    end
+
+    def destroy
+      dummy(:destroy)
+    end
+  end
+end

data/spec/dummy/app/controllers/api/group_nestings_controller.rb

@@ -0,0 +1,11 @@
+module Api
+  class GroupNestingsController < DummyController
+    def create
+      dummy(:create)
+    end
+
+    def destroy
+      dummy(:destroy)
+    end
+  end
+end

data/spec/dummy/app/controllers/api/group_owners_controller.rb

@@ -0,0 +1,11 @@
+module Api
+  class GroupOwnersController < DummyController
+    def create
+      dummy(:create)
+    end
+
+    def destroy
+      dummy(:destroy)
+    end
+  end
+end

data/spec/dummy/app/controllers/api/groups_controller.rb

@@ -0,0 +1,15 @@
+module Api
+  class GroupsController < DummyController
+    def create
+      dummy(:create)
+    end
+
+    def update
+      dummy(:update)
+    end
+
+    def destroy
+      dummy(:destroy)
+    end
+  end
+end

data/spec/dummy/app/controllers/api/users_controller.rb

@@ -3,5 +3,9 @@ module Api
     def index
       dummy(:index)
     end
+
+    def update
+      dummy(:update)
+    end
   end
 end

data/spec/dummy/app/models/ownership.rb

@@ -0,0 +1,7 @@
+class Ownership < ActiveRecord::Base
+
+  belongs_to :owner, polymorphic: true
+
+  validates :owner, presence: true
+
+end

data/spec/dummy/app/models/user.rb

@@ -1,10 +1,13 @@
 class User < ActiveRecord::Base
-  belongs_to :openstax_accounts_account, 
-             class_name: "OpenStax::Accounts::Account",
-             dependent: :destroy
+
+  belongs_to :account, 
+             class_name: "OpenStax::Accounts::Account"
+  has_many :groups_as_member, through: :account
+  has_many_through_groups :groups_as_member, :ownerships,
+                          as: :owner, dependent: :destroy
 
   delegate :username, :first_name, :last_name, :full_name, :title,
-           :name, :casual_name, to: :openstax_accounts_account
+           :name, :casual_name, to: :account
 
   def is_anonymous?
     false
@@ -12,15 +15,15 @@ class User < ActiveRecord::Base
 
   # OpenStax Accounts "account_user_mapper" methods
 
-  def self.account_to_user(account)
-    account.is_anonymous? ? \
+  def self.account_to_user(acc)
+    acc.is_anonymous? ? \
       AnonymousUser.instance : \
-      User.where(:openstax_accounts_account_id => account.id).first
+      User.where(:account_id => acc.id).first
   end
 
   def self.user_to_account(user)
     user.is_anonymous? ? \
       AnonymousAccount.instance : \
-      user.openstax_accounts_account
+      user.account
   end
 end

data/spec/dummy/config/application.rb

@@ -11,16 +11,6 @@ module Dummy
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
 
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
     # config.time_zone = 'Central Time (US & Canada)'
@@ -28,29 +18,6 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
-
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
-
-    # Enable escaping HTML in JSON.
-    config.active_support.escape_html_entities_in_json = true
-
-    # Use SQL instead of Active Record's schema dumper when creating the database.
-    # This is necessary if your schema can't be completely dumped by the schema dumper,
-    # like if you have constraints or database-specific column types
-    # config.active_record.schema_format = :sql
-
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
-
-    # Suppress warning
-    config.i18n.enforce_available_locales = true
   end
 end
 

data/spec/dummy/config/boot.rb

@@ -1,10 +1,5 @@
-require 'rubygems'
-gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 
-if File.exist?(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler'
-  Bundler.setup
-end
-
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)