form_api 0.2.0 → 1.0.0

data/lib/form_api/version.rb

@@ -1,15 +1,15 @@
 =begin
 #API V1
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 OpenAPI spec version: v1
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
 
 =end
 
 module FormAPI
-  VERSION = "0.2.0"
+  VERSION = '1.0.0'
 end

data/spec/api/client_spec.rb

@@ -1,28 +1,202 @@
 require 'spec_helper'
 require 'json'
 
-describe FormAPI::Client, vcr: { record: :none } do
-  it 'should generate a PDF and wait for the submission to be processed' do
-    client = FormAPI::Client.new
-    client.api_client.config.username = 'yRaaR9JmTPtGX7EN'
-    client.api_client.config.password = 'IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec'
-    template_id = '6zz3dYRYM67fxMXA'
-
-    expect(client).to receive(:sleep).with(1).once
-
-    response = client.generate_pdf(
-      template_id: template_id,
-      data: {
-        first_name: 'John',
-        last_name: 'Smith',
-        favorite_color: 'Blue'
-      }
-    )
-
-    expect(response.status).to eq 'success'
-    submission = response.submission
-    # expect(submission.id).to eq 'jpZnjXmRtZYxsFx4'
-    expect(submission.state).to eq 'processed'
-    expect(submission.download_url).to include 'https://formapi-docs.s3.amazonaws.com/store/submissions'
+describe FormAPI::Client do
+  before do
+    FormAPI.configure do |c|
+      c.api_token_id = 'api_token123'
+      c.api_token_secret = 'testsecret123'
+      c.host = 'http://localhost:31337'
+    end
+  end
+
+  describe '#generate_pdf' do
+    it 'should generate a PDF and wait for the submission to be processed' do
+      client = FormAPI::Client.new
+      template_id = 'tpl_000000000000000001'
+
+      expect(client).to receive(:sleep).with(1).once
+
+      response = client.generate_pdf(
+        template_id: template_id,
+        data: {
+          title: 'Test PDF',
+          description: 'This PDF is great!',
+        }
+      )
+
+      expect(response.status).to eq 'success'
+      submission = response.submission
+      expect(submission.id).to start_with 'sub_'
+      expect(submission.expired).to eq false
+      expect(submission.state).to eq 'processed'
+      expect(submission.download_url).to include 'submissions/submission.pdf'
+    end
+  end
+
+  describe '#batch_generate_pdfs' do
+    it 'should submit a batch job and wait for all jobs to be processed' do
+      client = FormAPI::Client.new
+      template_id = 'tpl_000000000000000001'
+
+      expect(client).to receive(:sleep).with(1).once
+
+      response = client.batch_generate_pdfs(
+        metadata: { user_id: 123 },
+        test: true,
+        submissions: [
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF',
+              description: 'This PDF is great!',
+            }
+          },
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF 2',
+              description: 'This PDF is also great!',
+            }
+          }
+        ]
+      )
+
+      expect(response.status).to eq 'success'
+      batch = response.submission_batch
+      expect(batch.id).to start_with 'sba_'
+      expect(batch.state).to eq 'processed'
+      expect(batch.total_count).to eq 2
+      expect(batch.pending_count).to eq 0
+      expect(batch.error_count).to eq 0
+      expect(batch.completion_percentage).to eq 100
+
+      expect(response.submissions.size).to eq 2
+      submission_response1 = response.submissions[0]
+      expect(submission_response1.status).to eq 'success'
+      submission1 = submission_response1.submission
+      expect(submission1.id).to start_with 'sub_'
+      expect(submission1.expired).to eq false
+      expect(submission1.state).to eq 'processed'
+      expect(submission1.download_url).to include 'submissions/submission.pdf'
+
+      submission_response2 = response.submissions[1]
+      expect(submission_response2.status).to eq 'success'
+      submission2 = submission_response2.submission
+      expect(submission2.id).to start_with 'sub_'
+      expect(submission2.expired).to eq false
+      expect(submission2.state).to eq 'processed'
+    end
+
+    it 'generates no PDFs if there are any errors' do
+      client = FormAPI::Client.new
+      template_id = 'tpl_000000000000000001'
+
+      # Response is immediately an error so no need to poll
+      expect(client).to_not receive(:sleep)
+
+      response = client.batch_generate_pdfs(
+        metadata: { user_id: 123 },
+        test: true,
+        submissions: [
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF',
+              description: 'This PDF is great!',
+            }
+          },
+          {
+            template_id: template_id,
+            data: {
+              description: 'This PDF is also great!',
+            }
+          }
+        ]
+      )
+
+      expect(response.status).to eq 'error'
+      batch = response.submission_batch
+      expect(batch.id).to start_with 'sba_'
+      expect(batch.state).to eq 'error'
+      expect(batch.total_count).to eq 2
+      expect(batch.pending_count).to eq 0
+      expect(batch.error_count).to eq 1
+      expect(batch.completion_percentage).to eq 100
+
+      expect(response.submissions.size).to eq 2
+      submission_response1 = response.submissions[0]
+      expect(submission_response1.status).to eq 'valid_but_not_saved'
+      expect(submission_response1.submission).to be_nil
+
+      submission_response2 = response.submissions[1]
+      expect(submission_response2.status).to eq 'error'
+      submission2 = submission_response2.submission
+      expect(submission2.id).to start_with 'sub_'
+      expect(submission2.expired).to eq false
+      expect(submission2.state).to eq 'invalid_data'
+    end
+  end
+
+  describe '#combine_submissions' do
+    it 'should merge multiple PDFs and wait for the job to be processed' do
+      client = FormAPI::Client.new
+      expect(client).to receive(:sleep).with(1).once
+
+      response = client.combine_submissions(
+        submission_ids: %w[sub_000000000000000001 sub_000000000000000002])
+
+      expect(response.status).to eq 'success'
+      combined_submission = response.combined_submission
+      expect(combined_submission.id).to start_with 'com_'
+      expect(combined_submission.expired).to eq false
+      expect(combined_submission.state).to eq 'processed'
+      expect(combined_submission.submission_ids).to eq(
+        %w[sub_000000000000000001 sub_000000000000000002])
+      expect(combined_submission.download_url).to include(
+        'combined_submissions/combined_submission.pdf')
+    end
+  end
+
+  describe '#batch_generate_and_combine_pdfs' do
+    it 'should submit a batch job and combine the PDFs into a single PDF' do
+      client = FormAPI::Client.new
+      template_id = 'tpl_000000000000000001'
+
+      expect(client).to receive(:sleep).with(1).twice
+
+      response = client.batch_generate_and_combine_pdfs(
+        metadata: { user_id: 123 },
+        test: true,
+        submissions: [
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF',
+              description: 'This PDF is great!',
+            }
+          },
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF 2',
+              description: 'This PDF is also great!',
+            }
+          }
+        ]
+      )
+
+      expect(response.status).to eq 'success'
+      combined_submission = response.combined_submission
+      expect(combined_submission.id).to start_with 'com_'
+      expect(combined_submission.expired).to eq false
+      expect(combined_submission.state).to eq 'processed'
+      expect(combined_submission.submission_ids.count).to eq 2
+      combined_submission.submission_ids.each do |sub_id|
+        expect(sub_id).to start_with 'sub_'
+      end
+      expect(combined_submission.download_url).to include(
+        'combined_submissions/combined_submission.pdf')
+    end
   end
 end

data/spec/api/pdf_api_spec.rb

@@ -1,12 +1,12 @@
 =begin
 #API V1
 
-#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 OpenAPI spec version: v1
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
 
 =end
 
@@ -14,121 +14,226 @@ require 'spec_helper'
 require 'json'
 
 # Unit tests for FormAPI::PDFApi
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
 describe 'PDFApi' do
   before do
-    # run before each test
-    @instance = FormAPI::PDFApi.new
+    FormAPI.configure do |c|
+      c.api_token_id = 'api_token123'
+      c.api_token_secret = 'testsecret123'
+      c.host = 'http://localhost:31337'
+    end
   end
 
+  let(:api_instance) { FormAPI::PDFApi.new }
+
   after do
     # run after each test
   end
 
-  describe 'test an instance of PDFApi' do
-    it 'should create an instance of PDFApi' do
-      expect(@instance).to be_instance_of(FormAPI::PDFApi)
-    end
-  end
-
-  # unit tests for batch_generate_pdf
+  # integration tests for batch_generate_pdf (v1)
   # Generates multiple PDFs
-  #
   # @param template_id
+  # @param create_submission_data
   # @param [Hash] opts the optional parameters
-  # @option opts [Array<CreateSubmissionBatchBody>] :create_submission_batch_body
-  # @return [Array<InlineResponse2011>]
-  describe 'batch_generate_pdf test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+  # @return [Array<CreateSubmissionResponse>]
+  describe 'batch_generate_pdf v1 test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001'
+      responses = api_instance.batch_generate_pdf_v1(template_id, [
+        {
+          data: {
+            title: 'Test PDF',
+            description: 'This PDF is great!',
+          }
+        },
+        {
+          data: {
+            title: 'Test PDF 2',
+            description: 'This PDF is also great!',
+          }
+        }
+      ])
+      expect(responses.size).to eq 2
+      expect(responses.first.status).to eq 'success'
+      submission = responses.first.submission
+      expect(submission.id).to start_with 'sub_'
+      expect(submission.expired).to eq false
+      expect(submission.state).to eq 'pending'
+    end
+  end
+
+  # Integration tests for batch_generate_pdf (v2)
+  describe 'batch_generate_pdfs v2 test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001'
+      response = api_instance.batch_generate_pdfs(
+        metadata: { user_id: 123 },
+        test: true,
+        submissions: [
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF',
+              description: 'This PDF is great!',
+            }
+          },
+          {
+            template_id: template_id,
+            data: {
+              title: 'Test PDF 2',
+              description: 'This PDF is also great!',
+            }
+          }
+        ]
+      )
+      expect(response.status).to eq 'success'
+      batch = response.submission_batch
+      expect(batch.id).to start_with 'sba_'
+      expect(batch.state).to eq 'pending'
+      expect(batch.total_count).to eq 2
+      expect(batch.pending_count).to eq 2
+      expect(batch.error_count).to eq 0
+      expect(batch.completion_percentage).to eq 0
+
+      expect(response.submissions.size).to eq 2
+      submission_response = response.submissions.first
+      expect(submission_response.status).to eq 'success'
+      submission = submission_response.submission
+      expect(submission.id).to start_with 'sub_'
+      expect(submission.expired).to eq false
+      expect(submission.state).to eq 'pending'
     end
   end
 
