surveymonkey 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01090e5bb2cc9905f723fc8cd3ba440b0d7557bf
-  data.tar.gz: 800fa9a973a283ba9dd36053a88c6bdc66eb2285
+  metadata.gz: 3d2814fc1738a375a5877e74006dd10d1070c862
+  data.tar.gz: 20e69559cdf751d6b6d90cdda9e9782f46fc124e
 SHA512:
-  metadata.gz: f75ee597a09ad0fab36c1a15063abef4dda45d0c6e0ccf0a8442076c6e7778ebb8666809643cdfb381f2f67060f8618bf0d809f8ba3d486cfbd730f14e4b4bc5
-  data.tar.gz: bdc3c2d2e98e212bc4671edf973c274d58e4eacbf30c341fe468a689ae59f4c97dabb1e0182430ca78cc33c807a340fff2d02e72285ab443c044dbaa1b3cc0e7
+  metadata.gz: c080bd3a46005a2b4f5a9aaaf48f7a8aca9ac7dc74111228056cce8a96117545c6831d1219fdd95894d58dde542ff6603a4df8afe140cf6de6515ff2ced3c15c
+  data.tar.gz: 5b6eb53aa49367fd987fa50e55bc8fa7aa19903b1e35a627b2db5af3a2f229b1f964b624470173301dd5c9007936404ee85e70dc8b9f91421010ed8f2777210d

data/lib/surveymonkey.rb

@@ -5,6 +5,7 @@ require "surveymonkey/version"
 require "surveymonkey/logging"
 require "surveymonkey/error"
 require "surveymonkey/request"
+require "surveymonkey/datestring"
 
 ##
 # Top-level module, holds the user-facing methods
@@ -46,7 +47,7 @@ module Surveymonkey
         page_size = the_args.delete('page_size') { |key| DefaultPageSize }.to_i
         $log.debug sprintf("%s: page_size: %i", __method__, page_size)
 
-        method_params = the_args
+        method_params = parse_datestrings(the_args)
         $log.debug sprintf("%s: method_params: %s", __method__, method_params.inspect)
 
         # is this a paginated method?
@@ -130,6 +131,31 @@ module Surveymonkey
       end
     end
 
+    ##
+    # Parse and validate DateStrings in method parameters
+    def parse_datestrings(method_params = {}) # :nodoc:
+      begin
+        ['start_date', 'end_date'].each do |date_param|
+          if method_params.has_key?(date_param)
+            raw = method_params.fetch(date_param)
+            $log.debug(sprintf("%s: parsing '%s' as %s param", __method__, raw, date_param))
+
+            parsed = Surveymonkey::DateString.new(raw).to_s
+            $log.debug(sprintf("%s: parsed '%s' to '%s'", __method__, raw, parsed))
+
+            method_params.store(date_param, parsed)
+          end
+        end
+
+        method_params
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: %s", __method__, e.message))
+        raise e
+
+      end
+    end
+
     ##
     # Execute a single API request.
     def execute_request(method_name, method_params = {}) # :nodoc:

data/lib/surveymonkey/datestring.rb

@@ -0,0 +1,63 @@
+require "timeliness"
+
+require "surveymonkey/logging"
+
+module Surveymonkey
+  class DateString
+    attr_reader :raw
+    attr_reader :time
+
+    # SurveyMonkey DateStrings are always in UTC
+    Timeliness.default_timezone = :utc
+
+    # and have a specific format
+    TimelinessFormat = 'yyyy-mm-dd hh:nn:ss'
+
+    # but for stringification we have to use strftime format
+    TimeFormat = '%Y-%m-%d %H:%M:%S'
+
+    def to_s
+      self.time.strftime(TimeFormat)
+    end
+
+    def <=>(other)
+      self.time.<=>(other)
+    end
+
+    def initialize(datestring, args = {})
+      begin
+        $log.debug(sprintf("%s: parsing '%s'", __method__, datestring))
+
+        @raw = datestring
+
+        timeliness_args = { :format => TimelinessFormat }
+
+        # merge additional args if provided
+        begin
+          timeliness_args.merge(args)
+        rescue TypeError => e
+          $log.error(sprintf("%s: '%s' (%s) is not a valid arguments hash", __method__, args.inspect, args.class))
+        end
+
+        parsed = Timeliness.parse(datestring, timeliness_args)
+
+        if parsed.nil?
+          # add a time component and try again
+          $log.info(sprintf("%s: '%s' cannot be parsed as a datetime, adding a time component", __method__, datestring))
+          datestring.concat(' 00:00:00')
+          parsed = Timeliness.parse(datestring, timeliness_args)
+        end
+
+        if parsed.nil?
+          raise StandardError, sprintf("'%s' is not a valid DateString", datestring)
+        else
+          @time = parsed
+        end
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: unable to parse '%s' as DateString", __method__, datestring))
+        raise e
+      end
+    end
+  end
+end

data/lib/surveymonkey/datetime.rb

@@ -0,0 +1,14 @@
+require 'date'
+
+module Surveymonkey::DateTime
+
+  # Constants
+
+  ## Offset
+  # Default offset from UTC (all SurveyMonkey DateStrings are in UTC)
+  Offset = 0
+
+  class DateString
+
+  end
+end

data/lib/surveymonkey/version.rb

@@ -2,5 +2,5 @@
 # Specify the version of the surveymonkey gem.
 
 module Surveymonkey
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/surveymonkey.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "httparty", "~> 0.13"
   spec.add_runtime_dependency "json", "~> 1.8"
   spec.add_runtime_dependency "logging", "~> 2"
+  spec.add_runtime_dependency "timeliness", "~> 0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surveymonkey
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Steve Huff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: timeliness
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: Interact with SurveyMonkey's REST API.  Requires an API token.
 email:
 - shuff@vecna.org
@@ -172,6 +186,8 @@ files:
 - lib/surveymonkey/api.rb
 - lib/surveymonkey/api/method.rb
 - lib/surveymonkey/client.rb
+- lib/surveymonkey/datestring.rb
+- lib/surveymonkey/datetime.rb
 - lib/surveymonkey/error.rb
 - lib/surveymonkey/logging.rb
 - lib/surveymonkey/request.rb