vf-email-handler 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d3dfd6e8bd814eb464375f2310eabcb1d2dbeb7
-  data.tar.gz: 35d8181ce32c6fe61c5a1959df0ee244512992a7
+  metadata.gz: 1c1778f9431c9ade3da0ea1dfd1b8f959c8985e6
+  data.tar.gz: ab78ce69d2f189ca009a17defbeedc1aa1dc966c
 SHA512:
-  metadata.gz: 31d8c82a3921232dd1479af035159aa6a0e21a9ce921bcadc9ce5744dbac24193463b6fc7ff668dd67320ca64a0fda1ac7fcce10b28082d4f807b32ef97a513f
-  data.tar.gz: ac941615464f4665fced5f48a7c8e9befb7bf6d2c1647e001ba47c6b21fa2d8e5a02d41655f7f5f16fa64b584bdfad2a3b751c3405480976946fcfe029431e41
+  metadata.gz: a0e8e25829b0acbaf7cdc3311f531890c58db300a6154850e2f66f574425daea629cbe14e8cc51a101672a1af915507e380d68c28306804bff4df28616e68660
+  data.tar.gz: 73e59bf4f5166e888499ebea3ec5730de0fe42116e9dddb411152e5749f282f5ba17ba80b5a4e144c75e0495668c0c82f37af1517a44f668be2b74e34f51aec3

data/README.md

@@ -5,6 +5,18 @@ Logic that binds the Amazon SQS (Simple Queue Service) to the Amazon SES (Simple
 
 The handler will poll a specified SQS Queue and translate the messages to somethign that SES can understand and then push them to SES; effectively sending the emails.
 
+The SQS message should look something like this: 
+
+```javascript
+{
+   "from": "SES verified email <noreply@videofy.me>",
+   "to": "Person <kalle@videofy.me>",
+   "subject": "Subject of the email",
+   "html": "<p> A little email </p>"
+}
+```
+There are ofcourse a bunch of other fields that can be used, check the code for more info.
+
 ####Get up and running with the mail handler
 To start with there are some dependencies that must be satisfied.
 * Ruby ( >= 2.1.2) must be installed on the host computer
@@ -12,26 +24,38 @@ To start with there are some dependencies that must be satisfied.
 
 To install just type `gem install vf-email-handler` and you're set to go.
 
+To build the gem from source hit `rake gem:build` and that will build the gem and install it.
+
 Then there is just the matter of writing the config, which of course the handler can do for you; at least get you started.
 Type the following:
 
 ```bash
-Config create call here
+vf-email-handler create-config
 ```
 
-and it will generate a config-skeleton for you. Looking inside `default.h.cfg` we se this:
-
-```bash
-Put sample config here
+and it will generate a config-skeleton for you. Looking inside `mailer_config.yml` we se this:
+
+```yaml
+:aws:
+  :ses:
+    :access_key_id: <YOUR AWS ACCESS_KEY_ID>
+    :secret_access_key: <YOUR AWS SECRET_ACCESS_KEY>
+    :ses_server: email.eu-west-1.amazonaws.com
+  :sqs:
+    :access_key_id: <YOUR AWS ACCESS_KEY_ID>
+    :secret_access_key: <YOUR AWS SECRET_ACCESS_KEY>
+    :sqs_queues: [<NAMES OF YOUR AWS SQS QUEUES>]
+    :aws_region: eu-west-1
+    :batch_size: <OPTIONAL DEFAULT 1 MAX 10>
+
+:logger:
+  :log_file: <PATH TO LOGFILE HERE; Null if STOUT>
 ```
 
 Fill in the blanks and then start the handler by running.
 
 ```bash
-Put startup command here
+vf-email-handler run mailer_config.yml
 ```
 
-#####Daemonize
-There is an init.d script in the opt folder of the repo.
-
 Happy hacking!

data/lib/logger/logger.rb

@@ -11,7 +11,7 @@ module MailHandler
       end
 
       def success(args)
-        #log "SUCCESS: #{args[:subject]}"
+        log "SUCCESS: #{args[:subject]}"
       end
 
       def error(args)

data/lib/meta/version.rb

@@ -1,4 +1,4 @@
 # Current version of the handler
 module MailHandler
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/vf-email-handler.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.email                 = 'karl.litterfeldt@videofy.me'
   s.license               = 'MIT-LICENSE'
 
-  s.required_ruby_version = '>=2.1.2'
+  s.required_ruby_version = '>=2.0.0'
 
   s.homepage              = 'http://www.videofy.me'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vf-email-handler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Videofy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-ses
@@ -105,7 +105,6 @@ files:
 - lib/meta/version.rb
 - lib/models/email.rb
 - lib/workers/threaded_worker.rb
-- spec/integration_spec.rb
 - spec/interfaces/ses_spec.rb
 - spec/interfaces/sqs_spec.rb
 - spec/mail_handler_spec.rb
@@ -123,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -136,7 +135,6 @@ signing_key:
 specification_version: 4
 summary: Integrates AWS SQS with SES letting youseemlessly queue emails for sending
 test_files:
-- spec/integration_spec.rb
 - spec/interfaces/ses_spec.rb
 - spec/interfaces/sqs_spec.rb
 - spec/mail_handler_spec.rb