allscripts_unity_client 1.0.3

data/spec/soap_client_driver_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+describe 'SOAPClientDriver' do
+  include Savon::SpecHelper
+  it_behaves_like 'a client driver'
+
+  subject do
+    client_driver = FactoryGirl.build(:soap_client_driver)
+    client_driver.security_token = SecureRandom.uuid
+    client_driver
+  end
+
+  let(:get_server_info) { FixtureLoader.load_file("get_server_info.xml") }
+  let(:get_security_token) { FixtureLoader.load_file("get_security_token.xml") }
+  let(:retire_security_token) { FixtureLoader.load_file("retire_security_token.xml") }
+  let(:soap_fault) { FixtureLoader.load_file("soap_fault.xml") }
+  let(:url) { Faker::Internet.url }
+
+  before(:all) { savon.mock! }
+  after(:all) { savon.unmock! }
+
+  describe '#initialize' do
+    context 'when nil is given for base_unity_url' do
+      it { expect { FactoryGirl.build(:soap_client_driver, :base_unity_url => nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when nil is given for username' do
+      it { expect { FactoryGirl.build(:soap_client_driver, :username => nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when nil is given for password' do
+      it { expect { FactoryGirl.build(:soap_client_driver, :password => nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when nil is given for appname' do
+      it { expect { FactoryGirl.build(:soap_client_driver, :appname => nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when given a base_unity_url with a trailing /' do
+      it 'sets @base_unity_url without the trailing /' do
+        client_driver = FactoryGirl.build(:soap_client_driver, :base_unity_url => "http://www.example.com/")
+        expect(client_driver.base_unity_url).to eq("http://www.example.com")
+      end
+    end
+
+    context 'when nil is given for timezone' do
+      it 'sets @timezone to UTC' do
+        client_driver = FactoryGirl.build(:soap_client_driver, :timezone => nil)
+        utc_timezone = FactoryGirl.build(:timezone, :zone_identifier => "UTC")
+        expect(client_driver.timezone.tzinfo).to eq(utc_timezone.tzinfo)
+      end
+    end
+
+    context 'when nil is given for proxy' do
+      it 'sets Savon proxy option to nil' do
+        client_driver = FactoryGirl.build(:soap_client_driver, :proxy => nil)
+        expect(client_driver.savon_client.globals.instance_variable_get("@options")[:proxy]).to be_nil
+      end
+    end
+
+    context 'when proxy is given' do
+      it 'sets Savon proxy option to the given url' do
+        client_driver = FactoryGirl.build(:soap_client_driver, :proxy => url)
+        expect(client_driver.savon_client.globals.instance_variable_get("@options")[:proxy]).to eq(url)
+      end
+    end
+
+    context 'when nil is given for logger' do
+      it 'sets @logger to Logger' do
+        client_driver = FactoryGirl.build(:soap_client_driver, :logger => nil)
+        expect(client_driver.logger).to be_instance_of(Logger)
+      end
+    end
+
+    context 'when logger is set' do
+      it 'sets @logger to logger' do
+        logger = double("logger")
+        client_driver = FactoryGirl.build(:soap_client_driver, :logger => logger)
+        expect(client_driver.logger).to be(logger)
+      end
+    end
+  end
+
+  describe '#client_type' do
+    it { expect(subject.client_type).to be(:soap) }
+  end
+
+  describe '#magic' do
+    before(:each) {
+      allow(subject).to receive(:start_timer)
+      allow(subject).to receive(:end_timer)
+      allow(subject).to receive(:log_magic)
+    }
+
+    it 'should send a SOAP request to Magic endpoint' do
+      savon.expects("Magic").with(:message => :any).returns(get_server_info)
+      subject.magic
+    end
+
+    context 'when a Savon::SOAPFault is raised' do
+      it 'should raise an APIError' do
+        savon.expects("Magic").with(:message => :any).returns({ code: 500, headers: {}, body: soap_fault })
+        expect { subject.magic }.to raise_error(AllscriptsUnityClient::APIError)
+      end
+    end
+
+    it 'should call start_timer' do
+      savon.expects("Magic").with(:message => :any).returns(get_server_info)
+      subject.magic
+      expect(subject).to have_received(:start_timer)
+    end
+
+    it 'should call end_timer' do
+      savon.expects("Magic").with(:message => :any).returns(get_server_info)
+      subject.magic
+      expect(subject).to have_received(:start_timer)
+    end
+
+    it 'should call log_magic' do
+      savon.expects("Magic").with(:message => :any).returns(get_server_info)
+      subject.magic
+      expect(subject).to have_received(:log_magic)
+    end
+  end
+
+  describe '#get_security_token!' do
+    before(:each) {
+      allow(subject).to receive(:start_timer)
+      allow(subject).to receive(:end_timer)
+      allow(subject).to receive(:log_get_security_token)
+    }
+
+    it 'should send a SOAP request to GetSecurityToken endpoint' do
+      savon.expects("GetSecurityToken").with(:message => :any).returns(get_security_token)
+      subject.get_security_token!
+    end
+
+    context 'when a Savon::SOAPFault is raised' do
+      it 'should raise an APIError' do
+        savon.expects("GetSecurityToken").with(:message => :any).returns({ code: 500, headers: {}, body: soap_fault })
+        expect { subject.get_security_token! }.to raise_error(AllscriptsUnityClient::APIError)
+      end
+    end
+
+    it 'should call start_timer' do
+      savon.expects("GetSecurityToken").with(:message => :any).returns(get_security_token)
+      subject.get_security_token!
+      expect(subject).to have_received(:start_timer)
+    end
+
+    it 'should call end_timer' do
+      savon.expects("GetSecurityToken").with(:message => :any).returns(get_security_token)
+      subject.get_security_token!
+      expect(subject).to have_received(:start_timer)
+    end
+
+    it 'should call log_get_security_token' do
+      savon.expects("GetSecurityToken").with(:message => :any).returns(get_security_token)
+      subject.get_security_token!
+      expect(subject).to have_received(:log_get_security_token)
+    end
+  end
+
+  describe '#retire_security_token!' do
+    before(:each) {
+      allow(subject).to receive(:start_timer)
+      allow(subject).to receive(:end_timer)
+      allow(subject).to receive(:log_retire_security_token)
+    }
+
+    it 'should send a SOAP request to RetireSecurityToken endpoint' do
+      savon.expects("RetireSecurityToken").with(:message => :any).returns(retire_security_token)
+      subject.retire_security_token!
+    end
+
+    context 'when a Savon::SOAPFault is raised' do
+      it 'should raise an APIError' do
+        savon.expects("RetireSecurityToken").with(:message => :any).returns({ code: 500, headers: {}, body: soap_fault })
+        expect { subject.retire_security_token! }.to raise_error(AllscriptsUnityClient::APIError)
+      end
+    end
+
+    it 'should call start_timer' do
+      savon.expects("RetireSecurityToken").with(:message => :any).returns(retire_security_token)
+      subject.retire_security_token!
+      expect(subject).to have_received(:start_timer)
+    end
+
+    it 'should call end_timer' do
+      savon.expects("RetireSecurityToken").with(:message => :any).returns(retire_security_token)
+      subject.retire_security_token!
+      expect(subject).to have_received(:start_timer)
+    end
+
+    it 'should call log_retire_security_token' do
+      savon.expects("RetireSecurityToken").with(:message => :any).returns(retire_security_token)
+      subject.retire_security_token!
+      expect(subject).to have_received(:log_retire_security_token)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'pathname'
+require 'simplecov'
+require 'coveralls'
+
+# Configure coverage stats.
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter do |source_file|
+    filename = Pathname.new(source_file.filename).basename
+    ignored_files = [
+      "version.rb",
+      "allscripts_unity_client.gemspec",
+      "Gemfile",
+      "Rakefile"
+    ]
+
+    ignored_files.include?(filename) || source_file.filename.include?("spec/")
+  end
+end
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'allscripts_unity_client'
+
+require 'rspec'
+require 'webmock/rspec'
+require 'savon/mock/spec_helper'
+require 'securerandom'
+require 'faker'
+require 'factory_girl'
+require 'json'
+
+# Include all support files
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f }
+
+# Include all factories
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+end

data/spec/support/fixture_loader.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+require 'json'
+
+class FixtureLoader
+  def self.load_yaml(filename)
+    YAML.load(read(filename))
+  end
+
+  def self.load_json(filename)
+    JSON.parse(read(filename))
+  end
+
+  def self.load_file(filename)
+    read(filename)
+  end
+
+  private
+
+  def self.read(filename)
+    File.read(File.expand_path("../../fixtures/#{filename}", __FILE__))
+  end
+end

data/spec/support/shared_examples_for_client_driver.rb

@@ -0,0 +1,139 @@
+shared_examples 'a client driver' do
+  describe '#security_token?' do
+    context 'when @security_token is nil' do
+      it do
+        subject.security_token = nil
+        expect(subject.security_token?).to be_false
+      end
+    end
+
+    context 'when @security_token is not nil' do
+      it do
+        subject.security_token = "security token"
+        expect(subject.security_token?).to be_true
+      end
+    end
+  end
+
+  describe "#log?" do
+    context 'when log is false' do
+      it 'return false' do
+        subject.log = false
+        expect(subject.log).to be_false
+      end
+    end
+
+    context 'when log is true' do
+      it 'return false' do
+        subject.log = true
+        expect(subject.log).to be_true
+      end
+    end
+  end
+
+  describe "#log_get_security_token" do
+    it 'should call log_info' do
+      allow(subject).to receive(:log_info)
+      subject.send(:log_get_security_token)
+      expect(subject).to have_received(:log_info)
+    end
+  end
+
+  describe "#log_retire_security_token" do
+    it 'should call log_info' do
+      allow(subject).to receive(:log_info)
+      subject.send(:log_retire_security_token)
+      expect(subject).to have_received(:log_info)
+    end
+  end
+
+  describe "#log_magic" do
+    it 'should call log_info' do
+      allow(subject).to receive(:log_info)
+      subject.send(:log_magic, double(:parameters => { :action => "action" }))
+      expect(subject).to have_received(:log_info)
+    end
+
+    context 'when given nil for request' do
+      it { expect { subject.send(:log_magic, nil) }.to raise_error(ArgumentError) }
+    end
+  end
+
+  describe '#log_info' do
+    context 'when log? is true' do
+      it 'should call @logger.info' do
+        subject.log = true
+        allow(subject.logger).to receive(:info)
+        subject.send(:log_info, "test")
+        expect(subject.logger).to have_received(:info)
+      end
+    end
+
+    context 'when log? is false' do
+      it 'should not call @logger.info' do
+        subject.log = false
+        allow(subject.logger).to receive(:info)
+        subject.send(:log_info, "test")
+        expect(subject.logger).to_not have_received(:info)
+      end
+    end
+
+    context 'when given nil for message' do
+      it 'should not call @logger.info' do
+        subject.log = true
+        allow(subject.logger).to receive(:info)
+        subject.send(:log_info, nil)
+        expect(subject.logger).to_not have_received(:info)
+      end
+    end
+
+    context 'when @logger is nil and log is true' do
+      it 'should not call @logger.info' do
+        subject.log = true
+        subject.logger = nil
+        expect { subject.send(:log_info, "test") }.to_not raise_error
+      end
+    end
+
+    context 'when @timer is nil and log is true' do
+      it 'should not include seconds in the log' do
+        subject.log = true
+        subject.instance_variable_set("@timer", nil)
+        allow(subject.logger).to receive(:info)
+        subject.send(:log_info, "test")
+        expect(subject.logger).to_not have_received(:info).with(match(/seconds/))
+      end
+    end
+
+    context 'when @timer is not nil and log is true' do
+      it 'should include seconds in log' do
+        subject.log = true
+        subject.instance_variable_set("@timer", 1.2)
+        allow(subject.logger).to receive(:info)
+        subject.send(:log_info, "test")
+        expect(subject.logger).to have_received(:info).with(match(/seconds/))
+      end
+    end
+  end
+
+  describe '#start_timer' do
+    it 'sets @start_time' do
+      subject.send(:start_timer)
+      expect(subject.instance_variable_get("@start_time")).to_not be_nil
+    end
+  end
+
+  describe '#end_timer' do
+    it 'sets @end_time' do
+      subject.send(:start_timer)
+      subject.send(:end_timer)
+      expect(subject.instance_variable_get("@end_time")).to_not be_nil
+    end
+
+    it 'sets @timer to @end_time - @start_time' do
+      subject.send(:start_timer)
+      subject.send(:end_timer)
+      expect(subject.instance_variable_get("@timer")).to eq(subject.instance_variable_get("@end_time") - subject.instance_variable_get("@start_time"))
+    end
+  end
+end

data/spec/support/shared_examples_for_unity_request.rb

@@ -0,0 +1,94 @@
+shared_examples 'a unity request' do
+  let(:magic_request) { FactoryGirl.build(:magic_request) }
+
+  describe '#to_hash' do
+    it ':action maps to Action' do
+      subject.parameters = FactoryGirl.build(:magic_request, :action => 'Action')
+      expect(subject.to_hash['Action']).to eq('Action')
+    end
+
+    it ':appname maps to Appname' do
+      subject.parameters = FactoryGirl.build(:magic_request, :appname => 'Appname')
+      expect(subject.to_hash['Appname']).to eq('Appname')
+    end
+
+    it ':patientid maps to PatientID' do
+      subject.parameters = FactoryGirl.build(:magic_request, :patientid => 'PatientID')
+      expect(subject.to_hash['PatientID']).to eq('PatientID')
+    end
+
+    it ':token maps to Token' do
+      subject.parameters = FactoryGirl.build(:magic_request, :token => 'Token')
+      expect(subject.to_hash['Token']).to eq('Token')
+    end
+
+    it ':parameter1 maps to Parameter1' do
+      subject.parameters = FactoryGirl.build(:magic_request, :parameter1 => 'Parameter1')
+      expect(subject.to_hash['Parameter1']).to eq('Parameter1')
+    end
+
+    it ':parameter2 maps to Parameter2' do
+      subject.parameters = FactoryGirl.build(:magic_request, :parameter2 => 'Parameter2')
+      expect(subject.to_hash['Parameter2']).to eq('Parameter2')
+    end
+
+    it ':parameter3 maps to Parameter3' do
+      subject.parameters = FactoryGirl.build(:magic_request, :parameter3 => 'Parameter3')
+      expect(subject.to_hash['Parameter3']).to eq('Parameter3')
+    end
+
+    it ':parameter4 maps to Parameter4' do
+      subject.parameters = FactoryGirl.build(:magic_request, :parameter4 => 'Parameter4')
+      expect(subject.to_hash['Parameter4']).to eq('Parameter4')
+    end
+
+    it ':parameter5 maps to Parameter5' do
+      subject.parameters = FactoryGirl.build(:magic_request, :parameter5 => 'Parameter5')
+      expect(subject.to_hash['Parameter5']).to eq('Parameter5')
+    end
+
+    it ':parameter6 maps to Parameter6' do
+      subject.parameters = FactoryGirl.build(:magic_request, :parameter6 => 'Parameter6')
+      expect(subject.to_hash['Parameter6']).to eq('Parameter6')
+    end
+
+    it 'calls process_date on parameters' do
+      subject.parameters = FactoryGirl.build(:populated_magic_request)
+      allow(subject).to receive(:process_date)
+      subject.to_hash
+      expect(subject).to have_received(:process_date).exactly(6).times
+    end
+  end
+
+  describe '#process_date' do
+    context 'when given nil' do
+      it { expect(subject.send(:process_date, nil)).to be_nil }
+    end
+
+    context 'when given a non-date string' do
+      it do
+        not_a_date = Faker::Name.name
+        expect(subject.send(:process_date, not_a_date)).to eq(not_a_date)
+      end
+    end
+
+    context 'when given a date string' do
+      it do
+        date = "2013-10-24"
+        expect(subject.send(:process_date, date)).to be_instance_of(Date)
+      end
+    end
+
+    context 'when given a Date' do
+      it { expect(subject.send(:process_date, Date.today)).to be_instance_of(Date) }
+    end
+
+    context 'when given a Time' do
+      it { expect(subject.send(:process_date, Time.now)).to be_instance_of(Time) }
+    end
+
+    context 'when given a DateTime' do
+      it { expect(subject.send(:process_date, DateTime.now)).to be_instance_of(DateTime) }
+    end
+  end
+end