roqua-rom-api 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1232ec18176d8cb41e579dadce78775014e70034
-  data.tar.gz: 94bd0b445ebc2ea4cd317312ca3e2c2c410753fe
+SHA256:
+  metadata.gz: f93240e16e4d8389c9b002a0093974f5eb830c8b7b52ae38751d92dc90cb9295
+  data.tar.gz: e4dea8ee1a71809ad2e4dcf70663ac2ec5c912aff199a16a8f8fc09b28f48389
 SHA512:
-  metadata.gz: d37f46dface65bab1ce4a1607dda74d34285b48187f8d5982a5df0702355c8bd9cf03dfd86582fdce61b8b7a79d66af5d1b31a0ca0b82f4c9a5a9a8c36d5c220
-  data.tar.gz: a3dbaf436487a0951aa6dd1ea0bed1b145142f7f05db105ade285950bc4b709857b95b1509fbb935e9c39e72628726256808ef7e87062813d701eddf61291704
+  metadata.gz: f7a101b1214e3b626007dcc9a49c1531deb3fa986d83b82f750f208230de88fe7619724667f7851676e74714040a5ecd402bafe4bec4ecd3c9af4d8cfd9a658d
+  data.tar.gz: 877e509d76bbd5de5f8b538ffdb5da70f5b5b992549f1cf6e43db674af12df2c532b8868283c1dae1a8cbb371dc85c052c805b98e7a668b0cdce337be4738114

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ### HEAD
 
+### 2.2.1 / 2018-06-06
+
+* Add key attribute to Protocol model
+* Allow protocol_id as parameter for StartProtocolSubscription
+
 ### 2.2.0 / 2017-02-12
 
 * Added ListNonResponses

data/Gemfile

@@ -3,8 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'fuubar', '~> 2.0.0'
   gem 'guard-bundler'
   gem 'guard-rspec',        '~> 4.3'
   gem 'rb-readline',        '~> 0.5.1'
-  gem 'fuubar',             '~> 2.0.0'
 end

data/lib/roqua/rom_api/cancel_fill_out_request.rb

@@ -1,10 +1,15 @@
 module Roqua
   module RomApi
-    # @api private
+    # @example To create a fill out request run:
+    #   Roqua::RomApi::CancelFillOutRequest.run! \
+    #     dossier_id: dossier_id,
+    #     fill_out_request_id: for_id
     class CancelFillOutRequest < Endpoint
       string :dossier_id
       string :fill_out_request_id
 
+      private
+
       def execute
         validate_response_for do
           basic_auth_session.delete("/dossiers/#{dossier_id}/fill_out_requests/#{fill_out_request_id}")

data/lib/roqua/rom_api/create_fill_out_request.rb

@@ -1,6 +1,12 @@
 module Roqua
   module RomApi
-    # @api private
+    # @example 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')
+    #
+    # @see http://docs.roqua.net/developer/rom/dossier/fill_out_requests/ for more info on how callbacks work.
     class CreateFillOutRequest < Endpoint
       string    :dossier_id
       integer   :measurement_sequence_id, default: nil
@@ -8,11 +14,13 @@ module Roqua
       string    :respondent_type, default: nil
       string    :callback_url, default: nil
       array     :reminders, default: []
-      time :open_from, default: nil, allow_nil: true
-      time :open_till, default: nil, allow_nil: true
+      time      :open_from, default: nil, allow_nil: true
+      time      :open_till, default: nil, allow_nil: true
 
       validates :dossier_id, presence: {allow_blank: false}
 
+      private
+
       def execute
         validate_response_for do
           fill_out_request = {

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

@@ -6,11 +6,26 @@ module Roqua
       class Protocol
         include Virtus.model
 
+        # @!attribute [r] id
+        #   @return [Integer]
         attribute :id, Integer
+        # @!attribute key
+        #   @return [String]
+        attribute :key, String
+        # @!attribute name
+        #   @return [String]
         attribute :name, String
+        # @!attribute description
+        #   @return [String]
         attribute :description, String
+        # @!attribute active
+        #   @return [Boolean]
         attribute :active, Boolean
+        # @!attribute automatic
+        #   @return [Boolean]
         attribute :automatic, Boolean
+        # @!attribute measurements
+        #   @return [Array<Measurement>]
         attribute :measurements, Array[Models::Measurement]
       end
     end

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

@@ -9,6 +9,7 @@ module Roqua
         attribute :id, Integer
         attribute :label, String
         attribute :respondent_type, String
+        attribute :sbg_code, String
       end
     end
   end

data/lib/roqua/rom_api/start_protocol_subscription.rb

@@ -3,13 +3,14 @@ module Roqua
     # @api private
     class StartProtocolSubscription < Endpoint
       string :dossier_id
-      string :protocol_key
+      string :protocol_key, default: nil # Pass the key
+      integer :protocol_id, default: nil # or the id
       time :start_at, default: nil
       hash :flags, default: {}, strip: false
       hash :textvars, default: {}, strip: false
 
       def execute
-        options = {protocol_key: protocol_key, flags: flags, textvars: textvars}
+        options = {protocol_key: protocol_key, protocol_id: protocol_id, flags: flags, textvars: textvars}
         options[:start_at] = start_at.to_i if start_at
         validate_response_for do
           basic_auth_session.post("/dossiers/#{dossier_id}/protocol_subscriptions", options)

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '2.2.0'
+    VERSION = '2.2.1'
   end
 end

data/spec/fabricators/basic_auth_session_fabricator.rb

@@ -2,6 +2,6 @@ Fabricator(:basic_auth_session, from: Roqua::RomApi::Sessions::BasicAuthSession)
   initialize_with do
     Roqua::RomApi::Sessions::BasicAuthSession.new username: 'some_username',
                                                   password: 'some_password',
-                                                  rom_host: 'http://roqua.dev'
+                                                  rom_host: 'http://test.rom.roqua.eu'
   end
 end

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

@@ -4,7 +4,7 @@ describe FillOutRequest do
   let(:response_body) do
     {'id' => 123,
      'respondent_type' => 'patient_version',
-     'completing_url' => 'http://roqua.dev/client/session/new?token=26aee9a4'
+     'completing_url' => 'http://test.rom.roqua.eu/client/session/new?token=26aee9a4'
     }
   end
 
@@ -12,6 +12,6 @@ describe FillOutRequest do
     response = FillOutRequest.new response_body
     expect(response.id).to eq 123
     expect(response.respondent_type).to    eq 'patient_version'
-    expect(response.completing_url).to     eq 'http://roqua.dev/client/session/new?token=26aee9a4'
+    expect(response.completing_url).to     eq 'http://test.rom.roqua.eu/client/session/new?token=26aee9a4'
   end
 end

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

@@ -13,7 +13,7 @@ describe Response do
      'completer_type' => 'patient',
      'completed_at' => nil,
      'status' => 'open',
-     'completing_url' => 'http://roqua.dev/client/session/new?token=26aee9a4',
+     'completing_url' => 'http://test.rom.roqua.eu/client/session/new?token=26aee9a4',
      'values' => {'some' => 'values'},
      'outcome' => {'some' => 'outcome'}}
   end
@@ -31,7 +31,7 @@ describe Response do
     expect(response.completed_at).to       eq nil
     expect(response.completer_type).to     eq 'patient'
     expect(response.status).to             eq 'open'
-    expect(response.completing_url).to     eq 'http://roqua.dev/client/session/new?token=26aee9a4'
+    expect(response.completing_url).to     eq 'http://test.rom.roqua.eu/client/session/new?token=26aee9a4'
     expect(response.values).to             eq('some' => 'values')
     expect(response.outcome).to            eq('some' => 'outcome')
   end

data/spec/lib/roqua/rom_api/sessions/basic_auth_session_spec.rb

@@ -48,7 +48,7 @@ describe BasicAuthSession do
 
   describe '#get' do
     it 'performs a get request' do
-      expect(HTTParty).to receive(:get).with('http://roqua.dev/api/v1/some_path.json',
+      expect(HTTParty).to receive(:get).with('http://test.rom.roqua.eu/api/v1/some_path.json',
                                              query: {some: 'param'},
                                              basic_auth: {username: 'some_username', password: 'some_password'})
                                        .and_return(response)

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe StartProtocolSubscription do
-  let(:options)  { {dossier_id: 'some_dossier_id', protocol_key: 'some_key',
+  let(:options)  { {dossier_id: 'some_dossier_id', protocol_key: 'some_key', protocol_id: nil,
                     flags: {some_flag: true}, textvars: {some_var: 'string'}} }
   let(:session)  { Sessions::BasicAuthSession.new }
   let(:response) { httparty_response({}) }
@@ -13,6 +13,7 @@ describe StartProtocolSubscription do
   it 'does a post to the rom protocol_subscription api' do
     expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions",
                                            protocol_key: options[:protocol_key],
+                                           protocol_id: options[:protocol_id],
                                            flags: {some_flag: true},
                                            textvars: {some_var: 'string'})
     StartProtocolSubscription.run!(options)
@@ -22,6 +23,7 @@ describe StartProtocolSubscription do
     start_at = Time.now
     expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions",
                                            protocol_key: options[:protocol_key],
+                                           protocol_id: options[:protocol_id],
                                            start_at: start_at.to_i,
                                            flags: {some_flag: true},
                                            textvars: {some_var: 'string'})

data/spec/spec_helper.rb

@@ -6,6 +6,11 @@ include Roqua::RomApi
 include Roqua::RomApi::Sessions
 include Roqua::RomApi::Models
 
+# It seems sometimes the Rails constant is defined and Rails.root is injected (which is nil at that moment) resulting
+# in missing fabricators. Let's just set the path to the current directory to fix this. See:
+# https://github.com/paulelliott/fabrication/blob/42db96f11cbf80d22bd9c87dbf6740894c2b2bdc/lib/fabrication/config.rb#L42
+Fabrication::Config.path_prefix = ['.']
+
 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')]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Samuel Esposito
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
@@ -283,4 +283,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/httparty_helpers.rb
 - spec/support/test.yml
-has_rdoc: