Add support for API version 5

lib/survey-gizmo-ruby.rb

@@ -17,4 +17,5 @@
 
 path = File.join(File.expand_path(File.dirname(__FILE__)), 'survey_gizmo')
 Dir["#{path}/*.rb"].each { |f| require f }
-Dir["#{path}/**/*.rb"].each { |f| require f }
+Dir["#{path}/v4/*.rb"].each { |f| require f }
+Dir["#{path}/v5/*.rb"].each { |f| require f }

lib/survey_gizmo/api/api.rb

@@ -0,0 +1,7 @@
+module SurveyGizmo::API
+  if SurveyGizmo.configuration.v5?
+    include SurveyGizmo::V5
+  else
+    include SurveyGizmo::V4
+  end
+end

lib/survey_gizmo/configuration.rb

@@ -32,6 +32,10 @@ def configure
       configuration.retriable_params = Configuration::DEFAULT_RETRIABLE_PARAMS.merge(configuration.retriable_params)
 
       @global_config = configuration
+
+      path = File.expand_path(File.dirname(__FILE__))
+      require File.join(path, 'api/api')
+      configuration
     end
 
     def reset!
@@ -41,7 +45,7 @@ def reset!
   end
 
   class Configuration
-    DEFAULT_API_VERSION = 'v4'
+    DEFAULT_API_VERSION = 'v5'
     DEFAULT_RESULTS_PER_PAGE = 50
     DEFAULT_TIMEOUT_SECONDS = 300
     DEFAULT_REGION = :us
@@ -113,5 +117,9 @@ def region=(region)
       @api_url = region_infos[:url]
       @api_time_zone = region_infos[:locale]
     end
+
+    def v5?
+      api_version == 'v5'
+    end
   end
 end

lib/survey_gizmo/faraday_middleware/parse_survey_gizmo.rb

@@ -19,6 +19,9 @@ class ParseSurveyGizmo < FaradayMiddleware::ResponseMiddleware
       'datecreated',
       'datemodified',
       'datesubmitted',
+      'date_created',
+      'date_modified',
+      'date_submitted',
       'modified_on'
     ]
 

lib/survey_gizmo/api/account_teams.rb → lib/survey_gizmo/v4/account_teams.rb

@@ -1,7 +1,7 @@
 # This REST endpoint is only available to accounts with admin privileges
 # This code is untested.
 
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class AccountTeams
     include SurveyGizmo::Resource
 

lib/survey_gizmo/api/answer.rb → lib/survey_gizmo/v4/answer.rb

@@ -1,4 +1,4 @@
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Answer
     include Virtus.model
 

lib/survey_gizmo/api/campaign.rb → lib/survey_gizmo/v4/campaign.rb

@@ -1,4 +1,4 @@
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Campaign
     include SurveyGizmo::Resource
 

lib/survey_gizmo/api/contact.rb → lib/survey_gizmo/v4/contact.rb

@@ -1,4 +1,4 @@
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Contact
     include SurveyGizmo::Resource
 

lib/survey_gizmo/api/email_message.rb → lib/survey_gizmo/v4/email_message.rb

@@ -1,4 +1,4 @@
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class EmailMessage
     include SurveyGizmo::Resource
 

lib/survey_gizmo/api/option.rb → lib/survey_gizmo/v4/option.rb

@@ -1,4 +1,4 @@
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Option
     include SurveyGizmo::Resource
     include SurveyGizmo::MultilingualTitle

lib/survey_gizmo/api/page.rb → lib/survey_gizmo/v4/page.rb

@@ -1,6 +1,6 @@
-require 'survey_gizmo/api/question'
+require 'survey_gizmo/v4/question'
 
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Page
     include SurveyGizmo::Resource
     include SurveyGizmo::MultilingualTitle

lib/survey_gizmo/api/question.rb → lib/survey_gizmo/v4/question.rb

@@ -1,6 +1,6 @@
-require 'survey_gizmo/api/option'
+require 'survey_gizmo/v4/option'
 
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Question
     include SurveyGizmo::Resource
     include SurveyGizmo::MultilingualTitle

lib/survey_gizmo/api/response.rb → lib/survey_gizmo/v4/response.rb

@@ -1,4 +1,4 @@
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Response
     include SurveyGizmo::Resource
 

lib/survey_gizmo/api/survey.rb → lib/survey_gizmo/v4/survey.rb

@@ -1,6 +1,6 @@
-require 'survey_gizmo/api/page'
+require 'survey_gizmo/v4/page'
 
-module SurveyGizmo::API
+module SurveyGizmo::V4
   class Survey
     include SurveyGizmo::Resource
 

lib/survey_gizmo/v5/account_teams.rb

@@ -0,0 +1,18 @@
+# This REST endpoint is only available to accounts with admin privileges
+# This code is untested.
+
+module SurveyGizmo::V5
+  class AccountTeams
+    include SurveyGizmo::Resource
+
+    attribute :id,            Integer
+    attribute :default_role,  String
+    attribute :status,        String
+
+    # v5 fields
+    attribute :team_name,      String
+    attribute :description,   String
+
+    @route = '/accountteams'
+  end
+end

lib/survey_gizmo/v5/answer.rb

@@ -0,0 +1,72 @@
+require 'survey_gizmo/v5/option'
+
+module SurveyGizmo::V5
+  class Answer
+    include Virtus.model
+
+    attribute :key,           String
+    attribute :value,         String
+    attribute :survey_id,     Integer
+    attribute :response_id,   Integer
+    attribute :question_id,   Integer
+    attribute :question_text, String
+    attribute :question_type, String
+    attribute :options,       Array[Option]
+    attribute :submitted_at,  DateTime
+    attribute :answer_text,   String
+    attribute :other_text,    String
+    attribute :question_pipe, String
+
+    def initialize(attrs = {})
+      self.attributes = attrs
+      self.question_id = value['id']
+      self.question_text = value['question']
+      self.question_type = value['type']
+
+      if value['options']
+        self.answer_text = selected_options_texts.join(', ')
+      else
+        self.answer_text = value['answer']
+      end
+    end
+
+    def single_option
+      [
+        Option.new(attributes.merge(
+          id: value['answer_id'],
+          value: value['answer'],
+          title: value['original_answer'] || value['answer']
+        ))
+      ]
+    end
+
+    def selected_options_texts
+      selected_options.map do |opt|
+        opt['answer']
+      end
+    end
+
+    def selected_options
+      value['options'].values.reject { |opt| opt['answer'].nil? }.map do |opt|
+        Option.new(attributes.merge(
+          id: opt['id'],
+          value: opt['answer'],
+          title: opt['option']
+        ))
+      end
+    end
+
+    # Strips out the answer_text when there is a valid option_id
+    def to_hash
+      {
+        response_id: response_id,
+        question_id: question_id,
+        question_pipe: question_pipe,
+        submitted_at: submitted_at,
+        survey_id: survey_id,
+        other_text: other_text,
+        answer_text: other_text ? nil : answer_text
+      }.reject { |k, v| v.nil? }
+    end
+  end
+end

lib/survey_gizmo/v5/campaign.rb

@@ -0,0 +1,32 @@
+module SurveyGizmo::V5
+  class Campaign
+    include SurveyGizmo::Resource
+
+    attribute :id,              Integer
+    attribute :name,            String
+    attribute :type,            String
+    attribute :status,          String
+    attribute :uri,             String
+    attribute :SSL,             Boolean
+    attribute :language,        String
+    attribute :close_message,   String
+    attribute :limit_responses, String
+    attribute :survey_id,       Integer
+
+    # v5 fields
+    attribute :token_variables,  Array
+    attribute :invite_id,       Integer
+    attribute :subtype,         String
+    attribute :link_type,       String
+    attribute :date_created,    DateTime
+    attribute :date_modified,   DateTime
+    attribute :link_open_date,  DateTime
+    attribute :link_close_date, DateTime
+
+    @route = '/survey/:survey_id/surveycampaign'
+
+    def contacts(conditions = {})
+      Contact.all(conditions.merge(children_params).merge(all_pages: !conditions[:page]))
+    end
+  end
+end

lib/survey_gizmo/v5/contact.rb

@@ -0,0 +1,46 @@
+module SurveyGizmo::V5
+  class Contact
+    include SurveyGizmo::Resource
+
+    attribute :id,                      Integer
+    attribute :survey_id,               Integer
+    attribute :campaign_id,             Integer
+
+    # v5 fields
+    attribute :date_last_sent,          DateTime
+    attribute :division,                String
+    attribute :team,                    String
+    attribute :group,                   String
+    attribute :role,                    String
+    attribute :status,                  String
+    attribute :subscriber_status,       String
+    attribute :email_address,           String
+    attribute :first_name,              String
+    attribute :last_name,               String
+    attribute :organization,            String
+    attribute :department,              String
+    attribute :business_phone,          String
+    attribute :home_phone,              String
+    attribute :fax_phone,               String
+    attribute :mailing_address,         String
+    attribute :mailing_address2,        String
+    attribute :mailing_address_city,    String
+    attribute :mailing_address_state,   String
+    attribute :mailing_address_country, String
+    attribute :mailing_address_postal,  String
+    attribute :title,                   String
+    attribute :url,                     String
+    attribute :customfield1,            String
+    attribute :customfield2,            String
+    attribute :customfield3,            String
+    attribute :customfield4,            String
+    attribute :customfield5,            String
+    attribute :customfield6,            String
+    attribute :customfield7,            String
+    attribute :customfield8,            String
+    attribute :customfield9,            String
+    attribute :customfield10,           String
+
+    @route = '/survey/:survey_id/surveycampaign/:campaign_id/contact'
+  end
+end

lib/survey_gizmo/v5/email_message.rb

@@ -0,0 +1,29 @@
+module SurveyGizmo::V5
+  class EmailMessage
+    include SurveyGizmo::Resource
+
+    attribute :id,                Integer
+    attribute :survey_id,         Integer
+    attribute :campaign_id,       Integer
+    attribute :invite_identity,   Integer
+    attribute :subject,           String
+    attribute :replies,           String
+    attribute :medium,            String
+    attribute :status,            String
+    attribute :from,              Hash
+    attribute :body,              Hash
+    attribute :send,              Boolean
+
+    # v5 fields
+    attribute :type,              String
+    attribute :subtype,           String
+    attribute :message_type,       String
+    attribute :footer,            String
+    attribute :embed_question,    Boolean
+    attribute :disable_styles,    Boolean
+    attribute :date_created,      DateTime
+    attribute :date_modified,     DateTime
+
+    @route = '/survey/:survey_id/surveycampaign/:campaign_id/emailmessage'
+  end
+end

lib/survey_gizmo/v5/option.rb

@@ -0,0 +1,18 @@
+module SurveyGizmo::V5
+  class Option
+    include SurveyGizmo::Resource
+    include SurveyGizmo::MultilingualTitle
+
+    attribute :id,            Integer
+    attribute :survey_id,     Integer
+    attribute :page_id,       Integer
+    attribute :question_id,   Integer
+    attribute :value,         String
+    attribute :properties,    Hash
+
+    # v5 fields
+    attribute :title,       String
+
+    @route = '/survey/:survey_id/surveypage/:page_id/surveyquestion/:question_id/surveyoption'
+  end
+end

lib/survey_gizmo/v5/page.rb

@@ -0,0 +1,27 @@
+require 'survey_gizmo/v5/question'
+
+module SurveyGizmo::V5
+  class Page
+    include SurveyGizmo::Resource
+    include SurveyGizmo::MultilingualTitle
+
+    attribute :id,            Integer
+    attribute :description,   String
+    attribute :properties,    Hash
+    attribute :survey_id,     Integer
+    attribute :questions,     Array[Question]
+
+    # v5 fields
+    attribute :title,       String
+
+    @route = '/survey/:survey_id/surveypage'
+
+    def survey
+      @survey ||= Survey.first(id: survey_id)
+    end
+
+    def questions
+      @questions.each { |q| q.attributes = children_params }
+    end
+  end
+end