typeform_data 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f71a20725a1b7dc1a2d6aef5ddf5beda089c7db
-  data.tar.gz: dcfcca188cfb6f976c5d9ae12605f963dd572231
+  metadata.gz: acb9391db4cf1a80933452517bebcbfbfd888eda
+  data.tar.gz: e140a1e7dd8928725bfa115ef5d883a44e71c708
 SHA512:
-  metadata.gz: f6c691c98b1222340f86cb5e7a9234aa3f41212d3f289d7008d8e42dde54dfb8a3d124738f363d6e1429d06da8bdf6a98974136dff6787e66d29fe513338bd67
-  data.tar.gz: 04eceaa69ec885857cdd7a3d0d569ce0307ac52fd192d7d4cd7fca48eab3443e4eae3d189994ba22797e3dadb5082696556d03724efb06807e6d35254afbf54d
+  metadata.gz: cceb10daaf8beed9ed861b33b4de0ba44babe9b4ad00e29be85df4d72244d59dcd72d1cef7b8cef98cc0c86ed6e0212065377bd564360a81bd102f18d65f5785
+  data.tar.gz: ae4c2c7c404363b35b49cb575bdf2a87fde5ced318a77cbabdbea807d484b29a6ff2495bc330229de0d7e090d12bc15f9ee95cb2e30186e989444ba8be6399bb

data/README.md

@@ -2,8 +2,6 @@
 
 A Ruby client for Typeform's [Data API](https://www.typeform.com/help/data-api/). Our documentation is available [here](http://www.rubydoc.info/gems/typeform_data/TypeformData/Typeform).
 
