firetail 0.0.1.pre.alpha → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c2911c879eebc409df8cd9ef8effa8339a7225e7626a896a602ffed00c02504
-  data.tar.gz: dde8fb62f7c0c770938b2c37a3f7440ce6ac1dba3450ce57f67a6186c9b2491d
+  metadata.gz: d72650eb852608c74233aa661dc8e0f900654e068769e6c09c29de37682e9642
+  data.tar.gz: 3538cbdb1c798756553b73921bbab9b3a7ab076b3b3c91b3a7b6e0142bbf7a7a
 SHA512:
-  metadata.gz: a4e2d329a58d5d324c9ea7edd3502cf5379caa3408c970ab92a20b9c6218c5c4ef4d3fbd331c633cf80976ed6f2e394b6973fa608fd056e7978e0f78785a1436
-  data.tar.gz: 14515df3e82951f12c813105627d59c18579bbe967a297212a71844ec4dab4cf940a8973df8621ae930d1efb8b6a47feaa414b64e8f10f7d037543fd00b21870
+  metadata.gz: 41dbd5ad76e2b78381794166cf9df5dae4c3f0afea1375fb3b4b47b6e1b5feb4bb01faa72e6749627f8e47170c92e68acc2af5ed3395d4f29f414ed4b0a5467c
+  data.tar.gz: e4cb860d75a1bf262e7a351595370db8746e1018dff7f745deb70ed11cc766840922042549a3f93112a6591803ddf9ec0c3f688c954844cbeb46cc50c6a52d11

data/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Describe your changes
+
+## Issue ticket number and link
+
+## Checklist before requesting a review
+
+- [ ] I have resolved any merge conflicts
+- [ ] I have run tests locally and they pass
+- [ ] I have linted and auto-formatted the code
+- [ ] If there is new or changed functionality, I have added/updated the tests
+- [ ] If there is new or changed functionality, I have added/updated the documentation

data/.gitignore

@@ -13,27 +13,27 @@
 /ext/target
 
 # Ignore bundler config.
-/rails_example/.bundle
+/examples/rails/.bundle
 
 # Ignore the default SQLite database.
-/rails_example/db/*.sqlite3
+/example/rails/db/*.sqlite3
 /db/*.sqlite3-*
 
 # Ignore all logfiles and tempfiles.
-/rails/log/*
-/rails/tmp/*
-!/rails/log/.keep
-!/rails/tmp/.keep
+/examples/rails/log/*
+/examples/rails/tmp/*
+!/examples/rails/log/.keep
+!/examples/rails/tmp/.keep
 
 # Ignore pidfiles, but keep the directory.
-/rails/tmp/pids/*
-!/rails/tmp/pids/
-!/rails/tmp/pids/.keep
+/examples/rails/tmp/pids/*
+!/examples/rails/tmp/pids/
+!/examples/rails/tmp/pids/.keep
 
 # Ignore uploaded files in development.
-/rails/storage/*
-!/rails/storage/.keep
-/rails/.byebug_history
+/examples/rails/storage/*
+!/examples/rails/storage/.keep
+/examples/rails/.byebug_history
 
 # Ignore master key for decrypting credentials and more.
-/rails/config/master.key
+/examples/rails/config/master.key

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in firetail.gemspec
 gemspec
 
-gem 'rack', "~> 3.0.4.2"
+gem 'rack', "~> 3.0.6.1"
 group :development, :test do
   gem "webmock", "~> 3.18"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    firetail (0.0.0)
+    firetail (0.0.1.pre.alpha)
       async (~> 1.30.3)
       committee_firetail (~> 5.0.0)
       json-schema (~> 3.0.0)
@@ -20,22 +20,24 @@ GEM
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser_firetail (~> 1.0)
       rack (>= 1.5)
-    console (1.16.2)
+    console (1.19.0)
+      fiber-annotation
       fiber-local
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
+    fiber-annotation (0.2.0)
     fiber-local (1.0.0)
     hashdiff (1.0.1)
     json-schema (3.0.0)
       addressable (>= 2.8)
     json_schema (0.21.0)
-    jwt (2.7.0)
-    nio4r (2.5.8)
+    jwt (2.7.1)
+    nio4r (2.5.9)
     openapi_parser_firetail (1.0.0)
       jwt (~> 2.5)
     public_suffix (5.0.1)
-    rack (3.0.4.2)
+    rack (3.0.6.1)
     rake (13.0.6)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -63,7 +65,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   firetail!
-  rack (~> 3.0.4.2)
+  rack (~> 3.0.6.1)
   rake (~> 13.0)
   rspec (~> 3.0)
   webmock (~> 3.18)

data/README.md

@@ -1,8 +1,6 @@
 # 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
+Welcome to the Firetail Ruby gem. Before we start, ensure that your ruby version is 2.7 or greater. We do not support ruby versions lower than 2.7.
 
 ## Installation
 
@@ -14,15 +12,31 @@ gem 'firetail'
 
 And then execute:
 
-    $ bundle
+    $ `bundle install`
+
+Or install it yourself with:
+
+    $ `gem install firetail`
+
+Finally, if you are using Rails, run:
+
+    $ `rails g firetail:install`
+
+This will configure your Rails app to use Firetail gem as middleware and generate configuration and json schema template.
+
+Finally, if you are using Rails, run:
 
-Or install it yourself as:
+    $ rails g firetail:install
 
-    $ gem install firetail
+This will configure your Rails app to use the Firetail gem as middleware, and generate configuration and json schema templates.
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Setup your Firetail key by setting environment variable `FIRETAIL_API_KEY`
+2. Setup Firetail backend URL by setting the environment variable `FIRETAIL_URL`
+**NOTE** For US based customers, use `https://api.logging.us-east-2.prod.us.firetail.app` for `FIRETAIL_URL`. By default `FIRETAIL_URL` uses **EUROPE(EU)** servers.
+3. Update `config/schema.json` to match your API endpoints.
+4. That's it! Happy coding!
 
 ## Development
 
@@ -32,12 +46,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/firetail-io/firetail-ruby-lib. 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).
+The gem is available as open source under the terms of the LGPL License.
 
 ## 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).
+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/firetail-io/firetail-ruby-lib/blob/main/CODE_OF_CONDUCT.md).

data/examples/rails/.gitattributes

@@ -0,0 +1,8 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/examples/rails/.gitignore

@@ -0,0 +1,31 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/examples/rails/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/examples/rails/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.7

data/examples/rails/Gemfile

@@ -0,0 +1,44 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '3.2.3'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails', branch: 'main'
+gem 'rails', '~> 6.1.7', '>= 6.1.7.4'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '~> 1.4'
+# Use Puma as the app server
+gem 'puma', '~> 5.0'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+# gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.4', require: false
+
+# Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin AJAX possible
+# gem 'rack-cors'
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem "rspec", "= 3.12"
+  gem "rspec-rails"
+end
+
+group :development do
+  gem 'listen', '~> 3.3'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+gem "firetail", "~> 1.0.1"

data/examples/rails/Gemfile.lock

@@ -0,0 +1,240 @@
+PATH
+  remote: ../..
+  specs:
+    firetail (0.0.1.pre.alpha)
+      async (~> 1.30.3)
+      committee_firetail (~> 5.0.1)
+      json-schema (~> 3.0.0)
+      jwt (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.7.4)
+      actionpack (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.4)
+      actionpack (= 6.1.7.4)
+      activejob (= 6.1.7.4)
+      activerecord (= 6.1.7.4)
+      activestorage (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.4)
+      actionpack (= 6.1.7.4)
+      actionview (= 6.1.7.4)
+      activejob (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.4)
+      actionview (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.4)
+      actionpack (= 6.1.7.4)
+      activerecord (= 6.1.7.4)
+      activestorage (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.4)
+      activesupport (= 6.1.7.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.7.4)
+      activesupport (= 6.1.7.4)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.4)
+      activesupport (= 6.1.7.4)
+    activerecord (6.1.7.4)
+      activemodel (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+    activestorage (6.1.7.4)
+      actionpack (= 6.1.7.4)
+      activejob (= 6.1.7.4)
+      activerecord (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    async (1.30.3)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    base64 (0.2.0)
+    bootsnap (1.16.0)
+      msgpack (~> 1.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    committee_firetail (5.0.1)
+      json_schema (~> 0.14, >= 0.14.3)
+      openapi_parser (~> 2.1.0)
+      rack (>= 1.5)
+    concurrent-ruby (1.2.2)
+    console (1.24.0)
+      fiber-annotation
+      fiber-local
+      json
+    crass (1.0.6)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    ffi (1.15.5)
+    fiber-annotation (0.2.0)
+    fiber-local (1.0.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    json-schema (3.0.0)
+      addressable (>= 2.8)
+    json_schema (0.21.0)
+    jwt (2.8.1)
+      base64
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.4)
+    minitest (5.19.0)
+    msgpack (1.7.2)
+    net-imap (0.3.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    openapi_parser (2.1.0)
+    public_suffix (5.0.5)
+    puma (5.6.6)
+      nio4r (~> 2.0)
+    racc (1.7.1)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (6.1.7.4)
+      actioncable (= 6.1.7.4)
+      actionmailbox (= 6.1.7.4)
+      actionmailer (= 6.1.7.4)
+      actionpack (= 6.1.7.4)
+      actiontext (= 6.1.7.4)
+      actionview (= 6.1.7.4)
+      activejob (= 6.1.7.4)
+      activemodel (= 6.1.7.4)
+      activerecord (= 6.1.7.4)
+      activestorage (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (6.1.7.4)
+      actionpack (= 6.1.7.4)
+      activesupport (= 6.1.7.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.0.3)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
+    rspec-support (3.12.1)
+    spring (4.1.1)
+    sprockets (4.2.0)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.6.3)
+      mini_portile2 (~> 2.8.0)
+    thor (1.2.2)
+    timeout (0.4.0)
+    timers (4.3.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bootsnap (>= 1.4.4)
+  byebug
+  firetail!
+  listen (~> 3.3)
+  puma (~> 5.0)
+  rails (~> 6.1.7, >= 6.1.7.4)
+  rspec (= 3.12)
+  rspec-rails
+  spring
+  sqlite3 (~> 1.4)
+  tzinfo-data
+
+RUBY VERSION
+   ruby 3.2.3p157
+
+BUNDLED WITH
+   2.1.4

data/examples/rails/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/examples/rails/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/examples/rails/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/examples/rails/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/examples/rails/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::API
+end

data/examples/rails/app/controllers/comments_controller.rb

@@ -0,0 +1,52 @@
+class CommentsController < ApplicationController
+  before_action :set_comment, only: [:show, :update, :destroy]
+
+  # GET /comments
+  def index
+    @comments = Comment.all
+
+    render json: @comments
+  end
+
+  # GET /comments/1
+  def show
+    render json: @comment
+  end
+
+  # POST /comments
+  def create
+    @post = Post.find(params[:post_id])
+    @comment = @post.comments.new(comment_params)
+
+    if @comment.save
+      render json: @comment, status: :created
+    else
+      render json: @comment.errors, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /comments/1
+  def update
+    if @comment.update(comment_params)
+      render json: @comment
+    else
+      render json: @comment.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /comments/1
+  def destroy
+    @comment.destroy
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_comment
+      @comment = Comment.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def comment_params
+      params.require(:comment).permit(:message, :post_id)
+    end
+end

data/examples/rails/app/controllers/posts_controller.rb

@@ -0,0 +1,51 @@
+class PostsController < ApplicationController
+  before_action :set_post, only: [:show, :update, :destroy]
+
+  # GET /posts
+  def index
+    @posts = Post.all
+
+    render json: @posts
+  end
+
+  # GET /posts/1
+  def show
+    render json: @post
+  end
+
+  # POST /posts
+  def create
+    @post = Post.new(post_params)
+
+    if @post.save
+      render json: @post, status: :created, location: @post
+    else
+      render json: @post.errors, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH/PUT /posts/1
+  def update
+    if @post.update(post_params)
+      render json: @post
+    else
+      render json: @post.errors, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /posts/1
+  def destroy
+    @post.destroy
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_post
+      @post = Post.find(params[:id])
+    end
+
+    # Only allow a list of trusted parameters through.
+    def post_params
+      params.require(:post).permit(:title, :content, comments: [:message])
+    end
+end

data/examples/rails/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end