Class: OpenStudio::Analysis::ServerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openstudio/analysis/server_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ ServerApi

Returns a new instance of ServerApi.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/openstudio/analysis/server_api.rb', line 8

def initialize(options = {})
  defaults = {:hostname => "http://localhost:8080"}
  options = defaults.merge(options)
  
  @hostname = options[:hostname]

  raise "no host defined for server api class" if @hostname.nil?

  # create connection with basic capabilities
  @conn = Faraday.new(:url => @hostname) do |faraday|
    faraday.request :url_encoded # form-encode POST params
    faraday.response :logger # log requests to STDOUT
    faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
  end

  # create connection to server api with multipart capabilities
  @conn_multipart = Faraday.new(:url => @hostname) do |faraday|
    faraday.request :multipart
    faraday.request :url_encoded # form-encode POST params
    faraday.response :logger # log requests to STDOUT
    faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
  end
end

Instance Attribute Details

#hostname ⇒ Object (readonly)

Returns the value of attribute hostname.



6
7
8
 
# File 'lib/openstudio/analysis/server_api.rb', line 6

def hostname
  @hostname
end

Instance Method Details

#delete_all ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/openstudio/analysis/server_api.rb', line 50

def delete_all()
  ids = get_project_ids()
  puts "Deleting Projects #{ids}"
  ids.each do |id|
    response = @conn.delete "/projects/#{id}.json"
    if response.status == 200
      puts "Successfully deleted project #{id}"
    else
      puts "ERROR deleting project #{id}"
    end
  end
end

#get_analyses(project_id) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/openstudio/analysis/server_api.rb', line 89

def get_analyses(project_id)
  analysis_ids = []
  response = @conn.get "/projects/#{project_id}.json"
  if response.status == 200
    puts "received the list of analyses for the project"

    analyses = JSON.parse(response.body, :symbolize_names => true, :max_nesting => false)
    if analyses[:analyses]
      analyses[:analyses].each do |analysis|
        analysis_ids << analysis[:_id]
      end
    end
  end

  analysis_ids
end

#get_datapoint_status(analysis_id, filter = nil) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/openstudio/analysis/server_api.rb', line 286

def get_datapoint_status(analysis_id, filter = nil)
  # get the status of all the entire analysis
  if !analysis_id.nil?
    if filter.nil? || filter == ""
      resp = @conn.get "analyses/#{analysis_id}/status.json"
      puts "Data points (all): #{resp}"
    else
      resp = @conn.get "#{@hostname}/analyses/#{analysis_id}/status.json", {jobs: filter}
      puts "Data points (#{filter}): #{resp}"
    end
  end
end

#get_project_ids ⇒ Object 



45
46
47
48
 
# File 'lib/openstudio/analysis/server_api.rb', line 45

def get_project_ids()
  ids = get_projects()
  ids.map { |project| project[:uuid] }
end

#get_projects ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/openstudio/analysis/server_api.rb', line 32

def get_projects()
  response = @conn.get '/projects.json'

  projects_json = nil
  if response.status == 200
    projects_json = JSON.parse(response.body, :symbolize_names => true, :max_nesting => false)
  else
    raise "did not receive a 200 in get_projects"
  end

  projects_json
end

#kill_all_analyses ⇒ Object 



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/openstudio/analysis/server_api.rb', line 271

def kill_all_analyses
  project_ids = get_project_ids
  puts "List of projects ids are: #{project_ids}"

  project_ids.each do |project_id|
    analysis_ids = get_analyses(project_id)
    puts analysis_ids
    analysis_ids.each do |analysis_id|
      puts "Trying to kill #{analysis_id}"
      kill_analysis(analysis_id)
    end
  end
end

#kill_analysis(analysis_id) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/openstudio/analysis/server_api.rb', line 254

def kill_analysis(analysis_id)
  analysis_action = {analysis_action: "stop"}

  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/action.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = analysis_action.to_json
  end

  if response.status == 200
    puts "Killed analysis #{analysis_id}"
  else
    #raise "Could not kill the analysis with response of #{response.inspect}"
  end

end

#new_analysis(project_id, options) ⇒ Object 



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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openstudio/analysis/server_api.rb', line 106

