postmark-mitt 0.0.1

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "multi_json"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Randy Schmidt
+
+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.rdoc

@@ -0,0 +1,73 @@
+= Postmark Mitt
+
+(This is only a prototype at the moment, it hasn't been built as a real gem yet. There are no tests.)
+
+This gem provides a little wrapper object for taking JSON from Postmark's incoming email system and composing it back into an object resembling an email. This comes in handy when you are trying to figure out what to do with the email.
+
+== Install
+
+    gem install postmark-mitt
+
+== Example
+
+    require 'lib/postmark_mitt'
+
+    # if you are just playing with this library
+    email = Postmark::Mitt.new(File.read("path/to/json/file/in/spec/fixtures"))
+
+    # if you are doing this in a controller
+    email = Postmark::Mitt.new(request.body.read)
+
+    email.to # "api-hash@inbound.postmarkapp.com"
+    email.from # Bob Bobson <bob@bob.com>
+    email.from_email # bob@bob.com
+    email.text_body
+    email.html_body
+    email.headers # returns a hash of the headers
+
+    email.attachments # array of attachment objects
+
+    attachment = email.attachments.first
+    attachment.file_name
+    attachment.content_type
+    attachment.read # will base64 decode the content... eventually this will lazy-load the file from Postmark
+    attachment.size # NYI
+    # You get the idea
+
+A lot of times you want to do something with the email, like create a post
+
+    mitt = Postmark::Mitt.new(request.body.read)
+    Post.create_from_postmark(mitt)
+
+    class Post
+      def self.create_from_postmark(mitt)
+        author = User.find_by_api_email(mitt.to)
+        handle_no_author # send an email back saying we couldn't find them
+        post = new
+        post.title = mitt.subject
+        post.author = author
+        post.photo = mitt.attachments.first.read
+        post.message_id = mitt.message_id # Make sure we don't process the same email twice
+        # You get the idea, right?
+        post.save
+        post
+      end
+    end
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+* Send me a pull request. Bonus points for topic branches.
+
+== Authors & Contributors
+
+* Randy Schmidt
+
+== Copyright
+
+Copyright (c) 2011 Randy Schmidt. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "postmark-mitt"
+  gem.homepage = "http://github.com/r38y/postmark-mitt"
+  gem.license = "MIT"
+  gem.summary     = %q{PROTOTYPE Mitt for incoming email through Postmark}
+  gem.description = %q{(Prototype) This gem will help you take JSON posted to your app from incoming email through Postmark. It will turn it back into an object with methods to help inspect the contents of the email}
+  gem.email = "randy@forge38.com"
+  gem.authors = ["Randy Schmidt"]
+  gem.add_dependency "multi_json"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "postmark-mitt #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/postmark/mitt.rb

@@ -0,0 +1,102 @@
+module Postmark
+  class Mitt
+    VERSION = "0.0.1"
+
+    def initialize(json)
+      @raw = json
+      @source = MultiJson.decode(json)
+    end
+
+    attr_reader :raw, :source
+
+    def inspect
+      "<Postmark::Mitt: #{message_id}>"
+    end
+
+    def subject
+      source["Subject"]
+    end
+
+    def from
+      source["From"].gsub('"', '')
+    end
+
+    def from_email
+      if match = from.match(/^.+<(.+)>$/)
+        match[1]
+      else
+        from_email
+      end
+    end
+
+    def to
+      source["To"]
+    end
+
+    def bcc
+      source["Bcc"]
+    end
+
+    def cc
+      source["Cc"]
+    end
+
+    def reply_to
+      source["ReplyTo"]
+    end
+
+    def html_body
+      source["HtmlBody"]
+    end
+
+    def text_body
+      source["TextBody"]
+    end
+
+    def mailbox_hash
+      source["MailboxHash"]
+    end
+
+    def tag
+      source["Tag"]
+    end
+
+    def headers
+      @headers ||= source["Headers"].inject({}){|hash,obj| hash[obj["Name"]] = obj["Value"]; hash}
+    end
+
+    def message_id
+      source["MessageID"]
+    end
+
+    def attachments
+      @attachments ||= begin
+        raw_attachments = source["Attachments"] || []
+        raw_attachments.map{|a| Attachment.new(a)}
+      end
+    end
+
+    class Attachment
+      def initialize(attachment_source)
+        @source = attachment_source
+      end
+      attr_accessor :source
+
+      def content_type
+        source["ContentType"]
+      end
+
+      def file_name
+        source["Name"]
+      end
+
+      def read
+        Base64.decode64(source["Content"])
+      end
+
+      def size
+        "NYI"
+      end
+    end
+  end
+end

data/lib/postmark_mitt.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'multi_json'
+require 'base64'
+require 'postmark/mitt'

data/spec/fixtures/email.json

@@ -0,0 +1,54 @@
+{
+  "Attachments": [
+    {
+      "Content": "iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAIAAAAP3aGbAAAABmJLR0QA\/wD\/AP+gvaeTAAAHFklEQVR4nO3dUWojSRRFwdHQ+9+yegE99BQ4eXonFfFt7HJJHPLnkq\/3+\/0PQMG\/n34AgKcEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjJ+ffoB\/tvr9fr0I3zM+\/3+35958n62\/Z5TnjzPKb6H2zhhARmCBWQIFpAhWECGYAEZggVkCBaQIVhAhmABGYIFZAgWkLF0S\/jEzq3T353apk3u+2595lPfn2\/+Hs5zwgIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCAjvCV8wn15P3fq\/yregXhK8fPayQkLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CAjMu3hMzYdgcit3LCAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIMOW8FqT9wmecupewrvv5vtmTlhAhmABGYIFZAgWkCFYQIZgARmCBWQIFpAhWECGYAEZggVkXL4lvHVTtm0neGoDOPm3Jr8bt34P5zlhARmCBWQIFpAhWECGYAEZggVkCBaQIVhAhmABGYIFZAgWkBHeEk7el7fN5FZucru3bQP4xDd\/D+c5YQEZggVkCBaQIVhAhmABGYIFZAgWkCFYQIZgARmCBWQIFpCxdEu4bS+2za3vZ9ve8Nb33OWEBWQIFpAhWECGYAEZggVkCBaQIVhAhmABGYIFZAgWkCFYQMZr51pq211vp97Stvv7bn3PT0xuEiff87Y95llOWECGYAEZggVkCBaQIVhAhmABGYIFZAgWkCFYQIZgARmCBWRcfi\/htr3Yrfu+bc88+TzbdnnbnucsJywgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIylm4Jt23TTtm2bZz8Pczo7gSfcMICMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgY+mWcNLkvq+489r2zMU95uTf2vZ5neWEBWQIFpAhWECGYAEZggVkCBaQIVhAhmABGYIFZAgWkCFYQEZ4S\/hkM3Vqd7bt92xTfD+T273J93P3JtEJC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgIylW8Jtu7NTJp9n2+bulG2f++T7ufUzfc4JC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgIylW8Jb3Xpn3DdvP2+9S3EnJywgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyXjtXRaf2Wbdur259P9vu+Nu2Eyz+rbOcsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8hYuiWcNLlfe2LbLm9yc7dtI\/nNdpbBCQvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsICMX59+gM\/buZn6u233CRbf4eQzb7sHsLu1dMICMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgY+mWsLt1+rknm7Li3XzbnueJyQ1g8f3Mc8ICMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgY+mW8IniXXjFvdg336k3+X\/d+g7PcsICMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgI7wlfOLW3dmkbf\/XqTsZu3u6n9v2mT7nhAVkCBaQIVhAhmABGYIFZAgWkCFYQIZgARmCBWQIFpAhWEDG5VvCW227K\/CJ4h1\/2\/aGtrFOWECGYAEZggVkCBaQIVhAhmABGYIFZAgWkCFYQIZgARmCBWTYEl7r1O5sclO2bbs3yU7wCScsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMi7fEnY3U3ts2\/dtu3PwyfOcukeyeB\/lWU5YQIZgARmCBWQIFpAhWECGYAEZggVkCBaQIVhAhmABGYIFZLx2Lo+27dcmndqUTf6tnd+iGbd+V3d+pk5YQIZgARmCBWQIFpAhWECGYAEZggVkCBaQIVhAhmABGYIFZCzdEgL8yQkLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyBAsIEOwgAzBAjIEC8gQLCBDsIAMwQIyBAvIECwgQ7CADMECMgQLyPgN6\/l0MFbvnZQAAAAASUVORK5CYII=",
+      "ContentType": "image\/png",
+      "Name": "chart.png"
+    }
+  ],
+  "Bcc": "FBI <hi@fbi.com>",
+  "Cc": "Your Mom <hithere@hotmail.com>",
+  "From": "\"Bob Bobson\" <bob@bob.com>",
+  "Headers": [
+    {
+      "Name": "Received-SPF",
+      "Value": "None (no SPF record) identity=mailfrom; client-ip=209.85.212.52; helo=mail-vw0-f52.google.com; envelope-from=bob@bob.com; receiver=4e8d6dec234dd90018e7bfd2b5d79107@inbound.postmarkapp.com"
+    },
+    {
+      "Name": "MIME-Version",
+      "Value": "1.0"
+    },
+    {
+      "Name": "Date",
+      "Value": "Thu, 31 Mar 2011 12:01:17 -0400"
+    },
+    {
+      "Name": "Message-ID",
+      "Value": "<AANLkTin3nR52muA3Pner1eoLo6GLQz_5iZLTPvwEjZNu@mail.gmail.com>"
+    },
+    {
+      "Name": "Subject",
+      "Value": "Hi There"
+    },
+    {
+      "Name": "From",
+      "Value": "Bob Bobson <bob@bob.com>"
+    },
+    {
+      "Name": "To",
+      "Value": "api-hash@inbound.postmarkapp.com"
+    },
+    {
+      "Name": "Content-Type",
+      "Value": "multipart\/mixed"
+    }
+  ],
+  "HtmlBody": "<p>We no speak americano</p>",
+  "MailboxHash": "moitoken",
+  "MessageID": "a8c1040e-db1c-4e18-ac79-bc5f64c7ce2c",
+  "ReplyTo": "new-comment+sometoken@yeah.com",
+  "Subject": "Hi There",
+  "Tag": "yourit",
+  "TextBody": "\nThis is awesome!\n\n",
+  "To": "api-hash@inbound.postmarkapp.com"
+}

data/spec/postmark/mitt_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/..' + '/spec_helper')
+
+describe Postmark::Mitt do
+  let(:mitt) do
+    Postmark::Mitt.new(read_fixture)
+  end
+
+  it "should have a subject" do
+    mitt.subject.should == "Hi There"
+  end
+
+  it "should have a html_body" do
+    mitt.html_body.should == "<p>We no speak americano</p>"
+  end
+
+  it "should have a text_body" do
+    mitt.text_body.should == "\nThis is awesome!\n\n"
+  end
+
+  it "should be to someone" do
+    mitt.to.should == "api-hash@inbound.postmarkapp.com"
+  end
+
+  it "should be from someone" do
+    mitt.from.should == "Bob Bobson <bob@bob.com>"
+  end
+
+  it "should pull out the from_email" do
+    mitt.from_email.should == "bob@bob.com"
+  end
+
+  it "should have a bcc" do
+    mitt.bcc.should == "FBI <hi@fbi.com>"
+  end
+
+  it "should have a cc" do
+    mitt.cc.should == "Your Mom <hithere@hotmail.com>"
+  end
+
+  it "should have a reply_to" do
+    mitt.reply_to.should == "new-comment+sometoken@yeah.com"
+  end
+
+  it "should have a mailbox_hash" do
+    mitt.mailbox_hash.should == 'moitoken'
+  end
+
+  it "should have a tag" do
+    mitt.tag.should == 'yourit'
+  end
+
+  it "should have a message_id" do
+    mitt.message_id.should == "a8c1040e-db1c-4e18-ac79-bc5f64c7ce2c"
+  end
+
+  it "should have headers" do
+    mitt.headers["Date"].should =="Thu, 31 Mar 2011 12:01:17 -0400"
+  end
+
+  it "should have an attachment" do
+    mitt.attachments.size.should == 1
+  end
+
+  it "should have attachment objects" do
+    mitt.attachments.first.class.name.should == 'Postmark::Mitt::Attachment'
+  end
+
+  describe Postmark::Mitt::Attachment do
+    let(:attachment) do
+      mitt.attachments.first
+    end
+
+    it "should have a content_type" do
+      attachment.content_type.should == 'image/png'
+    end
+
+    it "should have a file_name" do
+      attachment.file_name.should == 'chart.png'
+    end
+
+    it "should read the content" do
+      attachment.read.should_not be_empty
+    end
+
+    it "should have a size" do
+      attachment.size.should == "NYI"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'postmark_mitt'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+SPEC_ROOT = Pathname.new(File.dirname(__FILE__))
+
+def read_fixture(file='email.json')
+  File.read(File.join(SPEC_ROOT, 'fixtures', 'email.json'))
+end
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: postmark-mitt
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Randy Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+description: (Prototype) This gem will help you take JSON posted to your app from incoming email through Postmark. It will turn it back into an object with methods to help inspect the contents of the email
+email: randy@forge38.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/postmark/mitt.rb
+- lib/postmark_mitt.rb
+- spec/fixtures/email.json
+- spec/postmark/mitt_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/r38y/postmark-mitt
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -556844520113005002
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: PROTOTYPE Mitt for incoming email through Postmark
+test_files: 
+- spec/postmark/mitt_spec.rb
+- spec/spec_helper.rb