limesurvey_rails 1.1.0

data/spec/factories/limesurvey_rails_surveys.rb

@@ -0,0 +1,8 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+FactoryGirl.define do
+  factory :limesurvey_rails_survey, :class => 'Survey' do
+    title "MyString"
+    lang "MyString"
+  end
+end

data/spec/limesurvey_rails_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe LimesurveyRails, :main => true do
+  after(:each) do
+    LimesurveyRails.reset
+  end
+
+  context "when it's not fully configured" do
+    before(:each) { LimesurveyRails.reset }
+    its(:configured?) { is_expected.to be false }
+    its(:connected?) { is_expected.to be false }
+  end
+
+  context "when it's configured with a wrong password" do
+    before(:each) do
+      LimesurveyRails.configure do |config|
+        config.api_url = LIMESURVEY_API_URL
+        config.username = LIMESURVEY_USERNAME
+        config.password = 'wrong_password'
+      end
+    end
+    describe ".connect" do
+      it "return false" do
+        expect(LimesurveyRails.connect).to be false
+      end
+    end
+  end
+
+  context "when it's fully configured" do
+    before(:each) do
+      LimesurveyRails.configure do |config|
+        config.api_url = LIMESURVEY_API_URL
+        config.username = LIMESURVEY_USERNAME
+        config.password = LIMESURVEY_PASSWORD
+      end
+    end
+    its(:configured?) {is_expected.to be true }
+    describe 'LimesurveyRails.configuration' do
+      subject { LimesurveyRails.configuration }
+      its(:username) {should eq('rails_user_test') }
+      its(:password) {should eq('limoncello') }
+      its(:base_url) {should eq(LIMESURVEY_BASE_URL) }
+    end
+    its(:connected?) { is_expected.to be false }
+    describe ".connect" do
+      it "return true" do
+        expect(LimesurveyRails.connect).to be true
+      end
+    end
+    describe ".disconnect" do
+      it "return true" do
+        expect(LimesurveyRails.disconnect).to be false
+      end
+    end
+    context "when it's connected" do
+      before(:each) do
+        LimesurveyRails.connect
+      end
+      describe ".connect" do
+        it "return false" do
+          expect(LimesurveyRails.connect).to be false
+        end
+      end
+      describe ".connect(true)" do
+        it "return true" do
+          expect(LimesurveyRails.connect(true)).to be true
+        end
+      end
+      its(:connected?) { is_expected.to be true }
+      describe ".disconnect" do
+        it "return true" do
+          expect(LimesurveyRails.disconnect).to be true
+        end
+      end
+      describe ".list_surveys" do
+        it "return an array" do
+          expect(LimesurveyRails.list_surveys).to be_an_instance_of Array
+        end
+      end
+      describe ".wrong_name_method" do
+        specify { expect { LimesurveyRails.wrong_name_method }.to raise_error }
+      end
+    end
+    context "when it's configurated with continuous connection" do
+      before(:each) do
+        LimesurveyRails.configure do |config|
+          config.auto_connection = true
+        end
+      end
+      its(:connected?) { is_expected.to be true }
+    end
+  end
+
+
+
+
+end

data/spec/models/limesurvey_rails/participant_spec.rb

@@ -0,0 +1,174 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module LimesurveyRails
+  describe TestModel, :participant  do
+
+    before(:all) do
+      configure_and_connect
+      remove_all_test_surveys
+      reset_models
+      @test_survey_id = get_brand_new_test_survey_id(:activate_tokens => true)
+    end 
+    after(:all) { remove_all_test_surveys }
+
+    subject { TestModel }
+
+    let(:a_participant) { FactoryGirl.create(:test_model) }
+    let(:test_survey) { Survey.find(@test_survey_id) }
+
+    context "when not initialized for being a participant" do
+      before(:each) { reset_models }
+      its(:is_a_limesurvey_participant_class?) { is_expected.to be false }
+    end
+    
+    describe ".is_a_limesurvey_participant" do
+      before(:each) { reset_models }
+      context "with no options" do
+        before(:each) do
+          TestModel.is_a_limesurvey_participant
+        end
+        it "has many survey_participations" do
+          expect(subject.reflect_on_association(:survey_participations).macro).to be :has_many
+        end
+        its(:is_a_limesurvey_participant_class?) { is_expected.to be true }
+        its(:limesurvey_participant_attribute_1_attr) { is_expected.to eq 'id' }
+        its(:limesurvey_participant_email_attr) { is_expected.to be_nil }
+        its(:limesurvey_participant_firstname_attr) { is_expected.to be_nil }
+        its(:limesurvey_participant_lastname_attr) { is_expected.to be_nil }
+      end
+      context "with options :attribute_1_attr => 'other_id' " do
+        before(:each) do
+          TestModel.is_a_limesurvey_participant(:attribute_1_attr => 'other_id')
+        end
+        its(:is_a_limesurvey_participant_class?) { is_expected.to be true }
+        its(:limesurvey_participant_attribute_1_attr) { is_expected.to eq 'other_id' }
+      end
+      context "with options :email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname'  " do
+        before(:each) do
+          TestModel.is_a_limesurvey_participant(:email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname')
+        end
+        its(:limesurvey_participant_email_attr) { is_expected.to eq 'email_address' }
+        its(:limesurvey_participant_firstname_attr) { is_expected.to eq 'name' }
+        its(:limesurvey_participant_lastname_attr) { is_expected.to eq 'surname' }
+      end
+    end
+
+    context "when participant model is initialized with options: :attribute_1_attr => 'extra_id', :email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname'" do
+      
+      before(:all) { TestModel.is_a_limesurvey_participant(:attribute_1_attr => "extra_id", :email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname') }
+      
+      let(:a_participant) { FactoryGirl.create(:test_model) }
+
+      describe "#add_to_survey(arg)"  do
+        context "when arg is an existing survey object" do
+          it "returns true" do
+            expect(a_participant.add_to_survey(test_survey)).to be true
+          end
+          context "and #{described_class} instance is already registered" do
+            before(:each) do
+              a_participant.add_to_survey(test_survey)
+            end
+            it "returns false" do
+              expect(a_participant.add_to_survey(test_survey)).to be false
+            end
+          end
+        end
+        context "when arg is something wrong" do
+          it "raise WrongArgumentError" do
+            expect { a_participant.add_to_survey(Object.new) }.to raise_error(WrongArgumentError)
+          end
+        end
+      end
+      describe "#remove_from_survey(arg)" do
+        context "when arg is an existing survey object" do
+          context "when #{described_class} instance is already registered" do
+            before(:each) do
+              a_participant.add_to_survey(test_survey)
+            end
+            it "returns true" do
+              expect(a_participant.remove_from_survey(test_survey)).to be true
+            end
+          end
+          context "when #{described_class} instance is not registered" do
+            it "returns false" do
+              expect(a_participant.remove_from_survey(test_survey)).to be false
+            end
+          end
+        end
+        context "when arg is something wrong" do
+          it "raise WrongArgumentError" do
+            expect { a_participant.remove_from_survey(Object.new) }.to raise_error(WrongArgumentError)
+          end
+        end
+      end
+      describe "#surveys" do
+        before(:all) do
+          @another_test_survey_id = get_brand_new_test_survey_id(:activate_tokens => true)
+          @another_more_test_survey_id = get_brand_new_test_survey_id(:activate_tokens => true)
+        end
+        let(:another_test_survey) { Survey.find(@another_test_survey_id) }
+        let(:another_more_test_survey) { Survey.find(@another_more_test_survey_id) }
+        it "returns an empty array" do
+          expect(a_participant.surveys).to be_empty
+        end
+        context "when has added to a survey" do
+          before(:each) { SurveyParticipation.create(:survey_id => test_survey.id, :participant_id => a_participant.id ) }
+          it "returns an array with one element" do
+            expect(a_participant.surveys.size).to eq 1
+          end
+          it "and that element containing a Survey object" do
+            expect(a_participant.surveys.first).to be_kind_of(Survey)
+          end
+          context "when has added to another survey" do
+            before(:each) { SurveyParticipation.create(:survey_id => another_test_survey.id, :participant_id => a_participant.id ) }
+            it "returns an array with two elements" do
+              expect(a_participant.surveys.size).to eq 2
+            end
+          end
+          describe "#available_surveys" do
+            it "returns an array with two elements" do
+              expect(a_participant.available_surveys.size).to eq 2
+            end
+          end
+        end
+      end
+    end
+
+    describe "#destroy" do
+      before(:each) do
+        reset_models
+        TestModel.is_a_limesurvey_participant(opts)
+        test_survey.add_participant!(a_participant)
+      end
+
+      context "when participant model is initialized with no options" do
+        let(:opts){{}}
+        it "limesurvey token doesn't get destroyed" do
+          tid = a_participant.survey_participations.for_survey(test_survey.id).token_id
+          a_participant.destroy
+          expect(LimesurveyRails.list_participants(test_survey.id).map { |p| p["tid"] }).to include(tid)
+        end
+        it "participation remain but with no reference to the destroyed participant" do
+          tid = a_participant.survey_participations.for_survey(test_survey.id).token_id
+          a_participant.destroy
+          expect(SurveyParticipation.find_by_token_id(tid)).to be_present
+        end
+      end
+      context "when participant model is initialized with option: :dependent_participations => :destroy" do
+        let(:opts){{:dependent_participations => :destroy}}
+        it "also destroy token on limesurvey" do
+          tid = a_participant.survey_participations.for_survey(test_survey.id).token_id
+          a_participant.destroy
+          expect(LimesurveyRails.list_participants(test_survey.id).map { |p| p["tid"] }).to_not include(tid)
+        end
+      end
+      context "when participant model is initialized with option: :dependent_participations => :restrict"  do
+        let(:opts){{:dependent_participations => :restrict}}
+        specify { expect { a_participant.destroy }.to raise_error(ActiveRecord::DeleteRestrictionError) }
+      end
+    end
+
+
+  end
+end
+

data/spec/models/limesurvey_rails/survey_participations_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module LimesurveyRails
+  describe SurveyParticipation, :participation => true do
+    
+    subject { SurveyParticipation }
+
+    before(:all) do
+      configure_and_connect
+      @test_survey_id = get_brand_new_test_survey_id(:activate_tokens => true)
+      reset_models
+      TestModel.is_a_limesurvey_participant :attribute_1_attr => "extra_id", :email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname'
+    end 
+    after(:all) { remove_all_test_surveys }
+
+    let(:a_participant) { FactoryGirl.create(:test_model) }
+    let(:test_survey) { Survey.find(@test_survey_id) }
+
+    describe ".new" do
+      describe "the new SurveyParticipation object" do
+        context "when another record with the same survey_id and participant_id exist" do
+          before(:each) { SurveyParticipation.create(:survey_id => test_survey.id, :participant_id => a_participant.id ) }
+          subject { SurveyParticipation.new(:survey_id => test_survey.id, :participant_id => a_participant.id ) }
+          specify do
+            subject.valid?
+            expect(subject.errors[:participant_id].size).to eq 1
+          end
+        end
+        [:participant_id,:survey_id].each do |a|
+          context "when trying to create a new instance without #{a}" do
+            subject { SurveyParticipation.new }
+            specify do
+              subject.valid?
+              expect(subject.errors[a].size).to eq 1
+            end
+          end
+        end
+        
+      end
+    end
+
+    describe "callbacks beahvior" do
+      # before(:each) { LimesurveyRails.connect }
+      let!(:a_participant) { FactoryGirl.create(:test_model) }
+      let!(:test_survey) { Survey.find(@test_survey_id) }
+      describe "#create!" do
+        describe "returned value" do
+          subject(:ss) { SurveyParticipation.create!(:survey_id => test_survey.id, :participant_id => a_participant.id ) }
+          its(:token){ is_expected.to be_kind_of String }
+          its(:token_id){ is_expected.to be_kind_of String }
+          its(:url){ is_expected.to eq(LIMESURVEY_BASE_URL + "/survey/index/sid/#{ss.survey_id}/token/#{ss.token}/lang//newtest/Y") }
+        end
+        context "when something goes wrong with limesurvey add_participants call during the callback" do
+          before(:each) { LimesurveyRails.stub(:add_participants).and_raise }
+          specify { expect { SurveyParticipation.create!(:survey_id => test_survey.id, :participant_id => a_participant.id ) }.to raise_error}
+          it "doesn't create the SurveyParticipation object" do
+            SurveyParticipation.create!(:survey_id => test_survey.id, :participant_id => a_participant.id ) rescue nil
+            expect(SurveyParticipation.all).to be_empty
+          end
+        end
+        context "when something goes wrong with updating token_id attributes during the callback" do
+          before(:each) { SurveyParticipation.any_instance.stub(:save!).and_raise }
+          specify { expect { SurveyParticipation.create!(:survey_id => test_survey.id, :participant_id => a_participant.id ) }.to raise_error}
+        end
+      end
+      describe "#destroy!" do
+        before(:each) { @ss = SurveyParticipation.create(:survey_id => test_survey.id, :participant_id => a_participant.id ) }
+        context "when something goes wrong with limesurvey delete_participants call during the callback" do
+          before(:each) { LimesurveyRails.stub(:delete_participants).and_raise }
+          specify { expect { @ss.destroy }.to raise_error}
+        end
+      end
+    end
+
+    describe "limesurvey attributes" do
+      before(:each) { test_survey.add_participant!(a_participant) }
+      let(:a_participant) { FactoryGirl.create(:test_model, :extra_id => "XX030459") }
+      let(:ss) { a_participant.survey_participations.for_survey(test_survey.id) }
+      ['email', 'firstname', 'lastname'].each do |a|
+        it "includes correct value for attribute #{a}" do
+          token_value = ss.send(a)
+          participant_value = a_participant[TestModel.send("limesurvey_participant_#{a}_attr")]
+          expect(token_value).to eq(participant_value)
+        end
+      end
+      it "includes correct value for attribute attribute_1" do
+        token_value = ss.attribute_1
+        participant_value = a_participant[TestModel.send("limesurvey_participant_attribute_1_attr")]
+        expect(token_value).to eq(participant_value)
+      end
+      it "includes OK as value for emailstatus" do
+        token_value = ss.emailstatus
+        expect(token_value).to eq('OK')
+      end
+      context "when email is not available" do
+        let(:a_participant) { FactoryGirl.create(:test_model, :email_address => nil) }
+        it "includes UNKNOWN as value for emailstatus" do
+          token_value = ss.emailstatus
+          expect(token_value).to eq('UNKNOWN')
+        end
+      end
+    end
+
+    describe "#survey" do
+      let(:a_participation) { SurveyParticipation.create(:survey_id => test_survey.id, :participant_id => a_participant.id ) }
+      it "returns the survey" do
+        expect(a_participation.survey).to be_a(Survey)
+      end
+    end
+
+  end
+end
+

data/spec/models/limesurvey_rails/survey_spec.rb

@@ -0,0 +1,222 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module LimesurveyRails
+
+  describe Survey, :survey => true do
+    before(:all) do
+      configure_and_connect
+      reset_models
+      TestModel.is_a_limesurvey_participant :attribute_1_attr => "extra_id", :email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname'
+    end
+    after(:all) { remove_all_test_surveys }
+
+    describe ".add(title,lang)" do
+      it "returns true" do
+        expect(Survey.add('test title','en')).to be true
+      end
+      context "when wrong arguments provided" do
+        specify { expect { Survey.add('','en') }.to raise_error RemoteControlError }
+        specify { expect { Survey.add('test title','cds') }.to raise_error RemoteControlError }
+      end
+    end
+
+    describe ".all" do
+      before(:each) { remove_all_test_surveys }
+      it "returns an empty array" do
+        expect(Survey.all).to be_empty
+      end
+      context "when 3 surveys are present in the db" do
+        before(:each) { 3.times{|i| Survey.add("test survey number #{i}",'en') } }
+        it "returns an Array" do
+          expect(Survey.all).to be_an_instance_of(Array)
+        end
+        it "returns an Array with 3 elements" do
+          expect(Survey.all.size).to be 3
+        end
+        it "returns an Array made of Survey object" do
+          expect(Survey.all.inject(true){|memo,e| memo &= e.is_a? Survey}).to be true
+        end
+      end
+    end
+
+    context "when a test survey is present in the database" do
+
+      before(:each) { remove_all_test_surveys; @test_survey_id = get_brand_new_test_survey_id(:activate_tokens => true) }
+    
+      let(:test_survey) { Survey.find(@test_survey_id) }
+
+      describe ".find(id)" do
+        context "when id is the test survey id"  do
+          subject(:res) { Survey.find(@test_survey_id) } 
+          it { should be_instance_of Survey }
+          it { should have_same_attributes_as test_survey }
+        end
+        context "when id is wrong" do
+          it "raise RemoteControlError with message containing 'Invalid survey ID'" do
+            expect { Survey.find(0) }.to raise_error(RemoteControlError, /Invalid survey ID/)
+          end
+        end
+      end
+
+      describe ".url_for(id)" do
+        it "returns the specified limesurvey survey url" do
+          expect(Survey.url_for(@test_survey_id)).to eq(LIMESURVEY_BASE_URL + "/admin/survey/sa/view/surveyid/#{test_survey.id}")
+        end
+      end
+      
+      describe ".new_survey_url" do
+        specify { expect(Survey.new_survey_url).to eq(LIMESURVEY_BASE_URL + '/admin/survey/sa/newsurvey') }
+      end
+      
+      describe "#url" do
+        it "returns the limesurvey survey url" do
+          expect(test_survey.url).to eq(LIMESURVEY_BASE_URL + "/admin/survey/sa/view/surveyid/#{test_survey.id}")
+        end
+      end
+
+      describe "#description" do
+        it "returns a string with id title and status" do
+          expect(test_survey.description).to match /#{test_survey.id}.*#{test_survey.title}.*#{test_survey.status}/
+        end
+      end
+
+      describe "#destroy" do
+        it "returns true" do
+          expect(test_survey.destroy).to be true
+        end
+        context "when the survey has participants" do
+          # before(:all) { reset_models; TestModel.is_a_limesurvey_participant }
+          before(:each) do
+            FactoryGirl.create_list(:test_model,3)
+            TestModel.all.each{ |tm| FactoryGirl.create(:limesurvey_rails_survey_participation, :survey_id => test_survey.id, :participant_id => tm.id ) }
+          end
+          it "its survey participations are deleted" do
+            test_survey.destroy
+            expect(SurveyParticipation.for_survey(test_survey.id)).to be_empty
+          end
+        end
+      end
+
+      describe "participants instance methods"  do
+        # before(:all) { reset_models; TestModel.is_a_limesurvey_participant :attribute_1_attr => "extra_id", :email_attr => 'email_address', :firstname_attr => 'name', :lastname_attr => 'surname'}
+        # before(:each) do
+        #   instances = FactoryGirl.create_list(:test_model,3)
+        #   instances.each{ |tm| FactoryGirl.create(:limesurvey_rails_survey_participation, :survey_id => test_survey.id, :participant_id => tm.id ) }
+        # end
+
+        let(:a_participant) { FactoryGirl.create(:test_model) }
+
+        describe "#add_participant!(a_participant)" do
+          it_should_behave_like "adding a participant", 'add_participant!'
+          context "when a_participant is already registered" do
+            before(:each) do
+              test_survey.add_participant!(a_participant)
+            end
+            it "raise ActiveRecord::RecordInvalid" do
+              expect { test_survey.add_participant!(a_participant) }.to raise_error(ActiveRecord::RecordInvalid)
+            end
+          end
+          context "when a_participant is a regular ActiveRecord::Base object" do
+            it "raise WrongArgumentError" do
+              expect { test_survey.add_participant!(SurveyParticipation.new) }.to raise_error(WrongArgumentError)
+            end
+          end
+        end
+        
+        describe "#add_participant(a_participant)" do
+          it_should_behave_like "adding a participant", 'add_participant'
+          context "when a_participant is already registered" do
+            before(:each) do
+              test_survey.add_participant(a_participant)
+            end
+            it "returns false" do
+              expect(test_survey.add_participant(a_participant)).to be false
+            end
+          end
+          context "when a_participant is a regular ActiveRecord::Base object" do
+            it "returns false" do
+              expect(test_survey.add_participant(SurveyParticipation.new)).to be false
+            end
+          end
+        end
+
+        describe "#remove_participant!(a_participant)" do
+          it_should_behave_like "removing a participant", 'remove_participant!'
+          context "when a_participant is not registered" do
+            it "raise NoMethodError" do
+              expect { test_survey.remove_participant!(a_participant) }.to raise_error(NoMethodError)
+            end
+          end
+          context "when a_participant is a regular ActiveRecord::Base object" do
+            it "raise WrongArgumentError" do
+              expect { test_survey.remove_participant!(SurveyParticipation.new) }.to raise_error(WrongArgumentError)
+            end
+          end
+        end
+        
+        describe "#remove_participant(a_participant)" do
+          it_should_behave_like "removing a participant", 'remove_participant'
+          context "when a_participant is not registered" do
+            it "returns false" do
+              expect(test_survey.remove_participant(a_participant)).to be false
+            end
+          end
+          context "when a_participant is a regular ActiveRecord::Base object" do
+            it "returns false" do
+              expect(test_survey.remove_participant(SurveyParticipation.new)).to be false
+            end
+          end
+        end
+
+        context "when 3 participants are registered" do
+          describe "#participants" do
+            before(:each) do
+              instances = FactoryGirl.create_list(:test_model,3)
+              instances.each{ |tm| FactoryGirl.create(:limesurvey_rails_survey_participation, :survey_id => test_survey.id, :participant_id => tm.id ) }
+            end
+            subject { test_survey.reload }
+            its(:participants) { is_expected.to match_ar_array TestModel.all}
+            context "when a participant is missinig on Limesurvey" do
+              before(:each) do
+                id_to_delete = LimesurveyRails.list_participants(test_survey.id).sample['tid']
+                LimesurveyRails.delete_participants(test_survey.id,[id_to_delete])
+              end
+              specify { expect { test_survey.participants }.to raise_error(InconsistentParticipantsError) }
+            end
+          end
+        end
+
+        describe "#invite_participants!" do
+          context "when 3 participants are registered with email defined" do
+            before(:each) do
+              instances = FactoryGirl.create_list(:test_model,3)
+              instances.each{ |tm| FactoryGirl.create(:limesurvey_rails_survey_participation, :survey_id => test_survey.id, :participant_id => tm.id ) }
+            end
+            it "returns array [3,0]" do
+              expect(test_survey.invite_participants!).to eq [3,0]
+            end
+          end
+          context "when email is missing for one of them" do
+            before(:each) do
+              instances = FactoryGirl.create_list(:test_model,2)
+              instances << FactoryGirl.create(:test_model,:email_address => nil)
+              instances.each{ |tm| FactoryGirl.create(:limesurvey_rails_survey_participation, :survey_id => test_survey.id, :participant_id => tm.id ) }
+            end
+            it "returns array [2,0]" do
+              expect(test_survey.invite_participants!).to eq [2,0]
+            end
+            describe "survey"  do
+              before(:each) { test_survey.invite_participants! }
+              subject { test_survey.reload }
+              its(:token_count) { is_expected.to eq '3' }
+              its(:token_sent) { is_expected.to eq '2' }
+            end
+          end
+        end
+
+      end
+
+    end
+  end
+end
+