correole 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa914631ebd1483e1e4ec3f2e72b2e6ad8b0842c
-  data.tar.gz: 48491bc95bdfaaf363f337dfce859af9310225a6
+SHA256:
+  metadata.gz: c383918b800ea3b2cbe74401782d07e462762a89659e917275c938234e4e3aa4
+  data.tar.gz: 50497adea72cd5b913eb02e748a8cf521c49d5540ef65ace4efba4da67409cde
 SHA512:
-  metadata.gz: 5ff71315753d357a1db73ca235e18d1f58c1c443e0b8f543439c00ba0210eedfb8ad5a9567fb492d362d8639273d2a2b21eec5a6712f2e87f2a6330edc4149ca
-  data.tar.gz: d2c0e6bbeb236291e188e6e14009cb0fb9668b50c3b0f09303239efb52a5ed76c90ccb9adb216e755ba26fc29fe121d25d799299f24de2a1ccdbb948c82c6058
+  metadata.gz: 8873b9c5abb6dfe2806f1ee2509d6633fb3a07c771c5df39ff78e6839ee2454ac7037a49a8d58b4ff7ca8f94d1339bf68dd150f409b0b7636e6896fddb65c645
+  data.tar.gz: '07618872e9306c83cb78ae5a12452f18f8f623cb28b1340b0367b2c1fbaed46207bc9d29d6021c7c9dd7956ffdb25f8d329073bec28e38471288e5e45cb329fd'

data/bin/correole

@@ -12,8 +12,11 @@ Configuration.quiet = ARGV.second == '-q'
 case ARGV.first
 when 'send'
   Send.run!
-when 'purge'
-  Purge.run!
+when 'test'
+  Configuration.dry_run = true
+  Send.run!
+when 'skip'
+  Skip.run!
 else
   abort "Unknown parameters #{ARGV}."
 end

data/config/config.yml

@@ -0,0 +1,40 @@
+test:
+  quiet: true
+  dry_run: false
+  dry_run_email: test@mail.com
+  base_uri: http://test.ruslanledesma.com
+  feed: http://ruslanledesma.com/feed.xml # reset by env for end-to-end test
+  unsubscribe_uri: 'http://newsletter.ruslanledesma.com/unsubscribe/?email=<%= recipient %>'
+  confirmation_uri: http://newsletter.ruslanledesma.com/unsubscribed/
+  subject: 'Test <%= title %> - <%= date %>'
+  from: '<%= title %> <no-reply@ruslanledesma.com>'
+  html_template: templates/test.html.erb
+  plain_template: templates/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
+
+development: &dev
+  quiet: false
+  dry_run: false
+  dry_run_email: your.email@mail.com
+  base_uri: http://newsletter.ruslanledesma.com
+  feed: http://ruslanledesma.com/feed.xml
+  unsubscribe_uri: 'http://ruslanledesma.com/unsubscribe/?email=<%= recipient %>'
+  confirmation_uri: http://ruslanledesma.com/unsubscribed/
+  subject: '<%= title %>: newsletter for <%= date %>'
+  from: '<%= title %> <no-reply@ruslanledesma.com>'
+  html_template: templates/production.html.erb
+  plain_template: templates/production.txt.erb
+  smtp_host:
+  smtp_port:
+  smtp_user:
+  smtp_pass:
+  smtp_auth:
+  smtp_ttls:
+
+production:
+  <<: *dev

data/config/configuration.rb

@@ -2,13 +2,19 @@ DEFAULT_ENV = 'production'
 DEFAULT_CONFIG_FILE = 'config.yml'
 
 ENV['RACK_ENV'] ||= DEFAULT_ENV
-ENV['CONFIG_FILE'] ||= DEFAULT_CONFIG_FILE
+ENV['CONFIG_FILE'] ||= File.expand_path "../#{DEFAULT_CONFIG_FILE}", __FILE__
 
 class Configuration
 
-  CONFIG_KEYS = [
+  BOOLEAN_KEYS = [
     'QUIET',
+    'DRY_RUN',
+    'SMTP_TTLS'
+  ]
+  CONFIG_KEYS = [
+    'DRY_RUN_EMAIL',
     'FEED',
+    'UNSUBSCRIBE_URI',
     'CONFIRMATION_URI',
     'BASE_URI',
     'SUBJECT',
@@ -20,7 +26,7 @@ class Configuration
     'SMTP_USER',
     'SMTP_PASS',
     'SMTP_AUTH',
-    'SMTP_TTLS' ]
+  ] + BOOLEAN_KEYS
 
   class << self
     CONFIG_KEYS.each do |k|
@@ -30,19 +36,18 @@ class Configuration
 
   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}."
+    YAML.load_file(ENV['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 "Cannot load configuration file #{ENV['CONFIG_FILE']}. Using configuration given by environment."
 
     CONFIG_KEYS.each do |k|
       case k
-      when 'QUIET', 'SMTP_TTLS'
+      when *BOOLEAN_KEYS
         # 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]}."
+        path = File.expand_path "../#{ENV[k]}", __FILE__
+        template = File.read path rescue abort "Cannot load template #{path}."
         self.send("#{k.downcase}=".to_sym, template)
       when 'SMTP_USER', 'SMTP_PASS'
         # For user name and password, Mail interprets '' as an input.

data/config/dependencies.rb

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

data/db/migrate/0001_create_database.rb

@@ -1,4 +1,4 @@
-class CreateDatabase < ActiveRecord::Migration
+class CreateDatabase < ActiveRecord::Migration[6.0]
   def change
     create_table :subscribers do |t|
       t.string :email, null: false

data/db/migrate/0002_create_items.rb

@@ -1,4 +1,4 @@
-class CreateItems < ActiveRecord::Migration
+class CreateItems < ActiveRecord::Migration[6.0]
   def change
     create_table :items do |t|
       t.string :title, null: false

data/lib/correole/api.rb

@@ -9,12 +9,15 @@ class Api < Sinatra::Base
   set :server, :thin
   enable :logging
   disable :show_exceptions
-  use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
   before do
     content_type 'text/plain'
   end
 
+  after do
+     ActiveRecord::Base.clear_active_connections!
+  end
+
   def subscribe(params)
     response.headers['Access-Control-Allow-Origin'] = SUBSCRIBERS_ALLOWED_ORIGIN
     s = Subscriber.new(email: params[:email])
@@ -26,7 +29,7 @@ class Api < Sinatra::Base
       logger.info("Already subscribed #{params[:email]}.")
       Subscriber.find_by_email(params[:email]).touch
     end
-    "#{params[:email]}\n"
+    [201, "#{params[:email]}\n"]
   end
 
   def unsubscribe(params)
@@ -44,16 +47,19 @@ class Api < Sinatra::Base
   end
 
   def subscribers_method_not_allowed
+    response.headers['Allow'] = SUBSCRIBERS_ALLOWED_METHODS
     response.headers['Access-Control-Allow-Methods'] = SUBSCRIBERS_ALLOWED_METHODS
     405
   end
 
   def unsubscribe_method_not_allowed
+    response.headers['Allow'] = UNSUBSCRIBE_ALLOWED_METHODS
     response.headers['Access-Control-Allow-Methods'] = UNSUBSCRIBE_ALLOWED_METHODS
     405
   end
 
   options '/subscribers/:email' do
+    response.headers['Allow'] = SUBSCRIBERS_ALLOWED_METHODS
     response.headers['Access-Control-Allow-Methods'] = SUBSCRIBERS_ALLOWED_METHODS
     response.headers['Access-Control-Allow-Origin'] = SUBSCRIBERS_ALLOWED_ORIGIN
     200
@@ -77,6 +83,7 @@ class Api < Sinatra::Base
   end
 
   options "#{UNSUBSCRIBE_PATH}/:email" do
+    response.headers['Allow'] = UNSUBSCRIBE_ALLOWED_METHODS
     response.headers['Access-Control-Allow-Methods'] = UNSUBSCRIBE_ALLOWED_METHODS
     response.headers['Access-Control-Allow-Origin'] = UNSUBSCRIBE_ALLOWED_ORIGIN
     200

data/lib/correole/feed.rb

@@ -33,5 +33,4 @@ class Feed
     return split_feed
   end
 
-
 end

data/lib/correole/send.rb

@@ -12,47 +12,57 @@ class Send
     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}."
+    rr = recipients
+    rr.each_with_index do |r, i|
+      html_r = personalize html, r.email
+      plain_r = personalize plain, r.email
+      qputs "[#{i+1}/#{rr.size}] Send newsletter to #{r.email}."
       begin
-        send_out feed[:title], html_s, plain_s, s.email
+        send_out feed[:title], html_r, plain_r, r.email
       rescue => exc
-        qputs "Could not send newsletter to #{s.email} for the following reason."
+        qputs "Could not send newsletter to #{r.email} for the following reason."
         qputs exc.message
       end
     end
-    qputs 'Remember new items.'
-    split_feed[:unsent_item].each { |i| i.save }
+    if not Configuration.dry_run
+      qputs 'Remember new items.'
+      split_feed[:unsent_item].each { |i| i.save }
+    end
     qputs 'Done.'
   end
 
   private
 
+  def self.recipients
+    if Configuration.dry_run
+      s = Subscriber.new(email: Configuration.dry_run_email)
+      return [s].each
+    end
+    return Subscriber.find_each
+  end
+
   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 = split_feed[:unsent_item]
     unsent_items = [] if !unsent_items.is_a?(Array)
-    sent_items = [] if !unsent_items.is_a?(Array)
+    sent_items = split_feed[:sent_item]
+    sent_items = [] if !sent_items.is_a?(Array)
+    unsubscribe_uri = Configuration.unsubscribe_uri
+    if false then unsubscribe_uri end # suppress unused variable warning
     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)
+    return ERB.new(template, trim_mode: '-').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)
+    return ERB.new(template, trim_mode: '-').result(bindings)
   end
 
   def self.personalize(message, recipient)
@@ -60,8 +70,8 @@ class Send
   end
 
   def self.send_out(title, html, plain, recipient)
-    date = nil # supress unused variable warning
     date = Date.today.strftime('%a, %d %b %Y')
+    if false then date end # suppress unused variable warning
     Mail.deliver do
       to      recipient
       from    ERB.new(Configuration.from).result(binding)

data/lib/correole/{purge.rb → skip.rb}

@@ -1,4 +1,4 @@
-class Purge
+class Skip
 
   def self.run!
     qputs "Fetch feed from #{Configuration.feed}."
@@ -10,7 +10,7 @@ class Purge
     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.'
+    qputs 'Skip the new items by remembering them.'
     unsent_items.each { |i| i.save }
     qputs 'Done.'
   end

data/lib/correole/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: correole
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Ruslan Ledesma Garza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.9'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: mini-smtp-server
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '13.0'
 description: |
   Correole is a webservice that subscribes and unsubscribes readers from
   a newsletter.
@@ -202,23 +202,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/correole
+- config/config.yml
 - 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
+- config/templates/production.html.erb
+- config/templates/production.txt.erb
+- config/templates/test.html.erb
+- config/templates/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/skip.rb
 - lib/correole/subscriber.rb
 - lib/correole/version.rb
 homepage: http://ruslanledesma.com/
@@ -228,20 +227,20 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
+- config
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.7.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A newsletter webservice

data/config/example.config.yml

@@ -1,18 +0,0 @@
-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/test.config.yml

@@ -1,15 +0,0 @@
-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