roqua-rom-api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b5642304497ce4915b35dd98c38c742166385a9
-  data.tar.gz: a0a69d3b3677fcaa315f9840e3fddf20de52ffd0
+  metadata.gz: 1147f731426ba8d48888a09646f3860a6a8021e8
+  data.tar.gz: fedd0999ef1093c511d1ca9ac73d4f9c9cb7f727
 SHA512:
-  metadata.gz: ba9330f302f0060dc6bfc8163afc862e31d0e430326ed0cb6f4a7fc3de6498c6590fe30e02ba670f2116e8e62caafbc215c3779a3555650ed11082a6b4ee428e
-  data.tar.gz: 2c1ee8912c3a8b6eeec42ed9a60bb24c9fffc060fcf2a54a32b5ffbeeaaf3413036a1b5f0fe4b504bda8e6b2bd36edba25b17928620bcb4271f26660b0ed1729
+  metadata.gz: 09739ac4db79ec5d8df98bfb6c05257ee75d88cd012bbf713deb1ae062cab204ae335c43f5f357fb720aaf65823a66eae7200199b4d71138199cf048be9f9678
+  data.tar.gz: b93858850435d5b864b880bb1db32914fa8b7b2ea7da118ff70d04aa3b148b986bddc85f7f0d07c89ade78be9cb15c69d8617eaac65b2789b9ac37a2e9f5cb99

data/ChangeLog.md

@@ -1,5 +1,14 @@
 ### HEAD
 
+* Retrieve responses by response_ids.
+
+### 0.2.2 / 2014-12-15
+
+* Improve validation errors for protocol_subscriptions
+* Add API endpoint for retrieving questionnaires
+* Pass textvar and flag definitions of questionnaires
+* Pass textvars and flags of responses
+
 ### 0.2.1 / 2014-11-17
 
 * Add progress url to fill_out session api endpoint

data/README.md

@@ -2,7 +2,7 @@
 
 Make sure the following environment variables are defined:
 
-    ENV['ROM_HOST']             # URI of the RoQua application whose API you are targeting
+    ENV['ROM_SITE']             # URI of the RoQua application whose API you are targeting
     ENV['ROM_BASICAUTH_ID']     # username used for HTTP basic authentication on the RoQua API
     ENV['ROM_BASICAUTH_SECRET'] # password used for HTTP basic authentication on the RoQua API
 

data/config/locales/nl.yml

@@ -6,11 +6,19 @@ nl:
           attributes:
         roqua/rom_api/start_protocol_subscription:
           attributes:
+            start_at:
+              must_not_be_in_the_past: mag niet in het verleden liggen.
             base:
+              protocol_must_be_automatic: Het protocol is niet geautomatiseerd.
+              protocol_scheduler_options_invalid: Het protocol is verkeerd ingesteld.
+              patient_id_taken: Dit dossier is reeds geabonneerd op dit protocol.
               flag_does_not_exist: Een van de opgegeven vlaggen bestaat niet.
               flag_value_invalid: Een van de opgegeven vlaggen bevat een waarde anders dan true, false of nil.
-
+              text_message_template_blank: Er is geen SMS-template beschikbaar voor het protocol.
+              invitation_template_blank: Er is geen Email-template beschikbaar voor het protocol.
     attributes:
       roqua/rom_api/start_fill_out_session:
         questionnaire_keys: Vragenlijsten
         return_to: Return url
+      roqua/rom_api/start_protocol_subscription:
+        start_at: Startmoment

data/lib/roqua/rom_api/endpoint.rb

@@ -9,7 +9,11 @@ module Roqua
         if response.parsed_response.is_a?(Hash) && response['errors'].present?
           response['errors'].each do |attribute, attribute_errors|
             attribute_errors.each do |error|
-              errors.add attribute.to_sym, error.to_sym
+              if respond_to?(attribute.to_sym) || attribute.to_sym == :base
+                errors.add attribute.to_sym, error.to_sym
+              else
+                errors.add :base, [attribute, error].join('_').to_sym
+              end
             end
           end
         elsif response.code == 422

data/lib/roqua/rom_api/get_questionnaire.rb

@@ -0,0 +1,18 @@
+module Roqua
+  module RomApi
+    # @api private
+    class GetQuestionnaire < Endpoint
+      string  :questionnaire_key
+
+      def execute
+        validate_response_for do
+          RomApi.basic_auth_session.get "/questionnaires/#{questionnaire_key}"
+        end
+      end
+
+      def response_to_result(response)
+        Models::Questionnaire.new(response)
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/list_responses.rb

@@ -3,6 +3,7 @@ module Roqua
     # @api private
     class ListResponses < Endpoint
       string :dossier_id
+      array  :response_ids,             default: [] { string }
       array  :questionnaire_keys,       default: [] { string }
       time   :completed_before,         default: nil
       time   :completed_after,          default: nil
@@ -12,16 +13,21 @@ module Roqua
 
       def execute
         validate_response_for do
-          RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/responses",
-                                        respondent_type: respondent_type,
-                                        status: status,
-                                        questionnaire_keys: questionnaire_keys,
-                                        completed_after: completed_after,
-                                        completed_before: completed_before,
-                                        protocol_subscription_id: protocol_subscription_id
+          RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/responses", filter_params
         end
       end
 
+      def filter_params
+        {response_ids: response_ids,
+         respondent_type: respondent_type,
+         status: status,
+         questionnaire_keys: questionnaire_keys,
+         completed_after: completed_after,
+         completed_before: completed_before,
+         protocol_subscription_id: protocol_subscription_id
+        }.keep_if { |_k, v| v.present? }
+      end
+
       def response_to_result(response)
         response.map { |r| Models::Response.new(r) }
       end

data/lib/roqua/rom_api/models/questionnaire.rb

@@ -0,0 +1,21 @@
+require 'virtus'
+
+module Roqua
+  module RomApi
+    module Models
+      class Questionnaire
+        include Virtus.model
+
+        attribute :id, Integer
+        attribute :name, String
+        attribute :key, String
+        attribute :description, String
+        attribute :short_description, String
+        attribute :questions, Hash
+        attribute :scores, Hash
+        attribute :textvars, Hash
+        attribute :flags, Hash
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/models/response.rb

@@ -18,6 +18,8 @@ module Roqua
         attribute :status, String
         attribute :values, Hash
         attribute :outcome, Hash
+        attribute :flags, Hash
+        attribute :textvars, Hash
 
         def name
           ActiveSupport::Deprecation.warn(

data/lib/roqua/rom_api/models.rb

@@ -2,3 +2,4 @@ require 'roqua/rom_api/models/response'
 require 'roqua/rom_api/models/fill_out_request'
 require 'roqua/rom_api/models/protocol_subscription'
 require 'roqua/rom_api/models/measurement_sequence'
+require 'roqua/rom_api/models/questionnaire'

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

data/lib/roqua/rom_api.rb

@@ -13,6 +13,7 @@ require 'roqua/rom_api/create_fill_out_request'
 require 'roqua/rom_api/start_protocol_subscription'
 require 'roqua/rom_api/stop_protocol_subscription'
 require 'roqua/rom_api/report_calculations'
+require 'roqua/rom_api/get_questionnaire'
 
 module Roqua
   module RomApi

data/spec/lib/roqua/rom_api/list_responses_spec.rb

@@ -25,14 +25,15 @@ describe ListResponses do
                       protocol_subscription_id: 'protocol_subscription_id').result
   end
 
+  it 'can get responses by id' do
+    expect(session).to receive(:get).with(api_path, response_ids: ['1', '5', '7'])
+                                    .and_return response
+    ListResponses.run!(dossier_id: options[:dossier_id],
+                       response_ids: ['1', '5', '7'])
+  end
+
   it 'returns an array of response objects' do
-    allow(session).to receive(:get).with(api_path,
-                                         respondent_type: nil,
-                                         status: nil,
-                                         questionnaire_keys: [],
-                                         completed_after: nil,
-                                         completed_before: nil,
-                                         protocol_subscription_id: nil)
+    allow(session).to receive(:get).with(api_path, {})
                                    .and_return response
     responses = ListResponses.run(options).result
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -145,12 +145,14 @@ files:
 - lib/roqua/rom_api/create_measurement_sequence.rb
 - lib/roqua/rom_api/create_response.rb
 - lib/roqua/rom_api/endpoint.rb
+- lib/roqua/rom_api/get_questionnaire.rb
 - lib/roqua/rom_api/list_protocol_subscriptions.rb
 - lib/roqua/rom_api/list_responses.rb
 - lib/roqua/rom_api/models.rb
 - lib/roqua/rom_api/models/fill_out_request.rb
 - lib/roqua/rom_api/models/measurement_sequence.rb
 - lib/roqua/rom_api/models/protocol_subscription.rb
+- lib/roqua/rom_api/models/questionnaire.rb
 - lib/roqua/rom_api/models/response.rb
 - lib/roqua/rom_api/report_calculations.rb
 - lib/roqua/rom_api/sessions.rb
@@ -200,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API