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

Instance Method Details

#_reset_configuration! ⇒ Object 



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

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 



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

def adapter
  @adapter ||= Faraday.default_adapter
end

#adapter=(adapter) ⇒ Object 



109
110
111
112
 
# File 'lib/flexirest/configuration.rb', line 109

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 



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/flexirest/configuration.rb', line 154

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) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/flexirest/configuration.rb', line 139

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 



165
166
167
168
169
170
171
172
173
 
# File 'lib/flexirest/configuration.rb', line 165

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
30
31
 
# File 'lib/flexirest/configuration.rb', line 14

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
    value = value.gsub(/\/$/, '')
    @base_url = value
  end
end

#base_url=(value) ⇒ Object 



33
34
35
36
37
 
# File 'lib/flexirest/configuration.rb', line 33

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 



118
119
120
121
122
123
124
 
# File 'lib/flexirest/configuration.rb', line 118

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

#lazy_load! ⇒ Object 



126
127
128
 
# File 'lib/flexirest/configuration.rb', line 126

def lazy_load!
  @lazy_load = true
end

#lazy_load? ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/flexirest/configuration.rb', line 130

def lazy_load?
  @lazy_load ||= false
end

#password(value = nil) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/flexirest/configuration.rb', line 64

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 



81
82
83
84
85
 
# File 'lib/flexirest/configuration.rb', line 81

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 



190
191
192
193
 
# File 'lib/flexirest/configuration.rb', line 190

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

#request_body_type(value = nil) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/flexirest/configuration.rb', line 87

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 



104
105
106
107
 
# File 'lib/flexirest/configuration.rb', line 104

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 



184
185
186
187
188
 
# File 'lib/flexirest/configuration.rb', line 184

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 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/flexirest/configuration.rb', line 39

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 



58
59
60
61
62
 
# File 'lib/flexirest/configuration.rb', line 58

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) 


150
151
152
 
# File 'lib/flexirest/configuration.rb', line 150

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

#verbose(value = nil) ⇒ Object 



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

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

#verbose! ⇒ Object 



175
176
177
 
# File 'lib/flexirest/configuration.rb', line 175

def verbose!
  @verbose = true
end

#whiny_missing(value = nil) ⇒ Object 



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

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