lime_survey 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 431db8ddd4dc8272c123ed1fe3c08dd669c522d61d8fac2bb826f369dcaa6084
+  data.tar.gz: c406f56c9345080233afd8da85119ec2b5c5d461a883ecddfd51e64aa648f78d
+SHA512:
+  metadata.gz: 6388f481393a6056fac428649863b8e1a2a3951c3e6cd008ff59b76c5bc69c1a1896780e406a18ba0e5c95ef336ae71ef3cdedf2831b58d9988e5f356acaeefd
+  data.tar.gz: f03148d9ddf6e9dd87e44e2b2d44afe519606258a542e400c0aa0b99f150a4839906620efc52035827b44e63ea6d644ee18b41d9e343df77f04b4cb0a4c7bde9

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.env.sample

@@ -0,0 +1,4 @@
+LIMESURVEY_API_URL:  "https://YOUR_URL/survey/index.php?r=admin/remotecontrol"  
+LIMESURVEY_USERNAME: "my-username"
+LIMESURVEY_PASSWORD: "my-password"
+LIMESURVEY_BASE_URL: "https://YOUR_URL/survey/index.php"

data/.gitignore

@@ -0,0 +1,21 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.sublime-project
+*.sublime-workspace
+
+.DS_Store
+.env
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at beneggett@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lime_survey.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ben Eggett
+
+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,353 @@
+[![Gem Version](https://badge.fury.io/rb/lime_survey.svg)](https://badge.fury.io/rb/lime_survey)
+[![Build Status](https://travis-ci.com/beneggett/lime_survey.svg?branch=master)](https://travis-ci.com/beneggett/lime_survey)
+[![Coverage Status](https://coveralls.io/repos/github/beneggett/lime_survey/badge.svg?branch=master)](https://coveralls.io/github/beneggett/lime_survey?branch=master)
+# LimeSurvey
+
+Fully Implements the LimeSurvey API in Ruby
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'lime_survey'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lime_survey
+
+Be sure to define your LimeSurvey credentials by setting up environment variables in your application appropriately. Refer to the .env.sample file for details.
+```
+LIMESURVEY_API_URL = "https://YOUR_URL/survey/index.php?r=admin/remotecontrol"
+LIMESURVEY_USERNAME = "my-user"
+LIMESURVEY_PASSWORD = "my-password"
+```
+
+If you simply would like to play with the API, you can use the public demo credentials which are:
+
+```
+LIMESURVEY_API_URL:  "https://demo.limesurvey.org/index.php?r=admin/remotecontrol"
+LIMESURVEY_USERNAME: "demo"
+LIMESURVEY_PASSWORD: "demo"
+
+```
+Public credentials last updated 4/25/2019
+
+## Usage
+
+There are 48 primary APIs that are wrapped. Below you will see basic examples of how to use them. For more information about what optional query parameters are available, please consult the [LimeSurvey API Docs](https://api.limesurvey.org/classes/remotecontrol_handle.html#method_list_surveys)
+
+Authenticated calls require a token, this library already handles the request & reload of tokens as needed via the `check_authentication` & `get_session_key methods` defined in LimeSurvey::Api
+
+#### Activate Survey
+
+```
+LimeSurvey::Api.new.activate_survey survey_id: 1
+```
+
+#### Activate Tokens
+
+```
+LimeSurvey::Api.new.activate_tokens survey_id: 1, attribute_fields: [3,5,7]
+```
+
+#### Add Group
+
+```
+LimeSurvey::Api.new.add_group
+```
+
+#### Add Language
+
+```
+LimeSurvey::Api.new.add_language
+```
+
+#### Add Participants
+
+```
+LimeSurvey::Api.new.add_participants
+```
+
+#### Add Response
+
+```
+LimeSurvey::Api.new.add_response
+```
+
+#### Add Survey
+
+```
+LimeSurvey::Api.new.add_survey
+```
+
+#### Copy Survey
+
+```
+LimeSurvey::Api.new.copy_survey
+```
+
+#### Cpd Import Participants
+
+```
+LimeSurvey::Api.new.cpd_import_participants
+```
+
+#### Delete Group
+
+```
+LimeSurvey::Api.new.delete_group
+```
+
+#### Delete Language
+
+```
+LimeSurvey::Api.new.delete_language
+```
+
+#### Delete Participants
+
+```
+LimeSurvey::Api.new.delete_participants
+```
+
+#### Delete Question
+
+```
+LimeSurvey::Api.new.delete_question
+```
+
+#### Delete Survey
+
+```
+LimeSurvey::Api.new.delete_survey
+```
+
+#### Export Responses
+
+```
+LimeSurvey::Api.new.export_responses
+```
+
+#### Export Responses By Token
+
+```
+LimeSurvey::Api.new.export_responses_by_token
+```
+
+#### Export Statistics
+
+```
+LimeSurvey::Api.new.export_statistics
+```
+
+#### Export Timeline
+
+```
+LimeSurvey::Api.new.export_timeline
+```
+
+#### Get Group Properties
+
+```
+LimeSurvey::Api.new.get_group_properties
+```
+
+#### Get Language Properties
+
+```
+LimeSurvey::Api.new.get_language_properties
+```
+
+#### Get Participant Properties
+
+```
+LimeSurvey::Api.new.get_participant_properties
+```
+
+#### Get Question Properties
+
+```
+LimeSurvey::Api.new.get_question_properties
+```
+
+#### Get Response Ids
+
+```
+LimeSurvey::Api.new.get_response_ids
+```
+
+#### Get Session Key
+
+```
+LimeSurvey::Api.new.get_session_key
+```
+
+#### Get Site Settings
+
+```
+LimeSurvey::Api.new.get_site_settings
+```
+
+#### Get Summary
+
+```
+LimeSurvey::Api.new.get_summary
+```
+
+#### Get Survey Properties
+
+```
+LimeSurvey::Api.new.get_survey_properties
+```
+
+#### Get Uploaded Files
+
+```
+LimeSurvey::Api.new.get_uploaded_files
+```
+
+#### Import Group
+
+```
+LimeSurvey::Api.new.import_group
+```
+
+#### Import Question
+
+```
+LimeSurvey::Api.new.import_question
+```
+
+#### Import Survey
+
+```
+LimeSurvey::Api.new.import_survey
+```
+
+#### Invite Participants
+
+```
+LimeSurvey::Api.new.invite_participants
+```
+
+#### List Groups
+
+```
+LimeSurvey::Api.new.list_groups
+```
+
+#### List Participants
+
+```
+LimeSurvey::Api.new.list_participants
+```
+
+#### List Questions
+
+```
+LimeSurvey::Api.new.list_questions
+```
+
+#### List Surveys
+
+```
+LimeSurvey::Api.new.list_surveys
+```
+
+#### List Users
+
+```
+LimeSurvey::Api.new.list_users
+```
+
+#### Mail Registered Participants
+
+```
+LimeSurvey::Api.new.mail_registered_participants
+```
+
+#### Release Session Key
+
+```
+LimeSurvey::Api.new.release_session_key
+```
+
+#### Remind Participants
+
+```
+LimeSurvey::Api.new.remind_participants
+```
+
+#### Set Group Properties
+
+```
+LimeSurvey::Api.new.set_group_properties
+```
+
+#### Set Language Properties
+
+```
+LimeSurvey::Api.new.set_language_properties
+```
+
+#### Set Participant Properties
+
+```
+LimeSurvey::Api.new.set_participant_properties
+```
+
+#### Set Question Properties
+
+```
+LimeSurvey::Api.new.set_question_properties
+```
+
+#### Set Quota Properties
+
+```
+LimeSurvey::Api.new.set_quota_properties
+```
+
+#### Set Survey Properties
+
+```
+LimeSurvey::Api.new.set_survey_properties
+```
+
+#### Update Response
+
+```
+LimeSurvey::Api.new.update_response
+```
+
+#### Upload File
+
+```
+LimeSurvey::Api.new.upload_file
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/beneggett/lime_survey. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LimeSurvey project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beneggett/lime_survey/blob/master/CODE_OF_CONDUCT.md).
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require "dotenv"
+Dotenv.load
+require "bundler/setup"
+require "lime_survey"
+
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/lime_survey/api.rb

@@ -0,0 +1,290 @@
+module LimeSurvey
+  class Api
+      URL_ENDPOINT = ENV.fetch("LIMESURVEY_API_URL", "not-implemented")
+
+      include HTTParty
+
+      attr_accessor :username, :password, :token
+
+      def initialize(options = {})
+        @username = options.fetch(:username, default_username)
+        @password = options.fetch(:password, default_password)
+        @token = options.dig(:token)
+      end
+
+      # LimeSurvey::Api.new.activate_survey survey_id: 1
+      def activate_survey(survey_id:)
+        authenticated_post "activate_survey", [survey_id].compact
+      end
+
+      # LimeSurvey::Api.new.activate_tokens survey_id: 1, attribute_fields: [3,5,7]
+      def activate_tokens(survey_id:, attribute_fields: [])
+        authenticated_post "activate_tokens", [survey_id, attribute_fields]
+      end
+
+      # LimeSurvey::Api.new.add_group
+      def add_group(survey_id:, group_title: , group_description: '' )
+        authenticated_post "add_group", [survey_id, group_title, group_description]
+      end
+
+      def add_language(survey_id: , language: )
+        authenticated_post "add_language", [survey_id, language]
+      end
+
+      def add_participants(survey_id: , participant_data: [], create_token: true)
+        authenticated_post "add_participants", [survey_id, participant_data, create_token]
+      end
+
+      def add_response(survey_id: , response_data: [])
+        authenticated_post "add_response", [survey_id, response_data]
+      end
+
+      # Format can be A|G|S
+      # LimeSurvey::Api.new.add_survey survey_id: 1234, survey_title: "Survey 1234", survey_language: "en", format: "A"
+      def add_survey(survey_id: , survey_title: , survey_language: , format: 'G' )
+        authenticated_post "add_survey", [survey_id, survey_title, survey_language, format]
+      end
+
+      def copy_survey(survey_id: , survey_name: )
+        authenticated_post "copy_survey", [survey_id, survey_name]
+      end
+
+      def cpd_import_participants(participants: [])
+        authenticated_post "cpd_importParticipants", [participants]
+      end
+
+      def delete_group(survey_id: , group_id: )
+        authenticated_post "delete_group", [survey_id, group_id]
+      end
+
+      def delete_language(survey_id: , language: )
+        authenticated_post "delete_language", [survey_id, language]
+      end
+
+      def delete_participants(survey_id: , participants: [])
+        authenticated_post "delete_participants", [survey_id, participants]
+      end
+
+      def delete_question(question_id: )
+        authenticated_post "delete_question", [question_id]
+      end
+
+      def delete_survey(survey_id: )
+        authenticated_post "delete_survey", [survey_id]
+      end
+
+      # document types:  pdf, csv, xls, doc, json-rpc
+      def export_responses(survey_id: , document_type: 'json', language_code: 'en', completion_status: 'complete', heading_type: nil, response_type: nil, from_response_id: 0, to_response_id: 1_000_000, fields: nil)
+        authenticated_post "export_responses", [survey_id, document_type, language_code, completion_status, heading_type, response_type, from_response_id, to_response_id, fields]
+      end
+
+      def export_responses_by_token(survey_id: , document_type: 'json', token: , language_code: 'en', completion_status: 'all', heading_type: 'code', response_type: 'long', fields: nil)
+        authenticated_post "export_responses_by_token", [survey_id, document_type, token, language_code, completion_status, heading_type, response_type, fields]
+      end
+
+      def export_statistics(survey_id: , document_type: , token: , language_code: , graph: 'no', group_ids: nil)
+        authenticated_post "export_statistics", [survey_id, document_type, token, language_code, graph, group_ids]
+      end
+
+      def export_timeline(survey_id: , survey_type: 'day', start_time: , end_time: )
+        authenticated_post "export_timeline", [survey_id, survey_type, start_time, end_time]
+      end
+
+      def get_group_properties(group_id: , group_settings: [])
+        authenticated_post "get_group_properties", [group_id, group_settings]
+      end
+
+      def get_language_properties(survey_id: , survey_locale_settings: nil, language: nil)
+        authenticated_post "get_language_properties", [survey_id, survey_locale_settings, language]
+      end
+
+      def get_participant_properties(survey_id: , token_query_properties: nil, token_properties: nil)
+        authenticated_post "get_participant_properties", [survey_id, token_query_properties, token_properties]
+      end
+
+      def get_question_properties(question_id: , question_settings: [], language: nil)
+        authenticated_post "get_question_properties", [question_id, question_settings, language]
+      end
+
+      def get_response_ids(survey_id: , token:  )
+        authenticated_post "get_response_ids", [survey_id, token]
+      end
+
+      def get_session_key
+        response = post "get_session_key", [username, password]
+      end
+
+      def get_site_settings(setting_name: )
+        authenticated_post "get_site_settings", [setting_name]
+      end
+
+      def get_summary(survey_id: , stat_name: nil)
+        authenticated_post "get_summary", [survey_id, stat_name].compact
+      end
+
+      def get_survey_properties(survey_id: , survey_settings: nil)
+        authenticated_post "get_survey_properties", [survey_id, survey_settings].compact
+      end
+
+      def get_uploaded_files(survey_id: , token:  )
+        authenticated_post "get_uploaded_files", [survey_id, token]
+      end
+
+      def import_group(survey_id: , import_data: , import_data_type: , new_group_name: nil, new_group_description: nil)
+        authenticated_post "import_group", [survey_id, import_data, import_data_type, new_group_name, new_group_description]
+      end
+
+      def import_question(survey_id: , group_id: , import_data: , import_data_type: , mandatory: 'no', new_question_title: nil, new_q_question: nil, new_question_help: nil)
+        authenticated_post "import_question", [survey_id, group_id, import_data, import_data_type, mandatory, new_question_title, new_q_question, new_question_help]
+      end
+
+      def import_survey(import_data: , import_data_type: , new_survey_name: nil, destination_survey_id: nil)
+        authenticated_post "import_survey", [import_data, import_data_type, new_survey_name, destination_survey_id]
+      end
+      # email: TRUE / FALSE
+      def invite_participants(survey_id: , token_ids: [], email: )
+        authenticated_post "invite_participants", [survey_id, token_ids, email]
+      end
+
+      def list_groups(survey_id: )
+        authenticated_post "list_groups", [survey_id]
+      end
+
+      def list_participants(survey_id: , start: 0, limit: 10_000, unused: false, attributes: [], conditions: [])
+        authenticated_post "list_participants", [survey_id, start, limit, unused, attributes, conditions]
+      end
+
+      def list_questions(survey_id: , group_id: nil, language: nil)
+        authenticated_post "list_questions", [survey_id, group_id, language]
+      end
+
+      # LimeSurvey::Api.new.list_surveys
+      def list_surveys(username: nil)
+        authenticated_post "list_surveys", [username].compact
+      end
+
+      def list_users(user_id: nil)
+        authenticated_post "list_users", [user_id].compact
+      end
+
+      def mail_registered_participants(survey_id: , override_all_conditions: [])
+        authenticated_post "mail_registered_participants", [survey_id, override_all_conditions]
+      end
+
+      def release_session_key
+        authenticated_post "release_session_key"
+        @token = nil
+      end
+
+      def remind_participants(survey_id: , min_days_between: nil, max_reminders: nil, token_ids: nil)
+        authenticated_post "remind_participants", [survey_id, min_days_between, max_reminders, token_ids]
+      end
+
+      def set_group_properties(group_id: , group_data: [])
+        authenticated_post "set_group_properties", [group_id, group_data]
+      end
+
+      def set_language_properties(survey_id: , survey_locale_data: [], language: nil)
+        authenticated_post "set_language_properties", [survey_id, survey_locale_data, language]
+      end
+
+      def set_participant_properties(survey_id: , token_query_properties: , token_data: )
+        authenticated_post "set_participant_properties", [survey_id, token_query_properties, token_data]
+      end
+
+      def set_question_properties(question_id: , question_data: , language: )
+        authenticated_post "set_question_properties", [question_id, question_data, language]
+      end
+
+      def set_quota_properties(quota_id: , quota_data: )
+        authenticated_post "set_quota_properties", [quota_id, quota_data]
+      end
+
+      def set_survey_properties(survey_id: , survey_data: )
+        authenticated_post "set_survey_properties", [survey_id, suvey_data]
+      end
+
+      def update_response(survey_id: , response_data: )
+        authenticated_post "update_response", [survey_id, response_data]
+      end
+
+      #file_data is BASE64
+      def upload_file(survey_id: , field_name: , file_name: , file_data: )
+        authenticated_post "upload_file", params
+      end
+
+
+      def authenticated_post(method_name, params = [])
+        check_authentication
+        post method_name, params
+      end
+
+      def post(method_name, params = [])
+        response = self.class.post(URL_ENDPOINT, body: modify_body(method_name, params), timeout: 60, headers: headers)
+        OpenStruct.new body: JSON::parse(response.body), request: response.request, code: response.code
+      end
+
+      def check_authentication
+        if token
+          return self
+        else
+          authenticate!
+        end
+      end
+
+      private
+
+
+      def authenticate!
+        response = get_session_key
+        raise AuthenticationError.new(response.body.dig("result", "status")) if response.body.dig("result").is_a?(Hash) && response.body.dig("result", "status") == "Invalid user name or password"
+        @token = response.body.dig("result")
+        response
+      end
+
+      def argument_cleaner(required_params: , optional_params: , options: )
+        missing_required = required_params - options.map {|k,v| k.to_sym }
+        raise ArgumentError.new("Missing Required Arguments: #{missing_required.join(', ')}") if missing_required.any?
+        all_params = (required_params + optional_params).flatten
+        return options.select {|k,v| all_params.include?(k.to_sym)}
+      end
+
+      def modify_body(method_name, params = [])
+
+        default_params = {
+          method: method_name,
+          params: params,
+          id: 'json-rpc'
+        }
+
+        default_params[:params] = [token] + params if token
+        default_params.to_json
+      end
+
+
+      def headers
+        @headers = {
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+          "Connection" => "Keep-Alive",
+        }
+      end
+
+      def default_username
+        ENV["LIMESURVEY_USERNAME"]
+      end
+
+      def default_password
+        ENV["LIMESURVEY_PASSWORD"]
+      end
+
+      def default_base_url
+        ENV["LIMESURVEY_BASE_URL"]
+      end
+
+  end
+end
+
+# api_method = 'get_session_key'
+
+

data/lib/lime_survey/version.rb

@@ -0,0 +1,3 @@
+module LimeSurvey
+  VERSION = "0.10.0"
+end

data/lib/lime_survey.rb

@@ -0,0 +1,16 @@
+# require "active_support/all"
+require "httparty"
+require "ostruct"
+
+require "lime_survey/api"
+require "lime_survey/version"
+
+
+module LimeSurvey
+  class Api::AuthenticationError < StandardError
+    def initialize(msg="Could not Authenticate")
+      super
+    end
+  end
+end
+

data/lime_survey.gemspec

@@ -0,0 +1,50 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lime_survey/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lime_survey"
+  spec.version       = LimeSurvey::VERSION
+  spec.authors       = ["Ben Eggett"]
+  spec.email         = ["beneggett@gmail.com"]
+
+  spec.summary       = %q{LimeSurvey API wrapper}
+  spec.description   = %q{Fully implements LimeSurvey API}
+  spec.homepage      = "https://github.com/beneggett/lime_survey"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  # spec.add_development_dependency "guard"
+  # spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "dotenv"
+  spec.add_dependency "httparty", ">= 0.14.0"
+  # spec.add_dependency "activesupport"
+  spec.add_dependency "builder"
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: lime_survey
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Ben Eggett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fully implements LimeSurvey API
+email:
+- beneggett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".env.sample"
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lime_survey.rb
+- lib/lime_survey/api.rb
+- lib/lime_survey/version.rb
+- lime_survey.gemspec
+homepage: https://github.com/beneggett/lime_survey
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: LimeSurvey API wrapper
+test_files: []