typeform_data 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acb9391db4cf1a80933452517bebcbfbfd888eda
-  data.tar.gz: e140a1e7dd8928725bfa115ef5d883a44e71c708
+  metadata.gz: 6c89b3a3f4d42c31eb7caca0e233587b91c373b1
+  data.tar.gz: 6dbaf654728b826e8d71cb81b75d3ddd18763192
 SHA512:
-  metadata.gz: cceb10daaf8beed9ed861b33b4de0ba44babe9b4ad00e29be85df4d72244d59dcd72d1cef7b8cef98cc0c86ed6e0212065377bd564360a81bd102f18d65f5785
-  data.tar.gz: ae4c2c7c404363b35b49cb575bdf2a87fde5ced318a77cbabdbea807d484b29a6ff2495bc330229de0d7e090d12bc15f9ee95cb2e30186e989444ba8be6399bb
+  metadata.gz: fe56f2ccbb13af7c74e7f14f6d95a97a117d5b995081ac906e8be85b62c979d9b852f271b72c00626ed3df074bc08b0cda7f94a1dcad8f74b4eb451881aee795
+  data.tar.gz: 4bfddc0639cc2b3cb6b208f128e0ddf97ba7718a4c3d7b16c199fec49ac489d3b58a3c154eb0eda48d9378d437409e972ec76b47f4d1c89f581fa5e5967ff67e

data/README.md

@@ -47,7 +47,20 @@ typeform.responses.first.answers.map { |answer| [answer.field_text, answer.value
 
 ```
 
-To access a Typeform's questions, we recommend using `TypeformData::Typeform#fields` instead of `TypeformData::Typeform#questions`. Each `TypeformData::Typeform::Answer` is associated to exactly one `TypeformData::Typeform::Field`, and one or more `TypeformData::Typeform::Question`s.
+### Serialization & deserialization
+
+Your API key will not be serialized. `TypeformData::Client#dump` is just a pass-through to `Marshal#dump`, but `Client#load` will re-set your API key on each of the deserialized objects-- this ensures the object graph stays intact through the serialization process.
+
+```
+serialized = client.dump(responses)
+deserialized = client.load(serialized)
+
+> deserialized == responses
+=> true
+
+> deserialized.first.typeform == responses.first.typeform
+=> true
+```
 
 ## Notes on the API
 
@@ -62,7 +75,7 @@ The main goal of this API wrapper is to encapsulate these implementation details
 
   - At the moment, this gem has no runtime dependencies.
   - 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.
+  - 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 new serialization functionality! (We've already handled this for `Marshal#dump`.)
 
 ### Installation
 

data/lib/typeform_data/client.rb

@@ -18,9 +18,9 @@ module TypeformData
     # Your API key will automatically be added to the request URL as a query param, as required by
     # the API.
     #
-    # @param String
-    # @param Hash
-    # @return TypeformData::ApiResponse
+    # @param [String]
+    # @param [Hash]
+    # @return [TypeformData::ApiResponse]
     def get(endpoint, params = {})
       TypeformData::Requestor.get(@config, endpoint, params)
     end
@@ -35,5 +35,26 @@ module TypeformData
       ::TypeformData::Typeform.new(@config, id: id)
     end
 
+    def dump(object)
+      Marshal.dump(object)
+    end
+
+    # @param serialized [String] The output of Marshal.dump(vci) where vci is either (1) an
+    #   instance of TypeformData::ValueClass or (2) an array of instances of
+    #   TypeformData::ValueClass.
+    # @param default [Object] What to return if 'serialized' is blank or not a String.
+    def load(serialized, default = nil)
+      return default unless serialized.is_a?(String) && !serialized.empty?
+
+      Marshal.load(serialized).tap { |marshaled|
+        case marshaled
+        when Array
+          marshaled.each { |object| object.reconfig(@config) }
+        else
+          marshaled.reconfig(@config)
+        end
+      }
+    end
+
   end
 end

data/lib/typeform_data/comparable_by_id_and_config.rb

@@ -9,7 +9,7 @@ module TypeformData
     end
 
     def ==(other)
-      unless other.respond_to?(:sort_key) && other.respond_to?(:config)
+      unless other.respond_to?(:sort_key, true) && other.respond_to?(:config, true)
         raise ArgumentError, "#{other.inspect} does not specify a sort key and config"
       end
       other.sort_key == sort_key && other.config == config

data/lib/typeform_data/typeform.rb

@@ -97,7 +97,7 @@ module TypeformData
     end
 
     # It looks like sometimes the Typeform API will report stats that are out-of-date relative to
-    # the responses it actually returns. TODO: look into this more.
+    # the responses it actually returns.
     def responses_request(input_params = {})
       params = input_params.dup
       requests = [ResponsesRequest.new(params, client.get('form/' + id, params))]

data/lib/typeform_data/version.rb

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

data/lib/typeform_data.rb

@@ -1,25 +1,4 @@
 # frozen_string_literal: true
-module TypeformData
-
-  def self.dump(object)
-    Marshal.dump(object)
-  end
-
-  # Currently only handles single objects and arrays.
-  # @param [TypeformData::ValueClass]
-  # @param [TypeformData::Config]
-  def self.load(value_class_instance, config)
-    Marshal.load(value_class_instance).tap { |marshaled|
-      case marshaled
-      when Array
-        marshaled.each { |object| object.reconfig(config) }
-      else
-        marshaled.reconfig(config)
-      end
-    }
-  end
-
-end
 
 require 'net/http'
 require 'net/https'

metadata

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