roqua-rom-api 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b4880dbb6d6c9993997cde7707b54c2868fcf06
-  data.tar.gz: 3f2f850311daec6e0f7bba85aa9c8b8b73dc9b05
+  metadata.gz: 0e9e8469650f722f5c56ad4df3eb6762e7054001
+  data.tar.gz: eb58901e56a066fc16656e51929d4b57e9916315
 SHA512:
-  metadata.gz: bacf33df8afbad8ae0340abe98b96f2cd56604dc597af1341bc448c83228b76622fc677bb453fa5b497fcd9fe97454567f789fde62c78bfa7183674399394d83
-  data.tar.gz: 9ec1471630af1b4b3ad4980396e9cacfca009b048d10c3fd1616d5362f3590a47d6b1ad362b21911cef6c25d9f57afdc818c35c1755a23a2b6a9926e147c8bad
+  metadata.gz: b72e1e737e6a9389e2a34578dc9b12545b5338ba9b336227654031baf6af8f1d982ecce08294d16ca9f0996a8131b09f6b3f8f94539734c211881ae8f6ded730
+  data.tar.gz: 711f77ac9d5a8d642bf1dba8b293cd479fa9f84b8741069aec6e7556ad5955522b4603902eefc82e219d8c4e4c1e4c11a875dffcf69697fea4a4a16001eaeb8d

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 ### HEAD
+
+### 2.1.0 / 2017-02-07
+
+* Added ListProtocollen
+* Added GetProtocol
+* Added GetMeasurement
+* Added ListRespondents
+* Added GetRespondent
+
 ### 2.0.1 / 2016-08-15
 
 * Updated httparty gem to 0.14.0 to fix Virtus incompatibility

data/README.md

@@ -29,6 +29,20 @@ this means that you'll usually write a pattern like this:
       log_or_display outcome.errors.full_messages
     end
 
+## [Respondents](http://docs.roqua.net/developer/rom/dossier/respondents/)
+
+### List
+
+To retrieve all respondents belong to the dossier
+
+    outcome = Roqua::RomApi::ListRespondents.run dossier_id: 1
+
+### Get
+
+To retrieve single respondent
+
+    outcome = Roqua::RomApi::GetRespondent.run dossier_id: 1, respondent_id: 2
+
 
 ## [Fill Out Requests](http://docs.roqua.net/developer/rom/dossier/fill_out_requests/)
 
@@ -106,6 +120,30 @@ To store external data on an existing pending response:
                                                 id: 230, # response id,
                                                 answer_data: {some: 'aswer_data'}
 
+## [Protocols](http://docs.roqua.net/developer/rom/global/protocols/)
+
+### List
+
+To retrieve all protocols
+
+    outcome = Roqua::RomApi::ListProtocols.run
+
+### Get
+
+To get a single protocol
+
+    outcome = Roqua::RomApi::GetProtocol.run protocol_id: 1
+
+
+## [Measurements](http://docs.roqua.net/developer/rom/global/measurements/)
+
+### Get
+
+To get a single measurement
+
+    outcome = Roqua::RomApi::GetMeasurement.run measurement_id: 1
+
+
 ## [Stats](http://docs.roqua.net/developer/rom/dossier/stats/#stats)
 
 ### [List](http://docs.roqua.net/developer/rom/dossier/stats/#stats)

data/lib/roqua/rom_api.rb

@@ -16,6 +16,11 @@ 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_protocols'
+require 'roqua/rom_api/get_protocol'
+require 'roqua/rom_api/get_measurement'
+require 'roqua/rom_api/get_respondent'
+require 'roqua/rom_api/list_respondents'
 
 module Roqua
   module RomApi

data/lib/roqua/rom_api/create_fill_out_request.rb

@@ -11,7 +11,7 @@ module Roqua
       time :open_from, default: nil, allow_nil: true
       time :open_till, default: nil, allow_nil: true
 
-      validates :dossier_id, presence: { allow_blank: false }
+      validates :dossier_id, presence: {allow_blank: false}
 
       def execute
         validate_response_for do

data/lib/roqua/rom_api/get_measurement.rb

@@ -0,0 +1,18 @@
+module Roqua
+  module RomApi
+    # @api private
+    class GetMeasurement < Endpoint
+      integer :measurement_id
+
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/measurements/#{measurement_id}"
+        end
+      end
+
+      def response_to_result(response)
+        Models::Measurement.new(response)
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/get_protocol.rb

