mdash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f04e567a5a7a3c4f5c350db0a238c0f1193b9a312b60069159c740a6c64a309b
+  data.tar.gz: 4e22e7a1d14be1045162856737f72e181ba86b7f7041e2241e59dc44c0d55c45
+SHA512:
+  metadata.gz: 9ea1ac9cbc669d1673cfc5cec7b3eebd935c08ea2ae8a7703d926cf7aefa9f867ed47bf6b195bd26c52508f1fdf1f940a161c27ce2f4443cd1603c5df568fd4c
+  data.tar.gz: cdbe84f79f38cf298fd22bd0ef792025dfe152c57eeb6daa649bf9911ad927e40898b36bc1de8855293188dac4f9ec7756907aad7822161c13ffb350c207e1bc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Tim Marks
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Mdash
+Mdash is the easiest, most secure and most efficient way to setup dashboards for your Rails apps.
+Since we use client-side apps instead of bulky server-side embeds the overhead on your app and the surface area is kept to a minimum.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "mdash"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install mdash
+```
+
+#### Run the installer
+
+To setup the Mdash config file in your rails project run
+
+```bash
+rails generate mdash:install
+```
+
+## Usage
+
+Mount the Mdash engine in your routes file
+
+```ruby
+mount Mdash::Engine => "/mdash"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/imothee/mdash. 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/imothee/policygen/blob/main/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 Mdash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/imothee/policygen/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/mdash/announce_controller.rb

@@ -0,0 +1,18 @@
+module Mdash
+  class AnnounceController < ApplicationController
+    def index
+      available = Mdash.config.metrics.each_with_object({}) do |metric, hash|
+        hash[metric.id] = {
+          model: metric.model,
+          aggregation: metric.aggregation,
+          aggregation_column: metric.aggregation_column,
+          period: metric.period,
+          periods: metric.periods,
+          modifier: metric.modifier
+        }
+      end
+
+      render json: available.as_json
+    end
+  end
+end

data/app/controllers/mdash/application_controller.rb

@@ -0,0 +1,21 @@
+module Mdash
+  class ApplicationController < ActionController::Base
+    before_action :authenticate_token!
+
+    private
+
+    def authenticate_token!
+      unless Mdash.config.secret.present?
+        return render json: { error: "Mdash secret is not set" }, status: 500
+      end
+
+      unless Mdash.config.secret.length > 10
+        return render json: { error: "Mdash secret is too short" }, status: 500
+      end
+
+      unless request.headers["X-Mdash-Token"] == Mdash.config.secret
+        return render json: { error: "Unauthorized" }, status: 401
+      end
+    end
+  end
+end

data/app/controllers/mdash/stats_controller.rb

@@ -0,0 +1,8 @@
+module Mdash
+  class StatsController < ApplicationController
+    def index
+      @stats = Mdash.stats
+      render json: @stats
+    end
+  end
+end

data/app/helpers/mdash/application_helper.rb

@@ -0,0 +1,4 @@
+module Mdash
+  module ApplicationHelper
+  end
+end

data/app/jobs/mdash/application_job.rb

@@ -0,0 +1,4 @@
+module Mdash
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/mdash/application_mailer.rb

@@ -0,0 +1,6 @@
+module Mdash
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/mdash/application_record.rb

@@ -0,0 +1,5 @@
+module Mdash
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/mdash/metric.rb

@@ -0,0 +1,93 @@
+module Mdash
+  class Metric
+    include ActiveModel::Model
+
+    # Valid aggregations
+    AGGREGATIONS = %i[sum average count].freeze
+    # Valid periods
+    PERIODS = %i[hour day week month year].freeze
+
+    attr_reader :id, :model, :aggregation, :aggregation_column, :period, :periods, :modifier
+
+    def self.all(configuration: nil)
+      configuration ||= Mdash.config
+      configuration.metrics
+    end
+
+    def self.find(id, configuration: nil)
+      all(configuration:).find { |m| m.id == id.to_sym }.tap do |m|
+        raise ActiveRecord::RecordNotFound unless m
+      end
+    end
+
+    def initialize(id:, model:, aggregation:, aggregation_column: :id, period: nil, periods: nil, modifier: nil)
+      @id = id.to_sym
+      @model = model.to_sym
+      @aggregation = aggregation.to_sym
+      @aggregation_column = aggregation_column.to_sym
+      @period = period&.to_sym
+      @periods = periods
+      @modifier = modifier
+    end
+
+    def valid?
+      return false unless AGGREGATIONS.include?(@aggregation)
+      return false unless PERIODS.include?(@period) if @period.present?
+
+      true
+    end
+
+    def data
+      clazz = @model.to_s.classify.constantize
+      data = clazz.all
+      data = data.send(@modifier) if @modifier.present?
+      data = period_query(data) if @period.present? and @periods.nil?
+      data = periods_query(data) if @period.present? and @periods.present? and @periods.positive?
+      data = aggregation_query(data)
+      data
+    end
+
+    private
+
+    def period_query(query)
+      case @period
+      when :hour
+        query.where(created_at: 1.hour.ago..Time.now)
+      when :day
+        query.where(created_at: 1.day.ago..Time.now)
+      when :week
+        query.where(created_at: 1.week.ago..Time.now)
+      when :month
+        query.where(created_at: 1.month.ago..Time.now)
+      when :year
+        query.where(created_at: 1.year.ago..Time.now)
+      end
+    end
+
+    def periods_query(query)
+      case @period
+      when :hour
+        query.where(created_at: @periods.hours.ago..Time.now).group_by_hour(:created_at)
+      when :day
+        query.where(created_at: @periods.days.ago..Time.now).group_by_day(:created_at)
+      when :week
+        query.where(created_at: @periods.weeks.ago..Time.now).group_by_week(:created_at)
+      when :month
+        query.where(created_at: @periods.months.ago..Time.now).group_by_month(:created_at)
+      when :year
+        query.where(created_at: @periods.years.ago..Time.now).group_by_year(:created_at)
+      end
+    end
+
+    def aggregation_query(query)
+      case @aggregation
+      when :sum
+        query.sum(@aggregation_column)
+      when :avg
+        query.average(@aggregation_column)
+      when :count
+        query.count
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Mdash::Engine.routes.draw do
+  get "announce" => "announce#index"
+  get "stats" => "stats#index"
+end

data/lib/generators/mdash/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mdash
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy Mdash default files"
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_config
+        template "config/initializers/mdash.rb.tt", "config/initializers/mdash.rb"
+      end
+    end
+  end
+end

data/lib/generators/mdash/templates/config/initializers/mdash.rb.tt

@@ -0,0 +1,6 @@
+# Use this setup block to configure all options available in Mdash
+Mdash.configure do |config|
+  config.secret = "<%= SecureRandom.hex(32) %>"
+
+  config.exported_metrics = {}
+end

data/lib/mdash/configuration.rb

@@ -0,0 +1,21 @@
+module Mdash
+  class Configuration
+    attr_accessor :secret
+    attr_accessor :exported_metrics
+
+    def metrics
+      @metrics ||= exported_metrics.flat_map do |prefix, params|
+        model = params[:model]
+        params[:metrics].map do |k, metric_params|
+          metric = Metric.new(id: "#{prefix}_#{k}", model: model, **metric_params)
+          # Check if the metric is valid
+          unless metric.valid?
+            Rails.logger.warn("Invalid metric: #{metric.id}")
+            return nil
+          end
+          metric
+        end
+      end
+    end
+  end
+end

data/lib/mdash/engine.rb

@@ -0,0 +1,5 @@
+module Mdash
+  class Engine < ::Rails::Engine
+    isolate_namespace Mdash
+  end
+end

data/lib/mdash/version.rb

@@ -0,0 +1,3 @@
+module Mdash
+  VERSION = "0.1.0"
+end

data/lib/mdash.rb

@@ -0,0 +1,32 @@
+require "mdash/version"
+require "mdash/engine"
+require "mdash/configuration"
+require "groupdate"
+
+module Mdash
+  class Error < StandardError; end
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def stats
+      # Check the last time stats were updated
+      # If it's been more than 5 minutes, update the stats
+      if @last_updated.nil? || @last_updated < 5.minutes.ago
+        @stats = config.metrics.reduce({}) do |stats, metric|
+          stats[metric.id] = metric.data
+          stats
+        end
+        @last_updated = Time.now
+      end
+      @stats
+    end
+  end
+end
+

data/lib/tasks/mdash_tasks.rake

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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mdash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Marks
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+- !ruby/object:Gem::Dependency
+  name: groupdate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.5'
+description: mdash-rails exposes metrics for your Rails app to be consumed by the
+  mdash app.
+email:
+- t@imothee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/mdash/announce_controller.rb
+- app/controllers/mdash/application_controller.rb
+- app/controllers/mdash/stats_controller.rb
+- app/helpers/mdash/application_helper.rb
+- app/jobs/mdash/application_job.rb
+- app/mailers/mdash/application_mailer.rb
+- app/models/mdash/application_record.rb
+- app/models/mdash/metric.rb
+- config/routes.rb
+- lib/generators/mdash/install_generator.rb
+- lib/generators/mdash/templates/config/initializers/mdash.rb.tt
+- lib/mdash.rb
+- lib/mdash/configuration.rb
+- lib/mdash/engine.rb
+- lib/mdash/version.rb
+- lib/tasks/mdash_tasks.rake
+homepage: https://mdash.app
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://mdash.app
+  source_code_uri: https://github.com/imothee/mdash-rails
+  changelog_uri: https://github.com/imothee/mdash-rails/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: mdash-rails exposes metrics for your Rails app to be consumed by the mdash
+  app.
+test_files: []