Class: OpenStax::Accounts::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/openstax/accounts/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/openstax/accounts/configuration.rb', line 56

def initialize
  @openstax_application_id = 'SET ME!'
  @openstax_application_secret = 'SET ME!'
  @openstax_accounts_url = 'https://accounts.openstax.org/'
  @enable_stubbing = true
  @logout_via = :get
  @default_errors_partial = 'openstax/accounts/shared/attention'
  @default_errors_html_id = 'openstax-accounts-attention'
  @default_errors_added_trigger = 'openstax-accounts-errors-added'
  @security_transgression_exception = SecurityTransgression
  @account_user_mapper = OpenStax::Accounts::DefaultAccountUserMapper
  @min_search_characters = 3
  @max_search_items = 10
  super
end

Instance Attribute Details

#account_user_mapper ⇒ Object

account_user_mapper This class teaches the gem how to convert between accounts and users See the “account_user_mapper” discussion in the README



36
37
38
 
# File 'lib/openstax/accounts/configuration.rb', line 36

def 
  @account_user_mapper
end

#default_errors_added_trigger ⇒ Object

Returns the value of attribute default_errors_added_trigger.



27
28
29
 
# File 'lib/openstax/accounts/configuration.rb', line 27

def default_errors_added_trigger
  @default_errors_added_trigger
end

#default_errors_html_id ⇒ Object

Returns the value of attribute default_errors_html_id.



26
27
28
 
# File 'lib/openstax/accounts/configuration.rb', line 26

def default_errors_html_id
  @default_errors_html_id
end

#default_errors_partial ⇒ Object

Returns the value of attribute default_errors_partial.



25
26
27
 
# File 'lib/openstax/accounts/configuration.rb', line 25

def default_errors_partial
  @default_errors_partial
end

#enable_stubbing ⇒ Object

enable_stubbing Set to true if you want this engine to fake all interaction with the accounts site.



19
20
21
 
# File 'lib/openstax/accounts/configuration.rb', line 19

def enable_stubbing
  @enable_stubbing
end

#logout_via ⇒ Object

logout_via HTTP method to accept for logout requests



23
24
25
 
# File 'lib/openstax/accounts/configuration.rb', line 23

def logout_via
  @logout_via
end

#max_search_items ⇒ Object

max_search_items The maximum number of accounts that can be returned in a call to the AccountsSearch handler If more would be returned, the result will be empty instead



48
49
50
 
# File 'lib/openstax/accounts/configuration.rb', line 48

def max_search_items
  @max_search_items
end

#min_search_characters ⇒ Object

min_search_characters The minimum number of characters that can be used as a query in a call to the AccountsSearch handler If less are used, the handler will return an error instead



42
43
44
 
# File 'lib/openstax/accounts/configuration.rb', line 42

def min_search_characters
  @min_search_characters
end

#openstax_accounts_url ⇒ Object

openstax_accounts_url Base URL for OpenStax Accounts



6
7
8
 
# File 'lib/openstax/accounts/configuration.rb', line 6

def openstax_accounts_url
  @openstax_accounts_url
end

#openstax_application_id ⇒ Object

openstax_application_id OAuth client_id received from OpenStax Accounts



10
11
12
 
# File 'lib/openstax/accounts/configuration.rb', line 10

def openstax_application_id
  @openstax_application_id
end

#openstax_application_secret ⇒ Object

openstax_application_secret OAuth client_secret received from OpenStax Accounts



14
15
16
 
# File 'lib/openstax/accounts/configuration.rb', line 14

def openstax_application_secret
  @openstax_application_secret
end

#security_transgression_exception ⇒ Object

security_transgression_exception Class to be used for security transgression exceptions



31
32
33
 
# File 'lib/openstax/accounts/configuration.rb', line 31

def security_transgression_exception
  @security_transgression_exception
end

Instance Method Details

#enable_stubbing? ⇒ Boolean

Returns:

  • (Boolean) 


72
73
74
 
# File 'lib/openstax/accounts/configuration.rb', line 72

def enable_stubbing?
  !Rails.env.production? && enable_stubbing
end