roqua-rom-api 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 881dd5c16f0143f91608a347ffb8c53db068158b
-  data.tar.gz: 46dec1b7bef8b9c165318bca401707dc8cee143b
+  metadata.gz: ce8decd48dd3da616e6eb16c463ecc8f8603f104
+  data.tar.gz: 2bde7738950a4b361b882a06c50a4752475f6960
 SHA512:
-  metadata.gz: dc6f22a64c1b796dd5005ce4d05a623ddce36cf61e5467e3871781759bfbc456b69155527deaaf41b51c59e94c440b591b8bc4693431dfa2de4fd01d2c2d2d64
-  data.tar.gz: 881c3a68d08afb1eb48eabe34af902b34f3126ea3f10ef7f15e4a7af069af785671d72d0f3b2d0414f4651f52a813fb68f9eaf1e553f5990a1093dc441f3246e
+  metadata.gz: c5e0f2e97f3f2f7d17f06b7a45bf4a4d437cb258f17620ce6590effa94ae12e153d06e822c93117a3b08ff55adaa81944bf34535d33842ae8f5cd4c47ac6a8c6
+  data.tar.gz: 1ffdcdf567b1372c7e42f6f1fbc86ddcf232e258feb0ee19a7ce92ea6cf63f344efc6f3d0569e9c34d5fd8b5661d538a9d6f4567f0ed85350ac4fe469af3d9ab

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.1.8 / 2014-09-22
+
+* Add API endpoint for creating responses
+
 ### 0.1.7 / 2014-07-10
 
 * Add id to responses api

data/Guardfile

@@ -6,4 +6,3 @@ guard :rspec, cmd: 'bundle exec rspec --format Fuubar --colour', failed_mode: :n
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-

data/README.md

@@ -25,13 +25,13 @@ To create a fill out request run:
 
 #### Parameters
 
-* `dossier_id`         [Required]  - Unique dossier identifier string for the patient about to fill out questionnaires
-* `questionnaire_keys  [Required]  - Array of keys of questionnaires to fill out
-* open_from                        - Time the patient can start filling out the questionnaires and time.
-* open_till                        - Time the patient can no longer fill in the questionnaire.
-* callback_url         [Required]  - Url for event callbacks
-* reminders                        - Array of durations after which a reminder should be sent if fill_out_request has not been finished.
-* respondent_type                  - Defaults to 'patient_version', each type is a separate list of questionnaires to fill out.
+* `dossier_id:`         [Required]  - Unique dossier identifier string for the patient about to fill out questionnaires
+* `questionnaire_keys:` [Required]  - Array of keys of questionnaires to fill out
+* `open_from:`                        Time the patient can start filling out the questionnaires and time.
+* `open_till:`                        Time the patient can no longer fill in the questionnaire.
+* `callback_url:`       [Required]  - Url for event callbacks
+* `reminders:`                        Array of durations after which a reminder should be sent if fill_out_request has not been finished.
+* `respondent_type:`                  Defaults to 'patient_version', each type is a separate list of questionnaires to fill out.
 
 
 ## Fill Out Sessions
@@ -45,8 +45,8 @@ To start filling out a set of questionnaires run:
 #### Parameters
 
  * `dossier_id:`         [Required]           - Unique dossier identifier for the patient about to fill out a questionnaire.
- * `questionnaire_keys:`                      - Array of keys uniquely identifying the questionnaires to be filled out.
- * `response_ids:`                            - Array of ids uniquely identifying aborted responses for which filling out has to be resumed.
+ * `questionnaire_keys:`                        Array of keys uniquely identifying the questionnaires to be filled out.
+ * `response_ids:`                              Array of ids uniquely identifying aborted responses for which filling out has to be resumed.
  * `return_to:`          [Required]           - Address to return to after filling out the questionnaire.
 
 When questionnaire keys are provided, a set of blank questionnaires will be filled out. When response ids are provided,
@@ -134,6 +134,8 @@ Else the validation errors can be inspected:
 
 ## Responses
 
+### Index
+
 To retrieve filled out, pending or scheduled questionnaires run:
 
     outcome = Roqua::RomApi::ListResponses.run dossier_id: dossier_id
@@ -153,6 +155,34 @@ Else some validation errors can be shown:
       log_or_display outcome.errors.full_messages
     end
 
+### Create
+
+To store an externally filled out questionnaire run:
+
+    outcome = Roqua::RomApi::CreateResponse.run questionnaire_key: 'questionnaire_key',
+                                                dossier_id: 'dossier_id',
+                                                answer_data: {some: 'aswer_data'}
+
+#### Parameters
+
+ * `questionnaire_key:` [Required]  - Key uniquely identifying the questionnaire in RoQua
+ * `dossier_id:`        [Required]  - Unique dossier identifier for the patient you want to store the questionnaire for
+ * `answer_data:`       [Required]  - Hash storing the answered option key for every question key
+ * `filled_out_at:`                   Timestamp indicating the time the questionnaire was filled out
+ * `respondent:`        ['patient'(default)|'parent'|'second_parent'|'teacher'|'caregiver']
+                                    - String identifying the respondent which filled out the questionnaire
+
+When the request succeeds, the stored response is returned:
+
+    if outcome.valid?
+      responses = outcome.result
+
+Else some validation errors are provided:
+
+    else
+      log_or_display outcome.errors.full_messages
+    end
+
 ## Contributing to roqua-rom-api
 
  * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/lib/i18n/i18n.rb

@@ -1,12 +1,15 @@
+# rubocop:disable HandleExceptions
 begin
   require 'rails'
   module I18n
     class Railtie < ::Rails::Railtie #:nodoc:
-      initializer 'rails-i18n' do |app|
+      initializer 'rails-i18n' do |_app|
         I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__) + '/../../config/locales'), '*.yml')]
         I18n.load_path.flatten!
       end
     end
   end
 rescue LoadError
+  # No I18n is set up as rails is not installed
 end
+# rubocop:enable HandleExceptions

data/lib/roqua/rom_api.rb

@@ -5,10 +5,12 @@ require 'roqua/rom_api/models'
 require 'roqua/rom_api/endpoint'
 require 'roqua/rom_api/list_protocol_subscriptions'
 require 'roqua/rom_api/list_responses'
+require 'roqua/rom_api/create_response'
 require 'roqua/rom_api/start_fill_out_session'
 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'
 
 module Roqua
   module RomApi

data/lib/roqua/rom_api/create_fill_out_request.rb

@@ -3,7 +3,7 @@ module Roqua
     # @api private
     class CreateFillOutRequest < Endpoint
       string    :dossier_id
-      array     :questionnaire_keys, default: [] do string end
+      array     :questionnaire_keys, default: [] { string }
       string    :respondent_type, default: nil
       string    :callback_url
       array     :reminders, default: []
@@ -12,15 +12,16 @@ module Roqua
 
       def execute
         validate_response_for do
-          RomApi.basic_auth_session.post("/dossiers/#{dossier_id}/fill_out_requests", fill_out_request: {
-                                           questionnaire_keys: questionnaire_keys,
-                                           respondent_type: respondent_type,
-                                           callback_url: callback_url,
-                                           reminders: reminders,
-                                           open_from: open_from && open_from.to_i,
-                                           open_till: open_till && open_till.to_i
-                                         }.keep_if { |k, v| v.present? } )
-
+          fill_out_request = {
+            questionnaire_keys: questionnaire_keys,
+            respondent_type: respondent_type,
+            callback_url: callback_url,
+            reminders: reminders,
+            open_from: open_from && open_from.to_i,
+            open_till: open_till && open_till.to_i
+          }.keep_if { |_k, v| v.present? }
+          RomApi.basic_auth_session.post("/dossiers/#{dossier_id}/fill_out_requests",
+                                         fill_out_request: fill_out_request)
         end
       end
 

data/lib/roqua/rom_api/create_response.rb

@@ -0,0 +1,26 @@
+module Roqua
+  module RomApi
+    # @api private
+    class CreateResponse < Endpoint
+      string :questionnaire_key
+      string :dossier_id
+      hash   :answer_data,      strip: false
+      time   :filled_out_at,    default: nil
+      string :respondent,       default: nil
+
+      def execute
+        validate_response_for do
+          RomApi.basic_auth_session.post "/dossiers/#{dossier_id}/responses",
+                                         questionnaire_key: questionnaire_key,
+                                         answer_data: answer_data,
+                                         filled_out_at: filled_out_at.to_i,
+                                         respondent: respondent
+        end
+      end
+
+      def response_to_result(response)
+        Models::Response.new(response)
+      end
+    end
+  end
+end

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

@@ -10,7 +10,6 @@ module Roqua
         attribute :stop_at, DateTime
         attribute :protocol_key, String
         attribute :protocol_name, String
-
       end
     end
   end

data/lib/roqua/rom_api/report_calculations.rb

@@ -0,0 +1,39 @@
+module Roqua
+  module RomApi
+    # @api private
+    class ReportCalculations < Endpoint
+      string :dossier_id
+      string :calculator
+      array(:response_ids, default: nil) { string }
+      array(:questionnaire_keys, default: nil) { string }
+      time :completed_after, default: nil
+      time :completed_before, default: nil
+
+      validates :questionnaire_keys, presence: true, unless: 'response_ids.present?'
+
+      def execute
+        validate_response_for do
+          RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/report_calculations", params
+        end
+      end
+
+      private
+
+      def params
+        {calculator: calculator}.merge(filter_params)
+      end
+
+      def filter_params
+        if response_ids.present?
+          {response_ids: response_ids}
+        else
+          {filters: {
+            questionnaire_keys: questionnaire_keys,
+            completed_after: completed_after && completed_after.to_i,
+            completed_before: completed_before && completed_before.to_i
+          }}.keep_if { |_k, v| v.present? }
+        end
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/start_fill_out_session.rb

@@ -3,8 +3,8 @@ module Roqua
     # @api private
     class StartFillOutSession < Endpoint
       string :dossier_id
-      array :questionnaire_keys, default: [] do string end
-      array :response_ids, default: [] do integer end
+      array :questionnaire_keys, default: [] { string }
+      array :response_ids, default: [] { integer }
       string :return_to
       string :stylesheet, default: nil
 

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '0.1.7'
+    VERSION = '0.1.8'
   end
 end

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

@@ -1,13 +1,17 @@
 require 'spec_helper'
 
 describe CreateFillOutRequest do
-  let(:options)  { {dossier_id: 'some_dossier_id',
-                    questionnaire_keys: ['qkey1', 'qkey2'],
-                    respondent_type: 'patient_version',
-                    callback_url: 'http://callback.url',
-                    reminders: [1000, 2000],
-                    open_from: Time.now,
-                    open_till: Time.now + 100_000} }
+  let(:options) do
+    {
+      dossier_id: 'some_dossier_id',
+      questionnaire_keys: ['qkey1', 'qkey2'],
+      respondent_type: 'patient_version',
+      callback_url: 'http://callback.url',
+      reminders: [1000, 2000],
+      open_from: Time.now,
+      open_till: Time.now + 100_000
+    }
+  end
   let(:session)  { Sessions::BasicAuthSession.new }
   let(:response) { httparty_response({}) }
   before do
@@ -15,14 +19,17 @@ describe CreateFillOutRequest do
     allow(session).to receive(:post).and_return response
   end
 
-  it 'does a post to the rom fill_out_sessions api' do
-    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/fill_out_requests", fill_out_request: {
-                                           questionnaire_keys: options[:questionnaire_keys],
-                                           respondent_type: options[:respondent_type],
-                                           callback_url: options[:callback_url],
-                                           reminders: options[:reminders],
-                                           open_from: options[:open_from].to_i,
-                                           open_till: options[:open_till].to_i})
+  it 'does a post to the rom fill_out_requests api' do
+    fill_out_request = {
+      questionnaire_keys: options[:questionnaire_keys],
+      respondent_type: options[:respondent_type],
+      callback_url: options[:callback_url],
+      reminders: options[:reminders],
+      open_from: options[:open_from].to_i,
+      open_till: options[:open_till].to_i
+    }
+    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/fill_out_requests",
+                                           fill_out_request: fill_out_request)
     CreateFillOutRequest.run!(options)
   end
 
@@ -37,7 +44,7 @@ describe CreateFillOutRequest do
     options[:open_from] = nil
     options[:open_till] = nil
     options[:reminders] = nil
-    expect(session).to receive(:post) do |path, args|
+    expect(session).to receive(:post) do |_path, args|
       expect(args[:fill_out_request][:open_from]).to eq nil
       expect(args[:fill_out_request][:open_till]).to eq nil
       expect(args[:fill_out_request][:reminders]).to eq nil

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

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe CreateResponse do
+  let(:session)  { Sessions::BasicAuthSession.new }
+  let(:response) { httparty_response(questionnaire_name: 'Some Questionnaire') }
+  before do
+    allow(Sessions::BasicAuthSession).to receive(:new).and_return session
+    allow(session).to receive(:post).and_return response
+  end
+
+  it 'does a post to the rom responses api' do
+    filled_out_at = Time.now
+    expect(session).to receive(:post).with '/dossiers/some_dossier_id/responses',
+                                           questionnaire_key: 'some_questionnaire_key',
+                                           answer_data: {some: 'answer_data'},
+                                           filled_out_at: filled_out_at.to_i,
+                                           respondent: 'patient'
+    CreateResponse.run! dossier_id: 'some_dossier_id',
+                        questionnaire_key: 'some_questionnaire_key',
+                        answer_data: {some: 'answer_data'},
+                        filled_out_at: filled_out_at,
+                        respondent: 'patient'
+  end
+
+  it 'returns a response object' do
+    response = CreateResponse.run! dossier_id: 'some_dossier_id',
+                                   questionnaire_key: 'some_questionnaire_key',
+                                   answer_data: {some: 'answer_data'},
+                                   respondent: 'patient'
+    expect(response).to be_a(Response)
+    expect(response.questionnaire_name).to eq('Some Questionnaire')
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe ReportCalculations do
+  let(:options)  { {dossier_id: '1', calculator: 'calc'} }
+  let(:api_path) { "/dossiers/#{options[:dossier_id]}/report_calculations" }
+  let(:response) { httparty_response('foo' => 'bar') }
+  let(:session)  { Fabricate :basic_auth_session }
+
+  before do
+    allow(BasicAuthSession).to receive(:new).and_return session
+    allow(session).to receive(:get).and_return response
+  end
+
+  subject { ReportCalculations.run!(options) }
+
+  describe 'given a list of response_ids' do
+    let(:options)  { {dossier_id: '1', response_ids: ['1', '2'], calculator: 'calc'} }
+
+    it 'returns the response' do
+      expect(subject).to eq('foo' => 'bar')
+    end
+
+    it 'calls the right url' do
+      expect(session).to receive(:get).with(api_path, options.slice(:calculator, :response_ids))
+      subject
+    end
+  end
+
+  describe 'given a list of questionnaire_keys' do
+    let(:filters)  { {questionnaire_keys: ['q1', 'q2'],
+                      completed_after: Time.now - 100_000, completed_before: Time.now} }
+    let(:options)  { {dossier_id: '1', calculator: 'test'}.merge(filters) }
+
+    it 'calls the right url' do
+      filter_hash = {
+        questionnaire_keys: filters[:questionnaire_keys],
+        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)
+      subject
+    end
+  end
+
+  describe 'given neither response_ids or questionnaire_keys' do
+    let(:options)  { {dossier_id: '1', calculator: 'calc'} }
+
+    it 'should add an attr missing error' do
+      expect { subject }.to raise_error(ActiveInteraction::InvalidInteractionError)
+    end
+  end
+end

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

@@ -1,8 +1,14 @@
 require 'spec_helper'
 
 describe StartFillOutSession do
-  let(:options)  { {dossier_id: 'some_dossier_id', questionnaire_keys: ['some_key'],
-                    return_to: '/some/return/url', stylesheet: 'https://example.org/stylesheet.css'} }
+  let(:options)  do
+    {
+      dossier_id: 'some_dossier_id',
+      questionnaire_keys: ['some_key'],
+      return_to: '/some/return/url',
+      stylesheet: 'https://example.org/stylesheet.css'
+    }
+  end
   let(:session)  { Sessions::BasicAuthSession.new }
   let(:response) { httparty_response 'fill_out_url' => 'some_fill_out_url' }
   before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-10 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -142,12 +142,14 @@ files:
 - lib/roqua-rom-api.rb
 - lib/roqua/rom_api.rb
 - lib/roqua/rom_api/create_fill_out_request.rb
+- lib/roqua/rom_api/create_response.rb
 - lib/roqua/rom_api/endpoint.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/protocol_subscription.rb
 - lib/roqua/rom_api/models/response.rb
+- lib/roqua/rom_api/report_calculations.rb
 - lib/roqua/rom_api/sessions.rb
 - lib/roqua/rom_api/sessions/basic_auth_session.rb
 - lib/roqua/rom_api/start_fill_out_session.rb
@@ -157,11 +159,13 @@ files:
 - roqua_rom_api.gemspec
 - spec/fabricators/basic_auth_session_fabricator.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/list_protocol_subscriptions_spec.rb
 - spec/lib/roqua/rom_api/list_responses_spec.rb
 - spec/lib/roqua/rom_api/models/protocol_subscription_spec.rb
 - spec/lib/roqua/rom_api/models/response_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/start_protocol_subscription_spec.rb
@@ -197,11 +201,13 @@ summary: API wrapper gem around RoQua's ROM API
 test_files:
 - spec/fabricators/basic_auth_session_fabricator.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/list_protocol_subscriptions_spec.rb
 - spec/lib/roqua/rom_api/list_responses_spec.rb
 - spec/lib/roqua/rom_api/models/protocol_subscription_spec.rb
 - spec/lib/roqua/rom_api/models/response_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/start_protocol_subscription_spec.rb