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

Instance Method Summary collapse

Instance Method Details

#_reset_configuration! ⇒ Object 



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

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              = Faraday.default_adapter
  @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 ||= Faraday.default_adapter
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
135
136
137
138
139
140
 
# File 'lib/active_rest_client/configuration.rb', line 132

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 



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 



142
143
144
145
146
147
148
149
150
 
# File 'lib/active_rest_client/configuration.rb', line 142

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
 
# 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

Returns:

  • (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 



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

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 



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

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

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/active_rest_client/configuration.rb', line 128

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

#verbose(value = nil) ⇒ Object 



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

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

#verbose! ⇒ Object 



152
153
154
 
# File 'lib/active_rest_client/configuration.rb', line 152

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