TypedForm

TypedForm is a simple wrapper for the Typeform Data API to expose a simple Q&A format from their JSON schema.

The API interface is intentionally kept very minimalistic; the remainder of functionality will be in processing and rebuilding their data format into a format that is usable for a variety of applications (our use case: providing a Q&A view format from cached data-API results).

For a more robust API wrapper, you may want to investigate TypeformData or other wrappers.

Why?

TypedForm was created out of a simple desire: to display a full set of questions and answers provided via a completed survey. Typeform's Data API schema is robust, but delivers data in a format that requires some quite a bit of work to make sense of. For example, the typeform API delivers questions and answers that use piping in the following format (only showing relevant data for this example - their API provides much more data than included below):

# typeform_response.json

"questions" [
  {
    "id": "list_p0Qz_choice",
    "question": "I am applying on behalf of:",
    "field_id": 44763792
  },
  {
    "id": "textfield_goYz",
    "question": "What is the name of your {{answer_44763792}}?",
    "field_id": 44763783
  },
  {
    "id": "list_fprR_choice",
    "question": "Does {{answer_44763783}} have an advisor (coach, department head, etc)?",
    "field_id": 44763793
  }
],

"responses": [
  {
    "answers": {
      "list_p0Qz_choice": "Program or Academic Unit",
      "textfield_goYz": "Rory for President 2017",
      "list_fprR_choice": "Yes -- that's me!"
  }
]

In addition to piping/interpolation, Typeform's data is structured in a difficult-to-use manner (that's putting it nicely) when it comes to associating answers with questions on "choice" questions; we seek to remedy this by building arrays from choice values, and building a single canonical question with multiple answers associated with the question.

Finally, if you've ever tried to duplicate a Typeform Form, you'll notice that their response field IDs completely change, and can no longer be used for locating answers. This gem attempts to solve that as well, by associating questions and answers together based on their results.

Take a look at https://github.com/useed/typed_form/tree/master/spec/fixtures for examples of what you can expect when it comes to their data API; this should help shed some additional light on the purpose behind this gem.

Installation

Add this line to your application's Gemfile:

gem 'typed_form'

And then execute:

$ bundle

Or install it yourself as:

$ gem install typed_form

Usage

With TypedForm, you can easily extrapolate answers from the data provided into the question, and give your questions a simple interface for accessing the extrapolated (and original) question and answer format:

# Your typeform API key -- keep this a secret!
api_key = "api_key"

# Your typeform form ID
form_id = "typeform_form_id"

# individual response token, provided in responses hash or via webhook data
token = "form_token" 

client = TypedForm::API::Client.new(api_key: api_key)
form = TypedForm::Form.find_form_by(
  client: client, 
  form_id: form_id, 
  token: token
)

# Or, load from existing JSON
form = TypedForm::Form.build_form_from(json: your_json_source)
questions = form.questions

questions.first.text
 => "What is the name of your Program or Academic Unit?"

questions.first.original_text
 => "What is the name of your {{answer_44763792}}?"

questions.first.answer
 => "Rory for President 2017"

questions.first.type
 => "textfield"

The most common use case for this is extrapolating question and answers into a simple object that can provide a clean interface for displaying them. Question type information can be used to allow helpers to format and display different field types (most specifically dates) in a more user-friendly format.

Additional documentation is available at Rubydoc.

Wishlist

This gem is in the very early stages of development. Typeform does not provide a full example of the full JSON schema, so specific question and answer formats are not guaranteed to work. Issues and PRs are welcome, especially for functionality which focuses on working with data from the Typeform Data API.

The API wrapper is minimalist by purpose, and currently is only designed to fetch a single form response for a specific form from the Data API. Additional functionality may be desired in the future.

  • [ ] Error Handling for JSON Responses
  • [ ] Error Handling for API Requests
  • [ ] Error Logging Configuration
  • [ ] Automatic retry & failover for Typeform API response failures

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/useed/typed_form. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in this repository is expected to follow our code of conduct