surveygizmo 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage/*
+.DS_STORE

data/.rspec

@@ -0,0 +1 @@
+--color

data/Rakefile

@@ -1,4 +1,10 @@
 #!/usr/bin/env rake
 
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/surveygizmo/client.rb

@@ -1,3 +1,5 @@
+require 'surveygizmo/configurable'
+
 module Surveygizmo
   # Wrapper for the Surveygizmo REST API
   #
@@ -9,19 +11,25 @@ module Surveygizmo
     # Client-namespaced.
     require 'surveygizmo/client/account'
     require 'surveygizmo/client/account_user'
+    require 'surveygizmo/client/contact'
     require 'surveygizmo/client/filter'
     require 'surveygizmo/client/survey'
     require 'surveygizmo/client/survey_campaign'
     require 'surveygizmo/client/survey_response'
+    require 'surveygizmo/client/survey_question'
+    require 'surveygizmo/client/survey_statistic'
 
     alias :api_endpoint :endpoint
 
+    include Surveygizmo::Configurable
     include Surveygizmo::Client::Account
     include Surveygizmo::Client::AccountUser
+    include Surveygizmo::Client::Contact
     include Surveygizmo::Client::Filter
     include Surveygizmo::Client::Survey
     include Surveygizmo::Client::SurveyCampaign
     include Surveygizmo::Client::SurveyResponse
-
+    include Surveygizmo::Client::SurveyQuestion
+    include Surveygizmo::Client::SurveyStatistic
   end
-end
+end

data/lib/surveygizmo/client/contact.rb

@@ -8,7 +8,7 @@ module Surveygizmo
       # @param survey_id [Integer, String] Specify the survey
       # @param survey_campaign_id [Integer, String] Specify the campaign
       def contacts(survey_id, survey_campaign_id)
-        get("survey/#{survey_id}/surveycampaign")
+        get("survey/#{survey_id}/surveycampaign/#{survey_campaign_id}/contact")
       end
       
       # Returns contact details for a given id
@@ -16,11 +16,11 @@ module Surveygizmo
       # @param survey_campaign_id [Integer, String] Specify the campaign
       # @param id [Integer, String] Specify the user
       def contact(survey_id, survey_campaign_id, id)
-        get("survey/#{survey_id}/surveycampaign/#{id}")
+        get("survey/#{survey_id}/surveycampaign/#{survey_campaign_id}/contact/#{id}")
       end
       
       # TODO: Create, Update, Delete
       
     end
   end
-end
+end

data/lib/surveygizmo/client/filter.rb

@@ -8,7 +8,7 @@ module Surveygizmo
       # TODO: Not yet recursive
       # @param filters [Hash] Filter(s) used to refine search
       def formatted_filters(filters = {})
-        Hash[*filters.map{|key,value| ["filter[#{key}]", value]}.flatten]
+        Hash[*filters.map{|key,value| ["filter[#{key}][0]", value]}.flatten]
       end
       
     end

data/lib/surveygizmo/client/survey.rb

@@ -6,9 +6,9 @@ module Surveygizmo
     module Survey
       
       # List all surveys, optionally filtered
-      # @param filters [Hash] Filter(s) used to refine search
-      def surveys(filters = {})
-        get('survey', formatted_filters(filters))
+      # @param options [Hash] Option(s) used to refine search
+      def surveys(options = {})
+        get('survey', options)
       end
       
       # Temporary, until SG implements filtering by subtype
@@ -27,4 +27,4 @@ module Surveygizmo
       
     end
   end
-end
+end

data/lib/surveygizmo/client/survey_question.rb

@@ -0,0 +1,25 @@
+
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo survey question
+    # @see http://developer.surveygizmo.com/rest-api-documentation/objects/surveyquestion/
+    module SurveyQuestion
+
+      # List all survey questions for a given survey
+      # @param survey_id [Integer, String] Specify the survey to the questions to get
+      def survey_questions(survey_id, options = {})
+        get("survey/#{survey_id}/surveyquestion", options)
+      end
+
+      # Returns survey question details for a given id
+      # @param survey_id [Integer, String] Specify the survey to the question to get
+      # @param id [Integer, String] Specify the question to get
+      def survey_question(survey_id, id)
+        get("survey/#{survey_id}/surveyquestion/#{id}")
+      end
+
+      # TODO: Create, Update, Delete
+
+    end
+  end
+end

data/lib/surveygizmo/client/survey_response.rb

@@ -6,8 +6,8 @@ module Surveygizmo
       
       # List all survey responses for a given survey
       # @param survey_id [Integer, String] Specify the survey to the responses to get
-      def survey_responses(survey_id)
-        get("survey/#{survey_id}/surveyresponse")
+      def survey_responses(survey_id, options = {})
+        get("survey/#{survey_id}/surveyresponse", options)
       end
       
       # Returns survey response details for a given id
@@ -21,4 +21,4 @@ module Surveygizmo
       
     end
   end
-end
+end

data/lib/surveygizmo/client/survey_statistic.rb

@@ -0,0 +1,24 @@
+module Surveygizmo
+  class Client
+    # Defines methods related to a SurveyGizmo survey statistic
+    # @see http://developer.surveygizmo.com/rest-api-documentation/objects/surveystatistic/
+    module SurveyStatistic
+
+      # List all survey statistics for a given survey
+      # @param survey_id [Integer, String] Specify the survey to the responses to get
+      def survey_statistics(survey_id, options = {})
+        get("survey/#{survey_id}/surveystatistic", options)
+      end
+
+      # Returns survey statstic details for a given id
+      # @param survey_id [Integer, String] Specify the survey to the response to get
+      # @param id [Integer, String] Specify the response to get
+      def survey_statistic(survey_id, id)
+        get("survey/#{survey_id}/surveystatistic/#{id}")
+      end
+
+      # TODO: Create, Update, Delete
+
+    end
+  end
+end

data/lib/surveygizmo/configurable.rb

@@ -0,0 +1,27 @@
+module Surveygizmo
+  module Configurable
+    class << self
+      def keys
+        @keys ||= [
+          :username,
+          :password
+        ]
+      end
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    private
+
+    # @return [Hash]
+    def credentials
+      {
+        :username => @username,
+        :password => @password
+      }
+    end
+  end
+end

data/lib/surveygizmo/configuration.rb

@@ -18,7 +18,7 @@ module Surveygizmo
     DEFAULT_PASSWORD = nil
     
     # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = 'https://restapi.surveygizmo.com/v1/'.freeze
+    DEFAULT_ENDPOINT = 'https://restapi.surveygizmo.com/v2/'.freeze
 
     # The value sent in the 'User-Agent' header if none is set
     DEFAULT_USER_AGENT = "Surveygizmo Ruby Gem #{Surveygizmo::VERSION}".freeze

data/lib/surveygizmo/connection.rb

@@ -10,10 +10,14 @@ module Surveygizmo
       def connection(temp_api_endpoint=nil)
         options = {
           :headers => { 'Accept' => 'application/json', 'User-Agent' => user_agent },
-          :ssl => { :verify => false },
-          :params => { :'user:md5' => "#{username}:#{Digest::MD5.hexdigest(password)}" }
+          :ssl => { :verify => false }
         }
 
+        if credentials?
+          authentication = auth_query_hash
+          options[:params] = authentication
+        end
+
         options[:url] = temp_api_endpoint ? temp_api_endpoint : api_endpoint
 
         Faraday.new(options) do |builder|
@@ -23,6 +27,9 @@ module Surveygizmo
           builder.adapter(:net_http)
         end
       end
-    
+
+      def auth_query_hash
+        { :'user:md5' => "#{username}:#{Digest::MD5.hexdigest(password)}" }
+      end
   end
 end

data/lib/surveygizmo/request.rb

@@ -11,16 +11,6 @@ module Surveygizmo
       request(:post, path, options, temp_api_endpoint)
     end
 
-    # Perform an HTTP PUT request
-    def put(path, options={})
-      request(:put, path, options)
-    end
-
-    # Perform an HTTP DELETE request
-    def delete(path, options={})
-      request(:delete, path, options)
-    end
-
     private
 
       # Perform an HTTP request

data/lib/surveygizmo/version.rb

@@ -1,3 +1,3 @@
 module Surveygizmo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/readme.textile

@@ -6,19 +6,21 @@ h2. Installation
 
 @gem install surveygizmo@
 
-h2. Documentation
-
-http://rdoc.info/github/ample/surveygizmo
-
 h2. Usage
 
-<code>
-# Configure your Surveygizmo client
+bc. # Configure your Surveygizmo client
 Surveygizmo.configure do |config|
   config.username = YOUR_USERNAME
   config.password = YOUR_PASSWORD
 end
-</code>
+
+bc. # Return a list of all Surveys
+Surveygizmo.surveys
+
+bc. # Return a specific Survey
+Surveygizmo.survey(id)
+
+See the "Documentation":http://rdoc.info/github/ample/surveygizmo for the full list
 
 h2. To Do List
 
@@ -57,17 +59,15 @@ This gem is very young, and not all endpoints have been implemented. Here's a br
 ** _Update_
 ** _Delete_
 * _Survey Option_
-* _Survey Question_
+* Survey Question
 * _Survey Page_
-* _Survey Statistics_
+* Survey Statistics
 * _Email Message_
 
-Also, there aren't any tests yet. This is high on the priority list and should be coming soon.
-
 h2. Thanks
 
 This gem is heavily inspired by the Twitter gem and John Nunemaker's hard work.
 
 h2. Copyright
 
-Copyright (c) 2011 Bobby Uhlenbrock. See LICENSE for details.
+Copyright (c) 2011-2012 Bobby Uhlenbrock. See LICENSE for details.

data/spec/fixtures/account.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":57382,"organization":"Surveygizmo","contact_phone":"2065555455","reseller":false,"resellers_customer_id":null,"reseller_uuid":null,"datecreated":"2011-10-05T15:26:36-04:00","login_link":"https:\/\/appv3.sgizmo.com\/login\/v1?authenticate=20743223994f21c0cc96c9e2de0455d2c545c470&account_user_id=2894&signature=abcdef"}}

data/spec/fixtures/account_user.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":"183437","_type":"AccountUser","username":"Jon","email":"jon@somewhere.com","status":"Active","last_login":"2012-07-05 18:24:02"}}

data/spec/fixtures/account_users.json

@@ -0,0 +1 @@
+{"result_ok":true,"total_count":"2","page":1,"total_pages":1,"results_per_page":2,"data":[{"id":"183437","_type":"AccountUser","username":"Jon ","email":"jon@somewhere.com","status":"Active","last_login":"2012-07-05 18:24:02"},{"id":"183440","_type":"AccountUser","username":"Jill","email":"jill@somewhere.org","status":"Active","last_login":"2012-08-21 14:04:47"}]}

data/spec/fixtures/contact.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":"1","semailaddress":"allan@gmail.com","sfirstname":"Allan ","slastname":"Something","sorganization":"","sdepartment":"","shomephone":"","sfaxphone":"","sbusinessphone":"","smailingaddress":"","smailingaddress2":"","smailingaddresscity":"","smailingaddressstate":"","smailingaddresscountry":"","smailingaddresspostal":"","stitle":"","surl":"","scustomfield1":"","scustomfield2":"","scustomfield3":"","scustomfield4":"","scustomfield5":"","scustomfield6":"","scustomfield7":"","scustomfield8":"","scustomfield9":"","scustomfield10":"","estatus":"Active","esubscriberstatus":"Sent"}}

data/spec/fixtures/contacts.json

@@ -0,0 +1 @@
+{"result_ok":true,"total_count":"1","page":1,"total_pages":1,"results_per_page":50,"data":[{"id":"1","semailaddress":"allen@somewhere.com","sfirstname":"Allan ","slastname":"Something","sorganization":"","sdepartment":"","shomephone":"","sfaxphone":"","sbusinessphone":"","smailingaddress":"","smailingaddress2":"","smailingaddresscity":"","smailingaddressstate":"","smailingaddresscountry":"","smailingaddresspostal":"","stitle":"","surl":"","scustomfield1":"","scustomfield2":"","scustomfield3":"","scustomfield4":"","scustomfield5":"","scustomfield6":"","scustomfield7":"","scustomfield8":"","scustomfield9":"","scustomfield10":"","estatus":"Active","esubscriberstatus":"Sent"}]}

data/spec/fixtures/create_account_user.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":"183438","_type":"AccountUser","username":"Jamie","email":"jamie@somewhere.com","status":"Active","last_login":"2012-07-05 18:24:02"}}

data/spec/fixtures/delete_account_user.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":"183438","_type":"AccountUser","username":"Jamie","email":"jamie@somewhere.com","status":"Active","last_login":"2012-07-05 18:24:02"}}

data/spec/fixtures/survey.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":"1018301","team":"463634","_type":"Survey","_subtype":"Standard Survey","status":"In Design","created_on":"2012-09-03 22:56:20","modified_on":"2012-09-03 22:56:21","forward_only":false,"languages":["English"],"title":"Movie Rating","internal_title":"Movie Rating","title_ml":{"English":"Movie Rating"},"theme":"11147","blockby":null,"statistics":null,"links":{"edit":"https:\/\/appv3.sgizmo.com\/login\/v1?authenticate=42cca89759ab50342a9694fc4cb59181d3e6141f&account_user_id=231934&r=%2Fprojects%2Feditor%3Fid%3D1018301&signature=ee3517","publish":"https:\/\/appv3.sgizmo.com\/login\/v1?authenticate=42cca89759ab50342a9694fc4cb59181d3e6141f&account_user_id=231934&r=%2Fdistribute%2Fpromote%3Fid%3D1018301&signature=274901"},"pages":[{"id":1,"_type":"SurveyPage","title":{"English":"Page One"},"properties":{"hidden":false},"description":[],"questions":[]},{"id":2,"_type":"SurveyPage","title":{"English":"Thank You!"},"properties":{"hidden":false},"description":[],"questions":[{"id":1,"_type":"SurveyDecorative","_subtype":"instructions","title":{"English":"Thank you for taking our survey. Your response is very important to us."},"shortname":null,"varname":null,"description":[],"has_showhide_deps":null,"properties":{"hidden":false,"map_key":"instructions"},"options":[],"sub_question_skus":null}]}]}}

data/spec/fixtures/survey_campaign.json

@@ -0,0 +1 @@
+{"result_ok":true,"data":{"id":"673550","_type":"SurveyCampaign","_subtype":"link","__subtype":"standard","status":"Active","name":"Default Link","uri":"www.surveygizmo.com\/s3\/1018301\/Movie-Rating","SSL":"False","tokenvariables":null,"limit_responses":null,"close_message":null,"language":"Auto","datecreated":"2012-09-03 23:39:26","datemodified":"2012-09-03 23:39:26"}}

data/spec/fixtures/survey_campaigns.json

@@ -0,0 +1 @@
+{"result_ok":true,"total_count":"1","page":1,"total_pages":1,"results_per_page":50,"data":[{"id":"673550","_type":"SurveyCampaign","_subtype":"link","__subtype":"standard","status":"Active","name":"Default Link","uri":"www.surveygizmo.com\/s3\/1018301\/Movie-Rating","SSL":"False","tokenvariables":null,"limit_responses":null,"close_message":null,"language":"Auto","datecreated":"2012-09-03 23:39:26","datemodified":"2012-09-03 23:39:26"}]}

data/spec/fixtures/survey_question.json

@@ -0,0 +1,33 @@
+{
+  "result_ok" : true,
+  "data" :
+    { "_subtype" : "instructions",
+      "_type" : "SurveyDecorative",
+      "description" : [  ],
+      "has_showhide_deps" : null,
+      "id" : 3,
+      "options" : [  ],
+      "properties" : { "break_after" : false,
+          "custom_css" : "",
+          "disabled" : false,
+          "hidden" : false,
+          "hide_after_response" : false,
+          "labels_right" : false,
+          "map_key" : "instructions",
+          "messages" : { "inputmask" : [  ],
+              "l_extreme_label" : [  ],
+              "left_label" : [  ],
+              "r_extreme_label" : [  ],
+              "right_label" : [  ]
+            },
+          "question_description_above" : false,
+          "required" : false,
+          "show_title" : false,
+          "soft-required" : false
+        },
+      "shortname" : null,
+      "sub_question_skus" : null,
+      "title" : { "English" : "Survey Title" },
+      "varname" : null
+    }
+}

data/spec/fixtures/survey_questions.json

@@ -0,0 +1,195 @@
+{
+  "result_ok" : true,
+  "page" : 1,
+  "results_per_page" : 4,
+  "total_count" : 400,
+  "total_pages" : 100,
+
+  "data" : [
+    { "_subtype" : "instructions",
+      "_type" : "SurveyDecorative",
+      "description" : [  ],
+      "has_showhide_deps" : null,
+      "id" : 3,
+      "options" : [  ],
+      "properties" : { "break_after" : false,
+          "custom_css" : "",
+          "disabled" : false,
+          "hidden" : false,
+          "hide_after_response" : false,
+          "labels_right" : false,
+          "map_key" : "instructions",
+          "messages" : { "inputmask" : [  ],
+              "l_extreme_label" : [  ],
+              "left_label" : [  ],
+              "r_extreme_label" : [  ],
+              "right_label" : [  ]
+            },
+          "question_description_above" : false,
+          "required" : false,
+          "show_title" : false,
+          "soft-required" : false
+        },
+      "shortname" : null,
+      "sub_question_skus" : null,
+      "title" : { "English" : "SurveyInstructions" },
+      "varname" : null
+    },
+    { "_subtype" : "table",
+      "_type" : "SurveyQuestion",
+      "description" : [  ],
+      "has_showhide_deps" : false,
+      "id" : 106,
+      "options" : [ { "_type" : "SurveyOption",
+            "id" : 10031,
+            "properties" : [  ],
+            "title" : { "English" : "1" },
+            "value" : "1"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10032,
+            "properties" : [  ],
+            "title" : { "English" : "2" },
+            "value" : "2"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10033,
+            "properties" : [  ],
+            "title" : { "English" : "3" },
+            "value" : "3"
+          }
+        ],
+      "properties" : { "break_after" : false,
+          "custom_css" : "",
+          "disabled" : false,
+          "exclude_number" : "YES",
+          "hidden" : false,
+          "hide_after_response" : false,
+          "labels_right" : false,
+          "map_key" : "table-radio",
+          "messages" : { "inputmask" : [  ],
+              "l_extreme_label" : [  ],
+              "left_label" : [  ],
+              "r_extreme_label" : [  ],
+              "right_label" : [  ]
+            },
+          "question_description" : { "English" : "" },
+          "question_description_above" : false,
+          "required" : true,
+          "show_title" : false,
+          "soft-required" : false
+        },
+      "shortname" : "",
+      "sub_question_skus" : [ 107,
+          108,
+          109,
+          110,
+          111
+        ],
+      "title" : { "English" : " " },
+      "varname" : ""
+    },
+    { "_subtype" : "radio",
+      "_type" : "SurveyQuestion",
+      "description" : [  ],
+      "has_showhide_deps" : null,
+      "id" : 107,
+      "options" : [ { "_type" : "SurveyOption",
+            "id" : 10031,
+            "properties" : [  ],
+            "title" : { "English" : "1" },
+            "value" : "1"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10032,
+            "properties" : [  ],
+            "title" : { "English" : "2" },
+            "value" : "2"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10033,
+            "properties" : [  ],
+            "title" : { "English" : "3" },
+            "value" : "3"
+          }
+        ],
+      "properties" : { "hidden" : false,
+          "option_sort" : false,
+          "orientation" : "VERT",
+          "required" : true
+        },
+      "shortname" : null,
+      "sub_question_skus" : null,
+      "title" : { "English" : "Radio question #1" },
+      "varname" : null
+    },
+    { "_subtype" : "radio",
+      "_type" : "SurveyQuestion",
+      "description" : [  ],
+      "has_showhide_deps" : null,
+      "id" : 108,
+      "options" : [ { "_type" : "SurveyOption",
+            "id" : 10031,
+            "properties" : [  ],
+            "title" : { "English" : "1" },
+            "value" : "1"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10032,
+            "properties" : [  ],
+            "title" : { "English" : "2" },
+            "value" : "2"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10033,
+            "properties" : [  ],
+            "title" : { "English" : "3" },
+            "value" : "3"
+          }
+        ],
+      "properties" : { "hidden" : false,
+          "option_sort" : false,
+          "orientation" : "VERT",
+          "required" : true
+        },
+      "shortname" : null,
+      "sub_question_skus" : null,
+      "title" : { "English" : "Radio option #2" },
+      "varname" : null
+    },
+    { "_subtype" : "radio",
+      "_type" : "SurveyQuestion",
+      "description" : [  ],
+      "has_showhide_deps" : null,
+      "id" : 109,
+      "options" : [ { "_type" : "SurveyOption",
+            "id" : 10031,
+            "properties" : [  ],
+            "title" : { "English" : "1" },
+            "value" : "1"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10032,
+            "properties" : [  ],
+            "title" : { "English" : "2" },
+            "value" : "2"
+          },
+          { "_type" : "SurveyOption",
+            "id" : 10033,
+            "properties" : [  ],
+            "title" : { "English" : "3" },
+            "value" : "3"
+          }
+        ],
+      "properties" : { "hidden" : false,
+          "option_sort" : false,
+          "orientation" : "VERT",
+          "required" : true
+        },
+      "shortname" : null,
+      "sub_question_skus" : null,
+      "title" : { "English" : "Radio option #3" },
+      "varname" : null
+    }
+  ]
+}