eligible 2.4.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ab954288272a0ffb48111585b865a3e856282af
-  data.tar.gz: bd49eb34f4e6ba5ef8d6280ded9250c92e0b225e
+  metadata.gz: 17923f2b677856fbfddf6fcb264f50c1df9978a3
+  data.tar.gz: 5893d5023436251f4210528eb04427a3b8df88b8
 SHA512:
-  metadata.gz: 03d4b59e89c098e952fa372f3134f8141eb6341cce477723f5a43ead3c168ba2caedcce9ddb5832c09d4589e58cba54da64635fca0b4d884085a30f50cb8b6c8
-  data.tar.gz: d114c923f5a988785ff5214c5e140ada5dcfd4670feb0880fc9bce3b5ff9af31a43808b043fdf8d1d05455d89ab13db701120951e2b4a317d62336c7ef196363
+  metadata.gz: b7b78bb2711b50bf924913be82666f60231968cc9fa04b2dbb327bd0db11f0ac178b2554173139bbb4adf1d68516425f932fd9abd876a6db22d73c4ea644fe2e
+  data.tar.gz: f74b959d868e42bf2a85a903e28aa487fe9d6a5c420cc8f38e83e41bf85d5277ff2c9f7431d207ea90a55cdc791e082d3f68aeeb393d3037bd81894ee5c1c8ce

data/.gitignore

@@ -16,4 +16,3 @@ test/tmp
 test/version_tmp
 tmp
 .idea
-test.rb

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/ChangeLog

@@ -0,0 +1,51 @@
+2016-01-07  Eligible  <support@eligible.com>
+
+	* 2.5.0
+	- Added certificate pinning
+	- Added rubocop and fixed style/linting/metrics issues
+	- Migrated from outdated test-unit/mocha to current rspec for test suite
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 2.4
+	- Refactoring Code
+	- More test cases
+	- Removed legacy endpoint for *plans*, *coverage* should be used instead.
+	- Removed legacy endpoint for *services*, *coverage* should be used instead.
+	- List of contributors and documentation updated.
+	- Gemfile updated, dependencies updated as well.
+	- Removed json gem in favor of multi_json
+	- Fixed the code to let the users make x12 requests at anytime.
+	- New endpoint for Tickets
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 2.3
+	- New endpoint for Batch
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 2.2
+	- New endpoint for x12 POST
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 2.1
+	- New endpoint for payment status
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 2.0
+	- Additional endpoints for claims, enrollments, and coverage
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 1.1
+	- Additional endpoints for service/general and service/list
+	- Support x12 format in params
+
+0000-00-00  Eligible  <support@eligible.com>
+
+	* 1.0
+	- Initial release
+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Eligible
+Copyright (c) 2013-2016 Eligible
 
 MIT License
 

data/README.md

@@ -1,6 +1,8 @@
 # Eligible
 
-Ruby bindings for the [Eligible API](https://eligibleapi.com/rest-api-v1)
+[![Circle CI](https://circleci.com/gh/eligible/eligible-ruby.svg?style=svg)](https://circleci.com/gh/eligible/eligible-ruby)
+
+Ruby bindings for the [Eligible API](https://eligible.com/rest)
 
 ## Installation
 
@@ -16,72 +18,77 @@ Or install it yourself with:
 
     $ gem install eligible
 
-# Important notes
+## Usage
 
-## Payer List for Eligibility
+### Setup
+```ruby
+require 'eligible'
+Eligible.api_key = 'YOUR_KEY'
+```
 
-the parameter *payer_id*, required for most of the api calls, is provided by EligibleAPI from its website,
-in xml and json format, which you can embed into your applications.
+### Test
+```ruby
+Eligible.test = true
+```
 
-[https://eligibleapi.com/resources/information-sources.xml](https://eligibleapi.com/resources/information-sources.xml)
-[https://eligibleapi.com/resources/information-sources.json](https://eligibleapi.com/resources/information-sources.json)
+### Parameters overwrite
 
-## Payer List for Claims
+On each api call, you can overwrite the api key or the test parameter:
 
-the parameter *payer_id*, required for claims, is provided by EligibleAPI from its website,
-in xml and json format, which you can embed into your applications.
+```ruby
+Eligible::Demographic.get({:api_key => 'NEW_KEY', :test => false})
+```
 
-[https://eligibleapi.com/resources/claims-payer.xml](https://eligibleapi.com/resources/claims-payer.xml)
-[https://eligibleapi.com/resources/claims-payer.json](https://eligibleapi.com/resources/claims-payer.json)
+### Response Format
 
-## Service Type Codes
+By default, all responses are in JSON, but you can request raw
+access to X12 by adding is as a parameter on the api call:
 
-the parameter *service_type*, required on the api calls, is provided by EligibleAPI from its website,
-in xml and json format, which you can embed into your applications.
-[https://eligibleapi.com/resources/service-codes.xml](https://eligibleapi.com/resources/service-codes.xml)
-https://eligibleapi.com/resources/service-codes.json](ttps://eligibleapi.com/resources/service-codes.json)
+```ruby
+Eligible::Demographic.get({:format => "x12"})
+```
 
-## Place of Service
+# Important notes
 
-[https://eligibleapi.com/resources/place_of_service.json](https://eligibleapi.com/resources/place_of_service.json)
+## Payer List for Eligibility
 
-## Health Care Provider Taxonomy
+the parameter `payer_id`, required for most of the api calls, is
+provided by Eligible from its website, in xml and json format, which
+you can embed into your applications.
 
-[https://eligibleapi.com/resources/health-care-provider-taxonomy-code-set.json](https://eligibleapi.com/resources/health-care-provider-taxonomy-code-set.json)
+[https://eligible.com/resources/information-sources.xml](https://eligible.com/resources/information-sources.xml)  
+[https://eligible.com/resources/information-sources.json](https://eligible.com/resources/information-sources.json)
 
+## Payer List for Claims
 
-# Usage
+the parameter `payer_id`, required for claims, is provided by Eligible
+from its website, in xml and json format, which you can embed into
+your applications.
 
-### Setup
-```ruby
-    require 'eligible'
-    Eligible.api_key = 'YOUR_KEY'
-```
+[https://eligible.com/resources/claims-payer.xml](https://eligible.com/resources/claims-payer.xml)  
+[https://eligible.com/resources/claims-payer.json](https://eligible.com/resources/claims-payer.json)
 
-### Test
-```ruby
-Eligible.test = true
-```
+## Service Type Codes
 
-### Parameters overwrite
+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.
 
-On each api call, you can overwrite the api key or the test parameter, i.e.
+[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)
 
-```ruby
-   Eligible::Demographic.get({:api_key => 'NEW_KEY', :test => false})
-```
+## Place of Service
 
-### Response Format
+[https://eligible.com/resources/place_of_service.json](https://eligible.com/resources/place_of_service.json)
 
-By default, all the responses came in JSON, but you can request raw access to X12 by adding is as a parameter on the api call.
+## Health Care Provider Taxonomy
 
-```ruby
-   Eligible::Demographic.get({:format => "x12"})
-```
+[https://eligible.com/resources/health-care-provider-taxonomy-code-set.json](https://eligible.com/resources/health-care-provider-taxonomy-code-set.json)
 
 ### Api Call Results
 
-On all the results, you can check for errors in *result.error*, you can get get the raw json format in a has by using *result.to_hash*.
+On all results you can check for errors in `result.error`. The raw
+json format is available by using `result.to_hash`.
 
 ```ruby
 demographic = Eligible::Demographic.get(params)
@@ -93,9 +100,9 @@ demographic.to_hash
 
 ### Reference
 
-[https://eligibleapi.com/rest-api-v1-1/coverage-all#apiCoverageInfo](https://eligibleapi.com/rest-api-v1-1/coverage-all#apiCoverageInfo)
+[https://eligible.com/rest#coverage](https://eligible.com/rest#coverage)
 
-### Retrieve eligibility & benefit information
+### Retrieve eligibility and benefit information
 
 ```ruby
 params = {
@@ -120,7 +127,7 @@ coverage.error   # return error, if any
 
 ### Reference
 
-[https://eligibleapi.com/rest-api-v1-1/demographic-all#apiDemographics](https://eligibleapi.com/rest-api-v1-1/demographic-all#apiDemographics)
+[https://eligible.com/rest#demographics](https://eligible.com/rest#demographics)
 
 ### Fetch demographics for a patient
 
@@ -144,11 +151,7 @@ demographic.error   # return error, if any
 
 ## Medicare
 
-### Reference
-
-[https://github.com/EligibleAPI/tools/wiki/Medicare](https://github.com/EligibleAPI/tools/wiki/Medicare)
-
-### Retrieve eligibility & benefit information from CMS Medicare for a patient.
+### Retrieve eligibility and benefit information from CMS Medicare for a patient.
 
 ```ruby
 params = {
@@ -164,20 +167,15 @@ params = {
 medicare = Eligible::Medicare.get(params)
 medicare.to_hash # returns all coverage info for the request
 medicare.error   # return error, if any
-
 ```
 
 ## Batch API
 
-### Reference
-
-[https://github.com/EligibleAPI/tools/wiki/Batch-Api](https://github.com/EligibleAPI/tools/wiki/Batch-Api)
-
-Its important to notice that all the batch api calls, will notify the results by a webhook.
-
-You can setup a webhook in your [Dashboard](https://www.eligibleapi.com/dashboard/webhooks).
-
-All the batch api calls, returns a *reference_id* value and the *number_of_items* submitted.
+All the batch api calls will notify the results via webhook. You can
+setup a webhook in your
+[Dashboard](https://ligible.com/dashboard/webhooks). All batch api
+calls return a *reference_id* value and the *number_of_items*
+submitted.
 
 ### Coverage Batch API
 
@@ -288,12 +286,9 @@ result.error   # return error, if any
 
 ## Enrollment
 
-### Reference
-
-[https://github.com/EligibleAPI/tools/wiki/Enrollments](https://github.com/EligibleAPI/tools/wiki/Enrollments)
-
-Its important to notice than an Enrollment Request can have multiple Enrollment NPIs, and that the API has been designed
-in a way that you can repeat the enrollment for a NPI multiple times across different Enrollment request.
+Enrollment requests can have multiple enrollment NPIs. You can repeat
+the enrollment for a NPI multiple times across different enrollment
+requests.
 
 ### Create an Enrollment Request
 
@@ -331,7 +326,6 @@ params = {
 result = Eligible::Enrollment.post(params)
 result.to_hash # returns the api call results
 result.error   # return error, if any
-
 ```
 
 ### Retrieve an Enrollment Request
@@ -345,16 +339,10 @@ enrollment.enrollment_npis # quick access to the enrollment npis within the enro
 
 params = { :npis => %w(123 456 789).join(',') }
 enrollment = Eligible::Enrollment.get(params)
-
 ```
 
-
 ## Claims
 
-### Reference
-
-[https://github.com/EligibleAPI/tools/wiki/Claims](https://github.com/EligibleAPI/tools/wiki/Claims)
-
 ### Create Claim object
 
 ```ruby
@@ -433,24 +421,24 @@ enrollment.error  # return error, if any
 ### Retrieve all Claim objects/acknowledgments
 
 ```ruby
-claims = Eligible::Claim.all # returns acknowlegdement information for all claims that have been submitted with the API key
+claims = Eligible::Claim.all # returns acknowledgment information for all claims that have been submitted with the API key
 ```
 
 ### Retrieve individual Claim object/acknowledgment
 
 ```ruby
-params = { 
+params = {
   :reference_id => "12345"
 }
 
-claim = Eligible::Claim.get(params) # returns acknoweldement information on an individual claim identified by its reference_id
+claim = Eligible::Claim.get(params) # returns acknowledgment information on an individual claim identified by its reference_id
 ```
 
 ## Payment Status
 
 ### Reference
 
-[https://eligibleapi.com/rest-api-v1-1/beta/payment-status#apiPaymentStatus](https://eligibleapi.com/rest-api-v1-1/beta/payment-status#apiPaymentStatus)
+[https://eligible.com/rest#payment-status](https://eligible.com/rest#payment-status)
 
 ### Retrieve  Payment status
 
@@ -475,10 +463,6 @@ result.error     # return error, if any
 
 ## X12
 
-### Reference
-
-[https://github.com/EligibleAPI/tools/wiki/X12](https://github.com/EligibleAPI/tools/wiki/X12)
-
 ### X12 post
 
 ```ruby
@@ -489,16 +473,12 @@ result = Eligible::X12.post(params)
 
 ## Tickets
 
-### Reference
-
-[https://github.com/EligibleAPI/tools/wiki/Tickets](https://github.com/EligibleAPI/tools/wiki/Tickets)
-
 ### Create a ticket
 
 ```ruby
 params = {:priority => 'normal',
           :title => 'TITLE',
-          :notification_email => 'admin@eligibleapi.com',
+          :notification_email => 'admin@eligible.com',
           :body => 'Your comment'}
 result = Eligible::Ticket.create params
 result.to_hash # return the api call results
@@ -542,64 +522,22 @@ comments.to_hash # return the api call result
 comments.error   # return error, if any
 ```
 
-
 ### Get all tickets
 
 ```ruby
 Eligible::Ticket.all
 ```
 
-
-# Tests
-
-You can run tests with 
-
-```ruby
-rake test
-```
-
-If you do send a pull request, please add passing tests for the new feature/fix.
-
 ## Contributing
 
+Running `rake` will run the test suite along with rubocop as a basic
+style assessment. If you are going to submit a pull request, please
+verify that all tests pass and there are no rubocop errors. Please add
+additional tests for any features or fixes provided.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Run tests (see above)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
-
-## Changelog
-
-#### 2.4
-- Refactoring Code
-- More test cases
-- Removed legacy endpoint for *plans*, *coverage* should be used instead.
-- Removed legacy endpoint for *services*, *coverage* should be used instead.
-- List of contributors and documentation updated.
-- Gemfile updated, dependencies updated as well.
-- Removed json gem in favor of multi_json
-- Fixed the code to let the users make x12 requests at anytime.
-- New endpoint for Tickets
-
-#### 2.3
-- New endpoint for Batch
-
-#### 2.2
-- New endpoint for x12 POST
-
-#### 2.1 
-- New endpoint for payment status
-
-#### 2.0
-
-- Additional endpoints for claims, enrollments, and coverage
-
-#### 1.1
-
-- Additional endpoints for service/general and service/list
-- Support x12 format in params
-
-#### 1.0
-
-- Initial release

data/Rakefile

@@ -1,4 +1,14 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test)
+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]