roqua-rom-api 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce8decd48dd3da616e6eb16c463ecc8f8603f104
-  data.tar.gz: 2bde7738950a4b361b882a06c50a4752475f6960
+  metadata.gz: 4bac266254c426f6b3dbc4f723bd32ffa354c30e
+  data.tar.gz: 0369fa376ee5388965c5398b1240832a35e5c86f
 SHA512:
-  metadata.gz: c5e0f2e97f3f2f7d17f06b7a45bf4a4d437cb258f17620ce6590effa94ae12e153d06e822c93117a3b08ff55adaa81944bf34535d33842ae8f5cd4c47ac6a8c6
-  data.tar.gz: 1ffdcdf567b1372c7e42f6f1fbc86ddcf232e258feb0ee19a7ce92ea6cf63f344efc6f3d0569e9c34d5fd8b5661d538a9d6f4567f0ed85350ac4fe469af3d9ab
+  metadata.gz: 01acfc52290ea193019465edda26b7a45fd3f864b88b0e8bceea5dd36234b7fcf443b5d8ca9e0675b731a533b82c1adf5393e8b7f8ca7c14d60fc44ccba6ca3f
+  data.tar.gz: c677875fc78ebfd6c9162682970d6d164ae95c92a4438dc01ffcaf8ecb058fbd339ec782e6936eaf648db4016accddc729de6debd20d2f7de9163a1daf1f61fa

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.1.9 / 2014-10-07
+
+* Add API endpoint for updating responses
+
 ### 0.1.8 / 2014-09-22
 
 * Add API endpoint for creating responses

data/Gemfile

@@ -5,6 +5,7 @@ gem 'httparty',           '= 0.12.0'
 gem 'active_interaction', '= 1.1.0'
 
 group :test do
-  gem 'guard-rspec',        '~> 4.2'
-  gem 'fuubar',             '~> 1.3'
+  gem 'guard-rspec',        '~> 4.3'
+  gem 'rb-readline',        '~> 0.5.1'
+  gem 'fuubar',             '~> 2.0.0'
 end

data/README.md

@@ -142,7 +142,14 @@ To retrieve filled out, pending or scheduled questionnaires run:
 
 #### Parameters
 
- * `dossier_id:`   [Required]                - Unique dossier identifier for the patient you want the responses for.
+ * `dossier_id:`    [Required] - Unique dossier identifier for the patient you want the responses for.
+ * `questionnaire_keys`          Only return responses on questionnaires whose key is listed
+ * `completed_before`            Only return responses filled out before the specified time
+ * `completed_after`             Only return responses filled out after the specified time
+ * `respondent_type`             Only return responses whose `completer_type` equals the given value
+ * `status`                      ['completed', 'aborted', 'open', 'scheduled'] Only return responses whose `status` equals the given value
+ * `protocol_subscription_id`    Only return responses associated to the protocol subscription with the given id
+
 
 When the request succeeds, an array of responses is returned:
 
@@ -168,7 +175,7 @@ To store an externally filled out questionnaire run:
  * `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
+ * `filled_out_at:`                   Timestamp indicating the time the questionnaire was filled out (greater or equal to 31 december 1999)
  * `respondent:`        ['patient'(default)|'parent'|'second_parent'|'teacher'|'caregiver']
                                     - String identifying the respondent which filled out the questionnaire
 
@@ -183,6 +190,34 @@ Else some validation errors are provided:
       log_or_display outcome.errors.full_messages
     end
 
+### Update
+
+To store external data on an existing pending response:
+
+    outcome = Roqua::RomApi::CreateResponse.run questionnaire_key: 'questionnaire_key',
+                                                dossier_id: 'dossier_id',
+                                                id: 230, # response 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
+ * `id:`                [Required]  - Id of the response object to update
+ * `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 (greater or equal to 31 december 1999)
+
+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/roqua/rom_api.rb

@@ -6,6 +6,7 @@ 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/update_response'
 require 'roqua/rom_api/start_fill_out_session'
 require 'roqua/rom_api/create_fill_out_request'
 require 'roqua/rom_api/start_protocol_subscription'

data/lib/roqua/rom_api/create_response.rb

@@ -2,18 +2,18 @@ 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
+      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,
+                                         filled_out_at: (filled_out_at.to_i if filled_out_at),
                                          respondent: respondent
         end
       end

data/lib/roqua/rom_api/list_responses.rb

