eligible 1.0 → 1.1

data/README.md

@@ -19,100 +19,121 @@ Or install it yourself with:
 ## Usage
 
 ### Setup
-    require eligible
+    require 'eligible'
     Eligible.api_key = YOUR_KEY
 
+### Format
+
+Include `{ :format => "X12" }` in the params hash to get back the raw X12 response.
+
 ### Retrieve Plan object and query it
-    params = {
-      :payer_name => "Aetna",
-      :payer_id   => "000001",
-      :service_provider_last_name => "Last",
-      :service_provider_first_name => "First",
-      :service_provider_NPI => "1928384219",
-      :subscriber_id => "W120923801",
-      :subscriber_last_name => "Austen",
-      :subscriber_first_name => "Jane",
-      :subscriber_dob => "1955-12-14"
-    }
-
-    plan = Eligible::Plan.get(params)
-    plan.all      # returns all fields on the plan, per the plan/all endpoint
-    plan.status   # returns status fields on the plan, per the plan/status endpoint
-    ## Etc.: plan.deductible, plan.dates, plan.balance, plan.stop_loss 
+
+```ruby
+params = {
+  :payer_name => "Aetna",
+  :payer_id   => "000001",
+  :service_provider_last_name => "Last",
+  :service_provider_first_name => "First",
+  :service_provider_NPI => "12345678",
+  :subscriber_id => "12345678",
+  :subscriber_last_name => "Austen",
+  :subscriber_first_name => "Jane",
+  :subscriber_dob => "1955-12-14"
+}
+
+plan = Eligible::Plan.get(params)
+plan.all      # returns all fields on the plan, per the plan/all endpoint
+plan.status   # returns status fields on the plan, per the plan/status endpoint
+## Etc.: plan.deductible, plan.dates, plan.balance, plan.stop_loss 
+```
 
 ### Retrieve Service object and query it
-    params = {
-      :payer_name => "Aetna",
-      :payer_id   => "000001",
-      :service_provider_last_name => "Last",
-      :service_provider_first_name => "First",
-      :service_provider_NPI => "1928384219",
-      :subscriber_id => "W120923801",
-      :subscriber_last_name => "Austen",
-      :subscriber_first_name => "Jane",
-      :subscriber_dob => "1955-12-14"
-    }
-
-    service = Eligible::Service.get(params)
-    service.all     # returns all fields for the service, per service/all
-    service.visits  # returns the visits for the service, per service/visits
-    ## Etc.: service.copayment, service.coinsurance, service.deductible
+
+```ruby
+params = {
+  :payer_name => "Aetna",
+  :payer_id   => "000001",
+  :service_provider_last_name => "Last",
+  :service_provider_first_name => "First",
+  :service_provider_NPI => "12345678",
+  :subscriber_id => "12345678",
+  :subscriber_last_name => "Austen",
+  :subscriber_first_name => "Jane",
+  :subscriber_dob => "1955-12-14"
+}
+
+service = Eligible::Service.get(params)
+service.all     # returns all fields for the service, per service/all
+service.visits  # returns the visits for the service, per service/visits
+## Etc.: service.copayment, service.coinsurance, service.deductible
+
+## The endpoints 'general' and 'list' have a slightly different syntax than the others: 
+json = Eligible::Service.general(params)
+json = Eligible::Service.list(params)
+```
 
 ### Retrieve Demographic object and query it
-    params = {
-      :payer_name => "Aetna",
-      :payer_id   => "000001",
-      :service_provider_last_name => "Last",
-      :service_provider_first_name => "First",
-      :service_provider_NPI => "1928384219",
-      :subscriber_id => "W120923801",
-      :subscriber_last_name => "Austen",
-      :subscriber_first_name => "Jane",
-      :subscriber_dob => "1955-12-14"
-    }
-
-    demographic = Eligible::Demographic.get(params)
-    demographic.all # returns all fields for the demographic, per demographic/all
-    demographic.zip # returns the patient's zip code, per demographic/zip
-    ## Etc.: demographic.employer, demographic.address, demographic.dob
+
+```ruby
+params = {
+  :payer_name => "Aetna",
+  :payer_id   => "000001",
+  :service_provider_last_name => "Last",
+  :service_provider_first_name => "First",
+  :service_provider_NPI => "12345678",
+  :subscriber_id => "12345678",
+  :subscriber_last_name => "Austen",
+  :subscriber_first_name => "Jane",
+  :subscriber_dob => "1955-12-14"
+}
+
+demographic = Eligible::Demographic.get(params)
+demographic.all # returns all fields for the demographic, per demographic/all
+demographic.zip # returns the patient's zip code, per demographic/zip
+## Etc.: demographic.employer, demographic.address, demographic.dob
+```
 
 ### Retrieve Claim object
 
-    params = {
-      :payer_name => "Aetna",
-      :payer_id => "000001",
-      :information_receiver_organization_name => "Organization",
-      :information_receiver_last_name => "Last",
-      :information_receiver_first_name => "First",
-      :information_receiver_etin => "1386332",
-      :service_provider_organization_name => "Marshall Group",
-      :service_provider_last_name => "Last",
-      :service_provider_first_name => "First",
-      :service_provider_npi => "1928384219",
-      :service_provider_tax_id => "1386332",
-      :subscriber_id => "W120923801",
-      :subscriber_last_name => "Last", 
-      :subscriber_first_name => "First",
-      :subscriber_dob => "1955-12-14",
-      :dependent_last_name => "Last",
-      :dependent_first_name => "First",
-      :dependent_dob => "1975-12-14",
-      :dependent_gender => "M",
-      :trace_number => "12345",
-      :claim_control_number => "67890",
-      :claim_charge_amount => "45.00",
-      :claim_start_date => "2013-01-05",
-      :claim_end_date => "2013-01-05"
-    }    
-    
-    claim = Eligible::Claim.get(params)
-    claim.status # Returns in real time the status (paid, not paid, rejected, denied, etc) of claim specified.
+```ruby
+params = {
+  :payer_name => "Aetna",
+  :payer_id => "000001",
+  :information_receiver_organization_name => "Organization",
+  :information_receiver_last_name => "Last",
+  :information_receiver_first_name => "First",
+  :information_receiver_etin => "12345678",
+  :service_provider_organization_name => "Marshall Group",
+  :service_provider_last_name => "Last",
+  :service_provider_first_name => "First",
+  :service_provider_npi => "12345678",
+  :service_provider_tax_id => "12345678",
+  :subscriber_id => "12345678",
+  :subscriber_last_name => "Last", 
+  :subscriber_first_name => "First",
+  :subscriber_dob => "1955-12-14",
+  :dependent_last_name => "Last",
+  :dependent_first_name => "First",
+  :dependent_dob => "1975-12-14",
+  :dependent_gender => "M",
+  :trace_number => "12345",
+  :claim_control_number => "67890",
+  :claim_charge_amount => "45.00",
+  :claim_start_date => "2013-01-05",
+  :claim_end_date => "2013-01-05"
+}    
+
+claim = Eligible::Claim.get(params)
+claim.status # Returns in real time the status (paid, not paid, rejected, denied, etc) of claim specified.
+```
 
 ## Tests
 
 You can run tests with 
 
-    rake test
+```ruby
+rake test
+```
 
 If you do send a pull request, please add passing tests for the new feature/fix.
 
@@ -124,3 +145,14 @@ If you do send a pull request, please add passing tests for the new feature/fix.
 4. Run tests (see above)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
+
+## Changelog
+
+#### 1.1
+
+- Additional endpoints for service/general and service/list
+- Support x12 format in params
+
+#### 1.0
+
+- Initial release

data/lib/eligible.rb

@@ -151,7 +151,7 @@ module Eligible
     begin
       # Would use :symbolize_names => true, but apparently there is
       # some library out there that makes symbolize_names not work.
-      resp = Eligible::JSON.load(rbody)
+      resp = params[:format] && params[:format].match(/x12/i) ? 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

data/lib/eligible/service.rb

@@ -18,21 +18,41 @@ module Eligible
 
     def visits
       keys = COMMON_ATTRIBUTES + STATUS_ATTRIBUTES + VISITS_ATTRIBUTES
-      error ? nil : to_hash.select { |k, v| keys.include?(k) }
+      k_to_hash(keys)
     end
 
     def copayment
       keys = COMMON_ATTRIBUTES + STATUS_ATTRIBUTES + COPAYMENT_ATTRIBUTES
-      error ? nil : to_hash.select { |k, v| keys.include?(k) }
+      k_to_hash(keys)
     end
 
     def coinsurance
       keys = COMMON_ATTRIBUTES + STATUS_ATTRIBUTES + COINSURANCE_ATTRIBUTES
-      error ? nil : to_hash.select { |k, v| keys.include?(k) }
+      k_to_hash(keys)
     end
 
     def deductible
       keys = COMMON_ATTRIBUTES + STATUS_ATTRIBUTES + DEDUCTIBLE_ATTRIBUTES
+      k_to_hash(keys)
+    end
+
+    def self.general(params, api_key=nil)
+      response, api_key = Eligible.request(:get, "/service/general.json", api_key, params)
+      response = Util.convert_to_eligible_object(response, api_key)
+      response = response.to_hash if response.is_a? Hash
+      response
+    end
+
+    def self.list(params, api_key=nil)
+      response, api_key = Eligible.request(:get, "/service/list.json", api_key, params)
+      response = Util.convert_to_eligible_object(response, api_key)
+      response = response.to_hash if response.is_a? Hash
+      response
+    end
+
+    private
+
+    def k_to_hash(keys)
       error ? nil : to_hash.select { |k, v| keys.include?(k) }
     end
   end

data/lib/eligible/version.rb

@@ -1,3 +1,3 @@
 module Eligible
-  VERSION = "1.0"
+    VERSION = "1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eligible
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70130122371040 !ruby/object:Gem::Requirement
+  requirement: &70151816374100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70130122371040
+  version_requirements: *70151816374100
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70130122370000 !ruby/object:Gem::Requirement
+  requirement: &70151816370940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70130122370000
+  version_requirements: *70151816370940
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &70130122368580 !ruby/object:Gem::Requirement
+  requirement: &70151816383660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70130122368580
+  version_requirements: *70151816383660
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70130122367240 !ruby/object:Gem::Requirement
+  requirement: &70151816381080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70130122367240
+  version_requirements: *70151816381080
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70130122450000 !ruby/object:Gem::Requirement
+  requirement: &70151816394460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '1.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70130122450000
+  version_requirements: *70151816394460
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70130122473580 !ruby/object:Gem::Requirement
+  requirement: &70151816402500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,7 +79,7 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70130122473580
+  version_requirements: *70151816402500
 description: Eligible is a developer-friendly way to process health care eligibility
   checks. Learn more at https://eligibleapi.com
 email: