isurvey 0.0.7 → 0.0.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2RjMjU3NGRlZjVjODgyMjMwYWE2OTA3NTg4MGU4Yzg2Y2I2ZTRhMg==
+    MjE2NmJkYjlhNWMzMjg5ZmU0MGNmODkzNmM5ODYxOTUwOWJlNDEzMQ==
   data.tar.gz: !binary |-
-    MmJmNWI0ZThjMjNjZjkzOTZlZmYzN2Q2NWUxN2EyZjRmZDc0Njg4OA==
+    MjlhMjVkOTFlMTU3M2ZkNDAzZjNiMWY1Y2RiY2M5ODMwMWU0MTYzNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZWU4MGMzMGQ1MzY0NTY3NDJlOTg3NTg3ZWMwYWIyNGFjNDU2NWYxNjVhN2Mx
-    ZmUxY2FhOGYwZGU5NWQ2MTViOTNiYWMwMmE5YTc3YTgzMjJmNzkwYzA0ZDM2
-    MzczZDQwNmZiZTczM2RjMjVhMTIxNDMxNGY4MDU4NmU0NmNmODg=
+    ZTYyNDczMWI0N2EwNzhiNzg3ZjcwOTNlNmRlZTdjOGFiN2U5NGYwZTJlN2I2
+    MGU5M2VjMGY1ZjJhMzAyYjExN2NiNTc5NTlmYzBlMjFjNGE1MjBmYzQ3NGQw
+    MTFhMTE4YWMwNWFiNzE2MTRkNTY1MGI3ZWIwOGRjY2Y0NDlkZjc=
   data.tar.gz: !binary |-
-    NTEwNWJkYjllZTEzNDU5MTRjYzZkNDY5YzNjZDA3YzQ1ZWNjZjE1NDAzNDdk
-    NWJiMTY2MTI3ZWYyYWNlYmQwMGFmMWM2MzVlYTFjY2M3MGMyNDFmN2UwZjUz
-    MTQzMGY2MzBkOWVmZWYzZmU5OTg5N2JlNjhjYmQxZDEyYmY1ODY=
+    YmNjYTU3OTBjYzZmYTVkZGQwZDZjNTI3ZTAxZjBmOTQ2MzU5ZGRlZTc2ZDc0
+    YTJmZTI1MzNiYWFkZGM3Mjk2YTUxZTUyYzk0NTljNTExMzY2YzEwYjAyY2M2
+    OThlY2ZlYTU3NDRjYmQ4ZWEyM2YwOWUzNTJhMGFjYTEzMTI2ZjM=

data/README.md

@@ -1,6 +1,6 @@
 # Isurvey
 
-TODO: Write a gem description
+Gem for interacting with iSurvey's SOAP api.
 
 ## Installation
 
@@ -16,9 +16,58 @@ Or install it yourself as:
 
     $ gem install isurvey
 
+You must set up your company identifier and survey password.  Perhaps in config/initiaizers/isurvey.rb if you are using Rails.
+
+    Isurvey::Credentials.company_identifier = [cp]
+    Isurvey::Credentials.survey_password = [sp]
+
 ## Usage
 
-TODO: Write usage instructions here
+There are questions and answers.  Questions are available through Isurvey::Question and answers are available through Isurvey::Answer.
+
+To get a list of all questions:
+
+    Isurvey::Question.all
+
+To get a list of all answers:
+
+    Isurvey::Answer.all
+
+All of the properties available through the iSurvye API are also available through the gem.  You obtain a property value by calling for it on the appropriate class; for example, Isurvey::Answer.all.first.screen_id would give you the screen_id of the first Answer. 
+
+For questions, the available properties are:
+    
+    :screen_id, :question_number, :screen_id_next, :show_labels, :selectable_images, :screen_text, :screen_instructions, :theme_class_id, :screen_options, :answers, :questions
+
+For answers, the available properties are:
+    
+    :screen_id, :question_id, :answer_id, :result_answer, :response_date
+
+You can also get direct access to the API.  I do not recommend relying on any of these methods since they are being phased out.
+
+Get a list of the questions:
+
+    Isurvey::API.questions
+
+Get a list of the result ids:
+
+    Isurvey::API.result_ids
+
+Get a list of the questions by screen id:
+
+    Isurvey::API.question_by_screen_id(screen_id)
+
+Get a list of the answers by screen id:
+
+    Isurvey::API.answers_by_screen_id(screen_id)
+
+Get a list of the answers by result id:
+
+    Isurvey::API.answers_by_result_id(result)
+
+Get a list of the answers by result id and screen id:
+
+    Isurvey::API.answer_by_screen_and_result_id(result_id: id, screen_id: id)
 
 ## Contributing
 

data/isurvey.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "savon", "~> 2.0"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "rake"
 
 end

data/lib/isurvey/answer.rb

@@ -0,0 +1,6 @@
+module Isurvey
+  class Answer
+    include Base 
+    extend Collector
+  end
+end

data/lib/isurvey/api.rb

@@ -0,0 +1,66 @@
+module Isurvey
+  class API
+    def self.questions
+      unless @questions 
+        @questions = []
+        self.screens.each do |question|
+          @questions << Question.new(hash: question)
+        end
+      end
+      @questions
+    end
+
+    def self.result_ids
+      unless @result_ids
+        @result_ids = []
+        survey_results.each do |result|
+          @result_ids << result[:result_id] 
+        end
+      end
+      @result_ids
+    end
+
+
+    def self.question_by_screen_id(id)
+      self.screens.each do |question|
+        if question[:screen_id] == id
+          return question[:screen_text]
+        end
+      end
+    end
+
+    def self.answer_by_screen_and_result_id(options)
+      answers_by_result_id(options[:result_id]) & answers_by_screen_id(options[:screen_id])
+    end
+
+    def self.answers_by_result_id(id)
+      survey_results.each do |result|
+        if result[:result_id] == id
+          return result[:screen_results][:result]
+        end
+      end
+    end
+
+    def self.answers_by_screen_id(id)
+      @answers = []
+      survey_results.each do |result|
+        result[:screen_results][:result].each do |question|
+          @answers << question if question[:screen_id] == id
+        end
+      end
+      @answers
+
+    private
+    def self.survey
+      SOAPClient.export_survey.body[:export_survey_response][:export_survey_result]
+    end
+
+    def self.survey_results
+      SOAPClient.export_survey_results.body[:export_survey_results_response][:export_survey_results_result][:survey_result]
+    end
+
+    def self.screens
+      survey[:screens][:screen]
+    end
+  end
+end

data/lib/isurvey/base.rb

@@ -0,0 +1,17 @@
+module Isurvey
+  module Base
+    attr_reader :hash
+
+    def initialize(options)
+      @hash = options[:hash]
+    end
+
+    def method_missing(method, *args, &block)
+      if hash.has_key? method
+        @hash[method]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/isurvey/collector.rb

@@ -0,0 +1,7 @@
+module Isurvey
+  module Collector
+    def all
+      ObjectSpace.each_object(self).entries
+    end
+  end
+end

data/lib/isurvey/question.rb

@@ -0,0 +1,6 @@
+module Isurvey
+  class Question
+    include Base
+    extend Collector
+  end
+end

data/lib/isurvey/soap_client.rb

@@ -0,0 +1,28 @@
+module Isurvey
+  class SOAPClient 
+    def self.savon_client
+      @savon_client ||= Savon.client(
+        wsdl: "https://isurveysoft.com/servicesv3/exportservice.asmx?WSDL"
+      )
+    end
+
+    def self.savon_call(operation)
+      self.savon_client.call(
+        operation,
+        message:
+        {
+          cp: Credentials.company_identifier,
+          sp: Credentials.survey_password
+        }
+      )
+    end
+
+    def self.export_survey 
+      @export_survey ||= self.savon_call(:export_survey) 
+    end
+
+    def self.export_survey_results
+      @export_survey_results ||= self.savon_call(:export_survey_results) 
+    end
+  end
+end

data/lib/isurvey/version.rb

@@ -1,3 +1,3 @@
 module Isurvey
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/isurvey.rb

@@ -1,101 +1,16 @@
-require "isurvey/version"
-require "savon"
+require 'isurvey/version'
+require 'savon'
+require 'isurvey/base'
+require 'isurvey/collector'
+require 'isurvey/soap_client'
+require 'isurvey/api'
+require 'isurvey/question'
+require 'isurvey/answer'
 
 module Isurvey
-  class SOAPClient 
+  class Credentials 
     class << self
       attr_accessor :company_identifier, :survey_password
     end
-
-    def self.savon_client
-      @savon_client ||= Savon.client(
-        wsdl: "https://isurveysoft.com/servicesv3/exportservice.asmx?WSDL"
-      )
-    end
-
-    def self.savon_call(operation)
-      self.savon_client.call(
-        operation,
-        message:
-        {
-          cp: company_identifier,
-          sp: survey_password
-        }
-      )
-    end
-
-    def self.export_survey 
-      @export_survey ||= self.savon_call(:export_survey) 
-    end
-
-    def self.export_survey_results
-      @export_survey_results ||= self.savon_call(:export_survey_results) 
-    end
-  end
-
-  class API
-    def self.questions
-      unless @questions 
-        @questions = []
-        self.screens.each do |question|
-          @questions << question
-        end
-      end
-      @questions
-    end
-
-    def self.result_ids
-      unless @result_ids
-        @result_ids = []
-        survey_results.each do |result|
-          @result_ids << result[:result_id] 
-        end
-      end
-      @result_ids
-    end
-
-
-    def self.question_by_screen_id(id)
-      self.screens.each do |question|
-        if question[:screen_id] == id
-          return question[:screen_text]
-        end
-      end
-    end
-
-    def self.answer_by_screen_and_result_id(options)
-      answers_by_result_id(options[:result_id]) & answers_by_screen_id(options[:screen_id])
-    end
-
-    def self.answers_by_result_id(id)
-      survey_results.each do |result|
-        if result[:result_id] == id
-          return result[:screen_results][:result]
-        end
-      end
-    end
-
-    def self.answers_by_screen_id(id)
-      @answers = []
-      survey_results.each do |result|
-        result[:screen_results][:result].each do |question|
-          @answers << question if question[:screen_id] == id
-        end
-      end
-      @answers
-    end
-
-    private
-    def self.survey
-      SOAPClient.export_survey.body[:export_survey_response][:export_survey_result]
-    end
-
-    def self.survey_results
-      SOAPClient.export_survey_results.body[:export_survey_results_response][:export_survey_results_result][:survey_result]
-    end
-
-    def self.screens
-      survey[:screens][:screen]
-    end
   end
 end

data/spec/answer_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Isurvey::Answer do
+  
+  before :all do
+    @answer1 = Isurvey::Answer.new(hash: {:screen_id=>"431583", :question_id=>nil, :answer_id=>nil, :result_answer=>"9", :response_date=>"2013-06-14 19:34:58"})
+    @answer2 = Isurvey::Answer.new(hash: {:screen_id=>"431583", :question_id=>nil, :answer_id=>nil, :result_answer=>"9", :response_date=>"2013-06-14 19:34:58"})
+  end
+
+  it "should return the correct screen_id" do
+    @answer1.screen_id.should == '431583'
+  end
+
+  it "should return the correct result_answer" do
+    @answer1.result_answer.should == '9'
+  end
+
+  it "should return all questions for all" do
+    Isurvey::Answer.all.length.should == 2
+  end
+end

data/spec/question_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Isurvey::Question do
+  
+  before :all do
+    @question1 = Isurvey::Question.new(hash: {:screen_id=>"431424", :question_number=>"0", :screen_id_next=>"431426", :show_labels=>true, :selectable_images=>false, :screen_text=>"This is the Week in the Life Daily Survey. ", :screen_instruction=>nil, :theme_class_id=>"59786", :screen_options=>{:screen_option=>[{:screen_option_ref_code=>"DisplayImageAboveText", :screen_option_value_text=>"False"}, {:screen_option_ref_code=>"SelectableImages", :screen_option_value_text=>false}, {:screen_option_ref_code=>"ShowLabels", :screen_option_value_text=>true}]}, :answers=>nil, :questions=>nil, :@type=>"information", :@next_screen_is_linked=>"false"})
+    @question2 = Isurvey::Question.new(hash: {:screen_id=>"431424", :question_number=>"0", :screen_id_next=>"431426", :show_labels=>true, :selectable_images=>false, :screen_text=>"This is the Week in the Life Daily Survey. ", :screen_instruction=>nil, :theme_class_id=>"59786", :screen_options=>{:screen_option=>[{:screen_option_ref_code=>"DisplayImageAboveText", :screen_option_value_text=>"False"}, {:screen_option_ref_code=>"SelectableImages", :screen_option_value_text=>false}, {:screen_option_ref_code=>"ShowLabels", :screen_option_value_text=>true}]}, :answers=>nil, :questions=>nil, :@type=>"information", :@next_screen_is_linked=>"false"})
+  end
+
+  it "should return the correct screen_id" do
+    @question1.screen_id.should == '431424'
+  end
+
+  it "should return the correct screen_text" do
+    @question1.screen_text.should == 'This is the Week in the Life Daily Survey. '
+  end
+
+  it "should return all questions for all" do
+    Isurvey::Question.all.length.should == 2
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative '../lib/isurvey/base.rb'
+require_relative '../lib/isurvey/collector.rb'
+require_relative '../lib/isurvey/question.rb'
+require_relative '../lib/isurvey/answer.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isurvey
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Michael Nipper
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,16 @@ files:
 - Rakefile
 - isurvey.gemspec
 - lib/isurvey.rb
+- lib/isurvey/answer.rb
+- lib/isurvey/api.rb
+- lib/isurvey/base.rb
+- lib/isurvey/collector.rb
+- lib/isurvey/question.rb
+- lib/isurvey/soap_client.rb
 - lib/isurvey/version.rb
+- spec/answer_spec.rb
+- spec/question_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/mnipper/isurvey
 licenses:
 - MIT
@@ -105,4 +128,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Communicate with the iSurvey SOAP api.
-test_files: []
+test_files:
+- spec/answer_spec.rb
+- spec/question_spec.rb
+- spec/spec_helper.rb