limeade 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dde82df533a775a40556b8dbb81994c0105024765909b76755d8c8328a9c6fc3
+  data.tar.gz: df433be9bbaca0e38f8c253dd919987f34d616c58072e08b8edb6b0a13ea11ca
+SHA512:
+  metadata.gz: 793c66ca4da4fc38230b7b115d5dd353a31b5cd3e6a3fac98dd974cb945304847f946c322a0748c2cad1a95131c7547ea289ca6d9a76e10c51b15491c9116369
+  data.tar.gz: c5c692cf20af911dacdd44a3701a68a0c2d09d7836cb6a0c8e8ebfea473646c67eca7705c4f5bf7db5bf160a9f085327a42d01c2344b640521567bb5cdd7e37d

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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 david.pellegrini@spokesoftware.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in limeade.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 David Pellegrini
+
+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,122 @@
+# Limeade
+
+Ruby interface to the LimeSurvey RemoteControl 2 API
+
+LimeSurvey provides an API for accessing and managing surveys. The current version is RemoteControl 2.
+It is exposed as a XML-RPC/JSON-RPC based web service. This gem accesses using JSON-RPC.
+
+The goal of this gem is to access the API in a manner that is natural to rubyists. The API is defined in
+terms of methods and arguments. That's easy to mimic in Ruby by means of `#method_missing`. Thus, call any
+of the API's methods on the Limeade client itself!
+
+This gem handles the API session transparently so you don't have to even think about it.
+
+> __Note__ that before using the LimeSurvey RemoteControl API you need to activate it for your account. 
+See [the manual](https://manual.limesurvey.org/RemoteControl_2_API#How_to_configure_LSRC2) for 
+instructions on how to do this. Be sure to choose the **JSON-RPC** option.
+
+> __Note__ also that you must activate a survey in order for it to be visible via the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'limeade'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limeade
+
+## Usage
+
+Start by requiring limeade into your code.
+
+``` ruby
+require 'limeade'
+```
+
+Instantiate a client and start invoking API methods on it. The API methods are documented
+ [here](https://api.limesurvey.org/classes/remotecontrol_handle.html).
+
+```ruby
+client = Limeade::Client.new(api_uri, username, password)
+surveys = client.list_surveys
+summary = client.get_summary(surveys.first['sid'])
+```
+
+You'll probably want to get `api_uri`, `username`, and `password` from environment variables.
+
+The responses from the API are parsed from JSON into Ruby objects. Bear in mind that `Hash` keys are
+ going to be `String`.
+
+When you are done accessing the API, it is polite to disconnect.
+```ruby
+client.disconnect
+```
+
+### Retry Mechanism
+
+Not every network call goes as planned. Limeade uses the underlying Faraday gem for handling the
+transport. Faraday has a retry mechanism,
+[Faraday::Request::Retry](https://www.rubydoc.info/gems/faraday/0.9.2/Faraday/Request/Retry). Its
+behavior is configurable via
+[options](https://www.rubydoc.info/gems/faraday/0.9.2/Faraday/Request/Retry:initialize) offering a
+high degree of control. These same options may be passed when instantiating `Limeade::Client`.
+
+```ruby
+client = Limeade::Client.new(api_uri, username, password, max: 5, interval: 1.5)
+```
+
+View the `Limeade::Client` documentation for details.
+
+### Logging
+
+The gem defines a logger for its own use. Access it via `Limeade.logger`. Change logging
+level like so `Limeade.logger.level = Logger::WARN`
+
+You can substitute your own logger to consolidate logging throughout your app:
+```ruby
+Limeade.logger = my_apps_logger
+```
+ 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+The specs rely on API location and credentials being defined as environment variables. Edit `bin/env.sh`
+for your situation, then execute it.
+
+    $ source bin/env.sh
+
+Then run the tests.
+
+    $ bundle exec rake spec
+
+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/spokesoftware/limeade. 
+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).  
+Copyright 2019 David Pellegrini and Spoke Software, Inc.
+
+## Code of Conduct
+
+Everyone interacting in the Limeade project’s codebases, issue trackers, chat rooms and mailing lists is
+expected to follow the [code of conduct](https://github.com/spokesoftware/limeade/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'limeade'
+
+# 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/env.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+# The spec suite connects to the LimeSurvey RemoteControl API. If you intend to run the
+# specs, update this script with values specific to your situation. Then source this script
+# to set up your environment prior to running the specs.
+# Note that the specs test accessing a survey by id. Kindly provide that id below. If
+# necessary, create a dummy survey for this purpose. It only has to exist and be activated.
+
+# If you are not going to run the specs, you can skip this.
+
+echo "Setting LimeSurvey API auth"
+
+LIMESURVEY_ENDPOINT="https://<your_domain>.limequery.com/admin/remotecontrol"
+LIMESURVEY_ACCOUNT="margarita"
+LIMESURVEY_PASSWORD="sooper_seekrit"
+LIMESURVEY_SURVEY_ID=<the id of one of your surveys>
+
+export LIMESURVEY_ENDPOINT
+export LIMESURVEY_ACCOUNT
+export LIMESURVEY_PASSWORD
+export LIMESURVEY_SURVEY_ID

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/limeade/client.rb

@@ -0,0 +1,157 @@
+require 'limeade/methods'
+
+module Limeade
+
+  # Client for accessing the LimeSurvey RemoteControl API from Ruby.
+  class Client
+
+    #
+    # Instantiate a client and setup a connection to the LimeSurvey RemoteControl API.
+    # Passes configuration for the Faraday::Request::Retry mechanism.
+    # @see Faraday::Request::Retry
+    #
+    # @param endpoint [String] The URI for your account's API.
+    # @param username [String] The username for your account.
+    # @param password [String] The password for your account.
+    # @param retry_options [Hash] The options for Faraday::Request::Retry.
+    # @option retry_options [Integer] :max (2) Maximum number of retries.
+    # @option retry_options [Float] :interval (0) Pause in seconds between retries.
+    # @option retry_options [Float] :interval_randomness (0) The maximum random interval amount
+    #   expressed as a float between 0 and 1 to use in addition to the interval.
+    # @option retry_options [Float] :max_interval (Float::MAX) An upper limit for the interval.
+    # @option retry_options [Float] :backoff_factor (1) The amount to multiply each successive
+    #   retry's interval amount by in order to provide backoff.
+    # @option retry_options [Array<Error, String>] :exceptions ([Errno::ETIMEDOUT, 'Timeout::Error',
+    #   Error::TimeoutError, Faraday::Error::RetriableResponse]) The list of exceptions
+    #   to handle. Exceptions can be given as Class, Module, or String.
+    # @option retry_options [Array<Symbol>] :methods (Faraday::Request::Retry::IDEMPOTENT_METHODS)
+    #   A list of HTTP methods to retry without calling retry_if.  Pass an empty Array to call
+    #   retry_if for all exceptions.
+    # @option retry_options [Proc] :retry_if (return false) Block that will receive the env object
+    #   and the exception raised and decides whether to retry regardless of the retry count.
+    #   This would be useful if the exception produced is non-recoverable or if the the HTTP method
+    #   called is not idempotent.
+    # @option retry_options [Proc] :retry_block Block that is executed after every retry. Request
+    #   environment, middleware options, current number of retries and the exception are passed to
+    #   the block as parameters.
+    #
+    # @raise [InvalidCredentialsError] The username and password combination is not valid.
+    # @raise [ServerError] The API endpoint server is having issues. An error code and message are
+    #   included.
+    # @raise [InvalidResponseError] The API endpoint is returning malformed JSON RPC responses.
+    #   A descriptive message details the problem.
+    # @raise [URI::InvalidURIError] The API endpoint URI is not valid.
+    def initialize(endpoint, username, password, retry_options = {})
+      @json_rpc = Limeade::JSON_RPC.new(endpoint, retry_options)
+      @username = username
+      @password = password
+      @session_key = get_session_key
+    end
+
+    # Is the client ready to send requests to the endpoint?
+    # @return [Boolean] true if the client is ready; false otherwise.
+    def connected?
+      @session_key && @json_rpc
+    end
+
+    # Release resources for this client locally and at the endpoint.
+    # @return [Boolean] true if the resources were released; false if client has already disconnected.
+    def disconnect
+      if connected?
+        release_session_key
+        @json_rpc = nil
+        @session_key = nil
+        true
+      else
+        false
+      end
+    end
+
+    # Handle LimeSurvey RemoteControl API calls invoked on the client by invoking them on the endpoint.
+    # @param method [Symbol] the method invoked
+    # @param arguments [Array] the arguments to the method
+    #
+    # @raise [ServerError] The API endpoint server is having issues. An error code and message are included.
+    # @raise [InvalidResponseError] The API endpoint is returning malformed JSON RPC responses. A descriptive message
+    #
+    # @return [Object] the result of invoking the method on the endpoint
+    def method_missing(method, *arguments)
+      if API_METHODS.include? method
+        process_request(method, *arguments)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      API_METHODS.include?(method_name) || super
+    end
+
+    private
+
+    # Send an LimeSurvey RemoteControl API call to the endpoint and handle the response.
+    # @param method [Symbol] the method invoked
+    # @param arguments [Array] the arguments to the method
+    #
+    # @raise [ServerError] The API endpoint server is having issues. An error code and message are included.
+    # @raise [InvalidResponseError] The API endpoint is returning malformed JSON RPC responses. A descriptive message
+    #
+    # @return [Object] the result of invoking the method on the endpoint
+    def process_request(method_name, *arguments)
+      raise DisconnectedError unless connected?
+      result = @json_rpc.invoke(method_name, @session_key, *arguments)
+      if result.is_a? Hash and result['status']
+        case result['status']
+        when 'OK'
+          true
+        when 'No surveys found'
+          []
+        when 'No Tokens found'
+          []
+        when /(left to send)|(No candidate tokens)$/
+          result
+        when /Invalid surveyid$/i
+          nil
+        when /Invalid session key$/i
+          raise NoSessionError
+        else
+          raise APIError.new(method_name, result['status'])
+        end
+      else
+        result
+      end
+    rescue NoSessionError
+      # Get a fresh session and retry the call.
+      @session_key = get_session_key
+      retry
+    end
+
+    # Get a session key from the endpoint
+    #
+    # @raise [InvalidCredentialsError] The username and password combination is not valid.
+    # @raise [ServerError] The API endpoint server is having issues. An error code and message are included.
+    # @raise [InvalidResponseError] The API endpoint is returning malformed JSON RPC responses. A descriptive message
+    #   details the problem.
+    #
+    # @return [String] the session key
+    def get_session_key
+      response = @json_rpc.invoke(:get_session_key, @username, @password)
+      raise(InvalidCredentialsError, (response['status'] || response.inspect)) if response.is_a?(Hash)
+      response
+    end
+
+    # Release a session key on the endpoint
+    #
+    # @raise [ServerError] The API endpoint server is having issues. An error code and message are included.
+    # @raise [InvalidResponseError] The API endpoint is returning malformed JSON RPC responses. A descriptive message
+    #
+    # @return [String] "OK"
+    def release_session_key
+      @json_rpc.invoke(:release_session_key, @session_key)
+    end
+  end
+
+  # Private exception raised only in the context of #process_request.
+  class NoSessionError < Error; end
+
+end

data/lib/limeade/errors.rb

@@ -0,0 +1,31 @@
+module Limeade
+
+  class Error < StandardError; end
+
+  class InvalidResponseError < Error; end
+
+  class InvalidCredentialsError < Error; end
+
+  class DisconnectedError < Error
+    def initialize
+      super('Attempting to use a disconnected client to the LimeSurvey API')
+    end
+  end
+
+  class ServerError < Error
+    attr_reader :code, :response_error
+
+    def initialize(code, message)
+      @code = code
+      @response_error = message
+      super("Server error #{code}: #{message}")
+    end
+  end
+
+  class APIError < Error
+    def initialize(method, status)
+      super("LimeSurvey API '#{method}' returned a failure status: #{status}")
+    end
+  end
+
+end

data/lib/limeade/json_rpc.rb

@@ -0,0 +1,126 @@
+require 'faraday'
+require 'multi_json'
+
+module Limeade
+
+  # An implementation of JSON RPC version 1. This is inspired by jsonrpc-client, which implements
+  # version 2 of the spec. This implementation adds retry capability via Faraday::Request::Retry.
+
+  class JSON_RPC
+
+    JSON_RPC_VERSION = '1.0'.freeze
+
+    #
+    # Instantiate a client and setup a connection to the endpoint.
+    # Passes configuration for the Faraday::Request::Retry mechanism.
+    # @see Faraday::Request::Retry
+    #
+    # @param retry_options [Hash] The options for Faraday::Request::Retry.
+    # @option retry_options [Integer] :max (2) Maximum number of retries.
+    # @option retry_options [Float] :interval (0) Pause in seconds between retries.
+    # @option retry_options [Float] :interval_randomness (0) The maximum random interval amount
+    #   expressed as a float between 0 and 1 to use in addition to the interval.
+    # @option retry_options [Float] :max_interval (Float::MAX) An upper limit for the interval.
+    # @option retry_options [Float] :backoff_factor (1) The amount to multiply each successive
+    #   retry's interval amount by in order to provide backoff.
+    # @option retry_options [Array<Error, String>] :exceptions ([Errno::ETIMEDOUT, 'Timeout::Error',
+    #   Error::TimeoutError, Faraday::Error::RetriableResponse]) The list of exceptions
+    #   to handle. Exceptions can be given as Class, Module, or String.
+    # @option retry_options [Array<Symbol>] :methods (Faraday::Request::Retry::IDEMPOTENT_METHODS)
+    #   A list of HTTP methods to retry without calling retry_if.  Pass an empty Array to call
+    #   retry_if for all exceptions.
+    # @option retry_options [Proc] :retry_if (return false) Block that will receive the env object
+    #   and the exception raised and decides whether to retry regardless of the retry count.
+    #   This would be useful if the exception produced is non-recoverable or if the the HTTP method
+    #   called is not idempotent.
+    # @option retry_options [Proc] :retry_block Block that is executed after every retry. Request
+    #   environment, middleware options, current number of retries and the exception are passed to
+    #   the block as parameters.
+    #
+    # @raise [ServerError] The API endpoint server is having issues. An error code and message are
+    #   included.
+    # @raise [InvalidResponseError] The API endpoint is returning malformed JSON RPC responses.
+    #   A descriptive message details the problem.
+    # @raise [URI::InvalidURIError] The API endpoint URI is not valid.
+    def initialize(endpoint, retry_options = {})
+      @uri = ::URI.parse(endpoint).to_s     # Ensure that endpoint is a valid URI
+      @retry_options = retry_options || {}  # Ensure not nil
+    end
+
+    # Send the request with the specified method and arguments
+    # @param method [Symbol] the method to invoke
+    # @param args [Array] the arguments to the method
+    # @return the results of the call
+    def invoke(method, *args)
+      Limeade.logger.debug "invoke(#{method}, #{args.inspect})"
+      request_id = make_id
+      post_data = ::MultiJson.encode({
+                                         'jsonrpc' => JSON_RPC_VERSION,
+                                         'method'  => method,
+                                         'params'  => args,
+                                         'id'      => request_id
+                                     })
+      response = connection.post(@uri, post_data, STANDARD_HEADERS)
+
+      Limeade.logger.debug "API response: #{response.inspect}"
+
+      process_response(response, request_id)
+    end
+
+    private
+
+    STANDARD_HEADERS = {content_type: 'application/json'}.freeze
+
+    def connection
+      @connection ||= ::Faraday.new do |connection|
+        connection.request :retry, @retry_options
+        connection.response :logger, Limeade.logger
+        connection.adapter ::Faraday.default_adapter
+      end
+    end
+
+    def process_response(response, request_id)
+      verify_response(response)
+      payload = payload_from(response)
+      verify_payload(payload, request_id)
+      raise ServerError.new(payload['error']['code'], payload['error']['message']) if payload['error']
+      payload['result']
+    end
+
+    def verify_response(response)
+      Limeade.logger.debug "verify_response: #{response.inspect}"
+      raise(InvalidResponseError, 'Response is nil') if response.nil?
+      raise(InvalidResponseError, 'Response body is nil') if response.body.nil?
+      raise(InvalidResponseError, 'Response body is empty') if response.body.empty?
+    end
+
+    def verify_payload(payload, request_id)
+      Limeade.logger.debug "verify_payload: #{payload.inspect}"
+      raise(InvalidResponseError, 'Response body is not a Hash') unless payload.is_a?(::Hash)
+      raise(InvalidResponseError, 'Response body is missing the id') unless payload.has_key?('id')
+      raise(InvalidResponseError, "Response id (#{payload['id']}) does not match request id (#{request_id})") unless (payload['id'] == request_id)
+      raise(InvalidResponseError, 'Response body must have a result and an error') unless (payload.has_key?('error') && payload.has_key?('result'))
+
+      if payload['error']
+        error = payload['error']
+        raise(InvalidResponseError, 'Response error is not a Hash') unless error.is_a?(::Hash)
+        raise(InvalidResponseError, 'Response error is missing the code') unless error.has_key?('code')
+        raise(InvalidResponseError, 'Response error code is not a number') unless error['code'].is_a?(::Integer)
+        raise(InvalidResponseError, 'Response error is missing the message') unless error.has_key?('message')
+        raise(InvalidResponseError, 'Response error message is not a string') unless error['message'].is_a?(::String)
+      end
+    end
+
+    def payload_from(response)
+      ::MultiJson.decode(response.body)
+    rescue => parsing_error
+      Limeade.logger.info "Failed to parse JSON from:\n#{response.body}"
+      raise InvalidResponseError, parsing_error.message
+    end
+
+    def make_id
+      rand(10**12)
+    end
+
+  end
+end

data/lib/limeade/methods.rb

@@ -0,0 +1,53 @@
+module Limeade
+  API_METHODS = (<<_API_METHODS
+activate_survey
+activate_tokens
+add_group
+add_language
+add_participants
+add_response
+add_survey
+copy_survey
+cpd_importParticipants
+delete_group
+delete_language
+delete_participants
+delete_question
+delete_survey
+export_responses
+export_responses_by_token
+export_statistics
+export_timeline
+get_group_properties
+get_language_properties
+get_participant_properties
+get_question_properties
+get_response_ids
+get_session_key
+get_site_settings
+get_summary
+get_survey_properties
+get_uploaded_files
+import_group
+import_question
+import_survey
+invite_participants
+list_groups
+list_participants
+list_questions
+list_surveys
+list_users
+mail_registered_participants
+release_session_key
+remind_participants
+set_group_properties
+set_language_properties
+set_participant_properties
+set_question_properties
+set_quota_properties
+set_survey_properties
+update_response
+upload_file
+_API_METHODS
+  ).split("\n").map(&:to_sym).freeze
+end

data/lib/limeade/version.rb

@@ -0,0 +1,3 @@
+module Limeade
+  VERSION = '0.1.0'
+end

data/lib/limeade.rb

@@ -0,0 +1,17 @@
+require 'limeade/version'
+require 'limeade/errors'
+require 'limeade/client'
+require 'limeade/json_rpc'
+require 'logger'
+
+module Limeade
+
+  def self.logger
+    @logger ||= ::Logger.new($stdout)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+end

data/limeade.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'limeade/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'limeade'
+  spec.version       = Limeade::VERSION
+  spec.authors       = ['David Pellegrini']
+  spec.email         = ['david.pellegrini@spokesoftware.com']
+
+  spec.summary       = %q{A Ruby interface to the LimeSurvey API.}
+  spec.description   = %q{LimeSurvey exposes a JSON-RPC API for querying and managing surveys. This gem abstracts away the RPC calls and provides a friendly interface for Ruby clients.}
+  spec.homepage      = 'https://github.com/spokesoftware/limeade'
+  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'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/spokesoftware/limeade'
+    spec.metadata['changelog_uri'] = 'https://github.com/spokesoftware/limeade/releases'
+  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_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'multi_json'
+
+  spec.add_development_dependency 'bundler', '< 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: limeade
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Pellegrini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: LimeSurvey exposes a JSON-RPC API for querying and managing surveys.
+  This gem abstracts away the RPC calls and provides a friendly interface for Ruby
+  clients.
+email:
+- david.pellegrini@spokesoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/env.sh
+- bin/setup
+- lib/limeade.rb
+- lib/limeade/client.rb
+- lib/limeade/errors.rb
+- lib/limeade/json_rpc.rb
+- lib/limeade/methods.rb
+- lib/limeade/version.rb
+- limeade.gemspec
+homepage: https://github.com/spokesoftware/limeade
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/spokesoftware/limeade
+  source_code_uri: https://github.com/spokesoftware/limeade
+  changelog_uri: https://github.com/spokesoftware/limeade/releases
+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: A Ruby interface to the LimeSurvey API.
+test_files: []