floodlight_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 472ab736a0ece36c2e1c38b489c5e0cc9d153a78
+  data.tar.gz: 0b166aa6e26adf29fdf014d5a55fd656cbb22397
+SHA512:
+  metadata.gz: ad778a8afb3e7ee66652d413b886d16038a8b1608a3d49646c176c26e4bbf83a3681149ddf014bbb61a04b642f82f224421174f500285d9d69ea77b6007b0828
+  data.tar.gz: 365456a030d5a968a007cbaca01535d6838fe7e8d30676b3e77c6e114bcca9847a18ce222cba0f0465c643d43f886c45950eca7728fe75938635ca9b3affa375

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Chuck Callebs
+
+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,52 @@
+# Floodlight for Rails
+
+[Floodlight](https://www.floodlight.io) helps you stop bugs in their tracks. We provide an easy way to gain insight into your data and notify you if we see problems.
+
+This gem allows your Rails application to freely provide pre-configured daily data to Floodlight. It does this by mounting a set of protected API endpoints in your app. Only Floodlight can access these endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'floodlight_rails', require: 'floodlight'
+
+And then execute:
+
+    $ bundle
+
+You can then install the necessary configuration by executing:
+
+    $ floodlight install
+
+This will create a configuration file:
+
+    # config/initializers/floodlight.rb
+    Floodlight.configure do |config|
+      config.access_token = ENV['FLOODLIGHT_TOKEN']
+    end
+
+    # Sample usage:
+    # Floodlight.add_daily :confirmed_users,  -> { User.confirmed }
+    # Floodlight.add_daily :unpaid_orders,    -> { Order.unpaid }
+    # Floodlight.add_cumulative :total_users, -> { User }
+
+You will need to check your application dashboard for your access token. By default, we advise storing it in an environment variable in your production environment.
+
+## Usage
+
+For an example of how to set up various metrics to track, check out the configuration file. The `add_daily` and `add_cumulative` methods will expose additional metrics to the Floodlight application. The metrics will automatically be picked up by our servers.
+
+These method take two parameters -- a descriptive symbol and a lambda containing an ActiveRecord scope. Be aware that if you change the symbol name, it will track it as a separate metric.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FloodlightTeam/floodlight_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 FloodlightTeam project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/FloodlightTeam/floodlight_rails/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Floodlight'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/controllers/floodlight/api/health_check_controller.rb

@@ -0,0 +1,7 @@
+module Floodlight
+  class Api::HealthCheckController < Floodlight::ApiController
+    def index
+      render json: { success: true }
+    end
+  end
+end

data/app/controllers/floodlight/api/metrics_controller.rb

@@ -0,0 +1,7 @@
+module Floodlight
+  class Api::MetricsController < ApiController
+    def index
+      render json: { metrics: Floodlight.metrics.map { |m| [m.name, m.type]} }
+    end
+  end
+end

data/app/controllers/floodlight/api/statistics_controller.rb

@@ -0,0 +1,7 @@
+module Floodlight
+  class Api::StatisticsController < ApiController
+    def show
+      render json: { count: Floodlight.statistics_for(params[:id], days_ago: params[:days_ago] || 1) }
+    end
+  end
+end

data/app/controllers/floodlight/api_controller.rb

@@ -0,0 +1,12 @@
+module Floodlight
+  class ApiController < ActionController::Base
+    before_action :verify_access_token
+
+    def verify_access_token
+      if params[:access_token] != Floodlight.configuration.access_token
+        render json: { error: 'not authorized' }, status: 401
+        return
+      end
+    end
+  end
+end

data/bin/floodlight

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/floodlight/runner'
+
+Floodlight::Runner.invoke

data/config/routes.rb

@@ -0,0 +1,7 @@
+Floodlight::Engine.routes.draw do
+  namespace :api do
+    resources :health_check, only: [:index]
+    resources :metrics, only: [:index]
+    resources :statistics, only: [:show]
+  end
+end

data/lib/floodlight.rb

@@ -0,0 +1,45 @@
+require "floodlight/engine"
+require "floodlight/configuration"
+require "floodlight/installer"
+require "floodlight/lazy_metric"
+
+module Floodlight
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.metrics
+    @metrics ||= []
+  end
+
+  def self.add_daily(name, scope)
+    add(name, scope: scope, type: 'daily')
+  end
+
+  def self.add_cumulative(name, scope)
+    add(name, scope: scope, type: 'cumulative')
+  end
+
+  def self.add(name, scope:, type: 'daily')
+    if metric = metrics.find { |m| m.name == name }
+      metric.scope = scope
+    else
+      metrics << LazyMetric.new(name, scope: scope, type: type)
+    end
+  end
+
+  def self.statistics_for(name, days_ago: 1)
+    metric = metrics.find { |m| m.name == name.to_sym }
+    metric.compute(days_ago: days_ago)
+  rescue
+    nil
+  end
+end

data/lib/floodlight/configuration.rb

@@ -0,0 +1,5 @@
+module Floodlight
+  class Configuration
+    attr_accessor :access_token
+  end
+end

data/lib/floodlight/engine.rb

@@ -0,0 +1,18 @@
+module Floodlight
+  class Engine < ::Rails::Engine
+    isolate_namespace Floodlight
+
+    initializer 'floodlight.mount' do |app|
+      app.routes.append do
+        mount Floodlight::Engine => '/floodlight'
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/floodlight/installer.rb

@@ -0,0 +1,24 @@
+module Floodlight
+  class Installer
+    def self.perform
+      if defined?(Rails)
+        file_path = Rails.root.join('config', 'initializers', 'floodlight.rb')
+      else
+        file_path = Dir.pwd + '/config/initializers/floodlight.rb'
+      end
+
+      file_contents = <<-FILE
+Floodlight.configure do |config|
+  config.access_token = ENV['FLOODLIGHT_TOKEN']
+end
+
+# Sample usage:
+# Floodlight.add_daily :confirmed_users,  -> { User.confirmed }
+# Floodlight.add_daily :unpaid_orders,    -> { Order.unpaid }
+# Floodlight.add_cumulative :total_users, -> { User }
+FILE
+
+      File.write(file_path, file_contents)
+    end
+  end
+end

data/lib/floodlight/lazy_metric.rb

@@ -0,0 +1,27 @@
+module Floodlight
+  class LazyMetric
+    class InvalidMetricTypeException < StandardError; end
+
+    attr_accessor :name, :scope, :type
+
+    def initialize(name, scope:, type:)
+      raise InvalidMetricTypeException unless ['daily', 'cumulative'].include?(type)
+
+      self.name = name
+      self.scope = scope
+      self.type = type
+    end
+
+    def compute(days_ago: 1)
+      computed_scope = scope.call
+
+      if type == 'daily'
+        computed_scope = computed_scope.where("date(created_at) = date(?)", days_ago.to_i.days.ago)
+      elsif type == 'cumulative'
+        computed_scope = computed_scope.where("date(created_at) <= date(?)", days_ago.to_i.days.ago)
+      end
+
+      computed_scope.count
+    end
+  end
+end

data/lib/floodlight/runner.rb

@@ -0,0 +1,12 @@
+require 'floodlight/installer'
+
+module Floodlight
+  class Runner
+    def self.invoke
+      case ARGV
+      when ["install"]
+        Floodlight::Installer.perform
+      end
+    end
+  end
+end

data/lib/floodlight/version.rb

@@ -0,0 +1,3 @@
+module Floodlight
+  VERSION = '1.0.0'
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+module Floodlight
+  describe Configuration do
+    subject { Floodlight.configuration }
+
+    describe '#access_token' do
+      it 'sets value' do
+        subject.access_token = '1234'
+        expect(subject.access_token).to eq('1234')
+      end
+    end
+
+    describe '.configure' do
+      before do
+        Floodlight.configure do |config|
+          config.access_token = '4321'
+        end
+      end
+
+      it 'sets values' do
+        expect(subject.access_token).to eq('4321')
+      end
+    end
+  end
+end

data/spec/dummy/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/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/channels/application_cable/channel.rb

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

data/spec/dummy/app/channels/application_cable/connection.rb

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

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

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