Class: OSvCRuby::Connect

Inherits:
Object
  • Object
show all
Includes:
ValidationsModule
Defined in:
lib/osvc_ruby/connect.rb

Overview

This class is purely to provide the underlying methods for CRUD functionality using Net::HTTP, URI, and OpenSSL

Class Method Summary collapse

Methods included from ValidationsModule

check_client, check_query

Class Method Details

.check_client_config(client) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/osvc_ruby/connect.rb', line 170

def self.check_client_config(client)

	@config = ValidationsModule::check_client(client).config

	if @config.nil?
		raise ArgumentError, "Client configuration cannot be nil or blank"	
	elsif @config.interface.nil?
		raise ArgumentError, "The configured client interface cannot be nil or blank"	
	elsif @config.username.nil?
		raise ArgumentError, "The configured client username cannot be nil or blank"	
	elsif @config.password.nil?
		raise ArgumentError, "The configured client password cannot be nil or blank"	
	end

end

.delete(client, resource_url = nil) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/osvc_ruby/connect.rb', line 80

def self.delete(client,resource_url = nil)

	@final_config = delete_check(client,resource_url)

	@uri = @final_config['site_url']
	@username = @final_config['username']
	@password = @final_config['password']

	Net::HTTP.start(@uri.host, @uri.port,
	  :use_ssl => true, 
	  :verify_mode => @final_config['ssl']) do |http|

	  request = Net::HTTP::Delete.new @uri.request_uri
	  request.basic_auth @username, @password

	  http.request request # Net::HTTPResponse object

	end

end

.delete_check(client, resource_url = nil) ⇒ Object 



214
215
216
217
218
219
220
221
222
 
# File 'lib/osvc_ruby/connect.rb', line 214

def self.delete_check(client,resource_url = nil)
	if client.nil?
		raise ArgumentError, "Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings"
	elsif resource_url.nil?
		raise ArgumentError, "There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to"
	else
		@final_config = generate_url_and_config(client,resource_url)
	end
end

.demo_check(config) ⇒ Object 



134
135
136
137
138
139
140
 
# File 'lib/osvc_ruby/connect.rb', line 134

def self.demo_check(config)
	if config.demo_site == true
		"rightnowdemo"
	else
		"custhelp"
	end
end

.generate_url_and_config(client, resource_url = nil, patch_request = false) ⇒ Object

checking methods



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/osvc_ruby/connect.rb', line 104

def self.generate_url_and_config(client,resource_url = nil, patch_request = false)

	check_client_config(client)

	@config = client.config

	@version = @config.version

	@ssl_verification = ssl_check(@config)

	@rule_suppression = rule_suppress_check(@config)

	@cust_or_demo = demo_check(@config)

  	@url = "https://" + @config.interface + ".#{@cust_or_demo}.com/services/rest/connect/#{@version}/#{resource_url}"
  	
  	@final_uri = URI(@url)

  	@patch_request = patch_request == true ? true : false
  	
  	@final_config = {'site_url' => @final_uri,
  					 'username' => @config.username, 
  					 'password' => @config.password, 
  					 'patch_request' => @patch_request, 
  					 'ssl' => @ssl_verification, 
  					 'suppress_rules' => @rule_suppression
  					}

end

.get(client, resource_url = 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
40
41
42
 
# File 'lib/osvc_ruby/connect.rb', line 16

def self.get(client,resource_url = nil)

	@final_config = get_check(client,resource_url)

	@uri = @final_config['site_url']

	@username = @final_config['username']
	@password = @final_config['password']

	Net::HTTP.start(@uri.host, @uri.port,
		:use_ssl => true,
		:verify_mode => @final_config['ssl']) do |http|

		request = Net::HTTP::Get.new @uri.request_uri

		request.add_field('Content-Type', 'application/x-www-form-urlencoded')
		if @final_config['suppress_rules'] == true
			request.add_field 'OSvC-CREST-Suppress-All',true
		end

		request.basic_auth @username, @password

		http.request request # Net::HTTPResponse object

	end

end

.get_check(client, resource_url = nil) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/osvc_ruby/connect.rb', line 186

def self.get_check(client,resource_url = nil)

	if client.nil?
		raise ArgumentError, "Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings"
	elsif !resource_url.nil?
		@final_config = generate_url_and_config(client,resource_url)
	else
		@final_config = generate_url_and_config(client,nil)
	end

end

.patch(client, resource_url = nil, json_content = nil) ⇒ Object 



76
77
78
 
# File 'lib/osvc_ruby/connect.rb', line 76

def self.patch(client,resource_url = nil, json_content = nil)
	self.post_or_patch(client,resource_url, json_content,true)
end

.post(client, resource_url = nil, json_content = nil) ⇒ Object 



72
73
74
 
# File 'lib/osvc_ruby/connect.rb', line 72

def self.post(client,resource_url = nil, json_content = nil)
	self.post_or_patch(client,resource_url, json_content)
end

.post_and_patch_check(client, resource_url = nil, json_content = nil, patch_request = false) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/osvc_ruby/connect.rb', line 198

def self.post_and_patch_check(client,resource_url = nil, json_content = nil, patch_request = false)

	if client.nil?
		raise ArgumentError, "Client must have some configuration set; please create an instance of OSvCRuby::Client with configuration settings"
	elsif resource_url.nil?
		raise ArgumentError, "There is no URL resource provided; please specify a URL resource that you would like to send a POST or PATCH request to"
	elsif json_content.nil?
		raise ArgumentError, "There is no json content provided; please specify json content that you would like to send a POST or PATCH request with"
	elsif patch_request == true
		@final_config = generate_url_and_config(client,resource_url,true)
	else
		@final_config = generate_url_and_config(client,resource_url)
	end

end

.post_or_patch(client, resource_url = nil, json_content = nil, patch_request = false) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/osvc_ruby/connect.rb', line 44

def self.post_or_patch(client,resource_url = nil, json_content = nil,patch_request = false)

	@final_config = post_and_patch_check(client,resource_url, json_content, patch_request)
	@uri = @final_config['site_url']
	@username = @final_config['username']
	@password = @final_config['password']

	Net::HTTP.start(@uri.host, @uri.port,
		:use_ssl => true, 
		:verify_mode => @final_config['ssl']) do |http|

		request = Net::HTTP::Post.new @uri.request_uri
		request.basic_auth @username, @password
		request.content_type = "application/json"
		if @final_config['patch_request'] == true
			request.add_field 'X-HTTP-Method-Override','PATCH'
		end
		if @final_config['suppress_rules'] == true
			request.add_field 'OSvC-CREST-Suppress-All',true
		end
		request.body = JSON.dump(json_content)

		http.request request # Net::HTTPResponse object

	end

end

.rule_suppress_check(config) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/osvc_ruby/connect.rb', line 142

def self.rule_suppress_check(config)

	if config.suppress_rules == true || config.suppress_rules == "Yes"

		true
		
	else
		
		false

	end

end

.ssl_check(config) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/osvc_ruby/connect.rb', line 156

def self.ssl_check(config)

	if config.no_ssl_verify == true

		OpenSSL::SSL::VERIFY_NONE
		
	else
		
		OpenSSL::SSL::VERIFY_PEER

	end

end