docspring 1.0.0

data/lib/docspring/version.rb

@@ -0,0 +1,15 @@
+=begin
+#API v1
+
+#DocSpring is a service that helps you fill out and sign PDF templates.
+
+OpenAPI spec version: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.0-SNAPSHOT
+
+=end
+
+module DocSpring
+  VERSION = '1.0.0'
+end

data/spec/api/client_integration_spec.rb

@@ -0,0 +1,259 @@
+require 'spec_helper'
+require 'json'
+
+describe DocSpring::Client do
+  before do
+    DocSpring.configure do |c|
+      c.api_token_id = 'api_token123'
+      c.api_token_secret = 'testsecret123'
+      c.host = 'http://api.docspring.local:31337'
+    end
+  end
+
+  describe '#generate_pdf' do
+    it 'should generate a PDF and wait for the submission to be processed' do
+      client = DocSpring::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
+
+    it 'should handle invalid data errors' do
+      client = DocSpring::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(
+        DocSpring::ApiError,
+        'Unprocessable Entity: The root object did not contain a ' \
+          "required property of 'description'"
+      )
+    end
+  end
+
+  describe '#batch_generate_pdfs' do
+    it 'should submit a batch job and wait for all jobs to be processed' do
+      client = DocSpring::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 'sbb_'
+      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 = DocSpring::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 'sbb_'
+      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 with submission_ids' do
+    it 'should merge multiple PDFs and wait for the job to be processed' do
+      client = DocSpring::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.source_pdfs).to eq(
+        [
+          { type: 'submission', id: 'sub_000000000000000001' },
+          { type: 'submission', id: 'sub_000000000000000002' }
+        ]
+      )
+      # Backwards compatibility - We still set submission_ids
+      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 '#combine_pdfs with source_pdfs' do
+    it 'should merge multiple PDFs and wait for the job to be processed' do
+      client = DocSpring::Client.new
+      expect(client).to receive(:sleep).with(1).once
+
+      response = client.combine_pdfs(
+        source_pdfs: [
+          { type: 'submission', id: 'sub_000000000000000001' },
+          { type: 'template',   id: 'tpl_000000000000000001' },
+          { type: 'submission', id: '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.source_pdfs).to eq(
+        [
+          { type: 'submission', id: 'sub_000000000000000001' },
+          { type: 'template',   id: 'tpl_000000000000000001' },
+          { type: 'submission', id: '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 = DocSpring::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_integration_spec.rb

@@ -0,0 +1,377 @@
+=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 DocSpring::PDFApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PDFApi' do
+  before do
+    DocSpring.configure do |c|
+      c.api_token_id = 'api_token123'
+      c.api_token_secret = 'testsecret123'
+      c.host = 'http://api.docspring.local:31337'
+    end
+  end
+
+  let(:api_instance) { DocSpring::PDFApi.new }
+
+  after do
+    # run after each test
+  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<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 'sbb_'
+      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
+
+  describe 'get_submission_batch test' do
+    it 'should get the batch including submissions' do
+      submission_batch_id = 'sbb_000000000000000001'
+      batch = api_instance.get_submission_batch(submission_batch_id, include_submissions: true)
+      expect(batch.id).to eq 'sbb_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 = 'sbb_000000000000000001'
+      batch = api_instance.get_submission_batch(submission_batch_id)
+      expect(batch.id).to eq 'sbb_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 [CombinedSubmissionData] :combined_submission_data
+  # @return [CreateCombinedSubmissionResponse]
+  describe 'combine_submissions test' do
+    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
+  # 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://app.docspring.local/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
+  # @param [Hash] opts the optional parameters
+  # @return [CombinedSubmission]
+  describe 'expire_combined_submission test' do
+    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
+  # 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'
+      submission = api_instance.expire_submission(submission_id)
+      expect(submission.expired).to eq true
+    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'
+      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
+  # integration tests for generate_pdf with data requests
+  # Generates a new PDF
+  # @param template_id
+  # @param create_submission_data
+  # @param [Hash] opts the optional parameters
+  # @return [CreateSubmissionResponse]
+  describe 'generate_pdf test with data_requests' do
+    it 'should work' do
+      template_id = 'tpl_000000000000000001'
+      response = api_instance.generate_pdf(template_id,
+        data: {
+          title: 'Test PDF',
+        },
+        data_requests: [
+          {
+            name: 'John Smith',
+            email: 'jsmith@example.com',
+            fields: ['description'],
+            order: 1,
+            auth_type: 'email_link',
+          }
+        ]
+      )
+      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 'waiting_for_data_requests'
+
+      data_requests = submission.data_requests
+      expect(data_requests.count).to eq 1
+      data_request = data_requests.first
+
+      expect(data_request.id).to start_with 'drq_'
+      expect(data_request.state).to eq 'pending'
+      expect(data_request.fields).to eq ['description']
+      expect(data_request.order).to eq 1
+      expect(data_request.name).to eq 'John Smith'
+      expect(data_request.email).to eq 'jsmith@example.com'
+    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'
+      combined_submission = api_instance.get_combined_submission(combined_submission_id)
+      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 be_nil
+      expect(data_request.completed_at).to be_nil
+    end
+  end
+
+  # integration tests for update_data_request
+  # Update a submission data request
+  # @param data_request_id
+  # @param [Hash] opts the optional parameters
+  # @return [SubmissionDataRequest]
+  describe 'update_data_request test' do
+    it 'should work' do
+      data_request_id = 'drq_000000000000000001' # String |
+      response = api_instance.update_data_request(
+        data_request_id,
+        name: 'Harry Smith',
+        email: 'hsmith@example.com',
+        order: 2,
+        fields: ['title'],
+        metadata: { user_id: 345 },
+        auth_type: 'oauth',
+        auth_provider: 'twitter',
+        auth_session_started_at: '2018-10-23T13:00:00Z'
+      )
+      expect(response.status).to eq 'success'
+      data_request = response.data_request
+      expect(data_request.id).to start_with 'drq_'
+      # Not allowed to update order, name, email, fields
+      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: 345)
+      expect(data_request.state).to eq 'pending'
+      expect(data_request.viewed_at).to be_nil
+      expect(data_request.completed_at).to be_nil
+      expect(data_request.auth_type).to eq 'oauth'
+      expect(data_request.auth_provider).to eq 'twitter'
+      expect(data_request.auth_session_started_at).to eq '2018-10-23T13:00:00Z'
+    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'
+      submission = api_instance.get_submission(submission_id)
+      expect(submission.id).to start_with 'sub_'
+    end
+  end
+  # integration tests for list_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 'list_templates test' do
+    it 'should work' do
+      opts = {
+        query: 'API Client Test Template 2', # String | Search By Name
+        page: 1, # Integer | Default: 1
+        per_page: 10 # Integer | Default: 50
+      }
+      templates = api_instance.list_templates(opts)
+      expect(templates.size).to eq 1
+      expect(templates.first.id).to eq 'tpl_000000000000000002'
+    end
+  end
+  # integration tests for list_templates
+  # Get a list of all templates
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :query Search By Name
+  # @option opts [Integer] :page Default: 1
+  # @option opts [Integer] :per_page Default: 50
+  # @return [Array<Template>]
+  describe 'list_templates test' do
+    it 'should work' do
+      opts = {
+        query: '2', # String | Search By Name
+        page: 2, # Integer | Default: 1
+        per_page: 1 # Integer | Default: 50
+      }
+      result = api_instance.list_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
+      response = api_instance.test_authentication
+      expect(response.status).to eq 'success'
+    end
+  end
+end