MHV Activity Logging Client

.rubocop.yml

@@ -78,3 +78,4 @@ Style/AccessorMethodName:
   Exclude:
     - 'lib/rx/**/*'
     - 'lib/sm/**/*'
+    - 'lib/mhv_logging/**/*'

config/initializers/breakers.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'breakers/statsd_plugin'
+require 'mhv_logging/configuration'
 require 'rx/configuration'
 require 'sm/configuration'
 
@@ -14,7 +15,8 @@
 
 services = [
   Rx::Configuration.instance.breakers_service,
-  SM::Configuration.instance.breakers_service
+  SM::Configuration.instance.breakers_service,
+  MHVLogging::Configuration.instance.breakers_service
   # TODO: (AJM) Disabled for testing, add these back in for launch
   # EVSS::ClaimsService.breakers_service,
   # EVSS::CommonService.breakers_service,

lib/mhv_logging/api/audits.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module MHVLogging
+  module API
+    # This module defines the prescription actions
+    module Audits
+      def auditlogin
+        body = { isSuccessful: true, activityDetails: 'Signed in Vets.gov' }
+        perform(:post, 'activity/auditlogin', body, token_headers)
+      end
+
+      def auditlogout
+        body = { isSuccessful: true, activityDetails: 'Signed out Vets.gov' }
+        perform(:post, 'activity/auditlogout', body, token_headers)
+      end
+    end
+  end
+end

lib/mhv_logging/api/sessions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module MHVLogging
+  module API
+    # This module defines the session actions
+    module Sessions
+      def get_session
+        env = perform(:get, 'session', nil, auth_headers)
+        req_headers = env.request_headers
+        res_headers = env.response_headers
+        # This session store inherits from Rx, therefore it is the same redis_store
+        MHVLogging::ClientSession.new(user_id: req_headers['mhvCorrelationId'],
+                                      expires_at: res_headers['expires'],
+                                      token: res_headers['token'])
+      end
+    end
+  end
+end

lib/mhv_logging/client.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'common/client/errors'
+require 'common/client/middleware/response/json_parser'
+require 'common/client/middleware/response/raise_error'
+require 'common/client/middleware/response/snakecase'
+require 'mhv_logging/configuration'
+require 'mhv_logging/client_session'
+require 'mhv_logging/api/audits'
+require 'mhv_logging/api/sessions'
+
+module MHVLogging
+  # Core class responsible for api interface operations
+  class Client
+    include MHVLogging::API::Audits
+    include MHVLogging::API::Sessions
+
+    REQUEST_TYPES = %i(get post).freeze
+    USER_AGENT = 'Vets.gov Agent'
+    BASE_REQUEST_HEADERS = {
+      'Accept' => 'application/json',
+      'Content-Type' => 'application/json',
+      'User-Agent' => USER_AGENT
+    }.freeze
+
+    attr_reader :config, :session
+
+    def initialize(session:)
+      @config = MHVLogging::Configuration.instance
+      @session = MHVLogging::ClientSession.find_or_build(session)
+    end
+
+    # Note this uses the same session store as Rx
+    def authenticate
+      if @session.expired?
+        @session = get_session
+        @session.save
+      end
+      self
+    end
+
+    private
+
+    def perform(method, path, params, headers = nil)
+      raise NoMethodError, "#{method} not implemented" unless REQUEST_TYPES.include?(method)
+
+      send(method, path, params || {}, headers)
+    end
+
+    def request(method, path, params = {}, headers = {})
+      raise_not_authenticated if headers.keys.include?('Token') && headers['Token'].nil?
+      connection.send(method.to_sym, path, params) { |request| request.headers.update(headers) }.env
+    rescue Faraday::Error::TimeoutError, Timeout::Error => error
+      raise Common::Client::Errors::RequestTimeout, error
+    rescue Faraday::Error::ClientError => error
+      raise Common::Client::Errors::Client, error
+    end
+
+    def get(path, params, headers = base_headers)
+      request(:get, path, params, headers)
+    end
+
+    def post(path, params, headers = base_headers)
+      request(:post, path, params, headers)
+    end
+
+    def raise_not_authenticated
+      raise Common::Client::Errors::NotAuthenticated, 'Not Authenticated'
+    end
+
+    def connection
+      @connection ||= Faraday.new(config.base_path, headers: BASE_REQUEST_HEADERS, request: request_options) do |conn|
+        conn.use :breakers
+        conn.request :json
+        # Uncomment this out for generating curl output to send to MHV dev and test only
+        # conn.request :curl, ::Logger.new(STDOUT), :warn
+
+        # conn.response :logger, ::Logger.new(STDOUT), bodies: true
+        conn.response :snakecase
+        conn.response :raise_error
+        conn.response :json_parser
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def auth_headers
+      BASE_REQUEST_HEADERS.merge('appToken' => config.app_token, 'mhvCorrelationId' => @session.user_id.to_s)
+    end
+
+    def token_headers
+      BASE_REQUEST_HEADERS.merge('Token' => @session.token)
+    end
+
+    def request_options
+      {
+        open_timeout: config.open_timeout,
+        timeout: config.read_timeout
+      }
+    end
+  end
+end

lib/mhv_logging/client_session.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'common/client/session'
+module MHVLogging
+  # Session Model -- EXACT SAME AS Rx
+  class ClientSession < Common::Client::Session
+    redis_store REDIS_CONFIG['rx_store']['namespace']
+    redis_ttl 900
+    redis_key :user_id
+  end
+end

lib/mhv_logging/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require 'rx/configuration'
+module MHVLogging
+  # Configuration class used to setup the environment used by client
+  class Configuration < Rx::Configuration
+  end
+end

spec/lib/mhv_logging/api/audits_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+require 'rails_helper'
+require 'mhv_logging/client'
+
+describe 'mhv logging client' do
+  describe 'audits' do
+    before(:all) do
+      VCR.use_cassette 'mhv_logging_client/session', record: :new_episodes do
+        @client ||= begin
+          client = MHVLogging::Client.new(session: { user_id: ENV['MHV_USER_ID'] })
+          client.authenticate
+          client
+        end
+      end
+    end
+
+    let(:client) { @client }
+
+    it 'submits an audit log for signing in', :vcr do
+      client_response = client.auditlogin
+      expect(client_response.status).to eq(200)
+      expect(client_response.body).to eq(status: 'success')
+    end
+
+    it 'submits an audit log for signing out', :vcr do
+      client_response = client.auditlogout
+      expect(client_response.status).to eq(200)
+      expect(client_response.body).to eq(status: 'success')
+    end
+  end
+end