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 



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/active_rest_client/configuration.rb', line 126

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
end

#adapter ⇒ Object 



85
86
87
 
# File 'lib/active_rest_client/configuration.rb', line 85

def adapter
  @adapter ||= :patron
end

#adapter=(adapter) ⇒ Object 



80
81
82
83
 
# File 'lib/active_rest_client/configuration.rb', line 80

def adapter=(adapter)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Adapter set to be #{adapter}"
  @adapter = adapter
end

#base_url(value = nil) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/active_rest_client/configuration.rb', line 10

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 



23
24
25
26
27
 
# File 'lib/active_rest_client/configuration.rb', line 23

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 



89
90
91
92
93
94
95
 
# File 'lib/active_rest_client/configuration.rb', line 89

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

#lazy_load! ⇒ Object 



97
98
99
 
# File 'lib/active_rest_client/configuration.rb', line 97

def lazy_load!
  @lazy_load = true
end

#lazy_load? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/active_rest_client/configuration.rb', line 101

def lazy_load?
  @lazy_load || false
end

#password(value = nil) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/active_rest_client/configuration.rb', line 46

def password(value = nil)
  if value.nil?
    if @password.nil?
      @@password
    else
      @password
    end
  else
    @password = value
  end
end

#password=(value) ⇒ Object 



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

def password=(value)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Password set..."
  @@password = value
end

#proxy(value = nil) ⇒ Object 



122
123
124
 
# File 'lib/active_rest_client/configuration.rb', line 122

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

#request_body_type(value = nil) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/active_rest_client/configuration.rb', line 63

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 



75
76
77
78
 
# File 'lib/active_rest_client/configuration.rb', line 75

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 



117
118
119
120
 
# File 'lib/active_rest_client/configuration.rb', line 117

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 



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/active_rest_client/configuration.rb', line 29

def username(value = nil)
  if value.nil?
    if @username.nil?
      @@username
    else
      @username
    end
  else
    @username = value
  end
end

#username=(value) ⇒ Object 



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

def username=(value)
  ActiveRestClient::Logger.info "\033[1;4;32m#{name}\033[0m Username set to be #{value}"
  @@username = value
end

#verbose(value = nil) ⇒ Object 



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

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

#verbose! ⇒ Object 



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

def verbose!
  @verbose = true
end

#whiny_missing(value = nil) ⇒ Object 



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

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