limeade 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32583152633d904c31c68e00648525e8d9f85765f978d82a43fc0eeb2f24b8a
-  data.tar.gz: 5d3dc02334d0bfa704f64597ccfa81b537b04c6926452593925987422cba1c84
+  metadata.gz: bb14f9082aa25256534bdfe452342afa8e85c91f6865af7018ba29ba1bec0da6
+  data.tar.gz: 1eb9ce140d18269679297942b43eebc05999262f04b1e8458fc434b48370fa1c
 SHA512:
-  metadata.gz: dd211d93790439cfbdf9e8c609956769139a56cdcfc76f61fb9c55b0ccf6207cedd4e56a443d12bccfdc8fbfc391e15dae65028ddd7e662a42ebf96dd9d14d2c
-  data.tar.gz: e4f9efeff8dced2acf1ad56e1d74376a6fb4249acb17aa3c088e9f20cd5847eee711e53711cf75e1fa8ac0007d674998628e1c45b68a1b7404c74cfec3921c3c
+  metadata.gz: '06690414adef52692099da672515d777a452f7e6cf2b1cd4e5bd6f81c4e92e09b9dc0725a5408c6474427be1c26c5726ccce931667ac0f8ccc81a24e111c6ff8'
+  data.tar.gz: e1e0b2bce2473578c58d1e72c0f461d2b044fbc673ac08c435c2a36b739784d9e098e27bc77e53f1007146494e3c2b9cab44372dce07880d3ad2600f204a4c9e

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,6 @@
-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.
@@ -67,25 +63,73 @@ module Limeade
       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
+    # Define a LimeSurvey RemoteControl API method call.
     #
-    # @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
+    # @param ruby_method [Symbol] the name of the ruby method to define
+    # @param rpc_method [Symbol, String] the name of the JSON RPC method to call
+    # @!macro [attach] define_api_method
+    #   @method $1
+    #   Invoke the +${-1}+ JSON RPC method on the given endpoint.
     #
-    # @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
+    #   @see https://api.limesurvey.org/classes/remotecontrol_handle.html#method_${-1}
+    #   @param [variable] *arguments see LimeSurvey documentation
+    #   @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 self.define_api_method(ruby_method, rpc_method = ruby_method)
+      define_method(ruby_method) do |*arguments|
+        process_request(rpc_method, *arguments)
       end
     end
 
-    def respond_to_missing?(method_name, include_private = false)
-      API_METHODS.include?(method_name) || super
-    end
+    define_api_method :activate_survey
+    define_api_method :activate_tokens
+    define_api_method :add_group
+    define_api_method :add_language
+    define_api_method :add_participants
+    define_api_method :add_response
+    define_api_method :add_survey
+    define_api_method :copy_survey
+    define_api_method :cpd_importParticipants
+    define_api_method :delete_group
+    define_api_method :delete_language
+    define_api_method :delete_participants
+    define_api_method :delete_question
+    define_api_method :delete_survey
+    define_api_method :export_responses
+    define_api_method :export_responses_by_token
+    define_api_method :export_statistics
+    define_api_method :export_timeline
+    define_api_method :get_group_properties
+    define_api_method :get_language_properties
+    define_api_method :get_participant_properties
+    define_api_method :get_question_properties
+    define_api_method :get_response_ids
+    define_api_method :get_session_key
+    define_api_method :get_site_settings
+    define_api_method :get_summary
+    define_api_method :get_survey_properties
+    define_api_method :get_uploaded_files
+    define_api_method :import_group
+    define_api_method :import_question
+    define_api_method :import_survey
+    define_api_method :invite_participants
+    define_api_method :list_groups
+    define_api_method :list_participants
+    define_api_method :list_questions
+    define_api_method :list_surveys
+    define_api_method :list_users
+    define_api_method :mail_registered_participants
+    define_api_method :release_session_key
+    define_api_method :remind_participants
+    define_api_method :set_group_properties
+    define_api_method :set_language_properties
+    define_api_method :set_participant_properties
+    define_api_method :set_question_properties
+    define_api_method :set_quota_properties
+    define_api_method :set_survey_properties
+    define_api_method :update_response
+    define_api_method :upload_file
 
     private
 
@@ -100,7 +144,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 +152,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 +199,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/version.rb

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

data/limeade.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '>= 0.12.0'
+  spec.add_runtime_dependency 'faraday', '>= 0.12.0', '< 2.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.13'
 
   spec.add_development_dependency 'bundler', '>= 1.17', '< 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limeade
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - David Pellegrini
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +116,6 @@ files:
 - 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
@@ -119,11 +124,11 @@ 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.3
   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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +143,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A Ruby interface to the LimeSurvey API.
 test_files: []

data/lib/limeade/methods.rb

@@ -1,53 +0,0 @@
-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