roqua-rom-api 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91d667b8631aa54589b366efad47bfeddef143d7
-  data.tar.gz: a795fc9d8ea7c2184b4ab58f378618c736457f76
+  metadata.gz: 9e4c9540bc5e468f4b51c4cfab6016fbcea74241
+  data.tar.gz: 1404eaf705529199115775862aa7fe202fe80d16
 SHA512:
-  metadata.gz: cff1500644d1f5c89885b46055bd0283633d306cae2cf138904a0a5b1f23aa84c8c8dc40c89f42d0adee87a404dd43285af53f744f91890acacb12f00d424f7c
-  data.tar.gz: dd08a2bb94242e2945f6c1417e4c29568bdbcd1b8622abcbb57d2f4b5d10f3295641098cf3eff41da0c02489b56fa2aa2abc227c8336cc832e9e8054a29af5e7
+  metadata.gz: afcb437a07656bc8035000c59412f0799456b25f898409a976e1d8cd63f3676deca20919ecd9eea4501747223f585a60acd621e80500544238dca2be60847988
+  data.tar.gz: 288b8f042d92285cce3cbd16c793fb0cdd233d789ad3178794a8bb765086a068bdea06f24c96504fc71ff495627ef28bc12b8c5bae3d597495bce35df33fe9bd

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 0.0.9 / 2014-04-14
+
+* Added Virtus to the gemspec
+* Model::Response date attributes are DateTimes now.
+* Added list_protocol_subscriptions
+* Add fill_out sessions api
+
 ### 0.0.8 / 2014-03-13
 
 * rename env vars for consistency with roqua-core-api gem

data/Rakefile

@@ -24,8 +24,10 @@ task default: :spec
 
 task :release do
   # run bundle in parent dir to update Gemfile.lock
-  `cd ../ && bundle`
-  `git add ../Gemfile.lock && git commit -m 'update roqua-core-api in Gemfile.lock'`
+  Bundler.with_clean_env do
+    `bundle --gemfile=../Gemfile`
+  end
+  `git add ../Gemfile.lock && git commit -m 'update roqua-rom-api in Gemfile.lock'`
   # fetch tags first to prevent errors when releasing gem
   `git fetch --tags`
 end

data/lib/roqua/rom_api.rb

@@ -3,4 +3,15 @@ require 'roqua/rom_api/version'
 require 'roqua/rom_api/sessions'
 require 'roqua/rom_api/models'
 require 'roqua/rom_api/start_protocol_subscription'
-require 'roqua/rom_api/list_responses'
+require 'roqua/rom_api/stop_protocol_subscription'
+require 'roqua/rom_api/start_fill_out_session'
+require 'roqua/rom_api/list_responses'
+require 'roqua/rom_api/list_protocol_subscriptions'
+
+module Roqua
+  module RomApi
+    # Raised when a request failed due to an expired/non-existant session.
+    class NoSession < StandardError; end
+    class Unauthorized < StandardError; end
+  end
+end

data/lib/roqua/rom_api/list_protocol_subscriptions.rb

@@ -0,0 +1,12 @@
+module Roqua
+  module RomApi
+    # @api private
+    class ListProtocolSubscriptions < ActiveInteraction::Base
+      string :dossier_id
+      def execute
+        response = RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/protocol_subscriptions"
+        response['protocol_subscriptions'].map { |s| Models::ProtocolSubscription.new(s) }
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/list_responses.rb

@@ -3,13 +3,10 @@ module Roqua
     # @api private
     class ListResponses < ActiveInteraction::Base
       string :dossier_id
-
       def execute
         response = RomApi.basic_auth_session.get "/dossiers/#{dossier_id}/responses"
-        JSON.parse(response.body)['responses'].map do |response_entry|
-          Models::Response.new response_entry
-        end
+        response['responses'].map { |r| Models::Response.new(r) }
       end
     end
   end
-end
+end

data/lib/roqua/rom_api/models.rb

@@ -1 +1,2 @@
-require 'roqua/rom_api/models/response'
+require 'roqua/rom_api/models/response'
+require 'roqua/rom_api/models/protocol_subscription'

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

@@ -0,0 +1,19 @@
+module Roqua
+  module RomApi
+    module Models
+      class ProtocolSubscription
+        include Virtus # deprecated, should be Virtus.model for > 1.0
+
+        attribute :id, Integer
+        attribute :daily_start_time, Integer
+        attribute :next_run_time, DateTime
+        attribute :start_at, DateTime
+        attribute :stop_at, DateTime
+        attribute :state, String
+        attribute :protocol_key, String
+        attribute :protocol_name, String
+
+      end
+    end
+  end
+end

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

@@ -1,20 +1,19 @@
+require 'virtus'
+
 module Roqua
   module RomApi
     module Models
       class Response
-        attr_reader :response, :name, :open_from, :open_till, :completing_url, :completer_type, :completed_at, :status
+        include Virtus # deprecated, should be Virtus.model for > 1.0
 
-        def initialize(response)
-          @response       = response
-          @name           = response['name']
-          @open_from      = response['open_from']
-          @open_till      = response['open_till']
-          @completing_url = response['completing_url']
-          @completer_type = response['completer_type']
-          @status         = response['status']
-          @completed_at   = response['completed_at']
-        end
+        attribute :name, String
+        attribute :open_from, DateTime
+        attribute :open_till, DateTime
+        attribute :completing_url, String
+        attribute :completer_type, String
+        attribute :completed_at, DateTime
+        attribute :status, String
       end
     end
   end
-end
+end

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

@@ -33,15 +33,31 @@ module Roqua
         end
 
         def delete(path, params = {})
-          HTTParty.delete(full_url_for(path), query: params, basic_auth: basic_auth)
+          perform_request_or_fail do
+            HTTParty.delete(full_url_for(path), query: params, basic_auth: basic_auth)
+          end
         end
 
         private
 
         def perform_request_or_fail(&block)
           response = yield
-          fail response.parsed_response unless (200..299).include? response.code
-          response
+          case response.code
+          when 200..299, 422
+            response
+          when 401
+            access_denied(response)
+          else
+            fail response.parsed_response || 'error'
+          end
+        end
+
+        def access_denied(response)
+          if response.headers['WWW-Authenticate']
+            fail NoSession
+          else
+            fail Unauthorized
+          end
         end
 
         def full_url_for(path)
@@ -58,4 +74,4 @@ module Roqua
       end
     end
   end
-end
+end

data/lib/roqua/rom_api/start_fill_out_session.rb

@@ -0,0 +1,16 @@
+module Roqua
+  module RomApi
+    # @api private
+    class StartFillOutSession < ActiveInteraction::Base
+      string :dossier_id
+      string :questionnaire_key
+      string :return_to
+
+      def execute
+        RomApi.basic_auth_session.post("/dossiers/#{dossier_id}/fill_out_sessions",
+                                       questionnaire_key: questionnaire_key,
+                                       return_to: return_to).parsed_response
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/start_protocol_subscription.rb

@@ -7,10 +7,9 @@ module Roqua
       time :start_at, default: nil
 
       def execute
-        options = {dossier_id: dossier_id,
-                   protocol_key: protocol_key}
+        options = {protocol_key: protocol_key}
         options[:start_at] = start_at.to_i if start_at
-        RomApi.basic_auth_session.post('/protocol_subscriptions', options).parsed_response
+        RomApi.basic_auth_session.post("/dossiers/#{dossier_id}/protocol_subscriptions", options).parsed_response
       end
     end
   end

data/lib/roqua/rom_api/stop_protocol_subscription.rb

@@ -0,0 +1,14 @@
+module Roqua
+  module RomApi
+    # @api private
+    class StopProtocolSubscription < ActiveInteraction::Base
+      string :dossier_id
+      string :protocol_subscription_id
+
+      def execute
+        url = "/dossiers/#{dossier_id}/protocol_subscriptions/#{protocol_subscription_id}"
+        RomApi.basic_auth_session.delete(url).parsed_response
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/version.rb