@@ -3,10 +3,22 @@ module Roqua
     # @api private
     class ListResponses < Endpoint
       string :dossier_id
+      array  :questionnaire_keys,       default: [] { string }
+      time   :completed_before,         default: nil
+      time   :completed_after,          default: nil
+      string :respondent_type,          default: nil
+      symbol :status,                   default: nil
+      string :protocol_subscription_id, default: nil
 
       def execute
         validate_response_for do
-          RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/responses"
+          RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/responses",
+                                        respondent_type: respondent_type,
+                                        status: status,
+                                        questionnaire_keys: questionnaire_keys,
+                                        completed_after: completed_after,
+                                        completed_before: completed_before,
+                                        protocol_subscription_id: protocol_subscription_id
         end
       end
 

data/lib/roqua/rom_api/update_response.rb

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

data/lib/roqua/rom_api/version.rb

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

data/roqua_rom_api.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'active_interaction', '~> 1.1'
   gem.add_dependency 'virtus',             '~> 1.0'
 
-  gem.add_development_dependency 'bundler',     '~> 1.0'
-  gem.add_development_dependency 'rake',        '~> 10.1'
+  gem.add_development_dependency 'bundler',     '~> 1.6'
+  gem.add_development_dependency 'rake',        '~> 10.2'
   gem.add_development_dependency 'yard',        '~> 0.8'
-  gem.add_development_dependency 'rspec',       '~> 2.14'
+  gem.add_development_dependency 'rspec',       '~> 3.0.0'
   gem.add_development_dependency 'fabrication', '~> 2.9'
 end

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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Endpoint do
   class TestEndpoint < Endpoint
-    model :response, class: RSpec::Mocks::Mock
+    model :response, class: RSpec::Mocks::Double
 
     def execute
       validate_response_for do

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

@@ -7,8 +7,33 @@ describe ListResponses do
   let(:session)  { Fabricate :basic_auth_session }
   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
+    ListResponses.run(dossier_id: options[:dossier_id],
+                      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').result
+  end
+
   it 'returns an array of response objects' do
-    allow(session).to receive(:get).with(api_path).and_return response
+    allow(session).to receive(:get).with(api_path,
+                                         respondent_type: nil,
+                                         status: nil,
+                                         questionnaire_keys: [],
+                                         completed_after: nil,
+                                         completed_before: nil,
+                                         protocol_subscription_id: nil)
+                                   .and_return response
     responses = ListResponses.run(options).result
 
     expect(responses).to be_a(Array)

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

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe UpdateResponse 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(:patch).and_return response
+  end
+
+  it 'does a post to the rom responses api' do
+    filled_out_at = Time.now
+    expect(session).to receive(:patch).with '/dossiers/some_dossier_id/responses/230',
+                                            questionnaire_key: 'some_questionnaire_key',
+                                            answer_data: {some: 'answer_data'},
+                                            filled_out_at: filled_out_at.to_i
+    UpdateResponse.run! dossier_id: 'some_dossier_id',
+                        questionnaire_key: 'some_questionnaire_key',
+                        id: 230,
+                        answer_data: {some: 'answer_data'},
+                        filled_out_at: filled_out_at
+  end
+
+  it 'returns a response object' do
+    response = UpdateResponse.run! dossier_id: 'some_dossier_id',
+                                   questionnaire_key: 'some_questionnaire_key',
+                                   answer_data: {some: 'answer_data'},
+                                   respondent: 'patient',
+                                   id: 230
+    expect(response).to be_a(Response)
+    expect(response.questionnaire_name).to eq('Some Questionnaire')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '10.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '10.2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: fabrication
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +155,7 @@ files:
 - lib/roqua/rom_api/start_fill_out_session.rb
 - lib/roqua/rom_api/start_protocol_subscription.rb
 - lib/roqua/rom_api/stop_protocol_subscription.rb
+- lib/roqua/rom_api/update_response.rb
 - lib/roqua/rom_api/version.rb
 - roqua_rom_api.gemspec
 - spec/fabricators/basic_auth_session_fabricator.rb
@@ -170,6 +171,7 @@ files:
 - spec/lib/roqua/rom_api/start_fill_out_session_spec.rb
 - spec/lib/roqua/rom_api/start_protocol_subscription_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
@@ -212,6 +214,7 @@ test_files:
 - spec/lib/roqua/rom_api/start_fill_out_session_spec.rb
 - spec/lib/roqua/rom_api/start_protocol_subscription_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