posten 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5507003d22cfa28e7cb3865873dfa9a2a78e605c
+  data.tar.gz: cf35fd60c024ef13458b75a9acc1ec831c136c5a
+SHA512:
+  metadata.gz: df08b2bdddb0971061ed214f587d8868af81edc94b85238f5b04283ee238e3224c7afc0cd0b3a86a72523a9659747559e8b408750ca17db137844ea334db55da
+  data.tar.gz: 93063845d9e06717188efa7493e7f1c8cf682012c791305b9eb7c6cd04688bc8c2665639bc972b2f8415b7eeb6b7e1baa2a40bdd1286aa21c820c9c7224e8822

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "mt", "0.0.2"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Francesco Rodríguez
+
+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,182 @@
+posten
+======
+
+Mail delivery.
+
+Usage
+-----
+
+Configure the client with your SMTP credentials:
+
+```ruby
+require "posten"
+
+Posten.connect(
+  host: "smtp.posten.gem",
+  port: "587",
+  user: "eve@posten.gem",
+  password: "secret"
+)
+
+# or:
+
+Posten.connect(url: "smtp://eve%40posten.gem:secret@smtp.posten.gem:587")
+```
+
+Use the `deliver` method to send mails:
+
+```ruby
+posten = Posten.new
+
+posten.deliver(
+  from: "bob@posten.gem",
+  to: "alice@posten.gem",
+  subject: "Hei",
+  text: "hvordan går det?",
+  html: "<b>hvordan går det?</b>"
+)
+```
+
+Check [SMTP settings](#smtp-settings) and [Delivery Options](#delivery-options)
+for more supported options.
+
+Defaults
+--------
+
+You can use the `defaults` method to set default values for
+the `deliver` method options.
+
+```ruby
+Posten.defaults(
+  from: "no-reply@posten.gem",
+  cc: "jameson@posten.gem"
+)
+
+posten = Posten.new
+
+posten.deliver(to: "alice@posten.gem", subject: "hei")
+# from: no-reply@posten.gem
+# to: alice@posten.gem
+# cc: jameson@posten.gem
+# subject: =?utf-8?Q?hei?=
+```
+
+Mailers
+-------
+
+You can use inheritance to create mailer classes:
+
+```ruby
+class UserMailer < Posten
+  defaults from: "admin@posten.gem"
+
+  def welcome_mail(user)
+    deliver(
+      to: user.email,
+      subject: "Welcome #{ user.name }!",
+      text: "You have successfully signed up."
+    )
+  end
+end
+
+mailer = UserMailer.new
+mailer.welcome_mail(User.first)
+```
+
+Defaults are inherited but can be changed through the `defaults` method.
+
+Testing
+-------
+
+If you don't want to call the actual delivery method in your tests, you
+can use `posten/test`:
+
+```ruby
+require "posten/test"
+
+posten = Posten.new
+posten.deliver(to: "alice@posten.gem", subject: "hei")
+
+Posten.deliveries.count # => 1
+
+mail = Posten.deliveries.first
+mail.to == "alice@posten.gem" # => true
+mail.subject == "hei"         # => true
+
+mailer = UserMailer.new
+mailer.welcome_mail(User.first)
+
+UserMailer.deliveries.count # => 1
+```
+
+`Posten.deliveries` is simply an array. If you want to have a clean slate,
+you can reset it manually using Array's `clear` method before each test is
+executed. The next example uses the testing library [Cutest][cutest]:
+
+```ruby
+require "cutest"
+require "posten/test"
+
+setup do
+  Posten.deliveries.clear
+end
+
+scope "signup" do
+  test "welcome" do
+    post "/signup", email: "bob@posten.gem", name: "bob"
+
+    assert_equal 1, UserMailer.deliveries.count
+
+    mail = UserMailer.deliveries.first
+
+    assert_equal "bob@posten.gem", mail.to
+    assert /Welcome bob!/ === mail.text
+  end
+end
+```
+
+SMTP Settings
+-------------
+
+This is a list of supported STMP settings:
+
+| Option      | Description                      | Default |
+| ----------- | -------------------------------- | ------- |
+| `:url`      | URL connection                   | `nil`   |
+| `:host`     | hostname or IP address           | `nil`   |
+| `:port`     | port to connect                  | `25`    |
+| `:user`     | user for SMTP authentication     | `nil`   |
+| `:password` | password for SMTP authentication | `nil`   |
+| `:domain`   | HELO domain                      | `nil`   |
+| `:auth`     | type of authentication           | `nil`   |
+| `:tls`      | enables SMTP/TLS                 | `true`  |
+
+Delivery Options
+----------------
+
+This is a list of supported delivery options:
+
+```ruby
+posten = Posten.new
+
+posten.deliver(
+  from: "bob@posten.gem",
+  to: "alice@posten.gem",
+  subject: "Here are some files for you!",
+  text: "This is what people with plain text mail readers will see",
+  html: "A little something <b>special</b> for people with HTML readers",
+  cc: "carboncopy@posten.gem",
+  bcc: "blindcarboncopy@posten.gem",
+  attach: "/path/to/your/file.pdf",
+  attach_as: ["/path/to/your/file.pdf", "new_name.pdf"]
+)
+```
+
+Installation
+------------
+
+```
+$ gem install posten
+```
+
+[cutest]: https://github.com/djanowski/cutest

data/lib/posten.rb

@@ -0,0 +1,37 @@
+require "malone"
+require "seteable"
+require_relative "posten/version"
+
+class Posten
+  include Seteable
+
+  def self.connect(options)
+    settings[:smtp] = options
+  end
+
+  def self.defaults(defaults)
+    settings[:defaults].update(defaults)
+  end
+
+  def initialize
+    @malone = Malone.new(config)
+  end
+
+  private def config
+    return Malone::Configuration.new(smtp_settings)
+  end
+
+  private def smtp_settings
+    settings[:smtp] or raise("Missing configuration: Try `Posten.connect`")
+  end
+
+  def deliver(options)
+    return @malone.deliver(defaults.merge(options))
+  end
+
+  def defaults
+    return settings[:defaults]
+  end
+end
+
+Posten.settings[:defaults] = {}

data/lib/posten/test.rb

@@ -0,0 +1,15 @@
+require "ostruct"
+
+class Posten
+  def self.deliveries
+    return @deliveries ||= []
+  end
+
+  def deliver(options)
+    deliveries << OpenStruct.new(defaults.merge(options))
+  end
+
+  def deliveries
+    return self.class.deliveries
+  end
+end

data/lib/posten/version.rb

@@ -0,0 +1,3 @@
+class Posten
+  VERSION = "0.0.1"
+end

data/makefile

@@ -0,0 +1,5 @@
+default:
+	cutest ./test/*.rb
+
+smtp:
+	mt 2525

data/posten.gemspec

@@ -0,0 +1,19 @@
+require_relative "lib/posten/version"
+
+Gem::Specification.new do |s|
+  s.name        = "posten"
+  s.version     = Posten::VERSION
+  s.summary     = "Mail delivery"
+  s.description = s.summary
+  s.authors     = ["Francesco Rodríguez"]
+  s.email       = ["frodsan@protonmail.ch"]
+  s.homepage    = "https://github.com/harmoni/posten"
+  s.license     = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "malone", "~> 1.1.0"
+  s.add_dependency "seteable", "1.0.0"
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "cutest", "~> 1.2"
+end

data/test/posten_test.rb

@@ -0,0 +1,98 @@
+require "bundler/setup"
+require "cutest"
+require_relative "../lib/posten"
+
+require "malone/test"
+
+setup do
+  Malone.deliveries.clear
+
+  Posten.connect(url: "smtp://foo%40bar.com:pass1234@smtp.gmail.com:587")
+end
+
+test "raise if not smtp settings" do
+  Posten.settings.delete(:smtp)
+
+  assert_raise do
+    Posten.new
+  end
+end
+
+test "settings" do
+  Posten.settings[:foo] = "foo"
+
+  Notifier = Class.new(Posten)
+
+  assert_equal "foo", Notifier.settings[:foo]
+
+  Notifier.settings[:foo] = "bar"
+
+  assert_equal "foo", Posten.settings[:foo]
+  assert_equal "bar", Notifier.settings[:foo]
+end
+
+test "defaults" do
+  Posten.defaults(from: "bob@posten.gem")
+
+  class EveMailer < Posten
+    defaults to: "eve@posten.gem"
+  end
+
+  params = { from: "bob@posten.gem" }
+
+  assert_equal params, Posten.settings[:defaults]
+
+  params = params.merge(to: "eve@posten.gem")
+
+  assert_equal params, EveMailer.settings[:defaults]
+end
+
+test "deliver use defaults" do
+  defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
+
+  Posten.defaults(defaults)
+
+  params = {
+    subject: "subject",
+    text: "text",
+    html: "<html></html>"
+  }
+
+  Posten.new.deliver(params)
+
+  options = Malone.deliveries.last.to_h
+
+  assert_equal options, defaults.merge(params)
+
+  class Mailer < Posten
+    defaults to: "alice@posten.gem"
+  end
+
+  Mailer.new.deliver(params)
+
+  defaults = defaults.merge(to: "alice@posten.gem")
+
+  options = Malone.deliveries.last.to_h
+
+  assert_equal options, defaults.merge(params)
+end
+
+test "testing" do
+  require_relative "../lib/posten/test"
+
+  defaults = { from: "bob@posten.gem", to: "eve@posten.gem" }
+
+  Posten.defaults(defaults)
+
+  params = {
+    subject: "subject",
+    text: "text",
+    html: "<html></html>"
+  }
+
+  Posten.new.deliver(params)
+
+  mail = Posten.deliveries.first
+
+  assert_equal defaults.merge(params), mail.to_h
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: posten
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Francesco Rodríguez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: malone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: seteable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Mail delivery
+email:
+- frodsan@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- lib/posten.rb
+- lib/posten/test.rb
+- lib/posten/version.rb
+- makefile
+- posten.gemspec
+- test/posten_test.rb
+homepage: https://github.com/harmoni/posten
+licenses:
+- MIT
+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.8
+signing_key: 
+specification_version: 4
+summary: Mail delivery
+test_files: []