litera 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43ce216fa357aed945907939fea46e685daa7d6408f96a97921cf23e1aec769e
+  data.tar.gz: 21bd3b5811723594dd6305c492722c8c119ea7e7f39493eac631b7934224ab60
+SHA512:
+  metadata.gz: 6bfae89f0ac76b687b3ab7af8eb99355d1ba6ecb9b6b659cc459d3373bd3cb4716362287d38f2149391f30557322f6b975c9de007a476ac5ffe3a20099171746
+  data.tar.gz: f98eb603ef6522e0499da967c7cfe93e67365255c8ee0e8a8cedf667d21e41702b96502f22f2dfaf2d26b035c4ef2e26bca1c0206b4df018ae149f9d79f2db73

data/README.md

@@ -0,0 +1,125 @@
+# Litera - Messages Dashboard
+
+This rails engine aims to provide a simple dasboard for the messages
+received in your application regardless the services you are using to
+handle your messages (GooglePubSub, Amazon SQS, Apache Kafka, etc) in
+order to easily track and debug the data in your received data.
+
+## Installation
+
+Add `Litera` to your application's Gemfile:
+
+```ruby
+gem "litera"
+```
+
+And then install litera:
+
+```bash
+rails g litera:install
+```
+
+Install litera migrations:
+
+```bash
+rails g litera:install:migrations
+```
+
+Run pending migrations:
+
+```bash
+rails db:migrate
+```
+
+Add the following line to your `app/assets/config/manifest.js`:
+
+```javascript
+//= link litera/application.css
+```
+
+Lastly, mount litera engine in your `config/routes.rb`:
+
+```bash
+Rails.application.routes.draw do
+  mount Litera::Engine => "/litera"
+  ...
+end
+```
+
+## Configuration
+
+Configure what is the name of the method that returns your current user
+and how he will be authorized to access the messages dashboard.
+
+```ruby
+Litera.setup do |config|
+  # Configure what is the name of the method that returns the current
+  # logged in user in your application.
+  # config.litera_user = :current_user
+
+  # Setup the name of the main application controller in your application.
+  # config.parent_controller = "ApplicationController"
+
+  # Define how the current user will be authorized ot not to access the
+  # messages dashboard.
+  # config.authorization = -> (user) do
+    # user.admin?
+  # end
+end
+```
+
+## Usage
+
+Track your messages inmmediately after you received them using:
+
+```ruby
+Litera::Message.create!({
+  service: :google_pub_sub,
+  body: message.body,
+  metadata: message.attributes,
+  external_id: message.message_id,
+  published_at: message.published_at
+})
+```
+
+You can use an active job if you want to save it in background:
+
+```ruby
+Litera::MessageJob.perform_later({
+  service: :google_pub_sub,
+  body: message.body,
+  metadata: message.attributes,
+  external_id: message.message_id,
+  published_at: message.published_at
+})
+```
+
+## 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 the created tag, 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/amco/litera-rb.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[code of conduct](https://github.com/amco/litera-rb/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Litera project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the
+[code of conduct](https://github.com/amco/litera-rb/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/app/assets/config/litera_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/litera .css

data/app/assets/stylesheets/litera/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/litera/main.css

@@ -0,0 +1,14 @@
+.litera table, th, td {
+  border: 1px solid black;
+  border-collapse: collapse;
+}
+
+.litera table th {
+  text-align: left;
+  font-weight: bold;
+  text-transform: uppercase;
+}
+
+.litera table th, td {
+  padding: 5px;
+}

data/app/controllers/litera/application_controller.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Litera
+  class ApplicationController < Litera.parent_controller.constantize
+    before_action :authorize_litera_user
+
+    private
+
+    def litera_user
+      send(Litera.litera_user)
+    end
+
+    def authorize_litera_user
+      if !Litera.authorization.call(litera_user)
+        raise Litera::Errors::NotAuthorized
+      end
+    end
+  end
+end

data/app/controllers/litera/messages_controller.rb

@@ -0,0 +1,13 @@
+module Litera
+  class MessagesController < ApplicationController
+    include Pagy::Backend
+
+    def index
+      @pagy, @messages = pagy(Message.ordered)
+    end
+
+    def show
+      @message = Message.find(params[:id])
+    end
+  end
+end

data/app/helpers/litera/application_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Litera
+  module ApplicationHelper
+    include Pagy::Frontend
+  end
+end

data/app/jobs/litera/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Litera
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/litera/message_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Litera
+  class MessageJob < ApplicationJob
+    def perform(data = {})
+      Litera::Message.create!(data)
+    end
+  end
+end

data/app/models/litera/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Litera
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/litera/message.rb

@@ -0,0 +1,11 @@
+module Litera
+  class Message < ApplicationRecord
+    validates :body, presence: true
+    validates :service, presence: true
+    validates :metadata, presence: true
+    validates :external_id, presence: true
+    validates :published_at, presence: true
+
+    scope :ordered, -> { order(published_at: :desc) }
+  end
+end

data/app/views/layouts/litera/application.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Litera</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%= stylesheet_link_tag "litera/application", media: "all" %>
+  </head>
+
+  <body class="litera">
+    <%= yield %>
+  </body>
+</html>

data/app/views/litera/messages/index.html.erb

@@ -0,0 +1,27 @@
+<h1><%= Litera::Message.model_name.human(count: 2) %></h1>
+
+<table width="100%">
+  <thead>
+    <tr>
+      <th><%= Litera::Message.human_attribute_name(:published_at) %></th>
+      <th><%= Litera::Message.human_attribute_name(:service) %></th>
+      <th><%= Litera::Message.human_attribute_name(:id) %></th>
+      <th><%= Litera::Message.human_attribute_name(:metadata) %></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @messages.each do |message| %>
+      <tr>
+        <td><%= l(message.published_at) %></td>
+        <td><%= message.service %></td>
+        <td><%= message.external_id %></td>
+        <td><%= message.metadata.to_s.truncate(50).html_safe %></td>
+        <td><%= link_to t(".show"), message %></td>
+      </tr>
+    <% end %>
+  </body>
+</table>
+
+<%== pagy_nav(@pagy) %>

data/app/views/litera/messages/show.html.erb

@@ -0,0 +1,32 @@
+<h1>Message: <%= @message.external_id %></h1>
+
+<table>
+  <tbody>
+    <tr>
+      <th><%= Litera::Message.human_attribute_name(:published_at) %></th>
+      <td><%= l(@message.published_at) %></td>
+    </tr>
+
+    <tr>
+      <th><%= Litera::Message.human_attribute_name(:service) %></th>
+      <td><%= @message.service %></td>
+    </tr>
+
+    <tr>
+      <th><%= Litera::Message.human_attribute_name(:id) %></th>
+      <td><%= @message.external_id %></td>
+    </tr>
+
+    <tr>
+      <th><%= Litera::Message.human_attribute_name(:metadata) %></th>
+      <td><pre><%= JSON.pretty_generate(@message.metadata) %></pre></td>
+    </tr>
+
+    <tr>
+      <th><%= Litera::Message.human_attribute_name(:body) %></th>
+      <td><pre><%= JSON.pretty_generate(@message.body) %></pre></td>
+    </tr>
+  </body>
+</table>
+
+<%= link_to t(".back"), messages_path %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Litera::Engine.routes.draw do
+  resources :messages, only: %i[index show]
+end

data/db/migrate/20221102211322_create_litera_messages.rb

@@ -0,0 +1,15 @@
+class CreateLiteraMessages < ActiveRecord::Migration[7.0]
+  def change
+    create_table :litera_messages do |t|
+      t.jsonb :body, default: {}
+      t.jsonb :metadata, default: {}
+      t.string :service
+      t.string :external_id
+      t.datetime :published_at
+
+      t.timestamps
+    end
+
+    add_index :litera_messages, :published_at
+  end
+end

data/lib/generators/litera/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Litera
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc "Creates litera initializer."
+
+      def create_initializer
+        template "litera.rb", "config/initializers/litera.rb"
+      end
+    end
+  end
+end

data/lib/generators/litera/templates/litera.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Litera.setup do |config|
+  # Configure what is the name of the method that returns the current
+  # logged in user in your application.
+  # config.litera_user = :current_user
+
+  # Setup the name of the main application controller in your application.
+  # config.parent_controller = "ApplicationController"
+
+  # Define how the current user will be authorized ot not to access the
+  # messages dashboard.
+  # config.authorization = -> (user) do
+    # user.admin?
+  # end
+end

data/lib/litera/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Litera
+  module Configuration
+    mattr_accessor :litera_user, default: :current_user
+    mattr_accessor :parent_controller, default: "ApplicationController"
+    mattr_accessor :authorization, default: -> (user) { user.admin? }
+
+    def setup
+      yield(self) if block_given?
+    end
+  end
+end

data/lib/litera/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Litera
+  class Engine < ::Rails::Engine
+    isolate_namespace Litera
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: "spec/factories"
+    end
+  end
+end

data/lib/litera/errors/not_authorized.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Litera
+  module Errors
+    class NotAuthorized < StandardError
+    end
+  end
+end

data/lib/litera/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Litera
+  VERSION = "0.1.0"
+end

data/lib/litera.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "litera/version"
+require "litera/engine"
+require "litera/configuration"
+require "litera/errors/not_authorized"
+
+module Litera
+  extend Configuration
+end

data/lib/tasks/litera_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :litera do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: litera
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alejandro Gutiérrez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Rails engine that provides a simple dashboard to track received messages
+  in your application.
+email:
+- alejandrodevs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/assets/config/litera_manifest.js
+- app/assets/stylesheets/litera/application.css
+- app/assets/stylesheets/litera/main.css
+- app/controllers/litera/application_controller.rb
+- app/controllers/litera/messages_controller.rb
+- app/helpers/litera/application_helper.rb
+- app/jobs/litera/application_job.rb
+- app/jobs/litera/message_job.rb
+- app/models/litera/application_record.rb
+- app/models/litera/message.rb
+- app/views/layouts/litera/application.html.erb
+- app/views/litera/messages/index.html.erb
+- app/views/litera/messages/show.html.erb
+- config/routes.rb
+- db/migrate/20221102211322_create_litera_messages.rb
+- lib/generators/litera/install_generator.rb
+- lib/generators/litera/templates/litera.rb
+- lib/litera.rb
+- lib/litera/configuration.rb
+- lib/litera/engine.rb
+- lib/litera/errors/not_authorized.rb
+- lib/litera/version.rb
+- lib/tasks/litera_tasks.rake
+homepage: https://github.com/amco/litera-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/amco/litera-rb
+  source_code_uri: https://github.com/amco/litera-rb
+  changelog_uri: https://github.com/amco/litera-rb/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Rails engine dashboard for message tracking.
+test_files: []