questionpro_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 392c739ee6e848292c415b022e257a34c921785c
-  data.tar.gz: af526b9aaac803716a4938595988bd91e8c04ea4
+  metadata.gz: cd1ba206c0b432c652116dd0efada3b51cbcaacb
+  data.tar.gz: ef14a1dc5cfea420dfd8ac4c992045d140a8206f
 SHA512:
-  metadata.gz: bca6d715930431b50fa37fd0fc7e57bce09e3811e4e82f4b376c7f62e0e993df116bd3c2a3d220562cc5636dd1340d9cb25b4affde49950371e3bbb6f0762939
-  data.tar.gz: f728cf9f5f3c49ba66dd9aa1ba60c34f46340786ae39b1ca925f2c2b0fb20bb31f8d66f41b00f5c7b86292986f7ecdf6f5466be455f2d01c00ad2d3e2a3ab635
+  metadata.gz: 79fe244e0d32a63f69d440c70921f3dc13bb2982272a3cb93f7dc3e314f6e67a731b0591a123c131bee6d2eb992999d4819d33f65456c1894e3ca4e9b4259679
+  data.tar.gz: aa8deba5ec504f730985e41f34eb2eca58856c49e42f6dbd3990f9ca9e788f0cd1d6e46f7cce469a0891e0dd1e56515b38af2e8609470874dbb6299eaa45c3da

data/lib/questionpro_rails/account.rb

@@ -5,13 +5,13 @@ module QuestionproRails
                 :account_type, :creation_date, :phone
 
       def initialize (attributes)
-        @id = attributes['userID']
-        @first_name = attributes['firstName']
-        @last_name = attributes['lastName']
-        @last_login = attributes['lastLogin']
+        @id            = attributes['userID']
+        @first_name    = attributes['firstName']
+        @last_name     = attributes['lastName']
+        @last_login    = attributes['lastLogin']
         @email_address = attributes['emailAddress']
-        @phone = attributes['phone']
-        @account_type = attributes['accountType']
+        @phone         = attributes['phone']
+        @account_type  = attributes['accountType']
         @creation_date = attributes['creationDate']        
       end
   end

data/lib/questionpro_rails/api_request.rb

@@ -18,22 +18,41 @@ module QuestionproRails
                   :success, :message, :user_id, :status, :full_response, 
                   :starting_response_counter,  :email_group_id, :template_id
 
+    # Initializes a new Api Request.
+    #
+    # @param survey_id [Integer] 
+    # @param response_id [Integer] 
+    # @param result_mode [Integer] 
+    # @param start_date [String]  
+    # @param end_date [String]
+    # @param starting_response_counter [Integer] 
+    # @param email_group_id [Integer]
+    # @param template_id [Integer]
+    # @param user_id [Integer]
+    # @return [QuestionproRails::ApiRequest] Api Request object that is used to make the calls
     def initialize(survey_id = nil, response_id = nil, result_mode = 0, start_date = nil, end_date = nil, starting_response_counter = nil, email_group_id = nil, template_id = nil, user_id = nil)
-      @survey_id = survey_id
-      @response_id = response_id
-      @result_mode = result_mode
-      @start_date = start_date
-      @end_date = end_date
-      @starting_response_counter = starting_response_counter   
-      @email_group_id = email_group_id   
-      @template_id = template_id
-      @user_id = user_id
+      @survey_id                 = survey_id
+      @response_id               = response_id
+      @result_mode               = result_mode
+      @start_date                = start_date
+      @end_date                  = end_date
+      @email_group_id            = email_group_id   
+      @template_id               = template_id
+      @user_id                   = user_id
+      @starting_response_counter = starting_response_counter
     end
 
+    # Get the base url for api call.
+    # 
+    # @param method_url [String] the api method url.
+    # @return [String] Url for Api Call. 
     def self.base_path(method_url)
       "/a/api/#{method_url}?apiKey=#{QuestionproRails.api_key}"
     end
 
+    # Transform the object to the acceptable json format by questionpro.
+    # 
+    # @return [Json] options in the call request.
     def options
       {id: self.survey_id, surveyID: self.survey_id, responseID: self.response_id, 
        resultMode: self.result_mode, startDate: self.start_date, userID: self.user_id, 
@@ -41,6 +60,9 @@ module QuestionproRails
        emailGroupID: self.email_group_id, templateID: self.template_id}.compact.to_json
     end
 
+    # Get all the surveys that belongs to the api key's owner.
+    # 
+    # @return [Array<QuestionproRails::Survey>] Surveys.
     def list_surveys
       url = ApiRequest.base_path("questionpro.survey.getAllSurveys")
       result = self.class.get(url, body: self.options)
@@ -57,6 +79,10 @@ module QuestionproRails
       return surveys
     end
 
+    # Get a specific survey.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::Survey] Survey.
     def get_survey
       url = ApiRequest.base_path("questionpro.survey.getSurvey")
       result = self.class.get(url, body: self.options)
@@ -69,6 +95,10 @@ module QuestionproRails
       return survey
     end
 
+    # Delete a specific survey.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return sets ApiRequest success attribute to 1.
     def delete_survey
       url = ApiRequest.base_path("questionpro.survey.deleteSurvey")
       result = self.class.get(url, body: self.options)
@@ -80,6 +110,10 @@ module QuestionproRails
       return self
     end    
 
+    # Get list of survey Responses.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [Array<QuestionproRails::SurveyResponse>] Survey Responses.
     def get_survey_responses
       url = ApiRequest.base_path("questionpro.survey.surveyResponses")
       result = self.class.get(url, body: self.options)
@@ -96,6 +130,11 @@ module QuestionproRails
       return survey_responses
     end
 
+    # Get a specific survey Response.
+    # Survey ID must be set inside the api request object.
+    # Response ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::SurveyResponse] Survey Response.
     def get_survey_reponse
       url = ApiRequest.base_path("questionpro.survey.surveyResponse")
       result = self.class.get(url, body: self.options)
@@ -108,6 +147,10 @@ module QuestionproRails
       return response
     end
 
+    # Get a specific survey Response Statistics.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::SurveyResponseCount] Survey Response Statistics.
     def get_survey_response_count
       url = ApiRequest.base_path("questionpro.survey.responseCount")
       result = self.class.get(url, body: self.options)
@@ -120,6 +163,11 @@ module QuestionproRails
       return response_count
     end   
 
+    # Delete a specific survey response.
+    # Survey ID must be set inside the api request object.
+    # Response ID must be set inside the api request object.    
+    #
+    # @return sets ApiRequest success attribute to 1.
     def delete_response
       url = ApiRequest.base_path("questionpro.survey.deleteResponse")
       result = self.class.get(url, body: self.options)
@@ -131,6 +179,10 @@ module QuestionproRails
       return self       
     end 
 
+    # Get Email Lists related to a specific survey.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [Array<QuestionproRails::EmailList>] Email Lists.
     def get_email_lists
       url = ApiRequest.base_path("questionpro.survey.getEmailLists")
       result = self.class.get(url, body: self.options)
@@ -147,6 +199,10 @@ module QuestionproRails
       return email_lists
     end
 
+    # Get Specific Email List.
+    # Email Group ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::EmailList] Email List.
     def get_email_list
       url = ApiRequest.base_path("questionpro.survey.getEmailList")
       result = self.class.get(url, body: self.options)
@@ -159,6 +215,10 @@ module QuestionproRails
       return email_list
     end 
 
+    # Delete Specific Email List.
+    # Email Group ID must be set inside the api request object.
+    #
+    # @return sets ApiRequest success attribute to 1.
     def delete_email_list
       url = ApiRequest.base_path("questionpro.survey.deleteEmailList")
       result = self.class.get(url, body: self.options)
@@ -170,6 +230,10 @@ module QuestionproRails
       return self
     end
 
+    # Get Templates related to a specific survey.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [Array<QuestionproRails::Template>] Templates.
     def get_email_templates
       url = ApiRequest.base_path("questionpro.survey.getEmailTemplates")
       result = self.class.get(url, body: self.options)
@@ -186,6 +250,10 @@ module QuestionproRails
       return email_templates
     end
 
+    # Get Specific Template.
+    # Template ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::Template] Template.
     def get_email_template
       url = ApiRequest.base_path("questionpro.survey.getEmailTemplate")
       result = self.class.get(url, body: self.options)
@@ -198,6 +266,10 @@ module QuestionproRails
       return email_template
     end 
 
+    # Delete Specific Template.
+    # Template ID must be set inside the api request object.
+    #
+    # @return sets ApiRequest success attribute to 1.
     def delete_email_template
       url = ApiRequest.base_path("questionpro.survey.deleteEmailTemplate")
       result = self.class.get(url, body: self.options)
@@ -209,6 +281,9 @@ module QuestionproRails
       return self
     end
 
+    # Get all the accounts that belongs to the api key's owner.
+    # 
+    # @return [Array<QuestionproRails::Account>] Accounts.
     def get_all_accounts
       url = ApiRequest.base_path("questionpro.survey.getAllAccounts")
       result = self.class.get(url, body: self.options)
@@ -225,6 +300,10 @@ module QuestionproRails
       return accounts
     end
 
+    # Get Specific Account.
+    # User ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::Account] Account.
     def get_account
       url = ApiRequest.base_path("questionpro.survey.getAccount")
       result = self.class.get(url, body: self.options)
@@ -237,6 +316,9 @@ module QuestionproRails
       return account
     end   
 
+    # Get Unsubscribed Emails related to the api key.
+    #
+    # @return [Array<QuestionproRails::UnsubscribedEmail>] Unsubscribed Emails.
     def get_unsubscribers
       url = ApiRequest.base_path("questionpro.survey.getUnsubscribedEmailAddresses")
       result = self.class.get(url, body: self.options)
@@ -253,6 +335,9 @@ module QuestionproRails
       return unsubscribers
     end
 
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [QuestionproRails::SurveyMeta] Survey meta.
     def get_survey_meta
       url = ApiRequest.base_path("questionpro.survey.sendSurveyMetaData")
       result = self.class.get(url, body: self.options)
@@ -265,17 +350,28 @@ module QuestionproRails
       return survey_meta          
     end
 
-    def send_survey(mode = 1, emails = nil, template = nil)
+    # Send Specific Survey.
+    # Survey ID must be set inside the api request object.
+    #
+    # @param [Integer] mode (1).
+    # @param [Array<String>] emails to send to (nil).
+    # @param [Integer] template_id of email (nil).
+    # @return sets ApiRequest message attribute to "Message successful.".
+    def send_survey(mode = 1, emails = nil, template_id = nil)
       url = ApiRequest.base_path("questionpro.survey.sendSurvey")
       result = self.class.get(url, body: {surveyID: self.survey_id, mode: mode, 
                                           emailGroupID: self.email_group_id, emails: emails, 
-                                          templateID: self.template_id, template: template}.compact.to_json)
+                                          templateID: self.template_id, template: template_id}.compact.to_json)
 
       self.full_response = result
       self.status = result['status']
       self.message = result['response']['result']
     end
 
+    # Get Send History related to a specific survey.
+    # Survey ID must be set inside the api request object.
+    #
+    # @return [Array<QuestionproRails::EmailBatch>] Email Batches.
     def get_send_history
       url = ApiRequest.base_path("questionpro.survey.emailBatchStatistics")
       result = self.class.get(url, body: self.options)
@@ -292,6 +388,12 @@ module QuestionproRails
       return email_batches      
     end
 
+    # Send Reminders.
+    # Survey ID must be set inside the api request object.
+    # Email Group ID must be set inside the api request object.
+    # Template ID must be set inside the api request object.
+    #
+    # @return sets ApiRequest message attribute to "Message successful.".
     def send_reminders
       url = ApiRequest.base_path("questionpro.survey.sendReminder")
       result = self.class.get(url, body: self.options)
@@ -301,6 +403,12 @@ module QuestionproRails
       self.message = result['response']['result']
     end  
 
+    # Create Email List.
+    # Survey ID must be set inside the api request object.
+    #
+    # @param [Array<String>] emails ([]).
+    # @param [String] email_group_name (nil).
+    # @return sets ApiRequest email_group_id to the created email list id.
     def create_email_list (emails = [], email_group_name = nil)
       url = ApiRequest.base_path("questionpro.survey.createEmailGroup")
       result = self.class.get(url, body: {id: self.survey_id, emails: emails, 

data/lib/questionpro_rails/choice.rb

@@ -1,14 +1,14 @@
 module QuestionproRails
   class Choice
 
-    attr_reader :score, :is_default, :exclude_randomize, :id, :text
+    attr_reader :id, :text, :score, :is_default, :exclude_randomize
 
     def initialize (attributes)
-      @id = attributes['id']
-      @score = attributes['score']
-      @is_default = attributes['isDefault']
+      @id                = attributes['id']
+      @score             = attributes['score']
+      @is_default        = attributes['isDefault']
       @exclude_randomize = attributes['excludeRandomize']      
-      @text = attributes['text']      
+      @text              = attributes['text']      
     end
 
   end

data/lib/questionpro_rails/configuration.rb

@@ -1,5 +1,6 @@
 module QuestionproRails
   class Configuration
+    
     attr_accessor :api_key
 
     def initialize

data/lib/questionpro_rails/email_batch.rb

@@ -5,16 +5,16 @@ module QuestionproRails
                 :batch_type, :participation_pending, :timestamp, :initial_sent, :status
 
     def initialize (attributes)
-      @id = attributes['batchID']
-      @email_group = attributes['emailGroup']
-      @viewed = attributes['viewed']
-      @completed = attributes['completed']      
-      @participation_rate = attributes['participationRate']
-      @batch_type = attributes['batchType']
+      @id                    = attributes['batchID']
+      @email_group           = attributes['emailGroup']
+      @viewed                = attributes['viewed']
+      @completed             = attributes['completed']      
+      @participation_rate    = attributes['participationRate']
+      @batch_type            = attributes['batchType']
       @participation_pending = attributes['participationPending']
-      @timestamp = attributes['timestamp']
-      @initial_sent = attributes['initialSent']
-      @status = attributes['status']
+      @timestamp             = attributes['timestamp']
+      @initial_sent          = attributes['initialSent']
+      @status                = attributes['status']
     end
 
   end

data/lib/questionpro_rails/email_group.rb

@@ -4,7 +4,7 @@ module QuestionproRails
     attr_reader :id, :email_group_name
 
     def initialize (attributes) 
-      @id = attributes['emailGroupID']
+      @id               = attributes['emailGroupID']
       @email_group_name = attributes['emailGroupName']          
     end
 

data/lib/questionpro_rails/email_list.rb

@@ -3,22 +3,31 @@ require "questionpro_rails/email_list_statistic"
 module QuestionproRails
   class EmailList
 
-    attr_reader :survey_id, :name, :email_group_id, :qp_emails, :qp_statistics, 
+    attr_reader :survey_id, :name, :email_group_id, 
                 :unsubscribed, :total, :active, :pendin_verification, :bounced
 
+    # @return [Array<String>] Emails.
+    attr_reader :qp_emails 
+
+    # @return [Hash] Email list statistics.
+    attr_reader :qp_statistics
+
     def initialize (attributes)      
-      @survey_id = attributes['surveyID']
-      @email_group_id = attributes['emailGroupID']
-      @name = attributes['name']      
-      @qp_emails = attributes['email']
-      @qp_statistics = attributes['statistics']
-      @unsubscribed = attributes['unsubscribed']
-      @total = attributes['total']
-      @active = attributes['active']
+      @survey_id           = attributes['surveyID']
+      @email_group_id      = attributes['emailGroupID']
+      @name                = attributes['name']      
+      @qp_emails           = attributes['email']
+      @qp_statistics       = attributes['statistics']
+      @unsubscribed        = attributes['unsubscribed']
+      @total               = attributes['total']
+      @active              = attributes['active']
       @pendin_verification = attributes['pendinVerification']
-      @bounced = attributes['bounced']
+      @bounced             = attributes['bounced']
     end
 
+    # Extract the email list statistics from qp_statistics attribute.
+    #
+    # @return [QuestionproRails::EmailListStatistic] Email List Statistics.
     def statistics
       extracted_statistics = []
 
@@ -29,6 +38,9 @@ module QuestionproRails
       return extracted_statistics
     end
 
+    # Extract and seperate emails from qp_emails.
+    #
+    # @return [Array<String>] Emails.
     def emails
       unless self.qp_emails.empty?
         return self.qp_emails.split(',')

data/lib/questionpro_rails/email_list_statistic.rb

@@ -5,11 +5,11 @@ module QuestionproRails
                 :pendin_verification, :bounced
 
     def initialize (attributes)
-      @unsubscribed = attributes['unsubscribed']
-      @total = attributes['total']
-      @active = attributes['active']
+      @unsubscribed        = attributes['unsubscribed']
+      @total               = attributes['total']
+      @active              = attributes['active']
       @pendin_verification = attributes['pendinVerification']
-      @bounced = attributes['bounced']
+      @bounced             = attributes['bounced']
     end                
             
   end

data/lib/questionpro_rails/email_template.rb

@@ -4,9 +4,9 @@ module QuestionproRails
     attr_reader :id, :survey_id, :title, :content_summary
     
     def initialize (attributes)
-      @id = attributes['templateID']
-      @survey_id = attributes['surveyID']      
-      @title = attributes['title']
+      @id              = attributes['templateID']
+      @survey_id       = attributes['surveyID']      
+      @title           = attributes['title']
       @content_summary = attributes['contentSummary'] 
     end
 

data/lib/questionpro_rails/question.rb

@@ -3,15 +3,22 @@ require "questionpro_rails/choice"
 module QuestionproRails
   class Question
 
-    attr_reader :order_number, :qp_answers, :id, :text
+    attr_reader :id, :order_number, :text
+
+    # @return [Array<Hash>] Choices available for the question.
+    attr_reader :qp_answers 
 
     def initialize (attributes)
-      @id = attributes['id']
+      @id           = attributes['id']
       @order_number = attributes['orderNumber']          
-      @text = attributes['text']
-      @qp_answers = attributes['answers']
+      @text         = attributes['text']
+      @qp_answers   = attributes['answers']
     end
 
+    # Extract the choices from the hashes stored
+    # inside qp_answers attribute.
+    #
+    # @return [Array<QuestionproRails::Choice>] Choices.
     def choices
       extracted_choices = []
 

data/lib/questionpro_rails/response_answer.rb

@@ -4,9 +4,9 @@ module QuestionproRails
     attr_reader :id, :answer_text, :value    
 
     def initialize (attributes)
-      @id = attributes['id']
+      @id          = attributes['id']
       @answer_text = attributes['answerText']      
-      @value = attributes['value']      
+      @value       = attributes['value']      
     end
 
   end

data/lib/questionpro_rails/response_set.rb

@@ -3,16 +3,23 @@ require "questionpro_rails/response_answer"
 module QuestionproRails
   class ResponseSet
     
-    attr_reader :question_code, :question_description, :question_id, :question_text, :qp_values
+    attr_reader :question_code, :question_description, :question_id, :question_text
+
+    # @return [Array<Hash>] Answers collected from the survey response.
+    attr_reader :qp_values
 
     def initialize (attributes)
-      @question_code = attributes['questionCode']
+      @question_code        = attributes['questionCode']
       @question_description = attributes['questionDescription']
-      @question_id = attributes['questionID']
-      @question_text = attributes['questionText']
-      @qp_values = attributes['values']      
+      @question_id          = attributes['questionID']
+      @question_text        = attributes['questionText']
+      @qp_values            = attributes['values']      
     end
 
+    # Extract the Answers from the hashes stored
+    # inside qp_values attribute.
+    #
+    # @return [Array<QuestionproRails::ResponseAnswer>] Response Answers.
     def answers
       extracted_answers = []
 

data/lib/questionpro_rails/section.rb

@@ -3,31 +3,39 @@ require "questionpro_rails/question"
 module QuestionproRails
 	class Section
 
-		attr_reader :num_tasks, :exact_min_answers, :orientation, :code, :video_type, :max_answers, :qp_questions,
- 								:dynamic_explode_text, :section_id, :video, :type, :min_answers, :required, :has_page_break, 
- 								:random, :random_section, :subtype, :mobile_friendly
+		attr_reader :id, :num_tasks, :exact_min_answers, :orientation, :code, 
+                :max_answers, :required, :has_page_break, :type, 
+                :dynamic_explode_text, :video, :video_type, :min_answers,
+                :random, :random_section, :subtype, :mobile_friendly
+
+    # @return [Array<Hash>] Questions collected inside the section.
+    attr_reader :qp_questions
 
 		def initialize(attributes)
-			@num_tasks = attributes['numTasks']
-			@exact_min_answers = attributes['exactMinAnswers']
-			@orientation = attributes['orientation']
-			@code = attributes['code']
-			@video_type = attributes['videoType']
-			@max_answers = attributes['maxAnswers']			
-			@dynamic_explode_text = attributes['dynamicExplodeText']
-			@section_id = attributes['sectionID']
-			@video = attributes['video']
-			@type = attributes['type']
-			@min_answers = attributes['minAnswers']
-			@required = attributes['required']
-			@has_page_break = attributes['hasPageBreak']
-			@random = attributes['random']
-			@random_section = attributes['randomSection']
-			@subtype = attributes['subtype']
-			@mobile_friendly = attributes['mobileFriendly']	
-			@qp_questions = attributes['questions']					
+      @id                   = attributes['sectionID']
+			@num_tasks            = attributes['numTasks']
+			@exact_min_answers    = attributes['exactMinAnswers']
+			@orientation          = attributes['orientation']
+			@code                 = attributes['code']
+			@video_type           = attributes['videoType']
+			@max_answers          = attributes['maxAnswers']			
+			@dynamic_explode_text = attributes['dynamicExplodeText']			
+			@video                = attributes['video']
+			@type                 = attributes['type']
+			@min_answers          = attributes['minAnswers']
+			@required             = attributes['required']
+			@has_page_break       = attributes['hasPageBreak']
+			@random               = attributes['random']
+			@random_section       = attributes['randomSection']
+			@subtype              = attributes['subtype']
+			@mobile_friendly      = attributes['mobileFriendly']	
+			@qp_questions         = attributes['questions']					
 		end
 
+    # Extract the Questions from the hashes stored
+    # inside qp_questions attribute.
+    #
+    # @return [Array<QuestionproRails::Question>] Questions.
 		def questions
       extracted_questions = []
 

data/lib/questionpro_rails/survey.rb

@@ -4,20 +4,27 @@ module QuestionproRails
   class Survey
 
     attr_reader :id, :name, :subtitle, :url, :thank_you_message, 
-                :has_scoring_logic, :numeric_title, :status, :qp_sections
+                :has_scoring_logic, :numeric_title, :status
+
+    # @return [Array<Hash>] Sections collected from the survey request.
+    attr_reader :qp_sections
 
     def initialize (attributes)
-      @id = (attributes['id'] || attributes['surveyID']) 
-      @name = (attributes['title'] || attributes['surveyName'])
-      @url = (attributes['surveyURL'] || attributes['connectURL'])
-      @subtitle = attributes['subtitle']
+      @id                = (attributes['id'] || attributes['surveyID']) 
+      @name              = (attributes['title'] || attributes['surveyName'])
+      @url               = (attributes['surveyURL'] || attributes['connectURL'])
+      @subtitle          = attributes['subtitle']
       @thank_you_message = attributes['thankYouMessage']
       @has_scoring_logic = attributes['hasScoringLogic']
-      @numeric_title = attributes['numericTitle']
-      @status = attributes['status']
-      @qp_sections = attributes['sections']
+      @numeric_title     = attributes['numericTitle']
+      @status            = attributes['status']
+      @qp_sections       = attributes['sections']
     end
 
+    # Extract the Sections from the hashes stored
+    # inside qp_sections attribute.
+    #
+    # @return [Array<QuestionproRails::Section>] Sections. 
     def sections
       extracted_sections = []
 

data/lib/questionpro_rails/survey_meta.rb

@@ -4,13 +4,21 @@ require "questionpro_rails/template"
 module QuestionproRails
   class SurveyMeta
 
-    attr_reader :email_groups_list, :templates_list
+    # @return [Array<Hash>] Email Groups List collected from the survey meta.
+    attr_reader :email_groups_list
+
+    # @return [Array<Hash>] Templates List collected from the survey meta.
+    attr_reader :templates_list
     
     def initialize (attributes)
       @email_groups_list = attributes['emailGroups']
-      @templates_list = attributes['templates']
+      @templates_list    = attributes['templates']
     end
 
+    # Extract the Email Groups from the hashes stored
+    # inside email_groups_list attribute.
+    #
+    # @return [Array<QuestionproRails::EmailGroup>] Email Groups.
     def email_groups
       extracted_groups = []
 
@@ -23,6 +31,10 @@ module QuestionproRails
       return extracted_groups
     end
 
+    # Extract the Templates from the hashes stored
+    # inside templates_list attribute.
+    #
+    # @return [Array<QuestionproRails::Template>] Templates.
     def templates
       extracted_templates = []
 

data/lib/questionpro_rails/survey_response.rb

@@ -4,22 +4,29 @@ module QuestionproRails
   class SurveyResponse
 
     attr_reader :id, :country, :duplicate, :external_reference, 
-                :ip_address, :region, :qp_response_set, :response_status,
+                :ip_address, :region, :response_status,
                 :time_taken, :timestamp
 
+    # @return [Array<Hash>] Response Set collected from the survey response.
+    attr_reader :qp_response_set
+
     def initialize (attributes)
-      @id = attributes['id']
-      @country = attributes['country']
-      @duplicate = attributes['duplicate']
+      @id                 = attributes['id']
+      @country            = attributes['country']
+      @duplicate          = attributes['duplicate']
       @external_reference = attributes['externalReference']
-      @ip_address = attributes['ipAddress']
-      @region = attributes['region']
-      @qp_response_set = attributes['responseSet']
-      @response_status = attributes['responseStatus']
-      @time_taken = attributes['timeTaken']
-      @timestamp = attributes['timestamp']      
+      @ip_address         = attributes['ipAddress']
+      @region             = attributes['region']
+      @qp_response_set    = attributes['responseSet']
+      @response_status    = attributes['responseStatus']
+      @time_taken         = attributes['timeTaken']
+      @timestamp          = attributes['timestamp']      
     end
 
+    # Extract the Response Set from the hash stored
+    # inside qp_response_set attribute.
+    #
+    # @return [Array<QuestionproRails::ResponseSet>] Response Sets. 
     def response_set
       extracted_sets = []
 

data/lib/questionpro_rails/survey_response_count.rb

@@ -6,17 +6,17 @@ module QuestionproRails
                 :complete_count, :started_count, :status
 
     def initialize (attributes)
-      @id = attributes['id']
-      @name = attributes['name']
-      @partial_count = attributes['partialCount']
-      @overall_viewed_count = attributes['overallViewedCount']
-      @overall_complete_count = attributes['overallCompleteCount']
+      @id                       = attributes['id']
+      @name                     = attributes['name']
+      @partial_count            = attributes['partialCount']
+      @overall_viewed_count     = attributes['overallViewedCount']
+      @overall_complete_count   = attributes['overallCompleteCount']
       @overall_terminated_count = attributes['overallTerminatedCount']
-      @terminated_count = attributes['terminatedCount']
-      @overall_started_count = attributes['overallStartedCount']
-      @complete_count = attributes['completeCount']
-      @started_count = attributes['startedCount']
-      @status = attributes['status']
+      @terminated_count         = attributes['terminatedCount']
+      @overall_started_count    = attributes['overallStartedCount']
+      @complete_count           = attributes['completeCount']
+      @started_count            = attributes['startedCount']
+      @status                   = attributes['status']
     end
 
   end

data/lib/questionpro_rails/template.rb

@@ -4,7 +4,7 @@ module QuestionproRails
     attr_reader :id, :template_subject
 
     def initialize (attributes) 
-      @id = attributes['templateID']
+      @id               = attributes['templateID']
       @template_subject = attributes['templateSubject']          
     end 
 

data/lib/questionpro_rails/unsubscribed_email.rb

@@ -4,8 +4,8 @@ module QuestionproRails
     attr_reader :id, :email, :unsubscribed_time
 
     def initialize (attributes)
-      @id = attributes['id']
-      @email = attributes['emailAddress']
+      @id                = attributes['id']
+      @email             = attributes['emailAddress']
       @unsubscribed_time = attributes['unsubscribedTime']
     end
   end

data/lib/questionpro_rails/version.rb

@@ -1,3 +1,4 @@
 module QuestionproRails
-  VERSION = "0.1.0"
+  # Gem Version
+  VERSION = "0.1.1"
 end

data/lib/questionpro_rails.rb

@@ -6,20 +6,29 @@ require "questionpro_rails/api_request"
 module QuestionproRails
 
   class << self
+    
     attr_accessor :configuration
 
+    # Get the Configurations or Reset
+    # 
+    # @return [QuestionproRails::Configuration] Configuration
     def configuration
       @configuration ||= Configuration.new
     end
 
+    # Reset Configuration to nil
     def reset
       @configuration = Configuration.new
     end
 
+    # Holds the configurtion block
     def configure
       yield(configuration)
     end    
 
+    # Get the api key from the configurations
+    # 
+    # @return [String] Api Key
     def api_key
       configuration.api_key
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: questionpro_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Assem Deghady
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.6
 description: 
 email:
 - assem.deghady@gmail.com