@@ -0,0 +1,18 @@
+module Roqua
+  module RomApi
+    # @api private
+    class GetProtocol < Endpoint
+      integer :protocol_id
+
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/protocols/#{protocol_id}"
+        end
+      end
+
+      def response_to_result(response)
+        Models::Protocol.new(response)
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/get_respondent.rb

@@ -0,0 +1,21 @@
+module Roqua
+  module RomApi
+    # @api private
+    class GetRespondent < Endpoint
+      string :dossier_id
+      integer :respondent_id
+
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/dossiers/#{dossier_id}/respondents/#{respondent_id}"
+        end
+      end
+
+      private
+
+      def response_to_result(response)
+        Models::Respondent.new(response)
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/list_protocols.rb

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

data/lib/roqua/rom_api/list_respondents.rb

@@ -0,0 +1,20 @@
+module Roqua
+  module RomApi
+    # @api private
+    class ListRespondents < Endpoint
+      string :dossier_id
+
+      def execute
+        validate_response_for do
+          basic_auth_session.get "/dossiers/#{dossier_id}/respondents"
+        end
+      end
+
+      private
+
+      def response_to_result(response)
+        response.map { |r| Models::Respondent.new(r) }
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/models.rb

@@ -1,7 +1,10 @@
 require 'roqua/rom_api/models/response'
+require 'roqua/rom_api/models/respondent'
 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'
+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'

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

@@ -0,0 +1,19 @@
+require 'virtus'
+
+module Roqua
+  module RomApi
+    module Models
+      class Measurement
+        include Virtus.model
+
+        attribute :id, Integer
+        attribute :name, String
+        attribute :description, String
+        attribute :active, Boolean
+        attribute :label, String
+        attribute :protocol_id, Integer
+        attribute :questionnaires, Array[Models::Questionnaire]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'virtus'
+
+module Roqua
+  module RomApi
+    module Models
+      class Protocol
+        include Virtus.model
+
+        attribute :id, Integer
+        attribute :name, String
+        attribute :description, String
+        attribute :active, Boolean
+        attribute :automatic, Boolean
+        attribute :measurements, Array[Models::Measurement]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'virtus'
+
+module Roqua
+  module RomApi
+    module Models
+      class Respondent
+        include Virtus.model
+
+        attribute :id, Integer
+        attribute :label, String
+        attribute :respondent_type, String
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ module Roqua
         include Virtus.model
 
         attribute :id, Integer
+        attribute :respondent_id, Integer
         attribute :questionnaire_name, String
         attribute :questionnaire_key, String
         attribute :open_from, DateTime

data/lib/roqua/rom_api/version.rb

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

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

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe GetMeasurement do
+  let(:options) { {measurement_id: 1} }
+  let(:api_path) { "/measurements/#{options[:measurement_id]}" }
+  let(:response) { httparty_response \
+    'id' => 1,
+    'name' => 'meas',
+    'questionnaires' => [{
+      'id' => 2,
+      'name' => 'quest'
+    }] }
+  let(:session)  { Fabricate :basic_auth_session }
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns a protocol object' do
+    allow(session).to receive(:get).with(api_path).and_return response
+    measurement = GetMeasurement.run(options).result
+
+    expect(measurement).to be_a Measurement
+    expect(measurement.id).to eq 1
+    expect(measurement.name).to eq 'meas'
+    expect(measurement.questionnaires.first.id).to eq 2
+    expect(measurement.questionnaires.first.name).to eq 'quest'
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe GetProtocol do
+  let(:options) { {protocol_id: 1} }
+  let(:api_path) { "/protocols/#{options[:protocol_id]}" }
+  let(:response) { httparty_response \
+    'id' => 1,
+    'name' => 'prot',
+    'measurements' => [{
+      'id' => 2,
+      'name' => 'meas',
+      'questionnaires' => [{
+        'id' => 3,
+        'name' => 'quest'
+      }]
+    }] }
+  let(:session)  { Fabricate :basic_auth_session }
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns a protocol object' do
+    allow(session).to receive(:get).with(api_path).and_return response
+    protocol = GetProtocol.run(options).result
+
+    expect(protocol).to be_a Protocol
+    expect(protocol.id).to eq 1
+    expect(protocol.name).to eq 'prot'
+    expect(protocol.measurements.first.id).to eq 2
+    expect(protocol.measurements.first.name).to eq 'meas'
+    expect(protocol.measurements.first.questionnaires.first.id).to eq 3
+    expect(protocol.measurements.first.questionnaires.first.name).to eq 'quest'
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe GetRespondent do
+  let(:options) { {dossier_id: 'some_dossier_id', respondent_id: 2} }
+  let(:api_path) { "/dossiers/some_dossier_id/respondents/2" }
+  let(:response) { httparty_response \
+    'id' => 2,
+    'label' => 'Patiënt',
+    'respondent_type' => 'patient'
+  }
+  let(:session)  { Fabricate :basic_auth_session }
+
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns a respondent object' do
+    expect(session).to receive(:get).with(api_path).and_return response
+    respondent = GetRespondent.run(options).result
+
+    expect(respondent).to be_a Respondent
+    expect(respondent.id).to eq 2
+    expect(respondent.label).to eq 'Patiënt'
+    expect(respondent.respondent_type).to eq 'patient'
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe ListProtocols do
+  let(:api_path) { "/protocols" }
+  let(:response) { httparty_response [{
+    'id' => 1,
+    'name' => 'prot',
+    'measurements' => [{
+      'id' => 2,
+      'name' => 'meas',
+      'questionnaires' => [{
+        'id' => 3,
+        'name' => 'quest'
+      }]
+    }]}] }
+  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
+    protocols = ListProtocols.run.result
+
+    expect(protocols).to be_a(Array)
+    expect(protocols.first).to be_a Protocol
+    expect(protocols.first.id).to eq 1
+    expect(protocols.first.name).to eq 'prot'
+    expect(protocols.first.measurements.first.id).to eq 2
+    expect(protocols.first.measurements.first.name).to eq 'meas'
+    expect(protocols.first.measurements.first.questionnaires.first.id).to eq 3
+    expect(protocols.first.measurements.first.questionnaires.first.name).to eq 'quest'
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ListRespondents do
+  let(:options) { {dossier_id: 'some_dossier_id'} }
+  let(:api_path) { "/dossiers/some_dossier_id/respondents" }
+  let(:response) { httparty_response \
+    [{'id' => 2,
+      'label' => 'Patiënt',
+      'respondent_type' => 'patient'}]
+  }
+  let(:session)  { Fabricate :basic_auth_session }
+
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns an array of respondent objects' do
+    expect(session).to receive(:get).with(api_path).and_return response
+    respondents = ListRespondents.run(options).result
+    respondent = respondents.first
+
+    expect(respondent).to be_a Respondent
+    expect(respondent.id).to eq 2
+    expect(respondent.label).to eq 'Patiënt'
+    expect(respondent.respondent_type).to eq 'patient'
+  end
+end

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

@@ -8,7 +8,7 @@ describe ProtocolSubscription do
      'stop_at'          => nil,
      'state'            => "a",
      'protocol_key'     => "pkey",
-     'protocol_name'    => 'pname' }
+     'protocol_name'    => 'pname'}
   end
 
   it 'assigns fields to attr_accessors' do

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

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Respondent do
+  let(:response_body) do
+    {'id' => 1,
+     'label' => 'Patiënt',
+     'respondent_type' => 'patient'}
+  end
+
+  it 'assigns fields to attr_accessors' do
+    respondent = Respondent.new response_body
+    expect(respondent.id).to eq 1
+    expect(respondent.label).to eq 'Patiënt'
+    expect(respondent.respondent_type).to eq 'patient'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Samuel Esposito
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-15 00:00:00.000000000 Z
+date: 2017-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -164,16 +164,24 @@ 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_measurement.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_protocol_subscriptions.rb
+- lib/roqua/rom_api/list_protocols.rb
+- 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/dossier_stats.rb
 - 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/protocol.rb
 - lib/roqua/rom_api/models/protocol_subscription.rb
 - lib/roqua/rom_api/models/questionnaire.rb
+- lib/roqua/rom_api/models/respondent.rb
 - lib/roqua/rom_api/models/response.rb
 - lib/roqua/rom_api/models/stats.rb
 - lib/roqua/rom_api/report_calculations.rb
@@ -190,12 +198,18 @@ files:
 - 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_measurement_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_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/models/dossier_stats_spec.rb
 - spec/lib/roqua/rom_api/models/fill_out_request_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
@@ -228,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
@@ -238,12 +252,18 @@ test_files:
 - 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_measurement_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_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/models/dossier_stats_spec.rb
 - spec/lib/roqua/rom_api/models/fill_out_request_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
@@ -256,3 +276,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/httparty_helpers.rb
 - spec/support/test.yml
+has_rdoc: