form_api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6439e9cb2b05efe66eca66fa5592116e9712a7a
-  data.tar.gz: 6b5226c60049e966e413635cf409fb76ab88ec4b
+  metadata.gz: 1601d98e7510bd573bde97e48c4685cae8a72c4a
+  data.tar.gz: c6fcb19e49daa8ce6b590c2896f1af7d1b876ad1
 SHA512:
-  metadata.gz: 19a12793aca87698c8a656592423b3422a8e5aa7e0591e5f8a633904e60c2325206de77a55b72ee018a072d1406e6ea5d0155a3ef27bbee9de8d120d7cedc559
-  data.tar.gz: d2fa9c2058bbdbb40a01ca010fbbc77bad86beb23f6d81cc36b47ada2fda5e473d77b211b6b18d7b3988fe341226a1297f12f56117bbaf46a09aa3a581decb74
+  metadata.gz: ba61014b1f46f7f2100bb6c5a833dc90ee31a18ddf6001070fb5566734dd4ee78ab35d8ccfd853701a47895c6f81e91b73355bb67e7540d45bb243ba1e41a56c
+  data.tar.gz: 94191a22d051c41fa65c691106a8547d901c31b8aa49df3bd404e073baa9240edb88de98baa9987552d6f027c7601e21e424e3edf09f14db3d04a44b50c742d0

data/README.md

@@ -24,7 +24,7 @@ bundle install
 
 ## Usage
 
-See [examples](examples/) for runnable examples.
+See [examples](examples/) for some runnable examples.
 
 ```ruby
 FormAPI.configure do |config|
@@ -41,6 +41,9 @@ response = formapi.generate_pdf(
   data: {                            # Data to render in the template
     name: "foo",
     number: 42
+  },
+  metadata: {                        # Custom data to include in the request, for your own purposes
+    user_id: 123
   }
 )
 

data/examples/merge_generated_pdfs.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+#
+# This example demonstrates merging multiple generated PDFs into a single PDF.
+#
+
+require "bundler/setup"
+Bundler.require
+
+begin
+  FormAPI.configure do |c|
+    c.username  = ENV['FORM_API_TOKEN_ID']
+    c.password  = ENV['FORM_API_TOKEN_SECRET']
+  end
+
+  formapi = FormAPI::Client.new
+
+  response = formapi.combine_submissions(
+    submission_ids: ["SUBMISSION_1_ID", "SUBMISSION_2_ID", ... ],
+    metadata: {
+      user_id: 123
+    }
+  )
+
+  puts "Download your combined PDF at: #{response.combined_submission.download_url}"
+
+rescue FormAPI::ApiError => ex
+  puts "#{ex.class}: #{ex.message}"
+  puts ex.code          # HTTP response code
+  puts ex.response_body # HTTP response body
+  puts ex.backtrace[0..3].join("\n")
+end

data/extensions/lib/form_api/api/client.rb

@@ -12,7 +12,7 @@ module FormAPI
 
     def generate_pdf(opts = {})
       unless opts[:data].kind_of?(::Hash)
-        raise InvalidDataError, ":data is required, and must be a Hash."
+        raise InvalidDataError, "data is required, and must be a Hash."
       end
 
       # Wait for job to finish by default.
@@ -36,7 +36,7 @@ module FormAPI
       start_time = Time.now
 
       # Wait for submission to be ready
-      while submission.state != 'processed'
+      while submission.state == 'pending'
         sleep 1
         submission = get_submission(submission.id)
 
@@ -45,10 +45,54 @@ module FormAPI
         end
       end
 
-      return InlineResponse201.new(
+      return InlineResponse2011.new(
         status: submission.state == 'processed' ? 'success' : 'error',
         submission: submission
       )
     end
+
+
+    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
   end
 end

data/lib/form_api.rb

@@ -18,9 +18,13 @@ require 'form_api/configuration'
 
 # Models
 require 'form_api/models/data'
+require 'form_api/models/data_1'
 require 'form_api/models/inline_response_201'
-require 'form_api/models/inline_response_201_submission'
+require 'form_api/models/inline_response_201_1'
+require 'form_api/models/inline_response_201_1_submission'
+require 'form_api/models/inline_response_201_combined_submission'
 require 'form_api/models/inline_response_400'
+require 'form_api/models/inline_response_401'
 require 'form_api/models/inline_response_422'
 
 # APIs

data/lib/form_api/api/pdf_api.rb

@@ -20,11 +20,115 @@ module FormAPI
       @api_client = api_client
     end
 
+    # Merge generated PDFs together
+    #
+    # @param [Hash] opts the optional parameters
+    # @option opts [Data] :data
+    # @return [InlineResponse201]
+    def combine_submissions(opts = {})
+      data, _status_code, _headers = combine_submissions_with_http_info(opts)
+      return data
+    end
+
+    # Merge generated PDFs together
+    #
+    # @param [Hash] opts the optional parameters
+    # @option opts [Data] :data
+    # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
+    def combine_submissions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.combine_submissions ..."
+      end
+      # resource path
+      local_var_path = "/combined_submissions"
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'data'])
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse201')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#combine_submissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Expire a combined submission
+    #
+    # @param combined_submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse201CombinedSubmission]
+    def expire_combined_submission(combined_submission_id, opts = {})
+      data, _status_code, _headers = expire_combined_submission_with_http_info(combined_submission_id, opts)
+      return data
+    end
+
+    # Expire a combined submission
+    #
+    # @param combined_submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse201CombinedSubmission, Fixnum, Hash)>] InlineResponse201CombinedSubmission data, response status code and response headers
+    def expire_combined_submission_with_http_info(combined_submission_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.expire_combined_submission ..."
+      end
+      # verify the required parameter 'combined_submission_id' is set
+      if @api_client.config.client_side_validation && combined_submission_id.nil?
+        fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.expire_combined_submission"
+      end
+      # resource path
+      local_var_path = "/combined_submissions/{combined_submission_id}".sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse201CombinedSubmission')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#expire_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Expire a PDF submission
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse201Submission]
+    # @return [InlineResponse2011Submission]
     def expire_submission(submission_id, opts = {})
       data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
       return data
@@ -34,7 +138,7 @@ module FormAPI
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse201Submission, Fixnum, Hash)>] InlineResponse201Submission data, response status code and response headers
+    # @return [Array<(InlineResponse2011Submission, Fixnum, Hash)>] InlineResponse2011Submission data, response status code and response headers
     def expire_submission_with_http_info(submission_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PDFApi.expire_submission ..."
@@ -66,7 +170,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse201Submission')
+        :return_type => 'InlineResponse2011Submission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -77,8 +181,8 @@ module FormAPI
     #
     # @param template_id
     # @param [Hash] opts the optional parameters
-    # @option opts [Data] :data
-    # @return [InlineResponse201]
+    # @option opts [Data1] :data
+    # @return [InlineResponse2011]
     def generate_pdf(template_id, opts = {})
       data, _status_code, _headers = generate_pdf_with_http_info(template_id, opts)
       return data
@@ -88,8 +192,8 @@ module FormAPI
     #
     # @param template_id
     # @param [Hash] opts the optional parameters
-    # @option opts [Data] :data
-    # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
+    # @option opts [Data1] :data
+    # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers
     def generate_pdf_with_http_info(template_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PDFApi.generate_pdf ..."
@@ -123,18 +227,71 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse201')
+        :return_type => 'InlineResponse2011')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
+    # Check the status of a combined submission (merged PDFs)
+    #
+    # @param combined_submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse201CombinedSubmission]
+    def get_combined_submission(combined_submission_id, opts = {})
+      data, _status_code, _headers = get_combined_submission_with_http_info(combined_submission_id, opts)
+      return data
+    end
+
+    # Check the status of a combined submission (merged PDFs)
+    #
+    # @param combined_submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse201CombinedSubmission, Fixnum, Hash)>] InlineResponse201CombinedSubmission data, response status code and response headers
+    def get_combined_submission_with_http_info(combined_submission_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.get_combined_submission ..."
+      end
+      # verify the required parameter 'combined_submission_id' is set
+      if @api_client.config.client_side_validation && combined_submission_id.nil?
+        fail ArgumentError, "Missing the required parameter 'combined_submission_id' when calling PDFApi.get_combined_submission"
+      end
+      # resource path
+      local_var_path = "/combined_submissions/{combined_submission_id}".sub('{' + 'combined_submission_id' + '}', combined_submission_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse201CombinedSubmission')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#get_combined_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Check the status of a PDF
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [InlineResponse201Submission]
+    # @return [InlineResponse2011Submission]
     def get_submission(submission_id, opts = {})
       data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
       return data
@@ -144,7 +301,7 @@ module FormAPI
     #
     # @param submission_id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(InlineResponse201Submission, Fixnum, Hash)>] InlineResponse201Submission data, response status code and response headers
+    # @return [Array<(InlineResponse2011Submission, Fixnum, Hash)>] InlineResponse2011Submission data, response status code and response headers
     def get_submission_with_http_info(submission_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug "Calling API: PDFApi.get_submission ..."
@@ -176,7 +333,7 @@ module FormAPI
         :form_params => form_params,
         :body => post_body,
         :auth_names => auth_names,
-        :return_type => 'InlineResponse201Submission')
+        :return_type => 'InlineResponse2011Submission')
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/form_api/models/data.rb

@@ -17,17 +17,20 @@ module FormAPI
   class Data
     attr_accessor :test
 
-    attr_accessor :data
+    attr_accessor :submission_ids
 
     attr_accessor :metadata
 
+    attr_accessor :expires_in
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'test' => :'test',
-        :'data' => :'data',
-        :'metadata' => :'metadata'
+        :'submission_ids' => :'submission_ids',
+        :'metadata' => :'metadata',
+        :'expires_in' => :'expires_in'
       }
     end
 
@@ -35,8 +38,9 @@ module FormAPI
     def self.swagger_types
       {
         :'test' => :'BOOLEAN',
-        :'data' => :'Object',
-        :'metadata' => :'Object'
+        :'submission_ids' => :'Array<String>',
+        :'metadata' => :'Object',
+        :'expires_in' => :'Float'
       }
     end
 
@@ -52,22 +56,28 @@ module FormAPI
         self.test = attributes[:'test']
       end
 
-      if attributes.has_key?(:'data')
-        self.data = attributes[:'data']
+      if attributes.has_key?(:'submission_ids')
+        if (value = attributes[:'submission_ids']).is_a?(Array)
+          self.submission_ids = value
+        end
       end
 
       if attributes.has_key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
 
+      if attributes.has_key?(:'expires_in')
+        self.expires_in = attributes[:'expires_in']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properies with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @data.nil?
-        invalid_properties.push("invalid value for 'data', data cannot be nil.")
+      if @submission_ids.nil?
+        invalid_properties.push("invalid value for 'submission_ids', submission_ids cannot be nil.")
       end
 
       return invalid_properties
@@ -76,7 +86,7 @@ module FormAPI
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @data.nil?
+      return false if @submission_ids.nil?
       return true
     end
 
@@ -86,8 +96,9 @@ module FormAPI
       return true if self.equal?(o)
       self.class == o.class &&
           test == o.test &&
-          data == o.data &&
-          metadata == o.metadata
+          submission_ids == o.submission_ids &&
+          metadata == o.metadata &&
+          expires_in == o.expires_in
     end
 
     # @see the `==` method
@@ -99,7 +110,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [test, data, metadata].hash
+      [test, submission_ids, metadata, expires_in].hash
     end
 
     # Builds the object from hash