trackster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27cab2948a9443ac659685991ea801550f993e7c
+  data.tar.gz: ecb4ae9ac507e98e3eeb4d3a896276b15ce91a51
+SHA512:
+  metadata.gz: a29654d4e609892bcbefba17bc2c8043705540af0ee4a46bc7f7abce87418522b9c7c8f9d3ccca5d279ead3cb398bf653ccebf66eda88b1832a51eaa1f02a334
+  data.tar.gz: e6194f5ecb2d699a5f1eca31b142a5638774ac370e6d61fb1df43081f8837a74b4740cf0a87ed3bfe03db7c6b8b9a588805f0dbd7aec8d2e92d670f8da9ce5d0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Rajbir Karan Singh
+
+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 @@
+# Trackster
+A lightweight plugin to record visits to supplied URL.
+This gem is written using Rails version 5.1.4 and Ruby version ruby 2.4.2p198.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trackster'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install trackster
+```
+
+Generate the pageviews table
+```bash
+$ rake db:migrate
+```
+
+Usage
+
+1. Create trackster.rb as follwing:
+```ruby
+  Trackster::Engine.setup do |config|
+    config.trackable_regex = ["/a+", "/a[a-z]+"] # Regular Expression match
+    config.trackable_urls = ["/tests"] # Full URL match
+    config.results_page_username = "hello" # Username for pageview list page
+    config.results_page_password = "world" # Password for pageview list page
+  end
+```
+
+2. Add following to you routes.rb
+```ruby 
+  mount Trackster::Engine => "/trackster" 
+```
+
+3. To enable Trackster to count pageview, add following to your ApplicationController:
+```ruby 
+  trackster
+```
+
+4. The url for pageview list page is "/trackster/pageviews"
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+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    = 'Trackster'
+  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 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/trackster_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/trackster .js
+//= link_directory ../stylesheets/trackster .css

data/app/assets/javascripts/trackster/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/app/assets/javascripts/trackster/pageviews.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/trackster/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/trackster/pageviews.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/trackster/pageviews_controller.rb

@@ -0,0 +1,20 @@
+class Trackster::PageviewsController < ApplicationController
+  before_action :authenticate
+  
+  def index
+    @pageviews = Pageview.select("url, count(*) as visits, visit_date").group(:url, :visit_date).order(:visit_date)
+    respond_to do |format|
+      format.html
+      format.csv { send_data @pageviews.to_csv }
+    end
+  end
+
+  protected
+
+  def authenticate
+    authenticate_or_request_with_http_basic do |username, password|
+      username == Trackster::Engine.results_page_username && password == Trackster::Engine.results_page_password
+    end
+  end
+
+end

data/app/controllers/trackster/trackster_controller.rb

@@ -0,0 +1,43 @@
+module Trackster
+  module TracksterController
+    
+    module ClassMethods
+      def trackster
+        before_action :trackster_count_visit
+      end
+    end
+
+    module InstanceMethods
+      def trackster_count_visit
+        begin
+          is_matched = false
+          request_path = request.path
+          trackable_urls = Trackster::Engine.trackable_urls
+          trackable_regex = Trackster::Engine.trackable_regex
+
+          trackable_regex.each do |url|
+            url_as_regex = /#{url}/
+            if url_as_regex.match(request_path)
+              pageview = Pageview.create!(url: url, visit_date: Date.today)
+              is_matched = true
+              break
+            end
+          end
+
+          if !is_matched
+            trackable_urls.each do |url|
+              if url == request_path
+                pageview = Pageview.create!(url: url, visit_date: Date.today)
+                break
+              end
+            end
+          end
+        
+        rescue Exception => ex
+          puts ex.message
+        end
+
+      end
+    end
+  end
+end

data/app/helpers/trackster/application_helper.rb

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

data/app/helpers/trackster/pageviews_helper.rb

@@ -0,0 +1,2 @@
+module Trackster::PageviewsHelper
+end

data/app/jobs/trackster/application_job.rb

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

data/app/mailers/trackster/application_mailer.rb

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

data/app/models/application_record.rb

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

data/app/models/pageview.rb

@@ -0,0 +1,15 @@
+class Pageview < ApplicationRecord
+  require 'csv'
+  validates_presence_of :url, :visit_date
+
+  def self.to_csv(options = {})
+    CSV.generate(options) do |csv|
+      csv << ["url", "visit counts", "date"]
+      all.each do |pageview|
+        csv << pageview.attributes.values_at("url", "visits", "visit_date")
+      end
+    end
+end
+
+
+end

data/app/models/trackster/application_record.rb

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

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Trackster</title>
+  <%= stylesheet_link_tag    "trackster/application", media: "all" %>
+  <%= javascript_include_tag "trackster/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/trackster/pageviews/index.html.erb

@@ -0,0 +1,24 @@
+<style>
+  table, th, td {
+    border: 1px solid black;
+    width: 400px;
+    border-collapse: collapse;
+  }
+</style>
+<table>
+  <tr>
+    <th>url</th>
+    <th>visit counts</th>
+    <th>date</th>
+  </tr>
+  <%@pageviews.each do |pageview|%>
+    <tr>
+      <td><%=pageview.url%></td>
+      <td><%=pageview.visits%></td>
+      <td><%=pageview.visit_date%></td>
+    </tr>
+  <%end%>
+</table>
+
+<br />
+<%= link_to "Download as CSV", "/trackster/pageviews.csv" %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Trackster::Engine.routes.draw do
+    get "/pageviews" => "trackster/pageviews#index", as: "trackster_pageviews_path"
+end

data/db/migrate/20171029023846_create_pageviews.rb

@@ -0,0 +1,9 @@
+class CreatePageviews < ActiveRecord::Migration[5.1]
+  def change
+    create_table :pageviews do |t|
+      t.string :url
+      t.date :visit_date
+      t.timestamps
+    end
+  end
+end

data/lib/tasks/trackster_tasks.rake

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

data/lib/trackster.rb

@@ -0,0 +1,5 @@
+require "trackster/engine"
+
+module Trackster
+  # Your code goes here...
+end

data/lib/trackster/engine.rb

@@ -0,0 +1,35 @@
+module Trackster
+  class Engine < ::Rails::Engine
+    #isolate_namespace Trackster
+
+    initializer 'trackster.controller' do
+
+      ActiveSupport.on_load(:action_controller) do
+       include TracksterController::InstanceMethods
+       extend TracksterController::ClassMethods
+     end
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    class << self
+      mattr_accessor :results_page_username, :results_page_password, :trackable_urls, :trackable_regex
+      self.results_page_username = "admin"
+      self.results_page_password = "password"
+      self.trackable_urls = ["/"]
+      self.trackable_regex = []
+    end
+
+    # this function maps the vars from app into engine
+    def self.setup
+      yield self
+    end
+
+  end
+end

data/lib/trackster/version.rb

@@ -0,0 +1,3 @@
+module Trackster
+  VERSION = '0.1.0'
+end

data/spec/controllers/trackster/pageviews_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe Trackster::PageviewsController, type: :controller do
+
+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/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link trackster_manifest.js

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);