typeform_data 3.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a29d5216f5bc251d42df766ac5f6ee3453a113e
-  data.tar.gz: 824508bc3d4e477d0fbaa7a673fa4abad012c011
+  metadata.gz: d59e6ace3ebd1f11c50608dd55f8ab6473447540
+  data.tar.gz: a56983d75dc15baa9b95c57401d208f025339f50
 SHA512:
-  metadata.gz: d615981da83f83f61f8663bd3c1182de16255b32d01a90080d679d0bfe5be3c2a50646540a0de7d9300f4aeb3a1ae1f91dbb28e1c54e8dbcab76fe740286a924
-  data.tar.gz: 84bdecd33b209bfd7c0e2eddfc5687321bc23230a6aa32a11506dfe358ae92a6f5f7534d9ac85a11c292fca3e792433f690fb93effa3a36413a49bb4011a1be0
+  metadata.gz: 736daabbd96df999d30946e6c20d7b8b28d13562adb50c0b481f2bfd78c4c8e59532ea93753478863e26cf4b457bdcd1067f9199db8657ff7fbef2bf57ccdfbd
+  data.tar.gz: 84873ab4d73b0f89be5a6fc01f2f5d9c9f4fe0535c6ab669fbc4842fdc95e173ec7b7446e1c6434df90deca6a352410787e563cc2dbefce14e0cd869c69386a3

data/.gitignore

@@ -1,5 +1,7 @@
 /.bundle/
 /.yardoc
+/.ruby-version
+/.ruby-gemset
 /Gemfile.lock
 /_yardoc/
 /coverage/

data/README.md

@@ -107,7 +107,11 @@ And then execute:
 
 ### Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To get started, you'll probably want to run something like:
+
+```
+TypeformData::Client.new(api_key: your_api_key).all_typeforms
+```
 
 ### Releasing a new version
 

data/lib/typeform_data/client.rb

@@ -38,6 +38,10 @@ module TypeformData
       TypeformData::Typeform.new(@config, id: id)
     end
 
+    # The goals of this alias are:
+    #   1. To bring the serialization process within TypeformData's API, so
+    #        we can modify it in the future if needed.
+    #   2. Maintain symmetry with #load, which needs to be part of the API.
     def dump(object)
       Marshal.dump(object)
     end
@@ -59,5 +63,13 @@ module TypeformData
       }
     end
 
+    def marshal_dump
+      raise 'Do not serialize TypeformData::Client-- it contains your API key'
+    end
+
+    def as_json(*_args)
+      raise 'Do not serialize TypeformData::Client-- it contains your API key'
+    end
+
   end
 end

data/lib/typeform_data/typeform.rb

@@ -65,6 +65,11 @@ module TypeformData
 
     # This method will make an AJAX request if this Typeform's name hasn't already been set during
     # initialization.
+    #
+    # Since the readable_attributes call above calls attr_reader(:name) for us, this method
+    # redefines name, and causes an (expected) "warning: method redefined" message when running
+    # tests.
+    #
     # @return [String]
     def name
       @name ||= client.all_typeforms.find { |typeform| typeform.id == id }.name

data/lib/typeform_data/utils.rb

@@ -1,28 +1,32 @@
 # frozen_string_literal: true
-module Utils
+module TypeformData
+  module Utils
 
-  # Repeats the block until it succeeds or a limit is reached, waiting twice as long as it
-  # previously did after each failure.
-  # @param config [TypeformData::Config]
-  # @param rescued_exceptions [Class] Subclasses of Exception.
-  # @param max_retries [Integer]
-  # @param initial_wait [Integer] In seconds.
-  def self.retry_with_exponential_backoff(config, retry_exceptions, max_retries: 5, initial_wait: 1)
-    seconds_to_wait = initial_wait
+    # Repeats the block until it succeeds or a limit is reached, waiting twice as long as it
+    # previously did after each failure.
+    # @param config [TypeformData::Config]
+    # @param rescued_exceptions [Class] Subclasses of Exception.
+    # @param max_retries [Integer]
+    # @param initial_wait [Integer] In seconds.
+    def self.retry_with_exponential_backoff(config, retry_exceptions, max_retries: 5,
+      initial_wait: 1)
 
-    max_retries.times do |iteration|
-      begin
-        break yield
-      rescue *retry_exceptions
-        config.logger.warn "Retry. Waiting #{seconds_to_wait}s, attempt #{iteration} of "\
-          "#{max_retries}."
+      seconds_to_wait = initial_wait
 
-        sleep seconds_to_wait
-        seconds_to_wait *= 2
+      max_retries.times do |iteration|
+        begin
+          break yield
+        rescue *retry_exceptions
+          config.logger.warn "Retry. Waiting #{seconds_to_wait}s, attempt #{iteration} of "\
+            "#{max_retries}."
 
-        raise if iteration == max_retries - 1
+          sleep seconds_to_wait
+          seconds_to_wait *= 2
+
+          raise if iteration == max_retries - 1
+        end
       end
     end
-  end
 
+  end
 end

data/lib/typeform_data/value_class.rb

@@ -23,6 +23,49 @@ module TypeformData
       end
     end
 
+    # ActiveSupport defines Object#as_json in
+    # activesupport/lib/active_support/core_ext/object/json.rb which exists to separate
+    # stringification from serialization logic. as_json is not core Ruby, but we implement it here
+    # for compatibility with to_json when ActiveSupport is loaded.
+    #
+    # In addition to protection against serializing the API key, this method is needed for #to_json
+    # to work at all, since the :config object contains IO objects and ActiveSupport's #as_json
+    # method fails when trying to serialize IO objects. See
+    # https://github.com/rails/rails/issues/26132.
+    #
+    # Testing this method:
+    #
+    #   For now, we're not including ActiveSupport as a development dependency because of the risk
+    # of accidentally writing code that relies on an ActiveSupport core extension that might not
+    # be present where this gem is being used.
+    #
+    # To test this method in the console, add
+    #
+    #   spec.add_development_dependency 'activesupport'
+    #
+    # to typeform_data.gemspec and then run something like
+    #
+    #  require 'active_support'; require 'active_support/json'; \
+    #   c = TypeformData::Client.new(api_key: ...); \
+    #   at = c.all_typeforms; tf = at.reverse.find { |t| t.stats.completed > 0 }; \
+    #   tf.responses(completed: true, limit: 1).first.to_json
+    #
+    # using bin/console.
+    #
+    # One last thing: if you pass options #to_json or #as_json, Rails will use the same options for
+    # all calls in the object graph, so the following behavior is expected (if counterintuitive):
+    #
+    #    #   response.as_json(only: 'answers')
+    #   => {"answers"=>[{}, {}, {}, {}]}
+    #
+    # @param [Hash]
+    def as_json(options = {})
+      # Note: :config doesn't work here-- using the string form is mandatory.
+      return super({ except: 'config' }) if options.empty?
+
+      super(options.merge(except: ['config'] + Array(options[:except])))
+    end
+
     def self.included(base)
       base.extend(ClassMethods)
     end

data/lib/typeform_data/version.rb

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

data/typeform_data.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.name          = 'typeform_data'
   spec.version       = TypeformData::VERSION
-  spec.authors       = ['Max Wallace']
+  spec.authors       = ['Max Wallace', 'Eli Rose']
   spec.email         = ['engineering@shearwaterintl.com']
 
   spec.summary       = 'An opinionated, OO client for the Typeform.com Data API'
@@ -35,6 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry-byebug', '~> 3.3'
   spec.add_development_dependency 'pry-doc', '~> 0.8'
   spec.add_development_dependency 'byebug', '~> 8.2'
-  spec.add_development_dependency 'rubocop', '~> 0.39'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
 
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: typeform_data
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Max Wallace
+- Eli Rose
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.39'
+        version: '0.47'
 description: typeform_data is a minimal, opinionated, OO client for the Typeform.com
   Data API with no runtime dependencies.
 email:
@@ -193,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: An opinionated, OO client for the Typeform.com Data API