-  # unit tests for combine_submissions
+  describe 'get_submission_batch test' do
+    it 'should get the batch including submissions' do
+      submission_batch_id = 'sba_000000000000000001'
+      batch = api_instance.get_submission_batch(submission_batch_id, include_submissions: true)
+      expect(batch.id).to eq 'sba_000000000000000001'
+      expect(batch.total_count).to eq 2
+      expect(batch.pending_count).to eq 0
+      expect(batch.completion_percentage).to eq 100
+      expect(batch.state).to eq 'processed'
+      expect(batch.submissions.count).to eq 2
+    end
+
+    it 'should get the batch without submissions' do
+      submission_batch_id = 'sba_000000000000000001'
+      batch = api_instance.get_submission_batch(submission_batch_id)
+      expect(batch.id).to eq 'sba_000000000000000001'
+      expect(batch.submissions).to be_nil
+    end
+  end
+
+  # integration tests for combine_submissions
   # Merge generated PDFs together
-  #
   # @param [Hash] opts the optional parameters
-  # @option opts [CreateCombinedSubmissionBody] :create_combined_submission_body
-  # @return [InlineResponse201]
+  # @option opts [CombinedSubmissionData] :combined_submission_data
+  # @return [CreateCombinedSubmissionResponse]
   describe 'combine_submissions test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      response = api_instance.combine_submissions(
+        submission_ids: %w[sub_000000000000000001 sub_000000000000000002])
+      expect(response.status).to eq 'success'
+      expect(response.combined_submission.id).to start_with 'com_'
+      expect(response.combined_submission.state).to eq 'pending'
     end
   end
-
-  # unit tests for expire_combined_submission
+  # integration tests for expire_combined_submission
   # Expire a combined submission
-  #
   # @param combined_submission_id
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse201CombinedSubmission]
+  # @return [CombinedSubmission]
   describe 'expire_combined_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      combined_submission_id = 'com_000000000000000001'
+      combined_submission = api_instance.expire_combined_submission(combined_submission_id)
+      expect(combined_submission.expired).to eq true
     end
   end
-
-  # unit tests for expire_submission
+  # integration tests for expire_submission
   # Expire a PDF submission
-  #
   # @param submission_id
   # @param [Hash] opts the optional parameters
-  # @return [TemplatestemplateIdsubmissionsbatchSubmission]
+  # @return [Submission]
   describe 'expire_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      submission_id = 'sub_000000000000000001'
+      submission = api_instance.expire_submission(submission_id)
+      expect(submission.expired).to eq true
     end
   end
-
-  # unit tests for generate_pdf
+  # integration tests for generate_pdf
   # Generates a new PDF
-  #
   # @param template_id
+  # @param create_submission_data
   # @param [Hash] opts the optional parameters
-  # @option opts [CreateSubmissionBody] :create_submission_body
-  # @return [InlineResponse2011]
+  # @return [CreateSubmissionResponse]
   describe 'generate_pdf test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      template_id = 'tpl_000000000000000001'
+      response = api_instance.generate_pdf(template_id,
+        data: {
+          title: 'Test PDF',
+          description: 'This PDF is great!',
+        })
+      expect(response.status).to eq 'success'
+      submission = response.submission
+      expect(submission.id).to start_with 'sub_'
+      expect(submission.expired).to eq false
+      expect(submission.state).to eq 'pending'
     end
   end
-
-  # unit tests for get_combined_submission
+  # integration tests for get_combined_submission
   # Check the status of a combined submission (merged PDFs)
-  #
   # @param combined_submission_id
   # @param [Hash] opts the optional parameters
-  # @return [InlineResponse201CombinedSubmission]
+  # @return [CombinedSubmission]
   describe 'get_combined_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      combined_submission_id = 'com_000000000000000001'
+      combined_submission = api_instance.get_combined_submission(combined_submission_id)
+      expect(combined_submission.id).to start_with 'com_'
     end
   end
-
-  # unit tests for get_submission
+  # integration tests for get_submission
   # Check the status of a PDF
-  #
   # @param submission_id
   # @param [Hash] opts the optional parameters
-  # @return [TemplatestemplateIdsubmissionsbatchSubmission]
+  # @return [Submission]
   describe 'get_submission test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      submission_id = 'sub_000000000000000001'
+      submission = api_instance.get_submission(submission_id)
+      expect(submission.id).to start_with 'sub_'
     end
   end
-
-  # unit tests for get_templates
+  # integration tests for get_templates
   # Get a list of all templates
-  #
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :page Default: 1
   # @option opts [Integer] :per_page Default: 50
-  # @return [Array<InlineResponse2001>]
+  # @return [Array<Template>]
   describe 'get_templates test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    it 'should work' do
+      opts = {
+        page: 1, # Integer | Default: 1
+        per_page: 10 # Integer | Default: 50
+      }
+      templates = api_instance.get_templates(opts)
+      expect(templates.size).to eq 2
+      expect(templates.first.id).to start_with 'tpl_'
+    end
+  end
+  # integration tests for test_authentication
+  # Test Authentication
+  # @param [Hash] opts the optional parameters
+  # @return [AuthenticationSuccessResponse]
+  describe 'test_authentication test' do
+    it 'should work' do
+      response = api_instance.test_authentication
+      expect(response.status).to eq 'success'
     end
   end
-
 end