roqua-rom-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d62c6a258bb660e3611e4a7494931145d54966ed
-  data.tar.gz: 497c244e9b1b0d1e659bf232154d03cb4fa8cde7
+  metadata.gz: 6799541e853eb01fd30aa3acf6adf501f0dc9df1
+  data.tar.gz: b799b813379d314f5cde25a9d238bc910167b218
 SHA512:
-  metadata.gz: c419b26a1a7d6c1b871980f387aae35569024879102a0f8aa231b4c4ecab30e23c24b5e04fadc830e5157be77a5df6f5942f41f1c705b2e634e3d68b98010607
-  data.tar.gz: a610cff81e691ad11585dc20df220c32ef4d8f45dc997c7282b6c89aaa1174aa6c4921e8d6068509c1a50f2da4e8217c2911d3d90644cd8c15a86e9d1ccfefd6
+  metadata.gz: 4f8b7c6571b8f4170c95b2c002ff5b32065dc0b79e30668998eb6a5d6b2ca78dd5376c861bca06f9599785f128ea641c78295baf72363948a0883e07310f7630
+  data.tar.gz: b71f01c1dbdadacf838a526454d6bbc23bc87101bc658796b03ae06b92ca3f5cbae2e7708d328b2417a7e635cd4e9f36a12919748cec60b207e50d1957604425

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.0.3 / 2014-02-18
+
+* Remove daily start time from api
+
 ### 0.0.2 / 2014-02-17
 
 * Raise when API response is not in 200 range

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roqua-rom-api (0.0.2)
+    roqua-rom-api (0.0.3)
       active_interaction (~> 1.0.4)
       httparty (~> 0.12.0)
 

data/README.md

@@ -1,16 +1,37 @@
 # roqua-rom-api
 
-Description goes here.
+Make sure the following environment variables are defined:
+
+    ENV['ROQUA_ROM_HOST']    # uri of the RoQua application whose API you are targeting
+    ENV['ROQUA_ROM_KEY']     # username used for HTTP basic authentication on the RoQua API
+    ENV['ROQUA_ROM_SECRET']  # password used for HTTP basic authentication on the RoQua API
+
+A HTTP basic auth username password combination can be generated in the RoQua admin interface integration tab
+
+## Protocol Subscriptions
+
+To subscribe to a protocol run the following command:
+
+    Roqua::RomApi::StartProtocolSubscription.run dossier_id: dossier_id,
+                                                 protocol_key: protocol_key,
+                                                 start_at: start_at
+
+#### Subscription options
+
+ * `dossier_id:`   [Required]                - Unique identifier for the patient to be subscribed.
+ * `protocol_key:` [Required]                - Key uniquely identifying the protocol of interest as specified in RoQua.
+ * `start_at:`     [Defaults to the present] - Timestamp specifying when the first measurement should be prepared.
+
 
 ## 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.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+ * Fork the project.
+ * Start a feature/bugfix branch.
+ * Commit and push until you are happy with your contribution.
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 ## Copyright
 

data/lib/roqua/rom_api/base.rb

@@ -2,6 +2,7 @@ require 'httparty'
 
 module Roqua
   module RomApi
+    # @api private
     class Base
       def self.get(url, params = {})
         HTTParty.get(api_base + url + '.json', query: params, basic_auth: authentication)

data/lib/roqua/rom_api/start_protocol_subscription.rb

@@ -1,17 +1,17 @@
 module Roqua
   module RomApi
+    # @api private
     class StartProtocolSubscription < ActiveInteraction::Base
       string :dossier_id
       string :protocol_key
       time :start_at, default: nil
-      integer :daily_start_time, default: nil
 
       def execute
-        response = Base.post '/protocol_subscriptions', dossier_id: dossier_id,
-                                                        protocol_key: protocol_key,
-                                                        start_at: (start_at.to_i if start_at),
-                                                        daily_start_time: daily_start_time
-        fail response.inspect unless response.code / 100 == 2
+        options = {dossier_id: dossier_id,
+                   protocol_key: protocol_key}
+        options[:start_at] = start_at.to_i if start_at
+        response = Base.post '/protocol_subscriptions', options
+        fail response.parsed_response.inspect unless response.code / 100 == 2
         response
       end
     end

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

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

@@ -3,20 +3,25 @@ require 'spec_helper'
 describe StartProtocolSubscription do
   let(:options) do
     {dossier_id: 'some_dossier_id',
-     protocol_key: 'some_key',
-     start_at: Time.now,
-     daily_start_time: 32400}       # nine o'clock
+     protocol_key: 'some_key'}       # nine o'clock
   end
 
   it 'does a post to the rom protocol_subscription api' do
     expect(Base).to receive(:post).with('/protocol_subscriptions', dossier_id: options[:dossier_id],
-                                                                   protocol_key: options[:protocol_key],
-                                                                   start_at: options[:start_at].to_i,
-                                                                   daily_start_time: options[:daily_start_time])
+                                                                   protocol_key: options[:protocol_key])
                                   .and_return double('response', code: 200)
     StartProtocolSubscription.run(options)
   end
 
+  it 'passes in the start_at option when provided' do
+    start_at = Time.now
+    expect(Base).to receive(:post).with('/protocol_subscriptions', dossier_id: options[:dossier_id],
+                                                                   protocol_key: options[:protocol_key],
+                                                                   start_at: start_at.to_i)
+                                  .and_return double('response', code: 200)
+    StartProtocolSubscription.run(options.merge start_at: start_at)
+  end
+
   it 'raises when the response HTTP status is not in the 200 range' do
     allow(Base).to receive(:post).and_return double('response', code: 401)
     expect { StartProtocolSubscription.run(options) }.to raise_error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty