Class: FormAPI::Client

Inherits:
PDFApi
  • Object
show all
Defined in:
lib/form_api/api/client.rb

Defined Under Namespace

Classes: InvalidDataError, InvalidResponseError, PollTimeoutError

Instance Attribute Summary

Attributes inherited from PDFApi

#api_client

Instance Method Summary collapse

Methods inherited from PDFApi

#batch_generate_pdf, #batch_generate_pdf_with_http_info, #combine_submissions_with_http_info, #expire_combined_submission, #expire_combined_submission_with_http_info, #expire_submission, #expire_submission_with_http_info, #generate_pdf_with_http_info, #get_combined_submission, #get_combined_submission_with_http_info, #get_submission, #get_submission_with_http_info, #get_templates, #get_templates_with_http_info, #initialize, #test_authentication, #test_authentication_with_http_info

Constructor Details

This class inherits a constructor from FormAPI::PDFApi

Instance Method Details

#combine_submissions(opts = {}) ⇒ Object 



55
56
57
58
59
60
61
62
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
88
89
90
91
92
93
94
95
96
 
# File 'lib/form_api/api/client.rb', line 55

def combine_submissions(opts = {})
  unless opts[:submission_ids].kind_of?(::Array)
    raise InvalidDataError, "submission_ids is required, and must be an Array."
  end

  # Wait for job to finish by default.
  if !opts.has_key?(:wait)
    opts[:wait] = true
  end

  # FormAPI requires a nested :data object.
  opts[:data] = { submission_ids: opts.delete(:submission_ids) }
  if opts[:metadata]
    opts[:data][:metadata] = opts.delete(:metadata)
  end
  if opts[:expire_in]
    opts[:data][:expire_in] = opts.delete(:expire_in)
  end

  response = super(opts)

  return response unless opts[:wait]

  combined_submission = response.combined_submission
  timeout = opts[:timeout] || 60
  start_time = Time.now

  # Wait for submission to be ready
  while combined_submission.state == 'pending'
    sleep 1
    combined_submission = get_combined_submission(combined_submission.id)

    if Time.now - start_time > timeout
      raise PollTimeoutError, "Merged PDF was not ready after #{timeout} seconds!"
    end
  end

  return InlineResponse201.new(
    status: combined_submission.state == 'processed' ? 'success' : 'error',
    combined_submission: combined_submission
  )
end

#generate_pdf(opts = {}) ⇒ Object 



13
14
15
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
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/form_api/api/client.rb', line 13

def generate_pdf(opts = {})
  unless opts[:data].kind_of?(::Hash)
    raise InvalidDataError, "data is required, and must be a Hash."
  end

  # Wait for job to finish by default.
  if !opts.has_key?(:wait)
    opts[:wait] = true
  end

  # FormAPI requires a nested :data object.
  opts[:'create_submission_body'] = { data: opts.delete(:data) }
  if opts[:metadata]
    opts[:'create_submission_body'][:metadata] = opts.delete(:metadata)
  end

  template_id = opts.delete :template_id
  response = super(template_id, opts)

  return response unless opts[:wait]

  submission = response.submission
  timeout = opts[:timeout] || 60
  start_time = Time.now

  # Wait for submission to be ready
  while submission.state == 'pending'
    sleep 1
    submission = get_submission(submission.id)

    if Time.now - start_time > timeout
      raise PollTimeoutError, "PDF was not ready after #{timeout} seconds!"
    end
  end

  return InlineResponse2011.new(
    status: submission.state == 'processed' ? 'success' : 'error',
    submission: submission
  )
end