correole 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd23680d484c3a44bbd64e36a11ad473bda7953d
-  data.tar.gz: de2e5d476329234d2ab91e48ebb784edd442e59b
+SHA256:
+  metadata.gz: f8f2fe3a7de80d7791152fd8a3763666393e9126af594aa3f67b4cba3e468342
+  data.tar.gz: beb208a8c5f5798cd60f8ace8a62b7b949f1c363a2c85e8e2bc85267fb22de6d
 SHA512:
-  metadata.gz: b2bd2286ee6a39ed7abb65f86909dc54234ecd2bab9fdf1d3b72643fb08b4f05ebc3690257d5b09fae0a004fbf45ede5640993300296ae88221fbfebff589f42
-  data.tar.gz: 0eea183a91b61e868d30a2425568de437c939782cd49e8191e82a3321a90aa92a7c8205b07c83d68416b02f8e5bca2aea65fd9076305184b56858c7da79bd8ae
+  metadata.gz: c3b3d63f74a0be04f81a0ccee3cb48d467f3920701e6cc3cd0bf8a1e516effc8a0c8cecb3c3725e8e0d410d987811a38267dd26702abf06d2d412311a6deddb2
+  data.tar.gz: 32bdbf7124e7aed3474111af567c7cb8b1390d92807764285af43efe19be0c562c2dc8079667edaf07a7a3dd2857a1559ecbd5276dbb52a1d5b0086957604691

data/bin/correole

@@ -12,6 +12,9 @@ Configuration.quiet = ARGV.second == '-q'
 case ARGV.first
 when 'send'
   Send.run!
+when 'test'
+  Configuration.dry_run = true
+  Send.run!
 when 'purge'
   Purge.run!
 else

data/config/configuration.rb

@@ -6,9 +6,15 @@ 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|
@@ -31,12 +37,12 @@ class Configuration
   def self.load!
 
     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 "Could not load configuration file #{ENV['CONFIG_FILE']}."
+      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'

data/config/dependencies.rb

@@ -1,5 +1,6 @@
 require 'sinatra/base'
 require 'sinatra/activerecord'
+require 'active_support/core_ext/hash'
 require 'correole/qputs'
 require 'correole/subscriber'
 require 'correole/item'

data/config/example.config.yml

@@ -1,7 +1,10 @@
 production: &prod
   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>'

data/config/test.config.yml

@@ -1,8 +1,11 @@
 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
-  confirmation_uri: http://newsletter.ruslanledesma.com
+  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: test.html.erb

data/lib/correole/api.rb

@@ -9,7 +9,7 @@ class Api < Sinatra::Base
   set :server, :thin
   enable :logging
   disable :show_exceptions
-  use ActiveRecord::ConnectionAdapters::ConnectionManagement
+#  use ActiveRecord::ConnectionAdapters::ConnectionManagement
 
   before do
     content_type 'text/plain'
@@ -26,7 +26,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 +44,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 +80,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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: correole
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 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.
@@ -234,15 +234,14 @@ 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