survey-gizmo-ruby 1.0.5 → 2.0.0

data/lib/survey_gizmo/rest_response.rb

@@ -0,0 +1,82 @@
+# This class normalizes the response returned by Survey Gizmo
+class RestResponse
+  attr_accessor :raw_response
+  attr_accessor :parsed_response
+
+  def initialize(rest_response)
+    @raw_response = rest_response
+    @parsed_response = rest_response.parsed_response
+    return unless data
+
+    # Handle really crappy [] notation in SG API, so far just in SurveyResponse
+    (data.is_a?(Array) ? data : [data]).each do |datum|
+      datum.keys.grep(/^\[/).each do |key|
+        next if datum[key].nil? || datum[key].length == 0
+
+        parent = find_attribute_parent(key)
+        datum[parent] ||= {}
+
+        case key.downcase
+        when /(url|variable.*standard)/
+          datum[parent][cleanup_attribute_name(key).to_sym] = datum[key]
+        when /variable.*shown/
+          datum[parent][cleanup_attribute_name(key).to_i] = datum[key].include?('1')
+        when /variable/
+          datum[parent][cleanup_attribute_name(key).to_i] = datum[key].to_i
+        when /question/
+          datum[parent][key] = datum[key]
+        end
+
+        datum.delete(key)
+      end
+    end
+  end
+
+  def ok?
+    if ENV['GIZMO_DEBUG']
+      ap 'SG Response: '
+      ap @parsed_response
+    end
+
+    if @parsed_response['result_ok'] && @parsed_response['result_ok'].to_s.downcase == 'false' && @parsed_response['message'] && @parsed_response['code'] && @parsed_response['message'] =~ /service/i
+      raise Exception, "#{@parsed_response['message']}: #{@parsed_response['code']}"
+    end
+    @parsed_response['result_ok'] && @parsed_response['result_ok'].to_s.downcase == 'true'
+  end
+
+  # The parsed JSON data of the response
+  def data
+    @_data ||= @parsed_response['data'] #|| {'id' => @parsed_response['id']}
+  end
+
+  # The error message if there is one
+  def message
+    @_message ||= @parsed_response['message']
+  end
+
+
+  private
+
+  def cleanup_attribute_name(attr)
+    attr.downcase.gsub(/[^[:alnum:]]+/, '_')
+                 .gsub(/(url|variable|standard|shown)/, '')
+                 .gsub(/_+/, '_')
+                 .gsub(/^_/, '')
+                 .gsub(/_$/, '')
+  end
+
+  def find_attribute_parent(attr)
+    case attr.downcase
+    when /url/
+      'url'
+    when /variable.*standard/
+      'meta'
+    when /variable.*shown/
+      'shown'
+    when /variable/
+      'variable'
+    when /question/
+      'answers'
+    end
+  end
+end

data/lib/survey_gizmo/survey_gizmo.rb

@@ -1,23 +1,24 @@
-require "active_support/core_ext/string"
-require "active_support/core_ext/module"
-require "active_support/core_ext/hash"
-require "active_support/core_ext/object/blank"
-require "active_support/concern"
-require "virtus"
-require "httparty"
-require "digest/md5"
-
-require "survey_gizmo/resource"
-require "survey_gizmo/collection"
-
-require "survey_gizmo/api/survey"
-require "survey_gizmo/api/survey_campaign"
-require "survey_gizmo/api/question"
-require "survey_gizmo/api/option"
-require "survey_gizmo/api/page"
-require "survey_gizmo/api/contact"
-require "survey_gizmo/api/response"
-require "survey_gizmo/api/email_message"
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/object/blank'
+require 'active_support/concern'
+require 'awesome_print'
+require 'virtus'
+require 'httparty'
+require 'digest/md5'
+
+require 'survey_gizmo/resource'
+require 'survey_gizmo/rest_response'
+
+require 'survey_gizmo/api/survey'
+require 'survey_gizmo/api/survey_campaign'
+require 'survey_gizmo/api/question'
+require 'survey_gizmo/api/option'
+require 'survey_gizmo/api/page'
+require 'survey_gizmo/api/contact'
+require 'survey_gizmo/api/response'
+require 'survey_gizmo/api/email_message'
 
 module SurveyGizmo
   include HTTParty
@@ -42,7 +43,11 @@ module SurveyGizmo
   #   The account password
   def self.setup(opts = {})
     self.options = opts
-    default_params({ "user:md5" => "#{opts[:user]}:#{Digest::MD5.hexdigest(opts[:password])}" })
+    default_params({ 'user:md5' => "#{opts[:user]}:#{Digest::MD5.hexdigest(opts[:password])}" })
   end
 
-end
+  def self.reset
+    @@options = {}
+    default_params({})
+  end
+end

data/spec/resource_spec.rb

@@ -1,56 +1,61 @@
-require "spec_helper"
-describe "Survey Gizmo Resource" do
+require 'spec_helper'
+describe 'Survey Gizmo Resource' do
 
   describe SurveyGizmo::Resource do
     before(:each) do
-      SurveyGizmo.setup(:user => 'test@test.com', :password => 'password')
+      SurveyGizmo.setup(user: 'test@test.com', password: 'password')
     end
 
-    let(:described_class) { SurveyGizmoSpec::ResourceTest }
-
-    let(:create_attributes){ {:title => 'Spec', :test_id => 5} }
-    let(:get_attributes)   { create_attributes.merge(:id => 1) }
-    let(:update_attributes){ {:title => 'Updated'} }
-    let(:first_params){ {:id => 1, :test_id => 5} }
+    let(:described_class)   { SurveyGizmoSpec::ResourceTest }
+    let(:create_attributes) { {title: 'Spec', test_id: 5} }
+    let(:update_attributes) { {title: 'Updated'} }
+    let(:first_params)      { {id: 1, test_id: 5} }
+    let(:get_attributes)    { create_attributes.merge(id: 1) }
     let(:uri_paths){
       {
-        :get => '/test/1',
-        :create => '/test/5/resource',
-        :update => '/test/5/resource/1',
-        :delete => '/test/5/resource/1'
+        get:    '/test/1',
+        create: '/test/5/resource',
+        update: '/test/5/resource/1',
+        delete: '/test/5/resource/1'
       }
     }
 
-    it "#new?" do
-      described_class.new.should be_new
-    end
-
-
     it '#reload' do
       stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
       obj = described_class.new(get_attributes.merge(update_attributes))
-      obj.attributes.reject{|k,v| v.blank? }.should == get_attributes.merge(update_attributes)
+      obj.attributes.reject {|k,v| v.blank? }.should == get_attributes.merge(update_attributes)
       obj.reload
-      obj.attributes.reject{|k,v| v.blank? }.should == get_attributes
+      obj.attributes.reject {|k,v| v.blank? }.should == get_attributes
     end
 
-    it '#valid?'
-
-    it "should raise an error if params are missing" do
+    it 'should raise an error if params are missing' do
       lambda {
-        SurveyGizmoSpec::ResourceTest.destroy(:test_id => 5)
-      }.should raise_error(SurveyGizmo::URLError, 'Missing parameters in request: `:id`')
+        SurveyGizmoSpec::ResourceTest.destroy(test_id: 5)
+      }.should raise_error(SurveyGizmo::URLError, 'Missing RESTful parameters in request: `:id`')
     end
 
     it_should_behave_like 'an API object'
     it_should_behave_like 'an object with errors'
+
+    context '#convert_filters_into_query_string' do
+      let(:page)    { 2 }
+      let(:filters) { {page: page, filters: [{field: 'istestdata', operator: '<>', value: 1}] }}
+
+      it 'should generate the correct page request' do
+        expect(SurveyGizmoSpec::ResourceTest.convert_filters_into_query_string(page: page)).to eq("?page=#{page}")
+      end
+
+      it 'should generate the correct filter fragment' do
+        expect(SurveyGizmoSpec::ResourceTest.convert_filters_into_query_string(filters)).to eq("?filter%5Bfield%5D%5B0%5D=istestdata&filter%5Boperator%5D%5B0%5D=%3C%3E&filter%5Bvalue%5D%5B0%5D=1&page=#{page}")
+      end
+    end
   end
 
   describe SurveyGizmo::API::Survey do
-    let(:create_attributes){ {:title => 'Spec', :type => 'survey', :status => 'In Design'} }
-    let(:get_attributes)   { create_attributes.merge(:id => 1234) }
-    let(:update_attributes){ {:title => 'Updated'} }
-    let(:first_params){ {:id => 1234} }
+    let(:create_attributes) { { title: 'Spec', type: 'survey', status: 'In Design' } }
+    let(:get_attributes)    { create_attributes.merge(first_params) }
+    let(:update_attributes) { { title: 'Updated'} }
+    let(:first_params)      { { id: 1234} }
     let(:uri_paths){
       h = { :create => '/survey' }
       h.default = '/survey/1234'
@@ -59,16 +64,20 @@ describe "Survey Gizmo Resource" do
 
     it_should_behave_like 'an API object'
     it_should_behave_like 'an object with errors'
+
+    it 'should parse the number of completed records correctly' do
+      survey = described_class.new('statistics' => [['Partial', 2], ['Disqualified', 28], ['Complete', 15]])
+      expect(survey.number_of_completed_responses).to eq(15)
+    end
   end
 
   describe SurveyGizmo::API::Question do
-    let(:create_attributes){ {:survey_id => 1234, :page_id => 1, :title => 'Spec Question', :type => 'radio', :properties => {"required" => true, "option_sort" => false} } }
-    let(:get_attributes)   {
-      create_attributes.merge(:id => 1)
-    }
-    let(:update_attributes){ {:survey_id => 1234, :page_id => 1, :title => 'Updated'} }
-    let(:first_params){ {:id => 1, :survey_id => 1234, :page_id => 1} }
-    let(:uri_paths){
+    let(:base_params)       { {survey_id: 1234, page_id: 1} }
+    let(:create_attributes) { base_params.merge(title: 'Spec Question', type: 'radio', properties: {'required' => true, 'option_sort' => false}) }
+    let(:update_attributes) { base_params.merge(title: 'Updated') }
+    let(:first_params)      { base_params.merge(id: 1) }
+    let(:get_attributes)    { create_attributes.merge(id: 1) }
+    let(:uri_paths) {
       { :get =>    '/survey/1234/surveyquestion/1',
         :create => '/survey/1234/surveypage/1/surveyquestion',
         :update => '/survey/1234/surveypage/1/surveyquestion/1',
@@ -79,25 +88,44 @@ describe "Survey Gizmo Resource" do
     it_should_behave_like 'an API object'
     it_should_behave_like 'an object with errors'
 
-    it "should handle the title hash returned from the API" do
-      @question = described_class.new('title' => {'English' => 'Some title'})
-      @question.title.should == 'Some title'
+    it 'should handle the title hash returned from the API' do
+      expect(described_class.new('title' => {'English' => 'Some title'}).title).to eq('Some title')
+    end
+
+    it 'should handle the _subtype key' do
+      described_class.new(:_subtype => 'radio').type.should == 'radio'
     end
 
-    it "should handle the _subtype key" do
-      @question = described_class.new(:_subtype => 'radio')
-      @question.type.should == 'radio'
+    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
+      let(:parent_id) { 33 }
+      let(:question_with_subquestions) { described_class.new(id: parent_id, survey_id: 1234, sub_question_skus: [1, 2])}
+      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
+      end
     end
   end
 
   describe SurveyGizmo::API::Option do
-    let(:create_attributes){ {:survey_id => 1234, :page_id => 1, :question_id => 1, :title => 'Spec Question', :value => 'Spec Answer'} }
-    let(:get_attributes)   {
-      create_attributes.merge(:id => 1)
-    }
-    let(:update_attributes){ {:survey_id => 1234, :page_id => 1, :question_id => 1, :title => 'Updated'} }
-    let(:first_params){ {:id => 1, :survey_id => 1234, :page_id => 1, :question_id => 1} }
-    let(:uri_paths){
+    let(:survey_and_page)   { {survey_id: 1234, page_id: 1} }
+    let(:create_attributes) { survey_and_page.merge(question_id: 1, title: 'Spec Question', value: 'Spec Answer') }
+    let(:update_attributes) { survey_and_page.merge(question_id: 1, title: 'Updated') }
+    let(:first_params)      { survey_and_page.merge(id: 1, question_id: 1) }
+    let(:get_attributes)    { create_attributes.merge(id: 1) }
+    let(:uri_paths) {
       h = { :create => '/survey/1234/surveypage/1/surveyquestion/1/surveyoption' }
       h.default = '/survey/1234/surveypage/1/surveyquestion/1/surveyoption/1'
       h
@@ -108,12 +136,10 @@ describe "Survey Gizmo Resource" do
   end
 
   describe SurveyGizmo::API::Page do
-    let(:create_attributes){ {:survey_id => 1234, :title => {'English' => 'Spec Page'}} }
-    let(:get_attributes)   {
-      create_attributes.merge(:id => 1)
-    }
-    let(:update_attributes){ {:survey_id => 1234, :title => 'Updated'} }
-    let(:first_params){ {:id => 1, :survey_id => 1234 } }
+    let(:create_attributes) { {:survey_id => 1234, :title => {'English' => 'Spec Page'}} }
+    let(:get_attributes)    { create_attributes.merge(:id => 1) }
+    let(:update_attributes) { {:survey_id => 1234, :title => 'Updated'} }
+    let(:first_params)      { {:id => 1, :survey_id => 1234 } }
     let(:uri_paths){
       h = { :create => '/survey/1234/surveypage' }
       h.default = '/survey/1234/surveypage/1'

data/spec/support/methods.rb

@@ -5,13 +5,16 @@ module SurveyGizmoSpec
     end
 
     def request_params(opts = {})
-      {"user:pass" => 'test@test.com:password'}.merge(opts)
+      {'user:pass' => 'test@test.com:password'}.merge(opts)
     end
 
     def json_response(result, data)
-      body = {:result_ok => result}
-      result ? body.merge!(:data => data) : body.merge!(:message => data)
-      {:headers => {'Content-Type' => 'application/json'}, :body => body.to_json}
+      body = {result_ok: result}
+      result ? body.merge!(data: data) : body.merge!(message: data)
+      {
+        headers: {'Content-Type' => 'application/json'},
+        body: body.to_json
+      }
     end
   end
 end

data/spec/support/spec_shared_api_object.rb

@@ -1,126 +1,81 @@
 shared_examples_for 'an API object' do
-  before(:each) do
-    SurveyGizmo.setup(:user => 'test@test.com', :password => 'password')
+  before(:all) do
+    SurveyGizmo.setup(user: 'test@test.com', password: 'password')
   end
-  
+
   it "should be descendant of SurveyGizmo::Resource" do
     SurveyGizmo::Resource.descendants.should include(described_class)
   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
       stub_api_call(:put)
       obj = described_class.create(create_attributes)
       obj.should be_instance_of(described_class)
     end
-    
+
     it "should set the attributes" do
       stub_request(:put, /#{@base}/).to_return(json_response(true, create_attributes))
       obj = described_class.create(create_attributes)
       obj.attributes.reject{|k,v| v.blank? }.should == create_attributes
     end
   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
       stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
       obj = described_class.first(first_params)
       obj.attributes.reject{|k,v| v.blank? }.should == get_attributes
     end
-  
+
     it "should return false if the request fails" do
       stub_request(:get, /#{@base}/).to_return(json_response(false, "something is wrong"))
       described_class.first(first_params).should == nil
     end
   end
-  
-  context "instance#update" do
-    before(:each) do
-      @obj = described_class.new(get_attributes)
-      @obj.__send__(:clean!)
-    end
-    
-    it "should make a request" do
-      stub_api_call(:post)
-      @obj.update
-      a_request(:post, /#{@base}#{uri_paths[:update]}/).should have_been_made
-    end
-    
-    it 'should change object state to saved' do
-      stub_api_call(:post)
-      @obj.update(update_attributes)
-      @obj.should be_saved
-    end
-    
-    it "should not be marked saved if the request fails" do
-      stub_api_call(:post, false)
-      @obj.update
-      @obj.should_not be_saved
-    end
-    
-    xit "cannot be updated if new" do
-      @obj.instance_variable_set('@_state', nil)
-      @obj.update(update_attributes).should be_false
-    end
-    
-  end
-  
+
   context "instance#destroy" do
     before(:each) do
       @obj = described_class.new(get_attributes)
-      @obj.__send__(:clean!)
     end
-    
+
     it "should make a request" do
       stub_api_call(:delete)
       @obj.destroy
       a_request(:delete, /#{@base}#{uri_paths[:delete]}/).should have_been_made
     end
-    
-    it 'should change object state to destroyed' do
-      stub_api_call(:delete)
-      @obj.destroy
-      @obj.should be_destroyed
-    end
-    
-    it "should not be marked destroyed if the request fails" do
-      stub_api_call(:delete, false)
-      @obj.destroy
-      @obj.should_not be_destroyed
-    end
-    
+
     it "cannot be destroyed if new" do
-      @obj.instance_variable_set('@_state', nil)
+      @obj.id = nil
       @obj.destroy.should be_false
     end
   end
-  
+
   context '#destroy', :focused => true do
     it "should make a request" do
       stub_api_call(:delete)
       described_class.destroy(first_params)
       a_request(:delete, /#{@base}#{uri_paths[:delete]}/).should have_been_made
     end
-    
+
     it "should return result" do
       stub_api_call(:delete)
       described_class.destroy(first_params).should be_true
     end
   end
-  
+
   context 'instance#save' do
     it "should call create on a new resource" do
       stub_api_call(:put)
@@ -128,16 +83,15 @@ shared_examples_for 'an API object' do
       obj.save
       a_request(:put, /#{@base}#{uri_paths[:create]}/).should have_been_made
     end
-    
+
     it "should call update on a created resource" do
       obj = described_class.new(get_attributes)
-      obj.__send__(:clean!)
       stub_api_call(:post)
       obj.save
       a_request(:post, /#{@base}#{uri_paths[:update]}/).should have_been_made
     end
   end
-  
+
   context '#all' do
     before(:all) do
       @array = [
@@ -146,30 +100,30 @@ shared_examples_for 'an API object' do
         {:id => 3, :title => 'resource 3'}
       ]
     end
-    
+
     it "should make a get request" do
       stub_request(:get, /#{@base}/).to_return(json_response(true, []))
       described_class.all(get_attributes)
       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(SurveyGizmo::Collection)
-    end  
-    
+      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