limesurvey_rails 1.1.0

data/app/models/limesurvey_rails/survey_participation.rb

@@ -0,0 +1,78 @@
+module LimesurveyRails
+  class SurveyParticipation < ActiveRecord::Base
+
+    GET_PARTICIPANT_PROPERTY_ATTRIBUTES = %w{ attribute_1 tid completed language usesleft firstname blacklisted validfrom lastname sent validuntil email remindersent mpid emailstatus remindercount  }
+
+    attr_accessible :participant_id, :survey_id
+    attr_accessor *GET_PARTICIPANT_PROPERTY_ATTRIBUTES
+
+    validates :participant_id, :uniqueness => {:scope => :survey_id}
+
+    validates_presence_of [:participant_id, :survey_id]
+    validates_presence_of :token, :on => :update
+
+    scope :for_survey, lambda { |survey_id| where(:survey_id => survey_id) }
+
+    after_initialize :assign_ls_token_attributes, :unless => 'new_record?' 
+    after_create :add_token_to_limesurvey
+    after_destroy :delete_token_from_limesurvey
+
+    def url
+      LimesurveyRails.configuration.base_url + "/survey/index/sid/#{survey_id}/token/#{token}/lang//newtest/Y"
+    end
+
+    def survey
+      Survey.find(survey_id)
+    end
+
+    %w{ completed sent }.each do |name|
+      define_method "#{name}?" do
+        case send(name)
+        when 'Y'
+          true
+        when 'N'
+          false
+        else
+          true
+        end
+      end
+    end
+     
+    private
+
+    def assign_ls_token_attributes
+      begin
+        LimesurveyRails.get_participant_properties(survey_id,token_id,GET_PARTICIPANT_PROPERTY_ATTRIBUTES).each{ |a,v| self.send("#{a}=",v)}
+      rescue RemoteControlError => e
+        if e.message.end_with? 'Invalid tokenid'
+          raise InconsistentParticipantsError, "Participation #{self} was not found on Limesurvey"
+        else
+          raise e
+        end
+      end
+    end
+
+    def add_token_to_limesurvey
+      opts = [:email, :firstname, :lastname, :attribute_1].inject({}) do |h,a|
+        method = participant.class.send("limesurvey_participant_#{a}_attr")
+        if method and participant.respond_to? method
+          h.merge(a => participant.send(method))
+        else
+          h
+        end
+      end
+      opts.merge!(:emailstatus => (opts[:email].nil? ? 'UNKNOWN' : 'OK') )
+
+      res = LimesurveyRails.add_participants(survey_id,[opts],true)
+      self.token_id = res.first['tid']
+      self.token = res.first['token']
+      save!
+    end
+
+    def delete_token_from_limesurvey
+      res = LimesurveyRails.delete_participants(survey_id,[token_id])
+      raise RemoteControlError, "something went wrong while deleting participant #{token_id} on survey #{survey_id}" unless res.keys == [token_id]
+    end
+
+  end
+end

data/app/views/limesurvey_rails/surveys/_form.html.haml

@@ -0,0 +1,16 @@
+= form_for @survey do |f|
+  - if @survey.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@survey.errors.count, "error")} prohibited this survey from being saved:"
+      %ul
+        - @survey.errors.full_messages.each do |msg|
+          %li= msg
+
+  .field
+    = f.label :title
+    = f.text_field :surveyls_title
+  .field
+    = f.label :lang
+    = f.text_field :surveyls_language
+  .actions
+    = f.submit 'Save'

data/app/views/limesurvey_rails/surveys/edit.html.haml

@@ -0,0 +1,7 @@
+%h1 Editing survey
+
+= render 'form'
+
+= link_to 'Show', @survey
+\|
+= link_to 'Back', surveys_path

data/app/views/limesurvey_rails/surveys/index.html.haml

@@ -0,0 +1,21 @@
+%h1 Listing surveys
+
+%table
+  %tr
+    %th Title
+    %th Lang
+    %th
+    %th
+    %th
+
+  - @surveys.each do |survey|
+    %tr
+      %td= survey.title
+      %td= survey.lang
+      %td= link_to 'Show', survey_path(survey.id)
+      %td= link_to 'Edit', edit_survey_path(survey.id)
+      %td= link_to 'Destroy', survey, :method => :delete, :data => { :confirm => 'Are you sure?' }
+
+%br
+
+= link_to 'New Survey', new_survey_path

data/app/views/limesurvey_rails/surveys/new.html.haml

@@ -0,0 +1,5 @@
+%h1 New survey
+
+= render 'form'
+
+= link_to 'Back', surveys_path

data/app/views/limesurvey_rails/surveys/show.html.haml

@@ -0,0 +1,12 @@
+%p#notice= notice
+
+%p
+  %b Title:
+  = @survey.title
+%p
+  %b Lang:
+  = @survey.lang
+
+= link_to 'Edit', edit_survey_path(@survey)
+\|
+= link_to 'Back', surveys_path

data/config/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  

data/config/locales/it.yml

@@ -0,0 +1,15 @@
+it:
+  activerecord:
+    models:
+      "limesurvey_rails/survey":
+        one: questionario
+        other: questionari
+    attributes:
+      "limesurvey_rails/survey":
+        title: titolo
+        language: lingua
+        active: attivo
+        token_sent: partecipanti invitati
+        token_count: partecipanti
+        complete_responses: questionari completati
+        

data/config/routes.rb

@@ -0,0 +1,7 @@
+LimesurveyRails::Engine.routes.draw do
+  scope "(:locale)", :locale => /#{I18n.available_locales.join("|")}/ do
+    resources :surveys do
+      put 'invite_participants', :on => :member
+    end
+  end
+end

data/db/migrate/20140130110450_create_limesurvey_rails_survey_participations.rb

@@ -0,0 +1,11 @@
+class CreateLimesurveyRailsSurveyParticipations < ActiveRecord::Migration
+  def change
+    create_table :limesurvey_rails_survey_participations do |t|
+      t.integer :participant_id
+      t.integer :survey_id
+      t.string :token_id
+      t.string :token
+      t.timestamps
+    end
+  end
+end

data/lib/limesurvey_rails.rb

@@ -0,0 +1,10 @@
+require "limesurvey_rails/engine"
+require "limesurvey"
+require "limesurvey_rails/configuration"
+require "limesurvey_rails/exceptions"
+require "limesurvey_rails/participant"
+require "limesurvey_rails/limesurvey_rails"
+
+module LimesurveyRails
+
+end

data/lib/limesurvey_rails/configuration.rb

@@ -0,0 +1,31 @@
+module LimesurveyRails
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  def self.configured?
+    !(configuration and configuration.api_url and configuration.username and configuration.password).blank?
+  end
+
+  class Configuration
+    attr_accessor :api_url, :username, :password, :auto_connection, :max_number_of_tokens_per_survey
+
+    def initialize
+      @api_url = nil
+      @username = nil
+      @password = nil
+      @auto_connection = false
+      @max_number_of_tokens_per_survey = 100000
+    end
+
+    def base_url
+      @api_url.gsub('/admin/remotecontrol','')
+    end
+  end
+end

data/lib/limesurvey_rails/engine.rb

@@ -0,0 +1,21 @@
+module LimesurveyRails
+  class Engine < ::Rails::Engine
+    isolate_namespace LimesurveyRails
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+      g.template_engine :haml
+    end
+
+    # http://edgeguides.rubyonrails.org/engines.html#overriding-models-and-controllers
+    config.to_prepare do
+      Dir.glob(Rails.root + "app/decorators/**/*_decorator*.rb").each do |c|
+        require_dependency(c)
+      end
+    end
+
+  end
+end

data/lib/limesurvey_rails/exceptions.rb

@@ -0,0 +1,7 @@
+module LimesurveyRails
+  class GenericError < StandardError; end
+  class RemoteControlError < GenericError;  end
+  class WrongArgumentError < GenericError;  end
+  class InconsistentParticipantsError < GenericError;  end
+  class MultipleParticipationsToSurveyError < GenericError;  end
+end

data/lib/limesurvey_rails/limesurvey_rails.rb

@@ -0,0 +1,86 @@
+module LimesurveyRails
+  API_METHODS = %w{get_session_key release_session_key get_site_settings add_survey delete_survey import_survey get_survey_properties set_survey_properties list_surveys activate_survey export_statistics get_summary add_language delete_survey_language get_language_properties set_language_properties add_group delete_group import_group get_group_properties set_group_properties list_groups list_users delete_question import_question get_question_properties set_question_properties list_questions activate_tokens add_participants delete_participants get_participant_properties set_participant_properties list_participants activate_tokens invite_participants remind_participants add_response export_responses export_responses_by_token}
+
+  class << self
+    attr_accessor :api, :session_key
+  end
+
+  def self.connect(force = false)
+    if !force and connected?
+      false
+    else
+      if configured?
+        self.api = Limesurvey::API.new(configuration.api_url)
+        self.session_key = api.get_session_key(configuration.username,configuration.password) if api
+      end
+      session_key.present? and session_key.is_a? String
+    end
+  end
+
+  def self.disconnect
+    if connected?
+      api.release_session_key if api
+      self.api = nil
+      self.session_key = nil
+      api.nil? and session_key.nil?
+    else
+      false
+    end
+  end
+
+  def self.connected?
+    begin
+      raise unless configured?
+      raise unless session_key.present?
+      check_result = api.list_surveys(session_key)
+      raise unless check_result.is_a? Array or check_result['status'] == 'No surveys found'
+      true
+    rescue Exception => e
+      if configuration.try(:auto_connection)
+        connect(true)
+      else
+        false
+      end
+    end
+  end
+
+  def self.reset
+    disconnect
+    self.configuration = nil
+  end
+
+  def self.method_missing(method_name, *arguments, &block)
+    if API_METHODS.include? method_name.to_s
+      if connected?
+        # t0=Time.now
+        result = api.send(method_name, *arguments.unshift(session_key))
+        # puts "#{method_name} in #{Time.now-t0}"
+        if result.is_a? Hash and result["status"] # get exception result
+          case result["status"]
+          when 'OK'
+            true
+          when 'No surveys found'
+            []
+          when 'No Tokens found'
+            []
+          when /(left to send)|(No candidate tokens)$/
+            result # get regular result
+          else
+            raise RemoteControlError, "#{method_name} returned a failure response status: #{result["status"]}"
+          end
+        else # get regular result
+          result
+        end
+      else
+        raise RemoteControlError, 'you are disconnected from Limesurvey'
+      end
+    else
+      super
+    end
+  end
+
+  def self.respond_to_missing?(method_name, include_private = false)
+    API_METHODS.include? method_name.to_s || super
+  end  
+
+end

data/lib/limesurvey_rails/participant.rb

@@ -0,0 +1,86 @@
+module LimesurveyRails
+  
+  module Participant
+
+    module ClassMethods
+      
+      def is_a_limesurvey_participant(opts = {})
+        # puts "################################ init #{self} as a limesurvey_participant with opts #{opts}"
+        self.limesurvey_participant = true
+
+        # check options
+        opts.keys.each{|k| raise WrongArgumentError unless [:attribute_1_attr, :email_attr, :firstname_attr, :lastname_attr, :dependent_participations].include? k}
+
+        {:attribute_1_attr => 'id', :email_attr => nil, :firstname_attr => nil, :lastname_attr => nil, :dependent_participations => :nullify }.each do |k,v|
+          class_attribute_name = "limesurvey_participant_#{k}"
+          class_attribute class_attribute_name
+          self.send("#{class_attribute_name}=", (opts[k] or v))
+        end
+
+        has_many :survey_participations, :class_name => "LimesurveyRails::SurveyParticipation", :foreign_key => "participant_id", :dependent => limesurvey_participant_dependent_participations  do
+          def for_survey(survey_id)
+            res = where("survey_id == #{survey_id}")
+            raise MultipleParticipationsToSurveyError if res.size > 1
+            res.first
+          end
+        end
+
+        LimesurveyRails::SurveyParticipation.class_exec(self){ |klass| belongs_to :participant, :class_name => klass, :foreign_key => 'participant_id'}
+        # LimesurveyRails::SurveyParticipation.belongs_to :participant, :class_name => self.name, :foreign_key => 'participant_id' 
+
+        # below the proof that among tests associated classes not get updated even after remove_const calls
+        # see also http://code.activestate.com/lists/ruby-talk/42730/
+        # puts (LimesurveyRails::SurveyParticipation.reflect_on_association(:participant).klass.object_id == self.object_id)
+
+      end
+
+      def is_a_limesurvey_participant_class?
+        limesurvey_participant
+      end
+    end
+    
+    module InstanceMethods
+      
+      def add_to_survey(survey)
+        if survey.is_a? Survey
+          survey.add_participant(self)
+        else
+          raise WrongArgumentError, "expexted Survey object, got #{survey.class}"
+        end
+      end
+
+      def remove_from_survey(survey)
+        if survey.is_a? Survey
+          survey.remove_participant(self)
+        else
+          raise WrongArgumentError, "expexted Survey object, got #{survey.class}"
+        end
+      end
+
+      def surveys
+        survey_participations.map(&:survey)
+      end
+
+      def available_surveys
+        ids = surveys.map(&:id).map(&:to_s)
+        Survey.all.delete_if{|s| ids.include? s.id }
+      end
+
+    end
+    
+    def self.included(receiver)
+      
+      # I put this here because I want limesurvey_participant class attribute to be available as soon as you include the gem
+      receiver.class_attribute :limesurvey_participant
+      receiver.limesurvey_participant = false
+
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  
+  end
+
+  ActiveRecord::Base.send :include, Participant
+
+end
+

data/lib/limesurvey_rails/version.rb

@@ -0,0 +1,3 @@
+module LimesurveyRails
+  VERSION = "1.1.0"
+end