typed_form 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a388e80e46e93cdf800db1cd021694a69ed9aed0
+  data.tar.gz: 2130492e803088d27ecf5d91576c9ba212b3e566
+SHA512:
+  metadata.gz: '089b3bdba82b45d19823f71d1474c58dd088ee0516c66a133c7661c4b9f6bd88bc7341f11661930da29232aa85a616e5e69480c32172b4d82a417604dddf3f17'
+  data.tar.gz: 5800494788d591fc198451074850f01009665643eca9bb854fcf3c68edcfa12c813b4a3356ba1c8e3b2fd7c2993f516de5e04c799abe9862e9c79f5ae3acee91

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+## [0.0.2] - 2017-03-10
+
+Added support for interpolated questions (what Typeform refers to as "piping") and for string conversion of multiple choice answers to a single CSV format.
+
+## [0.0.1] - 2017-03-10
+
+Initial version released. Added initial support for retrieving results from Typeform Data API. 
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at robcole@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in typed_form.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 robcole
+
+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,119 @@
+# TypedForm
+
+TypedForm is a simple wrapper for the [Typeform Data API](https://www.typeform.com/help/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](https://github.com/shearwaterintl/typeform_data) 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](https://www.typeform.com/help/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/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:
+
+```ruby
+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:
+
+```ruby
+# 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::Client.new(api_key: api_key)
+json = client.find_form_by(form_id: form_id, token: token)
+  => # json response for that specific form submission
+
+parsed = TypedForm::JSONResponseHandler.new(json)
+form = TypedForm::FormResponse.new(parsed_questions: parsed.questions,
+                                   parsed_response: parsed.response.first)
+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.
+
+## 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](https://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](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "typed_form"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/typed_form/client.rb

@@ -0,0 +1,35 @@
+module TypedForm
+  class Client
+    attr_reader :api_key
+
+    include HTTParty
+
+    def initialize(api_key:)
+      @api_key = api_key
+    end
+
+    def forms_by_id(form_id:, **query_params)
+      url_params = query_params.map { |k, v| "#{k}=#{v}" }
+      request_url = [form_id, authenticated_slug(url_params)].join("?")
+      get(request_url).body
+    end
+
+    def find_form_by(form_id:, token:, **query_params)
+      forms_by_id(form_id: form_id, token: token, **query_params)
+    end
+
+    private
+
+    def get(slug)
+      self.class.get(base_url + slug)
+    end
+
+    def base_url
+      "https://api.typeform.com/v1/form/"
+    end
+
+    def authenticated_slug(url_params)
+      ["key=#{api_key}", url_params].join("&")
+    end
+  end
+end

data/lib/typed_form/form_answers.rb

@@ -0,0 +1,66 @@
+module TypedForm
+  class FormAnswers
+    extend Forwardable
+
+    def_delegators :response, :answers, :metadata, :token
+    def_delegators :metadata, :date_submit
+
+    attr_reader :response, :input_questions, :original_questions
+
+    def self.collate(response:, input_questions:, original_questions:)
+      new(response: response,
+          input_questions: input_questions,
+          original_questions: original_questions).questions
+    end
+
+    def initialize(response:, input_questions:, original_questions:)
+      @response = response
+      @input_questions = input_questions
+      @original_questions = original_questions
+    end
+
+    def questions
+      @_questions ||= build_questions
+    end
+
+    private
+
+    def build_questions
+      input_questions.map do |question|
+        Question.with_response_data(
+          question: question,
+          answer: answers_for(question.ids),
+          text: extrapolated_question_text(question)
+        )
+      end
+    end
+
+    def answers_for(ids)
+      id_answers = ids.map { |id| find_answer_by_id(id) }.compact
+      return if id_answers.size.zero?
+      id_answers.join(", ")
+    end
+
+    def extrapolated_question_text(question)
+      regex = %r(\{\{answer_(\d+)\}\})
+      id_match = question.original_text.match(regex)
+      return question.original_text unless id_match
+
+      question.original_text.gsub(regex, find_answer_by_field_id(id_match[1]))
+    end
+
+    def find_answer_by_field_id(id)
+      fields = original_questions.select do |question|
+        question.field_id == id.to_i
+      end
+
+      answers_found = fields.map { |field| find_answer_by_id(field.id) }.compact
+      return find_answer_by_id(fields.first.id) if answers_found.size == 1
+      raise ArgumentError, "Cannot find single answer with field ID ##{id}"
+    end
+
+    def find_answer_by_id(id)
+      answers.instance_variable_get("@#{id}")
+    end
+  end
+end

data/lib/typed_form/form_response.rb

@@ -0,0 +1,58 @@
+module TypedForm
+  class FormResponse
+    attr_reader :parsed_questions, :parsed_response
+
+    def initialize(parsed_questions:, parsed_response:)
+      @parsed_questions = parsed_questions
+      @parsed_response = parsed_response
+    end
+
+    def questions_and_answers
+      FormAnswers.collate(response: parsed_response,
+                          input_questions: questions,
+                          original_questions: parsed_questions)
+    end
+
+    def questions
+      @_questions ||= build_questions
+    end
+
+    def question_ids
+      questions.flat_map(&:ids)
+    end
+
+    def question_texts
+      questions.map(&:original_text).uniq
+    end
+
+    private
+
+    def question_for_grouped(grouped_questions)
+      question_texts = grouped_questions.map(&:question)
+      return question_texts.first if question_texts.uniq.size == 1
+      raise ArgumentError, "Grouped questions do not have matching text"
+    end
+
+    def type_for_grouped(grouped_questions)
+      types = questions.map(&:type)
+      return types.first if types.uniq.size == 1
+      raise ArgumentError, "Grouped questions do not have matching types"
+    end
+
+    def answerable_questions
+      parsed_questions
+        .reject { |q| q.id.match /(hidden|legal|statement|group)/ }
+        .group_by(&:field_id)
+    end
+
+    def build_questions
+      answerable_questions.map do |field_id, grouped_questions|
+        Question.new(
+          ids: grouped_questions.map(&:id),
+          field_id: field_id,
+          original_text: question_for_grouped(grouped_questions)
+        )
+      end
+    end
+  end
+end

data/lib/typed_form/json_response_handler.rb

@@ -0,0 +1,16 @@
+module TypedForm
+  class JSONResponseHandler
+    extend Forwardable
+    attr_reader :json
+
+    def_delegators :parsed_json, :questions, :responses
+
+    def initialize(json)
+      @json = json
+    end
+
+    def parsed_json
+      @_parsed_json ||= JSON.parse(json, object_class: Arendelle)
+    end
+  end
+end

data/lib/typed_form/question.rb

@@ -0,0 +1,28 @@
+module TypedForm
+  class Question
+    attr_reader :ids, :field_id, :original_text
+    attr_accessor :answer, :text
+
+    def initialize(ids:, field_id:, original_text:)
+      @ids = ids
+      @field_id = field_id
+      @original_text = original_text
+    end
+
+    def add_response_data(answer:, text:)
+      @answer = answer
+      @text = text
+    end
+
+    def type
+      @_type ||= field_id.split("_")[0]
+    end
+
+    def self.with_response_data(question:, text:, answer:)
+      question.dup.tap do |new_question|
+        new_question.answer = answer
+        new_question.text = text
+      end
+    end
+  end
+end

data/lib/typed_form/version.rb

@@ -0,0 +1,3 @@
+module TypedForm
+  VERSION = "0.0.2"
+end

data/lib/typed_form.rb

@@ -0,0 +1,12 @@
+require "httparty"
+require "forwardable"
+require "arendelle"
+require "typed_form/client"
+require "typed_form/json_response_handler"
+require "typed_form/form_response"
+require "typed_form/question"
+require "typed_form/form_answers"
+require "typed_form/version"
+
+module TypedForm
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: typed_form
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Rob Cole
+- Tim Walsh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: arendelle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Typeform exposes a robust schema for form data via
+                            their data API. typed_form facilitates the ability
+                            to present this data in an easily presentable format
+                            by adding types, extrapolating "piped" questions into
+                            their full text, and associating questions directly
+                            with answers.
+email:
+- robcole@useed.org
+- tim@useed.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/typed_form.rb
+- lib/typed_form/client.rb
+- lib/typed_form/form_answers.rb
+- lib/typed_form/form_response.rb
+- lib/typed_form/json_response_handler.rb
+- lib/typed_form/question.rb
+- lib/typed_form/version.rb
+homepage: https://github.com/useed/typed_form
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: typed_form provides an interface for retrieving results from Typeform surveys
+  and interpolating them into a presentable Q&A format.
+test_files: []