tricle 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ab31c91268e7d383dbc8090108459f7359d9d94
-  data.tar.gz: 2408d69e0b97e949ff16e572eece95f8ceca80c0
+  metadata.gz: b642f05f1b01ca4cd31ea2686d60ef99e63d203a
+  data.tar.gz: c230338123cff716fa9951ec7a2973c059448df3
 SHA512:
-  metadata.gz: ef63f1335cb81ca70af935ae1e495b0a2f78c260f7ca7a02a232de3f059dc267b40505ff99d4f10d89fa704420154ae309f9f8ad253570321cc1e0caff5ee649
-  data.tar.gz: f2eadcb789c8caf60fa2a1446740646831898eea9f734856c03f1355844628ef46fefc3a10bd93c5e6669649a48111572571bd3a54bdb5df8e419b3999dc8145
+  metadata.gz: 2ca75aae8ba3b852f2983e4444ba970959586be2209c4dc08209c7a5a0b3910d97e6d0982a0251a7aa7bb7b259c8c886b0d9af8ff8d765a6b53b6ad069543a7b
+  data.tar.gz: 59a2a220783e513ee84e8d650d213779dbc16735bdbbd7920b386d926b0caa6ff232438989fdf5720410680f8680504ad1101aabe9f4e1ec8f98dc2f7b69c365

data/README.md

@@ -6,23 +6,29 @@ Automated metrics reporting via email.  It's datastore-agnostic, so you can quer
 
 ## Installation
 
-### Gem
-
 This gem can be used within an existing project (e.g. a Rails app), or standalone.
 
 ```ruby
 # Gemfile
 gem 'tricle', '~> 0.2.0'
 
+
 # Rakefile
+require 'your/tricle/subclasses'
 require 'tricle/tasks'
 
+
 # your/config/file.rb
+
 # unless you already have ActionMailer set up
 ActionMailer::Base.raise_delivery_errors = true
 ActionMailer::Base.smtp_settings = {
   # ...
 }
+
+# Optional: Override the start day of the reports (Rails >= 4.0.3 only)
+# http://api.rubyonrails.org/classes/Date.html#method-i-beginning_of_week-3D
+Date.beginning_of_week = :monday
 ```
 
 See [the ActionMailer guide](http://guides.rubyonrails.org/action_mailer_basics.html#action-mailer-configuration) for configuration details.  Finally, execute:
@@ -237,6 +243,21 @@ To set a speficic time zone, use the `TZ` environment variable (see the list [he
 TZ=UTC rake tricle:emails:send
 ```
 
-### Cron Setup
+### Heroku
+
+1. Deploy the application.
+    * If this is a standalone app, you won't need a `web` process.
+1. Enable an [add-on for email delivery](https://addons.heroku.com/?q=email%20deliver), and [configure](#installation) ActionMailer to send via that provider.
+1. Enable [Heroku Scheduler](https://devcenter.heroku.com/articles/scheduler).
+
+    ```bash
+    heroku addons:add scheduler:standard
+    heroku addons:open scheduler
+    ```
+
+1. Add a "job".
+    * For a report sent once per day, use the command from [Deploying](#deploying).
+    * For a report sent once per week, use `rake tricle:emails:send_after_beginning_of_week` daily.
+        * Heroku Scheduler only supports a maximum of daily tasks, hence needing to use a special task.
 
-TODO
+You can trigger the email(s) manually for testing with `heroku run rake tricle:emails:send`.

data/lib/tricle/mailer.rb

@@ -4,6 +4,7 @@ require 'premailer'
 
 require_relative 'email_helper'
 require_relative 'presenters/report'
+require_relative 'time'
 
 
 module Tricle
@@ -70,6 +71,15 @@ module Tricle
         end
         puts "Done."
       end
+
+      def send_all_if_beginning_of_week
+        time = Tricle::Time.new
+        if time.beginning_of_week?
+          self.send_all
+        else
+          puts "Skipping send, because it's not the beginning of the week."
+        end
+      end
     end
   end
 end

data/lib/tricle/metric.rb

@@ -10,7 +10,7 @@ module Tricle
     attr_reader :now, :options
 
     def initialize(opts = {})
-      @now = opts[:now] || Time.now
+      @now = Tricle::Time.new(opts[:now])
       @options = opts
     end
 

data/lib/tricle/tasks.rb

@@ -15,5 +15,11 @@ namespace :tricle do
     task :send do
       Tricle::Mailer.send_all
     end
+
+    # needed for Heroku Scheduler, whose most infrequent option is daily
+    desc "Send all emails, but only if it's the current day is the \"beginning of the week\". See http://api.rubyonrails.org/classes/Date.html#method-i-beginning_of_week-3D."
+    task :send_after_beginning_of_week do
+      Tricle::Mailer.send_all_if_beginning_of_week
+    end
   end
 end

data/lib/tricle/time.rb

@@ -0,0 +1,41 @@
+module Tricle
+  class Time
+    attr_reader :time
+
+    def initialize(time=nil)
+      @time = time || ::Time.now
+    end
+
+    def day_of_week
+      self.time.strftime('%A').downcase.to_sym
+    end
+
+    def beginning_of_week?
+      self.day_of_week == self.class.beginning_of_week
+    end
+
+    ## delegate methods ##
+
+    def beginning_of_day
+      self.time.beginning_of_day
+    end
+
+    def beginning_of_week
+      self.time.beginning_of_week
+    end
+
+    ######################
+
+    class << self
+      def beginning_of_week
+        if Date.respond_to?(:beginning_of_week)
+          # Rails >= 4.0.2
+          # http://apidock.com/rails/v4.0.2/Date/beginning_of_week/class
+          Date.beginning_of_week
+        else
+          :monday
+        end
+      end
+    end
+  end
+end

data/lib/tricle/version.rb

@@ -1,3 +1,3 @@
 module Tricle
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/config/timecop.rb

@@ -2,6 +2,7 @@ require 'timecop'
 
 def reset_time
   # need to freeze the time for the TestMetric
+  # 1AM, Thursday, August 1, 2013
   now = Time.new(2013, 8, 1, 1, 0, 0)
   Timecop.freeze(now)
 end

data/spec/unit/mailer_spec.rb

@@ -76,4 +76,17 @@ describe Tricle::Mailer do
       expect(ActionMailer::Base.deliveries.length).to eq(5)
     end
   end
+
+  describe '.send_all_if_beginning_of_week' do
+    it "shouldn't do anything if not the beginning of the week" do
+      expect(Tricle::Mailer).to_not receive(:send_all)
+      Tricle::Mailer.send_all_if_beginning_of_week
+    end
+
+    it "should send if it's the beginning of the week" do
+      Timecop.freeze(Time.now - 3.days) # Monday
+      expect(Tricle::Mailer).to receive(:send_all)
+      Tricle::Mailer.send_all_if_beginning_of_week
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tricle
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Aidan Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -129,6 +129,7 @@ files:
 - lib/tricle/templates/email.css
 - lib/tricle/templates/email.html.erb
 - lib/tricle/templates/email.text.erb
+- lib/tricle/time.rb
 - lib/tricle/version.rb
 - screenshot.png
 - spec/app/group_test_mailer.rb