openstax_accounts 0.3.0 → 1.0.0

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

@@ -0,0 +1,44 @@
+# Routine for getting user updates from Accounts
+#
+# Should be scheduled to run regularly
+
+module OpenStax
+  module Accounts
+
+    class SyncUsers
+
+      SYNC_ATTRIBUTES = ['username', 'first_name', 'last_name',
+                         'full_name', 'title']
+
+      lev_routine transaction: :no_transaction
+      
+      protected
+      
+      def exec(options={})
+
+        return if OpenStax::Accounts.configuration.enable_stubbing?
+
+        response = OpenStax::Accounts.application_users_updates
+
+        app_users = []
+        app_users_rep = OpenStax::Accounts::Api::V1::ApplicationUsersRepresenter.new(app_users)
+        app_users_rep.from_json(response.body)
+
+        return if app_users.empty?
+
+        app_users_hash = {}
+        app_users.each do |app_user|
+          user = OpenStax::Accounts::User.where(:openstax_uid => app_user.user.openstax_uid).first
+          user.updating_from_accounts = true
+          next unless user.update_attributes(app_user.user.attributes.slice(*SYNC_ATTRIBUTES))
+          app_users_hash[app_user.id] = app_user.unread_updates
+        end
+
+        OpenStax::Accounts.application_users_updated(app_users_hash)
+
+      end
+
+    end
+
+  end
+end

data/app/views/openstax/accounts/dev/users/_search_results.html.erb

@@ -0,0 +1,50 @@
+<%
+  page = @handler_result.outputs[:page]
+  num_users = @handler_result.outputs[:num_matching_users]
+  per_page = @handler_result.outputs[:per_page]
+  pages = (num_users * 1.0 / per_page).ceil
+  users = @handler_result.outputs[:users]
+%>
+
+<div id='search-results-pagination'>
+  <%= pluralize(num_users, 'user') %> found. 
+
+  <% if pages > 0 %>
+    Page: 
+
+    <% 
+      linked_page_numbers = [page+1]
+      linked_page_numbers.push(1)
+      linked_page_numbers.push(pages)
+      linked_page_numbers.push(page+1-1, page+1-2, page+1+1, page+1+2)
+      linked_page_numbers.reject!{|pp| pp < 1 || pp > pages}
+      linked_page_numbers.uniq!
+      linked_page_numbers.sort!
+    %>
+
+    <% linked_page_numbers.each do |lpn| %>
+      <%= link_to_unless lpn == page + 1,
+                         lpn, 
+                         dev_users_path(search: {terms: @handler_result.outputs[:query], page: lpn-1, per_page: per_page}), remote: true %>
+    <% end %>
+  <% end %>
+</div>
+
+<%= osu.action_list(
+    records: users,
+    list: {
+      headings: ['Username', 'First Name', 'Last Name', ''],
+      widths: ['25%', '25%', '25%', '25%'],
+      data_procs:
+        [
+          Proc.new { |user| user.username },
+          Proc.new { |user| user.first_name || '---' },
+          Proc.new { |user| user.last_name || '---' },
+          Proc.new { |user| 
+            link_to 'Sign in as', 
+                    become_dev_user_path(user), 
+                    method: :post 
+          }
+        ]
+    }
+  ) %>

data/app/views/openstax/accounts/dev/users/index.js.erb

@@ -0,0 +1,3 @@
+<%= unless_errors alerts_html_id: 'dialog-local-alerts' do %>
+  $("#search-results-list").html("<%= j(render 'openstax/accounts/dev/users/search_results') %>");
+<% end %>

data/app/views/openstax/accounts/dev/users/login.html.erb

@@ -1,4 +1,3 @@
-
 <div class="openstax-accounts development-login">
 
   <% handler_errors.each do |error| %>
@@ -7,11 +6,13 @@
 
   <%= osu.section_block "Development Login" do %>
 
-    <p>You need to login, but we're not connected to the Accounts server. Search for a user below 
-       and click the sign in link next to him or her.</p>
+    <p>You need to login, but we're not connected to the Accounts server.
+    Search for a user below and click the sign in link next to him or her.</p>
 
-    <%= render 'openstax/accounts/users/action_search', action_search_path: search_dev_users_path %>
+    <%= render 'openstax/accounts/shared/users/index',
+               :search_action_path => openstax_accounts.dev_users_path,
+               :remote => true %>
 
   <% end %>
 
-</div>
+</div>

data/app/views/openstax/accounts/shared/_attention.html.erb

@@ -1,3 +1,3 @@
 <% handler_errors.each do |error| %>
   <%= error.translate %>
-<% end %>
+<% end %>

data/app/views/openstax/accounts/shared/users/_index.html.erb

@@ -0,0 +1,24 @@
+<%
+   # Clients of this partial can override the following variables:
+   search_action_path ||= nil
+   remote ||= false
+   form_html ||=  {id: 'search-form',
+                   class: 'form-inline'}
+   search_types ||= ['Any', 'Username', 'Email']
+%>
+
+<%= lev_form_for :search,
+                 url: search_action_path,
+                 remote: remote,
+                 html: form_html do |f| %>
+
+  Search for 
+  <%= f.search_field :terms, style: 'width:300px' %> 
+  in         
+  <%= f.select :type, search_types, {}, {style: 'width: 150px'} %>
+
+  <%= f.submit 'Search', class: 'btn btn-primary' %>
+
+<% end %>
+
+<div id="search-results-list"></div>

data/config/routes.rb

@@ -1,5 +1,5 @@
 OpenStax::Accounts::Engine.routes.draw do
-  match '/auth/openstax/callback', to: 'sessions#omniauth_authenticated' #omniauth route
+  get '/auth/openstax/callback', to: 'sessions#omniauth_authenticated' #omniauth route
   get '/auth/openstax', :as => 'openstax_login'
 
   get 'sessions/new', :as => 'login'
@@ -9,12 +9,13 @@ OpenStax::Accounts::Engine.routes.draw do
 
   if OpenStax::Accounts.configuration.enable_stubbing?
     namespace :dev do
-      resources :users, :only => [] do
+      resources :users, :only => [:index] do
         collection do
           get 'login'
-          post 'search'
-          post 'become'
+          post 'index'
         end
+
+        post 'become', :on => :member
       end
     end
   end

data/lib/generators/openstax/accounts/schedule/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a "whenever" task that checks for updates from Accounts.
+
+Example:
+    rails generate openstax:accounts:schedule
+
+    This will create or append to:
+        config/schedule.rb

data/lib/generators/openstax/accounts/schedule/schedule_generator.rb

@@ -0,0 +1,18 @@
+# Can't use OpenStax. See https://github.com/rails/rails/issues/13856
+module Openstax
+  module Accounts
+    class ScheduleGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_schedule
+        if File.exists?(File.expand_path('config/schedule.rb'))
+          File.open(File.expand_path('../templates/schedule.rb', __FILE__)) do |file|
+            append_file 'config/schedule.rb', file.read
+          end
+        else
+          copy_file 'schedule.rb', 'config/schedule.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/openstax/accounts/schedule/templates/schedule.rb

@@ -0,0 +1,3 @@
+every 5.minutes do
+  runner "OpenStax::Accounts::SyncUsers.call"
+end

data/lib/omniauth/strategies/openstax.rb

@@ -32,7 +32,7 @@ module OmniAuth
       end
 
       def raw_info
-        @raw_info ||= access_token.get('/api/users/me.json').parsed
+        @raw_info ||= access_token.get('/api/user.json').parsed
       end
     end
   end

data/lib/openstax/accounts/engine.rb

@@ -3,6 +3,8 @@ require 'omniauth/strategies/openstax'
 require 'lev'
 require 'roar/decorator'
 require 'roar/representer/json'
+require 'keyword_search'
+require 'squeel'
 
 ActiveSupport::Inflector.inflections do |inflect|
   inflect.acronym 'OpenStax'

data/lib/openstax/accounts/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Accounts
-    VERSION = "0.3.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/openstax_accounts.rb

@@ -6,12 +6,14 @@ require 'openstax/accounts/user_provider'
 require 'openstax/accounts/current_user_manager'
 
 require 'openstax_utilities'
-require 'uri'
 require 'oauth2'
+require 'uri'
 
 module OpenStax
   module Accounts
 
+    DEFAULT_API_VERSION = :v1
+
     class << self
 
       ###########################################################################
@@ -27,9 +29,6 @@ module OpenStax
       #     ...
       #   end
       #
-      # Set enable_stubbing to true iff you want this engine to fake all 
-      #   interaction with the accounts site.
-      #
       
       def configure
         yield configuration
@@ -40,26 +39,50 @@ module OpenStax
       end
 
       class Configuration
+        # openstax_accounts_url
+        # Base URL for OpenStax Accounts
+        attr_reader :openstax_accounts_url
+
+        # openstax_application_id
+        # OAuth client_id received from OpenStax Accounts
         attr_accessor :openstax_application_id
+
+        # openstax_application_secret
+        # OAuth client_secret received from OpenStax Accounts
         attr_accessor :openstax_application_secret
+
+        # enable_stubbing
+        # Set to true if you want this engine to fake all
+        # interaction with the accounts site.
         attr_accessor :enable_stubbing
-        attr_reader :openstax_accounts_url
+
+        # logout_via
+        # HTTP method to accept for logout requests
         attr_accessor :logout_via
+
         attr_accessor :default_errors_partial
         attr_accessor :default_errors_html_id
         attr_accessor :default_errors_added_trigger
+
+        # security_transgression_exception
+        # Class to be used for security transgression exceptions
         attr_accessor :security_transgression_exception
 
-        # See the "user_provider" discussion in the README 
+        # See the "user_provider" discussion in the README
         attr_accessor :user_provider
 
+        # The maximum number of users that can be returned in a call to SearchUsers
+        # If more would be returned, the result will be empty instead
+        # Can also be passed directly to SearchUsers
+        attr_accessor :max_matching_users
+
         def openstax_accounts_url=(url)
           url.gsub!(/https|http/,'https') if !(url =~ /localhost/)
           url = url + "/" if url[url.size-1] != '/'
           @openstax_accounts_url = url
         end
 
-        def initialize      
+        def initialize
           @openstax_application_id = 'SET ME!'
           @openstax_application_secret = 'SET ME!'
           @openstax_accounts_url = 'https://accounts.openstax.org/'
@@ -70,6 +93,7 @@ module OpenStax
           @default_errors_added_trigger = 'openstax-accounts-errors-added'
           @security_transgression_exception = SecurityTransgression
           @user_provider = OpenStax::Accounts::UserProvider
+          @max_matching_users = 10
           super
         end
 
@@ -96,43 +120,62 @@ module OpenStax
 
         token_string = options.delete(:access_token)
         token = token_string.blank? ? client.client_credentials.get_token :
-                OAuth2::AccessToken.new(client, token_string)
+                  OAuth2::AccessToken.new(client, token_string)
 
         api_url = URI.join(configuration.openstax_accounts_url, 'api/', url)
 
         token.request(http_method, api_url, options)
       end
 
-      # Creates an ApplicationUser in Accounts for the configured app
-      # and the given OpenStax::Accounts::User.
-      # Also takes an optional API version parameter. Defaults to :v1.
+      # Performs an ApplicationUser search in Accounts for the configured app.
+      # Takes a query parameter and 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_application_user(user, version = :v1)
-        options = {:access_token => user.access_token,
+      def application_users_index(query, version = DEFAULT_API_VERSION)
+        options = {:params => {:q => query},
                    :api_version => version}
-        api_call(:post, 'application_users', options)
+        api_call(:get, 'application_users', options)
       end
 
-      # Performs a user search in Accounts for the configured app.
-      # Takes a query parameter and an optional API version parameter.
-      # API version currently defaults to :v1.
+      # Retrieves information about ApplicationUsers that have been recently updated.
       # On failure, throws an Exception, just like api_call.
       # On success, returns an OAuth2::Response object.
-      def user_search(query, version = :v1)
-        options = {:params => {:q => query},
-                   :api_version => version}
-        api_call(:get, 'users/search', options)
+      def application_users_updates(version = DEFAULT_API_VERSION)
+        options = {:api_version => version}
+        api_call(:get, 'application_users/updates', options)
+      end
+
+      # Marks ApplicationUser updates as "read".
+      # The app_users parameter is a hash that maps ApplicationUser
+      # openstax_uid's to the value of the last received unread_updates.
+      # On failure, throws an Exception, just like api_call.
+      # On success, returns an OAuth2::Response object.
+      def application_users_updated(app_users, version = DEFAULT_API_VERSION)
+        options = {:api_version => version,
+                   :body => {:application_users => app_users}}
+        api_call(:put, 'application_users/updated', options)
+      end
+
+      # Updates an OpenStax::Accounts::User in Accounts for the configured app.
+      # 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 user_update(user, version = DEFAULT_API_VERSION)
+        options = {:access_token => user.access_token,
+                   :api_version => version,
+                   :body => user.attributes.slice('username', 'first_name',
+                              'last_name', 'full_name', 'title').to_json}
+        api_call(:put, 'user', options)
       end
 
-    protected
+      protected
 
       def client
-        @client ||= OAuth2::Client.new(
-                      configuration.openstax_application_id,
+        @client ||= OAuth2::Client.new(configuration.openstax_application_id,
                       configuration.openstax_application_secret,
-                      :site => configuration.openstax_accounts_url
-                    )
+                      :site => configuration.openstax_accounts_url)
       end
 
     end

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

@@ -5,13 +5,14 @@ module OpenStax::Accounts
     describe UsersController do
       routes { OpenStax::Accounts::Engine.routes }
 
-      let!(:user) { OpenStax::Accounts::User.create(username: 'some_user',
-                                                    openstax_uid: 1) }
+      let!(:user) { user = FactoryGirl.create :openstax_accounts_user,
+                                              username: 'some_user',
+                                              openstax_uid: 10 }
 
       it 'should allow users not in production to become other users' do
         expect(controller.current_user).to eq(OpenStax::Accounts::User.anonymous)
         expect(controller.current_user.is_anonymous?).to eq(true)
-        get :become, user_id: user.id
+        post :become, id: user.id
         expect(controller.current_user).to eq(user)
         expect(controller.current_user.is_anonymous?).to eq(false)
       end

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

@@ -1,7 +1,19 @@
 module Api
   class ApplicationUsersController < DummyController
+    def index
+      dummy(:index)
+    end
+
     def create
       dummy(:create)
     end
+
+    def updates
+      dummy(:updates)
+    end
+
+    def updated
+      dummy(:updated)
+    end
   end
 end