roqua-rom-api 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e9e8469650f722f5c56ad4df3eb6762e7054001
-  data.tar.gz: eb58901e56a066fc16656e51929d4b57e9916315
+  metadata.gz: 1232ec18176d8cb41e579dadce78775014e70034
+  data.tar.gz: 94bd0b445ebc2ea4cd317312ca3e2c2c410753fe
 SHA512:
-  metadata.gz: b72e1e737e6a9389e2a34578dc9b12545b5338ba9b336227654031baf6af8f1d982ecce08294d16ca9f0996a8131b09f6b3f8f94539734c211881ae8f6ded730
-  data.tar.gz: 711f77ac9d5a8d642bf1dba8b293cd479fa9f84b8741069aec6e7556ad5955522b4603902eefc82e219d8c4e4c1e4c11a875dffcf69697fea4a4a16001eaeb8d
+  metadata.gz: d37f46dface65bab1ce4a1607dda74d34285b48187f8d5982a5df0702355c8bd9cf03dfd86582fdce61b8b7a79d66af5d1b31a0ca0b82f4c9a5a9a8c36d5c220
+  data.tar.gz: a3dbaf436487a0951aa6dd1ea0bed1b145142f7f05db105ade285950bc4b709857b95b1509fbb935e9c39e72628726256808ef7e87062813d701eddf61291704

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ### HEAD
 
+### 2.2.0 / 2017-02-12
+
+* Added ListNonResponses
+* Added GetNonResponse
+* Added sbg_info to responses
+
 ### 2.1.0 / 2017-02-07
 
 * Added ListProtocollen

data/README.md

@@ -120,6 +120,11 @@ To store external data on an existing pending response:
                                                 id: 230, # response id,
                                                 answer_data: {some: 'aswer_data'}
 
+## [NonResponses](http://docs.roqua.net/developer/rom/dossier/non_responses/)
+
+* [List](Roqua/RomApi/ListNonResponses.html)
+* [Get](Roqua/RomApi/GetNonResponse.html)
+
 ## [Protocols](http://docs.roqua.net/developer/rom/global/protocols/)
 
 ### List

data/lib/roqua/rom_api.rb

@@ -21,6 +21,8 @@ require 'roqua/rom_api/get_protocol'
 require 'roqua/rom_api/get_measurement'
 require 'roqua/rom_api/get_respondent'
 require 'roqua/rom_api/list_respondents'
+require 'roqua/rom_api/list_non_responses'
+require 'roqua/rom_api/get_non_response'
 
 module Roqua
   module RomApi

data/lib/roqua/rom_api/get_non_response.rb

@@ -0,0 +1,27 @@
+module Roqua
+  module RomApi
+    # @!method run!(dossier_id: 'some_epd_id', non_response_id: 1)
+    #   Retrieve specified non_response from specified dossier.
+    #   @!scope class
+    #   @return [Models::NonResponse]
+    #   @param dossier_id: [String] epd_id of dossier (required)
+    #   @param non_response_id: [Integer] (required)
+    #   @see http://docs.roqua.net/developer/rom/dossier/non_responses#show json api
+    class GetNonResponse < Endpoint
+      string :dossier_id
+      integer :non_response_id
+
+      private
+
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/dossiers/#{dossier_id}/non_responses/#{non_response_id}"
+        end
+      end
+
+      def response_to_result(response)
+        Models::NonResponse.new(response)
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/get_questionnaire.rb

@@ -3,10 +3,11 @@ module Roqua
     # @api private
     class GetQuestionnaire < Endpoint
       string  :questionnaire_key
+      boolean :use_legacy_keys, default: true
 
       def execute
         validate_response_for do
-          basic_auth_session.get "/questionnaires/#{questionnaire_key}"
+          basic_auth_session.get "/questionnaires/#{questionnaire_key}", use_legacy_keys: use_legacy_keys
         end
       end
 

data/lib/roqua/rom_api/list_non_responses.rb

@@ -0,0 +1,25 @@
+module Roqua
+  module RomApi
+    # @!method run!(dossier_id: 'some_epd_id')
+    #   Retrieve all non_responses belonging to specified dossier.
+    #   @!scope class
+    #   @return [Array<Models::NonResponse>]
+    #   @param dossier_id: [String] epd_id of dossier (required)
+    #   @see http://docs.roqua.net/developer/rom/dossier/non_responses#index json api
+    class ListNonResponses < Endpoint
+      string :dossier_id
+
+      private
+
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/dossiers/#{dossier_id}/non_responses"
+        end
+      end
+
+      def response_to_result(response)
+        response.map { |r| Models::NonResponse.new(r) }
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/models.rb

@@ -8,3 +8,4 @@ require 'roqua/rom_api/models/measurement'
 require 'roqua/rom_api/models/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/models/non_response.rb

@@ -0,0 +1,33 @@
+require 'virtus'
+
+module Roqua
+  module RomApi
+    module Models
+      class NonResponse
+        include Virtus.model
+
+        # @!attribute [r] id
+        #   @return [Integer]
+        attribute :id, Integer
+        # @!attribute non_response_at
+        #   @return [DateTime]
+        attribute :non_response_at, DateTime
+        # @!attribute response_ids
+        #   @return [Array<Integer>]
+        attribute :response_ids, Array[Integer]
+        # @!attribute reason_group
+        #   @return [String]
+        attribute :reason_group, String
+        # @!attribute reason_option
+        #   @return [String]
+        attribute :reason_option, String
+        # @!attribute reason_code
+        #   @return [String]
+        attribute :reason_code, String
+        # @!attribute reason_other
+        #   @return [String]
+        attribute :reason_other, String
+      end
+    end
+  end
+end

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

@@ -14,6 +14,7 @@ module Roqua
         attribute :short_description, String
         attribute :questions, Hash
         attribute :scores, Hash
+        attribute :sbg_info, Hash
         attribute :textvars, Hash
         attribute :flags, Hash
         attribute :charts, Array

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

@@ -10,6 +10,8 @@ module Roqua
         attribute :respondent_id, Integer
         attribute :questionnaire_name, String
         attribute :questionnaire_key, String
+        attribute :measurement_id, Integer
+        attribute :non_response_id, Integer
         attribute :open_from, DateTime
         attribute :open_till, DateTime
         attribute :started_at, DateTime

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '2.1.0'
+    VERSION = '2.2.0'
   end
 end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe GetNonResponse do
+  let(:options) { {dossier_id: 'some_epd_id', non_response_id: 1} }
+  let(:api_path) { "/dossiers/#{options[:dossier_id]}/non_responses/1" }
+  let(:response) { httparty_response \
+    'id' => 1,
+    'non_response_at' => "2017-02-08T11:02:41+01:00",
+    'response_ids' => [1, 5, 9],
+    'reason_group' => "Patiënt is wel benaderd voor de ROM meting, maar:",
+    'reason_option' => "Patiënt retourneert meetinstrument niet.",
+    'reason_code' => '04',
+    'reason_other' => 'ik type, dus ik ben' }
+  let(:session)  { Fabricate :basic_auth_session }
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns non_response objects' do
+    allow(session).to receive(:get).with(api_path).and_return response
+    non_response = GetNonResponse.run(options).result
+
+    expect(non_response.id).to eq 1
+    expect(non_response.non_response_at).to eq Time.parse("2017-02-08T11:02:41+01:00")
+    expect(non_response.response_ids).to eq [1, 5, 9]
+    expect(non_response.reason_group).to eq "Patiënt is wel benaderd voor de ROM meting, maar:"
+    expect(non_response.reason_option).to eq "Patiënt retourneert meetinstrument niet."
+    expect(non_response.reason_code).to eq '04'
+    expect(non_response.reason_other).to eq 'ik type, dus ik ben'
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ListNonResponses do
+  let(:options) { {dossier_id: 'some_epd_id'} }
+  let(:api_path) { "/dossiers/#{options[:dossier_id]}/non_responses" }
+  let(:response) { httparty_response [{
+    'id' => 1,
+    'non_response_at' => "2017-02-08T11:02:41+01:00",
+    'response_ids' => [1, 5, 9],
+    'reason_group' => "Patiënt is wel benaderd voor de ROM meting, maar:",
+    'reason_option' => "Patiënt retourneert meetinstrument niet.",
+    'reason_code' => '04',
+    'reason_other' => 'ik type, dus ik ben'}] }
+  let(:session)  { Fabricate :basic_auth_session }
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns non_response objects' do
+    allow(session).to receive(:get).with(api_path).and_return response
+    non_responses = ListNonResponses.run(options).result
+
+    expect(non_responses.first.id).to eq 1
+    expect(non_responses.first.non_response_at).to eq Time.parse("2017-02-08T11:02:41+01:00")
+    expect(non_responses.first.response_ids).to eq [1, 5, 9]
+    expect(non_responses.first.reason_group).to eq "Patiënt is wel benaderd voor de ROM meting, maar:"
+    expect(non_responses.first.reason_option).to eq "Patiënt retourneert meetinstrument niet."
+    expect(non_responses.first.reason_code).to eq '04'
+    expect(non_responses.first.reason_other).to eq 'ik type, dus ik ben'
+  end
+end

data/spec/lib/roqua/rom_api/models/response_spec.rb

@@ -4,6 +4,9 @@ describe Response do
   let(:response_body) do
     {'questionnaire_name' => 'RS-12',
      'questionnaire_key' => 'rs12',
+     'respondent_id' => 2,
+     'measurement_id' => 3,
+     'non_response_id' => 4,
      'open_from' => '2014-02-19T14:15:49+01:00',
      'open_till' => '2014-02-20T14:15:49+01:00',
      'started_at' => '2014-02-19T15:15:49+01:00',
@@ -19,6 +22,9 @@ describe Response do
     response = Response.new response_body
     expect(response.questionnaire_name).to eq 'RS-12'
     expect(response.questionnaire_key).to  eq 'rs12'
+    expect(response.respondent_id).to      eq 2
+    expect(response.measurement_id).to     eq 3
+    expect(response.non_response_id).to    eq 4
     expect(response.open_from).to          eq DateTime.parse('2014-02-19T14:15:49+01:00')
     expect(response.open_till).to          eq DateTime.parse('2014-02-20T14:15:49+01:00')
     expect(response.started_at).to         eq DateTime.parse('2014-02-19T15:15:49+01:00')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Samuel Esposito
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -165,10 +165,12 @@ files:
 - lib/roqua/rom_api/create_response.rb
 - lib/roqua/rom_api/endpoint.rb
 - lib/roqua/rom_api/get_measurement.rb
+- lib/roqua/rom_api/get_non_response.rb
 - 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_dossier_stats.rb
+- lib/roqua/rom_api/list_non_responses.rb
 - lib/roqua/rom_api/list_protocol_subscriptions.rb
 - lib/roqua/rom_api/list_protocols.rb
 - lib/roqua/rom_api/list_respondents.rb
@@ -178,6 +180,7 @@ files:
 - lib/roqua/rom_api/models/fill_out_request.rb
 - lib/roqua/rom_api/models/measurement.rb
 - lib/roqua/rom_api/models/measurement_sequence.rb
+- lib/roqua/rom_api/models/non_response.rb
 - lib/roqua/rom_api/models/protocol.rb
 - lib/roqua/rom_api/models/protocol_subscription.rb
 - lib/roqua/rom_api/models/questionnaire.rb
@@ -199,9 +202,11 @@ files:
 - spec/lib/roqua/rom_api/create_response_spec.rb
 - spec/lib/roqua/rom_api/endpoint_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/get_respondent_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
 - spec/lib/roqua/rom_api/list_protocols_spec.rb
 - spec/lib/roqua/rom_api/list_respondents_spec.rb
@@ -242,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
@@ -253,9 +258,11 @@ test_files:
 - spec/lib/roqua/rom_api/create_response_spec.rb
 - spec/lib/roqua/rom_api/endpoint_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/get_respondent_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
 - spec/lib/roqua/rom_api/list_protocols_spec.rb
 - spec/lib/roqua/rom_api/list_respondents_spec.rb