form_api 1.0.0 → 1.1.0

data/lib/form_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 3.3.0-SNAPSHOT
 =end
 
 module FormAPI
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/api/{client_spec.rb → client_integration_spec.rb}

@@ -32,6 +32,26 @@ describe FormAPI::Client do
       expect(submission.state).to eq 'processed'
       expect(submission.download_url).to include 'submissions/submission.pdf'
     end
+
+    it 'should handle invalid data errors' do
+      client = FormAPI::Client.new
+      template_id = 'tpl_000000000000000001'
+
+      expect(client).to_not receive(:sleep)
+
+      expect {
+        client.generate_pdf(
+          template_id: template_id,
+          data: {
+            title: 'Test PDF'
+          }
+        )
+      }.to raise_error(
+        FormAPI::ApiError,
+        'Unprocessable Entity: The root object did not contain a ' \
+          "required property of 'description'"
+      )
+    end
   end
 
   describe '#batch_generate_pdfs' do

data/spec/api/{pdf_api_spec.rb → pdf_api_integration_spec.rb}

@@ -140,6 +140,25 @@ describe 'PDFApi' do
       expect(response.combined_submission.state).to eq 'pending'
     end
   end
+  # integration tests for create_data_request_token
+  # Creates a new data request token for form authentication
+  # @param data_request_id
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubmissionDataRequestTokenResponse]
+  describe 'create_data_request_token test' do
+    it 'should work' do
+      data_request_id = 'drq_000000000000000001' # String |
+      response = api_instance.create_data_request_token(data_request_id)
+      expect(response.status).to eq 'success'
+      expect(response.token.id).to_not be_nil
+      expect(response.token.secret).to_not be_nil
+      expect(response.token.data_request_url).to start_with \
+        'http://localhost/data_requests/drq_000000000000000001?token_id='
+      expect(response.token.data_request_url).to include \
+        "?token_id=#{response.token.id}" \
+        "&token_secret=#{response.token.secret}"
+    end
+  end
   # integration tests for expire_combined_submission
   # Expire a combined submission
   # @param combined_submission_id
@@ -197,6 +216,26 @@ describe 'PDFApi' do
       expect(combined_submission.id).to start_with 'com_'
     end
   end
+  # integration tests for get_data_request
+  # Look up a submission data request
+  # @param data_request_id
+  # @param [Hash] opts the optional parameters
+  # @return [SubmissionDataRequest]
+  describe 'get_data_request test' do
+    it 'should work' do
+      data_request_id = 'drq_000000000000000001' # String |
+      data_request = api_instance.get_data_request(data_request_id)
+      expect(data_request.id).to start_with 'drq_'
+      expect(data_request.order).to eq 1
+      expect(data_request.name).to eq 'John Doe'
+      expect(data_request.email).to eq 'jdoe@example.com'
+      expect(data_request.fields).to eq ['description']
+      expect(data_request.metadata).to eq(user_id: 123)
+      expect(data_request.state).to eq 'pending'
+      expect(data_request.viewed_at).to eq '2018-10-23T13:00:00Z'
+      expect(data_request.completed_at).to be_nil
+    end
+  end
   # integration tests for get_submission
   # Check the status of a PDF
   # @param submission_id

data/spec/api/pdf_api_spec_original.skipped.rb

@@ -0,0 +1,207 @@
+=begin
+#API V1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for FormAPI::PDFApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PDFApi' do
+  before do
+    FormAPI.configure do |c|
+      c.username  = 'api_token123'
+      c.password  = 'testsecret123'
+      c.host = 'localhost:31337'
+      c.scheme = 'http'
+    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(api_instance).to be_instance_of(FormAPI::PDFApi)
+    end
+  end
+
+  # integration tests for batch_generate_pdf_v1
+  # Generates multiple PDFs
+  # @param template_id 
+  # @param create_submission_data 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<CreateSubmissionBatchV1SubmissionsResponse>]
+  describe 'batch_generate_pdf_v1 test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001' # String | 
+      create_submission_data = nil # Array<CreateSubmissionData> | 
+      result = api_instance.batch_generate_pdf_v1(template_id, create_submission_data)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for batch_generate_pdfs
+  # Generates multiple PDFs
+  # @param submission_batch_data 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubmissionBatchResponse]
+  describe 'batch_generate_pdfs test' do
+    it 'should work' do
+      submission_batch_data = FormAPI::SubmissionBatchData.new # SubmissionBatchData | 
+      result = api_instance.batch_generate_pdfs(submission_batch_data)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for combine_submissions
+  # Merge generated PDFs together
+  # @param combined_submission_data 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateCombinedSubmissionResponse]
+  describe 'combine_submissions test' do
+    it 'should work' do
+      combined_submission_data = FormAPI::CombinedSubmissionData.new # CombinedSubmissionData | 
+      result = api_instance.combine_submissions(combined_submission_data)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for create_data_request_token
+  # Creates a new data request token for form authentication
+  # @param data_request_id 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubmissionDataRequestTokenResponse]
+  describe 'create_data_request_token test' do
+    it 'should work' do
+      data_request_id = 'drq_000000000000000001' # String | 
+      result = api_instance.create_data_request_token(data_request_id)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for expire_combined_submission
+  # Expire a combined submission
+  # @param combined_submission_id 
+  # @param [Hash] opts the optional parameters
+  # @return [CombinedSubmission]
+  describe 'expire_combined_submission test' do
+    it 'should work' do
+      combined_submission_id = 'com_000000000000000001' # String | 
+      result = api_instance.expire_combined_submission(combined_submission_id)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for expire_submission
+  # Expire a PDF submission
+  # @param submission_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Submission]
+  describe 'expire_submission test' do
+    it 'should work' do
+      submission_id = 'sub_000000000000000001' # String | 
+      result = api_instance.expire_submission(submission_id)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for generate_pdf
+  # Generates a new PDF
+  # @param template_id 
+  # @param create_submission_data 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubmissionResponse]
+  describe 'generate_pdf test' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001' # String | 
+      create_submission_data = FormAPI::CreateSubmissionData.new # CreateSubmissionData | 
+      result = api_instance.generate_pdf(template_id, create_submission_data)
+      expect(result).to_not be_nil
+    end
+  end
+  # 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 [CombinedSubmission]
+  describe 'get_combined_submission test' do
+    it 'should work' do
+      combined_submission_id = 'com_000000000000000001' # String | 
+      result = api_instance.get_combined_submission(combined_submission_id)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for get_data_request
+  # Look up a submission data request
+  # @param data_request_id 
+  # @param [Hash] opts the optional parameters
+  # @return [SubmissionDataRequest]
+  describe 'get_data_request test' do
+    it 'should work' do
+      data_request_id = 'drq_000000000000000001' # String | 
+      result = api_instance.get_data_request(data_request_id)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for get_submission
+  # Check the status of a PDF
+  # @param submission_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Submission]
+  describe 'get_submission test' do
+    it 'should work' do
+      submission_id = 'sub_000000000000000001' # String | 
+      result = api_instance.get_submission(submission_id)
+      expect(result).to_not be_nil
+    end
+  end
+  # integration tests for get_submission_batch
+  # Check the status of a submission batch job
+  # @param submission_batch_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :include_submissions 
+  # @return [SubmissionBatch]
+  describe 'get_submission_batch test' do
+    it 'should work' do
+      submission_batch_id = 'sba_000000000000000001' # String | 
+      opts = {
+        include_submissions: true # BOOLEAN | 
+      }
+      result = api_instance.get_submission_batch(submission_batch_id, opts)
+      expect(result).to_not be_nil
+    end
+  end
+  # 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<Template>]
+  describe 'get_templates test' do
+    it 'should work' do
+      opts = {
+        page: 2, # Integer | Default: 1
+        per_page: 1 # Integer | Default: 50
+      }
+      result = api_instance.get_templates(opts)
+      expect(result).to_not be_nil
+    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
+      result = api_instance.test_authentication
+      expect(result).to_not be_nil
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -14,6 +14,7 @@ require 'spec_helper'
 
 describe FormAPI::Configuration do
   let(:config) { FormAPI::Configuration.default }
