macaco 0.0.1 → 0.0.2

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .env
 .ruby-version
 .ruby-gemset
+fixtures/vcr_cassettes/*

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0.0
+- jruby-19mode
+- rbx-19mode
+env:
+  global:
+    secure: RRPan9WyIeNkwnDDHlmL+BgwSVP7dLcdUc7ZBQ4MF/XWH6dbkkTu5wDGxRnnI/Rjuwz1GKBpbV74La7X/3QrAQeQIUu5B/jdj2CgZvrTt2ngsbsPcLqLJXd6cCIUqBt125tkyPMDn3n/s1flloVvTLYRWZHwG0jOZiVy5rEdf9Q=

data/Gemfile

@@ -4,4 +4,7 @@ gemspec
 
 group :test do
   gem 'minitest'
+  gem 'webmock'
+  gem 'vcr'
+  gem 'rake'
 end

data/README.md

@@ -1,6 +1,7 @@
 # Macaco
+[![Build Status](https://travis-ci.org/jamesduncombe/macaco.png?branch=master)](https://travis-ci.org/jamesduncombe/macaco)
 
-Tiny wrapper around [Mandrill's API](https://mandrillapp.com/api/docs/)
+Tiny wrapper around (for now) [Mandrill API's send method](https://mandrillapp.com/api/docs/messages.JSON.html#method=send). Later to be expanded to handle Sendgrid's send method too.
 
 ## Installation
 
@@ -18,8 +19,11 @@ Or install it yourself as:
 
 ## Usage
 
-You can configure Macaco to use an API by passing a block to the
-configure method. Here I've used an environment variable:
+By default Macaco tries to find your mail API key with the `MACACO_API_KEY`
+environment variable.
+
+However, you can configure Macaco to use a different key by passing a block to the
+configure method. Here I've used a different environment variable:
 
 ```ruby
 Macaco.configure do |config|
@@ -29,30 +33,29 @@ end
 
 At the moment we just have the [send message](https://mandrillapp.com/api/docs/messages.JSON.html#method=send) method. Use it like this:
 
-Form your data hash:
+First create a new mail object:
 
 ```ruby
-data = {
-  message: {
-    text: 'Boom boom',
-    html: '''
-      <h1>My email title</h1>
-      <p>My email body</p>
-      <small>Monkey Corp Ltd</small>
-    ''',
-    subject: 'Test subject',
-    from_email: 'james@jamesduncombe.com',
-    to: [{ email: 'james@jamesduncombe.com' }]
-  }
-}
+mail = Macaco::Mandrill.new do
+  to 'to@test.com'
+  from 'from@test.com'
+  subject 'This is my subject'
+  body_html '<h1>This is a title</h1>'
+  body_text 'This is my text version'
+end
 ```
 
 Then call the method:
 
 ```ruby
-Macaco::Messages.send_message(data)
+mail.send
 ```
 
+## Todo
+
+- Add further reflection methods to be able to inspect the mail object
+- Add support for Sendgrid's send method
+
 
 ## Contributing
 
@@ -61,3 +64,27 @@ Macaco::Messages.send_message(data)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2013 James Duncombe
+
+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/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task :default => [:test]

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('macaco', 'rake')

data/lib/macaco.rb

@@ -3,7 +3,9 @@ require 'json'
 require 'open-uri'
 
 require 'macaco/version'
-require 'macaco/messages'
+require 'macaco/api'
+require 'macaco/senders/sender'
+require 'macaco/senders/mandrill'
 
 module Macaco
   class << self
@@ -16,12 +18,11 @@ module Macaco
   end
 
   class Configuration
-    attr_accessor :api_key, :api_root, :api_port
+    attr_accessor :api_key, :sender
 
     def initialize
-      @api_key = ENV['MANDRILL_API_KEY']
-      @api_root = 'mandrillapp.com'
-      @api_port = 443
+      @api_key  = ENV['MACACO_API_KEY']
+      @sender   = :mandrill
     end
   end
-end
+end

data/lib/macaco/api.rb

@@ -0,0 +1,30 @@
+module Macaco
+  class Api
+
+    def self.post(args = {})
+
+      request = request_instance(args)
+      request.body = args[:data].to_json
+
+      JSON.parse(http_response(request, args).body)
+
+    end
+
+    private
+
+      def self.http_response(request, args)
+        http_instance(args).start { |http| http.request(request) }
+      end
+
+      def self.request_instance(args)
+        Net::HTTP::Post.new(args[:mail].api_path, initheader = { 'Content-Type' => 'application/json' })
+      end
+
+      def self.http_instance(args)
+        http = Net::HTTP.new(args[:mail].api_root, 443)
+        http.use_ssl = true
+        http
+      end
+
+  end
+end

data/lib/macaco/senders/mandrill.rb

@@ -0,0 +1,34 @@
+module Macaco
+  class Mandrill < Sender
+
+    def api_key
+      Macaco.config.api_key || ENV['MACACO_API_KEY']
+    end
+
+    def api_root
+      'mandrillapp.com'
+    end
+
+    def api_path
+      '/api/1.0/messages/send.json'
+    end
+
+    def to_hash
+      {
+        message: {
+          from_email: @from,
+          to: @to,
+          subject: @subject,
+          html: @body_html,
+          text: @body_text
+        }
+      }
+    end
+
+    def send
+      data = to_hash.merge!({ key: api_key })
+      Macaco::Api.post({ mail: self, data: data })
+    end
+
+  end
+end

data/lib/macaco/senders/sender.rb

@@ -0,0 +1,64 @@
+module Macaco
+  class Sender
+
+    def initialize(*args, &block)
+      @body_html = nil
+      @body_text = nil
+      @text      = nil
+      @to        = []
+      @from      = nil
+      @subject   = nil
+
+      if args.first.is_a? Hash
+        hash_attributes(args.first)
+      end
+
+      if block_given?
+        instance_eval(&block)
+      end
+
+      self
+    end
+
+    def hash_attributes(args)
+      to      args[:to]
+      from    args[:from]
+      subject args[:subject]
+      body_html args[:body_html]
+      body_text args[:body_text]
+    end
+
+    def to(val = nil)
+      return @to unless val
+      @to << { email: val }
+    end
+
+    def from(val = nil)
+      return @from unless val
+      @from ||= val
+    end
+
+    def subject(val = nil)
+      return @subject unless val
+      @subject ||= val
+    end
+
+    def body_html(val = nil)
+      return @body_html unless val
+      @body_html ||= val
+    end
+    alias_method :html, :body_html
+
+    def body_text(val = nil)
+      return @body_text unless val
+      @body_text ||= val
+    end
+    alias_method :text, :body_text
+
+    # helpers - could be split out?
+
+    def to_json
+      to_hash.to_json
+    end
+  end
+end

data/lib/macaco/version.rb

@@ -1,3 +1,3 @@
 module Macaco
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/macaco.gemspec

@@ -8,9 +8,10 @@ Gem::Specification.new do |gem|
   gem.version       = Macaco::VERSION
   gem.authors       = ["James Duncombe"]
   gem.email         = ["james@jamesduncombe.com"]
-  gem.summary       = %q{A tiny gem to handle Mandrill's API}
-  gem.description   = %q{Tiny gem to handle Mandrill's API without other gem dependencies}
+  gem.summary       = %q{Tiny wrapper around Mandrill API's send method}
+  gem.description   = %q{Tiny gem to wrap Mandrill API's send method without other gem dependencies}
   gem.homepage      = "https://github.com/jamesduncombe/macaco"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/lib/macaco/senders/mandrill_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Macaco::Mandrill do
+
+  let(:mail) do
+    Macaco::Mandrill.new do
+      to      'to@test.com'
+      from    'from@test.com'
+      subject 'Subject for my email'
+      body_html '<h1>This is a header for the HTML version</h1>'
+      body_text 'This is the Text version'
+    end
+  end
+
+  describe '#api_root' do
+    it { Macaco::Mandrill.new.api_root.must_equal 'mandrillapp.com' }
+  end
+
+  describe '#api_path' do
+    it { Macaco::Mandrill.new.api_path.must_equal '/api/1.0/messages/send.json' }
+  end
+
+  describe '#to_hash' do
+    subject { mail.to_hash }
+    it { subject.must_be_kind_of Hash }
+  end
+
+  describe '#to_json' do
+    it 'converts the mandrill hash into a JSON string' do
+      mail.to_json.must_be_kind_of String
+    end
+  end
+
+  describe '#send' do
+    subject do
+      VCR.use_cassette('send') do
+        mail.send
+      end
+    end
+    it { subject.must_be_kind_of Array }
+    it { subject.first['status'].must_equal 'sent' }
+  end
+end

data/spec/lib/macaco/senders/sender_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Macaco::Sender do
+
+  let(:mail) do
+    Macaco::Sender.new do
+      to      'to@test.com'
+      from    'from@test.com'
+      subject 'Subject for my email'
+      body_html '<h1>This is a header for the HTML version</h1>'
+      body_text 'This is the Text version'
+    end
+  end
+
+  describe '#hash_attributes' do
+    it 'creates a new mail record via hash' do
+      m = Macaco::Sender.new( from: 'from@test.com', to: 'to@test.com', subject: 'Test' )
+      m.from.must_equal 'from@test.com'
+    end
+  end
+
+  describe '#to' do
+    it 'sets the recipient if theres a string provided' do
+      mail.to.must_equal [ { email: 'to@test.com' } ]
+    end
+  end
+
+  describe '#from' do
+    it 'sets the from address' do
+      mail.from.must_equal 'from@test.com'
+    end
+  end
+
+  describe '#subject' do
+    it 'sets the subject address' do
+      mail.subject.must_equal 'Subject for my email'
+    end
+  end
+
+  describe '#body_html' do
+    it 'sets the body html' do
+      n = Macaco::Sender.new
+      n.body_html '<h1>This is a test</h1>'
+      n.body_html.must_equal '<h1>This is a test</h1>'
+    end
+  end
+
+  describe '#body_text' do
+    it 'sets the body text' do
+      n = Macaco::Sender.new
+      n.body_text 'This is a test'
+      n.body_text.must_equal 'This is a test'
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,7 +1,18 @@
-ENV['RACK_ENV'] = 'test'
+require 'rubygems'
 require 'bundler'
 Bundler.require
 require 'minitest/autorun'
 require 'minitest/pride'
 
-require './lib/macaco'
+require 'vcr'
+
+require 'macaco'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end
+
+Macaco.configure do |config|
+  config.api_key = ENV['MANDRILL_API_KEY']
+end

metadata

@@ -1,58 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: macaco
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - James Duncombe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies: []
-description: Tiny gem to handle Mandrill's API without other gem dependencies
+description: Tiny gem to wrap Mandrill API's send method without other gem dependencies
 email:
 - james@jamesduncombe.com
-executables: []
+executables:
+- rake
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rake
 - lib/macaco.rb
-- lib/macaco/messages.rb
+- lib/macaco/api.rb
+- lib/macaco/senders/mandrill.rb
+- lib/macaco/senders/sender.rb
 - lib/macaco/version.rb
 - macaco.gemspec
-- spec/lib/macaco/messages_spec.rb
+- spec/lib/macaco/senders/mandrill_spec.rb
+- spec/lib/macaco/senders/sender_spec.rb
 - spec/lib/macaco_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jamesduncombe/macaco
-licenses: []
-metadata: {}
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
-summary: A tiny gem to handle Mandrill's API
+specification_version: 3
+summary: Tiny wrapper around Mandrill API's send method
 test_files:
-- spec/lib/macaco/messages_spec.rb
+- spec/lib/macaco/senders/mandrill_spec.rb
+- spec/lib/macaco/senders/sender_spec.rb
 - spec/lib/macaco_spec.rb
 - spec/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: cfd7cbd8435ea89f75b2cd6cadfdcad5b36b3a6d
-  data.tar.gz: 55f493eb3e10f825f35fdfbb588926dd3165c13c
-SHA512:
-  metadata.gz: 535d25ad21a393b6568396a329909026a9cb3f244f1e8f688c9391d5cfa1701b8bc00bf31cc8a8c5fc299faac086e817f0e1eb1dceb836601a423c2f8770bb06
-  data.tar.gz: f1eaf76c759b8f9883c2cc9a27e72eb5d32457bcb75ba32b7dbd1dbaabca86565147a2997c2148511c3ded7ea0dc6e6a84ae4d3b04ede20e6ae910a9c1967036

data/lib/macaco/messages.rb

@@ -1,22 +0,0 @@
-module Macaco
-  class Messages
-
-    def self.send_message(data)
-
-      data.merge!({ key: Macaco.config.api_key })
-
-      request = Net::HTTP::Post.new('/api/1.0/messages/send.json',
-                                    initheader = { 'Content-Type'=> 'application/json' })
-      request.body = data.to_json
-      http = Net::HTTP.new(Macaco.config.api_root, Macaco.config.api_port)
-      http.use_ssl = true
-
-      response = http.start do |http|
-        http.request(request)
-      end
-
-      JSON.parse(response.body)
-
-    end
-  end
-end

data/spec/lib/macaco/messages_spec.rb

@@ -1,28 +0,0 @@
-require 'spec_helper'
-
-describe Macaco::Messages do
-
-  describe '#send_message' do
-    subject do
-      data = {
-        message: {
-          text: 'Boom boom',
-          html: '''
-            <h1>My email title</h1>
-            <p>My email body</p>
-            <small>Monkey Corp Ltd</small>
-          ''',
-          subject: 'Test subject',
-          from_email: 'james@jamesduncombe.com',
-          to: [{ email: 'james@jamesduncombe.com' }]
-        }
-      }
-      Macaco.configure do |config|
-        config.api_key = ENV['MANDRILL_API_KEY']
-      end
-      Macaco::Messages.send_message(data)
-    end
-    it { subject.must_be_kind_of Array }
-    it { subject.first['status'].must_equal 'sent' }
-  end
-end