roqua-rom-api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da682d985d0f1bb2d2e18a3102d89b011e0afb75
-  data.tar.gz: 11a6c235df4e6e994b4d6eb3c82907fa22c1db1b
+  metadata.gz: e3f8ea4f36ee2e5dc8e00beed8c9a5becfb4f378
+  data.tar.gz: 8efa2129625a8f6efca60d7d6ab8731a49b432ee
 SHA512:
-  metadata.gz: 9017fb16837df479fa72b5f9e49b27b04915fd161d1246a46c9bf5601145c550992023d7453d918f0208726cf1dff3e25e64944c652744f75047bc28f70a4bfe
-  data.tar.gz: 847a62e1c49da738586b52459656055a24d996e20ae8dc6ba434f3bd89fd1ded413e547689e321eead4ee19b2f291cf7253f26badb2ea7c19e5560b32cce1ae8
+  metadata.gz: f340bf0b6bba37bcc393461fa3d8e90b5c373dad5f071e5947a5ed0ee77dd7aff97a4283e80aa2889f5b27341e5cf7a99fa943b69b8d1e41001c2ecca57af981
+  data.tar.gz: 36459698211d7cfc780f3f2d1dada4e7c2314180f19ccd70c8d252900986adfc20a52864cef1a88a02a5a746df91b039fbaabc2e4e1caf13034d11f0bef27d04

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 0.1.6 / 2014-07-02
+
+* Implement start\_fill\_out session for aborted answers
+* Add id to the responses api
+* Add 'aborted' status to the responses api
+* Allow multiple questionnaires in start\_fill\_out_session api
+
 ### 0.1.5 / 2014-06-10
 
 * Added CreateFillOutRequest

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec, cmd: 'bundle exec rspec --format Fuubar --colour' do
+guard :rspec, cmd: 'bundle exec rspec --format Fuubar --colour', failed_mode: :none do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -12,21 +12,47 @@ An HTTP basic auth username password combination can be generated in the RoQua a
 
 By default the ROM API Gem supports the `:nl` language only. If you use another locale or want to change some of the messages, simply extend your locale file by providing a value for some or all of the keys defined `config/locales/*.yml` in the root of this Gem.
 
-## FillOut Sessions
 
-To start filling out a questionnaire run:
+## Fill Out Requests
+
+See [api](http://roqua.github.io/developer/rom_v1/dossier/fill_out_requests/) for more info what this does and format of callbacks.
+
+To create a fill out request run:
+
+    Roqua::RomApi::CreateFillOutRequest.run! dossier_id: dossier_id,
+                                             questionnaire_keys: ['key1', 'key2'],
+                                             callback_url: notify_callback_path(token: 'secret')
+
+#### 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.
+
+
+## Fill Out Sessions
+
+To start filling out a set of questionnaires run:
 
     outcome = Roqua::RomApi::StartFillOutSession.run dossier_id: dossier_id,
-                                                     questionnaire_key: questionnaire_key,
+                                                     questionnaire_keys: questionnaire_keys,
                                                      return_to: '/some/return/url/or/path'
 
 #### Parameters
 
- * `dossier_id:`        [Required]           - Unique dossier identifier for the patient about to fill out a questionnaire.
- * `questionnaire_key:` [Required]           - Key uniquely identifying the questionnaire to be filled out.
- * `return_to:`         [Required]           - Address to return to after filling out the questionnaire.
+ * `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.
+ * `return_to:`          [Required]           - Address to return to after filling out the questionnaire.
 
-Redirect to the questionnaire url received when the outcome is valid:
+When questionnaire keys are provided, a set of blank questionnaires will be filled out. When response ids are provided,
+filling out questionnaires for these responses is resumed.
+
+Redirect to the fill_out url received when the outcome is valid:
 
     if outcome.valid?
       redirect_to outcome.result
@@ -37,6 +63,7 @@ or do something with the validation errors:
       log_or_display outcome.errors.full_messages
     end
 
+
 ## Protocol Subscriptions
 
 ### Index

data/config/locales/nl.yml

@@ -4,15 +4,13 @@ nl:
       models:
         roqua/rom_api/start_fill_out_session:
           attributes:
-            questionnaire_key:
-              questionnaire_not_found_by_key: met sleutel '%{value}' niet gevonden
         roqua/rom_api/start_protocol_subscription:
           attributes:
             protocol_key:
               protocol_not_found_by_key: met sleutel '%{value}' niet gevonden
     attributes:
       roqua/rom_api/start_fill_out_session:
-        questionnaire_key: Vragenlijst
+        questionnaire_keys: Vragenlijsten
         return_to: Return url
       roqua/rom_api/start_protocol_subscription:
-        protocol_key: Protocol
+        protocol_key: Protocol

data/lib/roqua/rom_api/endpoint.rb

@@ -6,12 +6,14 @@ module Roqua
 
       def validate_response_for
         response = yield
-        if response.is_a?(Hash) && response['errors']
+        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
             end
           end
+        elsif response.code == 422
+          errors.add :base, 'Validations failed!'
         else
           response_to_result response
         end

data/lib/roqua/rom_api/sessions/basic_auth_session.rb

@@ -48,7 +48,7 @@ module Roqua
           when 401
             access_denied(response)
           else
-            fail response.parsed_response || 'error'
+            fail response.parsed_response || "Received HTTP response code #{response.code}!"
           end
         end
 

data/lib/roqua/rom_api/start_fill_out_session.rb

@@ -3,21 +3,25 @@ module Roqua
     # @api private
     class StartFillOutSession < Endpoint
       string :dossier_id
-      string :questionnaire_key
+      array :questionnaire_keys, default: [] do string end
+      array :response_ids, default: [] do integer end
       string :return_to
       string :stylesheet, default: nil
 
+      validates :questionnaire_keys, presence: {unless: -> { response_ids.present? }}
+
       def execute
         validate_response_for do
           RomApi.basic_auth_session.post("/dossiers/#{dossier_id}/fill_out_sessions",
-                                         questionnaire_key: questionnaire_key,
+                                         questionnaire_keys: questionnaire_keys,
+                                         response_ids: response_ids,
                                          return_to: return_to,
                                          stylesheet: stylesheet)
         end
       end
 
       def response_to_result(response)
-        response['questionnaire_url']
+        response['fill_out_url']
       end
     end
   end

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '0.1.5'
+    VERSION = '0.1.6'
   end
 end

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

@@ -1,15 +1,15 @@
 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(:session) { Sessions::BasicAuthSession.new }
-  let(:response) { double('response', :[] => nil) }
+  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(:session)  { Sessions::BasicAuthSession.new }
+  let(:response) { httparty_response({}) }
   before do
     allow(Sessions::BasicAuthSession).to receive(:new).and_return session
     allow(session).to receive(:post).and_return response
@@ -27,12 +27,13 @@ describe CreateFillOutRequest do
   end
 
   it 'returns the id of the created fill_out_request' do
-    allow(session).to receive(:post).and_return 'id' => 'fill_out_request_id'
+    response['id'] = 'fill_out_request_id'
     outcome = CreateFillOutRequest.run(options)
     expect(outcome.result).to eq('fill_out_request_id')
   end
 
   it 'accepts explicit nil values' do
+    response['id'] = 'fill_out_request_id'
     options[:open_from] = nil
     options[:open_till] = nil
     options[:reminders] = nil
@@ -40,7 +41,7 @@ describe CreateFillOutRequest do
       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
-      {'id' => 'fill_out_request_id'}
+      response
     end
     CreateFillOutRequest.run!(options)
   end

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

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe Endpoint do
   class TestEndpoint < Endpoint
-    hash :response, strip: false
+    model :response, class: RSpec::Mocks::Mock
 
     def execute
       validate_response_for do
-        response.stringify_keys
+        response
       end
     end
 
@@ -16,31 +16,51 @@ describe Endpoint do
   end
 
   describe 'with validations' do
+    let(:response) do
+      double('httparty_repsonse', code: 200, parsed_response: {}).tap do |response|
+        allow(response).to receive(:[]).with('key').and_return ['values']
+        allow(response).to receive(:[]).with('errors').and_return []
+      end
+    end
+
     it 'returns the parsed response' do
-      outcome = TestEndpoint.run response: {'key' => ['values']}
+      outcome = TestEndpoint.run response: response
       expect(outcome.result).to eq(['values'])
     end
 
     it 'is valid' do
-      result = TestEndpoint.run response: {'key' => ['values']}
+      result = TestEndpoint.run response: response
       expect(result).to be_valid
     end
 
     context 'when the response contains errors' do
+      before do
+        allow(response).to receive(:[]).with('errors').and_return('base' => ['some_annoying_error'])
+      end
+
       it 'adds the errors' do
-        outcome = TestEndpoint.run response: {'errors' => {'base' => ['Some annoying error']}}
+        outcome = TestEndpoint.run response: response
         expect(outcome.errors.full_messages.first).to match('Some annoying error')
       end
 
       it 'marks the outcome as invalid' do
-        outcome = TestEndpoint.run response: {'errors' => {'base' => ['Some annoying error']}}
+        outcome = TestEndpoint.run response: response
         expect(outcome).not_to be_valid
       end
 
       it 'does not return a result' do
-        outcome = TestEndpoint.run response: {'errors' => {'base' => ['Some annoying error']}}
+        outcome = TestEndpoint.run response: response
         expect(outcome.result).to be_nil
       end
     end
+
+    context 'when the response code is 422 but the response contains no errors' do
+      it 'adds an error to base' do
+        allow(response).to receive(:code).and_return 422
+        outcome = TestEndpoint.run response: response
+        expect(outcome).not_to be_valid
+        expect(outcome.errors.full_messages).to include('Validations failed!')
+      end
+    end
   end
 end

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe ListProtocolSubscriptions do
   let(:options)  { {dossier_id: '1'} }
   let(:api_path) { "/dossiers/#{options[:dossier_id]}/protocol_subscriptions" }
-  let(:response) { [{"id" => 1}] }
+  let(:response) { httparty_response [{'id' => 1}] }
   let(:session)  { Fabricate :basic_auth_session }
   before { allow(BasicAuthSession).to receive(:new).and_return session }
 

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe ListResponses do
   let(:options)  { {dossier_id: '1'} }
   let(:api_path) { "/dossiers/#{options[:dossier_id]}/responses" }
-  let(:response) { [{"questionnaire_name" => "response_1"}, {"questionnaire_name" => "response_2"}] }
+  let(:response) { httparty_response [{"questionnaire_name" => "response_1"}, {"questionnaire_name" => "response_2"}] }
   let(:session)  { Fabricate :basic_auth_session }
   before { allow(BasicAuthSession).to receive(:new).and_return session }
 

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

@@ -1,26 +1,41 @@
 require 'spec_helper'
 
 describe StartFillOutSession do
-  let(:options) { {dossier_id: 'some_dossier_id', questionnaire_key: 'some_key',
-                   return_to: '/some/return/url', stylesheet: 'https://example.org/stylesheet.css'} }
-  let(:session) { Sessions::BasicAuthSession.new }
-  let(:response) { double('response', :[] => nil) }
+  let(:options)  { {dossier_id: 'some_dossier_id', questionnaire_keys: ['some_key'],
+                    return_to: '/some/return/url', stylesheet: 'https://example.org/stylesheet.css'} }
+  let(:session)  { Sessions::BasicAuthSession.new }
+  let(:response) { httparty_response 'fill_out_url' => 'some_fill_out_url' }
   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 fill_out_sessions api' do
+    options[:response_ids] = [1, 2]
     expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/fill_out_sessions",
-                                           questionnaire_key: options[:questionnaire_key],
+                                           questionnaire_keys: options[:questionnaire_keys],
+                                           response_ids: options[:response_ids],
                                            return_to: options[:return_to],
                                            stylesheet: options[:stylesheet])
     StartFillOutSession.run!(options)
   end
 
-  it 'returns the received questionnaire url' do
-    allow(session).to receive(:post).and_return 'questionnaire_url' => 'some_questionnaire_url'
+  it 'returns the received fill_out url' do
     outcome = StartFillOutSession.run(options)
-    expect(outcome.result).to eq('some_questionnaire_url')
+    expect(outcome.result).to eq('some_fill_out_url')
+  end
+
+  it 'validates the presence of questionnaire keys' do
+    options[:questionnaire_keys] = []
+    outcome = StartFillOutSession.run(options)
+    expect(outcome).not_to be_valid
+    expect(outcome.errors.full_messages).to include("Questionnaire keys can't be blank")
+  end
+
+  it 'does not validate the presence of questionnaire keys when answer_ids are given' do
+    options[:questionnaire_keys] = []
+    options[:response_ids] = [1, 2]
+    outcome = StartFillOutSession.run(options)
+    expect(outcome).to be_valid
   end
 end

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

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe StartProtocolSubscription do
-  let(:options) { {dossier_id: 'some_dossier_id', protocol_key: 'some_key'} }
-  let(:session) { Sessions::BasicAuthSession.new }
-  let(:response) { double('response', :[] => nil) }
+  let(:options)  { {dossier_id: 'some_dossier_id', protocol_key: 'some_key'} }
+  let(:session)  { Sessions::BasicAuthSession.new }
+  let(:response) { httparty_response({}) }
   before do
     allow(Sessions::BasicAuthSession).to receive(:new).and_return session
     allow(session).to receive(:post).and_return response

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

@@ -2,9 +2,8 @@ require 'spec_helper'
 
 describe StopProtocolSubscription do
   let(:options)  { {dossier_id: 'some_dossier_id', protocol_subscription_id: 'some_protsub_id'} }
-  let(:response) { double('response', :[] => nil) }
-
-  let(:session) { Fabricate :basic_auth_session }
+  let(:response) { httparty_response({}) }
+  let(:session)  { Fabricate :basic_auth_session }
   before do
     allow(Sessions::BasicAuthSession).to receive(:new).and_return session
     allow(session).to receive(:delete).and_return response

data/spec/spec_helper.rb

@@ -4,3 +4,7 @@ require 'roqua-rom-api'
 include Roqua::RomApi
 include Roqua::RomApi::Sessions
 include Roqua::RomApi::Models
+
+Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'support', '*.rb')].each {|f| require f}
+
+I18n.load_path << Dir[File.join(File.expand_path(File.dirname(__FILE__)), 'support', '*.yml')]

data/spec/support/httparty_helpers.rb

@@ -0,0 +1,5 @@
+def httparty_response(response_data)
+  allow(response_data).to receive(:code).and_return 200
+  allow(response_data).to receive(:parsed_response).and_return response_data
+  response_data
+end

data/spec/support/test.yml

@@ -0,0 +1,8 @@
+en:
+  active_interaction:
+    errors:
+      models:
+        test_endpoint:
+          attributes:
+            base:
+              some_annoying_error: Some annoying error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -168,6 +168,8 @@ files:
 - spec/lib/roqua/rom_api/stop_protocol_subscription_spec.rb
 - spec/lib/roqua_rom_api_spec.rb
 - spec/spec_helper.rb
+- spec/support/httparty_helpers.rb
+- spec/support/test.yml
 homepage: https://github.com/roqua/roqua/blob/master/rom_api/README.md
 licenses:
 - MIT
@@ -188,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
@@ -206,4 +208,6 @@ test_files:
 - spec/lib/roqua/rom_api/stop_protocol_subscription_spec.rb
 - spec/lib/roqua_rom_api_spec.rb
 - spec/spec_helper.rb
+- spec/support/httparty_helpers.rb
+- spec/support/test.yml
 has_rdoc: