openstax_accounts 1.0.0 → 2.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mjc2YjE2MDk2NTlkODU2NWVkNjJhYjAzZjY2MzRiZmMxOTRmZDNkZg==
+    ZmE5M2NiMTk1MWUzMTg1OTY1MDA5MzVjMGExNzEwMmVlMDY2NTFiMA==
   data.tar.gz: !binary |-
-    NzZmMzllNDRiODQ1MWVhMmRjMWNmYWYxYzc4ODUzZjNiMjkyZWFlNA==
+    MmMwMGI2MTRkYTkzZDg2NTlhZmE2Njc5NjZjOTgyMTUyNDJkZDU5MA==
 SHA512:
   metadata.gz: !binary |-
-    YzgxYzZkMjI5NDc5NTk3ZjQyOGFjMDVjYThiNDg4NDY2MTM1MWRlZTI4YTQ2
-    NDE2MzVkNDc4YzI1ODNkMDQ3ZWU0YjFkNmQxZmY5YWU2YTQzM2VmZjI4Zjk0
-    MWI1MzkyMzQ0NzA1MmQxMGZkYjFiZmRlOGI4NDczYzc5ZjVlMjc=
+    NmZhOWE1OTA5Y2U5M2ViZTJlNzQzMjNjYmUwM2FkMmFlNTczNDU5ZDVmZmEz
+    NjFmNmI4NGU4OGRiNDE2OTI2ZDRhYTdiNjFlMjc1NTA3ZWFiM2E4NWM4OTY3
+    YTZhZTVlYjVjODhkY2YzMmYxZGRhZWQxNmM1YmUyNzE0MmJhOGE=
   data.tar.gz: !binary |-
-    ODRkZDMzMDEwNGQwNTRhYjU5NzkwODU5YzljZGE4YzhiZWUwNDkzMzkwMWMx
-    ZmEwMmNlYTUzZDVjY2VhYzg5MWJiNzJkZjcwYjQ3MjVmZjE0ZTAwOGJjOWRl
-    MTE5ODIxN2NjYTY1MzFiZjI5NjNjMjE4ZTIwNTBlNzI5N2RlNDM=
+    NmJiODkwZGVjZTRlNzZmNGMwNDJmNWJkMTE1ZTE2MjQzNDc2YWM5YjRmYzlk
+    MjVjODkyYTNmNDZmMjQ4NTQyMDliY2YxYmY4MWNhMmY4NzA1OTcwMzNlNmFm
+    YTQwOTQxOWE5Y2NlYzJiMmQ2ZDdjYjBkYTZkOTg1ZTIxZTc2YTU=

data/README.md

@@ -6,82 +6,115 @@ accounts-rails
 
 A rails engine for interfacing with OpenStax's accounts server.
 
+Installation
+------------
+
+Make sure to install the engine's migrations:
+
+```sh
+$ rake openstax_accounts:install:migrations
+```
+
 Usage
 -----
 
-Add the engine to your Gemfile and then run `bundle install`.  
+Add the engine to your Gemfile and then run `bundle install`.
 
 Mount the engine your application's `routes.rb` file:
 
-    MyApplication::Application.routes.draw do
-      ...
-      mount OpenStax::Accounts::Engine, at: "/accounts"
-      ...
-     end
+```rb
+  MyApplication::Application.routes.draw do
+    # ...
+    mount OpenStax::Accounts::Engine, at: "/accounts"
+    # ...
+  end
+```
 
-You can use whatever path you want instead of `/accounts`, just make sure to make the appropriate changes below.
+You can use whatever path you want instead of `/accounts`,
+just make sure to make the appropriate changes below.
 
-Create an `openstax_accounts.rb` initializer in `config/initializers`, with the following contents:
+Create an `openstax_accounts.rb` initializer in `config/initializers`,
+with at least the following contents:
 
-    OpenStax::Accounts.configure do |config|
-      config.openstax_application_id = 'value_from_openstax_accounts_here'
-      config.openstax_application_secret = 'value_from_openstax_accounts_here'
-    end
+```rb
+OpenStax::Accounts.configure do |config|
+  config.openstax_application_id = 'value_from_openstax_accounts_here'
+  config.openstax_application_secret = 'value_from_openstax_accounts_here'
+end
+```
+
+If you're running the OpenStax Accounts server in a dev instance on your
+machine, you can specify that instance's local URL with:
 
-If you're running OpenStax Accounts in a dev instance on your machine, you can specify that instance's local URL with:
+```rb
+config.openstax_accounts_url = 'http://localhost:2999/'
+```
+
+To have users login, direct them to the login path using the
+`openstax_accounts.login_path` route helper with Action Interceptor, e.g:
+
+```erb
+<%= link_to 'Sign in!', with_interceptor { openstax_accounts.login_path } %>
+```
 
-    config.openstax_accounts_url = 'http://localhost:2999/'
+The `with_interceptor` block is necessary if you don't want to
+depend on the user's browser setting referers properly.
 
-To have users login, direct them to `/accounts/sessions/new`.  This is also available through the `openstax_accounts.login` route helper, e.g. `<%= link_to 'Sign in!', openstax_accounts.login_path %>`.
+You can also add the `authenticate_user!` interceptor to your controllers:
 
-There is also a logout path helper for `/accounts/sessions/destroy`, given by `logout_path`.  By default this expects a `GET` request.  If you'd prefer a `DELETE` request, add this configuration:
+```rb
+interceptor :authenticate_user!
+```
 
-    config.logout_via = :delete
+There is also a logout path helper, given by `logout_path`.
+By default this expects a `GET` request.
+If you'd prefer a `DELETE` request, add this configuration:
 
-OpenStax Accounts provides you with an `OpenStax::Accounts::User` object.  You can
-use this as your app's User object without modification, you can modify it to suit
-your app's needs (not recommended), or you can provide your own custom User object
-that references the OpenStax Accounts User object.  
+```rb
+config.logout_via = :delete
+```
 
-OpenStax Accounts also provides you methods for getting and setting the current 
-signed in user (`current_user` and `current_user=` methods).  If you choose to create 
-your own custom User object that references the User object provided by Accounts, 
-you can teach OpenStax Accounts how to translate between your app's custom User 
-object and OpenStax Accounts's built-in User object.
+OpenStax Accounts provides you with an `OpenStax::Accounts::Account` object.
+You can modify it and use this as your app's User object (not recommended),
+or you can provide your own custom user object that references one account.
 
-To do this, you need to set a `user_provider` in this configuration.  
+OpenStax Accounts also provides you methods for getting and setting the current
+signed in user (`current_user` and `current_user=` methods).  If you choose to
+create your own custom user object, you can teach this gem how to translate
+between a user object and an account object.
 
-    config.user_provider = MyUserProvider
+To do this, you need to set a `account_user_mapper` in this configuration.  
 
-The user_provider is a class that provides two class methods:
+    config.account_user_mapper = MyAccountUserMapper
 
-    def self.accounts_user_to_app_user(accounts_user)
-      # Converts the given accounts user to an app user.
-      # If you want to cache the accounts_user in the app user,
+The account_user_mapper is a class that provides two class methods:
+
+    def self.account_to_user(account)
+      # Converts the given account to a user.
+      # If you want to cache the account in the user,
       # this is the place to do it.
-      # If no app user exists for this accounts user, one should
+      # If no user exists for this account, one should
       # be created.
     end
   
-    def self.app_user_to_accounts_user(app_user)
-      # Converts the given app user to an accounts user.
+    def self.user_to_account(user)
+      # Converts the given user to an account.
     end 
 
-Accounts users are never nil.  When a user is signed out, the current accounts user 
-is an anonymous user (responding true to `is_anonymous?`).  You can follow the same
-pattern in your app or you can use nil for the current user.  Just remember to check
-the anonymous status of accounts users when doing your accounts <-> app translations.
-
-The default `user_provider` just uses OpenStax::Accounts::User as the app user.
+Accounts are never nil. When a user is signed out, the current account is the
+AnonymousAccount (responding true to `is_anonymous?`). You can follow the same
+pattern in your app or you can use nil for the current user. Just remember to
+check the anonymous status of accounts when doing your account <-> user
+translations.
 
-Make sure to install the engine's migrations:
-
-    rake openstax_accounts:install:migrations
+The default `account_user_mapper` assumes the account object and
+the user object are the same in your application.
 
 Syncing with Accounts
 ---------------------
 
-OpenStax::Accounts requires your app to periodically sync user information with the Accounts server. The easiest way to do this is to use the "whenever" gem.
+OpenStax Accounts requires your app to periodically sync user information with
+the Accounts server. The easiest way to do this is to use the "whenever" gem.
 
 To create or append to the schedule.rb file, run the following command:
 
@@ -89,7 +122,8 @@ To create or append to the schedule.rb file, run the following command:
 rails g openstax:accounts:schedule
 ```
 
-Then, after installing the "whenever" gem, run the `whenever` command for instructions to set up your crontab:
+Then, after installing the "whenever" gem, run the `whenever` command for
+instructions to set up your crontab:
 
 ```sh
 whenever
@@ -98,19 +132,16 @@ whenever
 Accounts API
 ------------
 
-OpenStax::Accounts provides convenience methods for accessing the OpenStax Accounts API.
-
-`OpenStax:: Accounts.create_application_user(accounts_user, version = nil)` takes
-an OpenStax::Accounts::User and, optionally, an API version argument, and creates
-an ApplicationUser for the configured application and the given user. Call this method
-when users finish the registration process in your app. This lets Accounts know that the given user is using your app, allowing Accounts to push user information to it whenever it changes.
+OpenStax Accounts provides convenience methods for accessing
+the Accounts server API.
 
-`OpenStax::Accounts.api_call(http_method, url, options = {})` provides a generic
-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 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).
+`OpenStax::Accounts.api_call(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
+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).
 
 Example Application
 -------------------

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

@@ -2,21 +2,12 @@ module OpenStax
   module Accounts
 
     class ApplicationController < ActionController::Base
-      include Lev::HandleWith
 
-      # Override current_user to always return an OpenStax::Accounts::User
-      def current_user
-        current_user_manager.accounts_current_user
-      end
+      include Lev::HandleWith
 
-    protected
+      acts_as_interceptor :override_url_options => false
 
-      def return_url(include_referrer=false)
-        referrer = include_referrer ? request.referrer : nil
-        # Always clear the session
-        session_return_to = session.delete(:return_to)
-        params[:return_to] || session_return_to || referrer || main_app.root_url
-      end
+      skip_interceptor :authenticate_user!
 
     end
 

data/app/controllers/openstax/accounts/dev/accounts_controller.rb

@@ -0,0 +1,19 @@
+module OpenStax
+  module Accounts
+    module Dev
+      class AccountsController < OpenStax::Accounts::Dev::BaseController
+
+        def index
+          handle_with(AccountsIndex)
+        end
+
+        def become
+          @account = Account.find(params[:id])
+          sign_in(@account)
+          redirect_back
+        end
+
+      end
+    end
+  end
+end

data/app/controllers/openstax/accounts/dev/base_controller.rb

@@ -3,15 +3,9 @@ module OpenStax
     module Dev
       class BaseController < OpenStax::Accounts::ApplicationController
 
-        before_filter Proc.new{
+        before_filter do
           raise SecurityTransgression if Rails.env.production?
-        }
-
-        skip_before_filter :authenticate_user!
-        skip_before_filter :require_registration!
-
-        fine_print_skip_signatures :general_terms_of_use, :privacy_policy \
-          if respond_to?(:fine_print_skip_signatures)
+        end
 
       end
     end

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

@@ -3,20 +3,23 @@ module OpenStax
     class SessionsController < OpenStax::Accounts::ApplicationController
 
       def new
-        session[:return_to] ||= request.referrer
-        redirect_to RouteHelper.get_path(:login)
+        if OpenStax::Accounts.configuration.enable_stubbing?
+          with_interceptor { redirect_to dev_accounts_path }
+        else
+          redirect_to openstax_login_path
+        end
       end
 
-      def omniauth_authenticated
-        handle_with(SessionsOmniauthAuthenticated,
-                    success: lambda {
-                      sign_in(@handler_result.outputs[:accounts_user_to_sign_in])
-                      # referrer is in Accounts, so don't include it
-                      redirect_to return_url
-                    },
-                    failure: lambda {
-                      failure
-                    })
+      def callback
+        handle_with(
+          SessionsCallback,
+            success: lambda {
+              sign_in(@handler_result.outputs[:account])
+              redirect_back
+            },
+            failure: lambda {
+              failure
+            })
       end
 
       def destroy
@@ -24,16 +27,25 @@ module OpenStax
 
         # If we're using the Accounts server, need to sign out of it so can't 
         # log back in automagically
-        redirect_to OpenStax::Accounts.configuration.enable_stubbing? ?
-                      return_url :
-                      OpenStax::Utilities.generate_url(
-                        OpenStax::Accounts.configuration.openstax_accounts_url + "/logout",
-                        return_to: return_url
-                      )
+        if OpenStax::Accounts.configuration.enable_stubbing?
+          redirect_back
+        else
+          without_interceptor do
+
+            redirect_to(
+              OpenStax::Utilities.generate_url(
+                OpenStax::Accounts.configuration.openstax_accounts_url,
+                "logout",
+                return_to: intercepted_url
+              )
+            )
+
+          end
+        end
       end
 
       def failure
-        redirect_to return_url, alert: "Authentication failed, please try again."
+        redirect_back alert: "Authentication failed, please try again."
       end
 
     end

data/app/handlers/openstax/accounts/dev/{users_index.rb → accounts_index.rb}

@@ -1,7 +1,7 @@
 module OpenStax
   module Accounts
     module Dev
-      class UsersIndex
+      class AccountsIndex
 
         lev_handler transaction: :no_transaction
 
@@ -11,8 +11,8 @@ module OpenStax
           attribute :page, type: Integer
         end
 
-        uses_routine OpenStax::Accounts::Dev::SearchUsers,
-                     as: :search_users,
+        uses_routine OpenStax::Accounts::Dev::SearchAccounts,
+                     as: :search_accounts,
                      translations: { outputs: {type: :verbatim} }
 
         protected
@@ -30,7 +30,7 @@ module OpenStax
           else
             query = search_params.terms || ''
           end
-          run(:search_users, query, page: search_params.page || 0)
+          run(:search_accounts, query, page: search_params.page || 0)
         end
 
       end

data/app/handlers/openstax/accounts/sessions_callback.rb

@@ -0,0 +1,43 @@
+module OpenStax
+  module Accounts
+
+    class SessionsCallback
+
+      lev_handler
+
+      protected
+
+      def setup
+        @auth_data = request.env['omniauth.auth']
+      end
+
+      def authorized?
+        @auth_data.provider == "openstax"
+      end
+
+      def handle
+        # Don't worry if the account is logged in or not beforehand.
+        # Just assume that they aren't.
+
+        existing_account = Account.where(openstax_uid: @auth_data.uid).first
+        return outputs[:account] = existing_account if !existing_account.nil?
+
+        new_account = Account.create do |account|
+          account.openstax_uid = @auth_data.uid
+          account.username     = @auth_data.info.nickname
+          account.first_name   = @auth_data.info.first_name
+          account.last_name    = @auth_data.info.last_name
+          account.full_name    = @auth_data.info.name
+          account.title        = @auth_data.info.title
+          account.access_token = @auth_data.credentials.token
+        end
+
+        transfer_errors_from(new_account, {type: :verbatim})
+
+        outputs[:account] = new_account
+      end
+
+    end
+
+  end
+end

data/app/models/openstax/accounts/{user.rb → account.rb}

@@ -1,14 +1,15 @@
 module OpenStax
   module Accounts
-    class User < ActiveRecord::Base
+    class Account < ActiveRecord::Base
 
       USERNAME_DISCARDED_CHAR_REGEX = /[^A-Za-z\d_]/
       USERNAME_MAX_LENGTH = 50
 
-      attr_accessor :updating_from_accounts
+      attr_accessor :syncing_with_accounts
 
       validates :username, uniqueness: true, presence: true
-      validates :openstax_uid, presence: true
+      validates :openstax_uid, uniqueness: true, presence: true
+      validates :access_token, uniqueness: true, allow_nil: true
 
       attr_accessible :username, :first_name, :last_name, :full_name, :title
 
@@ -23,30 +24,14 @@ module OpenStax
       end    
 
       def is_anonymous?
-        is_anonymous == true
-      end
-
-      attr_accessor :is_anonymous
-
-      def self.anonymous
-        @@anonymous ||= AnonymousUser.new
+        false
       end
 
       def update_openstax_accounts
-        return if updating_from_accounts || \
+        return if syncing_with_accounts || \
                   OpenStax::Accounts.configuration.enable_stubbing?
-        OpenStax::Accounts.user_update(self)
-      end
 
-      class AnonymousUser < User
-        before_save { false } 
-        def initialize(attributes=nil)
-          super
-          self.is_anonymous = true
-          self.first_name   = 'Guest'
-          self.last_name    = 'User'
-          self.openstax_uid = nil
-        end
+        OpenStax::Accounts.update_account(self)
       end
 
     end

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

@@ -0,0 +1,24 @@
+module OpenStax
+  module Accounts
+    class AnonymousAccount < Account
+
+      include Singleton
+
+      before_save { false }
+
+      def initialize(attributes=nil)
+        super
+        self.id           = nil
+        self.openstax_uid = nil
+        self.username     = 'anonymous'
+        self.first_name   = 'Guest'
+        self.last_name    = 'User'
+      end
+
+      def is_anonymous?
+        true
+      end
+
+    end
+  end
+end

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

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

data/app/representers/openstax/accounts/api/v1/{user_representer.rb → account_representer.rb}

@@ -2,7 +2,7 @@ module OpenStax
   module Accounts
     module Api
       module V1
-        class UserRepresenter < Roar::Decorator
+        class AccountRepresenter < Roar::Decorator
           include Roar::Representer::JSON
 
           property :openstax_uid,

data/app/representers/openstax/accounts/api/v1/{user_search_representer.rb → account_search_representer.rb}

@@ -2,10 +2,11 @@ module OpenStax
   module Accounts
     module Api
       module V1
-        class UserSearchRepresenter < Roar::Decorator
+        class AccountSearchRepresenter < Roar::Decorator
           include Roar::Representer::JSON
 
-          property :num_matching_users,
+          property :num_matching_accounts,
+                   as: :num_matching_users,
                    type: Integer
 
           property :page,
@@ -17,10 +18,10 @@ module OpenStax
           property :order_by,
                    type: String
 
-
-          collection :users,
-                     class: OpenStax::Accounts::User,
-                     decorator: UserRepresenter
+          collection :accounts,
+                     as: :users,
+                     class: Account,
+                     decorator: AccountRepresenter
 
         end
       end

data/app/representers/openstax/accounts/api/v1/{application_user_representer.rb → application_account_representer.rb}

@@ -2,7 +2,7 @@ module OpenStax
   module Accounts
     module Api
       module V1
-        class ApplicationUserRepresenter < Roar::Decorator
+        class ApplicationAccountRepresenter < Roar::Decorator
           include Roar::Representer::JSON
 
           property :id, 
@@ -11,9 +11,10 @@ module OpenStax
           property :application_id,
                    type: Integer
 
-          property :user,
-                   class: OpenStax::Accounts::User,
-                   decorator: UserRepresenter
+          property :account,
+                   as: :user,
+                   class: OpenStax::Accounts::Account,
+                   decorator: AccountRepresenter
 
           property :unread_updates,
                    type: Integer

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

@@ -0,0 +1,20 @@
+module OpenStax
+  module Accounts
+    module Api
+      module V1
+        class ApplicationAccountSearchRepresenter < AccountSearchRepresenter
+
+          collection :application_accounts,
+                     as: :application_users,
+                     class: OpenStax::Accounts::ApplicationAccount,
+                     decorator: ApplicationAccountRepresenter,
+                     schema_info: {
+                       description: "The matching accounts that have used this app",
+                       minItems: 0
+                     }
+
+        end
+      end
+    end
+  end
+end

data/app/representers/openstax/accounts/api/v1/{application_users_representer.rb → application_accounts_representer.rb}

@@ -4,11 +4,11 @@ module OpenStax
   module Accounts
     module Api
       module V1
-        class ApplicationUsersRepresenter < Roar::Decorator
+        class ApplicationAccountsRepresenter < Roar::Decorator
           include Representable::JSON::Collection
 
-          items class: OpenStax::Accounts::ApplicationUser,
-                decorator: ApplicationUserRepresenter
+          items class: OpenStax::Accounts::ApplicationAccount,
+                decorator: ApplicationAccountRepresenter
         end
       end
     end

data/app/routines/openstax/accounts/dev/{search_users.rb → search_accounts.rb}

@@ -1,10 +1,10 @@
-# Routine for searching for users
+# Routine for searching for accounts
 #
 # Caller provides a query and some options.  The query follows the rules of
 # https://github.com/bruce/keyword_search, e.g.:
 #
-#   "username:jps,richb" --> returns the "jps" and "richb" users
-#   "name:John" --> returns Users with first, last, or full name starting with "John"
+#   "username:jps,richb" --> returns the "jps" and "richb" accounts
+#   "name:John" --> returns accounts with first, last, or full name starting with "John"
 #
 # Query terms can be combined, e.g. "username:jp first_name:john"
 #
@@ -16,9 +16,9 @@
 module OpenStax
   module Accounts
     module Dev
-      class SearchUsers < OpenStax::Accounts::SearchUsers
+      class SearchAccounts < OpenStax::Accounts::SearchAccounts
         def exec(query, options={})
-          options = options.merge!(:max_matching_users => Float::INFINITY)
+          options = options.merge!(:max_matching_accounts => Float::INFINITY)
           super
         end
       end