msg 0.1.0

data/app/views/msg/sendings/show.html.haml

@@ -0,0 +1,50 @@
+#sending
+
+  
+  - if envelope = @sending.envelopes.first
+    .envelope
+      .headers
+        %p
+          %span.field
+            = t(:subject).titlecase + ":"
+          %strong
+            = envelope.subject
+        %p
+          %span.field
+            = t(:to).titlecase + ":"
+          %strong
+            = envelope.to_address
+        %p
+          %span.field
+            = t(:from).titlecase + ":"
+          %strong
+            = envelope.from_address
+        %p
+          %span.field
+            = t(:sent_at).titlecase + ":"
+          %strong
+            = l(@sending.created_at, :format => :natural_with_date)
+      %iframe.body{:src => msg.review_sending_url(@sending)}
+    
+
+
+-content_for :title do
+  = t :sent_message
+
+-content_for :margin do
+  #receivers
+    %p
+      - if @sending.receiving_group
+        = t(:sent_to)
+        = t("msg.groups.#{@sending.receiving_group}")
+        = t(:receiver_count, :count => @sending.envelopes.count)
+      - else
+        = t(:sent)
+      = t(:at)
+      = l(@sending.created_at, :format => :natural_with_date)
+
+    %span.pie{:data => {:diameter => 50}}<
+      = @sending.statistics.join(',')
+  
+    %ul.envelopes
+      = render :partial => "msg/envelopes/listing", :collection => @sending.envelopes

data/app/views/msg/shared/_toolbar.html.haml

@@ -0,0 +1,17 @@
+%header
+  %ul.commands
+    %li.command{:"data-wysihtml5-command" => "bold"}
+    %li.command{:"data-wysihtml5-command" => "italic"}
+    %li.command{:"data-wysihtml5-command" => "insertUnorderedList"}
+    %li.command{:"data-wysihtml5-command" => "insertOrderedList"}
+    %li.command{:"data-wysihtml5-command" => "createLink"}
+    %li.command{:"data-wysihtml5-command" => "formatBlock", :"data-wysihtml5-command-value" => "h1"}
+    %li.command{:"data-wysihtml5-command" => "formatBlock", :"data-wysihtml5-command-value" => "h2"}
+    %li.command{:"data-wysihtml5-action" => "change_view"}
+
+%div{:"data-wysihtml5-dialog" => "createLink", :style => "display: none"}
+  %label
+    Link:
+    %input{:type => "text", :"data-wysihtml5-dialog-field" => "href", :value => "http://"}
+    %a{:"data-wysihtml5-dialog-action" => "save"} OK
+    %a{:"data-wysihtml5-dialog-action" => "cancel"} cancel

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/locales/en.yml

@@ -0,0 +1,76 @@
+en:
+  activerecord:
+    attributes:
+      msg:
+        message:
+          saved: "Save this message for reuse"
+    errors:
+      msg:
+  from: "From"
+  bounce_report: "Bounces"
+  close: "close"
+  create_message: "send or save a new message"
+  sent_report: "Sent messages"
+  messages: "Messages"
+  please_set_layout: "You probably want to set Msg.layout (in an initializer) so that msg uses your application layout and not this default file."
+  confirm_delete_message: "Are you sure you want to delete the message '%{subject}? This cannot be undone."
+  edit_message: "edit message"
+  from: "From"
+  message_subject: "Subject"
+  message_body: "Body"
+  message_description: "Description (for your reference: does not appear in message)"
+  message_subject: "Subject"
+  message_function: "Function"
+  message_from_address: "Sender email address"
+  message_from_name: "Sender name"
+  message_from_note: "Leave both address fields blank to use the default"
+  receiver_count:
+    zero: "(nobody)"
+    one: "(one person)"
+    other: "(%{count} people)"
+  save_message: "Save message"
+  save_and_preview: "Save and preview"
+  send_message: "send message"
+  send_the_message: "Send the message"
+  preview_message: "preview message"
+  preview_and_send: "preview and send"
+  delete_message: "delete message"
+  transactional_messages: "Administrative messages"
+  saved_messages: "Saved messages"
+  send_this_message: "Send this message"
+  sent_at: "Sent at"
+  sent_messages: "Sent box"
+  sent_message: "Sent message"
+  subject: "Subject"
+  more_detail: "More detail"
+  to: "To"
+  save_for_reuse: "Save this message for reuse"
+  saved_note: "'Saving' the message adds it to the main message list, making it easier to send again. Unsaved messages can still be found in the sent box and resent from there."
+  sender: "Sender's name and address"
+  send_to: "Send to"
+  sent_to: "Sent to"
+  sent_to_count:
+    zero: "Sent to nobody"
+    one: "Sent to one person"
+    other: "Sent to %{count} people"
+  sent_count: "Sent: %{count}"
+  opened_count: "Opened: %{count}"
+  bounced_count: "Bounced: %{count}"
+  transactional_message: "Transactional message"
+  transactional_message_note: "You probably don't want to change this."
+  date:
+    formats:
+      dashed_short_date_format: "%d-%m-%Y"
+      month_header: "%B %Y"
+      natural: "%d %B"
+      natural_full: "%l:%M%P, %d %B %Y"
+      natural_with_year: "%d %B %Y"
+      minimal_with_year: "%d %b %Y"
+      year: "%Y"
+      month: "%B %Y"
+  time:
+    formats:
+      natural: "%l:%M%P"
+      natural_with_date: "%l:%M%P, %d %B %Y"
+      precise: "%H:%M:%S"
+      month_and_year: "%b %Y"

data/config/routes.rb

@@ -0,0 +1,26 @@
+Msg::Engine.routes.draw do
+
+  resources :messages do
+    resources :sendings, :only => [:new, :create]
+    member do
+      get :preview
+    end
+    collection do
+      get :transactional
+      get :saved
+    end
+  end
+
+  resources :sendings do
+    member do
+      get :review
+    end
+  end
+
+  # envelopes#show is pinged when a message is opened
+  resources :envelopes, :only => [:show]
+
+  # bounces#create is called from the email receiver
+  resources :bounces, :only => [:create]
+
+end

data/db/migrate/20130320141926_msg_data.rb

@@ -0,0 +1,54 @@
+class MsgData < ActiveRecord::Migration
+  def change
+    create_table :msg_messages do |t|
+      t.string :subject
+      t.string :from_address
+      t.string :from_name
+      t.text :body
+      t.string :function
+      t.text :description
+      t.boolean :transactional, :default => false
+      t.boolean :saved, :default => false
+      t.integer :created_by_id
+      t.timestamps
+    end
+
+    create_table :msg_sendings do |t|
+      t.integer :message_id
+      t.integer :created_by_id
+      t.datetime :sent_at
+      t.timestamps
+    end
+    add_index :msg_sendings, :message_id
+    add_index :msg_sendings, :created_by_id
+    
+    create_table :msg_envelopes do |t|
+      t.integer :sending_id
+      t.integer :receiver_id
+      t.integer :email_id
+      t.string :receiver_type
+      t.string :to_address
+      t.string :from_address
+      t.string :subject
+      t.text :contents
+      t.datetime :sent_at
+      t.datetime :opened_at
+      t.timestamps
+    end
+    add_index :msg_envelopes, :sending_id
+    add_index :msg_envelopes, :email_id
+    add_index :msg_envelopes, :receiver_id
+    add_index :msg_envelopes, [:receiver_id, :receiver_type]
+    
+    create_table :msg_bounces do |t|
+      t.integer :envelope_id
+      t.string :bounce_type
+      t.string :bounce_subtype
+      t.string :reporter
+      t.text :raw_message
+      t.timestamps
+    end
+    add_index :msg_bounces, :envelope_id
+    
+  end
+end

data/db/migrate/20130327134754_sending_circumstances.rb

@@ -0,0 +1,6 @@
+class SendingCircumstances < ActiveRecord::Migration
+  def change
+    add_column :msg_sendings, :receiving_class, :string
+    add_column :msg_sendings, :receiving_group, :string
+  end
+end

data/lib/msg.rb

@@ -0,0 +1,88 @@
+require "msg/receivers"
+require "msg/engine"
+
+module Msg
+  mattr_accessor :user_class,
+                 :layout,
+                 :email_layout,
+                 :default_from_address,
+                 :default_from_name,
+                 :email_bcc,
+                 :email_values,
+                 :messaging_groups,
+                 :receiving_classes,
+                 :sanitized_allowed_tags,
+                 :sanitized_allowed_attributes,
+                 :sending_domain,
+                 :ses_access_key_id,
+                 :ses_secret_access_key
+
+  class MsgError < StandardError; end
+  class EmailInvalid < MsgError; end
+
+
+  class << self
+
+    def setup
+      yield self
+    end
+
+    def layout
+      @@user_class ||= "User"
+    end
+
+    def layout
+      @@layout ||= "msg/default"
+    end
+
+    def email_layout
+      @@email_layout ||= "msg/email"
+    end
+
+    def default_from_address
+      @@default_from_address ||= "please_configure_email_in_msg_initializer@example.com"
+    end
+
+    def default_from_name
+      @@default_from_name ||= "Someone Unknown"
+    end
+
+    def default_from
+      "#{default_from_name} <#{default_from_address}>"
+    end
+
+    def email_values
+      @@email_values ||= {}
+    end
+
+    def receiving_classes
+      @@receiving_classes ||= []
+    end
+
+    def tags_allowed_in_email
+      @@permitted_tags ||= ActionView::Base.sanitized_allowed_tags
+    end
+
+    def attributes_allowed_in_email
+      @@permitted_attributes ||= ActionView::Base.sanitized_allowed_attributes
+    end
+
+    def sending_domain
+      @@sending_domain ||= ActionMailer::Base.default_url_options[:host]
+    end
+
+
+
+
+
+    def add_receiving_class(klass, options)
+      Rails.logger.warn ">>> Msg.add_receiving_class #{klass}"
+      
+      k = klass.to_s
+      receiving_classes << k unless receiving_classes.include?(k)
+      klass.messaging_groups = options[:groups] || []
+      Msg::Sending.add_receiver_hooks(klass, options)
+    end
+
+  end
+end

data/lib/msg/engine.rb

@@ -0,0 +1,23 @@
+module Msg
+  class Engine < ::Rails::Engine
+    isolate_namespace Msg
+
+    initializer "msg.integration" do |app|
+      ActiveSupport.on_load :action_controller do
+        helper Msg::MsgHelper
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+      g.fixture_replacement :factory_girl
+      g.assets false
+      g.helper false
+    end
+
+    config.to_prepare do
+      ActiveRecord::Base.send :include, Msg::Receivers
+    end
+
+  end
+end

data/lib/msg/receivers.rb

@@ -0,0 +1,64 @@
+# Msg::Receivers is for inclusion into ActiveRecord::Base...
+
+module Msg
+  module Receivers
+    def self.included(base)
+      base.extend ActiveRecordClassMethods
+    end
+  end
+  
+  module ActiveRecordClassMethods
+    # +receives_messages+ ...
+    
+    def receives_messages(options={})
+      include ReceiverInstanceMethods
+      has_many :envelopes, :as => :receiver, :class_name => "Msg::Envelope"
+      Msg.add_receiving_class(self, options)
+    end
+    
+    # Messaging groups are usually defined by passing a :groups parameter to `receives_messages`, 
+    # but you can also override the messaging_groups methods if that's easier.
+    #
+    def messaging_groups
+      Thread.current["messaging_groups_#{self.to_s.underscore}"]  ||= []
+      # @messaging_groups ||= []
+    end
+    
+    # Messaging groups are always held as a hash of name => lambda { retrieval action }, and in a complex
+    # case they can be passed in that form. If all the groups correspond to scopes on the receiving class,
+    # you can alternatively supply a list of scope names. It will be expanded to simple lambdas here.
+    #
+    #   receives_messages :groups => [:scope_name, :other_scope_name]
+    #
+    
+    def messaging_groups=(groups)
+      if groups.is_a?(Array)
+        groups = groups.each_with_object({}) do |grp, hash|
+          hash[grp] = lambda { self.send grp }
+        end
+      end
+      Thread.current["messaging_groups_#{self.to_s.underscore}"] = groups
+    end
+    
+    def messaging_group(name)
+      if definition = messaging_groups(name)
+        definition.call()
+      else
+        self.send name
+      end
+    end
+    
+  end
+  
+  module ReceiverInstanceMethods
+    
+    
+    
+  end
+end
+
+
+
+
+
+

data/lib/msg/version.rb

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

data/lib/tasks/cucumber.rake

@@ -0,0 +1,65 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
+  task 'test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end