form_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16637dd3f1d35a14cb131ac8ebf6432498d67906
+  data.tar.gz: c99c0ad76de1990a41656289284b2dc32c8faf43
+SHA512:
+  metadata.gz: 0cfef6e030171349458ef9c01d50464e26354da4fe13ab60e2123e276bbbc01ff1b9bb0b9350e88a77d4bbbf816f45b72b85cf0bab88502690f54fa4ec55dba4
+  data.tar.gz: 3bb5fc4eb9359d1077ee0e59e36cfec537a1386dd4aa48491619bb3c655b457c629c00dde923e9223fc1b0a9442862dc71459dee69fdec5c0dc4d5b5f434d6fd

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.byebug_history
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.rvmrc
+
+## Emacs files
+*~
+
+## OSX files
+.DS_Store
+Thumbs.db
+
+## Ignore baked in swagger generator
+swagger-codegen

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.swagger-codegen-ignore

@@ -0,0 +1,31 @@
+# Swagger Codegen Ignore
+# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+README.md
+CHANGELOG.md
+git_push.sh
+docs/
+.gitignore
+LICENSE
+Rakefile

data/.swagger-codegen/VERSION

@@ -0,0 +1 @@
+2.3.0-SNAPSHOT

data/.swagger-revision

@@ -0,0 +1 @@
+28a5b74dbf313529a2fc697d46e9ed870cfd6a30

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### 0.1.0 [October 3, 2017]
+* Initial Release

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright © 2017 Form Services Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# FormAPI Ruby Client
+
+This is a Ruby gem for using [FormAPI](https://formapi.io) to generate PDF documents from configured templates.
+
+
+## Installation
+
+Add the following to your `Gemfile`.
+
+```ruby
+gem "form_api"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+
+## Usage
+
+See [examples](examples/) for runnable examples with file output, error handling, etc.
+
+```ruby
+FormAPI.configure do |config|
+  config.username = "YOUR_API_KEY_HERE"
+  # config.debugging = true
+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
+    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.
+
+
+## More Help
+
+See the FormAPI documentation for more information.
+
+Please [email us](mailto:support@formapi.io) if you need 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`.
+
+
+## Release Process
+
+1. Pull latest master
+2. Merge feature branch(es) into master
+3. `script/test`
+4. Increment version in code:
+  - `swagger-config.json`
+  - `lib/formapi/version.rb`
+5. Update [CHANGELOG.md](CHANGELOG.md)
+6. Commit "Release version vX.Y.Z"
+7. `rake release`
+8. Verify package release at https://rubygems.org/gems/formapi
+9. Refresh documentation on formapi.io
+
+
+## Version Policy
+
+This library follows [Semantic Versioning 2.0.0](http://semver.org).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/examples/generate_pdf.rb

@@ -0,0 +1,43 @@
+#!/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_pdf.rb
+
+require "bundler/setup"
+Bundler.require
+
+PDF_FILENAME = '/tmp/formapi-test.pdf'
+
+begin
+  FormAPI.configure do |c|
+    c.username  = "yRaaR9JmTPtGX7EN"                              # Your API Token ID
+    c.password  = "IB3TRkSdm4f2BdtU_D3YgxjdMB7l-r2fOgvxD1Yzwec"   # Your API Token Secret
+    # c.debugging = true
+  end
+
+  formapi = FormAPI::Client.new
+
+  puts "Downloading PDF to /tmp/formapi-test.pdf..."
+
+  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/extensions/lib/form_api/api/client.rb

@@ -0,0 +1,61 @@
+require 'form_api/api/pdf_api'
+
+# The original 'lib' files are overriden every time we
+# regenerate the client, so custom methods go in here.
+# Also I want to call it "Client".
+
+module FormAPI
+  class Client < PDFApi
+    class InvalidDataError < ApiError; end
+    class PollTimeoutError < ApiError; end
+    class InvalidResponseError < ApiError; end
+
+    def generate_pdf(template_id, opts = {})
+      unless opts[:data].kind_of?(::Hash)
+        raise InvalidDataError, ":data is required, and must be a Hash."
+      end
+
+      # FormAPI requires a nested :data object.
+      opts[:data] = { data: opts.delete(:data) }
+
+      response = super(template_id, opts)
+      return response unless opts[:wait]
+
+      timeout = opts[:timeout] || 60
+      start_time = Time.now
+
+      submission = response.submission
+
+      # Wait for submission to be ready
+      while submission.state != 'processed'
+        sleep 1
+        submission = get_submission(submission.id)
+
+        if Time.now - start_time > timeout
+          raise PollTimeoutError, "PDF was not ready after #{timeout} seconds!"
+        end
+      end
+
+      return InlineResponse201.new(
+        status: submission.state == 'processed' ? 'success' : 'error',
+        submission: submission
+      )
+    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))
+      submission = response.submission
+
+      pdf_response = Typhoeus.get(submission.download_url, followlocation: true)
+
+      File.open(filename, 'wb') do |f|
+        f.write pdf_response.body
+      end
+
+      response
+    end
+  end
+end

data/form_api.gemspec

@@ -0,0 +1,51 @@
+# -*- encoding: utf-8 -*-
+#
+=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
+
+$:.push File.expand_path("../lib", __FILE__)
+require "form_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "form_api"
+  s.version     = FormAPI::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Form Services Ltd."]
+  s.email       = ["support@formapi.io"]
+  s.homepage    = "https://github.com/FormAPI/formapi-ruby"
+  s.summary     = "A client library for the FormAPI PDF generation service"
+  s.description = "A client library for the FormAPI PDF generation service"
+  s.license     = "MIT"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  # added by script/fix_gemspec.rb.
+  s.add_development_dependency 'rake', '~>11.2', '>= 11.2.2'
+  s.add_development_dependency 'pry', '~>0.10', '>= 0.10.4'
+  # </added> : if the above lines are missing in the gemspec, then
+  # the matcher for autotest is probably broken
+
+  s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }
+  s.test_files    = `git ls-files spec test`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/lib/form_api.rb

@@ -0,0 +1,45 @@
+=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
+
+# Common files
+require 'form_api/api_client'
+require 'form_api/api_error'
+require 'form_api/version'
+require 'form_api/configuration'
+
+# Models
+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_422'
+
+# APIs
+require File.join(File.dirname(__FILE__), '../extensions/lib/form_api/api/client')
+
+module FormAPI
+  class << self
+    # Customize default settings for the SDK using block.
+    #   FormAPI.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/form_api/api/pdf_api.rb

@@ -0,0 +1,133 @@
+=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 "uri"
+
+module FormAPI
+  class PDFApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Generates a new PDF
+    #
+    # @param template_id
+    # @param [Hash] opts the optional parameters
+    # @option opts [Data] :data
+    # @return [InlineResponse201]
+    def generate_pdf(template_id, opts = {})
+      data, _status_code, _headers = generate_pdf_with_http_info(template_id, opts)
+      return data
+    end
+
+    # Generates a new PDF
+    #
+    # @param template_id
+    # @param [Hash] opts the optional parameters
+    # @option opts [Data] :data
+    # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
+    def generate_pdf_with_http_info(template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.generate_pdf ..."
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.generate_pdf"
+      end
+      # resource path
+      local_var_path = "/templates/{template_id}/submissions".sub('{' + 'template_id' + '}', template_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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'data'])
+      auth_names = ['basic']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'InlineResponse201')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Check the status of a PDF
+    #
+    # @param submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [InlineResponse201Submission]
+    def get_submission(submission_id, opts = {})
+      data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
+      return data
+    end
+
+    # Check the status of a PDF
+    #
+    # @param submission_id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InlineResponse201Submission, Fixnum, Hash)>] InlineResponse201Submission data, response status code and response headers
+    def get_submission_with_http_info(submission_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: PDFApi.get_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.get_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(:GET, 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#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end