roqua-rom-api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6799541e853eb01fd30aa3acf6adf501f0dc9df1
-  data.tar.gz: b799b813379d314f5cde25a9d238bc910167b218
+  metadata.gz: 05a0d9ec612437981f82ec1c3b7236437c6aa58b
+  data.tar.gz: bc1bb0cac2a640d4038ba6a165a1ab38a6da3b40
 SHA512:
-  metadata.gz: 4f8b7c6571b8f4170c95b2c002ff5b32065dc0b79e30668998eb6a5d6b2ca78dd5376c861bca06f9599785f128ea641c78295baf72363948a0883e07310f7630
-  data.tar.gz: b71f01c1dbdadacf838a526454d6bbc23bc87101bc658796b03ae06b92ca3f5cbae2e7708d328b2417a7e635cd4e9f36a12919748cec60b207e50d1957604425
+  metadata.gz: d5df8650874825cc203a28a51522b34079271d3b8f9e6624e928a3f04508661d6832093c71b3629a7c904a6aec34726d0f584af95919c46237e6712546e37c05
+  data.tar.gz: 8064fc956752998a5f42970b7b96553e9efb7c51de471e9e5a2a59438f7218fc83a1c0a46b8d29ce0642124944c77b33e644970620ab574339770dce63962b30

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.0.4 / 2014-03-06
+
+* Use BasicAuthSession for http requests instead of RomApi::Base class
+
 ### 0.0.3 / 2014-02-18
 
 * Remove daily start time from api

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    roqua-rom-api (0.0.3)
+    roqua-rom-api (0.0.4)
       active_interaction (~> 1.0.4)
       httparty (~> 0.12.0)
 
@@ -10,10 +10,10 @@ GEM
   specs:
     active_interaction (1.0.4)
       activemodel (>= 3, < 5)
-    activemodel (4.0.2)
-      activesupport (= 4.0.2)
+    activemodel (4.0.3)
+      activesupport (= 4.0.3)
       builder (~> 3.1.0)
-    activesupport (4.0.2)
+    activesupport (4.0.3)
       i18n (~> 0.6, >= 0.6.4)
       minitest (~> 4.2)
       multi_json (~> 1.3)
@@ -28,6 +28,7 @@ GEM
       nio4r (>= 0.5.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    fabrication (2.9.6)
     ffi (1.9.3)
     formatador (0.2.4)
     fuubar (1.3.2)
@@ -88,8 +89,10 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.0)
+  fabrication (~> 2.9.6)
   fuubar (~> 1.3.2)
   guard-rspec (~> 4.2.6)
   rake (~> 10.1)
   roqua-rom-api!
+  rspec (~> 2.14.1)
   yard (~> 0.8)

data/README.md

@@ -6,7 +6,7 @@ Make sure the following environment variables are defined:
     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
+An HTTP basic auth username password combination can be generated in the RoQua admin interface integration tab
 
 ## Protocol Subscriptions
 

data/lib/roqua/rom_api.rb

@@ -1,4 +1,6 @@
 require 'roqua/rom_api/version'
 require 'active_interaction'
-require 'roqua/rom_api/base'
-require 'roqua/rom_api/start_protocol_subscription'
+require 'roqua/rom_api/sessions'
+require 'roqua/rom_api/results'
+require 'roqua/rom_api/start_protocol_subscription'
+require 'roqua/rom_api/list_responses'

data/lib/roqua/rom_api/list_responses.rb

@@ -0,0 +1,18 @@
+module Roqua
+  module RomApi
+    # @api private
+    class ListResponses < ActiveInteraction::Base
+      include Sessions
+      include Results
+      string :dossier_id
+
+      def execute
+        session = BasicAuthSession.new
+        response = session.get "/dossiers/#{dossier_id}/responses"
+        JSON.parse(response.body)['responses'].map do |response_entry|
+          Response.new response_entry
+        end
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/results.rb

@@ -0,0 +1 @@
+require 'roqua/rom_api/results/response'

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

@@ -0,0 +1,20 @@
+module Roqua
+  module RomApi
+    module Results
+      class Response
+        attr_reader :response, :name, :open_from, :open_till, :completing_url, :completer_type, :completed_at, :status
+
+        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
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/sessions.rb

@@ -0,0 +1,2 @@
+require 'httparty'
+require 'roqua/rom_api/sessions/basic_auth_session'

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

@@ -0,0 +1,61 @@
+module Roqua
+  module RomApi
+    module Sessions
+      class BasicAuthSession
+        attr_reader :rom_host
+        attr_reader :username
+        attr_reader :password
+
+        def initialize(rom_host: ENV['ROQUA_ROM_HOST'],
+                       username: ENV['ROQUA_ROM_KEY'],
+                       password: ENV['ROQUA_ROM_SECRET'])
+          @rom_host = rom_host
+          @username = username
+          @password = password
+        end
+
+        def get(path, params = {})
+          perform_request_or_fail do
+            HTTParty.get(full_url_for(path), query: params, basic_auth: basic_auth)
+          end
+        end
+
+        def post(path, params = {})
+          perform_request_or_fail do
+            HTTParty.post(full_url_for(path), body: params, basic_auth: basic_auth)
+          end
+        end
+
+        def patch(path, params = {})
+          perform_request_or_fail do
+            HTTParty.patch(full_url_for(path), body: params, basic_auth: basic_auth)
+          end
+        end
+
+        def delete(path, params = {})
+          HTTParty.delete(full_url_for(path), query: params, basic_auth: basic_auth)
+        end
+
+        private
+
+        def perform_request_or_fail(&block)
+          response = yield
+          fail response.parsed_response unless (200..299).include? response.code
+          response
+        end
+
+        def full_url_for(path)
+          rom_host + api_base + path + '.json'
+        end
+
+        def api_base
+          '/api/v1'
+        end
+
+        def basic_auth
+          {username: username, password: password}
+        end
+      end
+    end
+  end
+end

data/lib/roqua/rom_api/start_protocol_subscription.rb

@@ -2,16 +2,18 @@ module Roqua
   module RomApi
     # @api private
     class StartProtocolSubscription < ActiveInteraction::Base
+      include Sessions
       string :dossier_id
       string :protocol_key
       time :start_at, default: nil
 
       def execute
+        session = BasicAuthSession.new
         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 = session.post '/protocol_subscriptions', options
+        fail response.parsed_response.inspect unless (200..299).include? response.code
         response
       end
     end

data/lib/roqua/rom_api/version.rb

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

data/roqua_rom_api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.license       = "MIT"
   gem.authors       = ["Samuel Esposito"]
   gem.email         = "s.esposito@roqua.nl"
-  gem.homepage      = "https://github.com/roqua/rom/blob/master/rom_api/README.md"
+  gem.homepage      = "https://github.com/roqua/roqua/blob/master/rom_api/README.md"
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
@@ -19,7 +19,9 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'httparty',           '~> 0.12.0'
   gem.add_dependency 'active_interaction', '~>  1.0.4'
 
-  gem.add_development_dependency 'bundler', '~>  1.0'
-  gem.add_development_dependency 'rake',    '~> 10.1'
-  gem.add_development_dependency 'yard',    '~>  0.8'
+  gem.add_development_dependency 'bundler',     '~>    1.0'
+  gem.add_development_dependency 'rake',        '~>   10.1'
+  gem.add_development_dependency 'yard',        '~>    0.8'
+  gem.add_development_dependency 'rspec',       '~> 2.14.1'
+  gem.add_development_dependency 'fabrication', '~>  2.9.6'
 end

data/spec/fabricators/basic_auth_session_fabricator.rb

@@ -0,0 +1,7 @@
+Fabricator(:basic_auth_session, from: Roqua::RomApi::Sessions::BasicAuthSession) do
+  initialize_with do
+    Roqua::RomApi::Sessions::BasicAuthSession.new username: 'some_username',
+                                                  password: 'some_password',
+                                                  rom_host: 'http://roqua.dev'
+  end
+end

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

@@ -0,0 +1,18 @@
+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 }
+  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)
+    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

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Response do
+  let(:response_body) do
+    {'name' => 'RS-12',
+     'open_from' => '2014-02-19T14:15:49+01:00',
+     'open_till' => '2014-02-20T14:15:49+01:00',
+     'completer_type' => 'patient',
+     'completed_at' => nil,
+     'status' => 'open',
+     'completing_url' => 'http://roqua.dev/client/session/new?token=26aee9a4'}
+  end
+
+  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.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

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

@@ -0,0 +1,69 @@
+require 'spec_helper'
+include Sessions
+
+describe BasicAuthSession do
+  let(:session)  { Fabricate :basic_auth_session }
+  let(:response) { double('response', code: 201, parsed_response: 'some_response') }
+
+  describe '#initialize' do
+    it 'sets the rom_host instance attribute' do
+      session = BasicAuthSession.new rom_host: 'some_rom_host'
+      expect(session.rom_host).to eq('some_rom_host')
+    end
+
+    it 'defaults the rom_host to the ROQUA_ROM_HOST env variable' do
+      orginal_env_rom_host = ENV['ROQUA_ROM_HOST']
+      ENV['ROQUA_ROM_HOST'] = 'some_env_rom_host'
+      session = BasicAuthSession.new
+      ENV['ROQUA_ROM_HOST'] = orginal_env_rom_host
+      expect(session.rom_host).to eq('some_env_rom_host')
+    end
+
+    it 'sets the username instance variable' do
+      session = BasicAuthSession.new username: 'some_username'
+      expect(session.username).to eq('some_username')
+    end
+
+    it 'defaults the username to the ROQUA_ROM_KEY env variable' do
+      orginal_env_rom_key = ENV['ROQUA_ROM_KEY']
+      ENV['ROQUA_ROM_KEY'] = 'some_env_rom_key'
+      session = BasicAuthSession.new
+      ENV['ROQUA_ROM_KEY'] = orginal_env_rom_key
+      expect(session.username).to eq('some_env_rom_key')
+    end
+
+    it 'sets the password instance variable' do
+      session = BasicAuthSession.new password: 'some_password'
+      expect(session.password).to eq('some_password')
+    end
+
+    it 'defaults the password to the ROQUA_ROM_SECRET env variable' do
+      orginal_env_rom_secret = ENV['ROQUA_ROM_SECRET']
+      ENV['ROQUA_ROM_SECRET'] = 'some_env_rom_secret'
+      session = BasicAuthSession.new
+      ENV['ROQUA_ROM_SECRET'] = orginal_env_rom_secret
+      expect(session.password).to eq('some_env_rom_secret')
+    end
+  end
+
+  describe '#get' do
+    it 'performs a get request' do
+      expect(HTTParty).to receive(:get).with('http://roqua.dev/api/v1/some_path.json',
+                                             query: {some: 'param'},
+                                             basic_auth: {username: 'some_username', password: 'some_password'})
+                                       .and_return(response)
+      session.get '/some_path', some: 'param'
+    end
+
+    it 'throws an error if the reponse is not within the 200 range' do
+      allow(response).to receive(:code).and_return(500)
+      allow(HTTParty).to receive(:get).and_return(response)
+      expect { session.get '/some_path' }.to raise_error(RuntimeError, 'some_response')
+    end
+
+    it 'returns the response' do
+      allow(HTTParty).to receive(:get).and_return(response)
+      expect(session.get '/some_path').to eq(response)
+    end
+  end
+end

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

@@ -1,29 +1,28 @@
 require 'spec_helper'
 
 describe StartProtocolSubscription do
-  let(:options) do
-    {dossier_id: 'some_dossier_id',
-     protocol_key: 'some_key'}       # nine o'clock
-  end
+  let(:options) { {dossier_id: 'some_dossier_id', protocol_key: 'some_key'} }
+  let(:session) { Sessions::BasicAuthSession.new }
+  before { allow(Sessions::BasicAuthSession).to receive(:new).and_return session }
 
   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])
-                                  .and_return double('response', code: 200)
+    expect(session).to receive(:post).with('/protocol_subscriptions', dossier_id: options[:dossier_id],
+                                                                      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)
+    expect(session).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)
+    allow(session).to receive(:post).and_return double('response', code: 401)
     expect { StartProtocolSubscription.run(options) }.to raise_error
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
 require 'rspec'
+require 'fabrication'
 require 'roqua-rom-api'
 include Roqua::RomApi
+include Roqua::RomApi::Sessions
+include Roqua::RomApi::Results

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqua-rom-api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Samuel Esposito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.6
 description: Provides authenticated access to ROM utilities
 email: s.esposito@roqua.nl
 executables: []
@@ -97,15 +125,22 @@ files:
 - Rakefile
 - lib/roqua-rom-api.rb
 - lib/roqua/rom_api.rb
-- lib/roqua/rom_api/base.rb
+- lib/roqua/rom_api/list_responses.rb
+- lib/roqua/rom_api/results.rb
+- lib/roqua/rom_api/results/response.rb
+- lib/roqua/rom_api/sessions.rb
+- lib/roqua/rom_api/sessions/basic_auth_session.rb
 - lib/roqua/rom_api/start_protocol_subscription.rb
 - lib/roqua/rom_api/version.rb
 - roqua_rom_api.gemspec
-- spec/lib/roqua/rom_api/base_spec.rb
+- spec/fabricators/basic_auth_session_fabricator.rb
+- spec/lib/roqua/rom_api/list_responses_spec.rb
+- spec/lib/roqua/rom_api/results/response_spec.rb
+- spec/lib/roqua/rom_api/sessions/basic_auth_session_spec.rb
 - spec/lib/roqua/rom_api/start_protocol_subscription_spec.rb
 - spec/lib/roqua_rom_api_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/roqua/rom/blob/master/rom_api/README.md
+homepage: https://github.com/roqua/roqua/blob/master/rom_api/README.md
 licenses:
 - MIT
 metadata: {}
@@ -130,7 +165,10 @@ signing_key:
 specification_version: 4
 summary: API wrapper gem around RoQua's ROM API
 test_files:
-- spec/lib/roqua/rom_api/base_spec.rb
+- spec/fabricators/basic_auth_session_fabricator.rb
+- spec/lib/roqua/rom_api/list_responses_spec.rb
+- spec/lib/roqua/rom_api/results/response_spec.rb
+- spec/lib/roqua/rom_api/sessions/basic_auth_session_spec.rb
 - spec/lib/roqua/rom_api/start_protocol_subscription_spec.rb
 - spec/lib/roqua_rom_api_spec.rb
 - spec/spec_helper.rb

data/lib/roqua/rom_api/base.rb

@@ -1,50 +0,0 @@
-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)
-      end
-
-      def self.post(url, params = {})
-        HTTParty.post(api_base + url + '.json', query: params, basic_auth: authentication)
-      end
-
-      def self.put(url, params = {})
-        HTTParty.put(api_base + url + '.json', query: params, basic_auth: authentication)
-      end
-
-      def self.delete(url, params = {})
-        HTTParty.delete(api_base + url + '.json', query: params, basic_auth: authentication)
-      end
-
-      private
-
-      def self.rom_host
-        @roqua_rom_host || ENV['ROQUA_ROM_HOST']
-      end
-
-      def self.username
-        @roqua_rom_key || ENV['ROQUA_ROM_KEY']
-      end
-
-      def self.password
-        @roqua_rom_secret || ENV['ROQUA_ROM_SECRET']
-      end
-
-      def self.authentication
-        {username: username, password: password}
-      end
-
-      def self.api_path
-        '/api/v1'
-      end
-
-      def self.api_base
-        rom_host + api_path
-      end
-    end
-  end
-end

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

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-module Roqua
-  describe RomApi::Base do
-    let(:url)    { '/some/url' }
-    let(:params) { {some: 'params'} }
-    before do
-      RomApi::Base.instance_eval do
-        @roqua_rom_host = 'http://roqua.dev'
-        @roqua_rom_key = 'uname'
-        @roqua_rom_secret = 'pwd'
-      end
-    end
-
-    describe '.get' do
-      it 'performs a get request to a rom_api passing in some parameters' do
-        expect(HTTParty).to receive(:get).with('http://roqua.dev/api/v1/some/url.json',
-                                               query: params,
-                                               basic_auth: {username: 'uname', password: 'pwd'})
-        RomApi::Base.get(url, params)
-      end
-    end
-
-    describe '.post' do
-      it 'performs a get request to a rom_api passing in some parameters' do
-        expect(HTTParty).to receive(:post).with('http://roqua.dev/api/v1/some/url.json',
-                                                query: params,
-                                                basic_auth: {username: 'uname', password: 'pwd'})
-        RomApi::Base.post(url, params)
-      end
-    end
-
-    describe '.put' do
-      it 'performs a get request to a rom_api passing in some parameters' do
-        expect(HTTParty).to receive(:put).with('http://roqua.dev/api/v1/some/url.json',
-                                               query: params,
-                                               basic_auth: {username: 'uname', password: 'pwd'})
-        RomApi::Base.put(url, params)
-      end
-    end
-
-    describe '.delete' do
-      it 'performs a get request to a rom_api passing in some parameters' do
-        expect(HTTParty).to receive(:delete).with('http://roqua.dev/api/v1/some/url.json',
-                                                  query: params,
-                                                  basic_auth: {username: 'uname', password: 'pwd'})
-        RomApi::Base.delete(url, params)
-      end
-    end
-  end
-end