reparty 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+.idea
+*.tmproj
+*.tmproject
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+tmp
+test.db

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--tag ~letteropener:true

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@reparty --create

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in reparty.gemspec
+gemspec

data/History.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 timdorr
+
+MIT License
+
+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,32 @@
+# Reparty [![Build Status](https://travis-ci.org/timdorr/reparty.png?branch=master)](https://travis-ci.org/timdorr/reparty) [![Dependency Status](https://gemnasium.com/timdorr/reparty.png)](https://gemnasium.com/timdorr/reparty) [![Code Climate](https://codeclimate.com/github/timdorr/reparty.png)](https://codeclimate.com/github/timdorr/reparty)
+
+__A business analytics reporting party!__
+
+Although initially concentrating on a daily email report, Reparty intends to be an easy 
+tool for building dashboards and reports focused on business analytics about your app. 
+
+Planned reporting modules include:
+
+* ActiveRecord, including arbitrary sum/count columns
+* Google Analytics/MixPanel/Gaug.es/etc etc
+* Stripe
+* Twitter
+
+## Configuration
+
+Whilst not completely done, this is how you'll configure it for emailing a daily user count in the near future.
+
+    Reparty.config do |config|
+      config.from = "test@test.com"
+      config.subject = "SalesLoft JCA Daily Report"
+    
+      config.add_report Reparty::Report::ActiveRecord, "New User Signups", :user
+    end
+
+## Usage
+
+Generating an email is as simple as a rake task:
+
+    rake reparty:email[someone@somewhere.com]
+
+You can run this in a cron job or other scheduling system.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/mailers/report_mailer.rb

@@ -0,0 +1,16 @@
+ActionMailer::Base.view_paths = File.expand_path('../../views/', __FILE__)
+
+class ReportMailer < ActionMailer::Base
+  def daily(to)
+
+    @reports = Reparty::Email.reports
+    @reports.each {|r| r.attach(attachments)}
+    attachments.inline['spacer.gif'] = File.read(Reparty.root + 'app/assets/images/spacer.gif')
+
+    mail(
+        from: Reparty::Email.from,
+        to: to,
+        subject: Reparty::Email.subject
+    )
+  end
+end

data/app/views/report_mailer/_active_record.html.erb

@@ -0,0 +1,9 @@
+<table width="500">
+  <tr>
+    <td align="left"><h3 style="margin:0"><%= report.title %></h3></td>
+    <td align="right">Total <%= report.model.to_s.pluralize %>: <%= number_with_delimiter(report.total) %></td>
+  </tr>
+  <tr>
+    <td colspan="2"><%= image_tag attachments["#{report.hash}.png"].url, align: "center" %></td>
+  </tr>
+</table>

data/app/views/report_mailer/daily.html.erb

@@ -0,0 +1,20 @@
+<html lang="en" xmlns="http://www.w3.org/1999/html" xmlns="http://www.w3.org/1999/html">
+<head>
+  <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+  <style type="text/css">
+    body { font-family: Helvetica, Arial, sans-serif; }
+  </style>
+</head>
+<body>
+<table cellpadding="0" cellspacing="0" border="0" align="center" width="600">
+  <tr>
+    <td><h1>Your Daily Report:</h1></td>
+  </tr>
+  <% @reports.each do |report| -%>
+    <tr><td>
+    <%= render partial: report.class.name.demodulize.underscore, locals:{report:report} %>
+    </td></tr>
+  <% end -%>
+</table>
+</body>
+</html>

data/lib/reparty/config.rb

@@ -0,0 +1,16 @@
+require "ostruct"
+
+module Reparty
+  class Config < ::OpenStruct
+    attr_reader :reports
+
+    def initialize
+      @reports = []
+      super
+    end
+
+    def add_report(report, *args, &block)
+      @reports << report.new(*args, &block)
+    end
+  end
+end

data/lib/reparty/email.rb

@@ -0,0 +1,17 @@
+module Reparty
+  class Email
+    class << self
+      def reports
+        Reparty.reports
+      end
+
+      def from
+        Reparty.configuration.from || 'nobody@nowhere.com'
+      end
+
+      def subject
+        Reparty.configuration.subject || "Reparty Report!"
+      end
+    end
+  end
+end

data/lib/reparty/engine.rb

@@ -0,0 +1,7 @@
+require 'rails'
+
+module Reparty
+  class Engine < ::Rails::Engine
+    isolate_namespace Reparty
+  end
+end

data/lib/reparty/railties.rb

@@ -0,0 +1,7 @@
+module Reparty
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/reparty.rake"
+    end
+  end
+end

data/lib/reparty/report/active_record.rb

@@ -0,0 +1,37 @@
+module Reparty
+  class Report
+    class ActiveRecord < Report
+      attr_reader :model, :operation, :field
+
+      def initialize(*args, &block)
+        super(args.shift)
+
+        raise "Report::ActiveRecord: model undefined" unless args.first.is_a?(Symbol)
+        @model = Kernel.const_get(args.first.to_s.capitalize)
+
+        @operation = args.fetch(2, :count)
+        @field = :created_at
+
+        if args.last.is_a?(Hash)
+          @field = args.last.fetch(:field, @field)
+        end
+      end
+
+      def attach(attachments)
+        @graph = build_daily_graph
+
+        @graph.data(@model.to_s.pluralize, daily_dataset)
+
+        attachments.inline["#{self.hash}.png"] = @graph.to_blob
+      end
+
+      def daily_dataset
+        7.downto(1).map { |x| @model.where("DATE(#{@field.to_s}) = ?", (DateTime.now.at_midnight-x).strftime('%Y-%m-%d')).send(@operation, @field) }
+      end
+
+      def total
+        @model.send(@operation, @field)
+      end
+    end
+  end
+end

data/lib/reparty/report.rb

@@ -0,0 +1,25 @@
+require 'gruff'
+
+module Reparty
+  class Report
+    attr_reader :title
+
+    def initialize(title)
+      raise "Report: title must be defined" if title.blank?
+      @title = title
+    end
+
+    def attach(attachments)
+      # Optional
+    end
+
+    protected
+
+    def build_daily_graph
+      g = Gruff::Line.new(500)
+      g.title = @title
+      g.labels = Hash[*(1..7).map{|x| [x-1, (DateTime.now - (8-x)).strftime("%-m/%-d")] }.flatten]
+      g
+    end
+  end
+end

data/lib/reparty/version.rb

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

data/lib/reparty.rb

@@ -0,0 +1,28 @@
+require "reparty/version"
+
+require "reparty/config"
+require "reparty/report"
+require "reparty/report/active_record"
+require "reparty/email"
+
+require "reparty/engine"
+require "reparty/railties"
+
+module Reparty
+  class << self
+    def root
+      Pathname.new(File.expand_path('../..', __FILE__))
+    end
+
+    attr_accessor :configuration
+    attr_reader :reports
+
+    def config
+      self.configuration = Config.new
+
+      yield(configuration)
+
+      @reports = self.configuration.reports
+    end
+  end
+end

data/lib/tasks/reparty.rake

@@ -0,0 +1,11 @@
+namespace :reparty do
+  desc 'Generate the email to be sent'
+  task :email, [:address] => :environment do |t,args|
+    unless args.address
+      puts "Error: An address is required."
+      next
+    end
+
+    ReportMailer.daily(args.address).deliver
+  end
+end

data/reparty.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reparty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "reparty"
+  spec.version       = Reparty::VERSION
+  spec.authors       = ["Tim Dorr"]
+  spec.email         = ["reparty@timdorr.com"]
+  spec.description   = %q{Stupid easy business analytics}
+  spec.summary       = %q{Stupid easy business analytics}
+  spec.homepage      = "https://github.com/timdorr/reparty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", "~> 3.2"
+  spec.add_dependency "actionmailer", "~> 3.2"
+  spec.add_dependency "activerecord", "~> 3.2"
+  spec.add_dependency "rmagick"
+  spec.add_dependency "gruff"
+  spec.add_dependency "roadie"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "letter_opener"
+end

data/spec/reparty_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Reparty do
+  it 'should have a version number' do
+    Reparty::VERSION.should_not be_nil
+  end
+
+  it 'configures properly' do
+    Reparty.config do |config|
+      config.sender = 'test@test.com'
+    end
+    Reparty.configuration.sender.should == 'test@test.com'
+  end
+
+  it 'adds reports' do
+    Reparty.config do |config|
+      config.add_report Reparty::Report, "Some Report"
+    end
+    Reparty.reports.first.should be_kind_of(Reparty::Report)
+    Reparty.reports.first.title.should == "Some Report"
+  end
+end

data/spec/report/active_record_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../spec_helper'
+
+describe "Reparty::Report::ActiveRecord" do
+  before(:each) do
+    User.delete_all
+  end
+
+  it 'configures cleanly' do
+    Reparty.config do |config|
+      config.add_report Reparty::Report::ActiveRecord, "Users", :user, :count, field: :updated_at
+    end
+    Reparty.reports.last.should be_kind_of(Reparty::Report::ActiveRecord)
+    Reparty.reports.last.field.should == :updated_at
+  end
+end

data/spec/report_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Reparty::Report do
+  it "requires a title" do
+    expect {
+      Reparty::Report.new("title!")
+    }.to_not raise_exception
+
+    expect {
+      Reparty::Report.new(nil)
+    }.to raise_exception
+
+    expect {
+      Reparty::Report.new("")
+    }.to raise_exception
+  end
+
+  it "has an attach method" do
+    expect {
+      Reparty::Report.new("title!").attach(nil)
+    }.to_not raise_exception
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'reparty'
+
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+require 'action_mailer'
+ActionMailer::Base.delivery_method = :test
+
+require 'sqlite3'
+require 'active_record'
+
+ActiveRecord::Base.default_timezone = :utc
+ActiveRecord::Base.time_zone_aware_attributes = true
+
+class User < ActiveRecord::Base
+end
+
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => 'test.db'
+)
+
+unless ActiveRecord::Base.connection.table_exists? "users"
+  ActiveRecord::Migration.create_table :users do |t|
+    t.string :name
+    t.integer :score
+    t.timestamps
+  end
+end

data/spec/support/shared_contexts/rake.rb

@@ -0,0 +1,18 @@
+require "rake"
+
+shared_context "rake" do
+  let(:rake)      { Rake::Application.new }
+  let(:task_name) { self.class.top_level_description }
+  let(:task_path) { "lib/tasks/#{task_name.split(":").first}" }
+  subject         { rake[task_name] }
+
+  def exclude_current_task
+    $".reject {|file| file == Reparty.root.join("#{task_path}.rake").to_s }
+  end
+
+  before do
+    Rake.application = rake
+    Rake.application.rake_require(task_path, [Reparty.root], exclude_current_task)
+    Rake::Task.define_task(:environment)
+  end
+end

data/spec/tasks/reparty_task_spec.rb

@@ -0,0 +1,46 @@
+require_relative '../spec_helper'
+require 'action_mailer'
+require_relative '../../app/mailers/report_mailer'
+
+describe "reparty:email" do
+  include_context "rake"
+
+  before(:each) do
+    User.delete_all
+
+    Reparty.config do |config|
+      config.add_report Reparty::Report::ActiveRecord, "New User Signups", :user
+    end
+  end
+
+  its(:prerequisites) { should include("environment") }
+
+  it "requires an address" do
+    STDOUT.should_receive(:puts)
+    subject.invoke
+  end
+
+  it "should generate an email" do
+    expect{
+      subject.invoke("test@test.com")
+    }.to change(ActionMailer::Base, :deliveries)
+  end
+
+  it "should send out via letter_opener", letteropener: true do
+    require 'letter_opener'
+    ActionMailer::Base.add_delivery_method :letter_opener, LetterOpener::DeliveryMethod, :location => File.expand_path('../../../tmp/letter_opener', __FILE__)
+    ActionMailer::Base.delivery_method = :letter_opener
+
+    [
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 2},
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 2},
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 4},
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 5},
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 6},
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 7},
+        {:name => "Someone", :score => 1, :created_at => DateTime.now - 8},
+    ].each{|u| User.create!(u) }
+
+    subject.invoke("test@test.com")
+  end
+end

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: reparty
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Dorr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: gruff
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: roadie
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: letter_opener
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Stupid easy business analytics
+email:
+- reparty@timdorr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- History.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/images/spacer.gif
+- app/mailers/report_mailer.rb
+- app/views/report_mailer/_active_record.html.erb
+- app/views/report_mailer/daily.html.erb
+- lib/reparty.rb
+- lib/reparty/config.rb
+- lib/reparty/email.rb
+- lib/reparty/engine.rb
+- lib/reparty/railties.rb
+- lib/reparty/report.rb
+- lib/reparty/report/active_record.rb
+- lib/reparty/version.rb
+- lib/tasks/reparty.rake
+- reparty.gemspec
+- spec/reparty_spec.rb
+- spec/report/active_record_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_contexts/rake.rb
+- spec/tasks/reparty_task_spec.rb
+homepage: https://github.com/timdorr/reparty
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3863277872832140931
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 3863277872832140931
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Stupid easy business analytics
+test_files:
+- spec/reparty_spec.rb
+- spec/report/active_record_spec.rb
+- spec/report_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_contexts/rake.rb
+- spec/tasks/reparty_task_spec.rb