limesurvey_rails 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWUwNmEyNGI1YWJhNTU5MDNlMTc5NzFhNDhlMDdkMjE3MTM1YmIyNQ==
+  data.tar.gz: !binary |-
+    NTc5Y2I1NmM3NzUyZTU0NTdiODA4MWFmZTAwYzZkZTk2OWNjN2Y5YQ==
+SHA512:
+  metadata.gz: !binary |-
+    MTVhZmQxZGY4ZmJmODY3MGM4NjgyOWYzNTdmZTEwZWQ1NzgyMGZjYjk2ZDM1
+    NDI0MjU1NDQ2MWJiM2JiYmE1YWQ5ZDA0NDRjYmNiNmJiYjViMTYzMjBmZWRh
+    ZTQ3OWVmOWFiM2UzMTJhYmI5NTFmYWMzYzE1ZGM3YzJkNDFhMGU=
+  data.tar.gz: !binary |-
+    NWNjMzBmMTEyY2M1NzkyMDg2OTVlMDcyNWI2YTI0OGYwZmQ1NjhkZTRkZGE5
+    NmZmNDhjOWQ1YzlkMmI3ZDMzNGExMjNhODkzMzI3NDg1Mzk3ZTdlZTA4OWRl
+    ZDMwMWE2MjUwM2RlOGQ5M2VkYTg4ZTVlODhlMzAxYjBjODU4MWY=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in limesurvey_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 masciugo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# LimesurveyRails
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'limesurvey_rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limesurvey_rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/limesurvey_rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,42 @@
+# tasks for gem managment by bundler:
+# rake build    # Build limesurvey_rails-1.1.0.gem into the pkg directory
+# rake install  # Build and install limesurvey_rails-1.1.0.gem into system gems
+# rake release  # Create tag v1.1.0 and build and push limesurvey_rails-1.1.0.gem to Rubygems
+require "bundler/gem_tasks"
+
+# check for missing gems
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+# load tasks from dummy application
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+###### RSpec stuff 
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs) or the ones tagged by provided tag"
+RSpec::Core::RakeTask.new(:spec, :tag, :seed) do |t, task_args|
+  Rake::Task['app:db:test:prepare'].invoke
+  t.rspec_opts = ''
+  t.rspec_opts += " --tag #{task_args[:tag]}" unless task_args[:tag].blank?
+  t.rspec_opts += " --seed #{task_args[:seed]}" unless task_args[:seed].blank?
+end
+
+desc "Run specfiles specified by pattern with optional seed"
+RSpec::Core::RakeTask.new(:specfile, :pattern, :seed) do |t, task_args|
+  Rake::Task['app:db:test:prepare'].invoke
+  t.pattern = task_args[:pattern] unless task_args[:pattern].nil?
+  t.rspec_opts = ''
+  t.rspec_opts += " --seed #{task_args[:seed]}" unless task_args[:seed].blank?
+  # t.rspec_opts += " --fail-fast" # Making RSpec stop operation immediately after failing
+end
+###### end of RSpec stuff
+
+task :default => :spec

data/app/assets/javascripts/limesurvey_rails/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/limesurvey_rails/surveys.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/limesurvey_rails/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/limesurvey_rails/surveys.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/limesurvey_rails/application_controller.rb

@@ -0,0 +1,3 @@
+class LimesurveyRails::ApplicationController < ApplicationController
+end
+

data/app/controllers/limesurvey_rails/surveys_controller.rb

@@ -0,0 +1,51 @@
+require_dependency "limesurvey_rails/application_controller"
+
+module LimesurveyRails
+  class SurveysController < ApplicationController
+    # GET /surveys
+    def index
+      @surveys = Survey.all
+    end
+  
+    # PUT /surveys/1/invite
+    def invite_participants
+      @survey = Survey.find(params[:id])
+      @survey.invite_participants!
+      redirect_to surveys_url
+    end
+
+    # GET /surveys/1
+    def show
+      redirect_to Survey.url_for(params[:id])
+    end
+  
+    # GET /surveys/new
+    def new
+      @survey = Survey.new
+    end
+  
+    # GET /surveys/1/edit
+    def edit
+      redirect_to Survey.url_for(params[:id])
+    end
+  
+    # POST /surveys
+    def create
+      @survey = Survey.new(params[:survey])
+      respond_to do |format|
+        if @survey.valid? and Survey.add(@survey.title,@survey.language)
+          format.html { redirect_to surveys_url, notice: 'Survey was successfully created.' }
+        else
+          format.html { render action: "new" }
+        end
+      end
+    end
+  
+    # DELETE /surveys/1
+    def destroy
+      @survey = Survey.find(params[:id])
+      @survey.destroy
+      redirect_to surveys_url
+    end
+  end
+end

data/app/helpers/limesurvey_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module LimesurveyRails
+  module ApplicationHelper
+  end
+end

data/app/helpers/limesurvey_rails/surveys_helper.rb

@@ -0,0 +1,4 @@
+module LimesurveyRails
+  module SurveysHelper
+  end
+end

data/app/models/limesurvey_rails/no_persistence_active_model.rb

@@ -0,0 +1,33 @@
+module LimesurveyRails
+  class NoPersistenceActiveModel
+    include ActiveModel::MassAssignmentSecurity
+    include ActiveModel::Validations  
+    include ActiveModel::Conversion  
+    include ActiveModel::AttributeMethods
+    extend ActiveModel::Naming  
+    
+    # http://stackoverflow.com/questions/8835215/how-to-handle-translations-for-an-activemodel
+    class << self
+      def i18n_scope
+        :activerecord
+      end
+    end
+
+    def initialize(params = {})  
+      params.each do |name, value|  
+        send("#{name}=", value)  
+      end  
+    end
+
+    def persisted?  
+      false  
+    end 
+
+    # http://api.rubyonrails.org/classes/ActiveModel/AttributeMethods.html
+    def attributes
+      if defined?(self.class::ALL_ATTRIBUTES)
+        self.class::ALL_ATTRIBUTES.inject({}){|memo,a| memo.merge( a => send(a) )}
+      end
+    end
+  end
+end

data/app/models/limesurvey_rails/survey.rb

@@ -0,0 +1,151 @@
+module LimesurveyRails
+
+  class Survey < NoPersistenceActiveModel
+
+    LIST_SURVEYS_ATTRIBUTES = %w{ sid surveyls_title startdate expires active }
+
+    GET_SUMMARY_RESPONSES_ATTRIBUTES = %w{ completed_responses incomplete_responses full_responses }
+    GET_SUMMARY_TOKENS_ATTRIBUTES = %w{ token_count token_invalid token_sent token_opted_out token_completed }
+    GET_SUMMARY_ATTRIBUTES = GET_SUMMARY_RESPONSES_ATTRIBUTES + GET_SUMMARY_TOKENS_ATTRIBUTES
+    GET_SURVEY_PROPERTY_ATTRIBUTES = %w{ attributedescriptions savetimings allowprev tokenanswerspersistence showgroupinfo showwelcome owner_id template printanswers assessments shownoanswer showprogress admin language ipaddr usecaptcha showqnumcode allowjumps active additional_languages refurl usetokens bouncetime navigationdelay expires datestamp datecreated bounce_email bounceprocessing nokeyboard startdate usecookie publicstatistics bounceaccounttype alloweditaftercompletion adminemail allowregister publicgraphs emailresponseto bounceaccounthost googleanalyticsstyle anonymized allowsave listpublic emailnotificationto bounceaccountpass googleanalyticsapikey faxto autonumber_start htmlemail tokenlength bounceaccountencryption format autoredirect sendconfirmation showxquestions bounceaccountuser }
+    GET_LANGUAGE_PROPERTIES_ATTRIBUTES = %w{ surveyls_survey_id surveyls_url surveyls_email_register_subj email_admin_notification_subj surveyls_language surveyls_urldescription surveyls_email_register email_admin_notification surveyls_title surveyls_email_invite_subj surveyls_email_confirm_subj email_admin_responses_subj surveyls_description surveyls_email_invite surveyls_email_confirm email_admin_responses surveyls_welcometext surveyls_email_remind_subj surveyls_dateformat surveyls_numberformat surveyls_endtext surveyls_email_remind surveyls_attributecaptions }
+    
+    ALL_ATTRIBUTES = (GET_SUMMARY_ATTRIBUTES | GET_SURVEY_PROPERTY_ATTRIBUTES | GET_LANGUAGE_PROPERTIES_ATTRIBUTES ).sort.unshift('id')
+
+    attr_accessor *ALL_ATTRIBUTES
+
+    alias_attribute :title, :surveyls_title
+    alias_attribute :created_at, :datecreated
+
+    validates_presence_of :surveyls_title
+    validates_presence_of :language
+
+    def self.all(lang = nil)
+      LimesurveyRails.list_surveys(LimesurveyRails.configuration.username).map{|s| build(s['sid'],lang) }
+    end
+
+    def self.find(survey_id,lang = nil)
+      build(survey_id,lang)
+    end
+
+    def self.add(title,lang)
+      id = LimesurveyRails.add_survey(nil,title,lang)
+      LimesurveyRails.activate_tokens(id,[1])
+    end
+
+    def self.new_survey_url
+      LimesurveyRails.configuration.base_url + '/admin/survey/sa/newsurvey'
+    end
+
+    def self.url_for(survey_id)
+      LimesurveyRails.configuration.base_url + "/admin/survey/sa/view/surveyid/#{survey_id}"
+    end
+
+    def destroy
+      num_rows_to_delete = SurveyParticipation.for_survey(id).size
+      LimesurveyRails.delete_survey(id) and num_rows_to_delete == SurveyParticipation.for_survey(id).delete_all
+    end
+
+    def active?
+      case active
+      when 'Y'
+        true
+      when 'N'
+        false
+      end
+    end
+
+    def status
+      active? ? 'active' : 'not active'
+    end
+
+    def description
+      "#{id} - #{title} [#{status}]"
+    end
+
+    # def ==(comparison_object)
+    #   comparison_object.equal?(self) ||
+    #     (comparison_object.instance_of?(self.class) &&
+    #       comparison_object.id == id &&
+    #       !comparison_object.new_record?)
+    # end
+
+    def url
+      Survey.url_for(id)
+    end
+
+    def inspect
+      "#< #{self.class} id=#{id} title='#{title}' >"
+    end
+
+    def to_s
+      "#{title} [#{id}]"  
+    end
+
+    def participants
+      participations = SurveyParticipation.for_survey(id)
+      raise InconsistentParticipantsError if participations.map(&:token_id).sort != LimesurveyRails.list_participants(id).map{|p| p['tid']}.sort
+      participations.map(&:participant)
+    end
+
+    def add_participant!(participant)
+      if participant.class.is_a_limesurvey_participant_class?
+        SurveyParticipation.create!(:participant_id => participant.id, :survey_id => id)
+        return true
+      else
+        raise WrongArgumentError, "expexted limesurvey participant enabled object, got #{participant.class}"
+      end
+    end
+
+    def add_participant(participant)
+      add_participant!(participant) rescue false
+    end
+
+    def remove_participant!(participant)
+      if participant.class.is_a_limesurvey_participant_class?
+        ss = SurveyParticipation.find_by_participant_id_and_survey_id(participant.id,id)
+        ss.destroy
+        return true
+      else
+        raise WrongArgumentError, "expected limesurvey participant enabled object, got #{participant.class}"
+      end
+    end
+
+    def remove_participant(participant)
+      remove_participant!(participant) rescue false
+    end
+
+    def invite_participants!
+      res = LimesurveyRails.invite_participants(id)
+      status = res.delete('status')
+      if status.end_with?('No candidate tokens')
+        [0,token_count]
+      elsif status.end_with?('left to send')
+        [res.size, status.split(' ').first.to_i]
+      else
+        raise
+      end
+    end
+
+    def reload
+      Survey.build(id)
+    end
+
+    private
+
+    def self.build(survey_id, lang = nil)
+      all_attributes = {id: survey_id}
+      all_attributes.merge!(LimesurveyRails.get_survey_properties(survey_id,GET_SURVEY_PROPERTY_ATTRIBUTES))
+      
+      # if all_attributes['active'] == 'Y'
+        all_attributes.merge!(LimesurveyRails.get_summary(survey_id,'all')) 
+      # else
+      #   GET_SUMMARY_TOKENS_ATTRIBUTES.each{|a| all_attributes[a] = LimesurveyRails.get_summary(survey_id,a) rescue nil }
+      # end
+      all_attributes.merge!(LimesurveyRails.get_language_properties(survey_id,GET_LANGUAGE_PROPERTIES_ATTRIBUTES,lang || all_attributes['language']))
+      new(all_attributes)
+    end
+
+  end
+
+end