development_notification 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28d2600b70196fdd52b4dd3a38d76a498f854154
+  data.tar.gz: 84315114a54495fdc0c9a36bb1f94b19f9eb4b7e
+SHA512:
+  metadata.gz: 24ab4a084fdfe87c0895f8d5aed0db373d00562fe358bf33294702e378cac17ecbe94518174ad6440c118f66f357cfb2c35835cb8bab6338716053d08e7cbe4a
+  data.tar.gz: 0470695a2cf9cb47343bc423601bc6431ea41f381cd155996d6b8ff426c70496e455fb06c34dbbaf455557e3ad2a95e2c91cc968c84bb9c9cded1df2637cfaae

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# DevelopmentNotification
+
+## Installation
+
+Point to this repo (or a fork) and bundle
+```
+gem 'development_notification', "0.1.0", git: 'https://github.com/CreativePublisher/development_notification', branch: 'master'
+```
+
+Run migration
+```
+$ rake db:migrate
+```
+
+## Configuration
+
+```ruby
+# in /config/initializers/development_notification.rb
+DevelopmentNotification.configure do |config|
+  config.leadersend_username = "email@example.com"
+  config.leadersend_api_key = "0933e545acxc063cb8a101a374cc721f"
+  config.domain = "example.com"
+  config.validate! # must be called in the very end.
+end
+```
+
+## Usage
+After setup you gain access to:
+* DevelopmentNotification::Email model that logs email prepared and sent.
+* DevelopmentNotification::Email.send_email(parameter_hash) #=> sends emails
+
+### Email sending
+DevelopmentNotification::Email.send_email(title: "Systemside identifier", to: "dump@example.com", from: "creative@inbox.lv", fromname: "Creative", subject: "test", template: "html body")
+
+## Gotchas
+* Engine uses smart migration inclusion, this works well in development, but production deployment that migrates selectively (like mina) may fail at detecting migrations. Be sure to __force migration__ in production.
+* Sometimes production does not load the gem. Append `require: false` in gemfile, and add the line `require 'development_notification'` to `/config/application.rb`
+
+## Development
+You need to configure the dummy app database in `spec/dummy/config/database.yml`

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DevelopmentNotification'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/development_notification/email.rb

@@ -0,0 +1,38 @@
+module DevelopmentNotification
+  class Email < ActiveRecord::Base
+    # def self.params
+    #   return %i|title to_address subject body response status|
+    # end
+
+    validates :title, presence: true
+    validates :to_address, presence: true
+    validates :subject, presence: true
+    validates :status, presence: true
+
+    def self.send_email(title: nil, to: nil, from: nil, fromname: nil, subject: nil, template: nil, template_path: nil, locals: nil)
+
+      mailer = Leadersend::Mail.new(title: title, to: to, from: from, fromname: fromname, subject: subject, template: template)
+      leadersend_response_hash = mailer.send
+
+      mail_object = DevelopmentNotification::Email.create_from_leadersend_response_hash(leadersend_response_hash)
+
+      return mail_object
+
+      # TODO add differentiation based on template/template_path argument to use raw html or path accordingly.
+    end
+
+    # private
+
+      def self.statuses
+        ActiveSupport::HashWithIndifferentAccess.new(new: 0, sent: 1, error: 2)
+      end
+
+      def self.create_from_leadersend_response_hash(**hash)
+        hash[:status] = self.statuses[hash[:status]]
+        sent_mail = self.new(hash.symbolize_keys, :without_protection => true)
+        sent_mail.save
+        return sent_mail
+      end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+DevelopmentNotification::Engine.routes.draw do
+end

data/db/migrate/20151106101824_create_development_notification_emails.rb

@@ -0,0 +1,14 @@
+class CreateDevelopmentNotificationEmails < ActiveRecord::Migration
+  def change
+    create_table :development_notification_emails do |t|
+      t.string :title, index: true, null: false
+      t.string :to_address, index: true, null: false
+      t.string :subject, index: true, null: false
+      t.text   :body
+      t.text   :response
+      t.integer :status, index: true, null: false, default: 0
+
+      t.timestamps
+    end
+  end
+end

data/lib/development_notification.rb

@@ -0,0 +1,45 @@
+require "development_notification/engine"
+require 'leadersend'
+
+module DevelopmentNotification
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+
+  class Config
+    attr_accessor :leadersend_username, :leadersend_api_key, :domain
+
+    def validate!
+      raise ArgumentError.new("DevelopmentNotification did not receive all three configuration pieces!") unless @leadersend_username && @leadersend_api_key && @domain
+      Config.email_sending
+      return true
+    end
+
+    def self.email_sending
+      Leadersend.configure do |config|
+        config.username = DevelopmentNotification.config.leadersend_username
+        config.api_key  = DevelopmentNotification.config.leadersend_api_key
+      end
+
+      ActionMailer::Base.smtp_settings = {
+        :address        => Leadersend.config.host,
+        :port           => '587',
+        :authentication => :plain,
+        :user_name      => Leadersend.config.username,
+        :password       => Leadersend.config.api_key,
+        :domain         => DevelopmentNotification.config.domain
+      }
+
+      ActionMailer::Base.delivery_method = :smtp
+      ActionMailer::Base.default_url_options[:host] = DevelopmentNotification.config.domain
+    end
+
+  end
+
+end

data/lib/development_notification/engine.rb

@@ -0,0 +1,19 @@
+module DevelopmentNotification
+  class Engine < ::Rails::Engine
+    isolate_namespace DevelopmentNotification
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.integration_tool :rspec
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s == root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+  end
+end

data/lib/development_notification/version.rb

@@ -0,0 +1,3 @@
+module DevelopmentNotification
+  VERSION = "0.0.4"
+end

data/lib/tasks/development_notification_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :development_notification do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: development_notification
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Creative
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: leadersend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enables sending simple emails to app owners. Wraps [Leadersend](http://www.leadersend.com)
+  mail delivery service and defines a DevelopmentNotification::Email model for logging.
+email:
+- hi@creative.gs
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/development_notification/email.rb
+- config/routes.rb
+- db/migrate/20151106101824_create_development_notification_emails.rb
+- lib/development_notification.rb
+- lib/development_notification/engine.rb
+- lib/development_notification/version.rb
+- lib/tasks/development_notification_tasks.rake
+homepage: http://creative.gs/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Allow your rails app to send emails to dev team.
+test_files: []