typed_form 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d67800ceba46ef713f9fc5aa6d60390ad29d1737
-  data.tar.gz: dfe2b5bcf4c885ad9883af07d6a92f86d107572c
+  metadata.gz: d5ead981248e841e93b35f762ad6bfa365603a40
+  data.tar.gz: 47d2587d6a6bfc5405ae5c1263e9b912d65e0853
 SHA512:
-  metadata.gz: 3817ca0f77392d2846dca9b7f7b51fc00a5685d3caacf5a25dd90f6ec7a6a4aefa9cffa92a5d0eb8218b05099234ea14af6631512463b8edf9a8c7ee08d94b01
-  data.tar.gz: c1ed19b2752ec0e4d3fed9a2a20a913ba751c18bbf7af79ec79f359a070b4a8d6792f559f2fc65241a7cdbe3e96a7bc9a563877d1c9dad1f04fa9876d072b3af
+  metadata.gz: 21dc2335dac2fbc928e5e640612cda0aa05df5b88f75274351b25c916d0cfaa5e210f172efa033fdfa699c32474d3c451c1b84567797c04a1d5f4a16a28d6b91
+  data.tar.gz: 9973d47d3053017994a482de7584dc12c8001bb1ab2a68d10bf1693c302502dc3f2f59175437efcc0aabc604cfd3a34ef1a8332b8ea2d54dbf359aa57bd20c3a

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [0.1.1] - 2017-03-12
+
+Adds support for TypedForm::VirtualModel. Adds a decorator-like model which allows user-defined VirtualModels which respond with Typeform Data values.
+
 ## [0.1.0] - 2017-03-12
 
 Adds logic for extracting data needed for Data API from incoming Webhooks. 

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in typed_form.gemspec
 gemspec
+gem "redcarpet"

data/README.md

@@ -105,7 +105,18 @@ questions.first.type
 
 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.](http://www.rubydoc.info/github/useed/typed_form)
+Additional documentation is available at [Rubydoc.](http://www.rubydoc.info/github/useed/typed_form/master)
+
+## 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
 
@@ -121,3 +132,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/useed/
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+## Code of Conduct
+
+Everyone interacting in this repository is expected to follow [our code of conduct](https://github.com/useed/typed_form/blob/master/CODE_OF_CONDUCT.md)

data/lib/typed_form/form.rb

@@ -1,6 +1,5 @@
 module TypedForm
-  # A representation of the Typeform Form Data for a single
-  # form response.
+  # A representation of the Typeform Form Data for a single form response.
   #
   # @attr_reader [String] json JSON data using Typeform's Data API schema
   class Form
@@ -16,7 +15,7 @@ module TypedForm
     def_delegators :submission, :questions
 
     # Creates a new instance of a Form, to allow querying
-    def initialize(json: json)
+    def initialize(json:)
       @json = json
     end
 
@@ -37,13 +36,17 @@ module TypedForm
       questions.each_with_object({}) { |q, hash| hash[q.text] = q.answer }
     end
 
+    def response
+      raise StandardError, "Form expects a single response" if multi_response?
+      responses.first
+    end
+
     private
 
     def submission
-      raise StandardError, "Form expects a single response" if multi_response?
       @_submission ||= FormData::FormSubmission.new(
         parsed_questions: parsed_json.questions,
-        parsed_response: responses.first
+        parsed_response: response
       )
     end
 
@@ -54,9 +57,5 @@ module TypedForm
     def parsed_json
       @_parsed_json ||= FormData::ParsedJson.new(json: json)
     end
-
-    def response
-      responses.first
-    end
   end
 end

data/lib/typed_form/form_data/form_submission.rb

@@ -35,7 +35,7 @@ module TypedForm
 
       def answerable_questions
         parsed_questions
-          .reject { |q| q.id.match /(hidden|legal|statement|group)/ }
+          .reject { |q| q.id.match(/(hidden|legal|statement|group)/) }
           .group_by(&:field_id)
       end
 

data/lib/typed_form/form_data/parsed_json.rb

@@ -8,9 +8,11 @@ module TypedForm
       attr_reader :json
 
       # @!method questions
-      #   @return [Arendelle] parsed_json["questions"] questions data
+      #   @return [Arendelle] An immutable representation of the Typeform Data
+      #     API JSON questions field.
       # @!method responses
-      #   @return [Arendelle] parsed_json["responses"] response data
+      #   @return [Arendelle] An immutable representation of the Typeform Data
+      #     API JSON responses field.
       def_delegators :parsed_json, :questions, :responses
 
       # Creates and freezes JSON data.

data/lib/typed_form/version.rb

@@ -1,4 +1,4 @@
 module TypedForm
   # Up-to-date version of gem.
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/typed_form/virtual_model.rb

@@ -0,0 +1,96 @@
+module TypedForm
+  # A representation of the Typeform Response Data for a single form response.
+  # Dynamically adds methods at initialization time, to provide a simple
+  # interface for accessing form response data.
+  #
+  # ```ruby
+  # # this example would require json data with a question of "What is your
+  # # "email?" and an answer of "user@example.com"
+  #
+  # form = TypedForm::Form.build_form_from(json: your_json_source)
+  # hash = { "user_email" => "What is your email" }
+  # virtual_model = TypedForm::VirtualModel.new(form: form, question_attr: hash)
+  # ```
+  #
+  # VirtualModel has now dynamically matched the user_email attribute to the
+  # answer of the question, by finding the question matching the regular
+  # expression "What is your email", and then responding with the answer.
+  #
+  # ```ruby
+  # virtual_model.user_email => "user@example.com"
+  # ```
+  #
+  # @attr_reader [Form] form The instance of the form used when referencing
+  #   questions and answers in the submission.
+  # @attr_reader [Hash] question_attrs Hash mapping attribute names to regular
+  #   expressions, expressed as strings.
+  #
+  #   Format example: To match the answers of "What is your email" to an
+  #   attribute of "user_email", the format would look like:
+  #
+  #   ```ruby
+  #   question_attrs = { "user_email" => "What is your email" }
+  #   ```
+  #
+  # @attr_reader [Hash] response_attrs Hash mapping attribute names to a
+  #   chain of attributes accessbile from the form response.
+  #
+  #   Format example: To match the user_agent of the submission, which is under
+  #   response["metadata"]["user_agent"], the format would look like:
+  #
+  #   ```ruby
+  #   response_attrs = { "user_agent" => "metadata.user_agent" }
+  #   ```
+  class VirtualModel
+    attr_reader :form, :question_attrs, :response_attrs
+
+    def initialize(form:, question_attrs: nil, response_attrs: nil)
+      @form = form
+
+      _define_question_attributes(question_attrs || {})
+      _define_response_attributes(response_attrs || {})
+    end
+
+    private
+
+    def find_answer_to(text)
+      question = form.questions.detect { |q| q.text.match Regexp.new(text) }
+      return unless question
+      question.answer
+    end
+
+    def able_to_define?(attr)
+      !self.class.method_defined?(attr) &&
+        attr.to_s.match(/^[a-z_][a-zA-Z_0-9!?]*$/)
+    end
+
+    def _define_question_attributes(question_attrs)
+      question_attrs.each do |k, v|
+        next unless able_to_define?(k)
+
+        answer = find_answer_to(v)
+        next if answer.nil?
+
+        define_singleton_method k do
+          answer
+        end
+      end
+    end
+
+    def response_attribute_value(messages)
+      messages.split(".").inject(form.response) do |message, e|
+        message.send(e)
+      end
+    end
+
+    def _define_response_attributes(response_attrs)
+      response_attrs.each do |k, v|
+        next unless able_to_define?(k)
+
+        define_singleton_method k do
+          response_attribute_value(v)
+        end
+      end
+    end
+  end
+end

data/lib/typed_form/webhook.rb

@@ -20,7 +20,7 @@ module TypedForm
 
     # Creates a new webhook object from an incoming Typeform Data stream.
     # @param [String] json JSON Data from a Typeform Webhook
-    def initialize(json: json)
+    def initialize(json:)
       @json = json.freeze
     end
 

data/lib/typed_form.rb

@@ -6,6 +6,7 @@ require "typed_form/form_data/parsed_json"
 require "typed_form/form_data/question"
 require "typed_form/form_data/answers"
 require "typed_form/form_data/form_submission"
+require "typed_form/virtual_model"
 require "typed_form/form"
 require "typed_form/webhook"
 require "typed_form/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typed_form
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rob Cole
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-12 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -125,6 +125,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -141,6 +142,7 @@ files:
 - lib/typed_form/form_data/parsed_json.rb
 - lib/typed_form/form_data/question.rb
 - lib/typed_form/version.rb
+- lib/typed_form/virtual_model.rb
 - lib/typed_form/webhook.rb
 homepage: https://github.com/useed/typed_form
 licenses: