allscripts_unity_client 1.3.4 → 2.0.0

data/lib/allscripts_unity_client.rb

@@ -1,28 +1,28 @@
-require "allscripts_unity_client/utilities"
-require "allscripts_unity_client/timezone"
-require "allscripts_unity_client/unity_request"
-require "allscripts_unity_client/json_unity_request"
-require "allscripts_unity_client/unity_response"
-require "allscripts_unity_client/json_unity_response"
-require "allscripts_unity_client/client"
-require "allscripts_unity_client/client_driver"
-require "allscripts_unity_client/soap_client_driver"
-require "allscripts_unity_client/json_client_driver"
+require 'allscripts_unity_client/utilities'
+require 'allscripts_unity_client/timezone'
+require 'allscripts_unity_client/unity_request'
+require 'allscripts_unity_client/json_unity_request'
+require 'allscripts_unity_client/unity_response'
+require 'allscripts_unity_client/json_unity_response'
+require 'allscripts_unity_client/client'
+require 'allscripts_unity_client/client_driver'
+require 'allscripts_unity_client/client_options'
+require 'allscripts_unity_client/soap_client_driver'
+require 'allscripts_unity_client/json_client_driver'
 
 module AllscriptsUnityClient
   class APIError < RuntimeError
   end
 
-  def self.create(parameters = {})
-    parameters[:mode] ||= :soap
-    parameters[:log] = true unless parameters[:log] === false
-    raise_if_parameters_invalid parameters
+  def self.create(options = {})
+    options[:mode] ||= :soap
+    options[:log] = true unless options[:log] === false
+    raise_if_options_invalid options
 
-    case parameters[:mode]
-    when :json
-      client_driver = JSONClientDriver.new(parameters[:base_unity_url], parameters[:username], parameters[:password], parameters[:appname], parameters[:proxy], parameters[:timezone], parameters[:logger], parameters[:log])
-    when :soap
-      client_driver = SOAPClientDriver.new(parameters[:base_unity_url], parameters[:username], parameters[:password], parameters[:appname], parameters[:proxy], parameters[:timezone], parameters[:logger], parameters[:log])
+    if options[:mode] == :json
+      client_driver = JSONClientDriver.new(options)
+    else
+      client_driver = SOAPClientDriver.new(options)
     end
 
     client = Client.new(client_driver)
@@ -31,12 +31,8 @@ module AllscriptsUnityClient
 
   private
 
-  def self.raise_if_parameters_invalid(parameters)
-    raise ArgumentError, ":mode must be :json or :soap" unless [:json, :soap].include?(parameters[:mode])
-    raise ArgumentError, ":base_unity_url required" if parameters[:base_unity_url].nil?
-    raise ArgumentError, ":username required" if parameters[:username].nil?
-    raise ArgumentError, ":password required" if parameters[:password].nil?
-    raise ArgumentError, ":appname required" if parameters[:appname].nil?
+  def self.raise_if_options_invalid(options)
+    raise ArgumentError, ':mode must be :json or :soap' unless [:json, :soap].include?(options[:mode])
   end
 end
 

data/spec/allscripts_unity_client_spec.rb

@@ -6,44 +6,40 @@ describe 'AllscriptsUnityClient' do
   subject { AllscriptsUnityClient }
 
   describe '.create' do
-    context 'when given :mode => :soap' do
+    context 'when given mode: :soap' do
       it 'returns a SOAPClient' do
-        parameters = FactoryGirl.build(:allscripts_unity_client_parameters, :mode => :soap)
+        parameters = build(:allscripts_unity_client_parameters, mode: :soap)
         expect(subject.create(parameters).client_type).to be(:soap)
       end
     end
 
-    context 'when given :mode => :json' do
+    context 'when given mode: :json' do
       it 'returns a client with client_type :json' do
-        parameters = FactoryGirl.build(:allscripts_unity_client_parameters, :mode => :json)
+        parameters = build(:allscripts_unity_client_parameters, mode: :json)
         expect(subject.create(parameters).client_type).to be(:json)
       end
     end
 
     context 'when not given :mode' do
       it 'returns a client with client_type :soap' do
-        parameters = FactoryGirl.build(:allscripts_unity_client_parameters)
+        parameters = build(:allscripts_unity_client_parameters)
         parameters[:mode] = nil
         expect(subject.create(parameters).client_type).to be(:soap)
       end
     end
   end
 
-  describe '.raise_if_parameters_invalid' do
-    context 'when not given :base_unity_url' do
-      it { expect { subject.send(:raise_if_parameters_invalid, FactoryGirl.build(:allscripts_unity_client_parameters, :base_unity_url => nil)) }.to raise_error(ArgumentError) }
-    end
-
-    context 'when not given :username' do
-      it { expect { subject.send(:raise_if_parameters_invalid, FactoryGirl.build(:allscripts_unity_client_parameters, :username => nil)) }.to raise_error(ArgumentError) }
+  describe '.raise_if_options_invalid' do
+    context 'when not given :mode' do
+      it { expect { subject.send(:raise_if_options_invalid, build(:allscripts_unity_client_parameters, mode: nil)) }.to raise_error(ArgumentError) }
     end
 
-    context 'when not given :password' do
-      it { expect { subject.send(:raise_if_parameters_invalid, FactoryGirl.build(:allscripts_unity_client_parameters, :password => nil)) }.to raise_error(ArgumentError) }
+    context 'when given mode: :json' do
+      it { expect { subject.send(:raise_if_options_invalid, build(:allscripts_unity_client_parameters, mode: :json)) }.not_to raise_error }
     end
 
-    context 'when not given :appname' do
-      it { expect { subject.send(:raise_if_parameters_invalid, FactoryGirl.build(:allscripts_unity_client_parameters, :appname => nil)) }.to raise_error(ArgumentError) }
+    context 'when given mode: :soap' do
+      it { expect { subject.send(:raise_if_options_invalid, build(:allscripts_unity_client_parameters, mode: :soap)) }.not_to raise_error }
     end
   end
 end

data/spec/client_driver_spec.rb

@@ -3,55 +3,7 @@ require 'spec_helper'
 describe 'ClientDriver' do
   it_behaves_like 'a client driver'
 
-  subject { FactoryGirl.build(:client_driver) }
-
-  describe '#initialize' do
-    context 'when nil is given for base_unity_url' do
-      it { expect { FactoryGirl.build(:client_driver, :base_unity_url => nil) }.to raise_error(ArgumentError) }
-    end
-
-    context 'when nil is given for username' do
-      it { expect { FactoryGirl.build(:client_driver, :username => nil) }.to raise_error(ArgumentError) }
-    end
-
-    context 'when nil is given for password' do
-      it { expect { FactoryGirl.build(:client_driver, :password => nil) }.to raise_error(ArgumentError) }
-    end
-
-    context 'when nil is given for appname' do
-      it { expect { FactoryGirl.build(: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(: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(: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 logger' do
-      it 'sets @logger to Logger' do
-        client_driver = FactoryGirl.build(: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(:client_driver, :logger => logger)
-        expect(client_driver.logger).to be(logger)
-      end
-    end
-  end
+  subject { build(:client_driver) }
 
   describe '#client_type' do
     it { expect(subject.client_type).to be(:none) }

data/spec/client_options_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe 'ClientOptions' do
+  subject { build(:client_options) }
+
+  let(:url_with_slash) { 'http://www.example.com/' }
+  let(:url_without_slash) { 'http://www.example.com' }
+  let(:utc_timezone) { AllscriptsUnityClient::Timezone.new('UTC') }
+  let(:america_los_angeles) { 'America/Los_Angeles' }
+  let(:america_los_angeles_timezone) { AllscriptsUnityClient::Timezone.new('America/Los_Angeles') }
+  let(:client_options_hash) { { base_unity_url: 'http://www.example.com', username: 'username', password: 'password', appname: 'appname', proxy: 'proxy', timezone: 'UTC', logger: nil } }
+
+  describe '#initialize' do
+    context 'when given a base_unity_url that ends in a slash (/)' do
+      it 'strips the slash' do
+        expect(build(:client_options, base_unity_url: url_with_slash).base_unity_url).to eq(url_without_slash)
+      end
+    end
+  end
+
+  describe '#validate_options' do
+    context 'when not given base_unity_url' do
+      it { expect { build(:client_options, base_unity_url: nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when not given username' do
+      it { expect { build(:client_options, username: nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when not given password' do
+      it { expect { build(:client_options, password: nil) }.to raise_error(ArgumentError) }
+    end
+
+    context 'when not given appname' do
+      it { expect { build(:client_options, appname: nil) }.to raise_error(ArgumentError) }
+    end
+  end
+
+  describe '#base_unity_url=' do
+    context 'when given a base_unity_url that ends in a slash (/)' do
+      it 'strips the slash' do
+        subject.base_unity_url = url_with_slash
+        expect(subject.base_unity_url).to eq(url_without_slash)
+      end
+    end
+
+    context 'when given nil' do
+      it { expect { subject.base_unity_url = nil }.to raise_error(ArgumentError) }
+    end
+  end
+
+  describe '#username=' do
+    context 'when given nil' do
+      it { expect { subject.username = nil }.to raise_error(ArgumentError) }
+    end
+
+    context 'when given username' do
+      it { expect { subject.username = 'username' }.not_to raise_error }
+    end
+  end
+
+  describe '#password=' do
+    context 'when given nil' do
+      it { expect { subject.password = nil }.to raise_error(ArgumentError) }
+    end
+
+    context 'when given password' do
+      it { expect { subject.password = 'password' }.not_to raise_error }
+    end
+  end
+
+  describe '#appname=' do
+    context 'when given nil' do
+      it { expect { subject.appname = nil }.to raise_error(ArgumentError) }
+    end
+
+    context 'when given appname' do
+      it { expect { subject.appname = 'appname' }.not_to raise_error }
+    end
+  end
+
+  describe '#timezone=' do
+    context 'when given nil' do
+      it 'sets timezone to UTC' do
+        subject.timezone = nil
+        expect(subject.timezone).to eq(utc_timezone)
+      end
+    end
+
+    context 'when given tzinfo string' do
+      it 'sets it to correct Timezone' do
+        subject.timezone = america_los_angeles
+        expect(subject.timezone).to eq(america_los_angeles_timezone)
+      end
+    end
+  end
+
+  describe '#proxy?' do
+    context 'when proxy is nil' do
+      it 'returns false' do
+        expect(subject.proxy?).to be_falsey
+      end
+    end
+
+    context 'when proxy is not nil' do
+      it 'returns true' do
+        subject.proxy = url_with_slash
+        expect(subject.proxy?).to be_truthy
+      end
+    end
+
+    context 'when proxy is empty string' do
+      it 'returns false' do
+        subject.proxy = ''
+        expect(subject.proxy?).to be_falsey
+      end
+    end
+  end
+
+  describe '#logger?' do
+    context 'when logger is nil' do
+      it 'returns false' do
+        expect(subject.logger?).to be_falsey
+      end
+    end
+
+    context 'when logger is not nil' do
+      it 'returns true' do
+        subject.logger = double('logger')
+        expect(subject.logger?).to be_truthy
+      end
+    end
+  end
+end

data/spec/client_spec.rb

@@ -1,17 +1,17 @@
 require 'spec_helper'
 
 describe 'Client' do
-  subject { FactoryGirl.build(:client) }
+  subject { build(:client) }
 
   describe '#initialize' do
     context 'when given nil for client_driver' do
-      it { expect { FactoryGirl.build(:client, :client_driver => nil) }.to raise_error(ArgumentError) }
+      it { expect { build(:client, client_driver: nil) }.to raise_error(ArgumentError) }
     end
   end
 
   describe '#magic' do
     it 'calls magic on @client_driver' do
-      subject.client_driver = double(:magic => "magic")
+      subject.client_driver = double(magic: 'magic')
       subject.magic
       expect(subject.client_driver).to have_received(:magic)
     end
@@ -19,7 +19,7 @@ describe 'Client' do
 
   describe '#get_security_token!' do
     it 'calls get_security_token! on @client_driver' do
-      subject.client_driver = double(:get_security_token! => "get_security_token!")
+      subject.client_driver = double(get_security_token!: 'get_security_token!')
       subject.get_security_token!
       expect(subject.client_driver).to have_received(:get_security_token!)
     end
@@ -27,7 +27,7 @@ describe 'Client' do
 
   describe '#retire_security_token!' do
     it 'calls retire_security_token! on @client_driver' do
-      subject.client_driver = double(:retire_security_token! => "retire_security_token!")
+      subject.client_driver = double(retire_security_token!: 'retire_security_token!')
       subject.retire_security_token!
       expect(subject.client_driver).to have_received(:retire_security_token!)
     end
@@ -35,7 +35,7 @@ describe 'Client' do
 
   describe '#security_token?' do
     it 'calls security_token? on @client_driver' do
-      subject.client_driver = double(:security_token? => "security_token?")
+      subject.client_driver = double(security_token?: 'security_token?')
       subject.security_token?
       expect(subject.client_driver).to have_received(:security_token?)
     end
@@ -43,7 +43,7 @@ describe 'Client' do
 
   describe '#client_type' do
     it 'calls client_type on @client_driver' do
-      subject.client_driver = double(:client_type => "client_type?")
+      subject.client_driver = double(client_type: 'client_type?')
       subject.client_type
       expect(subject.client_driver).to have_received(:client_type)
     end
@@ -393,8 +393,8 @@ describe 'Client' do
   describe '#nokogiri_to_string' do
     context 'when given a Nokogiri::XML::Builder' do
       it 'returns an XML string' do
-        builder = Nokogiri::XML::Builder.new { |xml| xml.field "test" }
-        expect(subject.send(:nokogiri_to_string, builder)).to eq("<field>test</field>")
+        builder = Nokogiri::XML::Builder.new { |xml| xml.field 'test' }
+        expect(subject.send(:nokogiri_to_string, builder)).to eq('<field>test</field>')
       end
     end
   end

data/spec/factories/allscripts_unity_client_parameters_factory.rb

@@ -1,8 +1,8 @@
 FactoryGirl.define do
-  factory :allscripts_unity_client_parameters, :class => Hash do
+  factory :allscripts_unity_client_parameters, class: Hash do
     initialize_with { attributes }
 
-    base_unity_url "http://www.example.com"
+    base_unity_url 'http://www.example.com'
     username Faker::Name.name
     password Faker::Internet.password
     appname Faker::Name.name

data/spec/factories/client_driver_factory.rb

@@ -1,14 +1,13 @@
 FactoryGirl.define do
-  factory :client_driver, :class => AllscriptsUnityClient::ClientDriver do
-    initialize_with { new(base_unity_url, username, password, appname, proxy, timezone, logger, log) }
+  factory :client_driver, class: AllscriptsUnityClient::ClientDriver do
+    initialize_with { new(base_unity_url: base_unity_url, username: username, password: password, appname: appname, proxy: proxy, timezone: timezone, logger: logger) }
 
-    base_unity_url "http://www.example.com"
+    base_unity_url 'http://www.example.com'
     username Faker::Name.name
     password Faker::Internet.password
     appname Faker::Name.name
     proxy nil
-    timezone "America/Phoenix"
+    timezone 'America/Phoenix'
     logger nil
-    log false
   end
 end

data/spec/factories/client_factory.rb

@@ -1,7 +1,7 @@
 FactoryGirl.define do
-  factory :client, :class => AllscriptsUnityClient::Client do
+  factory :client, class: AllscriptsUnityClient::Client do
     initialize_with { new(client_driver) }
 
-    client_driver { FactoryGirl.build(:client_driver) }
+    client_driver { build(:client_driver) }
   end
 end

data/spec/factories/client_options.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :client_options, class: AllscriptsUnityClient::ClientOptions do
+    initialize_with { new(base_unity_url: base_unity_url, username: username, password: password, appname: appname, proxy: proxy, timezone: timezone, logger: logger) }
+
+    base_unity_url 'http://www.example.com'
+    username Faker::Name.name
+    password Faker::Internet.password
+    appname Faker::Name.name
+    proxy nil
+    timezone 'America/Phoenix'
+    logger nil
+  end
+end

data/spec/factories/json_client_driver_factory.rb

@@ -1,3 +1,3 @@
 FactoryGirl.define do
-  factory :json_client_driver, :parent => :client_driver, :class => AllscriptsUnityClient::JSONClientDriver
+  factory :json_client_driver, parent: :client_driver, class: AllscriptsUnityClient::JSONClientDriver
 end

data/spec/factories/json_unity_request_factory.rb

@@ -1,3 +1,3 @@
 FactoryGirl.define do
-  factory :json_unity_request, :parent => :unity_request, :class => AllscriptsUnityClient::JSONUnityRequest
+  factory :json_unity_request, parent: :unity_request, class: AllscriptsUnityClient::JSONUnityRequest
 end

data/spec/factories/json_unity_response_factory.rb

@@ -1,3 +1,3 @@
 FactoryGirl.define do
-  factory :json_unity_response, :parent => :unity_response, :class => AllscriptsUnityClient::JSONUnityResponse
+  factory :json_unity_response, parent: :unity_response, class: AllscriptsUnityClient::JSONUnityResponse
 end

data/spec/factories/magic_request_factory.rb

@@ -1,5 +1,5 @@
 FactoryGirl.define do
-  factory :magic_request, :class => Hash do
+  factory :magic_request, class: Hash do
     initialize_with { attributes }
 
     action nil
@@ -16,10 +16,10 @@ FactoryGirl.define do
     data nil
   end
 
-  factory :populated_magic_request, :parent => :magic_request do
-    action ["GetServerInfo", "GetProviders"].sample
+  factory :populated_magic_request, parent: :magic_request do
+    action %w(GetServerInfo GetProviders).sample
     appname Faker::Company.name
-    userid ["jmedici", "lmccoy"].sample
+    userid %w(jmedici lmccoy).sample
     patientid Faker::Number.number(3)
     token SecureRandom.uuid
     parameter1 Faker::Internet.domain_word

data/spec/factories/soap_client_driver_factory.rb

@@ -1,3 +1,3 @@
 FactoryGirl.define do
-  factory :soap_client_driver, :parent => :client_driver, :class => AllscriptsUnityClient::SOAPClientDriver
+  factory :soap_client_driver, parent: :client_driver, class: AllscriptsUnityClient::SOAPClientDriver
 end

data/spec/factories/timezone_factory.rb

@@ -1,7 +1,7 @@
 FactoryGirl.define do
-  factory :timezone, :class => AllscriptsUnityClient::Timezone do
+  factory :timezone, class: AllscriptsUnityClient::Timezone do
     initialize_with { new(zone_identifier) }
 
-    zone_identifier "America/Phoenix"
+    zone_identifier 'America/Phoenix'
   end
 end

data/spec/factories/unity_request_factory.rb

@@ -1,9 +1,9 @@
 FactoryGirl.define do
-  factory :unity_request, :class => AllscriptsUnityClient::UnityRequest do
+  factory :unity_request, class: AllscriptsUnityClient::UnityRequest do
     initialize_with { new(parameters, timezone, appname, security_token) }
 
-    parameters FactoryGirl.build(:magic_request)
-    timezone FactoryGirl.build(:timezone)
+    parameters { build(:magic_request) }
+    timezone { build(:timezone) }
     appname Faker::Name.name
     security_token SecureRandom.uuid
   end

data/spec/factories/unity_response_factory.rb

@@ -1,8 +1,8 @@
 FactoryGirl.define do
-  factory :unity_response, :class => AllscriptsUnityClient::UnityResponse do
+  factory :unity_response, class: AllscriptsUnityClient::UnityResponse do
     initialize_with { new(response, timezone) }
 
     response {}
-    timezone FactoryGirl.build(:timezone)
+    timezone { build(:timezone) }
   end
 end