typeform_data 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c89b3a3f4d42c31eb7caca0e233587b91c373b1
-  data.tar.gz: 6dbaf654728b826e8d71cb81b75d3ddd18763192
+  metadata.gz: edd3d6b08e718fd4c2429253873d9c5b269774d6
+  data.tar.gz: 8939f372f3a5fba107d4879b56ee04c02c2a885b
 SHA512:
-  metadata.gz: fe56f2ccbb13af7c74e7f14f6d95a97a117d5b995081ac906e8be85b62c979d9b852f271b72c00626ed3df074bc08b0cda7f94a1dcad8f74b4eb451881aee795
-  data.tar.gz: 4bfddc0639cc2b3cb6b208f128e0ddf97ba7718a4c3d7b16c199fec49ac489d3b58a3c154eb0eda48d9378d437409e972ec76b47f4d1c89f581fa5e5967ff67e
+  metadata.gz: d54650fab170d77b860f49d9839d88039f2280ccf24401272f089ba303ce51cc1839628f8980bb2e5bb35256d481318c5cccd4ceb6672c42b821980c4d534111
+  data.tar.gz: dd0308219f6e615bb0ac9e2218b450246c116212ac54fc1876261f4432aee99e53c9621ad9cb7fd4127b02ffc15e90631f65189e2a9ed45a85dce8bb17156b95

data/.rubocop.yml

@@ -146,3 +146,9 @@ Style/CaseIndentation:
 # !something.nil? isn't a good solution. I wish Ruby had a to_b ("to boolean") method.
 Style/DoubleNegation:
   Enabled: false
+
+# Marshal#load is a security concern, but we rely on it for serialization. The end-user is
+# responsible for ensuring any data they deserialize with TypeformData::Client#load comes from a
+# trusted source.
+Security/MarshalLoad:
+  Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # TypeformData
 
-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).
+A Ruby gem and 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).
 
 ## Usage:
 

data/lib/typeform_data/typeform/answer.rb

@@ -40,6 +40,23 @@ module TypeformData
       # same specificity as Fields.
       #
       # Use this method to create Answers when initializing a Response.
+      #
+      # @param config [TypeformData::Config]
+      # @param attrs [Hash] Looks like:
+      #   {
+      #    "completed"=>"1",
+      #    "token"=>"581eec6b27c23dc70e047e4354944bfb",
+      #    "metadata"=>{ ... },
+      #    "hidden"=>{ ... },
+      #    "answers"=>
+      #     {
+      #      "answer_id"=>"answer_value",
+      #       ...
+      #     },
+      #    :typeform_id=>"OTFzVb"
+      #   }
+      #
+      # @param fields [Array<TypeformData::Typeform::Field>]
       # @return [Array<Answer>]
       def self.from_response_attrs(config, attrs, fields)
         (attrs[:answers] || attrs['answers']).group_by { |id, _value|
@@ -53,6 +70,7 @@ module TypeformData
             raise UnexpectedError, 'Expected to find a matching field' unless matched
           }
         }.map { |field, ids_and_values|
+          # ids_and_values looks like [[id, value], [id, value], ...]
           values = ids_and_values.map(&:last)
 
           Answer.new(

data/lib/typeform_data/typeform.rb

@@ -74,7 +74,7 @@ module TypeformData
 
     def fetch_questions
       questions = responses_request(limit: 1)['questions'] || []
-      questions.map { |hash| Question.new(config, hash) }
+      questions.map { |hash| Question.new(config, hash.merge!(typeform_id: id)) }
     end
 
     def fetch_stats
@@ -118,7 +118,9 @@ module TypeformData
 
     # rubocop:disable Style/AccessorMethodName
     def set_questions(questions_hashes = [])
-      @_questions = questions_hashes.map { |hash| Question.new(config, hash) }
+      @_questions = questions_hashes.map { |hash|
+        Question.new(config, hash.merge(typeform_id: id))
+      }
     end
 
     # @param [Hash] stats_hash of the form {"responses"=>{"showing"=>2, "total"=>2, "completed"=>0}}
@@ -131,8 +133,8 @@ module TypeformData
       'completed' => Object,
       'since'     => Object,
       'until'     => Object,
-      'offset'    => Fixnum,
-      'limit'     => Fixnum,
+      'offset'    => Integer,
+      'limit'     => Integer,
       'token'     => String,
     }.freeze
 

data/lib/typeform_data/value_class.rb

@@ -51,7 +51,7 @@ module TypeformData
       end
     end
 
-    # Compond classes (e.g. a Response which has many Answers) should use this method to re-set
+    # Compound classes (e.g. a Response which has many Answers) should use this method to re-set
     # 'config' on each child object. ValueClass#reconfig is called in TypeformData#load.
     def reconfig(config)
       self.config = config

data/lib/typeform_data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typeform_data
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Max Wallace
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-11 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler