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
157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/active_rest_client/configuration.rb', line 157 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
93 94 95 |
# File 'lib/active_rest_client/configuration.rb', line 93 def adapter @adapter ||= :patron end |
#adapter=(adapter) ⇒ Object
88 89 90 91 |
# File 'lib/active_rest_client/configuration.rb', line 88 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
132 133 134 |
# File 'lib/active_rest_client/configuration.rb', line 132 def api_auth_access_id @@api_auth_access_id end |
#api_auth_credentials(access_id, secret_key) ⇒ Object
117 118 119 120 121 122 123 124 125 126 |
# File 'lib/active_rest_client/configuration.rb', line 117 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
136 137 138 |
# File 'lib/active_rest_client/configuration.rb', line 136 def api_auth_secret_key @@api_auth_secret_key end |
#base_url(value = nil) ⇒ Object
14 15 16 17 18 19 20 21 22 23 24 25 |
# File 'lib/active_rest_client/configuration.rb', line 14 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
27 28 29 30 31 |
# File 'lib/active_rest_client/configuration.rb', line 27 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
97 98 99 100 101 102 103 |
# File 'lib/active_rest_client/configuration.rb', line 97 def faraday_config(&block) if block @faraday_config = block else @faraday_config ||= default_faraday_config end end |
#lazy_load! ⇒ Object
105 106 107 |
# File 'lib/active_rest_client/configuration.rb', line 105 def lazy_load! @lazy_load = true end |
#lazy_load? ⇒ Boolean
109 110 111 |
# File 'lib/active_rest_client/configuration.rb', line 109 def lazy_load? @lazy_load || false end |
#password(value = nil) ⇒ Object
52 53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/active_rest_client/configuration.rb', line 52 def password(value = nil) if value.nil? if @password.nil? @@password else @password end else value = CGI::escape(value) if value.present? && !value.include?("%") @password = value end end |
#password=(value) ⇒ Object
65 66 67 68 69 |
# File 'lib/active_rest_client/configuration.rb', line 65 def password=(value) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Password set..." value = CGI::escape(value) if value.present? && !value.include?("%") @@password = value end |
#proxy(value = nil) ⇒ Object
153 154 155 |
# File 'lib/active_rest_client/configuration.rb', line 153 def proxy(value = nil) value ? @proxy = value : @proxy || nil end |
#request_body_type(value = nil) ⇒ Object
71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/active_rest_client/configuration.rb', line 71 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
83 84 85 86 |
# File 'lib/active_rest_client/configuration.rb', line 83 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
148 149 150 151 |
# File 'lib/active_rest_client/configuration.rb', line 148 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
33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/active_rest_client/configuration.rb', line 33 def username(value = nil) if value.nil? if @username.nil? @@username else @username end else value = CGI::escape(value) if value.present? && !value.include?("%") @username = value end end |
#username=(value) ⇒ Object
46 47 48 49 50 |
# File 'lib/active_rest_client/configuration.rb', line 46 def username=(value) ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Username set to be #{value}" value = CGI::escape(value) if value.present? && !value.include?("%") @@username = value end |
#using_api_auth? ⇒ Boolean
128 129 130 |
# File 'lib/active_rest_client/configuration.rb', line 128 def using_api_auth? !@@api_auth_access_id.nil? && !@@api_auth_secret_key.nil? end |
#verbose(value = nil) ⇒ Object
144 145 146 |
# File 'lib/active_rest_client/configuration.rb', line 144 def verbose(value = nil) value ? @verbose = value : @verbose || false end |
#verbose! ⇒ Object
140 141 142 |
# File 'lib/active_rest_client/configuration.rb', line 140 def verbose! @verbose = true end |
#whiny_missing(value = nil) ⇒ Object
113 114 115 |
# File 'lib/active_rest_client/configuration.rb', line 113 def whiny_missing(value = nil) value ? @whiny_missing = value : @whiny_missing || false end |