allscripts_unity_client 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecd96ba97fa670be830e0a85f10e577201e6363b
-  data.tar.gz: 87af8b8cbf7ebcea83ef5b0cf69d0ad67f3d2ab6
+  metadata.gz: 0f4d391c7be9dbfb1805efb30c26b2def701a968
+  data.tar.gz: 8339db470d7aeb19974e82b4d8e714af42103cee
 SHA512:
-  metadata.gz: b0c13a8a52bca8a0ad7a26ca837f1d8820922dd952ac08ccba9a23c03331731f141757ebcd7a7489f322ece978f4742dc630728cf30e40c4ceaeb905bb5e6a9d
-  data.tar.gz: 83b22d9a877b32fe3014450e4ab4500baedd05b945a7f81367046d8823afd4b873cc0db14a615a79ede8a5767db92315c69b87308e9dda4e456e91b3b7f41586
+  metadata.gz: b7bafb0b0cbf587c7729fda1ff143f20f3481d54fa3f54b5f383c1c728ed942bfe64937b61ecb53b24f6fc837f21d420e34190c968cbaaa77c13429cdff3286a
+  data.tar.gz: 663bd4436aa214ac28cbc47e7f24109e9193f75ff27b60e60b19af2b42790268fce2cd9cce33a7da277afbad19a160b341c9e4513e8d1a65b2d9340d771b212d

data/README.md

@@ -1,4 +1,4 @@
-# Allscripts Unity Client [![Build Status](https://travis-ci.org/healthfinch/allscripts-unity-client.png?branch=master)](https://travis-ci.org/healthfinch/allscripts-unity-client) [![Coverage Status](https://coveralls.io/repos/healthfinch/allscripts-unity-client/badge.png?branch=master)](https://coveralls.io/r/healthfinch/allscripts-unity-client?branch=master)
+# Allscripts Unity Client [![Build Status](https://travis-ci.org/healthfinch/allscripts-unity-client.png?branch=version2)](https://travis-ci.org/healthfinch/allscripts-unity-client) [![Coverage Status](https://coveralls.io/repos/healthfinch/allscripts-unity-client/badge.png?branch=master)](https://coveralls.io/r/healthfinch/allscripts-unity-client?branch=version2)
 
 The `allscripts_unity_client` gem is a Ruby client for the Allscripts Unity API. See http://remotecentral.allscripts.com/UnityAPIReference for more documentation on the API.
  
@@ -45,6 +45,38 @@ unity_client = AllscriptsUnityClient.create({
 })
 ```
 
+## SSL Management
+
+[Faraday](https://github.com/lostisland/faraday) is used in combination with [EM-HTTP-Request](https://github.com/igrigorik/em-http-request) to send HTTP requests when using JSON clients. Faraday requires
+some configuration when making connections over SSL. AllscriptsUnityClient will try to auto-detect the location of the
+operating system's CA File or CA Path, but these values can be explicitly configured when creating a client:
+
+```ruby
+# Mode defaults to :soap
+unity_client = AllscriptsUnityClient.create({
+  mode: :json,
+  base_unity_url: "http://unity.base.url",
+  appname: "appname",
+  username: "username",
+  password: "password",
+  ca_file: "/usr/lib/ssl/certs/ca-certificates.crt"
+})
+```
+
+OR
+
+```ruby
+# Mode defaults to :soap
+unity_client = AllscriptsUnityClient.create({
+  mode: :json,
+  base_unity_url: "http://unity.base.url",
+  appname: "appname",
+  username: "username",
+  password: "password",
+  ca_path: "/usr/lib/ssl/certs"
+})
+```
+
 ### Security token management
 
 Security tokens can be manually requested using the `get_security_token!` method:

data/lib/allscripts_unity_client/client_options.rb

@@ -1,7 +1,7 @@
 module AllscriptsUnityClient
   class ClientOptions
     attr_accessor :proxy, :logger
-    attr_reader :base_unity_url, :username, :password, :appname, :timezone
+    attr_reader :base_unity_url, :username, :password, :appname, :timezone, :ca_file, :ca_path
 
     def initialize(options = {})
       @base_unity_url = options[:base_unity_url] ? options[:base_unity_url].gsub(/\/$/, '') : nil
@@ -11,6 +11,8 @@ module AllscriptsUnityClient
       @proxy = options[:proxy]
       self.timezone = options[:timezone]
       @logger = options[:logger]
+      @ca_file = options[:ca_file]
+      @ca_path = options[:ca_path]
 
       validate_options
     end
@@ -64,5 +66,17 @@ module AllscriptsUnityClient
     def logger?
       !@logger.nil?
     end
+
+    def ca_file?
+      return false if @ca_file.nil?
+      return false if @ca_file.empty?
+      true
+    end
+
+    def ca_path?
+      return false if @ca_path.nil?
+      return false if @ca_path.empty?
+      true
+    end
   end
 end

data/lib/allscripts_unity_client/json_client_driver.rb

@@ -10,11 +10,7 @@ module AllscriptsUnityClient
 
     def initialize(options)
       super
-      @connection = Faraday.new(url: @options.base_unity_url) do |conn|
-        if @options.proxy?
-          conn.proxy @options.proxy
-        end
-
+      @connection = Faraday.new(build_faraday_options) do |conn|
         conn.adapter :em_http
       end
     end
@@ -102,5 +98,54 @@ module AllscriptsUnityClient
         raise APIError, response
       end
     end
+
+    def build_faraday_options
+      options = {}
+
+      # Configure Faraday base url
+      options[:url] = @options.base_unity_url
+
+      # Configure root certificates for Faraday using options or via auto-detection
+      if @options.ca_file?
+        options[:ssl] = { ca_file: @options.ca_file }
+      elsif @options.ca_path?
+        options[:ssl] = { ca_path: @options.ca_path }
+      elsif ca_file = JSONClientDriver.find_ca_file
+        options[:ssl] = { ca_file: ca_file }
+      elsif ca_path = JSONClientDriver.find_ca_path
+        options[:ssl] = { ca_path: ca_path }
+      end
+
+      # Configure proxy
+      if @options.proxy?
+        options[:proxy] = @options.proxy
+      end
+
+      options
+    end
+
+    def self.find_ca_path
+      if File.directory?('/usr/lib/ssl/certs')
+        return '/usr/lib/ssl/certs'
+      end
+
+      nil
+    end
+
+    def self.find_ca_file
+      if File.exists?('/opt/boxen/homebrew/opt/curl-ca-bundle/share/ca-bundle.crt')
+        return '/opt/boxen/homebrew/opt/curl-ca-bundle/share/ca-bundle.crt'
+      end
+
+      if File.exists?('/opt/local/share/curl/curl-ca-bundle.crt')
+        return '/opt/local/share/curl/curl-ca-bundle.crt'
+      end
+
+      if File.exists?('/usr/lib/ssl/certs/ca-certificates.crt')
+        return '/usr/lib/ssl/certs/ca-certificates.crt'
+      end
+
+      nil
+    end
   end
 end

data/lib/allscripts_unity_client/version.rb

@@ -1,3 +1,3 @@
 module AllscriptsUnityClient
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allscripts_unity_client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Ash Gupta
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon