limeade 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c32583152633d904c31c68e00648525e8d9f85765f978d82a43fc0eeb2f24b8a
-  data.tar.gz: 5d3dc02334d0bfa704f64597ccfa81b537b04c6926452593925987422cba1c84
+SHA1:
+  metadata.gz: 3ee2d420faf14714fd02821cc10675bde3faf0a9
+  data.tar.gz: a4a9ff39e5955422972da6374c790bcc57229d78
 SHA512:
-  metadata.gz: dd211d93790439cfbdf9e8c609956769139a56cdcfc76f61fb9c55b0ccf6207cedd4e56a443d12bccfdc8fbfc391e15dae65028ddd7e662a42ebf96dd9d14d2c
-  data.tar.gz: e4f9efeff8dced2acf1ad56e1d74376a6fb4249acb17aa3c088e9f20cd5847eee711e53711cf75e1fa8ac0007d674998628e1c45b68a1b7404c74cfec3921c3c
+  metadata.gz: 495c68105ebcf8dcb3a9e0645cd985906347841958e0f20d9f9c6257ef9fecf983a5c90d7232a9dac2b66acacd0258efbb0c7ebea4f5b4abfd3846ca230133f8
+  data.tar.gz: c94203f90122ee29c86224e0912f9353a7339e84d128fc71855b5fcde5b43b37a50b2f5548d4c46e4b0f1430a15c16b8b47c87638f59bae44565071fa967ec7e

data/README.md

@@ -42,7 +42,10 @@ 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).
+ [here](https://api.limesurvey.org/classes/remotecontrol_handle.html). Do not specify the
+ `$sSessionKey`, as it is added as the first argument automatically. (Recall that the session is
+ managed for you transparently.)
+ 
 
 ```ruby
 client = Limeade::Client.new(api_uri, username, password)

data/lib/limeade/client.rb

@@ -1,10 +1,8 @@
 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.
@@ -100,7 +98,7 @@ module Limeade
     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']
+      if result.is_a?(Hash) && result['status']
         case result['status']
         when 'OK'
           true
@@ -108,6 +106,8 @@ module Limeade
           []
         when 'No Tokens found'
           []
+        when 'No survey participants table'
+          false
         when /(left to send)|(No candidate tokens)$/
           result
         when /Invalid surveyid$/i
@@ -153,5 +153,4 @@ module Limeade
 
   # Private exception raised only in the context of #process_request.
   class NoSessionError < Error; end
-
 end

data/lib/limeade/errors.rb

@@ -1,5 +1,6 @@
-module Limeade
+# frozen_string_literal: true
 
+module Limeade
   class Error < StandardError; end
 
   class InvalidResponseError < Error; end
@@ -27,5 +28,4 @@ module Limeade
       super("LimeSurvey API '#{method}' returned a failure status: #{status}")
     end
   end
-
 end

data/lib/limeade/json_rpc.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 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
+    JSON_RPC_VERSION = '1.0'
 
     #
     # Instantiate a client and setup a connection to the endpoint.
@@ -69,7 +69,7 @@ module Limeade
 
     private
 
-    STANDARD_HEADERS = {content_type: 'application/json'}.freeze
+    STANDARD_HEADERS = { content_type: 'application/json' }.freeze
 
     def connection
       @connection ||= ::Faraday.new do |connection|
@@ -84,6 +84,7 @@ module Limeade
       payload = payload_from(response)
       verify_payload(payload, request_id)
       raise ServerError.new(payload['error']['code'], payload['error']['message']) if payload['error']
+
       payload['result']
     end
 
@@ -97,30 +98,29 @@ module Limeade
     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'))
+      raise(InvalidResponseError, 'Response body is missing the id') unless payload.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.key?('error') && payload.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 is missing the code') unless error.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 is missing the message') unless error.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
+    rescue StandardError => e
       Limeade.logger.info "Failed to parse JSON from:\n#{response.body}"
-      raise InvalidResponseError, parsing_error.message
+      raise InvalidResponseError, e.message
     end
 
     def make_id
       rand(10**12)
     end
-
   end
 end

data/lib/limeade/methods.rb

@@ -1,53 +1,55 @@
+# frozen_string_literal: true
+
 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
+  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

@@ -1,3 +1,3 @@
 module Limeade
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limeade
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Pellegrini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -119,7 +119,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/spokesoftware/limeade
-  documentation_uri: https://www.rubydoc.info/gems/limeade/0.1.1
+  documentation_uri: https://www.rubydoc.info/gems/limeade/0.1.2
   bug_tracker_uri: https://github.com/spokesoftware/limeade/issues
   source_code_uri: https://github.com/spokesoftware/limeade
   changelog_uri: https://github.com/spokesoftware/limeade/releases
@@ -138,7 +138,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Ruby interface to the LimeSurvey API.