def new_analysis(project_id, options)
  defaults = {analysis_name: nil, reset_uuids: false}
  options = defaults.merge(options)

  raise "No project id passed" if project_id.nil?
  raise "no formulation passed to new_analysis" if !options[:formulation_file]
  raise "No formation exists #{options[:formulation_file]}" if !File.exists?(options[:formulation_file])

  formulation_json = JSON.parse(File.read(options[:formulation_file]), :symbolize_names => true)

  # read in the analysis id from the analysis.json file
  analysis_id = nil
  if options[:reset_uuids]
    analysis_id = UUID.new.generate
    formulation_json[:analysis][:uuid] = analysis_id

    formulation_json[:analysis][:problem][:workflow].each do |wf|
      wf[:uuid] = UUID.new.generate
      if wf[:arguments]
        wf[:arguments].each do |arg|
          arg[:uuid] = UUID.new.generate
        end
      end
      if wf[:variables]
        wf[:variables].each do |var|
          var[:uuid] = UUID.new.generate
          if var[:argument]
            var[:argument][:uuid] = UUID.new.generate
          end
        end
      end
    end
  else
    analysis_id = formulation_json[:analysis][:uuid]
  end
  raise "No analysis id defined in analyis.json #{options[:formulation_file]}" if analysis_id.nil?

  # set the analysis name
  formulation_json[:analysis][:name] = "#{options[:analysis_name]}" unless options[:analysis_name].nil?

  # save out this file to compare
  #File.open('formulation_merge.json', 'w') { |f| f << JSON.pretty_generate(formulation_json) }

  response = @conn.post do |req|
    req.url "projects/#{project_id}/analyses.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = formulation_json.to_json
  end

  if response.status == 201
    puts "asked to create analysis with #{analysis_id}"
    #puts resp.inspect
    analysis_id = JSON.parse(response.body)["_id"]

    puts "new analysis created with ID: #{analysis_id}"
  else
    raise "Could not create new analysis"
  end

  # check if we need to upload the analysis zip file
  if options[:upload_file]
    raise "upload file does not exist #{options[:upload_file]}" if !File.exists?(options[:upload_file])

    payload = {:file => Faraday::UploadIO.new(options[:upload_file], 'application/zip')}
    response = @conn_multipart.post "analyses/#{analysis_id}/upload.json", payload

    if response.status == 201
      puts "Successfully uploaded ZIP file"
    else
      raise response.inspect
    end
  end

  analysis_id
end

#new_project(options = {}) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/openstudio/analysis/server_api.rb', line 63

def new_project(options = {})
  defaults = {project_name: "project #{(rand()*1000).round}"}
  options = defaults.merge(options)
  project_id = nil

  project_hash = {project: {name: "#{options[:project_name]}"}}

  response = @conn.post do |req|
    req.url "/projects.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = project_hash.to_json
  end

  if response.status == 201
    project_id = JSON.parse(response.body)["_id"]

    puts "new project created with ID: #{project_id}"
    #grab the project id
  elsif response.code == 500
    puts "500 Error"
    puts response.inspect
  end

  project_id
end

#run_analysis(analysis_id, options) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/openstudio/analysis/server_api.rb', line 235

def run_analysis(analysis_id, options)
  defaults = {analysis_action: "start", without_delay: false}
  options = defaults.merge(options)

  puts "Run analysis is configured with #{options.to_json}"
  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/action.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = options.to_json
    req.options[:timeout] = 1800 #seconds
  end

  if response.status == 200
    puts "Recieved request to run analysis #{analysis_id}"
  else
    raise "Could not start the analysis"
  end
end

#upload_datapoint(analysis_id, options) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/openstudio/analysis/server_api.rb', line 182

def upload_datapoint(analysis_id, options)
  defaults = {reset_uuids: false}
  options = defaults.merge(options)

  raise "No analysis id passed" if analysis_id.nil?
  raise "No datapoints file passed to new_analysis" if !options[:datapoint_file]
  raise "No datapoints_file exists #{options[:datapoint_file]}" if !File.exists?(options[:datapoint_file])

  dp_hash = JSON.parse(File.open(options[:datapoint_file]).read, :symbolize_names => true)

  if options[:reset_uuids]
    dp_hash[:analysis_uuid] = analysis_id
    dp_hash[:uuid] = UUID.new.generate
  end

  # merge in the analysis_id as it has to be what is in the database
  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/data_points.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = dp_hash.to_json
  end

  if response.status == 201
    puts "new datapoints created for analysis #{analysis_id}"
  else
    raise "could not create new datapoints #{response.body}"
  end
end

#upload_datapoints(analysis_id, options) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/openstudio/analysis/server_api.rb', line 211

def upload_datapoints(analysis_id, options)
  defaults = {}
  options = defaults.merge(options)

  raise "No analysis id passed" if analysis_id.nil?
  raise "No datapoints file passed to new_analysis" if !options[:datapoints_file]
  raise "No datapoints_file exists #{options[:datapoints_file]}" if !File.exists?(options[:datapoints_file])

  dp_hash = JSON.parse(File.open(options[:datapoints_file]).read, :symbolize_names => true)

  # merge in the analysis_id as it has to be what is in the database
  response = @conn.post do |req|
    req.url "analyses/#{analysis_id}/data_points/batch_upload.json"
    req.headers['Content-Type'] = 'application/json'
    req.body = dp_hash.to_json
  end

  if response.status == 201
    puts "new datapoints created for analysis #{analysis_id}"
  else
    raise "could not create new datapoints #{response.body}"
  end
end