redox 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6ab25d3f19478659e8b289237cfc384ac214d2ac2fe880a4e5ea324b16488e0
-  data.tar.gz: 035f903ba8152429b06c1ab2e1a6a17bc7639974bd483440448a391bab7c7763
+  metadata.gz: 4cf3d701269f03a48d3cd1fe870e2f124aeb705c643c4cd3826ad5b352317276
+  data.tar.gz: 562cc78ba951b7a58a3365612e09e38f114d7a7ab8ceb80b6e0e1c73b5592c7a
 SHA512:
-  metadata.gz: de4c1669a46c1cc4257d84ae12a8a3243679bf6d264e58383519a57cc405ab71fa870d098903b92edd322a672f6901481e9e824d259c6f1d86e8223d642f25e7
-  data.tar.gz: e98d7dfdfd023b845dcffadfcf46e17f8e21d2f1357f88cc0e0454cb377d2f7e6dad179a9c206f75be9432630cc6ccfcb6ec6ab6d73da8e06f73f43657e88de4
+  metadata.gz: fdd640751e3226609ac29cf6be385b7ae52487df1e46fa925e8e984cdf1e0458066f14e16a464dfa43d1201f9b0efcd988442c4eea26fd770a9b57d10e5cfd48
+  data.tar.gz: a339571774b1058f4b646d0d2667bee605def7683c2aa47e152f41bfb3cb51872915a91d120a8b7da5e75c89da0ff0b46ef7292931c3da9cd5941b74fd31b73e

data/CHANGELOG.md

@@ -4,9 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.1.6] - Unreleased
 ### Added
-- <TBD>
+- Meta model
+- Response and Authentication classes
+
+### Changed
+- Created a single request method
+- Allow caller to override all Meta
+- Made calls consistent in return and call signature
 
 ## [0.1.5] - 2019-04-09
 ### Added

data/lib/redox.rb

@@ -4,7 +4,10 @@ require 'uri'
 require 'openssl'
 require 'redox/version'
 require 'redox/redox_exception'
+require 'redox/authentication'
+require 'redox/response'
 require 'redox/models/model'
+require 'redox/models/meta'
 require 'redox/models/patient'
 require 'redox/models/demographics'
 require 'redox/models/identifiers'
@@ -12,6 +15,8 @@ require 'redox/models/identifiers'
 module Redox
   # Redox API client
   class Redox
+    DEFAULT_URI = 'https://api.redoxengine.com/'.freeze
+
     # Instantiates a new Redox connection object
     #
     # @param [String] api_key API key for the connection
@@ -27,15 +32,17 @@ module Redox
     #     destinations: destinations,
     #     test: true
     #   )
-    def initialize(api_key:, secret:, source:, destinations:, facility_code: nil, test: true)
+    def initialize(api_key:, secret:, source: nil, destinations: nil, facility_code: nil, test: true, uri: DEFAULT_URI)
       @api_key = api_key
       @secret = secret
-      @source = source
-      @destinations = destinations
-      @facility_code = facility_code
-      @test = test
+      @meta   = Models::Meta.new
+      destinations.each {|dest| @meta.add_destination(dest['Name'], dest['ID']) } if destinations
+      @meta.source = source if source
+      @meta.facility_code = facility_code if facility_code
+      @meta.test   = test
       @connection = nil
-      @access_token = nil
+      @authentication = nil
+      @uri = uri
     end
 
     # Send NewPatient message
@@ -49,16 +56,15 @@ module Redox
     #       FirstName: 'Joe'
     #     }
     #   )
-    def add_patient(patient_params)
-      patient_request = Net::HTTP::Post.new('/endpoint', auth_header)
-      request_body = request_meta(
-        data_model: 'PatientAdmin', event_type: 'NewPatient'
-      ).merge(Patient: patient_params)
-      patient_request.body = request_body.to_json
-
-      response = connection.request(patient_request)
-
-      JSON.parse(response.body)
+    def add_patient(patient_params, meta = nil)
+      meta = @meta.merge(Models::Meta.from_h(Models::Patient::ADD[:meta]).merge(meta))
+      body = meta.to_h.merge(Patient: patient_params)
+
+      return request(
+        endpoint: Models::Patient::ADD[:endpoint],
+        body: body.to_json,
+        model: Models::Patient
+      )
     end
 
     # Send PatientUpdate message
@@ -72,16 +78,15 @@ module Redox
     #       FirstName: 'Joe'
     #     }
     #   )
-    def update_patient(patient_params)
-      patient_request = Net::HTTP::Post.new('/endpoint', auth_header)
-      request_body = request_meta(
-        data_model: 'PatientAdmin', event_type: 'PatientUpdate'
-      ).merge(Patient: patient_params)
-      patient_request.body = request_body.to_json
-
-      response = connection.request(patient_request)
-
-      JSON.parse(response.body)
+    def update_patient(patient_params, meta = nil)
+      meta = @meta.merge(Models::Meta.from_h(Models::Patient::UPDATE[:meta]).merge(meta))
+      body = meta.to_h.merge(Patient: patient_params)
+
+      return request(
+        endpoint: Models::Patient::UPDATE[:endpoint],
+        body: body.to_json,
+        model: Models::Patient
+      )
     end
 
     # Send PatientSearch query
@@ -95,43 +100,55 @@ module Redox
     #       FirstName: 'Joe'
     #     }
     #   )
-    def search_patients(patient_params)
-      patient_request = Net::HTTP::Post.new(Models::Patient::SEARCH[:endpoint], auth_header)
-      request_body = request_meta(Models::Patient::SEARCH[:meta])
-        .merge(Patient: patient_params)
-      patient_request.body = request_body.to_json
-
-      response = connection.request(patient_request)
-
-      return Models::Patient.new(JSON.parse(response.body))
+    def search_patients(patient_params, meta = nil)
+      meta = @meta.merge(Models::Meta.from_h(Models::Patient::SEARCH[:meta]).merge(meta))
+      body = meta.to_h.merge(Patient: patient_params)
+
+      return request(
+        endpoint: Models::Patient::SEARCH[:endpoint],
+        body: body.to_json,
+        model: Models::Patient
+      )
     end
 
     private
 
-    attr_reader :api_key, :secret, :source, :destinations, :facility_code, :test
+    attr_reader :api_key, :secret, :meta
+
+    def request(endpoint: , body: , header: {}, model: nil, authorize: true)
+      header = {
+        'Content-Type' => 'application/json'
+      }.merge(header)
+
+      header = header.merge(authenticate.access_header) if authorize
+
+      request = Net::HTTP::Post.new(endpoint, header)
+      request.body = body
 
-    def access_token
-      return @access_token if @access_token
+      return Response.new(connection.request(request), model)
+    end
+
+    def authenticate
+      return @authentication if @authentication
 
-      login_request = Net::HTTP::Post.new(
-        '/auth/authenticate', 'Content-Type' => 'application/json'
+      redox_response = request(
+        endpoint: Authentication::ENDPOINT,
+        body: { apiKey: api_key, secret: secret }.to_json,
+        model: Authentication,
+        authorize: false
       )
-      login_request.body = { apiKey: api_key, secret: secret }.to_json
-      response = connection.request(login_request)
 
-      if (false == response.is_a?(Net::HTTPOK))
-        raise RedoxException.from_response(response, msg: 'Authentication')
+      if (false == redox_response.success?)
+        raise RedoxException.from_response(redox_response.http_response, msg: 'Authentication')
       end
 
-      body = JSON.parse(response.body)
-
-      @access_token = body['accessToken']
+      @authentication = redox_response.model
     end
 
     def connection
       return @connection if @connection
 
-      uri = URI.parse('https://api.redoxengine.com/')
+      uri = URI.parse(@uri)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_PEER
@@ -139,29 +156,5 @@ module Redox
 
       @connection = http
     end
-
-    def auth_header
-      {
-        'Authorization' => "Bearer #{access_token}",
-        'Content-Type' => 'application/json'
-      }
-    end
-
-    def request_meta(data_model:, event_type:)
-      meta_object = {
-        Meta: {
-          DataModel: data_model,
-          EventType: event_type,
-          EventDateTime: nil,
-          Test: test,
-        }
-      }
-
-      meta_object[:Meta][:FacilityCode] = facility_code if facility_code
-      meta_object[:Meta][:Source] = source if source
-      meta_object[:Meta][:Destinations] = destinations if destinations && !destinations.empty?
-
-      meta_object
-    end
   end
 end

data/lib/redox/authentication.rb

@@ -0,0 +1,19 @@
+module Redox
+  class Authentication
+    ENDPOINT = '/auth/authenticate'.freeze
+
+    def initialize(response_body)
+      @body = response_body
+    end
+
+    def access_token
+      return @body['accessToken']
+    end
+
+    def access_header
+      return {
+        'Authorization' => "Bearer #{access_token}",
+      }
+    end
+  end
+end

data/lib/redox/models/demographics.rb

@@ -1,7 +1,7 @@
 module Redox
   module Models
     class Demographics < Model
-      KEY = 'Demographics'
+      KEY = 'Demographics'.freeze
     end
   end
 end

data/lib/redox/models/identifiers.rb

@@ -1,7 +1,7 @@
 module Redox
   module Models
     class Identifiers < Model
-      KEY = 'Identifiers'
+      KEY = 'Identifiers'.freeze
     end
   end
 end

data/lib/redox/models/meta.rb

@@ -0,0 +1,80 @@
+module Redox
+  module Models
+    class Meta < Model
+      KEY = 'Meta'.freeze
+
+      DEFAULT = -> () {
+        return {
+          KEY => {
+            'DataModel' => nil,
+            'EventType' => nil,
+            'EventDateTime' => Time.now.strftime("%Y-%m-%dT%H:%M:%S.%6NZ"),
+            'Test' => true,
+            'Source' => {},
+            'Destinations' => [],
+            'FacilityCode' => nil
+          }
+        }
+      }
+
+      def initialize(data = DEFAULT.call)
+        super(data)
+      end
+
+      def add_destination(name, id)
+        self.inner['Destinations'] << Meta.build_subscription(name, id)
+
+        return self
+      end
+
+      def set_source(name, id)
+        self.source = Meta.build_subscription(name, id)
+
+        return self
+      end
+
+      def source=(source)
+        self.inner['Source'] = source
+      end
+
+      def facility_code=(facility_code)
+        self.inner['FacilityCode'] = facility_code.to_s
+      end
+
+      def test=(test)
+        self.inner['Test'] = (true == test)
+      end
+
+      def merge(other)
+        if (other.is_a?(Hash))
+          if (other.include?(KEY))
+            self.inner.merge!(other[KEY])
+          else
+            self.inner.merge!(other)
+          end
+        elsif (other.is_a?(self.class))
+          self.inner.merge!(other.inner.select {|k,v| !v.nil?})
+        end
+
+        return self
+      end
+
+      def to_h
+        return JSON.parse(@data.to_json)
+      end
+
+      class << self
+        def build_subscription(name, id)
+          return {
+            'ID' => id,
+            'Name' => name
+          }
+        end
+
+        def from_h(hash)
+          return Meta.new.merge(hash)
+        end
+      end
+    end
+  end
+end

data/lib/redox/models/model.rb

@@ -11,39 +11,17 @@ module Redox
         return @data.is_a?(Hash) && @data.include?(self.class::KEY)
       end
 
-      def raw(key: self.class::KEY)
+      def raw
+        return self.inner(key: nil)
+      end
+
+      def inner(key: self.class::KEY)
         if key.nil?
           return @data
         else
           return @data[key]
         end
       end
-
-      def map(mapper: {}, data: self.raw)
-        result = {}
-
-        if (true == mapper.is_a?(Hash))
-          mapper.each do |key, value|
-            if (true == value.is_a?(Hash))
-              result = result.merge(self.map(data: data[key], mapper: value))
-            elsif (true == value.respond_to?(:call))
-              lambda_result = value.call(data[key])
-
-              if (true == lambda_result.is_a?(Hash))
-                result = result.merge(lambda_result)
-              else
-                raise "lambda must return hash"
-              end
-            else
-              result[value] = data[key]
-            end
-          end
-        else
-          raise "mapper must be a hash, got '#{mapper}'"
-        end
-
-        return result
-      end
     end
   end
 end

data/lib/redox/models/patient.rb

@@ -3,22 +3,38 @@ module Redox
     class Patient < Model
       attr_reader :demographics, :identifiers
 
-      KEY = 'Patient'
+      KEY = 'Patient'.freeze
 
       SEARCH = {
         meta: {
-          data_model: 'PatientSearch',
-          event_type: 'Query'
+          'DataModel' => 'PatientSearch',
+          'EventType' => 'Query'
         },
         endpoint: '/query'
       }
 
+      ADD = {
+        meta: {
+          'DataModel' => 'PatientAdmin',
+          'EventType' => 'NewPatient'
+        },
+        endpoint: '/endpoint'
+      }
+
+      UPDATE = {
+        meta: {
+          'DataModel' => 'PatientAdmin',
+          'EventType' => 'PatientUpdate'
+        },
+        endpoint: '/endpoint'
+      }
+
       def initialize(data)
         super(data)
 
         if (self.valid?)
-          @demographics = Demographics.new(self.raw)
-          @identifiers  = Identifiers.new(self.raw)
+          @demographics = Demographics.new(self.inner)
+          @identifiers  = Identifiers.new(self.inner)
         end
       end
     end

data/lib/redox/response.rb

@@ -0,0 +1,14 @@
+module Redox
+  class Response
+    attr_reader :model, :http_response
+
+    def initialize(response, model_class = nil)
+      @http_response = response
+      @model    = model_class.new(JSON.parse(response.body)) if !model_class.nil? && self.success?
+    end
+
+    def success?
+      return @http_response.is_a?(Net::HTTPOK)
+    end
+  end
+end

data/lib/redox/version.rb

@@ -1,3 +1,3 @@
 module Redox
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/redox.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'webmock', '~> 3.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redox
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Alexander Clark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-09 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -98,11 +112,14 @@ files:
 - bin/console
 - bin/setup
 - lib/redox.rb
+- lib/redox/authentication.rb
 - lib/redox/models/demographics.rb
 - lib/redox/models/identifiers.rb
+- lib/redox/models/meta.rb
 - lib/redox/models/model.rb
 - lib/redox/models/patient.rb
 - lib/redox/redox_exception.rb
+- lib/redox/response.rb
 - lib/redox/version.rb
 - redox.gemspec
 homepage: https://github.com/WeInfuse/redox