-**Warning**: this is alpha software, and hasn't been thoroughly vetted in production yet. Use at your own risk :).
-
 ## Usage:
 
 ```
@@ -27,8 +25,6 @@ Unless you specify a limit, `TypeformData::Typeform#responses` will not paginate
 
 You can also specify any of the ["Filtering Options"](https://www.typeform.com/help/data-api/) to pass along to the API call:
 
-(*Warning*: the `token` parameter isn't working yet.)
-
 ```
 some_complete_responses = typeform.responses(limit: 500, offset: 2000, completed: true)
 two_days_of_responses = typeform.responses(from: 1470143917, since: 1470316722)
@@ -37,7 +33,7 @@ two_days_of_responses = typeform.responses(from: 1470143917, since: 1470316722)
 
 ### Questions & answers
 
-The response data you get back is represented using classes with defined relationships:
+The response data you get back is represented using classes with defined relationships. All `TypeformData::*` objects should be treated as immutable.
 
 ```
 typeform.responses.first.answers.first.typeform == typeform
@@ -46,7 +42,7 @@ typeform.responses.first.answers.first.typeform == typeform
 typeform.fields.map(&:text)
 => ["What is your name?", "What are your favorite colors?", ...]
 
-typeform.responses.first.answers.map { |answer| [answer.field_text, answer.value] }`
+typeform.responses.first.answers.map { |answer| [answer.field_text, answer.value] }
 => [["What is your name?", "Foo Bar"], ["What are your favorite colors?", ["blue", "orange"]]]
 
 ```
@@ -55,18 +51,18 @@ To access a Typeform's questions, we recommend using `TypeformData::Typeform#fie
 
 ## Notes on the API
 
-So far, we've found Typeform's current Data API to be confusing. In particular, there are a couple design decisions that have been a big source of confusion and friction for us:
+So far, we've found Typeform's current Data API to be confusing. In particular, there are a couple design decisions that have been a source of friction for us:
 
 - Statements (which are sections of text in a Typeform, and can't be answered) and Hidden Fields (data passed into a form, and not provided by the user) are both included under the `'questions'` key in the API's response JSON. From the perspective of a user, we don't think of these as "questions".
 - Each option in a "Picture choice" (and, IIRC "Multiple choice" as well, if multiple choices are allowed) is returned as its own "question" in the response JSON for questions and answers. We feel that it makes more sense to model these as multiple answers to one question, i.e. an Array-valued answer.
 
-The main goal of this API wrapper is to encapsulate these implementation details (which we find confusing) and provide a more intuitive API for our application code. This means that our data model must deviating in specific places from the implicit data model expressed in the Data API's JSON responses. We're sacrificing consistency for a more intuitive client API.
+The main goal of this API wrapper is to encapsulate these implementation details and provide a more intuitive API for our application code. This means that our data model must deviate in specific places from the implicit data model expressed in the Data API's JSON responses. We're sacrificing consistency for a more intuitive client API.
 
 ## Notes
 
-  - We haven't tested against any Ruby versions other than 2.3.
   - At the moment, this gem has no runtime dependencies.
-  - Under the hood, the object relationships are implemented by storing a reference to a config object containing your API key. This is what allows you to say `answer.typeform.responses` and make an API call originating from a `TypeformData::Typeform::Answer` without having to pass in a reference to a client or your API key (again). To avoid leaking your API key, make sure to clear out the `@config` reference if you serialize any of the objects! We've already done a bit here: if you call `Marshal.dump` on a `TypeformData::ValueClass`, we only serialize attributes (not references, and not the `@config` object). 
+  - We've only tested this gem against Ruby 2.3. I'm not sure whether it works with older versions.
+  - Under the hood, the object relationships are implemented by storing a reference to a config object containing your API key. This is what allows you to say `answer.typeform.responses` and ultimately make an API call originating from a `TypeformData::Typeform::Answer` without having to pass in a reference to a client or your API key (again). To avoid leaking your API key, make sure to clear out the `@config` reference if you add functionality to serialize any of the objects! We've already done some work here: if you call `Marshal.dump` on a `TypeformData::ValueClass`, we only serialize attributes, and not the `@config` object.
 
 ### Installation
 

data/lib/typeform_data/typeform.rb

@@ -63,10 +63,10 @@ module TypeformData
       @_stats ||= fetch_stats
     end
 
-    # This method will make an AJAX request if this Typeform's name hasn't already been set.
+    # This method will make an AJAX request if this Typeform's name hasn't already been set during
+    # initialization.
     # @return [String]
     def name
-      return name if name
       @name ||= client.all_typeforms.find { |typeform| typeform.id == id }.name
     end
 
@@ -121,7 +121,7 @@ module TypeformData
       @_questions = questions_hashes.map { |hash| Question.new(config, hash) }
     end
 
-    # @param Hash stats_hash of the form {"responses"=>{"showing"=>2, "total"=>2, "completed"=>0}}
+    # @param [Hash] stats_hash of the form {"responses"=>{"showing"=>2, "total"=>2, "completed"=>0}}
     def set_stats(hash)
       @_stats = Stats.new(config, hash)
     end
@@ -155,7 +155,14 @@ module TypeformData
           "provided: #{params['limit']}"
       end
 
-      params['offset'] ||= 0
+      if params['token']
+        if params.keys.length > 1
+          raise ::TypeformData::ArgumentError, "'token' may not be combined with other filters"
+        end
+      else
+        params['offset'] ||= 0
+      end
+
       params
     end
 

data/lib/typeform_data/value_class.rb

@@ -13,9 +13,11 @@ module TypeformData
       keys = attribute_keys
 
       attrs.each do |key, value|
-        unless keys.include?(key) || keys.include?(key.to_sym)
-          raise ArgumentError, "Unexpected key: #{key}"
-        end
+        # Previously, we would throw an error if an unexpected attribute was present. Unfortunately,
+        # this causes exceptions in production if Typeform adds new fields to their API responses.
+        # We could filter the fields to the expected keys, but that defeats the purpose of having
+        # the validation.
+        next unless keys.include?(key) || keys.include?(key.to_sym)
         instance_variable_set("@#{key}", value)
       end
     end

data/lib/typeform_data/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module TypeformData
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typeform_data
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Max Wallace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-04 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler