moesif_aws_lambda 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f59e608ff68965ce70ee78cab1118c2b3ef2061b7959a2381a8980e7dd4e87ec
+  data.tar.gz: 9fda726c38ce6024ed5037dbd9d57265c1a1bedfc18e51f9bac1765fd8a7a427
+SHA512:
+  metadata.gz: c47740859106ab0cecf1f92603237ce151118f0331db6471e6eb894a6c2c7f61b9eff32fafdd3454a2c85beb7b04e630482669d277325b0a5a34f2079c9f73a3
+  data.tar.gz: 01cee574368e225740b351c3410cd612b8c9cfecf0f28f2a97f7ac2674a60c3b389cf1b9d576d01a2806db8f40bdb92ae292918eea05a37ca647668057eba825

data/LICENSE

@@ -0,0 +1,216 @@
+Copyright (c) 2022 Moesif, Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2016 - 2017] Moesif Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,218 @@
+# Moesif AWS Lambda Middleware Ruby
+
+[![Built For][ico-built-for]][link-built-for]
+[![Software License][ico-license]][link-license]
+[![Source Code][ico-source]][link-source]
+
+Middleware (Ruby) to automatically log API calls from AWS Lambda functions and sends
+and sends to [Moesif](https://www.moesif.com) for API analytics.
+
+This middleware expects the
+[Lambda proxy integration type.](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html#api-gateway-set-up-lambda-proxy-integration-on-proxy-resource)
+If you're using AWS Lambda with API Gateway, you are most likely using the proxy integration type.
+
+
+## How to install
+
+```shell
+bundle install moesif_aws_lambda
+```
+
+## How to use
+
+### 1. Wrap your original lambda handler with Moesif Middleware
+
+
+```ruby
+
+def your_original_handler(event:, context:)
+   # your code
+end
+
+moesif_options = {
+  # application_id is required
+  "application_id" => 'Your Moesif Application Id',
+  "debug" => true,
+  # see list of other options below.
+}
+
+# create moesif_middleware object.
+$moesif_middleware = Moesif::MoesifAwsMiddleware.new(method(:your_original_handler), moesif_options)
+```
+
+
+### 2. create a wrapped handler and set AWS lambda to use this.
+
+
+```ruby
+def wrapped_handler(event:, context:)
+  $moesif_middleware.handle(event: event, context: context);
+end
+```
+
+configure AWS Lambda handler to `wrapped_handler` instead.
+
+
+## Configuration Options
+
+#### __`application_id`__
+
+Required. String. This is the Moesif application_id under settings
+from your [Moesif account.](https://www.moesif.com)
+
+
+#### __`api_version`__
+
+Optional. String. Tag requests with the version of your API.
+
+
+#### __`identify_user`__
+
+Optional.
+identify_user is a Proc that takes event, context, and lambda result as arguments and returns a user_id string. This helps us attribute requests to unique users. Even though Moesif can automatically retrieve the user_id without this, this is highly recommended to ensure accurate attribution.
+
+`event` and `context` are original lambda input params, and `result` is the return result from your own original lambda handler.
+
+```ruby
+moesif_options['identify_user'] = Proc.new { |event, context, result|
+
+  # Add your custom code that returns a string for user id
+  '12345'
+}
+
+```
+
+#### __`identify_company`__
+
+Optional.
+identify_company returns a company_id string. This helps us attribute requests to unique company.
+
+```ruby
+moesif_options['identify_company'] = Proc.new { |event, context, result|
+
+  # Add your custom code that returns a string for company id
+  '67890'
+}
+
+```
+
+#### __`identify_session`__
+
+Optional. A Proc that takes env, headers, body and returns a string.
+
+```ruby
+
+moesif_options['identify_session'] = Proc.new { |event, context, result|
+    # Add your custom code that returns a string for session/API token
+    'XXXXXXXXX'
+}
+```
+
+#### __`get_metadata`__
+
+Optional.
+get_metadata is a Proc that takes env, headers, and body as arguments and returns a Hash that is
+representation of a JSON object. This allows you to attach any
+metadata to this event.
+
+```ruby
+
+moesif_options['get_metadata'] = Proc.new { |event, context, result|
+  # Add your custom code that returns a dictionary
+  value = {
+      'datacenter'  => 'westus',
+      'deployment_version'  => 'v1.2.3'
+  }
+  value
+}
+```
+
+
+#### __`mask_data`__
+
+Optional. A Proc that takes event_model as an argument and returns event_model.
+
+With mask_data, you can make modifications to headers or body of the event before it is sent to Moesif.
+
+```ruby
+
+moesif_options['mask_data'] = Proc.new { |event_model|
+  # Add your custom code that returns a event_model after modifying any fields
+  event_model.response.body.password = nil
+  event_model
+}
+
+```
+
+For details for the spec of moesif event model, please see the [moesifapi-ruby](https://github.com/Moesif/moesifapi-ruby) or [Moesif Ruby API Documentation](https://www.moesif.com/docs/api?ruby)
+
+
+#### __`skip`__
+
+Optional. A Proc that takes env, headers, body and returns a boolean.
+
+```ruby
+
+moesif_options['skip'] = Proc.new { |event, context, result|
+  # Add your custom code that returns true to skip logging the API call
+  if event.key?("rawPath")
+      # Skip probes to health page
+    event["rawPath"].include? "/health"
+  else
+      false
+  end
+}
+
+```
+
+
+
+#### __`debug`__
+
+Optional. Boolean. Default false. If true, it will print out debug messages. In debug mode, the processing is not done in backend thread.
+
+#### __`log_body`__
+
+Optional. Boolean. Default true. If false, will not log request and response body to Moesif.
+
+
+## Additional Methods for Updating User and Company Profile
+
+If you wish to update User or Company profile when needed using this SDK, you can also use below methods:
+
+``` ruby
+$moesif_middleware.update_user(user_profile)
+$moesif_middleware.update_user_batch(user_profiles)
+$moesif_middleware.update_company(company_profile)
+$moesif_middleware.update_company_batch(company_profiles)
+```
+
+For details regarding shape of the profiles, please see the [Moesif Ruby API Documentation](https://www.moesif.com/docs/api?ruby)
+
+
+## Notes Regarding Bundling Your Gem Files
+
+For AWS lambda with ruby, you have to bundle the gem dependencies into the zip file.
+https://docs.aws.amazon.com/lambda/latest/dg/ruby-package.html
+
+In your ruby main file, you may have to specify where the dependencies are installed:
+
+```ruby
+load_paths = Dir[
+  "./vendor/bundle/ruby/2.7.0/gems/**/lib"
+]
+$LOAD_PATH.unshift(*load_paths)
+```
+
+## Example
+
+`example_handler.rb` is an example file that implement this.
+
+
+[ico-built-for]: https://img.shields.io/badge/built%20for-aws%20lambda-blue.svg
+[ico-license]: https://img.shields.io/badge/License-Apache%202.0-green.svg
+[ico-source]: https://img.shields.io/github/last-commit/moesif/moesif-aws-lambda-ruby.svg?style=social
+
+[link-built-for]: https://aws.amazon.com/lambda/
+[link-license]: https://raw.githubusercontent.com/Moesif/moesif-aws-lambda-ruby/master/LICENSE
+[link-source]: https://github.com/moesif/moesif-aws-lambda-ruby

data/lib/moesif_aws_lambda/lambda_utils.rb

@@ -0,0 +1,83 @@
+require "json"
+
+def build_uri(event, context, payload_format_version_1_0)
+  headers = event["headers"] || {};
+  protocol = headers.fetch("X-Forwarded-Proto", headers.fetch("x-forwarded-proto", "http")) + "://"
+  host = headers.fetch("Host", headers.fetch("host", "localhost"))
+
+  uri = protocol + host
+
+  if payload_format_version_1_0
+    uri = uri + event.fetch.get("path", "/")
+    if event.fetch("multiValueQueryStringParameters", {})
+      uri = uri + "?" + urlencode(event["multiValueQueryStringParameters"], doseq = True)
+    elsif event.fetch("queryStringParameters", {})
+      uri = uri + "?" + urlencode(event["queryStringParameters"])
+    end
+  else
+    uri = uri + event.fetch("rawPath", "/")
+    if event["rawQueryString"]
+      uri = uri + "?" + event["rawQueryString"]
+    end
+  end
+
+  uri
+end
+
+def get_request_verb(event, context, payload_format_version_1_0)
+  verb = event.dig("requestContext", "http", "method") || "GET"
+  if payload_format_version_1_0
+    verb = event.fetch("httpMethod", "GET")
+  end
+  verb
+end
+
+def get_request_headers(event, context, payload_format_version_1_0)
+  req_headers = event["headers"] || {}
+  if payload_format_version_1_0
+    if event.include? "multiValueHeaders"
+      req_headers = (event["multiValueHeaders"] || {}).transform_values do |value|
+        value.join("\n")
+      end
+    end
+  end
+  req_headers
+end
+
+def get_ip_address(event, context, payload_format_version_1_0)
+  ip_address = event.dig("requestContext", "http", "sourceIp")
+  if payload_format_version_1_0
+    ip_address = event.dig("requestContext", "identity", "sourceIp")
+  end
+  ip_address
+end
+
+def get_response_info_from_lambda_result(lambda_result)
+  if lambda_result.is_a?(Hash) and lambda_result.include?("statusCode")
+    raw_status = lambda_result["statusCode"]
+    status = raw_status.to_i
+    rsp_body = lambda_result["body"]
+    rsp_headers = lambda_result["headers"]
+    if lambda_result.includes?("multiValueHeaders")
+      multi_value_headers = (lambda_result["multiValueHeaders"] || {}).transform_values do |value|
+        value.join("\n")
+      end
+      rsp_headers = multi_value_headers.merge(lambda_result["headers"] || {})
+    end
+    rsp_body_transfer_encoding = lambda_result["isBase64Encoded"] ? "base64" : nil
+  else
+    # see here on how API gateway interpreate lambda_results when no status code.
+    # https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
+    status = 200
+    rsp_headers = { "content-type" => "application/json" }
+    begin
+      rsp_body = JSON.generate(lambda_result)
+      transfer_encoding = nil
+    rescue
+      rsp_body = nil
+      rsp_body_transfer_encoding = nil
+    end
+  end
+
+  [status, rsp_headers, rsp_body, rsp_body_transfer_encoding]
+end

data/lib/moesif_aws_lambda/moesif_aws_middleware.rb

@@ -0,0 +1,290 @@
+require "moesif_api"
+require "json"
+require "time"
+require "base64"
+require "zlib"
+require "stringio"
+
+require_relative "./update_user.rb"
+require_relative "./update_company.rb"
+require_relative "./moesif_helpers.rb"
+require_relative "./lambda_utils.rb"
+
+module Moesif
+  class MoesifAwsMiddleware
+    def initialize(handler, options = {})
+      @handler = handler
+      if not options["application_id"]
+        raise "application_id required for Moesif Middleware"
+      end
+      @api_client = MoesifApi::MoesifAPIClient.new(options["application_id"])
+      @api_controller = @api_client.api
+
+      @api_version = options["api_version"]
+      @identify_user = options["identify_user"]
+      @identify_company = options["identify_company"]
+      @get_metadata = options["get_metadata"]
+      @identify_session = options["identify_session"]
+      @mask_data = options["mask_data"]
+      @skip = options["skip"]
+      @debug = options["debug"]
+      @moesif_helpers = MoesifHelpers.new(@debug)
+      @disable_transaction_id = options["disable_transaction_id"] || false
+      @log_body = options.fetch("log_body", true)
+      @event_response_config_etag = nil
+    end
+
+    def update_user(user_profile)
+      UserHelper.new.update_user(@api_controller, @debug, user_profile)
+    end
+
+    def update_users_batch(user_profiles)
+      UserHelper.new.update_users_batch(@api_controller, @debug, user_profiles)
+    end
+
+    def update_company(company_profile)
+      CompanyHelper.new.update_company(@api_controller, @debug, company_profile)
+    end
+
+    def update_companies_batch(company_profiles)
+      CompanyHelper.new.update_companies_batch(@api_controller, @debug, company_profiles)
+    end
+
+    def start_with_json(body)
+      body.start_with?("{") || body.start_with?("[")
+    end
+
+    def decompress_body(body)
+      Zlib::GzipReader.new(StringIO.new(body)).read
+    end
+
+    def base64_encode_body(body)
+      return Base64.encode64(body), "base64"
+    end
+
+    def @moesif_helpers.log_debug(message)
+      if @debug
+        puts("#{Time.now.to_s} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
+      end
+    end
+
+    def parse_body(body, headers)
+      begin
+        if (body.instance_of?(Hash) || body.instance_of?(Array))
+          parsed_body = body
+          transfer_encoding = "json"
+        elsif start_with_json(body)
+          parsed_body = JSON.parse(body)
+          transfer_encoding = "json"
+        elsif headers.key?("content-encoding") && ((headers["content-encoding"].downcase).include? "gzip")
+          uncompressed_string = decompress_body(body)
+          parsed_body, transfer_encoding = base64_encode_body(uncompressed_string)
+        else
+          parsed_body, transfer_encoding = base64_encode_body(body)
+        end
+      rescue
+        parsed_body, transfer_encoding = base64_encode_body(body)
+      end
+      return parsed_body, transfer_encoding
+    end
+
+    def start_worker(event_model)
+      thr = Thread::new do
+        @moesif_helpers.log_debug("start worker")
+
+        begin
+            batch_events = [ event_model ]
+            @moesif_helpers.log_debug("Sending #{batch_events.size.to_s} events to Moesif")
+            event_api_response = @api_controller.create_events_batch(batch_events)
+            @event_response_config_etag = event_api_response[:x_moesif_config_etag]
+            @moesif_helpers.log_debug(event_api_response.to_s)
+            @moesif_helpers.log_debug("Events successfully sent to Moesif")
+        rescue MoesifApi::APIException => e
+          if e.response_code.between?(401, 403)
+            puts "Unathorized accesss sending event to Moesif. Please verify your Application Id."
+            @moesif_helpers.log_debug(e.to_s)
+          end
+          @moesif_helpers.log_debug("Error sending event to Moesif, with status code #{e.response_code.to_s} #{e.to_s}")
+        end
+
+      end
+
+      thr.join
+    end
+
+    def handle(event:, context:)
+      payload_format_version_1_0 = event["version"] == "1.0"
+
+      # Request Time
+      if payload_format_version_1_0
+        epoch = event.dig("requestContext", "requestTimeEpoch")
+      else
+        epoch = event.dig("requestContext", "timeEpoch")
+      end
+      if epoch.nil?
+        start_time = Time.now.utc.iso8601(3)
+      else
+        # divide by 1000 to preserve the milliseconds
+        start_time = Time.at(epoch / 1000.0).utc.iso8601(3)
+      end
+      # preserve request headers here in case it is changed down stream.
+      req_headers = get_request_headers(event, context, payload_format_version_1_0)
+
+      @moesif_helpers.log_debug("Calling Moesif middleware")
+
+      begin
+        lambda_result = @handler.call(event: event, context: context)
+      rescue Exception => customer_exception
+        execution_error = customer_exception
+      end
+
+      end_time = Time.now.utc.iso8601(3)
+
+      process_send = lambda do
+        # REQUEST
+        event_req = MoesifApi::EventRequestModel.new()
+
+        event_req.time = start_time
+        event_req.uri = build_uri(event, context, payload_format_version_1_0)
+        event_req.verb = get_request_verb(event, context, payload_format_version_1_0)
+
+        # extract below from lambda_result
+        if execution_error
+          # so we can still continue
+          @moesif_helpers.log_debug("an exception occured with original execution, so capture that.")
+          status = 500
+          rsp_body = { "message" => "Internal Server Error" }
+          rsp_headers = {}
+          rsp_body_transfer_encoding = nil
+        else
+          status, rsp_headers, rsp_body, rsp_body_transfer_encoding = get_response_info_from_lambda_result(lambda_result)
+        end
+
+        if @api_version
+          event_req.api_version = @api_version
+        end
+
+        # Add Transaction Id to the Request Header
+        if !@disable_transaction_id
+          req_trans_id = req_headers["X-MOESIF_TRANSACTION_ID"]
+          if !req_trans_id.nil?
+            transaction_id = req_trans_id
+            if transaction_id.strip.empty?
+              transaction_id = SecureRandom.uuid
+            end
+          else
+            transaction_id = SecureRandom.uuid
+          end
+          # Add Transaction Id to Request Header
+          req_headers["X-Moesif-Transaction-Id"] = transaction_id
+          # Filter out the old key as HTTP Headers case are not preserved
+          if req_headers.key?("X-MOESIF_TRANSACTION_ID")
+            req_headers = req_headers.except("X-MOESIF_TRANSACTION_ID")
+          end
+        end
+
+        event_req.ip_address = get_ip_address(event, context, payload_format_version_1_0)
+        event_req.headers = req_headers
+
+        if @log_body
+          event_req.body = event["body"]
+          event_req.transfer_encoding = event["isBase64Encoded"] ? "base64" : "json"
+        end
+
+        # RESPONSEE
+        event_rsp = MoesifApi::EventResponseModel.new()
+        event_rsp.time = end_time
+
+        # Add Transaction Id to the Response Header
+        if !transaction_id.nil?
+          rsp_headers["X-Moesif-Transaction-Id"] = transaction_id
+        end
+
+        event_rsp.status = status
+        event_rsp.headers = rsp_headers
+
+        if @log_body
+          event_rsp.body = rsp_body
+          event_rsp.transfer_encoding = rsp_body_transfer_encoding
+        end
+
+        event_model = MoesifApi::EventModel.new()
+        event_model.request = event_req
+        event_model.response = event_rsp
+        event_model.direction = "Incoming"
+
+        if @identify_user
+          @moesif_helpers.log_debug "calling identify user proc"
+          event_model.user_id = @identify_user.call(event, context, lambda_result)
+        end
+
+        if @identify_company
+          @moesif_helpers.log_debug "calling identify company proc"
+          event_model.company_id = @identify_company.call(event, context, lambda_result)
+        end
+
+        if @get_metadata
+          @moesif_helpers.log_debug "calling get_metadata proc"
+          event_model.metadata = @get_metadata.call(event, context, lambda_result)
+        else
+          @moesif_helpers.log_debug "create default metadata"
+          ## get default metadata from context object?
+          contextHash = {}
+          context.instance_variables.each {|var| contextHash[var.to_s.delete("@")] = context.instance_variable_get(var) }
+          event_model.metadata = {
+            "trace_id" => context.aws_request_id.to_s,
+            "function_name" => context.function_name,
+            "request_context" => event["requestContext"],
+            "context" => contextHash
+          }
+          @moesif_helpers.log_debug JSON.generate(event_model.metadata)
+        end
+
+        if @identify_session
+          @moesif_helpers.log_debug "calling identify session proc"
+          event_model.session_token = @identify_session.call(event, context, lambda_result)
+        end
+        if @mask_data
+          @moesif_helpers.log_debug "calling mask_data proc"
+          event_model = @mask_data.call(event_model)
+        end
+
+        @moesif_helpers.log_debug "sending data to moesif"
+        @moesif_helpers.log_debug event_model.to_json
+
+        # send event directly
+        start_worker(event_model)
+      end # end process_send
+
+      should_skip = false
+
+      if @skip
+        if @skip.call(event, context, lambda_result)
+          should_skip = true
+        end
+      end
+
+      if !should_skip
+        begin
+          process_send.call
+        rescue => exception
+          @moesif_helpers.log_debug "Error while logging event - "
+          @moesif_helpers.log_debug exception.to_s
+          @moesif_helpers.log_debug exception.backtrace
+        end
+      else
+        @moesif_helpers.log_debug "Skipped Event using should_skip configuration option."
+      end
+
+      # return original result
+      # or raise original exception
+      if execution_error
+        @moesif_helpers.log_debug "raise original exception that happened."
+        raise execution_error
+      else
+        @moesif_helpers.log_debug "return original lambda result."
+        lambda_result
+      end
+    end
+  end
+end

data/lib/moesif_aws_lambda/moesif_helpers.rb

@@ -0,0 +1,14 @@
+require 'time'
+
+class MoesifHelpers
+
+    def initialize debug
+        @debug = debug
+    end
+
+    def log_debug(message)
+        if @debug
+            puts("#{Time.now.to_s} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
+        end
+    end
+end

data/lib/moesif_aws_lambda/update_company.rb

@@ -0,0 +1,56 @@
+class CompanyHelper
+    def update_company(api_controller, debug, company_profile)
+        if company_profile.any?
+            if company_profile.key?("company_id")
+                begin
+                api_controller.update_company(MoesifApi::CompanyModel.from_hash(company_profile))
+                if debug
+                    puts "Update Company Successfully"
+                end
+                rescue MoesifApi::APIException => e
+                if e.response_code.between?(401, 403)
+                    puts "Unathorized accesss updating company to Moesif. Please verify your Application Id."
+                end
+                if debug
+                    puts "Error updating company to Moesif, with status code: "
+                    puts e.response_code
+                end
+                end
+            else 
+                puts "To update a company, a company_id field is required"
+            end
+            else 
+            puts "Expecting the input to be of the type - dictionary while updating user"
+        end
+    end
+
+    def update_companies_batch(api_controller, debug, company_profiles)
+        companyModels = []
+        company_profiles.each { |company| 
+        if company.key?("company_id")
+            companyModels << MoesifApi::CompanyModel.from_hash(company)
+        else 
+            puts "To update a company, a company_id field is required"
+        end
+        }
+
+        if companyModels.any?
+            begin
+                api_controller.update_companies_batch(companyModels)
+                if debug
+                puts "Update Companies Successfully"
+                end
+            rescue MoesifApi::APIException => e
+                if e.response_code.between?(401, 403)
+                puts "Unathorized accesss updating companies to Moesif. Please verify your Application Id."
+                end
+                if debug
+                puts "Error updating companies to Moesif, with status code: "
+                puts e.response_code
+                end
+            end
+        else
+        puts "Expecting the input to be of the type - Array of hashes while updating companies in batch"
+        end
+    end
+end

data/lib/moesif_aws_lambda/update_user.rb

@@ -0,0 +1,56 @@
+class UserHelper
+    def update_user(api_controller, debug, user_profile)
+        if user_profile.any?
+            if user_profile.key?("user_id")
+            begin
+                api_controller.update_user(MoesifApi::UserModel.from_hash(user_profile))
+                if debug
+                puts "Update User Successfully"
+                end
+            rescue MoesifApi::APIException => e
+                if e.response_code.between?(401, 403)
+                puts "Unathorized accesss updating user to Moesif. Please verify your Application Id."
+                end
+                if debug
+                puts "Error updating user to Moesif, with status code: "
+                puts e.response_code
+                end
+            end
+            else 
+            puts "To update an user, an user_id field is required"
+            end
+        else 
+            puts "Expecting the input to be of the type - dictionary while updating user"
+        end
+    end
+
+    def update_users_batch(api_controller, debug, user_profiles)
+        userModels = []
+        user_profiles.each { |user| 
+        if user.key?("user_id")
+            userModels << MoesifApi::UserModel.from_hash(user)
+        else 
+            puts "To update an user, an user_id field is required"
+        end
+        }
+
+        if userModels.any?
+            begin
+            api_controller.update_users_batch(userModels)
+            if debug
+                puts "Update Users Successfully"
+            end
+            rescue MoesifApi::APIException => e
+            if e.response_code.between?(401, 403)
+                puts "Unathorized accesss updating user to Moesif. Please verify your Application Id."
+            end
+            if debug
+                puts "Error updating user to Moesif, with status code: "
+                puts e.response_code
+            end
+            end
+        else
+            puts "Expecting the input to be of the type - Array of hashes while updating users in batch"
+        end
+    end
+end

data/lib/moesif_aws_lambda.rb

@@ -0,0 +1,2 @@
+
+require_relative 'moesif_aws_lambda/moesif_aws_middleware.rb'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: moesif_aws_lambda
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Moesif, Inc
+- Xing Wang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: moesif_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.14
+description: Moesif aws lambda middleware for Ruby to log API calls to Moesif API
+  analytics and monitoring
+email: xing@moesif.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/moesif_aws_lambda.rb
+- lib/moesif_aws_lambda/lambda_utils.rb
+- lib/moesif_aws_lambda/moesif_aws_middleware.rb
+- lib/moesif_aws_lambda/moesif_helpers.rb
+- lib/moesif_aws_lambda/update_company.rb
+- lib/moesif_aws_lambda/update_user.rb
+homepage: https://moesif.com
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/Moesif/moesif-aws-lambda-ruby/issues
+  changelog_uri: https://github.com/Moesif/moesif-aws-lambda-ruby/releases
+  documentation_uri: https://github.com/Moesif/moesif-aws-lambda-ruby
+  homepage_uri: https://www.moesif.com
+  mailing_list_uri: https://github.com/Moesif/moesif-aws-lambda-ruby
+  source_code_uri: https://github.com/Moesif/moesif-aws-lambda-ruby
+  wiki_uri: https://github.com/Moesif/moesif-aws-lambda-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: moesif_aws_lambda
+test_files: []