gmailish 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2157ddb5105b3b038cac8f2de54fa826889fdb2
+  data.tar.gz: 48fc9e5d02eeaa557ea49c79be59e4572fbfedf1
+SHA512:
+  metadata.gz: d241af1c987e449f01e020f4cf07e71757abda3ed7d1c8bc84a1775f4369653a803597ed12a03e0b358bb64ba88776c23a8077afb509fd881551d517989bc55a
+  data.tar.gz: 5a4f6b5e6c69004c8cac7ff0cdb760f31e88b874a58b7269ef25348f5ddc2180f0dfe010eca7aadb4d2ef387323fc76f5f632f218a3d53ace51a96d21002d0bd

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.ruby-version
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+coverage.vim
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.simplecov

@@ -0,0 +1,19 @@
+require 'coveralls'
+require 'simplecov-vim/formatter'
+
+SimpleCov.configure do
+  minimum_coverage 95
+  maximum_coverage_drop 5
+
+  start('rails') do
+    formatter SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      Coveralls::SimpleCov::Formatter,
+      SimpleCov::Formatter::VimFormatter
+    ]
+
+    add_group "Long files" do |src_file|
+      src_file.lines.count > 100
+    end
+  end
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+  - bundle exec rspec spec/
+rvm:
+  - 2.0.0
+  - 1.9.3
+notifications:
+  email:
+    - chuckjhardy@gmail.com

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'coveralls', require: false
+
+# Specify your gem's dependencies in gmailish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Charles J Hardy
+
+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,89 @@
+[![Build Status](https://travis-ci.org/ChuckJHardy/Gmailish.png)](https://travis-ci.org/ChuckJHardy/Gmailish) [![Coverage Status](https://coveralls.io/repos/ChuckJHardy/Gmailish/badge.png?branch=master)](https://coveralls.io/r/ChuckJHardy/Gmailish) [![Gem Version](https://badge.fury.io/rb/gmailish.png)](https://rubygems.org/gems/gmailish)
+
+# Gmailish
+
+Grabs unread emails from Gmail, marks them as read, applies a `Transfered` label and archives them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gmailish', '~> 0.0.1'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gmailish
+
+## Usage
+
+See Mail documentation [here](http://github.com/mikel/mail).
+
+	account = Gmailish::Account.new(username, password)
+	#=> #<Gmailish::Account:0x007f89dcaa7950>
+	
+	account.process
+	#=> #<Gmailish::Account:0x007ff175d69ed0>
+	
+	messages = account.messages
+	#=> [#<Mail::Message:70337520506800>, #<Mail::Message:70337520506801>]
+	
+	message = messages.first
+
+	message.envelope.from   #=> 'chuckjhardy@gmail.com'
+	message.from.addresses  #=> ['chuckjhardy@gmail.com', 'venkmanapp@gmail.com']
+	message.sender.address  #=> 'chuckjhardy@gmail.com'
+	message.to              #=> 'chuckjhardy@gmail.com'
+	message.cc              #=> 'chuckjhardy@gmail.com'
+	message.subject         #=> "This is the subject"
+	message.date.to_s       #=> '15 Aug 2013 09:55:06 -1100'
+	message.message_id      #=> '<4D6AA7GB.8170198@xxx.xxx>'
+	message.body.decoded    #=> 'This is the body of the email..
+	
+## Example
+
+	GmailService.retrieve
+	#=> [#<Mail::Message:70337520506800>, #<Mail::Message:70337520506801>]
+
+	class GmailService
+	  def self.retrieve
+	    new.messages
+	  end
+
+	  def messages
+	    @messages ||= mailer.messages
+	  end
+
+	  private
+
+	  def mailer
+	    Gmailish::Account.new(username, password).tap do |account|
+	      account.process
+	    end
+	  end
+
+	  def username
+	    ENV['GMAIL_EMAIL']
+	  end
+
+	  def password
+	    ENV['GMAIL_PASSWORD']
+	  end
+	end
+
+## Requirements
+
+* ruby > 1.9.x
+* net/imap
+* [Mail](http://rubygems.org/gems/mail)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

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

data/gmailish.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gmailish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gmailish"
+  spec.version       = Gmailish::VERSION
+  spec.authors       = ["Charles J Hardy"]
+  spec.email         = ["chuckjhardy@gmail.com"]
+  spec.description   = %q{Grabs unread emails for Gmail, marks them as read, applies a given label and archives them.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/ChuckJHardy/Gmailish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "mail", "~> 2.5.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "rspec-fire", "~> 1.1.3"
+  spec.add_development_dependency "simplecov", "~> 0.7.1"
+  spec.add_development_dependency "simplecov-vim", "~> 0.0.1"
+end

data/lib/gmailish.rb

@@ -0,0 +1,7 @@
+require "gmailish/version"
+require 'net/imap'
+require 'mail'
+
+module Gmailish; end
+
+require 'gmailish/all'

data/lib/gmailish/account.rb

@@ -0,0 +1,41 @@
+module Gmailish
+  class Account
+    ADDRESS = 'imap.gmail.com'
+    PORT = 993
+    UNREAD = 'UNSEEN'
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+    end
+
+    def self.process(username, password)
+      new(username, password).process
+    end
+
+    def process
+      actions.process { messages }
+      self
+    end
+
+    def messages
+      @messages ||= account.uid_search([UNREAD]).map do |uid|
+        Message.process(account, uid)
+      end
+    end
+
+    private
+
+    attr_reader :username, :password
+
+    def account
+      @account ||= Net::IMAP.new(ADDRESS, PORT, true, nil, false)
+    end
+
+    def actions
+      @actions ||= Actions.new(account, username, password)
+    end
+  end
+end
+
+

data/lib/gmailish/actions.rb

@@ -0,0 +1,53 @@
+module Gmailish
+  class Actions
+    attr_accessor :logged_in
+
+    INBOX = 'inbox'
+
+    def initialize(account, username, password)
+      @account = account
+      @username = username
+      @password = password
+      @logged_in = false
+    end
+
+    def process(&block)
+      if block_given?
+        login
+        inbox
+        yield
+        logout
+      else
+        raise Error::NoMessageError, "Messages must be passed within a block."
+      end
+    end
+
+    def logged_in?
+      logged_in
+    end
+
+    private
+
+    attr_reader :account, :username, :password
+
+    def login
+      account.login(username, password).tap do |response|
+        @logged_in = true if ok?(response)
+      end
+    end
+
+    def logout
+      account.logout.tap do |response|
+        @logged_in = false if ok?(response)
+      end
+    end
+
+    def inbox
+      account.select(INBOX)
+    end
+
+    def ok?(response)
+      response && response.name == 'OK'
+    end
+  end
+end

data/lib/gmailish/all.rb

@@ -0,0 +1,7 @@
+require_relative 'error'
+require_relative 'account'
+require_relative 'actions'
+require_relative 'message'
+require_relative 'labeler'
+require_relative 'flagger'
+require_relative 'mover'

data/lib/gmailish/error.rb

@@ -0,0 +1,6 @@
+module Gmailish
+  module Error
+    class NoMessageError < StandardError; end
+    class NoLabelError < StandardError; end
+  end
+end

data/lib/gmailish/flagger.rb

@@ -0,0 +1,27 @@
+module Gmailish
+  class Flagger
+    DELETED = :Deleted
+    UNREAD = :Seen
+
+    def initialize(account, uid)
+      @account = account
+      @uid = uid
+    end
+
+    def delete
+      flag(DELETED)
+    end
+
+    def unread
+      flag(UNREAD)
+    end
+
+    private
+
+    attr_reader :account, :uid
+
+    def flag(name)
+      account.uid_store(uid, "+FLAGS", [name])
+    end
+  end
+end

data/lib/gmailish/labeler.rb

@@ -0,0 +1,29 @@
+module Gmailish
+  class Labeler
+    TRANSFERED = 'Transfered'
+    ARCHIVE = '[Gmail]/All Mail'
+
+    def initialize(account, uid)
+      @account = account
+      @uid = uid
+    end
+
+    def transfered
+      label(TRANSFERED)
+    end
+
+    def all_mail
+      label(ARCHIVE)
+    end
+
+    private
+
+    attr_reader :account, :uid
+
+    def label(name)
+      account.uid_copy(uid, name)
+    rescue
+      raise Error::NoLabelError, "Manually create `#{name}' label."
+    end
+  end
+end

data/lib/gmailish/message.rb

@@ -0,0 +1,42 @@
+module Gmailish
+  class Message
+    RFC = 'RFC822'
+
+    def initialize(account, uid)
+      @account = account
+      @uid = uid
+    end
+
+    def self.process(account, uid)
+      new(account, uid).process
+    end
+
+    def process
+      message
+      actions
+      message
+    end
+
+    private
+
+    attr_reader :account, :uid
+
+    def actions
+      Labeler.new(account, uid).transfered
+      Flagger.new(account, uid).unread
+      Mover.new(account, uid).archive
+    end
+
+    def raw
+      @raw ||= Array(account.uid_fetch(uid, RFC)).first
+    end
+
+    def body
+      raw.attr[RFC] unless raw.nil?
+    end
+
+    def message
+      @message ||= Mail.new(body)
+    end
+  end
+end

data/lib/gmailish/mover.rb

@@ -0,0 +1,25 @@
+module Gmailish
+  class Mover
+    def initialize(account, uid)
+      @account = account
+      @uid = uid
+    end
+
+    def archive
+      all_mail
+      delete
+    end
+
+    private
+
+    attr_reader :account, :uid
+
+    def all_mail
+      Labeler.new(account, uid).all_mail
+    end
+
+    def delete
+      Flagger.new(account, uid).delete
+    end
+  end
+end