Module: Flexirest::Configuration::ClassMethods
- Defined in:
- lib/flexirest/configuration.rb
Constant Summary collapse
- @@base_url =
nil
- @@username =
nil
- @@password =
nil
- @@request_body_type =
:form_encoded
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
185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/flexirest/configuration.rb', line 185 def _reset_configuration! @base_url = nil @@base_url = nil @request_body_type = nil @@request_body_type = nil @whiny_missing = nil @lazy_load = false @faraday_config = default_faraday_config @adapter = Faraday.default_adapter @api_auth_access_id = nil @api_auth_secret_key = nil end |
#adapter ⇒ Object
109 110 111 |
# File 'lib/flexirest/configuration.rb', line 109 def adapter @adapter ||= Faraday.default_adapter end |
#adapter=(adapter) ⇒ Object
104 105 106 107 |
# File 'lib/flexirest/configuration.rb', line 104 def adapter=(adapter) Flexirest::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}" @adapter = adapter end |
#api_auth_access_id ⇒ Object
148 149 150 151 152 153 154 155 156 |
# File 'lib/flexirest/configuration.rb', line 148 def api_auth_access_id if !@api_auth_access_id.nil? return @api_auth_access_id elsif self.superclass.respond_to?(:api_auth_access_id) return self.superclass.api_auth_access_id end return nil end |
#api_auth_credentials(access_id, secret_key) ⇒ Object
133 134 135 136 137 138 139 140 141 142 |
# File 'lib/flexirest/configuration.rb', line 133 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
158 159 160 161 162 163 164 165 166 |
# File 'lib/flexirest/configuration.rb', line 158 def api_auth_secret_key if !@api_auth_secret_key.nil? return @api_auth_secret_key elsif self.superclass.respond_to?(:api_auth_secret_key) return self.superclass.api_auth_secret_key end return nil end |
#base_url(value = nil) ⇒ Object
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
# File 'lib/flexirest/configuration.rb', line 14 def base_url(value = nil) if value.nil? value = if @base_url.nil? @@base_url else @base_url end if value.nil? && superclass.respond_to?(:base_url) value = superclass.base_url end value else value = value.gsub(/\/$/, '') @base_url = value end end |
#base_url=(value) ⇒ Object
31 32 33 34 35 |
# File 'lib/flexirest/configuration.rb', line 31 def base_url=(value) Flexirest::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
113 114 115 116 117 118 119 |
# File 'lib/flexirest/configuration.rb', line 113 def faraday_config(&block) if block @faraday_config = block else @faraday_config ||= default_faraday_config end end |
#lazy_load! ⇒ Object
121 122 123 |
# File 'lib/flexirest/configuration.rb', line 121 def lazy_load! @lazy_load = true end |
#lazy_load? ⇒ Boolean
125 126 127 |
# File 'lib/flexirest/configuration.rb', line 125 def lazy_load? @lazy_load || false end |
#password(value = nil) ⇒ Object
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/flexirest/configuration.rb', line 60 def password(value = nil) if value.nil? value = if @password.nil? @@password else @password end if value.nil? && superclass.respond_to?(:password) value = superclass.password end value else value = CGI::escape(value) if value.present? && !value.include?("%") @password = value end end |
#password=(value) ⇒ Object
77 78 79 80 81 |
# File 'lib/flexirest/configuration.rb', line 77 def password=(value) Flexirest::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
181 182 183 |
# File 'lib/flexirest/configuration.rb', line 181 def proxy(value = nil) value ? @proxy = value : @proxy || nil end |
#request_body_type(value = nil) ⇒ Object
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/flexirest/configuration.rb', line 83 def request_body_type(value = nil) if value.nil? if @request_body_type.nil? if value.nil? && superclass.respond_to?(:request_body_type) superclass.request_body_type else @@request_body_type || :form_encoded end else @request_body_type end else @request_body_type = value end end |
#request_body_type=(value) ⇒ Object
99 100 101 102 |
# File 'lib/flexirest/configuration.rb', line 99 def request_body_type=(value) Flexirest::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
176 177 178 179 |
# File 'lib/flexirest/configuration.rb', line 176 def translator(value = nil) Flexirest::Logger.warn("DEPRECATION: The translator functionality of Flexirest has been replaced with proxy functionality, see https://github.com/andyjeffries/flexirest#proxying-apis for more information") unless value.nil? value ? @translator = value : @translator || nil end |
#username(value = nil) ⇒ Object
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/flexirest/configuration.rb', line 37 def username(value = nil) if value.nil? value = if @username.nil? @@username else @username end if value.nil? && superclass.respond_to?(:username) value = superclass.username end value else value = CGI::escape(value) if value.present? && !value.include?("%") @username = value end end |
#username=(value) ⇒ Object
54 55 56 57 58 |
# File 'lib/flexirest/configuration.rb', line 54 def username=(value) Flexirest::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
144 145 146 |
# File 'lib/flexirest/configuration.rb', line 144 def using_api_auth? !self.api_auth_access_id.nil? && !self.api_auth_secret_key.nil? end |
#verbose(value = nil) ⇒ Object
172 173 174 |
# File 'lib/flexirest/configuration.rb', line 172 def verbose(value = nil) value ? @verbose = value : @verbose || false end |
#verbose! ⇒ Object
168 169 170 |
# File 'lib/flexirest/configuration.rb', line 168 def verbose! @verbose = true end |
#whiny_missing(value = nil) ⇒ Object
129 130 131 |
# File 'lib/flexirest/configuration.rb', line 129 def whiny_missing(value = nil) value ? @whiny_missing = value : @whiny_missing || false end |