form_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a43920ddce58d1e34829ae44d775d6f533a2bd62
-  data.tar.gz: 4aa5e61ffdf7c1426a55d104e679e4623495e2bf
+  metadata.gz: b369e863ec1ebe4a6916db2835f07fbb1579e318
+  data.tar.gz: ea11624eee27b90f5dd8c2ba6fb9d7a93fc4b1dd
 SHA512:
-  metadata.gz: f281aa2c9f5a2dbfcb41cd3996c62bd20db86ae4ccd62c494bbfc80e4077a1f94860e20f2490e535ed96a7534223b310613bf964c6034c3638f9e79b2c291c27
-  data.tar.gz: 497aeb7db329614c0337da92b70241bd47b044d7e869055bcc1816cef3008a890b6cc7065447aaa49f548e092fb0b8f167342a22cbf87a5e0b62c94715ac99cb
+  metadata.gz: e0cf854c6b6090954b76e42e2b1597b5be490c65aa2f55a53415735737b1a435b60568d343d72cd161cc906a395d8a004e29035347b1412995816ebec406f721
+  data.tar.gz: a3d25bbbd7c00de727675666beee16314867f9d3607cdd03fe3ef42650d5ed8b9359042a010900309a759dc3ea7d95a4b90a9460b6bad513c2909d915bd8e8c3

data/README.md

@@ -35,15 +35,24 @@ end
 formapi = FormAPI::Client.new
 
 response = formapi.generate_pdf(
-  template_id:      '<TEMPLATE_ID>',   # ID of a template that you have configured
-  test:             true,              # Test documents are free but watermarked
-  template_data: {                     # Data to fill in the template
+  template_id: 'YOUR_TEMPLATE_ID',   # ID of a template that you have configured
+  test: true,                        # Test documents are free but watermarked
+  wait: true,                        # Wait for the PDF to be processed   (default: true)
+  data: {                            # Data to render in the template
     name: "foo",
     number: 42
   }
 )
 
-
+# {
+#   status: "success",
+#   submission: {
+#     id: "bymRSZYTKDnd6jfY",
+#     test: true,
+#     state: "processed",
+#     download_url: "https://..."
+#   }
+# }
 ```
 
 This submits a PDF request and waits for the job to finish.

data/examples/generate_and_download_pdf.rb

@@ -8,10 +8,11 @@
 require "bundler/setup"
 Bundler.require
 
+# This is a real test API token and template on formapi.io
+# -------------------------------------------------------------
 API_TOKEN_ID = 'yRaaR9JmTPtGX7EN'
 API_TOKEN_SECRET = 'IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec'
 TEMPLATE_ID = '6zz3dYRYM67fxMXA'
-
 PDF_FILENAME = '/tmp/formapi-test.pdf'
 
 begin
@@ -23,10 +24,10 @@ begin
 
   formapi = FormAPI::Client.new
 
-  puts "Downloading PDF to #{PDF_FILENAME}..."
+  puts "Generating PDF..."
 
-  formapi.generate_and_download_pdf(
-    template_id: '6zz3dYRYM67fxMXA',
+  response = formapi.generate_pdf(
+    template_id: TEMPLATE_ID,
     filename: PDF_FILENAME,
     data: {
       first_name: 'John',
@@ -35,10 +36,22 @@ begin
     }
   )
 
-  puts "PDF was downloaded to /tmp/formapi-test.pdf"
+  puts "Downloading PDF to #{PDF_FILENAME}..."
 
-  # Open the PDF on Mac or Linux.
-  `type xdg-open > /dev/null 2>&1 && xdg-open '#{PDF_FILENAME}' || open '#{PDF_FILENAME}'`
+  # Note: This example uses the Typhoeus library to download the file as a stream.
+  # This is a good way to download files, since the whole file is not loaded into memory.
+  # (The form_api gem includes Typhoeus as a dependency.)
+  downloaded_file = File.open PDF_FILENAME, 'wb'
+  request = Typhoeus::Request.new(response.submission.download_url)
+  request.on_body { |chunk| downloaded_file.write(chunk) }
+  request.on_complete do |response|
+    downloaded_file.close
+
+    puts "PDF was downloaded!"
+    # Open the downloaded PDF on Mac or Linux.
+    `type xdg-open > /dev/null 2>&1 && xdg-open '#{PDF_FILENAME}' || open '#{PDF_FILENAME}'`
+  end
+  request.run
 
 rescue FormAPI::ApiError => ex
   puts "#{ex.class}: #{ex.message}"

data/examples/generate_pdf.rb

@@ -8,6 +8,8 @@
 require "bundler/setup"
 Bundler.require
 
+# This is a real test API token and template on formapi.io
+# -------------------------------------------------------------
 API_TOKEN_ID = 'yRaaR9JmTPtGX7EN'
 API_TOKEN_SECRET = 'IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec'
 TEMPLATE_ID = '6zz3dYRYM67fxMXA'

data/examples/generate_pdf_no_wait.rb

@@ -8,10 +8,13 @@
 require "bundler/setup"
 Bundler.require
 
+# This is a real test API token and template on formapi.io
+# -------------------------------------------------------------
 API_TOKEN_ID = 'yRaaR9JmTPtGX7EN'
 API_TOKEN_SECRET = 'IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec'
 TEMPLATE_ID = '6zz3dYRYM67fxMXA'
 
+
 begin
   FormAPI.configure do |c|
     c.username  = API_TOKEN_ID               # Your API Token ID

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

@@ -22,6 +22,9 @@ module FormAPI
 
       # FormAPI requires a nested :data object.
       opts[:data] = { data: opts.delete(:data) }
+      if opts[:metadata]
+        opts[:data][:metadata] = opts.delete(:metadata)
+      end
 
       template_id = opts.delete :template_id
       response = super(template_id, opts)
@@ -47,18 +50,5 @@ module FormAPI
         submission: submission
       )
     end
-
-    def generate_and_download_pdf(opts = {})
-      filename = opts.delete :filename
-
-      response = generate_pdf(opts.merge(wait: true))
-      submission = response.submission
-
-      pdf_response = Typhoeus.get(submission.download_url, followlocation: true)
-
-      File.open(filename, 'wb') { |f| f.write pdf_response.body }
-
-      response
-    end
   end
 end

data/lib/form_api.rb

@@ -20,7 +20,7 @@ require 'form_api/configuration'
 require 'form_api/models/data'
 require 'form_api/models/inline_response_201'
 require 'form_api/models/inline_response_201_submission'
-require 'form_api/models/inline_response_401'
+require 'form_api/models/inline_response_400'
 require 'form_api/models/inline_response_422'
 
 # APIs

data/lib/form_api/api/pdf_api.rb

@@ -20,6 +20,59 @@ module FormAPI
       @api_client = api_client
     end
 
+    # Expire a PDF submission
+    #
+    # @param submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse201Submission]
+    def expire_submission(submission_id, opts = {})
+      data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
+      return data
+    end
+
+    # Expire a PDF submission
+    #
+    # @param submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse201Submission, Fixnum, Hash)>] InlineResponse201Submission 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 ..."
+      end
+      # verify the required parameter 'submission_id' is set
+      if @api_client.config.client_side_validation && submission_id.nil?
+        fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.expire_submission"
+      end
+      # resource path
+      local_var_path = "/submissions/{submission_id}".sub('{' + 'submission_id' + '}', 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 => 'InlineResponse201Submission')
+      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
+      return data, status_code, headers
+    end
+
     # Generates a new PDF
     #
     # @param template_id

data/lib/form_api/models/data.rb

@@ -19,12 +19,15 @@ module FormAPI
 
     attr_accessor :data
 
+    attr_accessor :metadata
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'test' => :'test',
-        :'data' => :'data'
+        :'data' => :'data',
+        :'metadata' => :'metadata'
       }
     end
 
@@ -32,7 +35,8 @@ module FormAPI
     def self.swagger_types
       {
         :'test' => :'BOOLEAN',
-        :'data' => :'Object'
+        :'data' => :'Object',
+        :'metadata' => :'Object'
       }
     end
 
@@ -52,6 +56,10 @@ module FormAPI
         self.data = attributes[:'data']
       end
 
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -78,7 +86,8 @@ module FormAPI
       return true if self.equal?(o)
       self.class == o.class &&
           test == o.test &&
-          data == o.data
+          data == o.data &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -90,7 +99,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [test, data].hash
+      [test, data, metadata].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/inline_response_201_submission.rb

@@ -19,8 +19,14 @@ module FormAPI
 
     attr_accessor :test
 
+    attr_accessor :expired
+
+    attr_accessor :expires_at
+
     attr_accessor :state
 
+    attr_accessor :metadata
+
     attr_accessor :download_url
 
     class EnumAttributeValidator
@@ -50,7 +56,10 @@ module FormAPI
       {
         :'id' => :'id',
         :'test' => :'test',
+        :'expired' => :'expired',
+        :'expires_at' => :'expires_at',
         :'state' => :'state',
+        :'metadata' => :'metadata',
         :'download_url' => :'download_url'
       }
     end
@@ -60,7 +69,10 @@ module FormAPI
       {
         :'id' => :'String',
         :'test' => :'BOOLEAN',
+        :'expired' => :'BOOLEAN',
+        :'expires_at' => :'String',
         :'state' => :'String',
+        :'metadata' => :'Object',
         :'download_url' => :'String'
       }
     end
@@ -81,10 +93,22 @@ module FormAPI
         self.test = attributes[:'test']
       end
 
+      if attributes.has_key?(:'expired')
+        self.expired = attributes[:'expired']
+      end
+
+      if attributes.has_key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
       if attributes.has_key?(:'state')
         self.state = attributes[:'state']
       end
 
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
       if attributes.has_key?(:'download_url')
         self.download_url = attributes[:'download_url']
       end
@@ -99,6 +123,18 @@ module FormAPI
         invalid_properties.push("invalid value for 'id', id cannot be nil.")
       end
 
+      if @test.nil?
+        invalid_properties.push("invalid value for 'test', test cannot be nil.")
+      end
+
+      if @expired.nil?
+        invalid_properties.push("invalid value for 'expired', expired cannot be nil.")
+      end
+
+      if @expires_at.nil?
+        invalid_properties.push("invalid value for 'expires_at', expires_at cannot be nil.")
+      end
+
       if @state.nil?
         invalid_properties.push("invalid value for 'state', state cannot be nil.")
       end
@@ -110,6 +146,9 @@ module FormAPI
     # @return true if the model is valid
     def valid?
       return false if @id.nil?
+      return false if @test.nil?
+      return false if @expired.nil?
+      return false if @expires_at.nil?
       return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed"])
       return false unless state_validator.valid?(@state)
@@ -133,7 +172,10 @@ module FormAPI
       self.class == o.class &&
           id == o.id &&
           test == o.test &&
+          expired == o.expired &&
+          expires_at == o.expires_at &&
           state == o.state &&
+          metadata == o.metadata &&
           download_url == o.download_url
     end
 
@@ -146,7 +188,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, test, state, download_url].hash
+      [id, test, expired, expires_at, state, metadata, download_url].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/{inline_response_401.rb → inline_response_400.rb}

@@ -14,7 +14,7 @@ require 'date'
 
 module FormAPI
 
-  class InlineResponse401
+  class InlineResponse400
     attr_accessor :status
 
     attr_accessor :error

data/lib/form_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.3.0-SNAPSHOT
 =end
 
 module FormAPI
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/scripts/post_generate

@@ -8,6 +8,14 @@ find lib -name "*.rb" -type f -exec sed -E -i 's/[[:space:]]+$//g' {} +
 echo "Fixing gemspec to work around swagger..."
 ruby scripts/fix_gemspec.rb
 
+
+# This is not needed anymore.
+# echo "Adding ':followlocation => true'..."
+# sed -i "s/req_opts = {/\
+# req_opts = {\n        :followlocation => true,/" \
+# lib/form_api/api_client.rb
+
+
 echo "Injecting extensions..."
 sed -i "s/require 'form_api\/api\/pdf_api'/\
 require File.join(File.dirname(__FILE__), '..\/extensions\/lib\/form_api\/api\/client')/" \

data/scripts/release

@@ -0,0 +1,7 @@
+#!/bin/sh
+set -e
+
+./scripts/generate
+rm form_api-*.gem
+gem build form_api.gemspec
+gem push form_api-*.gem

data/spec/models/inline_response_302_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FormAPI::InlineResponse302
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InlineResponse302' do
+  before do
+    # run before each test
+    @instance = FormAPI::InlineResponse302.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InlineResponse302' do
+    it 'should create an instance of InlineResponse302' do
+      expect(@instance).to be_instance_of(FormAPI::InlineResponse302)
+    end
+  end
+  describe 'test attribute "url"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/spec/models/inline_response_400_spec.rb

@@ -0,0 +1,52 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for FormAPI::InlineResponse400
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'InlineResponse400' do
+  before do
+    # run before each test
+    @instance = FormAPI::InlineResponse400.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InlineResponse400' do
+    it 'should create an instance of InlineResponse400' do
+      expect(@instance).to be_instance_of(FormAPI::InlineResponse400)
+    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', ["error"])
+       #validator.allowable_values.each do |value|
+       #  expect { @instance.status = value }.not_to raise_error
+       #end
+    end
+  end
+
+  describe 'test attribute "error"' do
+    it 'should work' do
+       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end
+

data/swagger-config.json

@@ -1,7 +1,7 @@
 {
     "gemName": "form_api",
     "moduleName": "FormAPI",
-    "gemVersion": "0.1.1",
+    "gemVersion": "0.1.2",
     "gemAuthor": "Form Services Ltd.",
     "gemAuthorEmail": "support@formapi.io",
     "gemHomepage": "https://github.com/FormAPI/formapi-ruby",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: form_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Form Services Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -260,13 +260,14 @@ files:
 - lib/form_api/models/data.rb
 - lib/form_api/models/inline_response_201.rb
 - lib/form_api/models/inline_response_201_submission.rb
-- lib/form_api/models/inline_response_401.rb
+- lib/form_api/models/inline_response_400.rb
 - lib/form_api/models/inline_response_422.rb
 - lib/form_api/version.rb
 - scripts/clean
 - scripts/fix_gemspec.rb
 - scripts/generate
 - scripts/post_generate
+- scripts/release
 - scripts/swagger
 - scripts/test
 - spec/api/pdf_api_spec.rb
@@ -275,6 +276,8 @@ files:
 - spec/models/data_spec.rb
 - spec/models/inline_response_201_spec.rb
 - spec/models/inline_response_201_submission_spec.rb
+- spec/models/inline_response_302_spec.rb
+- spec/models/inline_response_400_spec.rb
 - spec/models/inline_response_401_spec.rb
 - spec/models/inline_response_422_spec.rb
 - spec/spec_helper.rb
@@ -310,6 +313,8 @@ test_files:
 - spec/models/data_spec.rb
 - spec/models/inline_response_201_spec.rb
 - spec/models/inline_response_201_submission_spec.rb
+- spec/models/inline_response_302_spec.rb
+- spec/models/inline_response_400_spec.rb
 - spec/models/inline_response_401_spec.rb
 - spec/models/inline_response_422_spec.rb
 - spec/spec_helper.rb