roqua-rom-api 3.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477f788af8448ee3fa2a41f20352eef3328dc09e712671437db727ea80da013d
-  data.tar.gz: 5067b2d36c85318641c47dfc7f7ae53e52257448b5de0fcf66ed4f2b928b6c06
+  metadata.gz: 7e4cbc3256f5ae1f1cc8925aeddd23a062557f5f31b88d17908e5856d4ff22f5
+  data.tar.gz: e7202043808f8d9993729a94e5adc4369830ad43bb2cb4a720d012d5c647128c
 SHA512:
-  metadata.gz: 17dd22e0f74ec2d4e47e816f0f7d103691ce14266411ce3db3f140a363e4c24c0c9c4a3b72329b8d90aa61b652914555392474e14b8f4081a7c0bbc43c50c30b
-  data.tar.gz: edfd436ed08cc2df027f8369d54f1d056c02fdcb7d1279aef3f7bddc7ef75d3deffc213c1bc7858d79501c97de820c39f76ef818ef1aec93dad7d2b982dd8471
+  metadata.gz: d1769591f3affdddcc516c07d965603f4effd9470b9c7e0db6ec05422df5e0dd3d3be0c9383e0ca1e6544c65a3fc9e79a9ffdfaaefbeaff74f72937ef77fbe75
+  data.tar.gz: 139002940dfab95e73caa7678102b7edf32f15df2230c0b306fa309d7adb766c00df6ae634717a18d3647bee7872a983449ec844c71dfac10591e855d7666cba

data/config/locales/nl.yml

@@ -11,7 +11,7 @@ nl:
             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.
+              respondent_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.

data/lib/roqua/rom_api/list_auto_protocols.rb

@@ -0,0 +1,16 @@
+module Roqua
+  module RomApi
+    # @api private
+    class ListAutoProtocols < Endpoint
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/auto_protocols"
+        end
+      end
+
+      def response_to_result(response)
+        response.map { |r| Models::AutoProtocol.new(r) }
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/list_responses.rb

@@ -18,13 +18,14 @@ module Roqua
       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
+        {
+          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
 

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

@@ -0,0 +1,27 @@
+require 'virtus'
+
+module Roqua
+  module RomApi
+    module Models
+      class AutoProtocol
+        include Virtus.model
+
+        # @!attribute [r] id
+        #   @return [Integer]
+        attribute :id, Integer
+        # @!attribute key
+        #   @return [String]
+        attribute :key, String
+        # @!attribute name
+        #   @return [String]
+        attribute :name, String
+        # @!attribute description
+        #   @return [String]
+        attribute :description, String
+        # @!attribute active
+        #   @return [Boolean]
+        attribute :active, Boolean
+      end
+    end
+  end
+end

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

@@ -15,8 +15,8 @@ module Roqua
         attribute :questions, Hash
         attribute :scores, Hash
         attribute :sbg_info, Hash
-        attribute :textvars, Hash
-        attribute :flags, Hash
+        attribute :textvars, Array
+        attribute :flags, Array
         attribute :charts, Array
       end
     end

data/lib/roqua/rom_api/models.rb

@@ -6,6 +6,7 @@ require 'roqua/rom_api/models/measurement_sequence'
 require 'roqua/rom_api/models/questionnaire'
 require 'roqua/rom_api/models/measurement'
 require 'roqua/rom_api/models/protocol'
+require 'roqua/rom_api/models/auto_protocol'
 require 'roqua/rom_api/models/dossier_stats'
 require 'roqua/rom_api/models/stats'
 require 'roqua/rom_api/models/non_response'

data/lib/roqua/rom_api/sessions.rb

@@ -3,8 +3,8 @@ require 'roqua/rom_api/sessions/basic_auth_session'
 
 module Roqua
   module RomApi
-    def self.basic_auth_session(*arguments, &block)
-      Sessions::BasicAuthSession.new(*arguments, &block)
+    def self.basic_auth_session(...)
+      Sessions::BasicAuthSession.new(...)
     end
   end
 end

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '3.0.1'
+    VERSION = '3.0.3'
   end
 end

data/lib/roqua/rom_api.rb

@@ -16,6 +16,7 @@ require 'roqua/rom_api/stop_protocol_subscription'
 require 'roqua/rom_api/report_calculations'
 require 'roqua/rom_api/get_questionnaire'
 require 'roqua/rom_api/list_dossier_stats'
+require 'roqua/rom_api/list_auto_protocols'
 require 'roqua/rom_api/list_protocols'
 require 'roqua/rom_api/get_protocol'
 require 'roqua/rom_api/get_measurement'

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe ListAutoProtocols do
+  let(:api_path) { "/auto_protocols" }
+  let(:response) { httparty_response [{
+    'id' => 1,
+    'name' => 'prot'
+    }] }
+  let(:session)  { Fabricate :basic_auth_session }
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns an array of protocol objects' do
+    allow(session).to receive(:get).with(api_path).and_return response
+    auto_protocols = ListAutoProtocols.run.result
+
+    expect(auto_protocols).to be_a(Array)
+    expect(auto_protocols.first).to be_a AutoProtocol
+    expect(auto_protocols.first.id).to eq 1
+    expect(auto_protocols.first.name).to eq 'prot'
+  end
+end

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

@@ -17,7 +17,7 @@ describe ListDossierStats do
   describe 'with epd_ids provided' do
     let(:response) { {'foo' => {}, 'bar' => {}} }
     before do
-      allow(session).to receive(:get).with('/stats', epd_ids: ['foo', 'bar']).and_return httparty_response(response)
+      allow(session).to receive(:get).with('/stats', {epd_ids: ['foo', 'bar']}).and_return httparty_response(response)
     end
 
     subject { ListDossierStats.run! epd_ids: ['foo', 'bar'] }

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

@@ -8,14 +8,14 @@ describe ListResponses do
   before { allow(BasicAuthSession).to receive(:new).and_return session }
 
   it 'performs a GET on the responses API' do
-    expect(session).to receive(:get).with(api_path,
-                                          respondent_type: 'respondent_type',
-                                          status: :status,
-                                          questionnaire_keys: ['questionnaire_key'],
-                                          completed_after: Time.new(2014, 1, 1),
-                                          completed_before: Time.new(2014, 1, 31),
-                                          protocol_subscription_id: 'protocol_subscription_id')
-                                    .and_return response
+    expect(session).to receive(:get).with(api_path, {
+      respondent_type: 'respondent_type',
+      status: :status,
+      questionnaire_keys: ['questionnaire_key'],
+      completed_after: Time.new(2014, 1, 1),
+      completed_before: Time.new(2014, 1, 31),
+      protocol_subscription_id: 'protocol_subscription_id'
+    }).and_return response
     ListResponses.run(dossier_id: options[:dossier_id],
                       respondent_type: 'respondent_type',
                       status: :status,
@@ -26,7 +26,7 @@ describe ListResponses do
   end
 
   it 'can get responses by id' do
-    expect(session).to receive(:get).with(api_path, response_ids: ['1', '5', '7'])
+    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'])

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

@@ -37,7 +37,7 @@ describe ReportCalculations do
         completed_after: filters[:completed_after].to_i,
         completed_before: filters[:completed_before].to_i
       }
-      expect(session).to receive(:get).with(api_path, calculator: 'test', filters: filter_hash)
+      expect(session).to receive(:get).with(api_path, {calculator: 'test', filters: filter_hash})
       subject
     end
   end

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

@@ -11,24 +11,26 @@ describe StartProtocolSubscription do
   end
 
   it 'does a post to the rom protocol_subscription api' do
-    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions",
-                                           protocol_key: options[:protocol_key],
-                                           protocol_id: options[:protocol_id],
-                                           respondent_id: options[:respondent_id],
-                                           flags: {some_flag: true},
-                                           textvars: {some_var: 'string'})
+    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions", {
+      protocol_key: options[:protocol_key],
+      protocol_id: options[:protocol_id],
+      respondent_id: options[:respondent_id],
+      flags: {"some_flag" => true},
+      textvars: {"some_var" => 'string'}
+    })
     StartProtocolSubscription.run!(options)
   end
 
   it 'passes in the start_at option when provided' do
     start_at = Time.current
-    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions",
-                                           protocol_key: options[:protocol_key],
-                                           protocol_id: options[:protocol_id],
-                                           respondent_id: options[:respondent_id],
-                                           start_at: start_at.to_i,
-                                           flags: {some_flag: true},
-                                           textvars: {some_var: 'string'})
+    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions", {
+      protocol_key: options[:protocol_key],
+      protocol_id: options[:protocol_id],
+      respondent_id: options[:respondent_id],
+      start_at: start_at.to_i,
+      flags: {"some_flag" => true},
+      textvars: {"some_var" => 'string'}
+    })
     StartProtocolSubscription.run!(options.merge start_at: start_at)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Samuel Esposito
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -160,20 +160,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
-- !ruby/object:Gem::Dependency
-  name: ruby_dep
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 description: Provides authenticated access to ROM utilities
 email: support@roqua.nl
 executables: []
@@ -198,6 +184,7 @@ files:
 - lib/roqua/rom_api/get_protocol.rb
 - lib/roqua/rom_api/get_questionnaire.rb
 - lib/roqua/rom_api/get_respondent.rb
