Module: ActiveRestClient::Configuration::ClassMethods
- Defined in:
- lib/active_rest_client/configuration.rb
Constant Summary collapse
- @@base_url =
nil
- @@username =
nil
- @@password =
nil
- @@request_body_type =
:form_encoded
- @@api_auth_access_id =
nil
- @@api_auth_secret_key =
nil
Instance Method Summary collapse
- #_reset_configuration! ⇒ Object
- #adapter ⇒ Object
- #adapter=(adapter) ⇒ Object
- #api_auth_access_id ⇒ Object
- #api_auth_credentials(access_id, secret_key) ⇒ Object
- #api_auth_secret_key ⇒ Object
- #base_url(value = nil) ⇒ Object
- #base_url=(value) ⇒ Object
- #faraday_config(&block) ⇒ Object
- #lazy_load! ⇒ Object
- #lazy_load? ⇒ Boolean
- #password(value = nil) ⇒ Object
- #password=(value) ⇒ Object
- #proxy(value = nil) ⇒ Object
- #request_body_type(value = nil) ⇒ Object
- #request_body_type=(value) ⇒ Object
- #translator(value = nil) ⇒ Object
- #username(value = nil) ⇒ Object
- #username=(value) ⇒ Object
- #using_api_auth? ⇒ Boolean
- #verbose(value = nil) ⇒ Object
- #verbose! ⇒ Object
- #whiny_missing(value = nil) ⇒ Object
Instance Method Details
#_reset_configuration! ⇒ Object
151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/active_rest_client/configuration.rb', line 151 def _reset_configuration! @base_url = nil @@base_url = nil @request_body_type = nil @@request_body_type = :form_encoded @whiny_missing = nil @lazy_load = false @faraday_config = default_faraday_config @adapter = :patron @@api_auth_access_id = nil @@api_auth_secret_key = nil end |
#adapter ⇒ Object
87 88 89 |
# File 'lib/active_rest_client/configuration.rb', line 87 def adapter @adapter ||= :patron end |
#adapter=(adapter) ⇒ Object
82 83 84 85 |
# File 'lib/active_rest_client/configuration.rb', line 82 def adapter=(adapter) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}" @adapter = adapter end |
#api_auth_access_id ⇒ Object
126 127 128 |
# File 'lib/active_rest_client/configuration.rb', line 126 def api_auth_access_id @@api_auth_access_id end |
#api_auth_credentials(access_id, secret_key) ⇒ Object
111 112 113 114 115 116 117 118 119 120 |
# File 'lib/active_rest_client/configuration.rb', line 111 def api_auth_credentials(access_id, secret_key) begin require 'api-auth' rescue LoadError raise MissingOptionalLibraryError.new("You must include the gem 'api-auth' in your Gemfile to set api-auth credentials.") end @@api_auth_access_id = access_id @@api_auth_secret_key = secret_key end |
#api_auth_secret_key ⇒ Object
130 131 132 |
# File 'lib/active_rest_client/configuration.rb', line 130 def api_auth_secret_key @@api_auth_secret_key end |
#base_url(value = nil) ⇒ Object
12 13 14 15 16 17 18 19 20 21 22 23 |
# File 'lib/active_rest_client/configuration.rb', line 12 def base_url(value = nil) if value.nil? if @base_url.nil? @@base_url else @base_url end else value = value.gsub(/\/$/, '') @base_url = value end end |
#base_url=(value) ⇒ Object
25 26 27 28 29 |
# File 'lib/active_rest_client/configuration.rb', line 25 def base_url=(value) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Base URL set to be #{value}" value = value.gsub(/\/+$/, '') @@base_url = value end |
#faraday_config(&block) ⇒ Object
91 92 93 94 95 96 97 |
# File 'lib/active_rest_client/configuration.rb', line 91 def faraday_config(&block) if block @faraday_config = block else @faraday_config ||= default_faraday_config end end |
#lazy_load! ⇒ Object
99 100 101 |
# File 'lib/active_rest_client/configuration.rb', line 99 def lazy_load! @lazy_load = true end |
#lazy_load? ⇒ Boolean
103 104 105 |
# File 'lib/active_rest_client/configuration.rb', line 103 def lazy_load? @lazy_load || false end |
#password(value = nil) ⇒ Object
48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/active_rest_client/configuration.rb', line 48 def password(value = nil) if value.nil? if @password.nil? @@password else @password end else @password = value end end |
#password=(value) ⇒ Object
60 61 62 63 |
# File 'lib/active_rest_client/configuration.rb', line 60 def password=(value) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Password set..." @@password = value end |
#proxy(value = nil) ⇒ Object
147 148 149 |
# File 'lib/active_rest_client/configuration.rb', line 147 def proxy(value = nil) value ? @proxy = value : @proxy || nil end |
#request_body_type(value = nil) ⇒ Object
65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/active_rest_client/configuration.rb', line 65 def request_body_type(value = nil) if value.nil? if @request_body_type.nil? @@request_body_type else @request_body_type end else @request_body_type = value end end |
#request_body_type=(value) ⇒ Object
77 78 79 80 |
# File 'lib/active_rest_client/configuration.rb', line 77 def request_body_type=(value) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Request Body Type set to be #{value}" @@request_body_type = value end |
#translator(value = nil) ⇒ Object
142 143 144 145 |
# File 'lib/active_rest_client/configuration.rb', line 142 def translator(value = nil) ActiveRestClient::Logger.warn("DEPRECATION: The translator functionality of ActiveRestClient has been replaced with proxy functionality, see https://github.com/whichdigital/active-rest-client#proxying-apis for more information") unless value.nil? value ? @translator = value : @translator || nil end |
#username(value = nil) ⇒ Object
31 32 33 34 35 36 37 38 39 40 41 |
# File 'lib/active_rest_client/configuration.rb', line 31 def username(value = nil) if value.nil? if @username.nil? @@username else @username end else @username = value end end |
#username=(value) ⇒ Object
43 44 45 46 |
# File 'lib/active_rest_client/configuration.rb', line 43 def username=(value) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Username set to be #{value}" @@username = value end |
#using_api_auth? ⇒ Boolean
122 123 124 |
# File 'lib/active_rest_client/configuration.rb', line 122 def using_api_auth? !@@api_auth_access_id.nil? && !@@api_auth_secret_key.nil? end |
#verbose(value = nil) ⇒ Object
138 139 140 |
# File 'lib/active_rest_client/configuration.rb', line 138 def verbose(value = nil) value ? @verbose = value : @verbose || false end |
#verbose! ⇒ Object
134 135 136 |
# File 'lib/active_rest_client/configuration.rb', line 134 def verbose! @verbose = true end |
#whiny_missing(value = nil) ⇒ Object
107 108 109 |
# File 'lib/active_rest_client/configuration.rb', line 107 def whiny_missing(value = nil) value ? @whiny_missing = value : @whiny_missing || false end |