correole 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a600945ac9a19b338201ce5b6098c74cac2a1fa
-  data.tar.gz: 2e1c5a6c6e7a765dd8b6c66ad54526fa38cd6e3f
+  metadata.gz: fa914631ebd1483e1e4ec3f2e72b2e6ad8b0842c
+  data.tar.gz: 48491bc95bdfaaf363f337dfce859af9310225a6
 SHA512:
-  metadata.gz: bf5ce5f7f5befad4c24719a8a32f79ff6f03fa39c8796879c094908807dadfcc773a029d59e10a963c8b5690324d3b0f81791cad8d6377c4ea0ed7a8004d2f44
-  data.tar.gz: b81547d79a84dcf4acbfbce6a18c15accd2ac7feb39602b3e297d5ca0793477770c224662dec2c102622499140b7bb992f3c92436be73c44078d7e0237f66b32
+  metadata.gz: 5ff71315753d357a1db73ca235e18d1f58c1c443e0b8f543439c00ba0210eedfb8ad5a9567fb492d362d8639273d2a2b21eec5a6712f2e87f2a6330edc4149ca
+  data.tar.gz: d2c0e6bbeb236291e188e6e14009cb0fb9668b50c3b0f09303239efb52a5ed76c90ccb9adb216e755ba26fc29fe121d25d799299f24de2a1ccdbb948c82c6058

data/config/configuration.rb

@@ -0,0 +1,70 @@
+DEFAULT_ENV = 'production'
+DEFAULT_CONFIG_FILE = 'config.yml'
+
+ENV['RACK_ENV'] ||= DEFAULT_ENV
+ENV['CONFIG_FILE'] ||= DEFAULT_CONFIG_FILE
+
+class Configuration
+
+  CONFIG_KEYS = [
+    'QUIET',
+    'FEED',
+    'CONFIRMATION_URI',
+    'BASE_URI',
+    'SUBJECT',
+    'FROM',
+    'HTML_TEMPLATE',
+    'PLAIN_TEMPLATE',
+    'SMTP_HOST',
+    'SMTP_PORT',
+    'SMTP_USER',
+    'SMTP_PASS',
+    'SMTP_AUTH',
+    'SMTP_TTLS' ]
+
+  class << self
+    CONFIG_KEYS.each do |k|
+      attr_accessor k.downcase.to_sym
+    end
+  end
+
+  def self.load!
+
+    config_file = File.expand_path "../#{ENV['CONFIG_FILE']}", __FILE__
+    YAML.load_file(config_file)[ENV['RACK_ENV']].each_pair do |k, v|
+      ENV[k.upcase] ||= v.to_s rescue abort "Cannot load configuration key #{k}."
+    end rescue qputs "Could not load configuration file #{config_file}."
+
+    CONFIG_KEYS.each do |k|
+      case k
+      when 'QUIET', 'SMTP_TTLS'
+        # Cannot store boolean values in ENV, thus this.
+        self.send("#{k.downcase}=".to_sym, ENV[k] == 'true')
+      when 'HTML_TEMPLATE', 'PLAIN_TEMPLATE'
+        file = File.expand_path "../#{ENV[k]}", __FILE__
+        template = File.read file rescue abort "Cannot load template #{ENV[k]}."
+        self.send("#{k.downcase}=".to_sym, template)
+      when 'SMTP_USER', 'SMTP_PASS'
+        # For user name and password, Mail interprets '' as an input.
+        # It doesn't do the same with nil.
+        self.send("#{k.downcase}=".to_sym, ENV[k] == '' ? nil : ENV[k])
+      else
+        self.send("#{k.downcase}=".to_sym, ENV[k])
+      end
+    end
+
+    Mail.defaults do
+      delivery_method :smtp,
+      address:                Configuration.smtp_host,
+      port:                   Configuration.smtp_port,
+      user_name:              Configuration.smtp_user,
+      password:               Configuration.smtp_pass,
+      authentication:         Configuration.smtp_auth,
+      enable_starttls_auto:   Configuration.smtp_ttls
+    end
+
+  end
+
+end
+
+Configuration.load!

data/config/database.yml

@@ -0,0 +1,10 @@
+test:
+  adapter: sqlite3
+  database: test.db
+
+development:
+  adapter: sqlite3
+  database: development.db
+
+production: 
+  adapter: postgresql

data/config/dependencies.rb

@@ -0,0 +1,12 @@
+require 'sinatra/base'
+require 'sinatra/activerecord'
+require 'correole/qputs'
+require 'correole/subscriber'
+require 'correole/item'
+require 'correole/feed'
+require 'correole/api'
+require 'correole/send'
+require 'correole/purge'
+require 'net/http'
+require 'mail'
+require 'configuration'

data/config/example.config.yml

@@ -0,0 +1,18 @@
+production: &prod
+  quiet: false
+  base_uri: http://newsletter.ruslanledesma.com
+  feed: http://ruslanledesma.com/feed.xml
+  confirmation_uri: http://ruslanledesma.com/unsubscribed/
+  subject: '<%= title %>: newsletter for <%= date %>'
+  from: '<%= title %> <no-reply@ruslanledesma.com>'
+  html_template: production.html.erb
+  plain_template: production.txt.erb
+  smtp_host:
+  smtp_port:
+  smtp_user:
+  smtp_pass:
+  smtp_auth:
+  smtp_ttls:
+
+development:
+  <<: *prod

data/config/production.html.erb

@@ -0,0 +1,21 @@
+<html>
+  <body>
+    <h1><%= title %></h1>
+    <h2>New posts</h2>
+    <ul>
+<% for item in unsent_items %>
+      <li>
+        <h3>
+          <a href="<%= item.link %>"><%= item.title %></a>
+        </h3>
+<% if item.pub_date -%>
+        <p><i><%= item.pub_date.to_date %></i></p>
+<% end -%>
+        <p><%= item.description %></p>
+      </li>
+<% end %>
+    </ul>
+
+    <a href="<%= unsubscribe_uri %>">Unsubscribe here.</a>
+  </body>
+</html>

data/config/production.txt.erb

@@ -0,0 +1,13 @@
+<%= title %>
+
+New posts
+<% for item in unsent_items %>
+- <%= item.title %>
+<% if item.pub_date -%>
+  <%= item.pub_date.to_date %>
+<% end -%>
+  <%= item.link %>
+
+  <%= item.description %>
+<% end %>
+Unsubscribe here: <%= unsubscribe_uri %>

data/config/test.config.yml

@@ -0,0 +1,15 @@
+test:
+  quiet: true
+  base_uri: http://test.ruslanledesma.com
+  feed: http://ruslanledesma.com/feed.xml # reset by env for end-to-end test
+  confirmation_uri: http://newsletter.ruslanledesma.com
+  subject: 'Test <%= title %> - <%= date %>'
+  from: '<%= title %> <no-reply@ruslanledesma.com>'
+  html_template: test.html.erb
+  plain_template: test.txt.erb
+  smtp_host: localhost # reset by env for end-to-end test
+  smtp_port: 25 # reset by env for end-to-end test
+  smtp_user:
+  smtp_pass:
+  smtp_auth:
+  smtp_ttls: false

data/config/test.html.erb

@@ -0,0 +1,21 @@
+<html>
+  <body>
+    <h1><%= title %></h1>
+    <h2>Items</h2>
+    <ul>
+<% for item in unsent_items %>
+      <li>
+<% if item.pub_date -%>
+        <i><%= item.pub_date.to_date %></i>
+<% end -%>
+        <h3>
+          <a href="<%= item.link %>"><%= item.title %></a>
+        </h3>
+        <p><%= item.description %></p>
+      </li>
+<% end %>
+    </ul>
+
+    <a href="<%= unsubscribe_uri %>">Unsubscribe here.</a>
+  </body>
+</html>

data/config/test.txt.erb

@@ -0,0 +1,13 @@
+<%= title %>
+
+Items
+<% for item in unsent_items %>
+- <%= item.title %>
+<% if item.pub_date -%>
+  <%= item.pub_date.to_date %>
+<% end -%>
+  <%= item.link %>
+
+  <%= item.description %>
+<% end %>
+Unsubscribe here: <%= unsubscribe_uri %>

data/db/migrate/0001_create_database.rb

@@ -0,0 +1,9 @@
+class CreateDatabase < ActiveRecord::Migration
+  def change
+    create_table :subscribers do |t|
+      t.string :email, null: false
+      t.index :email, unique: true
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/0002_create_items.rb

@@ -0,0 +1,12 @@
+class CreateItems < ActiveRecord::Migration
+  def change
+    create_table :items do |t|
+      t.string :title, null: false
+      t.string :description, null: false
+      t.string :link, null: false
+      t.timestamp :pub_date, null: true
+      t.index :link, unique: true
+      t.timestamps null: false
+    end
+  end
+end

data/lib/correole/api.rb

@@ -0,0 +1,118 @@
+class Api < Sinatra::Base
+
+  UNSUBSCRIBE_PATH = '/unsubscribe'
+  SUBSCRIBERS_ALLOWED_METHODS = 'PUT, DELETE, OPTIONS'
+  SUBSCRIBERS_ALLOWED_ORIGIN = '*'
+  UNSUBSCRIBE_ALLOWED_METHODS = 'GET, OPTIONS'
+  UNSUBSCRIBE_ALLOWED_ORIGIN = '*'
+
+  set :server, :thin
+  enable :logging
+  disable :show_exceptions
+  use ActiveRecord::ConnectionAdapters::ConnectionManagement
+
+  before do
+    content_type 'text/plain'
+  end
+
+  def subscribe(params)
+    response.headers['Access-Control-Allow-Origin'] = SUBSCRIBERS_ALLOWED_ORIGIN
+    s = Subscriber.new(email: params[:email])
+    return 400 if not s.valid?
+    begin
+      s.save
+      logger.info("Subscribed #{params[:email]}.")
+    rescue ActiveRecord::RecordNotUnique
+      logger.info("Already subscribed #{params[:email]}.")
+      Subscriber.find_by_email(params[:email]).touch
+    end
+    "#{params[:email]}\n"
+  end
+
+  def unsubscribe(params)
+    response.headers['Access-Control-Allow-Origin'] = UNSUBSCRIBE_ALLOWED_ORIGIN
+    s = Subscriber.new(email: params[:email])
+    return 400 if not s.valid?
+    s = Subscriber.find_by_email(params[:email])
+    if s != nil
+      s.delete
+      logger.info("Unsubscribed #{params[:email]}.")
+    else
+      logger.info("Tried to unsubscribe #{params[:email]} but address is not subscribed.")
+    end
+    "#{params[:email]}\n"
+  end
+
+  def subscribers_method_not_allowed
+    response.headers['Access-Control-Allow-Methods'] = SUBSCRIBERS_ALLOWED_METHODS
+    405
+  end
+
+  def unsubscribe_method_not_allowed
+    response.headers['Access-Control-Allow-Methods'] = UNSUBSCRIBE_ALLOWED_METHODS
+    405
+  end
+
+  options '/subscribers/:email' do
+    response.headers['Access-Control-Allow-Methods'] = SUBSCRIBERS_ALLOWED_METHODS
+    response.headers['Access-Control-Allow-Origin'] = SUBSCRIBERS_ALLOWED_ORIGIN
+    200
+  end
+
+  put '/subscribers/:email' do
+    subscribe(params)
+  end
+
+  delete '/subscribers/:email' do
+    unsubscribe(params)
+  end
+
+  [ :get,
+    :post,
+    :patch
+  ].each do |verb|
+    send verb, '/subscribers/:email' do
+      subscribers_method_not_allowed
+    end
+  end
+
+  options "#{UNSUBSCRIBE_PATH}/:email" do
+    response.headers['Access-Control-Allow-Methods'] = UNSUBSCRIBE_ALLOWED_METHODS
+    response.headers['Access-Control-Allow-Origin'] = UNSUBSCRIBE_ALLOWED_ORIGIN
+    200
+  end
+
+  get "#{UNSUBSCRIBE_PATH}/:email" do
+    r = unsubscribe(params)
+    return r if r.is_a? Integer
+    response.headers['Location'] = Configuration.confirmation_uri
+    [302, r]
+  end
+
+  [ :put,
+    :delete,
+    :post,
+    :patch
+  ].each do |verb|
+    send verb, "#{UNSUBSCRIBE_PATH}/:email" do
+      unsubscribe_method_not_allowed
+    end
+  end
+
+  not_found do
+    [404, "Not found\n"]
+  end
+
+  error 400 do
+    [400, "Bad request\n"]
+  end
+
+  error 405 do
+    [405, "Method not allowed\n"]
+  end
+
+  error 500 do
+    [500, "Internal server error\n"]
+  end
+
+end

data/lib/correole/feed.rb

@@ -0,0 +1,37 @@
+class Feed
+
+  def self.get
+    uri = URI Configuration.feed
+    xml = Net::HTTP.get uri
+    hash = Hash.from_xml xml
+    return {
+      :title => hash['rss']['channel']['title'],
+      :item => hash['rss']['channel']['item'].map { |i|
+        pub_date = nil
+        pub_date = Time.parse(i['pubDate']) if i.has_key? 'pubDate'
+        Item.new(title: i['title'],
+                 description: i['description'],
+                 link: i['link'],
+                 pub_date: pub_date)
+      }
+    }
+  end
+
+  def self.split_items(feed)
+    split_feed = {
+      :title => feed[:title],
+      :unsent_item => [],
+      :sent_item => []
+    }
+    feed[:item].each do |i|
+      if Item.where(:link => i.link).any?
+        split_feed[:sent_item] << i
+      else
+        split_feed[:unsent_item] << i
+      end
+    end
+    return split_feed
+  end
+
+
+end

data/lib/correole/item.rb

@@ -0,0 +1,17 @@
+class Item < ActiveRecord::Base
+  validates :title, presence: true
+  validates :description, presence: true
+  validates :link, presence: true, format: /http.+/
+
+  def ==(o)
+    return o.class == self.class &&
+      o.title == self.title &&
+      o.description == self.description &&
+      o.link == self.link &&
+      o.pub_date == self.pub_date &&
+      o.id == self.id &&
+      o.created_at == self.created_at &&
+      o.updated_at == self.updated_at
+  end
+
+end

data/lib/correole/purge.rb

@@ -0,0 +1,18 @@
+class Purge
+
+  def self.run!
+    qputs "Fetch feed from #{Configuration.feed}."
+    feed = Feed.get
+    unsent_items = Feed.split_items(feed)[:unsent_item]
+    if unsent_items.empty?
+      qputs 'There are no new items, exiting.'
+      return
+    end
+    qputs "There are #{unsent_items.length} new items. The items are the following."
+    unsent_items.each_with_index { |i, j| qputs "[#{j+1}] #{i.link}" }
+    qputs 'Purge the new items by remembering them.'
+    unsent_items.each { |i| i.save }
+    qputs 'Done.'
+  end
+
+end

data/lib/correole/qputs.rb

@@ -0,0 +1,3 @@
+def qputs(s)
+  puts s if not Configuration.quiet
+end

data/lib/correole/send.rb

@@ -0,0 +1,81 @@
+class Send
+
+  def self.run!
+    qputs "Fetch feed from #{Configuration.feed}."
+    feed = Feed.get
+    split_feed = Feed.split_items feed
+    if split_feed[:unsent_item].empty?
+      qputs 'There are no new items, exiting.'
+      return
+    end
+    qputs "There are #{split_feed[:unsent_item].length} new items. The items are the following."
+    split_feed[:unsent_item].each_with_index { |i, j| qputs "[#{j+1}] #{i.link}" }
+    html = compose_html split_feed
+    plain = compose_plain split_feed
+    count = Subscriber.count
+    Subscriber.find_each.with_index do |s, i|
+      html_s = personalize html, s.email
+      plain_s = personalize plain, s.email
+      qputs "[#{i+1}/#{count}] Send newsletter to #{s.email}."
+      begin
+        send_out feed[:title], html_s, plain_s, s.email
+      rescue => exc
+        qputs "Could not send newsletter to #{s.email} for the following reason."
+        qputs exc.message
+      end
+    end
+    qputs 'Remember new items.'
+    split_feed[:unsent_item].each { |i| i.save }
+    qputs 'Done.'
+  end
+
+  private
+
+  def self.template_bindings(split_feed)
+    title = split_feed[:title]
+    unsent_items = split_feed[:unsent_item]
+    sent_items = split_feed[:sent_item]
+    unsubscribe_uri = nil # supress unused variable warning
+    unsubscribe_uri = "#{Configuration.base_uri}#{Api::UNSUBSCRIBE_PATH}/<%= recipient %>"
+    title = '' if !title.is_a?(String)
+    unsent_items = [] if !unsent_items.is_a?(Array)
+    sent_items = [] if !unsent_items.is_a?(Array)
+    return binding
+  end
+
+  def self.compose_html(split_feed)
+    template = Configuration.html_template
+    bindings = template_bindings(split_feed)
+    return ERB.new(template, nil, '-').result(bindings)
+  end
+
+  def self.compose_plain(split_feed)
+    template = Configuration.plain_template
+    bindings = template_bindings(split_feed)
+    return ERB.new(template, nil, '-').result(bindings)
+  end
+
+  def self.personalize(message, recipient)
+    return ERB.new(message).result(binding)
+  end
+
+  def self.send_out(title, html, plain, recipient)
+    date = nil # supress unused variable warning
+    date = Date.today.strftime('%a, %d %b %Y')
+    Mail.deliver do
+      to      recipient
+      from    ERB.new(Configuration.from).result(binding)
+      subject ERB.new(Configuration.subject).result(binding)
+
+      text_part do
+        body plain
+      end
+
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body html
+      end
+    end
+  end
+
+end

data/lib/correole/subscriber.rb

@@ -0,0 +1,3 @@
+class Subscriber < ActiveRecord::Base
+  validates :email, presence: true, format: /.+@.+/
+end

data/lib/correole/version.rb

@@ -0,0 +1,4 @@
+module Correole
+  VERSION = '0.0.2'
+  DATE = '2016-07-26'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: correole
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ruslan Ledesma Garza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -202,6 +202,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/correole
+- config/configuration.rb
+- config/database.yml
+- config/dependencies.rb
+- config/example.config.yml
+- config/production.html.erb
+- config/production.txt.erb
+- config/test.config.yml
+- config/test.html.erb
+- config/test.txt.erb
+- db/migrate/0001_create_database.rb
+- db/migrate/0002_create_items.rb
+- lib/correole/api.rb
+- lib/correole/feed.rb
+- lib/correole/item.rb
+- lib/correole/purge.rb
+- lib/correole/qputs.rb
+- lib/correole/send.rb
+- lib/correole/subscriber.rb
+- lib/correole/version.rb
 homepage: http://ruslanledesma.com/
 licenses:
 - MIT