firetail-rails 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce1eb2ebda2bffb7959cd23fe33e226a32cd39b103e74d09489d04f953f6992a
+  data.tar.gz: 3da8f3bbfbd4b3e838017c042c8bce17e4069e28f6510149ff354b6eb3fe1610
+SHA512:
+  metadata.gz: 22f935be0e43e9e93d2d3ad81fad2c08445773e9d74674d813062407802c05727aab7aac4a407f8c29ad0e61a7d710e0d4d8c3d726196a67c9cb0ae38bacb9cc
+  data.tar.gz: 48281d84583cb5948aac646bd084d1ad7ce7ceac2fa50f4b3bb268be0d5efbd05270175d0501396ed8da2d70f5af9e886c1df2799e5513410c2aa060acfe5729

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at muhammad@taqisystems.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in firetail.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,43 @@
+# Firetail
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/firetail`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'firetail'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install firetail
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/firetail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Firetail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/firetail/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "firetail"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/firetail-rails.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "firetail-rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "firetail-rails"
+  spec.version       = Firetail::VERSION
+  spec.authors       = ["Muhammad Nuzaihan"]
+  spec.email         = ["zaihan@flitnetics.com"]
+
+  spec.summary       = %q{Ruby On Rails library for firetail}
+  spec.description   = %q{API security library that is designed for ruby}
+  spec.homepage      = "https://www.firetail.io"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/firetail-io/ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/firetail-io/ruby/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  # These gems are needed for firetail in production
+  spec.add_dependency "async", "~> 1.30.3"
+end

data/lib/case_sensitive_headers.rb

@@ -0,0 +1,29 @@
+class CustomPost < Net::HTTP::Post
+    def initialize_http_header(headers)
+      @header = {}
+      headers.each { |k, v| @header[k.to_s] = [v] }
+    end
+
+    def [](name)
+      _k, val = header_insensitive_match name
+      val
+    end
+
+    def []=(name, val)
+      key, _val = header_insensitive_match name
+      key = name if key.nil?
+      if val
+        @header[key] = [val]
+      else
+        @header.delete(key)
+      end
+    end
+
+    def capitalize(name)
+      name
+    end
+
+    def header_insensitive_match(name)
+      @header.find { |key, _value| key.match Regexp.new(name.to_s, Regexp::IGNORECASE) }
+    end
+end

data/lib/firetail-rails/version.rb

@@ -0,0 +1,3 @@
+module Firetail
+  VERSION = "0.0.0"
+end

data/lib/firetail-rails.rb

@@ -0,0 +1,212 @@
+require "firetail/version"
+require "rack"
+require 'objspace'
+require 'yaml'
+require 'json'
+require 'net/http'
+require 'case_sensitive_headers' # a hack because firetail API headers is case-sensitive
+require "async"
+
+module Firetail
+  class Error < StandardError; end
+
+  class Run
+    MAX_BULK_SIZE_IN_BYTES = 1 * 1024 * 1024  # 1 MB
+
+    def initialize app
+      @app = app
+      @reqres ||= [] # request data in stored in array memory
+      @init_time ||= Time.now # initialize time
+    end
+ 
+    def call(env)
+      # This block initialises the configuration and checks
+      # sets the values for certain necessary configuration
+      # If it is Rails
+      if defined?(Rails)
+        begin
+          default_location = File.join(Rails.root, "config/firetail.yml")
+          config = YAML.load_file(default_location)
+        rescue Errno::ENOENT
+          # error message if firetail is not installed
+          puts ""
+          puts "Please run 'rails generate firetail:install' first"
+          puts ""
+        end
+      else # other frameworks
+        config = YAML.load_file("firetail.yml")
+      end
+
+      raise Error.new "Please run 'rails generate firetail:install' first" if config.nil?
+      raise Error.new "Token is missing from firetail.yml configuration" if config['token'].nil?
+      raise Error.new "API Key is missing from firetail.yml configuration"  if config['api_key'].nil?
+
+      @token              = config['token']
+      @api_key            = config['api_key']
+      @url                = config['url'] ? config['url'] : "https://ingest.eu-west-1.dev.firetail.app/ingest/request" # default goes to dev
+      @log_drains_timeout = config['log_drains_timeout'] ? config['log_drains_timeout'] : 5
+      @network_timeout    = config['network_timeout'] ? config['network_timeout'] : 10
+      @number_of_retries  = config['number_of_retries'] ? config['number_of_retries'] : 4
+      @retry_timeout      = config['retry_timeout'] ? config['retry_timeout'] : 2
+      # End of configuration initialization
+
+      # Gets the rack middleware requests
+      request = Rack::Request.new(env)
+      started_on = Time.now
+      begin
+        status, res_headers, body = response = @app.call(env)
+        log(env, response, status, res_headers, body, started_on, Time.now)
+      rescue Exception => exception
+        log(env, response, status, res_headers, body, started_on, Time.now, exception)
+        raise exception
+      end
+
+      response
+    end
+
+    def log(env,
+            response,
+            status,
+            res_headers,
+            body,
+            started_on,
+            ended_on,
+            exception = nil)
+
+      # request values
+      req_url               = env['REQUEST_URI']
+      req_path              = env['PATH_INFO']
+      time_spent            = ended_on - started_on
+      req_user_agent        = env['HTTP_USER_AGENT']
+      req_ip                = defined?(Rails) ? env['action_dispatch.remote_ip'].calculate_ip : env['REMOTE_ADDR']
+      req_method            = env['REQUEST_METHOD']
+      req_http_host         = env['HTTP_HOST']
+      req_http_version      = env['HTTP_VERSION']
+      req_http_encoding     = env['HTTP_ACCEPT_ENCODING']
+      req_http_accept       = env['HTTP_ACCEPT']
+      req_query_string      = env['QUERY_STRING']
+      req_path              = env['REQUEST_PATH']
+      req_uri               = env['REQUEST_URI']
+      req_server_software   = env['SERVER_SOFTWARE']
+      req_server_port       = env['SERVER_PORT']
+      req_gateway_interface = env['GATEWAY_INTERFACE']
+      req_http_connection   = env['HTTP_CONNECTION']
+
+      # get the request "HTTP_" headers
+      req_headers = env.select {|k,v| k.start_with? 'HTTP_'}
+       .collect {|key, val| [key.sub(/^HTTP_/, ''), val]}
+       .collect {|key, val| "#{key}: #{val}<br>"}
+       .sort
+
+      # add the request and response data 
+      # to array of data for batching up
+      @reqres.push({
+	version: "1.1",
+	dateCreated: Time.now.utc.to_i,
+	execution_time: time_spent,
+	#dateCreated: 1663763942581,
+	#execution_time: 3.74,
+	req: {
+ 	  httpProtocol: req_http_version,
+	  headers: req_headers.to_s,
+	  path: req_path,
+	  method: req_method,
+          oPath: req_path,
+	  fPath: req_path,
+	  args: req_query_string,
+	  ip: req_ip,
+	  pathParams: req_path,
+	  user_agent: req_user_agent # maybe need this?
+	},
+	resp: {
+          status_code: status,
+	  content_len: res_headers['Content-Length'],
+	  content_enc: res_headers['Content-Encoding'],
+	  body: body ? body.body : body[0],
+          headers: res_headers.to_s,
+	  content_type: res_headers['Content-Type'], 
+	  error_type: exception&.class&.name, # maybe need this? 
+          error_message: exception&.message # maybe need this? can be removed
+	}
+      })
+
+      # the time we calculate if request that is
+      # buffered max is 120 seconds
+      current_time = Time.now
+      # duration in millseconds
+      duration = (current_time - @init_time) * 1000.0
+
+      #Firetail.logger.debug "size in bytes #{ObjectSpace.memsize_of(@request_data.to_s)}"
+      #request data size in bytes
+      #request_data_size = ObjectSpace.memsize_of(@request_data.to_s)
+      # It is difficult to calculate the object size in bytes, 
+      # seems to not return the accurate values
+
+      # This will send the data we need in batches of 5 requests or when it is more than 120 seconds
+      # if there are more than 5 requests or is more than
+      # 2 minutes, then send to backend - this is for testing
+      if @reqres.length >= 5 || duration > 120
+        #Firetail.logger.debug "request data #{@request_data.length}"
+	payload = "" # begin of data will have a newline
+	@reqres.each do |data|
+          # append string in-place
+ 	  json = data.to_json
+	  payload = json + "\n"
+        end
+
+	#puts "Our data: #{payload}"
+	# send the data to backend API
+	# This is an async task
+	Async do |task|
+          task.async do
+            send_to_backend(payload)
+          end
+	end
+
+	# reset back tohe conditions
+	payload = nil
+	@reqres = []
+	@init_time = Time.now
+      end
+    rescue Exception => exception
+      Firetail.logger.error(exception.message)
+    end
+
+    def send_to_backend(payload)
+      #Firetail.logger.debug datas.to_json
+      # Parse it as URI
+      uri = URI(@url)
+
+      # Send the request
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      #http.set_debug_output($stdout)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+      # Create a new request
+      req = CustomPost.new(uri.path,
+      {
+        'Content-Type': 'text/plain',
+        'x-api-key': @api_key,
+        'X-FT-API-KEY': @token
+      })
+
+      # debug code
+      #req.body = "{\"version\": \"1.1\", \"dateCreated\": 1663763942581, \"execution_time\": 3.74, \"req\": {}, \"resp\": {}}"
+      #req.body = '{"version": "1.1", "dateCreated": 1663763942581, "execution_time": 3.74, "req": {}, "resp": {}}\n{"version": "1.1", "dateCreated": 1663763942581, "execution_time": 3.74, "req": {}, "resp": {}}'
+      req.body = payload
+
+      res = http.request(req)
+      
+      Firetail.logger.debug "response from firetail: #{res}"
+    end
+  end
+
+  def self.logger
+    @@logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @@logger = logger
+  end
+end

data/lib/generators/firetail/install/templates/README

@@ -0,0 +1,12 @@
+====================================================================================
+
+Thank you for installing Firetail!
+
+Before you start using firetail, please edit the file in "config/firetail.yml"
+with your API Key, Token and URL first before running your Rails app.
+
+The middleware is already configured in "config/application.rb" (you can check that)
+
+Happy coding!
+
+- From the team at Firetail

data/lib/generators/firetail/install/templates/firetail.yml

@@ -0,0 +1,3 @@
+api_key: yourfiretailapikey
+token: yourfiretailtoken
+url: https://ingest.eu-west-1.dev.firetail.app/ingest/request

data/lib/generators/firetail/install_generator.rb

@@ -0,0 +1,22 @@
+module Firetail
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../install/templates", __FILE__)
+
+      desc "create firetail configuration template to config/firetail.yml and add middleware"
+      def add_firetail_configuration
+        template "firetail.yml", File.join("config", "firetail.yml")
+        application "config.middleware.use Firetail::Run"
+      end
+
+      desc "add firetail middleware to rails application.rb"
+      def add_firetail_middleware
+        application "config.middleware.use Firetail::Run"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: firetail-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Muhammad Nuzaihan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.3
+description: API security library that is designed for ruby
+email:
+- zaihan@flitnetics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- firetail-rails.gemspec
+- lib/case_sensitive_headers.rb
+- lib/firetail-rails.rb
+- lib/firetail-rails/version.rb
+- lib/generators/firetail/install/templates/README
+- lib/generators/firetail/install/templates/firetail.yml
+- lib/generators/firetail/install_generator.rb
+homepage: https://www.firetail.io
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.firetail.io
+  source_code_uri: https://github.com/firetail-io/ruby
+  changelog_uri: https://github.com/firetail-io/ruby/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Ruby On Rails library for firetail
+test_files: []