roqua-rom-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b6c4bbe62c3f8fe5d798f7076baec87b0eeded9
-  data.tar.gz: 98929db7f55e728b9a2ce7d697d8cd1d97aa7a72
+  metadata.gz: 8fdae5cd03021f42ee36e88231c17528bce92494
+  data.tar.gz: 60d8978308dc7272f69ff4052497db5cee26cb9d
 SHA512:
-  metadata.gz: dd3b8f83aaf677e5e6826e11adc1ff89f6352e332a95a84a5b6c7f2a052bb9009a098e90583c58add5981f2bdc8dd0652ec383af46b9c1d82f1116c37434c32f
-  data.tar.gz: 4ecb7b6a00e6086605ec48c6cc0a3c6b89eb80b482d2154685306db7cc00d38b7cd952d7708183598fb17b6af480964e68c1b4808e004c35e286a499354c1f44
+  metadata.gz: 2fcfa215e3a6d850f226cacd2bbb7ff5b3ad429645cedae36d95633fea487c40c53fb14b3d4fe610e5acd67d167ca5acc8e92e0e0cf35f10977dcb4c308799ec
+  data.tar.gz: cf2b41dc88d3ca60cd004f9a5b188f34e6d6346f27a0b5f2dafb9d0f0616acda3b88b1cf78b840b70ba33f017e2c332d8383182854f69063faeead272847c858

data/ChangeLog.md

@@ -81,7 +81,7 @@
 * Instead of full messages the HTTP API returns hashes with attribute and error keys. The Ruby Gem uses these keys to compile localized messages using I18n.
 
 #### Validations
-* Some of the 422 response codes are changed to 404 and will now raise an exception when using the Ruby Gem. See the [HTTP API documentation](http://roqua.github.io/developer/rom_v1/dossier/) for more info.
+* Some of the 422 response codes are changed to 404 and will now raise an exception when using the Ruby Gem. See the [HTTP API documentation](http://docs.roqua.net/developer/rom_v1/dossier/) for more info.
 
 ### 0.1.1 / 2014-04-23
 

data/README.md

@@ -30,7 +30,7 @@ this means that you'll usually write a pattern like this:
     end
 
 
-## [Fill Out Requests](http://roqua.github.io/developer/rom/dossier/fill_out_requests/)
+## [Fill Out Requests](http://docs.roqua.net/developer/rom/dossier/fill_out_requests/)
 
 To create a fill out request run:
 
@@ -38,11 +38,11 @@ To create a fill out request run:
                                              questionnaire_keys: ['key1', 'key2'],
                                              callback_url: notify_callback_path(token: 'secret')
 
-See [api](http://roqua.github.io/developer/rom/dossier/fill_out_requests/) for more info on how callbacks work.
+See [api](http://docs.roqua.net/developer/rom/dossier/fill_out_requests/) for more info on how callbacks work.
 
 
 
-## [Fill Out Sessions](http://roqua.github.io/developer/rom/dossier/fill_out_sessions/)
+## [Fill Out Sessions](http://docs.roqua.net/developer/rom/dossier/fill_out_sessions/)
 
 To start filling out a set of questionnaires run:
 
@@ -58,15 +58,15 @@ Redirect to the fill_out url received when the outcome is valid:
       log_or_display outcome.errors.full_messages
     end
 
-## [Protocol Subscriptions](http://roqua.github.io/developer/rom/dossier/protocol_subscriptions/)
+## [Protocol Subscriptions](http://docs.roqua.net/developer/rom/dossier/protocol_subscriptions/)
 
-### [List](http://roqua.github.io/developer/rom/dossier/protocol_subscriptions/#list-active-protocol-subscriptions-for-a-patient)
+### [List](http://docs.roqua.net/developer/rom/dossier/protocol_subscriptions/#list-active-protocol-subscriptions-for-a-patient)
 
 To retrieve active protocol subscriptions run:
 
     outcome = Roqua::RomApi::ListProtocolSubscriptions.run dossier_id: dossier_id
 
-### [Start](http://roqua.github.io/developer/rom/dossier/protocol_subscriptions/#start-a-protocol-subscription)
+### [Start](http://docs.roqua.net/developer/rom/dossier/protocol_subscriptions/#start-a-protocol-subscription)
 
 To subscribe to a protocol run the following command:
 
@@ -74,22 +74,22 @@ To subscribe to a protocol run the following command:
                                                            protocol_key: protocol_key,
                                                            start_at: start_at
 
-### [Stop](http://roqua.github.io/developer/rom/dossier/protocol_subscriptions/#stop-a-protocol-subscription)
+### [Stop](http://docs.roqua.net/developer/rom/dossier/protocol_subscriptions/#stop-a-protocol-subscription)
 
 To unsubscribe from a protocol run the command:
 
     outcome = Roqua::RomApi::StopProtocolSubscription.run dossier_id: dossier_id,
                                                           protocol_subscription_id: subscription_id
 
-## [Responses](http://roqua.github.io/developer/rom/dossier/responses/)
+## [Responses](http://docs.roqua.net/developer/rom/dossier/responses/)
 
-### [List](http://roqua.github.io/developer/rom/dossier/responses/#list-all-responses-for-dossier)
+### [List](http://docs.roqua.net/developer/rom/dossier/responses/#list-all-responses-for-dossier)
 
 To retrieve filled out, pending or scheduled questionnaires run:
 
     outcome = Roqua::RomApi::ListResponses.run dossier_id: dossier_id
 
-### [Create](http://roqua.github.io/developer/rom/dossier/responses/#store-a-new-response)
+### [Create](http://docs.roqua.net/developer/rom/dossier/responses/#store-a-new-response)
 
 To store an externally filled out questionnaire run:
 
@@ -97,7 +97,7 @@ To store an externally filled out questionnaire run:
                                                 dossier_id: 'dossier_id',
                                                 answer_data: {some: 'aswer_data'}
 
-### [Update](http://roqua.github.io/developer/rom/dossier/responses/#update-a-response)
+### [Update](http://docs.roqua.net/developer/rom/dossier/responses/#update-a-response)
 
 To store external data on an existing pending response:
 
@@ -106,6 +106,14 @@ To store external data on an existing pending response:
                                                 id: 230, # response id,
                                                 answer_data: {some: 'aswer_data'}
 
+## [Stats](http://docs.roqua.net/developer/rom/dossier/stats/#stats)
+
+### [List](http://docs.roqua.net/developer/rom/dossier/stats/#stats)
+
+    outcome = Roqua::RomApi::ListDossierStats.run epd_ids: "comma,separated,list,of,epd,ids"
+
+To get stats for epd_ids:
+
 ## 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.
@@ -119,4 +127,3 @@ To store external data on an existing pending response:
 ## Copyright
 
 Copyright (c) 2014 RoQua. See LICENSE.txt for further details.
-

data/lib/roqua/rom_api.rb

@@ -10,6 +10,7 @@ require 'roqua/rom_api/update_response'
 require 'roqua/rom_api/create_measurement_sequence'
 require 'roqua/rom_api/start_fill_out_session'
 require 'roqua/rom_api/create_fill_out_request'
+require 'roqua/rom_api/cancel_fill_out_request'
 require 'roqua/rom_api/start_protocol_subscription'
 require 'roqua/rom_api/stop_protocol_subscription'
 require 'roqua/rom_api/report_calculations'

data/lib/roqua/rom_api/cancel_fill_out_request.rb

@@ -0,0 +1,15 @@
+module Roqua
+  module RomApi
+    # @api private
+    class CancelFillOutRequest < Endpoint
+      string :dossier_id
+      string :fill_out_request_id
+
+      def execute
+        validate_response_for do
+          RomApi.basic_auth_session.delete("/dossiers/#{dossier_id}/fill_out_requests/#{fill_out_request_id}")
+        end
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe CancelFillOutRequest do
+  let(:options)  { {dossier_id: 'some_dossier_id', fill_out_request_id: 'some_fill_out_request_id'} }
+  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
+  end
+
+  it 'does a post to the rom protocol_subscription api' do
+    url = "/dossiers/#{options[:dossier_id]}/fill_out_requests/#{options[:fill_out_request_id]}"
+    expect(session).to receive(:delete).with(url)
+    CancelFillOutRequest.run!(options)
+  end
+
+  it 'returns the response' do
+    expect(CancelFillOutRequest.run!(options)).to eq(response)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -141,6 +141,7 @@ files:
 - lib/i18n/i18n.rb
 - lib/roqua-rom-api.rb
 - lib/roqua/rom_api.rb
+- lib/roqua/rom_api/cancel_fill_out_request.rb
 - lib/roqua/rom_api/create_fill_out_request.rb
 - lib/roqua/rom_api/create_measurement_sequence.rb
 - lib/roqua/rom_api/create_response.rb
@@ -167,6 +168,7 @@ files:
 - lib/roqua/rom_api/version.rb
 - roqua_rom_api.gemspec
 - spec/fabricators/basic_auth_session_fabricator.rb
+- spec/lib/roqua/rom_api/cancel_fill_out_request_spec.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
@@ -208,12 +210,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
 test_files:
 - spec/fabricators/basic_auth_session_fabricator.rb
+- spec/lib/roqua/rom_api/cancel_fill_out_request_spec.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