form_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16637dd3f1d35a14cb131ac8ebf6432498d67906
-  data.tar.gz: c99c0ad76de1990a41656289284b2dc32c8faf43
+  metadata.gz: a43920ddce58d1e34829ae44d775d6f533a2bd62
+  data.tar.gz: 4aa5e61ffdf7c1426a55d104e679e4623495e2bf
 SHA512:
-  metadata.gz: 0cfef6e030171349458ef9c01d50464e26354da4fe13ab60e2123e276bbbc01ff1b9bb0b9350e88a77d4bbbf816f45b72b85cf0bab88502690f54fa4ec55dba4
-  data.tar.gz: 3bb5fc4eb9359d1077ee0e59e36cfec537a1386dd4aa48491619bb3c655b457c629c00dde923e9223fc1b0a9442862dc71459dee69fdec5c0dc4d5b5f434d6fd
+  metadata.gz: f281aa2c9f5a2dbfcb41cd3996c62bd20db86ae4ccd62c494bbfc80e4077a1f94860e20f2490e535ed96a7534223b310613bf964c6034c3638f9e79b2c291c27
+  data.tar.gz: 497aeb7db329614c0337da92b70241bd47b044d7e869055bcc1816cef3008a890b6cc7065447aaa49f548e092fb0b8f167342a22cbf87a5e0b62c94715ac99cb

data/README.md

@@ -5,7 +5,11 @@ This is a Ruby gem for using [FormAPI](https://formapi.io) to generate PDF docum
 
 ## Installation
 
-Add the following to your `Gemfile`.
+```bash
+gem install form_api
+```
+
+Or add the following to your `Gemfile`.
 
 ```ruby
 gem "form_api"
@@ -20,25 +24,26 @@ bundle install
 
 ## Usage
 
-See [examples](examples/) for runnable examples with file output, error handling, etc.
+See [examples](examples/) for runnable examples.
 
 ```ruby
 FormAPI.configure do |config|
-  config.username = "YOUR_API_KEY_HERE"
-  # config.debugging = true
+  config.username = "YOUR_API_TOKEN_ID"
+  config.password = "YOUR_API_TOKEN_SECRET"
 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:      '<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
     name: "foo",
     number: 42
-  },
-  key: "<CUSTOM_KEY>",                                            # Helps you find a PDF later
+  }
 )
