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
@@disable_automatic_date_parsing = 
nil

Instance Method Summary collapse

Instance Method Details

#_reset_configuration! ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/flexirest/configuration.rb', line 236

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 



144
145
146
 
# File 'lib/flexirest/configuration.rb', line 144

def adapter
  @adapter ||= Faraday.default_adapter
end

#adapter=(adapter) ⇒ Object 



139
140
141
142
 
# File 'lib/flexirest/configuration.rb', line 139

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 



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/flexirest/configuration.rb', line 185

def api_auth_access_id
  @api_auth_access_id ||= nil
  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, options = {}) ⇒ Object 



169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/flexirest/configuration.rb', line 169

def api_auth_credentials(access_id, secret_key, options = {})
  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
  @api_auth_options = options
end

#api_auth_options ⇒ Object 



206
207
208
209
210
211
212
213
214
 
# File 'lib/flexirest/configuration.rb', line 206

def api_auth_options
  if !@api_auth_options.nil?
    return @api_auth_options
  elsif self.superclass.respond_to?(:api_auth_options)
    return self.superclass.api_auth_options
  end

  return {}
end

#api_auth_secret_key ⇒ Object 



196
197
198
199
200
201
202
203
204
 
# File 'lib/flexirest/configuration.rb', line 196

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 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/flexirest/configuration.rb', line 16

def base_url(value = nil)
  @base_url ||= nil
  @@base_url ||= 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
    if value.is_a?(Array)
      value.each_with_index do |v, k|
        value[k] = v.gsub(/\/$/, '')
      end
    else
      value = value.gsub(/\/$/, '')
    end
    @base_url = value
  end
end

#base_url=(value) ⇒ Object 



41
42
43
44
45
 
# File 'lib/flexirest/configuration.rb', line 41

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

#disable_automatic_date_parsing(value = nil) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/flexirest/configuration.rb', line 117

def disable_automatic_date_parsing(value = nil)
  @disable_automatic_date_parsing ||= nil
  if value.nil?
    if @disable_automatic_date_parsing.nil?
      if value.nil? && superclass.respond_to?(:disable_automatic_date_parsing)
        superclass.disable_automatic_date_parsing
      else
        @@disable_automatic_date_parsing || false
      end
    else
      @disable_automatic_date_parsing
    end
  else
    @disable_automatic_date_parsing = value
  end
end

#disable_automatic_date_parsing=(value) ⇒ Object 



134
135
136
137
 
# File 'lib/flexirest/configuration.rb', line 134

def disable_automatic_date_parsing=(value)
  Flexirest::Logger.info "\033[1;4;32m#{name}\033[0m Request Body Type set to be #{value}"
  @@disable_automatic_date_parsing = value
end

#faraday_config(&block) ⇒ Object 



148
149
150
151
152
153
154
 
# File 'lib/flexirest/configuration.rb', line 148

def faraday_config(&block)
  if block
    @faraday_config = block
  else
    @faraday_config ||= default_faraday_config
  end
end

#lazy_load! ⇒ Object 



156
157
158
 
# File 'lib/flexirest/configuration.rb', line 156

def lazy_load!
  @lazy_load = true
end

#lazy_load? ⇒ Boolean

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/flexirest/configuration.rb', line 160

def lazy_load?
  @lazy_load ||= false
end

#password(value = nil) ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/flexirest/configuration.rb', line 72

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 



89
90
91
92
93
 
# File 'lib/flexirest/configuration.rb', line 89

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 



231
232
233
234
 
# File 'lib/flexirest/configuration.rb', line 231

def proxy(value = nil)
  @proxy ||= nil
  value ? @proxy = value : @proxy || nil
end

#request_body_type(value = nil) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/flexirest/configuration.rb', line 95

def request_body_type(value = nil)
  @request_body_type ||= 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 



112
113
114
115
 
# File 'lib/flexirest/configuration.rb', line 112

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 



225
226
227
228
229
 
# File 'lib/flexirest/configuration.rb', line 225

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?
  @translator ||= nil
  value ? @translator = value : @translator
end

#username(value = nil) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/flexirest/configuration.rb', line 47

def username(value = nil)
  @username ||= nil
  @@username ||= 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 



66
67
68
69
70
 
# File 'lib/flexirest/configuration.rb', line 66

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

Returns:

  • (Boolean) 


181
182
183
 
# File 'lib/flexirest/configuration.rb', line 181

def using_api_auth?
  !self.api_auth_access_id.nil? && !self.api_auth_secret_key.nil?
end

#verbose(value = nil) ⇒ Object 



220
221
222
223
 
# File 'lib/flexirest/configuration.rb', line 220

def verbose(value = nil)
  @verbose ||= false
  value ? @verbose = value : @verbose
end

#verbose! ⇒ Object 



216
217
218
 
# File 'lib/flexirest/configuration.rb', line 216

def verbose!
  @verbose = true
end

#whiny_missing(value = nil) ⇒ Object 



164
165
166
167
 
# File 'lib/flexirest/configuration.rb', line 164

def whiny_missing(value = nil)
  @whiny_missing ||= false
  value ? @whiny_missing = value : @whiny_missing
end