missinglink 0.1.6 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b278ee350c825cbf5865a20c06323cc2760988a7
-  data.tar.gz: 1d12e2f05a11a165e56d4903229020a20ce1952a
+  metadata.gz: d5ab020970fa34b7686f693901d08b96088f9089
+  data.tar.gz: f0a3ad6302bce18822d17faeddfee59bf775325d
 SHA512:
-  metadata.gz: b286d50f06cecd6c25726fb54857d57005177d1cbd88e5733b0d22d18fe2e52d161d7018890a70ebb1e980280f5ddd346c5402f94ee78622316884d20c8eb6d4
-  data.tar.gz: 1b89b1e30c1c85646b305a90820b5ff219309a74d0d0061e82025058b4ab899e8296b0c965ad48ac6341075c8a7e14557dfb2edfe2a5123469d7d8b9eb49539d
+  metadata.gz: 557e5969361e996f5b6f3206c2296c8904c51c1597f5759ac2dbd4350a2aeffe28c480f3ec33bd528e0203f1f47416191d95cd5d1426318a5826421c9e3ddc78
+  data.tar.gz: 3aa659a7708656e19dfd80c76864c83816905e80c629a7a25a8606606c10a4e05ef3e93824ac73dc38079859a6b427efa2aebd242f4a38a1c792cf2102eda085

data/app/models/missinglink/survey.rb

@@ -14,5 +14,67 @@ module Missinglink
         return Survey.create(sm_survey_id: sm_id.to_i)
       end
     end
+
+    def load_survey_details
+      response = Connection.request('get_survey_details',
+                                         { survey_id: sm_survey_id.to_s })
+      (puts "Error loading survey details for survey #{ self.inspect }." && return) unless response
+
+      update_from_survey_details(response)
+
+      response['pages'].each do |page|
+        SurveyPage.parse(self, page)
+      end
+
+      return true
+    end
+
+    def load_respondents
+      response = Connection.request('get_respondent_list',
+                                    { survey_id: sm_survey_id.to_s })
+      (puts "Error loading responses for survey #{ self.inspect }" && return) unless response
+
+      response['respondents'].each do |respondent|
+        SurveyRespondentDetail.parse(self, respondent)
+      end
+
+      return true
+    end
+
+    def respondents_to_update
+      completed_respondents = survey_respondent_details.completed
+      completed_respondents.select { |r| r.survey_responses.empty? }
+    end
+
+    def load_response_details(respondents)
+      respondents = [respondents] unless respondents.is_a? Array
+
+      while (respondents.size > 0)
+        ids = respondents.slice!(0, 100).map { |x| x.sm_respondent_id.to_s }
+        response = Connection.request('get_responses',
+                                      { survey_id: sm_survey_id.to_s,
+                                        respondent_ids: ids })
+
+        (puts "Error fetching response answers" && return) unless response
+
+        response.each do |r|
+          SurveyResponse.parse(self, r) unless r.nil?
+        end
+      end
+
+      return true
+    end
+
+    def update_from_survey_details(response = {})
+      return nil if response.nil? || response.empty? || response['title'].nil?
+
+      self.update_attributes({date_created: DateTime.parse(response['date_created']),
+                              date_modified: DateTime.parse(response['date_modified']),
+                              title: response['title']['text'],
+                              language_id: response['language_id'].to_i,
+                              nickname: response['nickname'],
+                              title_enabled: response['title']['enabled'],
+                              title_text: response['title']['text']})
+    end
   end
 end

data/app/models/missinglink/survey_respondent_detail.rb

@@ -6,6 +6,8 @@ module Missinglink
     has_many :survey_responses
     has_many :survey_response_answers, through: :survey_responses
 
+    scope :completed, -> { where(status: "completed") }
+
     def self.parse(survey, hash)
       srd = SurveyRespondentDetail.first_or_create_by_survey_details(survey.id, hash['respondent_id'])
 

data/lib/missinglink/connection.rb

@@ -0,0 +1,39 @@
+require 'typhoeus'
+
+module Missinglink
+  module Connection
+    extend self
+
+    def request(request_type, body = { })
+      (puts "Please provide credentials before making a request." && return) unless credentials_provided?
+
+      JSON.parse(typh_request(request_type,
+                              @credential_hash[:api_key],
+                              @credential_hash[:token],
+                              body.to_json).tap {|x| x.run}.response.body)['data']
+    end
+
+    def credential_hash=(key_pair)
+      @credential_hash = { api_key: nil, token: nil }.merge(key_pair)
+    end
+
+    def credentials_provided?
+      !!(@credential_hash && @credential_hash[:api_key] && @credential_hash[:token])
+    end
+
+  private
+    def typh_request(fragment, api_key, token, body = '{ }')
+      # survey monkey's API limits are obnoxious, this is hacky but an easy way
+      # to ensure that we're always under the 2 QPS limit
+      sleep 0.5 unless ENV["RAILS_ENV"] == 'test'
+
+      Typhoeus::Request.new(
+        "https://api.surveymonkey.net/v2/surveys/#{fragment}",
+        method: :post,
+        params: { api_key: api_key },
+        body: body,
+        headers: { Authorization: "bearer #{token}", :"Content-Type" => "application/json" }
+      )
+    end
+  end
+end

data/lib/missinglink/version.rb

@@ -1,3 +1,3 @@
 module Missinglink
-  VERSION = "0.1.6"
+  VERSION = "0.2"
 end

data/lib/missinglink.rb

@@ -1,111 +1,33 @@
+require 'pry'
 require "missinglink/engine"
-require 'typhoeus'
+require "missinglink/connection"
 
 module Missinglink
+  include Connection
   extend self
 
-  def poll_surveys(credential_hash = { api_key: nil, token: nil })
-    unless (api_key = credential_hash[:api_key]) && (token = credential_hash[:token])
-      puts "Please provide a hash with api_key and token to poll surveys."
-      return
-    end
+  def poll_surveys
+    response = Connection.request('get_survey_list')
+    (puts "Error polling surveys" && return) unless response
 
-    response = JSON.parse(typh_request('get_survey_list', api_key, token).tap {|x| x.run}.response.body)['data']['surveys']
-    response.each do |s|
+    response['surveys'].each do |s|
       survey = Survey.first_or_create_by_sm_survey_id(s['survey_id'].to_i)
       survey.update_attributes(analysis_url: s['analysis_url'])
-      fetch_survey(survey, credential_hash)
-    end
-  end
-
-  def fetch_survey(survey, credential_hash)
-    unless (api_key = credential_hash[:api_key]) && (token = credential_hash[:token])
-      puts "Please provide a hash with api_key and token to fetch surveys."
-      return
-    end
-
-    request = typh_request('get_survey_details', api_key, token, {survey_id: survey.sm_survey_id.to_s}.to_json).tap { |x| x.run }
-    response = JSON.parse(request.response.body)['data']
-
-    survey.update_attributes({date_created: DateTime.parse(response['date_created']),
-                              date_modified: DateTime.parse(response['date_modified']),
-                              title: response['title']['text'],
-                              language_id: response['language_id'].to_i,
-                              nickname: response['nickname'],
-                              title_enabled: response['title']['enabled'],
-                              title_text: response['title']['text']})
-
-    response['pages'].each do |page|
-      SurveyPage.parse(survey, page)
-    end
-  end
-
-  def fetch_respondents(survey, credential_hash = { api_key: nil, token: nil })
-    unless (api_key = credential_hash[:api_key]) && (token = credential_hash[:token])
-      puts "Please provide a hash with api_key and token to fetch survey respondents."
-      return
+      survey.load_survey_details
     end
-
-    request = typh_request('get_respondent_list', api_key, token, {survey_id: survey.sm_survey_id.to_s}.to_json).tap { |x| x.run }
-    respondents = JSON.parse(request.response.body)['data']['respondents']
-    respondents.each do |respondent|
-      SurveyRespondentDetail.parse(survey, respondent)
-    end
-
-    fetch_responses(survey.reload, credential_hash)
   end
 
-  def fetch_responses(survey, credential_hash)
-    unless (api_key = credential_hash[:api_key]) && (token = credential_hash[:token])
-      puts "Please provide a hash with api_key and token to fetch survey responses."
-      return
-    end
-
-    # to start, we will only pull down completed surveys, and not re-pull these surveys
-    # if a respondent is complete and has no response, then we need to pull it down
-    # if a respodnent is complete and has a response, then we will not re-pull, it's done
-
-    respondents = SurveyRespondentDetail.where(survey_id: survey.id,
-                                               status: "completed")
+  def fetch_respondents(survey)
+    return if survey.load_respondents.nil?
 
-    respondents_to_pull = respondents.select { |r| r.survey_responses.empty? }
-
-    fetch_response_answers(survey, respondents_to_pull, credential_hash)
+    fetch_responses(survey.reload)
   end
 
-  def fetch_response_answers(survey, respondents, credential_hash)
-    unless (api_key = credential_hash[:api_key]) && (token = credential_hash[:token])
-      puts "Please provide a hash with api_key and token to fetch survey response answers."
-      return
-    end
-
-    while (respondents.size > 0)
-      ids = respondents.slice!(0, 100).map { |x| x.sm_respondent_id.to_s }
-      request = typh_request('get_responses', api_key, token,
-                                              { survey_id: survey.sm_survey_id.to_s,
-                                                respondent_ids: ids }.to_json).tap { |x| x.run }
-      response = JSON.parse(request.response.body)['data']
-
-      response.each do |r|
-        begin
-          SurveyResponse.parse(survey, r) unless r.nil?
-        rescue Exception => e
-          raise "Error processing Survey Response for survey #{ survey.inspect }\n\nResponse hash: #{ response.inspect }\n\nAttempting to parse: #{ r.inspect }\n\nException: #{ e.inspect }"
-        end
-      end
-    end
+  def fetch_responses(survey)
+    fetch_response_answers(survey, survey.respondents_to_update)
   end
 
-  private
-  def typh_request(fragment, api_key, token, body = '{ }')
-    sleep 0.5 # survey monkey's API limits are obnoxious, this is hacky but an easy way to ensure that we're always under
-             # the 2 QPS limit
-    Typhoeus::Request.new(
-      "https://api.surveymonkey.net/v2/surveys/#{fragment}",
-      method: :post,
-      params: { api_key: api_key },
-      body: body,
-      headers: { Authorization: "bearer #{token}", :"Content-Type" => "application/json" }
-    )
+  def fetch_response_answers(survey, respondents)
+    survey.load_response_details(respondents)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: missinglink
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: '0.2'
 platform: ruby
 authors:
 - Trey Springer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-12 00:00:00.000000000 Z
+date: 2014-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,7 @@ files:
 - config/routes.rb
 - db/migrate/20140308005724_add_missinglink_survey_schema.rb
 - lib/missinglink.rb
+- lib/missinglink/connection.rb
 - lib/missinglink/engine.rb
 - lib/missinglink/version.rb
 - lib/tasks/missinglink_tasks.rake