leadersend 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce9b8259f8b1e82631796939e260515e24b9f5a0
+  data.tar.gz: 1bfa1fe938bddb1a1f7da47d7be64729658a5e9d
+SHA512:
+  metadata.gz: e5a905477a67dc7213822f7d64672bd8f94a4a871b615e026e69531a3f21dbb88156d1b001a7aeeaca2740e74ae8c07d8fa8433089972702f3eb82563fbd59a1
+  data.tar.gz: 5646ef8c222edf8f8005ad3b5892fc2b24480b8a3f5af18cbd277a2dee45e2d8e3328b260a111ac800773a00b75ba977955e77d73552792982ce5244aa93e98e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in leadersend.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Epigene
+
+MIT License
+
+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,88 @@
+# Leadersend
+
+Ruby wrapper for Leadersend transactional email sending service
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'leadersend'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install leadersend
+
+## Usage
+
+LS can be used instead of Leadersend
+
+### Configure
+```ruby
+# /config/initializers/leadersend.rb
+
+Leadersend.configure do |config|
+  config.username = "example@domain.com"
+  config.api_key  = "0953e545acdf063cb8a903a174gh721f" # place your key here
+  config.api_url  = "http://api.leadersend.com/1.0/?output=json" # leave as is
+  config.host     = "smtp.leadersend.com" # leave as is
+end
+```
+
+Setup ActionMailer::Base.smtp_settings with
+```ruby
+ActionMailer::Base.smtp_settings = {
+  :address        => Leadersend.config.host,
+  :port           => '587',
+  :authentication => :plain,
+  :user_name      => Leadersend.config.username,
+  :password       => Leadersend.config.api_key,
+  :domain         => 'example-domain.com'
+}
+```
+
+### Send Email
+Instantiate a Leadersend::Mail object with given parameters
+```ruby
+mailer = Leadersend::Mail.new to: self.email, from: from, fromname: fromname, subject: subject, template_path: template_path, locals: locals, title: title
+```
+Parameter examples and explanations:
+```ruby
+to: "example@email.com"
+from: "coworker@company.com"
+fromname: "Bob"
+subject: "Friday party!"
+template_path = "delivery/partials/party_markup"
+title = "It is friday!"
+locals = {variable: value, another_variable: different_value} # These will be made available in the template
+```
+
+Call the #send method on the instantiated objecto send an email. This method returns a hash
+```ruby
+sent_mail_hash = mailer.send
+```
+
+### Log the sending
+Result hash content and explanations:
+```ruby
+{
+  title: @title,
+  body: @template, # returns the actual markup generated
+  status: status, # very useful, returns "sent" on success and "error" on fail
+  subject: @subject,
+  to_address: @to,
+  response: result.inspect # a verbose repeat of what you already knew, for example
+  :response=>"[{\"email\"=>\"example@email.com\", \"status\"=>\"sent\", \"id\"=>\"ecf0ea8f33df690a02c83ccc86x678be\"}]"
+}
+```
+
+Use this information to populate a logging object like SentMail
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/leadersend.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'leadersend/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "leadersend"
+  spec.version       = Leadersend::VERSION
+  spec.date          = Date.today.to_s
+  spec.authors       = ["Epigene", "Sacristan", "artursbraucs"]
+  spec.email         = ["augusts.bautra@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for LeaderSend, the Transactional Email Delivery Service}
+  spec.description   = %q{Ruby wrapper for LeaderSend, the Transactional Email Delivery Service}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.2.0"
+end

data/lib/leadersend.rb

@@ -0,0 +1,35 @@
+require 'leadersend/version'
+require 'leadersend/mailer'
+
+module Leadersend
+  ROOT = File.expand_path("../..", __FILE__)
+
+  def self.root
+    return ROOT
+  end
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+
+  class Config
+    attr_accessor :api_url, :host, :username, :api_key
+
+    def initialize
+      @api_url  = "http://api.leadersend.com/1.0/?output=json"
+      @host     = "smtp.leadersend.com"
+      @username = "example@domain.com"
+      @api_key  = "0953e545acdf063cb8a903a174gh721f"
+    end
+
+  end
+
+  Leadersend.configure {}
+end
+
+LS = Leadersend

data/lib/leadersend/mailer.rb

@@ -0,0 +1,58 @@
+module Leadersend
+  class Mail
+    def initialize to: nil, from: nil, fromname: nil, subject: "System", template_path: nil, locals: {}, title: "System"
+      @api_email_url = LEADERSEND_API_URL
+      @api_user = LEADERSEND_USERNAME
+      @api_key = LEADERSEND_API_KEY
+      @to = to
+      @subject = subject
+      @template_path = template_path
+      @locals = locals
+      @title = title
+      @from = from
+      @fromname = fromname
+      @template_path = template_path
+
+      if @template_path
+        @template = ApplicationController.new.render_to_string(:partial => @template_path, :locals => @locals )
+      end
+    end
+
+    def send
+      result = call_api
+      status = (result[0] && result[0]["status"]) ? result[0]["status"] : "error"
+      return {
+        title: @title,
+        body: @template,
+        status: status,
+        subject: @subject,
+        to_address: @to,
+        response: result.inspect
+      }
+    end
+
+    def call_api
+      subject = @subject
+      fromname = @fromname
+      options = {method: "messagesSend", apikey: @api_key, to: {email: @to}, subject: @subject, html: @template, from: {name: @fromname, email: @from}, auto_plain: true}
+      resp = post_api @api_email_url, options
+      json = JSON.parse(resp)
+      puts json
+      return json
+    rescue => e
+      return [{"status" => "error", "description" => "<#{e.class.name}>: #{e.message}"}]
+    end
+
+    private
+
+      def post_api url, params
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = false
+        form_params = params.to_query
+        res = http.post(uri.request_uri, form_params)
+        res.body
+      end
+
+  end
+end

data/lib/leadersend/version.rb

@@ -0,0 +1,3 @@
+module Leadersend
+  VERSION = "1.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'leadersend' # and any other gems you need
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+end

data/spec/tests/basic_spec.rb

@@ -0,0 +1,21 @@
+# rspec spec/tests/basic_spec.rb
+describe "Leadersend" do
+  it "#root returns gem root" do
+    expect(Leadersend.root).to eq File.expand_path("../../..", __FILE__)
+  end
+
+  describe "config" do
+    it "default username should be ok" do
+      expect(Leadersend.config.username).to eq "example@domain.com"
+    end
+    it "default api_key should be ok" do
+      expect(Leadersend.config.api_key).to eq "0953e545acdf063cb8a903a174gh721f"
+    end
+    it "default api_url should be ok" do
+      expect(Leadersend.config.api_url).to eq "http://api.leadersend.com/1.0/?output=json"
+    end
+    it "default host should be ok" do
+      expect(Leadersend.config.host).to eq "smtp.leadersend.com"
+    end
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: leadersend
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Epigene
+- Sacristan
+- artursbraucs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Ruby wrapper for LeaderSend, the Transactional Email Delivery Service
+email:
+- augusts.bautra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- leadersend.gemspec
+- lib/leadersend.rb
+- lib/leadersend/mailer.rb
+- lib/leadersend/version.rb
+- spec/spec_helper.rb
+- spec/tests/basic_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for LeaderSend, the Transactional Email Delivery Service
+test_files:
+- spec/spec_helper.rb
+- spec/tests/basic_spec.rb