+
+
 ```
 
 This submits a PDF request and waits for the job to finish.
@@ -46,14 +51,15 @@ This submits a PDF request and waits for the job to finish.
 
 ## More Help
 
-See the FormAPI documentation for more information.
+See the [FormAPI documentation](https://formapi.io/docs) for more information.
 
-Please [email us](mailto:support@formapi.io) if you need help.
+Please [email us](mailto:support@formapi.io) if you need any help.
 
 
 ## Development
 
-The majority of the code in this repo is generated using swagger-codegen on [formapi.yaml](formapi.yaml). You can modify this file and regenerate the client using `script/generate_language ruby`.
+The majority of the code in this repo is generated using swagger-codegen.
+You can modify this file and regenerate the client using `scripts/generate`.
 
 
 ## Release Process

data/examples/generate_and_download_pdf.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+#
+# This example demonstrates generating a PDF from a preconfigured template,
+# and downloading the PDF to a local file.
+#
+# You can run this example with: ./examples/generate_and_download_pdf.rb
+
+require "bundler/setup"
+Bundler.require
+
+API_TOKEN_ID = 'yRaaR9JmTPtGX7EN'
+API_TOKEN_SECRET = 'IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec'
+TEMPLATE_ID = '6zz3dYRYM67fxMXA'
+
+PDF_FILENAME = '/tmp/formapi-test.pdf'
+
+begin
+  FormAPI.configure do |c|
+    c.username  = API_TOKEN_ID               # Your API Token ID
+    c.password  = API_TOKEN_SECRET           # Your API Token Secret
+    # c.debugging = true
+  end
+
+  formapi = FormAPI::Client.new
+
+  puts "Downloading PDF to #{PDF_FILENAME}..."
+
+  formapi.generate_and_download_pdf(
+    template_id: '6zz3dYRYM67fxMXA',
+    filename: PDF_FILENAME,
+    data: {
+      first_name: 'John',
+      last_name: 'Smith',
+      favorite_color: 'Blue'
+    }
+  )
+
+  puts "PDF was downloaded to /tmp/formapi-test.pdf"
+
+  # Open the PDF on Mac or Linux.
+  `type xdg-open > /dev/null 2>&1 && xdg-open '#{PDF_FILENAME}' || open '#{PDF_FILENAME}'`
+
+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/examples/generate_pdf.rb

@@ -1,28 +1,32 @@
 #!/usr/bin/env ruby
+#
 # This example demonstrates generating a PDF from a preconfigured template,
-# and downloading the PDF to a local file.
+# and waiting for the PDF to be processed.
 #
 # You can run this example with: ./examples/generate_pdf.rb
 
 require "bundler/setup"
 Bundler.require
 
-PDF_FILENAME = '/tmp/formapi-test.pdf'
+API_TOKEN_ID = 'yRaaR9JmTPtGX7EN'
+API_TOKEN_SECRET = 'IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec'
+TEMPLATE_ID = '6zz3dYRYM67fxMXA'
+
 
 begin
   FormAPI.configure do |c|
-    c.username  = "yRaaR9JmTPtGX7EN"                              # Your API Token ID
-    c.password  = "IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec"   # Your API Token Secret
+    c.username  = API_TOKEN_ID               # Your API Token ID
+    c.password  = API_TOKEN_SECRET           # Your API Token Secret
     # c.debugging = true
   end
 
   formapi = FormAPI::Client.new
 
-  puts "Downloading PDF to /tmp/formapi-test.pdf..."
+  puts "Generating PDF and waiting until ready..."
 
-  formapi.generate_and_download_pdf(
-    template_id: '6zz3dYRYM67fxMXA',
-    filename: PDF_FILENAME,
+  response = formapi.generate_pdf(
+    template_id: TEMPLATE_ID,
+    test: true,
     data: {
       first_name: 'John',
       last_name: 'Smith',
@@ -30,10 +34,8 @@ begin
     }
   )
 
-  puts "PDF was downloaded to /tmp/formapi-test.pdf"
-
-  # Open the PDF on Mac or Linux.
-  `type xdg-open > /dev/null 2>&1 && xdg-open '#{PDF_FILENAME}' || open '#{PDF_FILENAME}'`
+  puts "PDF was generated:"
+  puts response
 
 rescue FormAPI::ApiError => ex
   puts "#{ex.class}: #{ex.message}"

data/examples/generate_pdf_no_wait.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+#
+# This example demonstrates generating a PDF from a preconfigured template,
+# and NOT waiting for the PDF to be processed.
+#
+# You can run this example with: ./examples/generate_pdf.rb
+
+require "bundler/setup"
+Bundler.require
+
+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
+    c.password  = API_TOKEN_SECRET           # Your API Token Secret
+    # c.debugging = true
+  end
+
+  formapi = FormAPI::Client.new
+
+  puts "Generating PDF, but not waiting for job to finish processing..."
+
+  response = formapi.generate_pdf(
+    template_id: TEMPLATE_ID,
+    wait: false,
+    data: {
+      first_name: 'John',
+      last_name: 'Smith',
+      favorite_color: 'Blue'
+    }
+  )
+
+  puts "PDF job was submitted:"
+  puts response
+
+  submission = response.submission
+  while submission.state == 'pending'
+    sleep 1
+    submission = formapi.get_submission(response.submission.id)
+  end
+
+  puts "PDF finished processing:"
+  puts submission
+
+
+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

@@ -10,22 +10,28 @@ module FormAPI
     class PollTimeoutError < ApiError; end
     class InvalidResponseError < ApiError; end
 
-    def generate_pdf(template_id, opts = {})
+    def generate_pdf(opts = {})
       unless opts[:data].kind_of?(::Hash)
         raise InvalidDataError, ":data is required, and must be a Hash."
       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] = { data: opts.delete(:data) }
 
+      template_id = opts.delete :template_id
       response = super(template_id, opts)
+
       return response unless opts[:wait]
 
+      submission = response.submission
       timeout = opts[:timeout] || 60
       start_time = Time.now
 
-      submission = response.submission
-
       # Wait for submission to be ready
       while submission.state != 'processed'
         sleep 1
@@ -43,17 +49,14 @@ module FormAPI
     end
 
     def generate_and_download_pdf(opts = {})
-      template_id = opts.delete :template_id
       filename = opts.delete :filename
 
-      response = generate_pdf(template_id, opts.merge(wait: true))
+      response = generate_pdf(opts.merge(wait: true))
       submission = response.submission
 
       pdf_response = Typhoeus.get(submission.download_url, followlocation: true)
 
-      File.open(filename, 'wb') do |f|
-        f.write pdf_response.body
-      end
+      File.open(filename, 'wb') { |f| f.write pdf_response.body }
 
       response
     end

data/lib/form_api/models/data.rb

@@ -15,12 +15,15 @@ require 'date'
 module FormAPI
 
   class Data
+    attr_accessor :test
+
     attr_accessor :data
 
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'test' => :'test',
         :'data' => :'data'
       }
     end
@@ -28,6 +31,7 @@ module FormAPI
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'test' => :'BOOLEAN',
         :'data' => :'Object'
       }
     end
@@ -40,6 +44,10 @@ module FormAPI
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
+      if attributes.has_key?(:'test')
+        self.test = attributes[:'test']
+      end
+
       if attributes.has_key?(:'data')
         self.data = attributes[:'data']
       end
@@ -69,6 +77,7 @@ module FormAPI
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          test == o.test &&
           data == o.data
     end
 
@@ -81,7 +90,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [data].hash
+      [test, data].hash
     end
 
     # Builds the object from hash

data/lib/form_api/models/inline_response_201_submission.rb

@@ -17,6 +17,8 @@ module FormAPI
   class InlineResponse201Submission
     attr_accessor :id
 
+    attr_accessor :test
+
     attr_accessor :state
 
     attr_accessor :download_url
@@ -47,6 +49,7 @@ module FormAPI
     def self.attribute_map
       {
         :'id' => :'id',
+        :'test' => :'test',
         :'state' => :'state',
         :'download_url' => :'download_url'
       }
@@ -56,6 +59,7 @@ module FormAPI
     def self.swagger_types
       {
         :'id' => :'String',
+        :'test' => :'BOOLEAN',
         :'state' => :'String',
         :'download_url' => :'String'
       }
@@ -73,6 +77,10 @@ module FormAPI
         self.id = attributes[:'id']
       end
 
+      if attributes.has_key?(:'test')
+        self.test = attributes[:'test']
+      end
+
       if attributes.has_key?(:'state')
         self.state = attributes[:'state']
       end
@@ -124,6 +132,7 @@ module FormAPI
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          test == o.test &&
           state == o.state &&
           download_url == o.download_url
     end
@@ -137,7 +146,7 @@ module FormAPI
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, state, download_url].hash
+      [id, test, state, download_url].hash
     end
 
     # Builds the object from hash

data/lib/form_api/version.rb

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

data/scripts/generate

@@ -0,0 +1,22 @@
+#!/bin/sh
+set -e
+cd "$(dirname "$0")/.."
+
+LANGUAGE=ruby
+CONFIG_FILE="swagger-config.json"
+
+if [ ! -f "$CONFIG_FILE" ]; then
+  echo "Could not find $CONFIG_FILE"
+  ./scripts/swagger config-help -l "$LANGUAGE"
+  exit 1
+fi
+
+./scripts/clean
+
+./scripts/swagger generate \
+  -i ../form_api/swagger/v1/swagger.json \
+  -l "$LANGUAGE" \
+  -c "$CONFIG_FILE"
+
+# call a generator cleanup script
+./scripts/post_generate

data/scripts/post_generate

@@ -0,0 +1,14 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+echo "Removing trailing whitespace..."
+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
+
+echo "Injecting extensions..."
+sed -i "s/require 'form_api\/api\/pdf_api'/\
+require File.join(File.dirname(__FILE__), '..\/extensions\/lib\/form_api\/api\/client')/" \
+lib/form_api.rb

data/swagger-config.json

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: form_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Form Services Ltd.
@@ -247,7 +247,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/generate_and_download_pdf.rb
 - examples/generate_pdf.rb
+- examples/generate_pdf_no_wait.rb
 - extensions/lib/form_api/api/client.rb
 - form_api.gemspec
 - lib/form_api.rb
@@ -261,12 +263,12 @@ files:
 - lib/form_api/models/inline_response_401.rb
 - lib/form_api/models/inline_response_422.rb
 - lib/form_api/version.rb
-- script/clean
-- script/fix_gemspec.rb
-- script/generate_language
-- script/post_generate_language
-- script/swagger
-- script/test
+- scripts/clean
+- scripts/fix_gemspec.rb
+- scripts/generate
+- scripts/post_generate
+- scripts/swagger
+- scripts/test
 - spec/api/pdf_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb

data/script/generate_language

@@ -1,35 +0,0 @@
-#!/bin/sh
-set -e
-cd "$(dirname "$0")/.."
-
-LANGUAGE="$1"
-CONFIG_FILE="swagger-config.json"
-
-if [ "$LANGUAGE" = "" ]; then
-  ./script/swagger # prints languages
-  exit 1
-fi
-
-if [ ! -f "$CONFIG_FILE" ]; then
-  echo "Could not find $CONFIG_FILE"
-  ./script/swagger config-help -l "$LANGUAGE"
-  exit 1
-fi
-
-./script/clean
-
-./script/swagger generate \
-  -i ../form_api/swagger/v1/swagger.json \
-  -l "$LANGUAGE" \
-  -c "$CONFIG_FILE"
-
-# call a generator cleanup script
-if [ -f "script/post_generate_language" ]; then
-  ./script/post_generate_language
-fi
-
-
-# Inject extensions
-sed -i "s/require 'form_api\/api\/pdf_api'/\
-require File.join(File.dirname(__FILE__), '..\/extensions\/lib\/form_api\/api\/client')/" \
-lib/form_api.rb

data/script/post_generate_language

@@ -1,9 +0,0 @@
-#!/bin/sh
-set -e
-cd "`dirname \"$0\"`/.."
-
-echo "Removing trailing whitespace..."
-find lib -name "*.rb" -type f -exec sed -E -i 's/[[:space:]]+$//g' {} +
-
-echo "Fixing gemspec to work around swagger..."
-ruby script/fix_gemspec.rb