survey_monkey 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c6ff1c896073faa5c2f32aa2410c0d74d46086d
-  data.tar.gz: 208f9ee34f065f9c5b87c5d5906d95d39badea19
+  metadata.gz: 125097a806ade2658f50ab46a3fac7fc954da771
+  data.tar.gz: dd25f4b0540f416285a04a24ca34c5e553a9b987
 SHA512:
-  metadata.gz: 306f74acec296051f7b1ad0b0d67109e3cdb99002af433846799cddb50826af44d2980d2b8f1c45d528682ef57c769bee5a990ff0e3e571bdb536bd96e14bffc
-  data.tar.gz: 7f926d813786aeb7856138e3e678e8037fc5eed345de37bb53eccf4dcfe49f15aebf06db3492a556b00d65263fcd0b4a120c3dbfdca1fc0ee0343e685547c599
+  metadata.gz: a4cf4f96c0c90543d2bb4dc3d34669bc85b41916af9619572da7c2c543dd9ab8276e87d10f061c73a91f2fd59a69f38c8adc9c27b5e8f244c329063237881d43
+  data.tar.gz: 55defc012c0dcb8462dd1c080747dc03cb58dc66c691dcbbcc9e2d8ffe8ac9109ac81f2b7ea5a43f8a97e131c051f7bcb0a4b626ff81443f74f282dbd74a51c2

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 To Authenticate, you have two options:
 
-1. Use ENV Variables:
+Option 1: Use ENV Variables:
 
 ```ruby
 # Set the following variables ( the gem is configured to use dotenv.
@@ -32,14 +32,14 @@ ENV['SURVEY_MONKEY_CLIENT_SECRET']
 ENV['SURVEY_MONKEY_CLIENT_ID']
 ```
 
-2. Create an instance of SurveyMonkey::Auth
+Option 2: Create an instance of SurveyMonkey::Auth with the credentials. 
 
 ```ruby
 api_credentials = {
-	access_token: 	'accesstoken',
-	api_key:		'apikey',
-	client_secret:	'clientsecret',
-	client_id:		'clientid'
+	access_token: 'accesstoken',
+	api_key: 'apikey',
+	client_secret: 'clientsecret',
+	client_id: 'clientid'
 }
 auth = SurveyMonkey::Auth.new(api_credentials)
 
@@ -58,15 +58,16 @@ Make the request:
 ```ruby
 # Create the request
 # if ENV vars were used, auth can be excluded from options hash
+# params can be excluded or nil to set with set_params method and a block
 
-options = {api_method: api_method, auth: auth}
+options = {api_method: api_method, auth: auth, params: nil}
 api_request = SurveyMonkey::Request.new(api_method)
 
 # Set the parameters
 api_request.set_parameters do |p|
 	p.page = 1
 	p.page_size = 10
-	p.order_ac = 'true'
+	p.order_asc = 'true'
 end
 
 # Run the request
@@ -79,10 +80,24 @@ result = api_request.result
 
 ## Quick Requests
 ```ruby
+# A shortcut for specifying params is to use a hash instead of the block.
+# The params_hash is passed in the options hash under the :params key
+# e.g.
+params_hash = {page_size: 10, page: 1, order_asc: 'true'}
+options = {params: params_hash}
+
 # A shortcut for making requests using default options is to simply call
 # SurveyMonkey.method where method is the name of the API method you wish to call
 # e.g. 
-request = SurveyMonkey.get_survey_list
+
+api_request = SurveyMonkey.get_survey_list options
+
+# Run the request
+api_request.run_request
+
+# View the result
+result = api_request.result
+
 ```
 
 ## TODO

data/lib/config/api_settings.yml

@@ -73,7 +73,7 @@ create_flow:
   parameters: 
     survey: 
       template_id: optional
-      form_survey_id: optional
+      from_survey_id: optional
       survey_title: optional
     collector: 
       type: conditionally_required

data/lib/survey_monkey/parameters.rb

@@ -1,5 +1,8 @@
 require 'survey_monkey/recipients'
 require 'survey_monkey/recipient'
+require "active_support"
+require "active_support/core_ext/string"
+require "active_support/core_ext/object"
 
 module SurveyMonkey
   class Parameters 
@@ -18,23 +21,35 @@ module SurveyMonkey
     def to_hash
       converted_hash = Hash.new
       method_parameters.keys.each do |root|
-        if method_parameters[root].is_a? Hash   ## has child
+        if method_parameters[root].is_a? Hash   ## The parameter has children
           converted_hash[root] = Hash.new
           method_parameters[root].keys.each do |child|
             if method_parameters[root][child].is_a? Hash   ## has grand_child
               method_parameters[root].keys.each do |grand_child|
-                converted_hash[root][child][grand_child] = self.send("#{root}_#{child}_#{grand_child}") ## GrandChild
+                # save the value for each grand_child into the hash
+                converted_hash[root][child][grand_child] = self.send("#{root}_#{child}_#{grand_child}")
               end
+              # Delete any nil grand_child keys
+              converted_hash[root][child].delete_if{ |k, v| v.nil? } if converted_hash[root].has_key?(child) 
             elsif method_parameters[root][child].is_a? Array
-              converted_hash[root][child] = self.send("#{root}_#{child}").to_hash ## Child Array
+              # child is an array. elements of array to hash
+              value = self.send("#{root}_#{child}")
+              unless value.empty?
+                converted_hash[root][child] = value
+                converted_hash[root][child].map{ |e| e.to_hash }
+              end
             else
-              converted_hash[root][child] = self.send("#{root}_#{child}") ## Child
+              value = self.send("#{root}_#{child}")
+              converted_hash[root][child] = value unless value.nil? ## save value for child (dont assign nil values)
             end
+            # Delete any root keys with nil values
+            converted_hash[root] = converted_hash[root].delete_if{ |k, v| v.nil? } if converted_hash.has_key?(root)
           end
         elsif method_parameters[root].is_a? Array
-          converted_hash[root] = self.send("#{root}").to_hash ## root Array
+          converted_hash[root] = self.send("#{root}").to_hash.delete_if{ |k, v| v.nil? } ## root Array
         else
-          converted_hash[root] = self.send("#{root}") ## No children
+          value = self.send("#{root}") ## No children
+          converted_hash[root] = value unless value.nil?
         end
       end
       converted_hash

data/lib/survey_monkey/recipient.rb

@@ -2,17 +2,21 @@ module SurveyMonkey
   class Recipient
     attr_accessor :email, :first_name, :last_name, :custom_id
     
-    def intialize(options = {})
-      email = options[:email]
-      first_name = options[:first_name]
-      first_name = options[:first_name]
-      last_name = options[:last_name]
-      custom_id = options[:custom_id]
-
+    def initialize(options = {})
+      @email = options[:email]
+      @first_name = options[:first_name]
+      @last_name = options[:last_name]
+      @custom_id = options[:custom_id]
       raise "Email Required for Recipient" if email.nil?
     end
+
     def to_hash
-      { email: email, name: name, last_name: last_name, custom_id: custom_id }
+      hash = Hash.new
+      hash["email"] = email unless email.nil?
+      hash["first_name"] = first_name unless first_name.nil?
+      hash["last_name"] = last_name unless last_name.nil?
+      hash["custom_id"] = custom_id unless custom_id.nil?
+      hash
     end
   end
 end

data/lib/survey_monkey/recipients.rb

@@ -17,7 +17,11 @@ module SurveyMonkey
     end
 
     def to_hash
-      map { |e| e.as_json }
+      map { |e| e.to_hash }
+    end
+
+    def empty?
+      count == 0
     end
   end
 end

data/lib/survey_monkey/request.rb

@@ -71,6 +71,7 @@ module SurveyMonkey
         end
       end
       request.run
+      self
     end
 
     def set_on_complete_response
@@ -93,6 +94,11 @@ module SurveyMonkey
       JSON.parse @response.body
     end
 
+    def submit
+      run_request
+      result
+    end
+
     private
       def api_key
         @api_key

data/lib/survey_monkey/version.rb

@@ -1,3 +1,3 @@
 module SurveyMonkey
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/survey_monkey.rb

@@ -1,7 +1,8 @@
 require "dotenv"
+require "json"
 require "active_record"
 require "active_support"
-require "json"
+require "active_support/all"
 require "typhoeus"
 require "yaml"
 require "survey_monkey/config"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: survey_monkey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Nick Dawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus