eligible 2.5.0 → 2.6.0

data/ChangeLog

@@ -1,3 +1,11 @@
+2016-02-23  Eligible  <support@eligible.com>
+	
+	* 2.6.0
+	- Added new endpoints customer, original signature pdf and payer.
+	- Added specs
+	- Bumped api version to 1.5
+	- Fixed few bugs
+
 2016-01-07  Eligible  <support@eligible.com>
 
 	* 2.5.0

data/README.md

@@ -1,6 +1,6 @@
 # Eligible
 
-[![Circle CI](https://circleci.com/gh/eligible/eligible-ruby.svg?style=svg)](https://circleci.com/gh/eligible/eligible-ruby)
+[![Circle CI](https://circleci.com/gh/eligible/eligible-ruby.svg?style=svg)](https://circleci.com/gh/eligible/eligible-ruby) [![Code Climate](https://codeclimate.com/github/eligible/eligible-ruby/badges/gpa.svg)](https://codeclimate.com/github/eligible/eligible-ruby)
 
 Ruby bindings for the [Eligible API](https://eligible.com/rest)
 

data/Rakefile

@@ -12,3 +12,9 @@ RuboCop::RakeTask.new(:rubocop) do |task|
 end
 
 task default: [:rubocop, :spec]
+
+desc 'Runs code coverage'
+task :rcov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task[:spec].invoke
+end

data/lib/eligible.rb

@@ -12,6 +12,7 @@ require 'eligible/util'
 require 'eligible/json'
 require 'eligible/eligible_object'
 require 'eligible/api_resource'
+require 'eligible/coverage_resource'
 require 'eligible/demographic'
 require 'eligible/claim'
 require 'eligible/enrollment'
@@ -20,6 +21,9 @@ require 'eligible/payment'
 require 'eligible/x12'
 require 'eligible/medicare'
 require 'eligible/ticket'
+require 'eligible/customer'
+require 'eligible/original_signature_pdf'
+require 'eligible/payer'
 
 # Errors
 require 'eligible/errors/eligible_error'
@@ -28,11 +32,10 @@ require 'eligible/errors/authentication_error'
 require 'eligible/errors/api_error'
 require 'eligible/errors/invalid_request_error'
 
-# rubocop:disable Metrics/ModuleLength, Style/ClassVars
 module Eligible
   @@api_key = nil
   @@test = false
-  @@api_version = 1.1
+  @@api_version = '1.5'
   @@api_base = "https://gds.eligibleapi.com/v#{@@api_version}"
   @@fingerprints = %w(79d62e8a9d59ae687372f8e71345c76d92527fac 4b2c6888ede79d0ee47339dc6fab5a6d0dc3cb0e)
 
@@ -81,7 +84,10 @@ module Eligible
     @@fingerprints << digest
   end
 
-  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def self.direct_response?(params)
+    params[:format].is_a?(String) && params[:format].downcase == 'x12'
+  end
+
   def self.request(method, url, api_key, params = {}, headers = {})
     api_key ||= @@api_key
     test = self.test
@@ -104,7 +110,7 @@ module Eligible
     # POST requests, parameters as json in the body
     url = api_url(url)
     case method.to_s.downcase.to_sym
-    when :get, :head
+    when :get, :head, :delete
       url += "?api_key=#{api_key}"
       if params && params.count > 0
         query_string = Util.flatten_params(params).collect { |key, value| "#{key}=#{Util.url_encode(value)}" }.join('&')
@@ -113,7 +119,8 @@ module Eligible
       url += "&test=#{test}"
       payload = nil
     else
-      payload = Eligible::JSON.dump(params.merge!('api_key' => api_key, 'test' => test))
+      params.merge!('api_key' => api_key, 'test' => test)
+      payload = params.key?(:file) ? params : Eligible::JSON.dump(params)
     end
 
     begin
@@ -145,43 +152,44 @@ module Eligible
 
     begin
       response = execute_request(opts)
+
     rescue SocketError => e
       handle_restclient_error(e)
+
     rescue NoMethodError => e
       # Work around RestClient bug
-      if e.message =~ /\WRequestFailed\W/
-        e = APIConnectionError.new('Unexpected HTTP response code')
-        handle_restclient_error(e)
-      else
-        raise
-      end
-    # rubocop:disable Lint/AssignmentInCondition, Style/AndOr
+      raise unless e.message =~ /\WRequestFailed\W/
+
+      e = APIConnectionError.new('Unexpected HTTP response code')
+      handle_restclient_error(e)
+
     rescue RestClient::ExceptionWithResponse => e
-      if rcode = e.http_code and rbody = e.http_body
-        handle_api_error(rcode, rbody)
+      err_rcode = e.http_code
+      err_rbody = e.http_body
+
+      if err_rcode && err_rbody
+        handle_api_error(err_rcode, err_rbody)
       else
         handle_restclient_error(e)
       end
+
     rescue RestClient::Exception, Errno::ECONNREFUSED => e
       handle_restclient_error(e)
     end
 
     rbody = response.body
     rcode = response.code
+
     begin
       # Would use :symbolize_names => true, but apparently there is
       # some library out there that makes symbolize_names not work.
-      resp = if params[:format] && params[:format].downcase == 'x12' || url[-4..-1].downcase == '/x12'
-               rbody
-             else
-               Eligible::JSON.load(rbody)
-             end
+      resp = direct_response?(params) ? rbody : Eligible::JSON.load(rbody)
     rescue MultiJson::DecodeError
       raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
     end
 
     resp = Util.symbolize_names(resp)
-    [resp, api_key]
+    return [ resp, api_key ]
   end
 
   def self.verify_certificate
@@ -208,7 +216,12 @@ module Eligible
     RestClient::Request.execute(opts)
   end
 
-  # rubocop:disable Style/SignalException
+  def self.error_message(error)
+    return error.to_s unless error.is_a?(Hash)
+    result = error[:details] || error[:reject_reason_description] || error
+    return result.to_s
+  end
+
   def self.handle_api_error(rcode, rbody)
     begin
       error_obj = Eligible::JSON.load(rbody)
@@ -219,7 +232,7 @@ module Eligible
       raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
     end
 
-    error_msg = error[:details] || error[:reject_reason_description]
+    error_msg = error_message(error)
 
     case rcode
     when 400, 404 then

data/lib/eligible/api_resource.rb

@@ -10,5 +10,15 @@ module Eligible
       end
       "/#{CGI.escape(class_name.downcase)}/"
     end
+
+    def self.require_param(value, name)
+      fail ArgumentError, "#{name} of the claim is required" if value.nil? || (value.is_a?(String) && value.empty?)
+    end
+
+    def self.send_request(method, url, api_key, params, required_param_name = nil)
+      require_param(params[required_param_name], required_param_name) unless required_param_name.nil?
+      response, api_key = Eligible.request(method, url, api_key, params)
+      Util.convert_to_eligible_object(response, api_key)
+    end
   end
 end

data/lib/eligible/claim.rb

@@ -1,22 +1,25 @@
 module Eligible
   class Claim < APIResource
-    def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, "/claims/acknowledgements/#{params[:reference_id]}.json", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.ack(params, api_key = nil)
+      send_request(:get, "/claims/#{params[:reference_id]}/acknowledgements.json", api_key, params, :reference_id)
     end
 
     def self.post(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/claims.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:post, '/claims.json', api_key, params)
     end
 
-    def self.all(api_key = nil)
-      response, api_key = Eligible.request(:get, '/claims/acknowledgements.json', api_key)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.acks(params, api_key = nil)
+      send_request(:get, '/claims/acknowledgements.json', api_key, params)
     end
 
-    def status
-      error ? nil : to_hash
+    def self.payment_report(params, api_key = nil)
+      require_param(params[:reference_id], 'Reference id')
+      url = params.key?(:id) ? "/claims/#{params[:reference_id]}/payment_reports/#{params[:id]}" : "/claims/#{params[:reference_id]}/payment_reports"
+      send_request(:get, url, api_key, params)
+    end
+
+    def self.payment_reports(params, api_key = nil)
+      send_request(:get, '/claims/payment_reports.json', api_key, params)
     end
   end
 end

data/lib/eligible/coverage.rb

@@ -1,23 +1,19 @@
 module Eligible
-  class Coverage < APIResource
-    def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, '/coverage/all.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+  class Coverage < CoverageResource
+    def self.get_uri
+      return '/coverage/all.json'
     end
 
-    def self.cost_estimate(params, api_key = nil)
-      response, api_key = Eligible.request(:get, '/coverage/cost_estimate.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.post_uri
+      return '/coverage/all/batch.json'
     end
 
-    def self.batch_post(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/coverage/all/batch.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.cost_estimate(params, api_key = nil)
+      send_request(:get, '/coverage/cost_estimates.json', api_key, params)
     end
 
     def self.batch_medicare_post(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/medicare/coverage/batch.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:post, '/medicare/coverage/batch.json', api_key, params)
     end
   end
 end

data/lib/eligible/coverage_resource.rb

@@ -0,0 +1,19 @@
+module Eligible
+  class CoverageResource < APIResource
+    def self.get(params, api_key = nil)
+      send_request(:get, get_uri, api_key, params)
+    end
+
+    def self.batch_post(params, api_key = nil)
+      send_request(:post, post_uri, api_key, params)
+    end
+
+    def self.get_uri
+      fail NotImplementedError, "Please implement class method #{self}.get_uri"
+    end
+
+    def self.post_uri
+      fail NotImplementedError, "Please implement class method #{self}.post_uri"
+    end
+  end
+end

data/lib/eligible/customer.rb

@@ -0,0 +1,19 @@
+module Eligible
+  class Customer < APIResource
+    def self.get(params, api_key = nil)
+      send_request(:get, "/customers/#{params[:customer_id]}.json", api_key, params, :customer_id)
+    end
+
+    def self.post(params, api_key = nil)
+      send_request(:post, '/customers.json', api_key, params)
+    end
+
+    def self.update(params, api_key = nil)
+      send_request(:put, "/customers/#{params[:customer_id]}.json", api_key, params, :customer_id)
+    end
+
+    def self.all(params, api_key = nil)
+      send_request(:get, '/customers.json', api_key, params)
+    end
+  end
+end

data/lib/eligible/demographic.rb

@@ -1,13 +1,11 @@
 module Eligible
-  class Demographic < APIResource
-    def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, '/demographic/all.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+  class Demographic < CoverageResource
+    def self.get_uri
+      return '/demographic/all.json'
     end
 
-    def self.batch_post(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/demographic/all/batch.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.post_uri
+      return '/demographic/all/batch.json'
     end
   end
 end

data/lib/eligible/eligible_object.rb

@@ -4,7 +4,7 @@ module Eligible
 
     attr_accessor :api_key
     attr_accessor :eligible_id
-    # rubocop:disable Style/ClassVars
+
     @@permanent_attributes = Set.new([:api_key, :error, :balance, :address, :dob])
 
     # The default :id method is deprecated and isn't useful to us
@@ -26,7 +26,6 @@ module Eligible
       obj
     end
 
-    # rubocop:disable Metrics/AbcSize
     def refresh_from(values, api_key, partial = false)
       @api_key = api_key
 

data/lib/eligible/enrollment.rb

@@ -1,18 +1,19 @@
 module Eligible
   class Enrollment < APIResource
     def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, "/enrollment_npis/#{params[:enrollment_npi_id]}.json", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:get, "/enrollment_npis/#{params[:enrollment_npi_id]}.json", api_key, params, :enrollment_npi_id)
+    end
+
+    def self.list(params, api_key = nil)
+      send_request(:get, '/enrollment_npis.json', api_key, params)
     end
 
     def self.post(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/enrollment_npis.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:post, '/enrollment_npis.json', api_key, params)
     end
 
     def self.update(params, api_key = nil)
-      response, api_key = Eligible.request(:put, "/enrollment_npis/#{params[:enrollment_npi_id]}.json", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:put, "/enrollment_npis/#{params[:enrollment_npi_id]}.json", api_key, params, :enrollment_npi_id)
     end
 
     def enrollment_npis

data/lib/eligible/medicare.rb

@@ -1,13 +1,11 @@
 module Eligible
-  class Medicare < APIResource
-    def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, '/medicare/coverage.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+  class Medicare < CoverageResource
+    def self.get_uri
+      return '/medicare/coverage.json'
     end
 
-    def self.batch_post(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/medicare/coverage/batch.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.post_uri
+      return '/medicare/coverage/batch.json'
     end
   end
 end

data/lib/eligible/original_signature_pdf.rb

@@ -0,0 +1,29 @@
+module Eligible
+  class OriginalSignaturePdf < APIResource
+    def self.get(params, api_key = nil)
+      send_request(:get, "/enrollment_npis/#{params[:enrollment_npi_id]}/original_signature_pdf", api_key, params, :enrollment_npi_id)
+    end
+
+    def self.post(params, api_key = nil)
+      send_request(:post, "/enrollment_npis/#{params[:enrollment_npi_id]}/original_signature_pdf", api_key, params, :enrollment_npi_id)
+    end
+
+    def self.update(params, api_key = nil)
+      send_request(:put, "/enrollment_npis/#{params[:enrollment_npi_id]}/original_signature_pdf", api_key, params, :enrollment_npi_id)
+    end
+
+    def self.delete(params, api_key = nil)
+      send_request(:delete, "/enrollment_npis/#{params[:enrollment_npi_id]}/original_signature_pdf", api_key, params, :enrollment_npi_id)
+    end
+
+    def self.download(params, api_key = nil)
+      require_param(params[:enrollment_npi_id], 'Enrollment Npi id')
+      params[:format] = 'x12'
+      response = Eligible.request(:get, "/enrollment_npis/#{params[:enrollment_npi_id]}/original_signature_pdf/download", api_key, params)[0]
+      filename = params[:filename] || '/tmp/original_signature_pdf.pdf'
+      file = File.new(filename, 'w')
+      file.write response
+      file.close
+    end
+  end
+end

data/lib/eligible/payer.rb

@@ -0,0 +1,16 @@
+module Eligible
+  class Payer < APIResource
+    def self.list(params, api_key = nil)
+      send_request(:get, '/payers.json', api_key, params)
+    end
+
+    def self.get(params, api_key = nil)
+      send_request(:get, "/payers/#{params[:payer_id]}.json", api_key, params, :payer_id)
+    end
+
+    def self.search_options(params, api_key = nil)
+      url = params.key?(:payer_id) ? "/payers/#{params[:payer_id]}/search_options" : '/payers/search_options'
+      send_request(:get, url, api_key, params)
+    end
+  end
+end

data/lib/eligible/payment.rb

@@ -1,8 +1,7 @@
 module Eligible
   class Payment < APIResource
     def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, '/payment/status.json', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:get, '/payment/status.json', api_key, params)
     end
   end
 end

data/lib/eligible/ticket.rb

@@ -1,33 +1,27 @@
 module Eligible
   class Ticket < APIResource
     def self.create(params, api_key = nil)
-      response, api_key = Eligible.request(:post, '/tickets', api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:post, '/tickets', api_key, params)
     end
 
     def self.comments(params, api_key = nil)
-      response, api_key = Eligible.request(:post, "/tickets/#{params[:id]}/comments", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:post, "/tickets/#{params[:id]}/comments", api_key, params, :id)
     end
 
-    def self.all
-      response, api_key = Eligible.request(:get, '/tickets', api_key)
-      Util.convert_to_eligible_object(response, api_key)
+    def self.all(params, api_key = nil)
+      send_request(:get, '/tickets', api_key, params)
     end
 
     def self.get(params, api_key = nil)
-      response, api_key = Eligible.request(:get, "/tickets/#{params[:id]}", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:get, "/tickets/#{params[:id]}", api_key, params, :id)
     end
 
     def self.delete(params, api_key = nil)
-      response, api_key = Eligible.request(:delete, "/tickets/#{params[:id]}", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:delete, "/tickets/#{params[:id]}", api_key, params, :id)
     end
 
     def self.update(params, api_key = nil)
-      response, api_key = Eligible.request(:put, "/tickets/#{params[:id]}", api_key, params)
-      Util.convert_to_eligible_object(response, api_key)
+      send_request(:put, "/tickets/#{params[:id]}", api_key, params, :id)
     end
   end
 end