track_rate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe55c59824483926030241646b4ed5e8dfbd6d29
+  data.tar.gz: dd91f47cd419d0834437e38970cc806e9a5017f5
+SHA512:
+  metadata.gz: f907b85395d00d2c261f024d2d9337583db62e536dcf02b824b0a852477b247768a03021b9fb2162630f32cf13234462c9ff00335b18c5b7cc41427e35049353
+  data.tar.gz: 192d49ff0a53a77a3c93a0caa5ef9a195387c954341ffffd766bf6a3010f215ce1b2e6a38494012eae6946d4f7f3fc62d253d10428679fc51c5e6e436f837974

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Craig Sheen
+
+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,47 @@
+# TrackRate
+Keep track of open/click rates
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'track_rate'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install track_rate
+```
+
+Add this to your `config/routes.rb`
+```ruby
+mount TrackRate::Engine, at: "/track_rate"
+```
+
+When you send you will need to add a call to track the send. When you do this pass the `tracking_object` for example an instance of user and a `service_key` for example `email`.
+```ruby
+TrackRate::ProcessSend.perform(user, service_key)
+```
+
+Finally set up your provider to make post requests when an event occurs.
+
+SendGrid: https://sendgrid.com/docs/API_Reference/Webhooks/event.html with webhook URL as `<www.mywebsite.com>/send_grid/open`
+
+## Currently supports
+
+### Email
+
+Using the `service_key` as `email`
+
+- SendGrid
+
+## Contributing
+PRs to track other providers welcome!
+
+## 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,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    = 'TrackRate'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/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/track_rate_manifest.js

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

data/app/assets/javascripts/track_rate/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/stylesheets/track_rate/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/controllers/track_rate/application_controller.rb

@@ -0,0 +1,9 @@
+module TrackRate
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+
+    def tracking_object
+      TrackRate.tracking_object
+    end
+  end
+end

data/app/controllers/track_rate/send_grids_controller.rb

@@ -0,0 +1,14 @@
+module TrackRate
+  class SendGridsController < ApplicationController
+    def open
+      tracking_object = tracking_class.find_by(sanitized_params[:email])
+      ProcessOpen.perform(tracking_object, 'email')
+    end
+
+    private
+
+    def sanitized_params
+      params.permit(:email)
+    end
+  end
+end

data/app/helpers/track_rate/application_helper.rb

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

data/app/jobs/track_rate/application_job.rb

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

data/app/mailers/track_rate/application_mailer.rb

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

data/app/models/track_rate/application_record.rb

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

data/app/models/track_rate/track_rate.rb

@@ -0,0 +1,14 @@
+module TrackRate
+  class TrackRate < ApplicationRecord
+    belongs_to :tracking_object, polymorphic: true
+
+    validates :tracking_service, presence: true
+
+    def self.for(object, service)
+      find_or_intialize_by(
+        tracking_object_type: object.class.name, tracking_object_id: object.id,
+        tracking_service: service
+      )
+    end
+  end
+end

data/app/services/process_open.rb

@@ -0,0 +1,31 @@
+module TrackRate
+  class ProcessOpen
+    def initialize(object, service)
+      self.object = object
+      self.service = service
+    end
+
+    def self.perform(object, service)
+      new.perform(object, service)
+    end
+
+    def perform
+      object.update_attributes(
+        open_count: new_open_count,
+        open_percent: new_open_percent
+      )
+    end
+
+    private
+
+    attr_reader :object, :service
+
+    def new_open_count
+      object.open_count + 1
+    end
+
+    def new_open_percent
+      (new_open_count / object.send_count) * 100
+    end
+  end
+end

data/app/services/process_send.rb

@@ -0,0 +1,31 @@
+module TrackRate
+  class ProcessSend
+    def initialize(object, service)
+      self.object = object
+      self.service = service
+    end
+
+    def self.perform(object, service)
+      new.perform(object, service)
+    end
+
+    def perform
+      object.update_attributes(
+        send_count: new_send_count,
+        open_percent: new_open_percent
+      )
+    end
+
+    private
+
+    attr_reader :object, :service
+
+    def new_send_count
+      object.send_count + 1
+    end
+
+    def new_open_percent
+      (object.open_count / new_send_count) * 100
+    end
+  end
+end

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

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

data/config/initializers/tracking_object.rb

@@ -0,0 +1,5 @@
+module TrackRate
+  def self.tracking_object
+    'User'
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+TrackRate::Engine.routes.draw do
+  namespace :send_grid do
+    post 'open' => 'send_grid#open'
+  end
+end

data/db/migrate/20171118031539_create_track_rate_track_rates.rb

@@ -0,0 +1,15 @@
+class CreateTrackRates < ActiveRecord::Migration
+  def change
+    create_table :track_rates do |t|
+      t.string :tracking_object_type
+      t.integer :tracking_object_id
+      t.string :tracking_service
+      t.integer :send_count, default: 0
+      t.integer :open_count, default: 0
+      t.integer :open_percent, default: 0
+      t.timestamps
+    end
+
+    add_index :track_rate, [:tracking_object_type, :tracking_object_id, :tracking_service]
+  end
+end

data/lib/tasks/track_rate_tasks.rake

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

data/lib/track_rate.rb

@@ -0,0 +1,5 @@
+require 'track_rate/engine'
+
+module TrackRate
+  # Your code goes here...
+end

data/lib/track_rate/engine.rb

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

data/lib/track_rate/version.rb

@@ -0,0 +1,3 @@
+module TrackRate
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: track_rate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Craig Sheen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Keep track of open/click rates
+email:
+- craig_sheen@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/track_rate_manifest.js
+- app/assets/javascripts/track_rate/application.js
+- app/assets/stylesheets/track_rate/application.css
+- app/controllers/track_rate/application_controller.rb
+- app/controllers/track_rate/send_grids_controller.rb
+- app/helpers/track_rate/application_helper.rb
+- app/jobs/track_rate/application_job.rb
+- app/mailers/track_rate/application_mailer.rb
+- app/models/track_rate/application_record.rb
+- app/models/track_rate/track_rate.rb
+- app/services/process_open.rb
+- app/services/process_send.rb
+- app/views/layouts/track_rate/application.html.erb
+- config/initializers/tracking_object.rb
+- config/routes.rb
+- db/migrate/20171118031539_create_track_rate_track_rates.rb
+- lib/tasks/track_rate_tasks.rake
+- lib/track_rate.rb
+- lib/track_rate/engine.rb
+- lib/track_rate/version.rb
+homepage: http://github.com/craigsheen/track_rate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Track usage rates
+test_files: []