@@ -1,5 +1,5 @@
 module Roqua
   module RomApi
-    VERSION = '0.0.8'
+    VERSION = '0.0.9'
   end
 end

data/roqua_rom_api.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'httparty',           '~> 0.12.0'
   gem.add_dependency 'active_interaction', '~> 1.1'
+  gem.add_dependency 'virtus' # ,             '~> 1.0' # Pavlov wants 0.5.5,
+                              # we keep it simple to be compliant with both.
 
   gem.add_development_dependency 'bundler',     '~> 1.0'
   gem.add_development_dependency 'rake',        '~> 10.1'

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

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe ListProtocolSubscriptions do
+  let(:options)  { {dossier_id: '1'} }
+  let(:api_path) { "/dossiers/#{options[:dossier_id]}/protocol_subscriptions" }
+  let(:response) { {"protocol_subscriptions" => [{"id" => 1}]} }
+  let(:session)  { Fabricate :basic_auth_session }
+  before { allow(BasicAuthSession).to receive(:new).and_return session }
+
+  it 'returns an array of response objects' do
+    allow(session).to receive(:get).with(api_path).and_return response
+    result = ListProtocolSubscriptions.run(options).result
+
+    expect(result).to be_a(Array)
+    expect(result.first).to be_a(ProtocolSubscription)
+    expect(result.first.id).to eq(1)
+  end
+end

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

@@ -3,16 +3,16 @@ require 'spec_helper'
 describe ListResponses do
   let(:options)  { {dossier_id: '1'} }
   let(:api_path) { "/dossiers/#{options[:dossier_id]}/responses" }
-  let(:response) { '{"responses":[{"name":"response_1"},{"name":"response_2"}]}'  }
-  let(:session) { Fabricate :basic_auth_session }
+  let(:response) { {"responses" => [{"name" => "response_1"}, {"name" => "response_2"}]} }
+  let(:session)  { Fabricate :basic_auth_session }
   before { allow(BasicAuthSession).to receive(:new).and_return session }
 
   it 'returns an array of response objects' do
-    allow(session).to receive(:get).with(api_path).and_return double(body: response)
+    allow(session).to receive(:get).with(api_path).and_return response
     result = ListResponses.run(options).result
 
     expect(result).to be_a(Array)
     expect(result.first).to be_a(Response)
     expect(result.first.name).to eq('response_1')
   end
-end
+end

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

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe ProtocolSubscription do
+  let(:response_body) do
+    {'id'               => 1,
+     'daily_start_time' => 300,
+     'next_run_time'    => nil,
+     'start_at'         => "2014-04-10T14:00:28+02:00",
+     'stop_at'          => nil,
+     'state'            => "a",
+     'protocol_key'     => "pkey",
+     'protocol_name'    => 'pname' }
+  end
+
+  it 'assigns fields to attr_accessors' do
+    protocol_subscription = ProtocolSubscription.new response_body
+    expect(protocol_subscription.id).to                eq 1
+    expect(protocol_subscription.daily_start_time).to  eq 300
+    expect(protocol_subscription.next_run_time).to     eq nil
+    expect(protocol_subscription.start_at).to          eq DateTime.parse("2014-04-10T14:00:28+02:00")
+    expect(protocol_subscription.stop_at).to           eq nil
+    expect(protocol_subscription.state).to             eq "a"
+    expect(protocol_subscription.protocol_key).to      eq 'pkey'
+    expect(protocol_subscription.protocol_name).to     eq 'pname'
+  end
+end

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

@@ -14,11 +14,11 @@ describe Response do
   it 'assigns fields to attr_accessors' do
     response = Response.new response_body
     expect(response.name).to            eq 'RS-12'
-    expect(response.open_from).to       eq '2014-02-19T14:15:49+01:00'
-    expect(response.open_till).to       eq '2014-02-20T14:15:49+01:00'
+    expect(response.open_from).to       eq DateTime.parse('2014-02-19T14:15:49+01:00')
+    expect(response.open_till).to       eq DateTime.parse('2014-02-20T14:15:49+01:00')
     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'
   end
-end
+end

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

@@ -11,11 +11,11 @@ describe BasicAuthSession do
       expect(session.rom_host).to eq('some_rom_host')
     end
 
-    it 'defaults the rom_host to the ROM_HOST env variable' do
-      orginal_env_rom_host = ENV['ROM_HOST']
-      ENV['ROM_HOST'] = 'some_env_rom_host'
+    it 'defaults the rom_host to the ROM_SITE env variable' do
+      orginal_env_rom_host = ENV['ROM_SITE']
+      ENV['ROM_SITE'] = 'some_env_rom_host'
       session = Roqua::RomApi.basic_auth_session
-      ENV['ROM_HOST'] = orginal_env_rom_host
+      ENV['ROM_SITE'] = orginal_env_rom_host
       expect(session.rom_host).to eq('some_env_rom_host')
     end
 
@@ -24,11 +24,11 @@ describe BasicAuthSession do
       expect(session.username).to eq('some_username')
     end
 
-    it 'defaults the username to the ROM_KEY env variable' do
-      orginal_env_rom_key = ENV['ROM_KEY']
-      ENV['ROM_KEY'] = 'some_env_rom_key'
+    it 'defaults the username to the ROM_BASICAUTH_ID env variable' do
+      orginal_env_rom_key = ENV['ROM_BASICAUTH_ID']
+      ENV['ROM_BASICAUTH_ID'] = 'some_env_rom_key'
       session = Roqua::RomApi.basic_auth_session
-      ENV['ROM_KEY'] = orginal_env_rom_key
+      ENV['ROM_BASICAUTH_ID'] = orginal_env_rom_key
       expect(session.username).to eq('some_env_rom_key')
     end
 
@@ -37,11 +37,11 @@ describe BasicAuthSession do
       expect(session.password).to eq('some_password')
     end
 
-    it 'defaults the password to the ROM_SECRET env variable' do
-      orginal_env_rom_secret = ENV['ROM_SECRET']
-      ENV['ROM_SECRET'] = 'some_env_rom_secret'
+    it 'defaults the password to the ROM_BASICAUTH_SECRET env variable' do
+      orginal_env_rom_secret = ENV['ROM_BASICAUTH_SECRET']
+      ENV['ROM_BASICAUTH_SECRET'] = 'some_env_rom_secret'
       session = Roqua::RomApi.basic_auth_session
-      ENV['ROM_SECRET'] = orginal_env_rom_secret
+      ENV['ROM_BASICAUTH_SECRET'] = orginal_env_rom_secret
       expect(session.password).to eq('some_env_rom_secret')
     end
   end
@@ -61,6 +61,20 @@ describe BasicAuthSession do
       expect { session.get '/some_path' }.to raise_error(RuntimeError, 'some_response')
     end
 
+    it 'throws a NoSession error if the basic auth is incorrect' do
+      allow(response).to receive(:code).and_return(401)
+      allow(HTTParty).to receive(:get).and_return(response)
+      allow(response).to receive(:headers).and_return('WWW-Authenticate' => 'Basic realm="Application"')
+      expect { session.get '/some_path' }.to raise_error(Roqua::RomApi::NoSession)
+    end
+
+    it 'throws a Unauthorized error on 401 without www-authenticate header' do
+      allow(response).to receive(:code).and_return(401)
+      allow(HTTParty).to receive(:get).and_return(response)
+      allow(response).to receive(:headers).and_return('foo' => 'bar')
+      expect { session.get '/some_path' }.to raise_error(Roqua::RomApi::Unauthorized)
+    end
+
     it 'returns the response' do
       allow(HTTParty).to receive(:get).and_return(response)
       expect(session.get '/some_path').to eq(response)

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

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe StartFillOutSession do
+  let(:options) { {dossier_id: 'some_dossier_id', questionnaire_key: 'some_key', return_to: '/some/return/url'} }
+  let(:session) { Sessions::BasicAuthSession.new }
+  let(:parsed_response) { double('parsed_response') }
+  let(:response) { double('response', parsed_response: parsed_response) }
+  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
+    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/fill_out_sessions",
+                                           questionnaire_key: options[:questionnaire_key],
+                                           return_to: options[:return_to])
+    StartFillOutSession.run!(options)
+  end
+
+  it 'returns the parsed response' do
+    expect(StartFillOutSession.run!(options)).to eq(parsed_response)
+  end
+end

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

@@ -11,16 +11,16 @@ describe StartProtocolSubscription do
   end
 
   it 'does a post to the rom protocol_subscription api' do
-    expect(session).to receive(:post).with('/protocol_subscriptions', dossier_id: options[:dossier_id],
-                                                                      protocol_key: options[:protocol_key])
+    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions",
+                                           protocol_key: options[:protocol_key])
     StartProtocolSubscription.run!(options)
   end
 
   it 'passes in the start_at option when provided' do
     start_at = Time.now
-    expect(session).to receive(:post).with('/protocol_subscriptions', dossier_id: options[:dossier_id],
-                                                                      protocol_key: options[:protocol_key],
-                                                                      start_at: start_at.to_i)
+    expect(session).to receive(:post).with("/dossiers/#{options[:dossier_id]}/protocol_subscriptions",
+                                           protocol_key: options[:protocol_key],
+                                           start_at: start_at.to_i)
     StartProtocolSubscription.run!(options.merge start_at: start_at)
   end
 

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe StopProtocolSubscription do
+  let(:options)  { {dossier_id: 'some_dossier_id', protocol_subscription_id: 'some_protsub_id'} }
+  let(:parsed_response) { double('parsed_response') }
+  let(:response) { double('response', parsed_response: parsed_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]}/protocol_subscriptions/#{options[:protocol_subscription_id]}"
+    expect(session).to receive(:delete).with(url)
+    StopProtocolSubscription.run!(options)
+  end
+end

data/spec/lib/roqua_rom_api_spec.rb

@@ -4,4 +4,4 @@ describe Roqua::RomApi do
   it "should have a VERSION constant" do
     expect(subject.const_get('VERSION')).to_not be_empty
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,19 +138,27 @@ files:
 - Rakefile
 - lib/roqua-rom-api.rb
 - lib/roqua/rom_api.rb
+- lib/roqua/rom_api/list_protocol_subscriptions.rb
 - lib/roqua/rom_api/list_responses.rb
 - lib/roqua/rom_api/models.rb
+- lib/roqua/rom_api/models/protocol_subscription.rb
 - lib/roqua/rom_api/models/response.rb
 - lib/roqua/rom_api/sessions.rb
 - lib/roqua/rom_api/sessions/basic_auth_session.rb
+- 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/version.rb
 - roqua_rom_api.gemspec
 - spec/fabricators/basic_auth_session_fabricator.rb
+- spec/lib/roqua/rom_api/list_protocol_subscriptions_spec.rb
 - spec/lib/roqua/rom_api/list_responses_spec.rb
+- spec/lib/roqua/rom_api/models/protocol_subscription_spec.rb
 - spec/lib/roqua/rom_api/models/response_spec.rb
 - spec/lib/roqua/rom_api/sessions/basic_auth_session_spec.rb
+- 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_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/roqua/roqua/blob/master/rom_api/README.md
@@ -165,10 +187,14 @@ 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/list_protocol_subscriptions_spec.rb
 - spec/lib/roqua/rom_api/list_responses_spec.rb
+- spec/lib/roqua/rom_api/models/protocol_subscription_spec.rb
 - spec/lib/roqua/rom_api/models/response_spec.rb
 - spec/lib/roqua/rom_api/sessions/basic_auth_session_spec.rb
+- 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_spec.rb
 - spec/spec_helper.rb
 has_rdoc: