survey-gizmo-ruby 4.1.0 → 5.0.2

data/lib/survey_gizmo/version.rb

@@ -1,4 +1,3 @@
 module SurveyGizmo
-  # TODO: When bumping to 5.0, remove the deprecated parameters for Resource.all and Resource.first
-  VERSION = '4.1.0'
+  VERSION = '5.0.2'
 end

data/spec/configuration_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'survey_gizmo/configuration'
 
 describe SurveyGizmo::Configuration do
-
   before(:each) do
     SurveyGizmo.configure do |config|
       config.user = 'test@test.com'
@@ -14,18 +13,12 @@ describe SurveyGizmo::Configuration do
     SurveyGizmo.reset!
   end
 
-  it 'should allow basic authentication configuration' do
-    expect(SurveyGizmo.default_params).to eq({ 'user:md5' => 'test@test.com:5f4dcc3b5aa765d61d8327deb882cf99' })
-  end
-
   it 'should allow changing user and pass' do
     SurveyGizmo.configure do |config|
       config.user = 'slimthug'
       config.password = 'fourfourz'
-      config.api_version = 'v3'
     end
 
-    expect(SurveyGizmo.default_params).to eq({ 'user:md5'=>'slimthug:836fd7e2961a094c01cb7ba78bac6a06' })
-    expect(SurveyGizmo.base_uri).to eq('https://restapi.surveygizmo.com/v3')
+    expect(SurveyGizmo::Connection.send(:connection).params).to eq({ 'user:md5'=>'slimthug:836fd7e2961a094c01cb7ba78bac6a06' })
   end
 end

data/spec/resource_spec.rb

@@ -68,6 +68,14 @@ describe 'Survey Gizmo Resource' do
       survey = described_class.new('statistics' => [['Partial', 2], ['Disqualified', 28], ['Complete', 15]])
       expect(survey.number_of_completed_responses).to eq(15)
     end
+
+    it 'should determine if there are new results' do
+      stub_request(:get, /#{@base}\/survey\/1\/surveyresponse/).to_return(json_response(true, []))
+
+      survey = described_class.new(id: 1)
+      expect(survey.server_has_new_results_since?(Time.now)).to be_false
+      a_request(:get, /#{@base}\/survey\/1\/surveyresponse/).should have_been_made
+    end
   end
 
   describe SurveyGizmo::API::Question do
@@ -95,19 +103,65 @@ describe 'Survey Gizmo Resource' do
       described_class.new(:_subtype => 'radio').type.should == 'radio'
     end
 
-    it 'should have no subquestions' do
-      expect(described_class.new.sub_questions).to eq([])
-    end
-
     it 'should find the survey' do
       stub_request(:get, /#{@base}\/survey\/1234/).to_return(json_response(true, get_attributes))
       described_class.new(base_params).survey
       a_request(:get, /#{@base}\/survey\/1234/).should have_been_made
     end
 
-    context 'with subquestions' do
+    context 'options' do
+      let(:survey_id) { 15 }
+      let(:question_id) { 23 }
+      let(:body_data) do
+        {
+          "id" => question_id,
+          "title" => {"English"=>"How likely are you to bang your head to Bohemian Rhapsody?"},
+          "options"=>
+             [
+               {
+                 "id" => 10014,
+                 "title" => {"English"=>"0 = Not at all likely"},
+                 "value" => "0 = Not at all likely"
+               },
+               {
+                 "id" => 10015,
+                 "title" => {"English"=>"1"},
+                 "value" => "1"
+               }
+             ]
+        }
+      end
+
+      context 'option parsing' do
+        before do
+          stub_request(:get, /#{@base}\/survey\/#{survey_id}\/surveyquestion\/#{question_id}/).to_return(json_response(true, body_data))
+        end
+
+        it 'correctly parses options out of question data' do
+          question = described_class.first(survey_id: survey_id, id: question_id)
+          expect(question.options.all? { |o| o.question_id == question_id && o.survey_id == survey_id }).to be_true
+          expect(question.options.map { |o| o.id }).to eq([10014, 10015])
+          a_request(:get, /#{@base}\/.*surveyoption/).should_not have_been_made
+        end
+
+        it 'correctly parses sub question options' do
+          question = described_class.new(survey_id: survey_id, id: question_id + 1, parent_question_id: question_id)
+          expect(question.parent_question.id).to eq(described_class.new(body_data).id)
+          expect(question.options.all? { |o| o.question_id == question.id && o.survey_id == survey_id }).to be_true
+          expect(question.options.map { |o| o.id }).to eq([10014, 10015])
+          a_request(:get, /#{@base}\/survey\/#{survey_id}\/surveyquestion\/#{question_id}/).should have_been_made
+        end
+      end
+    end
+
+    context 'subquestions' do
       let(:parent_id) { 33 }
-      let(:question_with_subquestions) { described_class.new(id: parent_id, survey_id: 1234, sub_question_skus: [1, 2]) }
+      let(:skus) { [544, 322] }
+      let(:question_with_subquestions) { described_class.new(id: parent_id, survey_id: 1234, sub_question_skus: skus) }
+
+      it 'should have no subquestions' do
+        expect(described_class.new.sub_questions).to eq([])
+      end
 
       it 'should have 2 subquestions and they should have the right parent question' do
         stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
@@ -115,6 +169,21 @@ describe 'Survey Gizmo Resource' do
 
         question_with_subquestions.sub_questions.first.parent_question
         a_request(:get, /#{@base}\/survey\/1234\/surveyquestion\/#{parent_id}/).should have_been_made
+        skus.each { |sku| a_request(:get, /#{@base}\/survey\/1234\/surveyquestion\/#{sku}/).should have_been_made }
+      end
+
+      context 'and shortname' do
+        let(:sku) { 6 }
+        let(:question_with_subquestions) { described_class.new(id: parent_id, survey_id: 1234, sub_question_skus: [["0", sku], ["foo", 8]]) }
+
+        it 'should have 2 subquestions and they should have the right parent question' do
+          stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
+          expect(question_with_subquestions.sub_questions.size).to eq(2)
+
+          question_with_subquestions.sub_questions.first.parent_question
+          a_request(:get, /#{@base}\/survey\/1234\/surveyquestion\/#{parent_id}/).should have_been_made
+          a_request(:get, /#{@base}\/survey\/1234\/surveyquestion\/#{sku}/).should have_been_made
+        end
       end
     end
   end
@@ -165,6 +234,45 @@ describe 'Survey Gizmo Resource' do
 
     it_should_behave_like 'an API object'
     it_should_behave_like 'an object with errors'
+
+    context 'answers' do
+      let(:survey_id) { 6 }
+      let(:response_id) { 7 }
+      let(:timestamp) { '2015-01-02'.to_time(:utc) }
+      let(:answers) do
+        {
+          "[question(3), option(\"10021-other\")]" => "Some other text field answer",
+          "[question(3), option(10021)]" => "Other (required)",
+          "[question(5)]" => "VERY important",
+          "[question(6)]" => nil,
+          "[question(7), option(10001)]" => nil,
+          "[question(8)]" => false,
+          "[question(9), option(10002)]" => '16',
+          "[question(10), question_pipe(\"Que aplicación\")]" => "5 = Extremely important",
+          "[question(11), option(10001)]" => ""
+        }
+      end
+
+      it 'should propagate time, survey_id, and response_id' do
+        response = described_class.new(
+          answers: answers.select { |k,v| k == "[question(5)]"},
+          survey_id: survey_id,
+          id: response_id,
+          submitted_at: timestamp
+        )
+        expect(response.parsed_answers.map { |a| a.to_hash }).to eq([ { survey_id: survey_id, response_id: response_id, question_id: 5, answer_text: "VERY important", submitted_at: timestamp }])
+      end
+
+      it 'should parse the answers and remove extraneous answers' do
+        expect(described_class.new(answers: answers, survey_id: 1).parsed_answers.map { |a| a.to_hash }).to eq([
+          { survey_id: 1, question_id: 3, option_id: 10021, other_text: "Some other text field answer" },
+          { survey_id: 1, question_id: 5, answer_text: "VERY important" },
+          { survey_id: 1, question_id: 8, answer_text: 'false' },
+          { survey_id: 1, question_id: 9, option_id: 10002 },
+          { survey_id: 1, question_id: 10, question_pipe: "Que aplicación", answer_text: "5 = Extremely important" }
+        ])
+      end
+    end
   end
 
   describe SurveyGizmo::API::AccountTeams do

data/spec/spec_helper.rb

@@ -11,10 +11,16 @@ RSpec.configure do |config|
   config.include SurveyGizmoSpec::Methods
 
   config.before(:each) do
-    @base = 'https://restapi.surveygizmo.com/v4'
     SurveyGizmo.configure do |config|
       config.user = 'test@test.com'
       config.password = 'password'
+      config.logger.level = Logger::WARN
     end
+
+    Pester.configure do |config|
+      config.environments[:survey_gizmo_ruby][:logger] = ::Logger.new(nil)
+    end
+
+    @base = "#{SurveyGizmo.configuration.api_url}/#{SurveyGizmo.configuration.api_version}"
   end
 end

data/spec/support/spec_shared_api_object.rb

@@ -4,16 +4,12 @@ shared_examples_for 'an API object' do
   end
 
   context "#create" do
-    it "should make a request" do
-      stub_api_call(:put)
-      described_class.create(create_attributes)
-      a_request(:put, /#{@base}#{uri_paths[:create]}/).should have_been_made
-    end
-
-    it "should return a new instance" do
+    it "should make a request and create a new instance" do
       stub_api_call(:put)
       obj = described_class.create(create_attributes)
+
       obj.should be_instance_of(described_class)
+      a_request(:put, /#{@base}#{uri_paths[:create]}/).should have_been_made
     end
 
     it "should set the attributes" do
@@ -25,15 +21,10 @@ shared_examples_for 'an API object' do
   end
 
   context "#get" do
-    it "should make a request" do
-      stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
-      described_class.first(first_params)
-      a_request(:get, /#{@base}#{uri_paths[:get]}/).should have_been_made
-    end
-
-    it "should set the attributes" do
+    it "should make a request and set the attributes" do
       stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
       obj = described_class.first(first_params)
+      a_request(:get, /#{@base}#{uri_paths[:get]}/).should have_been_made
       obj.attributes.reject{|k,v| v.blank? }.should == (get_attributes_to_compare || get_attributes)
     end
 
@@ -90,8 +81,8 @@ shared_examples_for 'an API object' do
   end
 
   context '#all' do
-    before(:all) do
-      @array = [
+    let(:data) do
+      [
         {:id => 1, :title => 'resource 1'},
         {:id => 2, :title => 'resource 2'},
         {:id => 3, :title => 'resource 3'}
@@ -99,28 +90,13 @@ shared_examples_for 'an API object' do
     end
 
     it "should make a get request" do
-      stub_request(:get, /#{@base}/).to_return(json_response(true, []))
-      described_class.all(get_attributes)
+      stub_request(:get, /#{@base}/).to_return(json_response(true, data))
+      iterator = described_class.all(get_attributes.merge(page: 1))
+      iterator.should be_instance_of(Enumerator)
+      collection = iterator.to_a
       a_request(:get, /#{@base}#{uri_paths[:create]}/).should have_been_made
-    end
-
-    it "should create a collection using the class" do
-      stub_request(:get, /#{@base}/).to_return(json_response(true, @array))
-      collection = described_class.all(get_attributes)
-      collection.should be_instance_of(Array)
-    end
-
-    it "should return instances of the class" do
-      stub_request(:get, /#{@base}/).to_return(json_response(true, @array))
-      collection = described_class.all(get_attributes)
       collection.first.should be_instance_of(described_class)
-    end
-
-    it "should include all elements" do
-      stub_request(:get, /#{@base}/).to_return(json_response(true, @array))
-      collection = described_class.all(get_attributes)
       collection.length.should == 3
     end
   end
-
 end

data/spec/support/spec_shared_object_with_errors.rb

@@ -6,7 +6,7 @@ shared_examples_for 'an object with errors' do
   context 'class methods' do
     it 'should raise errors' do
       expect { described_class.first(get_attributes) }.to raise_error
-      expect { described_class.all(get_attributes) }.to raise_error
+      expect { described_class.all(get_attributes.merge(page: 1)).to_a }.to raise_error
     end
   end
 end

data/spec/support/test_resource_classes.rb

@@ -7,13 +7,12 @@ module SurveyGizmoSpec
     attribute :test_id, Integer
 
     # routes
-    route '/test/:id', :via => :get
-    route '/test/:test_id/resource', :via => :create
-    route '/test/:test_id/resource/:id', :via => [:update, :delete]
-
-    def to_param_options
-      {id: self.id, test_id: self.test_id}
-    end
+    @route = {
+      get: '/test/:id',
+      create: '/test/:test_id/resource',
+      update: '/test/:test_id/resource/:id',
+      delete: '/test/:test_id/resource/:id'
+    }
   end
 
   class GenericResource

data/survey-gizmo-ruby.gemspec

@@ -16,10 +16,12 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9'
 
   gem.add_dependency 'activesupport', '>= 3.0'
-  gem.add_dependency 'addressable'
-  gem.add_dependency 'awesome_print'
-  gem.add_dependency 'httparty'
+  gem.add_dependency 'addressable', '~> 2'
+  gem.add_dependency 'awesome_print', '~> 1'
+  gem.add_dependency 'faraday', '~> 0.9'
+  gem.add_dependency 'faraday_middleware'
   gem.add_dependency 'i18n'
+  gem.add_dependency 'pester', '>= 1.0.0'
   gem.add_dependency 'virtus', '>= 1.0.0'
 
   gem.add_development_dependency 'rspec', '~> 2.11.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.2
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,18 +31,46 @@ dependencies:
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -56,7 +84,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,19 +98,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: pester
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +197,8 @@ files:
 - Rakefile
 - lib/survey-gizmo-ruby.rb
 - lib/survey_gizmo/api/account_teams.rb
+- lib/survey_gizmo/api/answer.rb
+- lib/survey_gizmo/api/campaign.rb
 - lib/survey_gizmo/api/contact.rb
 - lib/survey_gizmo/api/email_message.rb
 - lib/survey_gizmo/api/option.rb
@@ -176,12 +206,12 @@ files:
 - lib/survey_gizmo/api/question.rb
 - lib/survey_gizmo/api/response.rb
 - lib/survey_gizmo/api/survey.rb
-- lib/survey_gizmo/api/survey_campaign.rb
 - lib/survey_gizmo/configuration.rb
+- lib/survey_gizmo/connection.rb
+- lib/survey_gizmo/faraday_middleware/parse_survey_gizmo.rb
+- lib/survey_gizmo/faraday_middleware/pester_survey_gizmo.rb
 - lib/survey_gizmo/multilingual_title.rb
 - lib/survey_gizmo/resource.rb
-- lib/survey_gizmo/rest_response.rb
-- lib/survey_gizmo/survey_gizmo.rb
 - lib/survey_gizmo/version.rb
 - spec/configuration_spec.rb
 - spec/resource_spec.rb
@@ -190,7 +220,6 @@ files:
 - spec/support/spec_shared_api_object.rb
 - spec/support/spec_shared_object_with_errors.rb
 - spec/support/test_resource_classes.rb
-- spec/survey-gizmo-ruby_spec.rb
 - spec/test_json/page.json
 - spec/test_json/question.json
 - spec/test_json/survey.json
@@ -215,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gem to use the SurveyGizmo.com REST API, v3+
@@ -227,7 +256,6 @@ test_files:
 - spec/support/spec_shared_api_object.rb
 - spec/support/spec_shared_object_with_errors.rb
 - spec/support/test_resource_classes.rb
-- spec/survey-gizmo-ruby_spec.rb
 - spec/test_json/page.json
 - spec/test_json/question.json
 - spec/test_json/survey.json