mail-control 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caaf2a07f4cecd59194d9daf3e6d0e04ee9dedf7
-  data.tar.gz: 4c943c088a90bd54ad7e7f3ae62eaf943325ebce
+  metadata.gz: 28eec123b42a400284f71afc92e989d4f2877ea3
+  data.tar.gz: 6d766275023a1500be441f65cc9d2f54d5bb9265
 SHA512:
-  metadata.gz: 776a0118e140c9692d61cb15b728a04b932697ac4091606fa537ae61eb097792140ebc12c11a6044dc990ecbc80d26d5b37b7d67d2a102ec4b4798bcd2f79663
-  data.tar.gz: 219ff9a4a205aea11a8144ea63164b575405dae75347dfb41275d7dae6a41a123dcd5889ce71446405b97063834500ac9e3710285964a9cfae137c399d1f6344
+  metadata.gz: 4a6491f83866a569a8fc84686ce88fd5eafdacab1f530755a0e3283f7bedb65b9cdc2cd69b6ad14661f85b407467a4964e29e1b08dd4ce37d2c5593a90659f74
+  data.tar.gz: a57e599e6528aa33a559c90f9505b8ce306d2894be50f2e380b0ae6bc1795dc3c43d19b1a294ff0c1490fc4873b52de09197ba751f6b7b5823282357c41b8242

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.1.1
+
+* Add license to gemspec
+
 ## 0.1.0
 
 First version of gem

data/README.md

@@ -16,21 +16,21 @@ This gem is inspired by Streama by Christopher Pappas.
 ### Create migration for logged_emails and migrate the database (in your Rails project):
 
 ```ruby
-rails g mail-control:migration
+rails g mail_control:migration
 rake db:migrate
 ```
 
 ### Define Queued Task
 
-Create an LoggedEmail model and define the logged_emails and the fields you would like to cache within the queued_task.
+Create an LoggedEmail model and define the logged_emails and the fields you would like to cache within the mailing.
 
-An queued_task consists of an actor, a verb, an act_object, and a target.
+An mailing consists of an actor, a verb, an act_object, and a target.
 
 ``` ruby
 class LoggedEmail < ActiveRecord::Base
   include MailControl::LoggedEmail
 
-  queued_task :new_enquiry do
+  mailing :new_enquiry do
     actor        :User
     act_object   :Article
     act_target   :Volume
@@ -38,9 +38,9 @@ class LoggedEmail < ActiveRecord::Base
 end
 ```
 
-The queued_task verb is implied from the queued_task name, in the above example the verb is :new_enquiry
+The mailing verb is implied from the mailing name, in the above example the verb is :new_enquiry
 
-The act_object may be the entity performing the queued_task, or the entity on which the queued_task was performed.
+The act_object may be the entity performing the mailing, or the entity on which the mailing was performed.
 e.g John(actor) shared a video(act_object)
 
 The target is the act_object that the verb is enacted on.
@@ -69,18 +69,18 @@ In your controller or background worker:
 current_user.send_email(:new_enquiry, :act_object => @enquiry, :target => @listing)
 ```
   
-This will publish the queued_task to the mongoid act_objects returned by the #followers method in the Actor.
+This will publish the mailing to the mongoid act_objects returned by the #followers method in the Actor.
 
 
 ## Retrieving LoggedEmail
 
-To retrieve all queued_task for an actor
+To retrieve all mailing for an actor
 
 ``` ruby
 current_user.logged_emails
 ```
   
-To retrieve and filter to a particular queued_task type
+To retrieve and filter to a particular mailing type
 
 ``` ruby
 current_user.logged_emails(:verb => 'new_enquiry')
@@ -94,7 +94,7 @@ Additional options can be required:
 class LoggedEmail < ActiveRecord::Base
   include MailControl::LoggedEmail
 
-  queued_task :new_enquiry do
+  mailing :new_enquiry do
     actor        :User
     act_object   :Article
     act_target   :Volume
@@ -110,13 +110,13 @@ The option fields are stored using the ActiveRecord 'store' feature.
 #### Bond type
 
 A verb can have one bond type. This bond type can be used to classify and quickly retrieve
