firetail 0.0.0 → 1.0.1

data/examples/rails/spec/requests/comments_spec.rb

@@ -0,0 +1,127 @@
+require 'rails_helper'
+
+# This spec was generated by rspec-rails when you ran the scaffold generator.
+# It demonstrates how one might use RSpec to test the controller code that
+# was generated by Rails when you ran the scaffold generator.
+#
+# It assumes that the implementation code is generated by the rails scaffold
+# generator. If you are using any extension libraries to generate different
+# controller code, this generated spec may or may not pass.
+#
+# It only uses APIs available in rails and/or rspec-rails. There are a number
+# of tools you can use to make these specs even more expressive, but we're
+# sticking to rails and rspec-rails APIs to keep things simple and stable.
+
+RSpec.describe "/comments", type: :request do
+  # This should return the minimal set of attributes required to create a valid
+  # Comment. As you add validations to Comment, be sure to
+  # adjust the attributes here as well.
+  let(:valid_attributes) {
+    skip("Add a hash of attributes valid for your model")
+  }
+
+  let(:invalid_attributes) {
+    skip("Add a hash of attributes invalid for your model")
+  }
+
+  # This should return the minimal set of values that should be in the headers
+  # in order to pass any filters (e.g. authentication) defined in
+  # CommentsController, or in your router and rack
+  # middleware. Be sure to keep this updated too.
+  let(:valid_headers) {
+    {}
+  }
+
+  describe "GET /index" do
+    it "renders a successful response" do
+      Comment.create! valid_attributes
+      get comments_url, headers: valid_headers, as: :json
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET /show" do
+    it "renders a successful response" do
+      comment = Comment.create! valid_attributes
+      get comment_url(comment), as: :json
+      expect(response).to be_successful
+    end
+  end
+
+  describe "POST /create" do
+    context "with valid parameters" do
+      it "creates a new Comment" do
+        expect {
+          post comments_url,
+               params: { comment: valid_attributes }, headers: valid_headers, as: :json
+        }.to change(Comment, :count).by(1)
+      end
+
+      it "renders a JSON response with the new comment" do
+        post comments_url,
+             params: { comment: valid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:created)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "does not create a new Comment" do
+        expect {
+          post comments_url,
+               params: { comment: invalid_attributes }, as: :json
+        }.to change(Comment, :count).by(0)
+      end
+
+      it "renders a JSON response with errors for the new comment" do
+        post comments_url,
+             params: { comment: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+  end
+
+  describe "PATCH /update" do
+    context "with valid parameters" do
+      let(:new_attributes) {
+        skip("Add a hash of attributes valid for your model")
+      }
+
+      it "updates the requested comment" do
+        comment = Comment.create! valid_attributes
+        patch comment_url(comment),
+              params: { comment: new_attributes }, headers: valid_headers, as: :json
+        comment.reload
+        skip("Add assertions for updated state")
+      end
+
+      it "renders a JSON response with the comment" do
+        comment = Comment.create! valid_attributes
+        patch comment_url(comment),
+              params: { comment: new_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:ok)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "renders a JSON response with errors for the comment" do
+        comment = Comment.create! valid_attributes
+        patch comment_url(comment),
+              params: { comment: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+  end
+
+  describe "DELETE /destroy" do
+    it "destroys the requested comment" do
+      comment = Comment.create! valid_attributes
+      expect {
+        delete comment_url(comment), headers: valid_headers, as: :json
+      }.to change(Comment, :count).by(-1)
+    end
+  end
+end

data/examples/rails/spec/requests/posts_spec.rb

@@ -0,0 +1,127 @@
+require 'rails_helper'
+
+# This spec was generated by rspec-rails when you ran the scaffold generator.
+# It demonstrates how one might use RSpec to test the controller code that
+# was generated by Rails when you ran the scaffold generator.
+#
+# It assumes that the implementation code is generated by the rails scaffold
+# generator. If you are using any extension libraries to generate different
+# controller code, this generated spec may or may not pass.
+#
+# It only uses APIs available in rails and/or rspec-rails. There are a number
+# of tools you can use to make these specs even more expressive, but we're
+# sticking to rails and rspec-rails APIs to keep things simple and stable.
+
+RSpec.describe "/posts", type: :request do
+  # This should return the minimal set of attributes required to create a valid
+  # Post. As you add validations to Post, be sure to
+  # adjust the attributes here as well.
+  let(:valid_attributes) {
+    skip("Add a hash of attributes valid for your model")
+  }
+
+  let(:invalid_attributes) {
+    skip("Add a hash of attributes invalid for your model")
+  }
+
+  # This should return the minimal set of values that should be in the headers
+  # in order to pass any filters (e.g. authentication) defined in
+  # PostsController, or in your router and rack
+  # middleware. Be sure to keep this updated too.
+  let(:valid_headers) {
+    {}
+  }
+
+  describe "GET /index" do
+    it "renders a successful response" do
+      Post.create! valid_attributes
+      get posts_url, headers: valid_headers, as: :json
+      expect(response).to be_successful
+    end
+  end
+
+  describe "GET /show" do
+    it "renders a successful response" do
+      post = Post.create! valid_attributes
+      get post_url(post), as: :json
+      expect(response).to be_successful
+    end
+  end
+
+  describe "POST /create" do
+    context "with valid parameters" do
+      it "creates a new Post" do
+        expect {
+          post posts_url,
+               params: { post: valid_attributes }, headers: valid_headers, as: :json
+        }.to change(Post, :count).by(1)
+      end
+
+      it "renders a JSON response with the new post" do
+        post posts_url,
+             params: { post: valid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:created)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "does not create a new Post" do
+        expect {
+          post posts_url,
+               params: { post: invalid_attributes }, as: :json
+        }.to change(Post, :count).by(0)
+      end
+
+      it "renders a JSON response with errors for the new post" do
+        post posts_url,
+             params: { post: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+  end
+
+  describe "PATCH /update" do
+    context "with valid parameters" do
+      let(:new_attributes) {
+        skip("Add a hash of attributes valid for your model")
+      }
+
+      it "updates the requested post" do
+        post = Post.create! valid_attributes
+        patch post_url(post),
+              params: { post: new_attributes }, headers: valid_headers, as: :json
+        post.reload
+        skip("Add assertions for updated state")
+      end
+
+      it "renders a JSON response with the post" do
+        post = Post.create! valid_attributes
+        patch post_url(post),
+              params: { post: new_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:ok)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+
+    context "with invalid parameters" do
+      it "renders a JSON response with errors for the post" do
+        post = Post.create! valid_attributes
+        patch post_url(post),
+              params: { post: invalid_attributes }, headers: valid_headers, as: :json
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.content_type).to match(a_string_including("application/json"))
+      end
+    end
+  end
+
+  describe "DELETE /destroy" do
+    it "destroys the requested post" do
+      post = Post.create! valid_attributes
+      expect {
+        delete post_url(post), headers: valid_headers, as: :json
+      }.to change(Post, :count).by(-1)
+    end
+  end
+end

data/examples/rails/spec/routing/comments_routing_spec.rb

@@ -0,0 +1,30 @@
+require "rails_helper"
+
+RSpec.describe CommentsController, type: :routing do
+  describe "routing" do
+    it "routes to #index" do
+      expect(get: "/comments").to route_to("comments#index")
+    end
+
+    it "routes to #show" do
+      expect(get: "/comments/1").to route_to("comments#show", id: "1")
+    end
+
+
+    it "routes to #create" do
+      expect(post: "/comments").to route_to("comments#create")
+    end
+
+    it "routes to #update via PUT" do
+      expect(put: "/comments/1").to route_to("comments#update", id: "1")
+    end
+
+    it "routes to #update via PATCH" do
+      expect(patch: "/comments/1").to route_to("comments#update", id: "1")
+    end
+
+    it "routes to #destroy" do
+      expect(delete: "/comments/1").to route_to("comments#destroy", id: "1")
+    end
+  end
+end

data/examples/rails/spec/routing/posts_routing_spec.rb

@@ -0,0 +1,30 @@
+require "rails_helper"
+
+RSpec.describe PostsController, type: :routing do
+  describe "routing" do
+    it "routes to #index" do
+      expect(get: "/posts").to route_to("posts#index")
+    end
+
+    it "routes to #show" do
+      expect(get: "/posts/1").to route_to("posts#show", id: "1")
+    end
+
+
+    it "routes to #create" do
+      expect(post: "/posts").to route_to("posts#create")
+    end
+
+    it "routes to #update via PUT" do
+      expect(put: "/posts/1").to route_to("posts#update", id: "1")
+    end
+
+    it "routes to #update via PATCH" do
+      expect(patch: "/posts/1").to route_to("posts#update", id: "1")
+    end
+
+    it "routes to #destroy" do
+      expect(delete: "/posts/1").to route_to("posts#destroy", id: "1")
+    end
+  end
+end

data/examples/rails/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/examples/rails/test/channels/application_cable/connection_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+
+class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase
+  # test "connects with cookies" do
+  #   cookies.signed[:user_id] = 42
+  #
+  #   connect
+  #
+  #   assert_equal connection.user_id, "42"
+  # end
+end

data/examples/rails/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV['RAILS_ENV'] ||= 'test'
+require_relative "../config/environment"
+require "rails/test_help"
+
+class ActiveSupport::TestCase
+  # Run tests in parallel with specified workers
+  parallelize(workers: :number_of_processors)
+
+  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/firetail.gemspec

@@ -29,6 +29,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.18.1"
+
+  # These gems are needed for firetail in production
+  spec.add_dependency "async", "~> 1.30.3"
+  spec.add_dependency "jwt", "~> 2.5"
+  spec.add_dependency "json-schema", "~> 3.0.0"
+  spec.add_dependency "committee_firetail", "~> 5.0.1"
 end

data/lib/backend.rb

@@ -0,0 +1,34 @@
+class Backend
+
+  def self.send_now(payload, options)
+    #Firetail.logger.debug "running backend"
+    # Parse it as URI
+    uri = URI(options[:url])
+
+    # Create a new request
+    http = Net::HTTP.new(uri.hostname, uri.port)
+    #http.set_debug_output($stdout) # Use this is you want to see the data output
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.read_timeout = options[:network_timeout]
+
+    begin
+      # Create a new request
+      req = CustomPost.new(uri.path,
+      {
+        'content-type': 'application/nd-json',
+        'x-ft-api-key': options[:api_key]
+      })
+
+      req.body = payload
+      # Create new thread
+      Thread.new {
+        # Send the request
+        request = http.request(req)
+      }
+      #Firetail.logger.debug "response from firetail: #{res}"
+    rescue StandardError => e
+      Firetail.logger.info "Firetail HTTP Request failed (#{e.message})"
+    end
+  end
+end

data/lib/background_tasks.rb

@@ -0,0 +1,43 @@
+require 'backend'
+
+class BackgroundTasks
+
+    # send the data to backend API
+    # This is an async task
+    def self.http_task(url,
+                       timeout,
+                       api_key,
+                       retries,
+                       payload)
+      Async do |task|
+        task.async do
+          # below code includes exponential backoff algorithm
+          retries = 0
+          begin
+            # send to firetail backend
+            # values to use for backend object
+            options = {"url": url,
+                       "network_timeout": timeout,
+                       "api_key": api_key}
+
+            request = Backend.send_now(payload, options)
+            Firetail.logger.info "Successfully sent to Firetail"
+          rescue Net::HTTPError => e
+            # if request response code is an error
+            # then try sending.
+            # @number_of_retries is configurable in .yaml file
+
+            if retries <= retries
+              retries += 1
+              max_sleep_seconds = Float(2 ** retries)
+              sleep rand(0..max_sleep_seconds)
+              retry
+            else
+              raise "Giving up on the server after #{retries} retries. Got error: #{e.message}"
+            end
+          end
+        end
+      end
+    end
+
+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/version.rb

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