eligible 3.0.0.beta1 → 3.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f26d623c6899f3464e7e248ac88bc443bf7bc9ca483b7aebe989e430a1f01d4
-  data.tar.gz: 532753d9a4753bec287e0f4d74202b15596711a07898d2e24ad47712ec6580e0
+  metadata.gz: b91ee15bde1467fb30499f497982d0ffdea4a5739855a6bd01e2a5d868cd2d85
+  data.tar.gz: c61d65c8a67fb3b775848fa7b54f7e622995d2cf743c635e1d7ac1539e17cf28
 SHA512:
-  metadata.gz: d579842a87e0968e409d4aa095975c754e8deecb869c474594ee4587156154b69644d69ad951c3cf56dda61cf02202c38dfa2e0159c9e4b0e473c5e1bfc1c34f
-  data.tar.gz: 7f3884cdb6665753356acca910e296b3f8ac57dbae9dab1c6e93ba3d753ced3ae2f90c0642c41ecd3c7808f38998cefcf2f8e59c6ab2256aec97af456c17218a
+  metadata.gz: 5e9d0784d9641a575fa423b9b63c5ffcb1c762d3520f1f611a6de10b4888707562dff6fefbf2e5567a16bf478fbb6e5024b4ad4db8f987b5f7a8263be0018f92
+  data.tar.gz: 2152560fada012eb4da4936a7431bacf2ad4c816fca4e04e7f83647b460e6fe32a1f03b682d640e957f8337c95bd90609eb9f02a2c90d1974ed5fc2816b8e0ac

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.0.0.beta2 - 2020-03-03
+  - Added support for V1.0 REST API endpoints and added Files endpoints
+  - Update pinned api.eligible.com and wildcard.eligible.com certificate
+
 ## 3.0.0.beta1 - 2019-10-01
   - Added support for Eligible-Account Header in the API requests when used Eligible Connect feature
 

data/lib/eligible.rb

@@ -41,6 +41,9 @@ require 'eligible/calculator_deploy_url'
 require 'eligible/risk_assessment'
 require 'eligible/icd'
 
+# New REST API Endpoints
+require 'eligible/v1_0/file_object'
+
 # Errors
 require 'eligible/errors/eligible_error'
 require 'eligible/errors/api_connection_error'
@@ -54,11 +57,14 @@ module Eligible
   @@api_version = '1.5'
   @@api_base = "https://gds.eligibleapi.com/v#{@@api_version}"
   @@fingerprints = %w(9df5f186fb20ad25ffd864942a6394840b02a480
-                      a1cd762a9f4be0f3b6bdd6300e52c6ce8d7d67f5)
+                      a1cd762a9f4be0f3b6bdd6300e52c6ce8d7d67f5
+                      d93b7697100fe978ae0f78fbf2a2443cc1958ca3
+                      896ce24f7a83eb656c040985fdb50ce39f90b813)
   @@eligible_account = nil
 
-  def self.api_url(url = '')
-    @@api_base + url.to_s
+  def self.api_url(url = '', rest_api_version = nil)
+    api_base = rest_api_version ? @@api_base.gsub(/v(\d).(\d)/, "v#{rest_api_version}") : @@api_base
+    api_base + url.to_s
   end
 
   def self.eligible_account
@@ -122,12 +128,18 @@ module Eligible
     Util.key?(params, :api_key)
   end
 
+  def self.rest_api_version?(params)
+    Util.key?(params, :rest_api_version)
+  end
+
   def self.request(method, url, api_key, params = {}, headers = {})
     session_token = Util.value(params, :session_token)
     api_key ||= @@api_key unless session_token
     test = self.test
     api_key = Util.value(params, :api_key) if api_key?(params)
     test = Util.value(params, :test) if test_key?(params)
+    rest_api_version = Util.value(params, :rest_api_version) if rest_api_version?(params)
+    basic_auth = true if rest_api_version?(params)
 
     fail AuthenticationError, 'No API key provided. (HINT: set your API key using "Eligible.api_key = <API-KEY>".' unless api_key || session_token
 
@@ -141,40 +153,13 @@ module Eligible
       uname: uname
     }
 
-    # GET requests, parameters on the query string
-    # POST requests, parameters as json in the body
-    url = api_url(url)
-    case method.to_s.downcase.to_sym
-    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('&')
-        url += "&#{query_string}"
-      end
-      url += "&test=#{test}"
-      payload = nil
-    else
-      params.merge!('api_key' => api_key, 'test' => test)
-      payload = Util.key?(params, :file) ? params : Eligible::JSON.dump(params)
-    end
-
-    begin
-      headers = { x_eligible_debuginfo: Eligible::JSON.dump(debug_info) }.merge(headers)
-    rescue => e
-      headers = {
-        x_eligible_client_raw_user_agent: debug_info.inspect,
-        error: "#{e} (#{e.class})"
-      }.merge(headers)
-    end
-
-    headers = {
-      user_agent: "eligible-ruby/#{Eligible::VERSION}",
-      authorization: "Bearer #{api_key}",
-      content_type: 'application/json'
-    }.merge(headers)
+    # Set request URL and Payload based on new and old endpoints version
+    url, payload = generate_request_url_and_payload(
+      method, url, params, { test: test, rest_api_version: rest_api_version, api_key: api_key, basic_auth: basic_auth },
+    )
 
-    headers[:eligible_version] = api_version if api_version
-    headers[:eligible_account] = eligible_account if eligible_account
+    # Set request Headers and Authorization based on new and old endpoints version
+    headers = generate_request_headers(headers, debug_info, basic_auth, { api_key: api_key, session_token: session_token })
 
     opts = {
       method: method,
@@ -229,6 +214,68 @@ module Eligible
     return [ resp, api_key ]
   end
 
+  def self.generate_request_url_and_payload(method, url, params, options)
+    # GET requests, parameters on the query string
+    # POST requests, parameters as json in the body
+    url = api_url(url, options[:rest_api_version])
+
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      url = fetch_url_with_query_string(params, url, options)
+      payload = nil
+    else
+      payload = request_payload(options, params)
+    end
+
+    [url, payload]
+  end
+
+  def self.fetch_url_with_query_string(params, url, options)
+    url += "?test=#{options[:test]}"
+    url += "&api_key=#{options[:api_key]}" unless options[:basic_auth]
+    return url unless params || params.count == 0
+
+    query_string = Util.flatten_params(params).collect { |key, value| "#{key}=#{Util.url_encode(value)}" }.join('&')
+    url += "&#{query_string}"
+    url
+  end
+
+  def self.request_payload(options, params)
+    params.merge!('test' => options[:test])
+    params.merge!('api_key' => options[:api_key]) unless options[:basic_auth]
+    Util.key?(params, :file) ? params : Eligible::JSON.dump(params)
+  end
+
+  def self.generate_request_headers(headers, debug_info, basic_auth, auth_options)
+    begin
+      headers = { x_eligible_debuginfo: Eligible::JSON.dump(debug_info) }.merge(headers)
+    rescue => e
+      headers = {
+        x_eligible_client_raw_user_agent: debug_info.inspect,
+        error: "#{e} (#{e.class})"
+      }.merge(headers)
+    end
+
+    headers = {
+      user_agent: "eligible-ruby/#{Eligible::VERSION}",
+      content_type: 'application/json'
+    }.merge(headers)
+
+    headers[:authorization] = authorization_header(basic_auth, auth_options)
+    headers[:eligible_version] = api_version if api_version
+    headers[:eligible_account] = eligible_account if eligible_account
+    headers
+  end
+
+  def self.authorization_header(basic_auth, auth_options)
+    # Using Bearer scheme for Session Token Auth for new REST API endpoints (v1.0)
+    return "Bearer #{auth_options[:session_token]}" if basic_auth && auth_options[:session_token]
+
+    # Using Basic Auth for new REST API endpoints (v1.0)
+    basic_auth_token = Base64.strict_encode64("#{auth_options[:api_key]}:")
+    "Basic #{basic_auth_token}" if basic_auth
+  end
+
   def self.verify_certificate
     lambda do |preverify_ok, certificate_store|
       return true if test == 'true'

data/lib/eligible/api_resource.rb

@@ -6,10 +6,10 @@ module Eligible
 
     def self.api_url(base, params = nil, param_id = nil)
       if params.nil?
-        "/#{base}.json"
+        "/#{base}"
       else
         id = Util.value(params, param_id)
-        "/#{base}/#{id}.json"
+        "/#{base}/#{id}"
       end
     end
 
@@ -41,9 +41,10 @@ module Eligible
 
       required_param_validation(params: params, required_params: headers.delete(:required_params))
 
+      # Here rest_api_version is related to New REST API Endpoints
+      params = self.const_defined?(:REST_API_VERSION) ? params.merge(rest_api_version: self::REST_API_VERSION) : params
       response, api_key = Eligible.request(method, url, api_key, params, headers)
       Util.convert_to_eligible_object(response, api_key)
     end
-
   end
 end

data/lib/eligible/public_key.rb

@@ -12,7 +12,7 @@ module Eligible
 
     def self.activate(params, opts = {})
       key_id = Util.value(params, :key_id)
-      send_request :get, "/public_keys/#{key_id}/activate.json", params, opts.merge(required_params: [:key_id])
+      send_request :get, "/public_keys/#{key_id}/activate", params, opts.merge(required_params: [:key_id])
     end
 
     def self.all(params, opts = {})

data/lib/eligible/v1_0/file_object.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Eligible
+  class FileObject < APIResource
+    REST_API_VERSION = '1.0'.freeze
+
+    def self.get(params, opts = {})
+      send_request :get, api_url('files', params, :file_id), params, opts.merge(required_params: [:file_id])
+    end
+
+    def self.post(params, opts = {})
+      send_request :post, api_url('files'), params, opts
+    end
+
+    def self.list(params, opts = {})
+      send_request :get, api_url('files'), params, opts
+    end
+  end
+end

data/lib/eligible/version.rb

@@ -1,3 +1,3 @@
 module Eligible
-  VERSION = '3.0.0.beta1'.freeze
+  VERSION = '3.0.0.beta2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eligible
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - Katelyn Gleaon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -155,6 +155,7 @@ files:
 - lib/eligible/session_token.rb
 - lib/eligible/ticket.rb
 - lib/eligible/util.rb
+- lib/eligible/v1_0/file_object.rb
 - lib/eligible/version.rb
 - lib/eligible/visit_type.rb
 - lib/eligible/x12.rb