-queued_task feed items that belong to a particular aggregate feed, like e.g the global feed.
+mailing feed items that belong to a particular aggregate feed, like e.g the global feed.
 
 ``` ruby
 class LoggedEmail < ActiveRecord::Base
   include MailControl::LoggedEmail
 
-  queued_task :new_enquiry do
+  mailing :new_enquiry do
     actor        :User
     act_object   :Article
     act_target   :Volume

data/lib/generators/{mail-control.rb → mail_control.rb}

@@ -7,7 +7,7 @@ module MailControl
     module Base
       # Get path for migration template
       def source_root
-        @_mail_control_source_root ||= File.expand_path(File.join('../mail-control', generator_name, 'templates'), __FILE__)
+        @_mail_control_source_root ||= File.expand_path(File.join('../mail_control', generator_name, 'templates'), __FILE__)
       end
     end
   end

data/lib/generators/{mail-control/activity → mail_control/logged_email}/activity_generator.rb

@@ -1,9 +1,9 @@
-require 'generators/mail-control'
+require 'generators/mail_control'
 require 'rails/generators/active_record'
 
 module MailControl
   module Generators
-    # LoggedEmail generator that creates queued_task model file from template
+    # LoggedEmail generator that creates mailing model file from template
     class LoggedEmailGenerator < ActiveRecord::Generators::Base
       extend Base
 

data/lib/generators/{mail-control → mail_control}/migration/migration_generator.rb

@@ -1,7 +1,7 @@
-require 'generators/mail-control'
+require 'generators/mail_control'
 require 'rails/generators/active_record'
 
-module LiveStream
+module MailControl
   module Generators
     # Migration generator that creates migration file from template
     class MigrationGenerator < ActiveRecord::Generators::Base

data/lib/mail-control/actor.rb

@@ -4,7 +4,7 @@ module MailControl
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :queued_task_klass
+      cattr_accessor :mailing_klass
 
       has_many :logged_emails,             :class_name => "LoggedEmail", :as => :actor
       has_many :act_object_logged_emails,  :class_name => "LoggedEmail", :as => :act_object
@@ -16,17 +16,17 @@ module MailControl
     module ClassMethods
 
       def mail_control_class(klass)
-        self.queued_task_klass = klass.to_s
+        self.mailing_klass = klass.to_s
       end
 
     end
 
 
-    # Publishes the queued_task to the receivers
+    # Publishes the mailing to the receivers
     #
     # @param [ Hash ] options The options to publish with.
     #
-    # @example publish an queued_task with a act_object and act_target
+    # @example publish an mailing with a act_object and act_target
     #   current_user.send_email(:enquiry, :act_object => @enquiry, :act_target => @listing)
     #
     def send_email(name, options={})
@@ -40,7 +40,7 @@ module MailControl
     end
 
     def mail_control_class
-      @queued_task_klass ||= queued_task_klass ? queued_task_klass.classify.constantize : ::LoggedEmail
+      @mailing_klass ||= mailing_klass ? mailing_klass.classify.constantize : ::LoggedEmail
     end
 
     def actor_logged_emails(options = {})

data/lib/mail-control/logged_email.rb

@@ -42,26 +42,26 @@ module MailControl
 
       # Defines a new LoggedEmail2 type and registers a definition
       #
-      # @param [ String ] name The name of the queued_task
+      # @param [ String ] name The name of the mailing
       #
-      # @example Define a new queued_task
-      #   queued_task(:enquiry) do
+      # @example Define a new mailing
+      #   mailing(:enquiry) do
       #     actor :user, :cache => [:full_name]
       #     act_object :enquiry, :cache => [:subject]
       #     act_target :listing, :cache => [:title]
       #   end
       #
       # @return [Definition] Returns the registered definition
-      def queued_task(name, &block)
+      def mailing(name, &block)
         definition = MailControl::DefinitionDSL.new(name)
         definition.instance_eval(&block)
         MailControl::Definition.register(definition)
       end
 
-      # Publishes an queued_task using an queued_task name and data
+      # Publishes an mailing using an mailing name and data
       #
-      # @param [ String ] verb The verb of the queued_task
-      # @param [ Hash ] data The data to initialize the queued_task with.
+      # @param [ String ] verb The verb of the mailing
+      # @param [ Hash ] data The data to initialize the mailing with.
       #
       # @return [MailControl::LoggedEmail2] An LoggedEmail instance with data
       def send_email(verb, data)
@@ -72,7 +72,7 @@ module MailControl
 
 
 
-    # Publishes the queued_task to the receivers
+    # Publishes the mailing to the receivers
     #
     # @param [ Hash ] options The options to send_email with.
     #

data/lib/mail-control/version.rb

@@ -1,3 +1,3 @@
 module MailControl
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/mail-control.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{LoggedEmail Streams for rails}
   s.description = %q{MailControl is a simple gem for giving both your app and users control over when, if and how emails are sent out.}
   s.homepage    = 'https://github.com/digitalplaywright/mail-control'
+  s.license     = 'MIT'
 
   s.rubyforge_project = "mail-control"
 

data/test/test_helper.rb

@@ -26,7 +26,7 @@ end
 class LoggedEmail < ActiveRecord::Base
   include MailControl::LoggedEmail
 
-  queued_task :new_enquiry do
+  mailing :new_enquiry do
     actor        :User
     act_object   :Article
     act_target   :User
@@ -34,7 +34,7 @@ class LoggedEmail < ActiveRecord::Base
     unsubscribe_by :option_1
   end
 
-  queued_task :test_description do
+  mailing :test_description do
     actor        :User
     act_object   :Article
     act_target   :User
@@ -42,7 +42,7 @@ class LoggedEmail < ActiveRecord::Base
     unsubscribe_by :option_1
   end
 
-  queued_task :test_option do
+  mailing :test_option do
     actor        :User
     act_object   :Article
     act_target   :User
@@ -50,7 +50,7 @@ class LoggedEmail < ActiveRecord::Base
     unsubscribe_by :option_1
   end
 
-  queued_task :test_bond_type do
+  mailing :test_bond_type do
     actor        :User
     act_object   :Article
     act_target   :User

data/test/unit/activity_test.rb

@@ -6,7 +6,7 @@ class LoggedEmailTest < ActiveSupport::TestCase
 
   def test_register_definition
 
-    @definition = LoggedEmail.queued_task(:test_queued_task) do
+    @definition = LoggedEmail.mailing(:test_mailing) do
       actor :user, :cache => [:full_name]
       act_object :listing, :cache => [:title, :full_address]
       act_target :listing, :cache => [:title]
@@ -16,15 +16,15 @@ class LoggedEmailTest < ActiveSupport::TestCase
 
   end
 
-  def test_publish_new_queued_task
+  def test_publish_new_mailing
     _user    = User.create()
     _article = Article.create()
     _user_t  = User.create()
 
-    _queued_task = LoggedEmail.send_email(:new_enquiry, :send_after => Time.now, :send_before => Time.now + 1.hour,  :actor => _user, :act_object => _article, :act_target => _user_t )
+    _mailing = LoggedEmail.send_email(:new_enquiry, :send_after => Time.now, :send_before => Time.now + 1.hour,  :actor => _user, :act_object => _article, :act_target => _user_t )
 
-    assert _queued_task.persisted?
-    #_queued_task.should be_an_instance_of LoggedEmail
+    assert _mailing.persisted?
+    #_mailing.should be_an_instance_of LoggedEmail
 
   end
 
@@ -34,10 +34,10 @@ class LoggedEmailTest < ActiveSupport::TestCase
     _user_t  = User.create()
 
     _description = "this is a test"
-    _queued_task = LoggedEmail.send_email(:test_description, :send_after => Time.now, :send_before => Time.now + 1.hour,   :actor => _user, :act_object => _article, :act_target => _user_t ,
+    _mailing = LoggedEmail.send_email(:test_description, :send_after => Time.now, :send_before => Time.now + 1.hour,   :actor => _user, :act_object => _article, :act_target => _user_t ,
                                  :description => _description )
 
-    assert _queued_task.description  == _description
+    assert _mailing.description  == _description
 
   end
 
@@ -47,10 +47,10 @@ class LoggedEmailTest < ActiveSupport::TestCase
     _user_t  = User.create()
 
     _country = "denmark"
-    _queued_task = LoggedEmail.send_email(:test_option, :send_after => Time.now, :send_before => Time.now + 1.hour, :actor => _user, :act_object => _article, :act_target => _user_t ,
+    _mailing = LoggedEmail.send_email(:test_option, :send_after => Time.now, :send_before => Time.now + 1.hour, :actor => _user, :act_object => _article, :act_target => _user_t ,
                                  :country => _country )
 
-    assert _queued_task.options[:country]  == _country
+    assert _mailing.options[:country]  == _country
 
   end
 
@@ -59,9 +59,9 @@ class LoggedEmailTest < ActiveSupport::TestCase
     _article = Article.create()
     _user_t  = User.create()
 
-    _queued_task = LoggedEmail.send_email(:test_bond_type, :send_after => Time.now, :send_before => Time.now + 1.hour, :actor => _user, :act_object => _article, :act_target => _user_t )
+    _mailing = LoggedEmail.send_email(:test_bond_type, :send_after => Time.now, :send_before => Time.now + 1.hour, :actor => _user, :act_object => _article, :act_target => _user_t )
 
-    assert _queued_task.bond_type  == 'global'
+    assert _mailing.bond_type  == 'global'
 
   end
 

data/test/unit/actor_test.rb

@@ -7,9 +7,9 @@ class ActorTest < ActiveSupport::TestCase
     _article = Article.create()
     _user_t  = User.create()
 
-    queued_task = _user.send_email(:new_enquiry,  :send_after => Time.now, :send_before => Time.now + 1.hour, :act_object => _article, :act_target => _user_t  )
+    mailing = _user.send_email(:new_enquiry,  :send_after => Time.now, :send_before => Time.now + 1.hour, :act_object => _article, :act_target => _user_t  )
 
-    assert queued_task.persisted?
+    assert mailing.persisted?
 
   end
 
@@ -26,7 +26,7 @@ class ActorTest < ActiveSupport::TestCase
   end
 
 
-  def test_retrieves_the_stream_for_a_particular_queued_task_type
+  def test_retrieves_the_stream_for_a_particular_mailing_type
     _user = User.create()
     _article = Article.create()
     _user_t  = User.create()

data/test/unit/definition_test.rb

@@ -42,9 +42,9 @@ class DefinitionTest < ActiveSupport::TestCase
 
   end
 
-  def test_raise_exception_if_invalid_queued_task
+  def test_raise_exception_if_invalid_mailing
 
-    assert_raises(MailControl::InvalidLoggedEmail){ MailControl::Definition.find(:unknown_queued_task) }
+    assert_raises(MailControl::InvalidLoggedEmail){ MailControl::Definition.find(:unknown_mailing) }
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-control
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andreas Saebjoernsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -83,11 +83,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/mail-control.rb
-- lib/generators/mail-control/activity/activity_generator.rb
-- lib/generators/mail-control/activity/templates/logged_email.rb
-- lib/generators/mail-control/migration/migration_generator.rb
-- lib/generators/mail-control/migration/templates/migration.rb
+- lib/generators/mail_control.rb
+- lib/generators/mail_control/logged_email/activity_generator.rb
+- lib/generators/mail_control/logged_email/templates/logged_email.rb
+- lib/generators/mail_control/migration/migration_generator.rb
+- lib/generators/mail_control/migration/templates/migration.rb
 - lib/mail-control.rb
 - lib/mail-control/actor.rb
 - lib/mail-control/definition.rb
@@ -107,7 +107,8 @@ files:
 - test/unit/definition_dsl_test.rb
 - test/unit/definition_test.rb
 homepage: https://github.com/digitalplaywright/mail-control
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []