eligible 2.8.2 → 2.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12277e8af0e82975de94997f83c564f3cf6ecbff
-  data.tar.gz: c9ae1c944a99d84bcaf590114e63c985d505d703
+  metadata.gz: a2a50028978ef5f3a39e998f84ac1e7a80d45696
+  data.tar.gz: 7296fa9ff2ca890a1e3f5464fe190285d0a2f2df
 SHA512:
-  metadata.gz: 03a4e1ac8dd8ab78947b921d7bba440368b5a777e3f745ce9bf2d99e8d9c170677576cad63f85406d8cc1a866966b085ad6d2a98245751a3b5591aafb14863bd
-  data.tar.gz: deb0e71d15b54b1c9a56097d67646dffbf07ca296bc7290c71bc9c95a1311cf936241883a860eaad160633ab53dada5ad4f6c713be1c269c284ca7bacbddf891
+  metadata.gz: 6376bc0fa92857b043ac2da25a9897a34dd5fc51252a980f667277d4226dfe2b51032673fa2261de3c564d78951ce97be213b2916e97027d6742c6894a70947b
+  data.tar.gz: 41c0a0339c6781b82f23f94df810e5fbb159fadece8f3c5beb2d49edfbc36b58a229a571e8b442cd926e616ac13b115d1868482a7651a93a033f4825bfb2b01b

data/.codeclimate.yml

@@ -4,9 +4,6 @@ engines:
     config:
       languages:
       - ruby
-      - javascript
-      - python
-      - php
 
   fixme:
     enabled: true
@@ -16,12 +13,9 @@ engines:
 
 ratings:
   paths:
-  - "**.inc"
-  - "**.js"
-  - "**.jsx"
-  - "**.module"
-  - "**.php"
-  - "**.py"
+  - Gemfile.lock
+  - Rakefile
+  - "**.rake"
   - "**.rb"
 
 exclude_paths:

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.ruby-gemset
 Gemfile.lock
 InstalledFiles
 _yardoc

data/ChangeLog

@@ -1,3 +1,8 @@
+2017-10-04 Eligible  <support@eligible.com>
+
+	* 2.9.0
+	- Adding revoke functionality for session tokens
+
 2017-03-24 Eligible  <support@eligible.com>
 
 	* 2.8.2

data/README.md

@@ -90,7 +90,7 @@ the parameter `service_type`, required on the api calls, is provided
 by Eligible from its website, in xml and json format, which you can
 embed into your applications.
 
-[https://eligible.com/resources/service-codes.xml](https://eligible.com/resources/service-codes.xml)  
+[https://eligible.com/resources/service-codes.xml](https://eligible.com/resources/service-codes.xml)
 [https://eligible.com/resources/service-codes.json](ttps://eligible.com/resources/service-codes.json)
 
 ## Place of Service
@@ -450,7 +450,7 @@ Eligible::Ticket.all
 ### Create a customer
 
 ```ruby
-customer_params = { customer: { name: "ABC company", 
+customer_params = { customer: { name: "ABC company",
                                 site_name: "ABC site name"
                               }
                   }
@@ -579,7 +579,7 @@ response.to_hash
 params = { payer_id: '12345' }
 response = Eligible::Payer.search_options(params)
 response.to_hash
-``` 
+```
 
 ### Search options for all payers
 
@@ -648,6 +648,33 @@ response = Eligible::Referral.create(params)
 response.to_hash
 ```
 
+## Session Tokens
+
+### Reference
+[https://account.eligible.com/docs/account#session-tokens](https://account.eligible.com/docs/account#session-tokens)
+
+### Retrieve session token
+
+```ruby
+params = { endpoints: 'coverage, cost_estimates, visit_types, payer_list',
+           ttl_seconds: 300,
+           max_calls: 50
+         }
+result = Eligible::SessionToken.create(params)
+result.to_hash # returns all session token info for the request
+result.error # returns error, if any
+```
+
+### Revoke session token
+
+```ruby
+params = { session_token: 'session-token-to-revoke' }
+result = Eligible::SessionToken.revoke(params)
+result.to_hash # returns all session token info for the request
+result.error # returns error, if any
+```
+
+
 ## Errors
 
 This is the list of errors thrown from the eligible ruby gem.
@@ -660,6 +687,28 @@ This is the list of errors thrown from the eligible ruby gem.
 6. NotImplementedError - Raised when the functionality you are trying to use doesn't exist.
 7. ArgumentError - Raised when all the required params are not provided.
 
+### Error Handling
+
+Raised errors have details in `message`, `http_code`, `http_body`, `json_body`, and `errors` attributes:
+
+```ruby
+def call_eligible(request_params)
+  Eligible::Coverage.cost_estimate request_params
+rescue Eligible::AuthenticationError => auth_error # handle any specific error
+  auth_error.message        # readable message
+  auth_error.http_status    # HTTP Status Code
+  auth_error.http_body      # HTTP Response body
+  auth_error.json_body      # HTTP Response body as Hash
+  auth_error.errors         # Errors from Response Hash
+rescue Eligible::EligibleError => error # handle generic error
+  ## Similar format
+  error.message
+  error.http_status
+  error.http_body
+  error.json_body
+  error.errors
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -5,13 +5,7 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-desc 'Run RuboCop on the lib directory'
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
-  task.fail_on_error = false
-end
-
-task default: [:rubocop, :spec]
+task default: [:spec]
 
 desc 'Runs code coverage'
 task :rcov do

data/circle.yml

@@ -0,0 +1,15 @@
+machine:
+  environment:
+    CC_TEST_REPORTER_ID: 1a814ffba15f437df919868f6c26f3c6ac111338b88f9a9d7e2b3030598bccdd
+
+dependencies:
+  post:
+    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+    - chmod +x ./cc-test-reporter
+
+test:
+  pre:
+    - ./cc-test-reporter before-build
+
+  post:
+    - ./cc-test-reporter after-build --exit-code $EXIT_CODE --coverage-input-type simplecov

data/eligible.gemspec

@@ -19,8 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency('rest-client', '~> 2.0.0')
   gem.add_dependency('multi_json', '~> 1.7')
 
-  gem.add_development_dependency('rake', '~> 10.5')
+  gem.add_development_dependency('rake', '~> 12.0')
   gem.add_development_dependency('rspec', '~> 3.4')
-  gem.add_development_dependency('rubocop', '= 0.35.0')
   gem.add_development_dependency('simplecov', '~> 0.11')
 end

data/lib/eligible.rb

@@ -45,9 +45,8 @@ module Eligible
   @@test = false
   @@api_version = '1.5'
   @@api_base = "https://gds.eligibleapi.com/v#{@@api_version}"
-  @@fingerprints = %w(79d62e8a9d59ae687372f8e71345c76d92527fac
-                      4b2c6888ede79d0ee47339dc6fab5a6d0dc3cb0e
-                      de4cdd0aae26df71290f0373af18e9ee7ecff18c)
+  @@fingerprints = %w(de4cdd0aae26df71290f0373af18e9ee7ecff18c
+                      9df5f186fb20ad25ffd864942a6394840b02a480)
 
   def self.api_url(url = '')
     @@api_base + url.to_s
@@ -235,7 +234,21 @@ module Eligible
     RestClient::Request.execute(opts)
   end
 
-  def self.error_message(error)
+  def self.error_message(error, errors)
+    message = compose_message_from_errors(errors)
+    return message if message
+
+    return compose_message_from_error(error)
+  end
+
+  def self.compose_message_from_errors(errors)
+    return unless errors.is_a?(Array)
+
+    return errors.first[:message] if errors.size == 1
+    return errors.each_with_index.map { |error, index| "#{index + 1}. #{error[:message]}" }.join("\n")
+  end
+
+  def self.compose_message_from_error(error)
     return error.to_s unless error.is_a?(Hash)
     result = error[:details] || error[:reject_reason_description] || error
     return result.to_s
@@ -243,15 +256,16 @@ module Eligible
 
   def self.handle_api_error(rcode, rbody)
     begin
-      error_obj = Eligible::JSON.load(rbody)
-      error_obj = Util.symbolize_names(error_obj)
-      fail EligibleError unless error_obj.key?(:error)
+      error_obj = Util.symbolize_names(Eligible::JSON.load(rbody))
+      fail EligibleError unless error_obj.keys.any? { |k| [:error, :errors].include? k }
       error = error_obj[:error]
+      errors = error_obj[:errors]
+
     rescue MultiJson::DecodeError, EligibleError
       raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
     end
 
-    error_msg = error_message(error)
+    error_msg = error_message(error, errors)
 
     case rcode
     when 400, 404 then

data/lib/eligible/api_resource.rb

@@ -21,7 +21,7 @@ module Eligible
     end
 
     def self.require_param(value, name)
-      fail ArgumentError, "#{name} of the claim is required" if value.nil? || (value.is_a?(String) && value.empty?)
+      fail ArgumentError, "#{name} of the #{class_name} 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)

data/lib/eligible/errors/eligible_error.rb

@@ -4,17 +4,19 @@ module Eligible
     attr_reader :http_status
     attr_reader :http_body
     attr_reader :json_body
+    attr_reader :errors
 
     def initialize(message = nil, http_status = nil, http_body = nil, json_body = nil)
       @message = message
       @http_status = http_status
       @http_body = http_body
       @json_body = json_body
+      @errors = (@json_body || {}).fetch(:errors, [])
     end
 
     def to_s
       status_string = @http_status.nil? ? '' : "(Status #{@http_status}) "
-      "#{status_string}#{@message}"
+      "#{status_string}#{@message}: #{@errors.to_json}"
     end
   end
 end

data/lib/eligible/session_token.rb

@@ -3,5 +3,9 @@ module Eligible
     def self.create(params, api_key = nil)
       send_request(:post, '/session_tokens/create.json', api_key, params)
     end
+
+    def self.revoke(params, api_key = nil)
+      send_request(:post, '/session_tokens/revoke.json', api_key, params)
+    end
   end
 end

data/lib/eligible/version.rb

@@ -1,3 +1,3 @@
 module Eligible
-  VERSION = '2.8.2'.freeze
+  VERSION = '2.9.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eligible
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.1
 platform: ruby
 authors:
 - Katelyn Gleaon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -46,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,20 +68,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.35.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.35.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +102,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- circle.yml
 - eligible.gemspec
 - lib/eligible.rb
 - lib/eligible/api_resource.rb
@@ -168,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Eligible API