+- lib/roqua/rom_api/list_auto_protocols.rb
 - lib/roqua/rom_api/list_dossier_stats.rb
 - lib/roqua/rom_api/list_non_responses.rb
 - lib/roqua/rom_api/list_protocol_subscriptions.rb
@@ -205,6 +192,7 @@ files:
 - lib/roqua/rom_api/list_respondents.rb
 - lib/roqua/rom_api/list_responses.rb
 - lib/roqua/rom_api/models.rb
+- lib/roqua/rom_api/models/auto_protocol.rb
 - lib/roqua/rom_api/models/dossier_stats.rb
 - lib/roqua/rom_api/models/fill_out_request.rb
 - lib/roqua/rom_api/models/measurement.rb
@@ -233,6 +221,7 @@ files:
 - spec/lib/roqua/rom_api/get_non_response_spec.rb
 - spec/lib/roqua/rom_api/get_protocol_spec.rb
 - spec/lib/roqua/rom_api/get_respondent_spec.rb
+- spec/lib/roqua/rom_api/list_auto_protocols_spec.rb
 - spec/lib/roqua/rom_api/list_dossier_stats_spec.rb
 - spec/lib/roqua/rom_api/list_non_responses_spec.rb
 - spec/lib/roqua/rom_api/list_protocol_subscriptions_spec.rb
@@ -274,39 +263,40 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
 test_files:
-- spec/spec_helper.rb
-- spec/support/test.yml
-- spec/support/httparty_helpers.rb
 - spec/fabricators/basic_auth_session_fabricator.rb
-- spec/lib/roqua/rom_api/list_respondents_spec.rb
-- spec/lib/roqua/rom_api/update_response_spec.rb
+- spec/lib/roqua/rom_api/cancel_fill_out_request_spec.rb
 - spec/lib/roqua/rom_api/create_fill_out_request_spec.rb
+- spec/lib/roqua/rom_api/create_response_spec.rb
 - spec/lib/roqua/rom_api/endpoint_spec.rb
-- spec/lib/roqua/rom_api/get_respondent_spec.rb
+- spec/lib/roqua/rom_api/get_measurement_spec.rb
+- spec/lib/roqua/rom_api/get_non_response_spec.rb
 - spec/lib/roqua/rom_api/get_protocol_spec.rb
-- spec/lib/roqua/rom_api/stop_protocol_subscription_spec.rb
+- spec/lib/roqua/rom_api/get_respondent_spec.rb
+- spec/lib/roqua/rom_api/list_auto_protocols_spec.rb
+- spec/lib/roqua/rom_api/list_dossier_stats_spec.rb
 - spec/lib/roqua/rom_api/list_non_responses_spec.rb
-- spec/lib/roqua/rom_api/create_response_spec.rb
+- spec/lib/roqua/rom_api/list_protocol_subscriptions_spec.rb
+- spec/lib/roqua/rom_api/list_protocols_spec.rb
+- spec/lib/roqua/rom_api/list_respondents_spec.rb
 - spec/lib/roqua/rom_api/list_responses_spec.rb
-- spec/lib/roqua/rom_api/report_calculations_spec.rb
-- spec/lib/roqua/rom_api/cancel_fill_out_request_spec.rb
-- spec/lib/roqua/rom_api/get_non_response_spec.rb
-- spec/lib/roqua/rom_api/models/stats_spec.rb
 - spec/lib/roqua/rom_api/models/dossier_stats_spec.rb
-- spec/lib/roqua/rom_api/models/respondent_spec.rb
 - spec/lib/roqua/rom_api/models/fill_out_request_spec.rb
-- spec/lib/roqua/rom_api/models/response_spec.rb
 - spec/lib/roqua/rom_api/models/protocol_subscription_spec.rb
+- spec/lib/roqua/rom_api/models/respondent_spec.rb
+- spec/lib/roqua/rom_api/models/response_spec.rb
+- spec/lib/roqua/rom_api/models/stats_spec.rb
+- spec/lib/roqua/rom_api/report_calculations_spec.rb
 - spec/lib/roqua/rom_api/sessions/basic_auth_session_spec.rb
 - spec/lib/roqua/rom_api/start_fill_out_session_spec.rb
-- spec/lib/roqua/rom_api/list_protocols_spec.rb
 - spec/lib/roqua/rom_api/start_protocol_subscription_spec.rb
-- spec/lib/roqua/rom_api/get_measurement_spec.rb
-- spec/lib/roqua/rom_api/list_protocol_subscriptions_spec.rb
-- spec/lib/roqua/rom_api/list_dossier_stats_spec.rb
+- spec/lib/roqua/rom_api/stop_protocol_subscription_spec.rb
+- spec/lib/roqua/rom_api/update_response_spec.rb
 - spec/lib/roqua_rom_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/httparty_helpers.rb
+- spec/support/test.yml