+  let(:new_config) { FormAPI::Configuration.new }
 
   before(:each) do
     # uncomment below to setup host and base_path
@@ -25,6 +26,16 @@ describe FormAPI::Configuration do
     # end
   end
 
+  it 'adds aliases for #api_token_*, and loads the api token from ENV variables' do
+    ENV['FORMAPI_TOKEN_ID'] = 'test_token_id_from_env'
+    ENV['FORMAPI_TOKEN_SECRET'] = 'test_token_secret_from_env'
+
+    expect(new_config.username).to eq 'test_token_id_from_env'
+    expect(new_config.api_token_id).to eq 'test_token_id_from_env'
+    expect(new_config.password).to eq 'test_token_secret_from_env'
+    expect(new_config.api_token_secret).to eq 'test_token_secret_from_env'
+  end
+
   describe '#base_url' do
     it 'should have the default value' do
       # uncomment below to test default value of the base path

data/spec/models/{create_submission_response1_spec.rb → create_submission_batch_submissions_response_spec.rb}

@@ -14,22 +14,22 @@ require 'spec_helper'
 require 'json'
 require 'date'
 
-# Unit tests for FormAPI::CreateSubmissionResponse1
+# Unit tests for FormAPI::CreateSubmissionBatchSubmissionsResponse
 # Automatically generated by openapi-generator (https://openapi-generator.tech)
 # Please update as you see appropriate
-describe 'CreateSubmissionResponse1' do
+describe 'CreateSubmissionBatchSubmissionsResponse' do
   before do
     # run before each test
-    @instance = FormAPI::CreateSubmissionResponse1.new
+    @instance = FormAPI::CreateSubmissionBatchSubmissionsResponse.new
   end
 
   after do
     # run after each test
   end
 
-  describe 'test an instance of CreateSubmissionResponse1' do
-    it 'should create an instance of CreateSubmissionResponse1' do
-      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionResponse1)
+  describe 'test an instance of CreateSubmissionBatchSubmissionsResponse' do
+    it 'should create an instance of CreateSubmissionBatchSubmissionsResponse' do
+      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionBatchSubmissionsResponse)
     end
   end
   describe 'test attribute "submission"' do

data/spec/models/create_submission_batch_v1_submissions_response_spec.rb

@@ -0,0 +1,57 @@
+=begin
+#API V1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FormAPI::CreateSubmissionBatchV1SubmissionsResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CreateSubmissionBatchV1SubmissionsResponse' do
+  before do
+    # run before each test
+    @instance = FormAPI::CreateSubmissionBatchV1SubmissionsResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CreateSubmissionBatchV1SubmissionsResponse' do
+    it 'should create an instance of CreateSubmissionBatchV1SubmissionsResponse' do
+      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionBatchV1SubmissionsResponse)
+    end
+  end
+  describe 'test attribute "submission"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "errors"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["success", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+end

data/spec/models/create_submission_data_request_token_response_spec.rb

@@ -0,0 +1,57 @@
+=begin
+#API V1
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FormAPI::CreateSubmissionDataRequestTokenResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CreateSubmissionDataRequestTokenResponse' do
+  before do
+    # run before each test
+    @instance = FormAPI::CreateSubmissionDataRequestTokenResponse.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CreateSubmissionDataRequestTokenResponse' do
+    it 'should create an instance of CreateSubmissionDataRequestTokenResponse' do
+      expect(@instance).to be_instance_of(FormAPI::CreateSubmissionDataRequestTokenResponse)
+    end
+  end
+  describe 'test attribute "errors"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["success", "error"])
+      # validator.allowable_values.each do |value|
+      #   expect { @instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "token"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end