RubyGems - acts_as_newsletter - Versions diffs - 0.1 - Mend

acts_as_newsletter 0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

data/MIT-LICENSE +20 -0
data/README.md +81 -0
data/Rakefile +35 -0
data/lib/acts_as_newsletter.rb +32 -0
data/lib/acts_as_newsletter/mailer.rb +20 -0
data/lib/acts_as_newsletter/model.rb +155 -0
data/lib/acts_as_newsletter/model/config.rb +21 -0
data/lib/acts_as_newsletter/railtie.rb +19 -0
data/lib/acts_as_newsletter/version.rb +3 -0
data/lib/generators/acts_as_newsletter/acts_as_newsletter_generator.rb +35 -0
data/lib/generators/acts_as_newsletter/install/install_generator.rb +12 -0
data/lib/generators/acts_as_newsletter/install/templates/initializer.rb +22 -0
data/lib/generators/acts_as_newsletter/templates/migration.erb +17 -0
data/lib/tasks/acts_as_newsletter.rake +18 -0
data/spec/acts_as_newsletter_generator_spec.rb +20 -0
data/spec/config_spec.rb +23 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +65 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/acts_as_newsletter.rb +6 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +58 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +36 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +29 -0
data/spec/dummy/log/test.log +111434 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/install_generator_spec.rb +18 -0
data/spec/model_spec.rb +90 -0
data/spec/spec_helper.rb +40 -0
data/spec/support/active_record.rb +46 -0
metadata +219 -0

data/spec/dummy/public/404.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED

File without changes

data/spec/dummy/script/rails ADDED

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/install_generator_spec.rb ADDED

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'generator_spec/test_case'
+require 'generators/acts_as_newsletter/install/install_generator'
+describe ActsAsNewsletter::Generators::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../tmp", __FILE__)
+  before do
+    prepare_destination
+    run_generator
+  end
+  it "should create an initializer file" do
+    assert_file "config/initializers/acts_as_newsletter.rb"
+  end
+end

data/spec/model_spec.rb ADDED

@@ -0,0 +1,90 @@
+require 'spec_helper'
+describe TestNewsletter do
+  before(:each) do
+    # Empty deliveries
+    ActionMailer::Base.deliveries = []
+    # Ensure config specs doesn't edit current chunks size
+    ActsAsNewsletter::Model.emails_chunk_size = EMAILS_CHUNK_SIZE
+    @newsletter = TestNewsletter.new
+  end
+  it "should be initialized as a draft" do
+    @newsletter.draft?.should be_true
+  end
+  it "should transition to ready state when readied switch is set to true" do
+    @newsletter.readied = true
+    @newsletter.save
+    @newsletter.state_name.should eq :ready
+  end
+  it "should transition back to draft state if readied is set to false" do
+    @newsletter.readied = true
+    @newsletter.save
+    @newsletter.readied = false
+    @newsletter.save
+    @newsletter.state_name.should eq :draft
+  end
+  it "should prepare sending when #send_newsletter! is called" do
+    @newsletter.readied = true
+    @newsletter.save
+    @newsletter.send_newsletter!
+    @newsletter.emails.length.should eq EMAILS_CHUNK_SIZE
+  end
+  it "should prepare recipients when asked to" do
+    @newsletter.readied = true
+    @newsletter.save
+    @newsletter.prepare_sending!
+    @newsletter.state_name.should eq :sending
+    @newsletter.emails.should include("user-0@example.com")
+    @newsletter.emails.length.should eq EMAILS_CHUNK_SIZE
+    @newsletter.sent_count.should eq 0
+    @newsletter.recipients_count.should eq RECIPIENTS_COUNT
+  end
+  context "Sending" do
+    before(:each) do
+      @newsletter.readied = true
+      @newsletter.save
+      @newsletter.prepare_sending!
+    end
+    context "emails" do
+      it "should contain the next recipients to send emails to" do
+        @newsletter.emails.should eq RECIPIENTS_EMAILS.take EMAILS_CHUNK_SIZE
+      end
+      it "should contain different emails on each sending" do
+        first_emails = @newsletter.emails
+        @newsletter.send_newsletter!
+        second_emails = @newsletter.emails
+        second_emails.should_not eq first_emails
+      end
+    end
+    it "should update sent emails counter when a chunk is sent" do
+      expected_recipients = @newsletter.emails
+      @newsletter.send_newsletter!
+      @newsletter.save
+      @newsletter.sent_count.should eq EMAILS_CHUNK_SIZE
+      actual_recipients = ActionMailer::Base.deliveries.map(&:to).flatten
+      expected_recipients.should eq actual_recipients
+    end
+    it "should send to all recipients and transition to :sent state when called enough times" do
+      expected_recipients = @newsletter.available_emails.dup
+      3.times { @newsletter.send_newsletter! }
+      @newsletter.sent_count.should eq RECIPIENTS_COUNT
+      @newsletter.state_name.should eq :sent
+      actual_recipients = ActionMailer::Base.deliveries.map(&:to).flatten
+      actual_recipients.should eq expected_recipients
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,40 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end
+require 'support/active_record'

data/spec/support/active_record.rb ADDED

@@ -0,0 +1,46 @@
+unless defined? TestNewsletter
+  require 'active_record'
+  ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+  ActiveRecord::Migration.create_table :test_newsletters do |t|
+    t.string :subject
+    t.text :content
+    t.string :state
+    t.text :recipients
+    t.integer :recipients_count
+    t.integer :sent_count
+    t.boolean :readied, default: false
+  end
+  ActsAsNewsletter::Mailer.from = "contact@example.com"
+  EMAILS_CHUNK_SIZE = 2
+  RECIPIENTS_COUNT = (2.5 * EMAILS_CHUNK_SIZE).to_i
+  RECIPIENTS_EMAILS = RECIPIENTS_COUNT.times.map { |n| "user-#{ n }@example.com" }
+  class TestNewsletter < ActiveRecord::Base
+    include ActsAsNewsletter::Model
+    # Model specific fields
+    attr_accessor :subject, :content
+    # AcsAsNewsletter created fields
+    attr_accessor :state, :recipients, :recipients_count, :sent_count, :readied
+    acts_as_newsletter do
+      emails model.temp_emails
+      # template_name ""
+      # template_path ""
+      layout false
+    end
+    def initialize(*)
+      super
+      send(:initialize_state_machines, :dynamic => :force)
+    end
+    def temp_emails
+      RECIPIENTS_EMAILS
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_newsletter
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease:
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.12
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to send a models content as a batch e-mail to a list
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/acts_as_newsletter/mailer.rb
+- lib/acts_as_newsletter/model/config.rb
+- lib/acts_as_newsletter/model.rb
+- lib/acts_as_newsletter/railtie.rb
+- lib/acts_as_newsletter/version.rb
+- lib/acts_as_newsletter.rb
+- lib/generators/acts_as_newsletter/acts_as_newsletter_generator.rb
+- lib/generators/acts_as_newsletter/install/install_generator.rb
+- lib/generators/acts_as_newsletter/install/templates/initializer.rb
+- lib/generators/acts_as_newsletter/templates/migration.erb
+- lib/tasks/acts_as_newsletter.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/acts_as_newsletter_generator_spec.rb
+- spec/config_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/acts_as_newsletter.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/install_generator_spec.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: http://www.glyph.fr
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Allows to send a models content as a batch e-mail to a list
+test_files:
+- spec/acts_as_newsletter_generator_spec.rb
+- spec/config_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/acts_as_newsletter.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config.ru
+- spec/dummy/db/development.sqlite3
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/log/development.log
+- spec/dummy/log/test.log
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/install_generator_spec.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb