gmail-api-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24b38375594da2fabd46ccde5cb098b9d5cfebc9
+  data.tar.gz: d67652090a269c623f7930ae74660f3b56813d7a
+SHA512:
+  metadata.gz: 286c48ccfce4c9551296e2d24fd44e13654fbad378295502e3ddae54ab18b5afae1224bdd34adc2772fe72c3810b94493f4e9f446b0b7dae531c502e4ba48198
+  data.tar.gz: 573ca19b9f5f4ffcc8bdd272a6a86d5d0ab21d7414f0bc36ff4f070a343b1ef5fc8a412d1509d4fc582bc7cad65fd0dfa75e8ae83a4791b520a48c65d98c957c

data/.gitignore

@@ -0,0 +1,34 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## rubymine
+.idea
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+Gemfile.lock
+
+## Gem build
+.gem
+
+## PROJECT::SPECIFIC
+*.rdb
+
+## Test Account details
+spec/account.yml
+env.yml
+spec/

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Gmail gem changelog
+## 0.0.1 / 2015-01
+
+* Birthday!
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyrignt (c) 2015 Julien Hobeika
+
+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,218 @@
+# GMail for Ruby
+
+A Rubyesque interface to Google's GMail, with all the tools you'll need. Search, 
+read and send multipart emails, archive, mark as read/unread, delete emails, 
+and manage labels. Everything goes through Gmail API (and not throught IMAP or SMTP protocols)
+
+# Notice
+
+If for your usecase, the gem is too limited there are two solutions for you:
+
+1- Contribute ;)
+2- Look at Gmail Api doc (https://developers.google.com/gmail/api/v1/reference) to:
+    *Do custom query by adding parameters I didn't talk about in my doc
+    *If for some reason I forgot to build some methods, note that you can call fully custom request via Gmail.client (Standard Google Api Client)
+
+# To Do
+
+Write test
+write proper error handling
+
+## Installation
+
+    gem install gmail-ruby-api
+
+## initialisation
+
+    Gmail.client_id = "...Your app client id..."
+    Gmail.client_secret = "...Your app Secret..."
+    Gmail.refresh_token = "...the refresh token of the Gmail account you want to use..."
+
+## Usage
+
+    require "Gmail"
+
+### Common methods
+
+this works for Messages, Labels, Drafts and Threads (everything)
+   Gmail::Message.all
+   Gmail::Message.all(maxResults: -1) #will parse everything. Use with care. Can through request timeout if used in web apps
+   Gmail::Message.get(message_id)
+   some_gmail_message.delete
+this will work for Messages and Threads
+   some_message.archive
+   some_message.un_archive
+   some_message.trash
+   some_message.un_trash
+   some_message.star
+   some_message.un_star
+   some_message.mark_as_read
+   some_message.mark_as_unread
+
+   Gmail::Message.search(in: "labelId" from: "me@gmail.com", to: "you@gmail.com, theothers@gmail.com", subject: "some subject", after: "date", before: "date", has_words: "some words", has_not_words: "some text")
+   Gmail::Message.search("some words") #search as you would do in gmail interface
+
+
+
+### Message
+
+Create a Message object
+
+    m = Gmail::Message.new(
+        from: "test@test.com",
+        to: "hello@world.com",
+        subject: "this is the subject",
+        body: "this is a text body")
+
+If you want a multipart message
+
+    m = Gmail::Message.new(
+        from: "test@test.com",
+        to: "hello@world.com",
+        subject: "this is the subject",
+        text: "this is a text body",
+        html: "<div>this is a html body</div>",
+        labelIds: ["cool label", "Newsletter"] #labelIds is always array of labels
+        )
+
+From this you can create a Draft in Gmail
+
+    m.create_draft
+
+or just send the Message
+
+    m.deliver
+
+Notice that the Message object can use from, to, cc, bcc, threadId, labelIds, text, html, body
+
+If you need to send Message or create draft with custom headers or set other headers.
+Or if you need to create a different multipart email, you need to build the "raw" email yourself
+
+example:
+
+    mail = Mail.new #this is the native ruby Mail object
+    #
+    # construct your Mail object
+    #
+    raw = Base64.urlsafe_encode64 mail.to_s
+    m = Gmail::Message.new(raw: raw)
+
+In that scenario, you still assign, if needed, ThreadId and labelIds as previously
+
+    m.threadId = "somethreadId"
+    m.labelIds = ["cool label"]
+
+If you want to quickly generate a reply or a forward to message
+
+    # this will handle everything for you, keeping the subject the thread etc as it would happen in Gmail
+      # reply only to the sender of Message m.
+        m.reply_sender_with Gmail::Message.new(body: "some reply text")
+      # reply to all (sender, to (without yourself) and cc)
+        m.reply_all_with Gmail::Message.new(body: "some reply text")
+      # forward
+        m.forward_with Gmail::Message.new(body: "some forward text", to: "address@toforward.com")
+
+Other stuffs that you can do with Message object
+
+    m.detailed #if for any reason Google did send us the full detail of on email object
+    m.thread #to get the associated Thread
+    m.inbox? #to know if email is in inbox
+    m.sent? #to know if email is a sent email
+    m.unread? #to know if email is unread
+
+Those are basics helpers feel free to add more if you want (ex: starred?, important?, etc)
+
+
+## Thread
+
+Get a thread
+   one_thread = Gmail::Thread.get(thread_id)
+or
+   one_thread = one_message.thread
+
+Filter messages in Thread
+
+   one_thread.unread_messages
+   one_thread.sent_messages
+
+Expand messages in Thread
+
+   one_thread.detailed #this will return a thread object but with all messages detailed
+   one_thread.messages #this will return an array of message objects
+
+## Draft
+
+As we explained in Message, you create a draft with
+
+    d = some_message.create_draft
+
+Modify it with
+
+    d.message.subject = "some different subject than before"
+    d.save
+
+send it with
+
+    d.deliver
+
+## Label
+
+You can create a label like this:
+
+    l = Gmail::Label.new
+    l.name = "different Name"
+    l.messageListVisibility = "hide" #can be 'hide' or 'show'
+    l.labelListVisibility = "labelShowIfUnread" #can be "labelShowIfUnread", "labelShow", "labelHide"
+    l.save
+
+You can modify a label like this:
+
+    l = Gmail::Label.get("labelId")
+    l.name = "different Name"
+    l.messageListVisibility = "hide"
+    l.labelListVisibility = "labelShowIfUnread"
+    l.save
+
+You can use Labels to directly access box information
+
+    l.detailed #will display number of messages and number of threads if you don't see it
+
+For system labels like inbox, sent, trash, important, starred, draft, spam, unread, category_updates, category_promotions, category_social, category_personal, category_forums
+
+    l = Gmail::Label.inbox
+
+Access threads and messages from labels
+
+    l.threads
+    l.messages
+
+    l.unread_threads
+    l.unread_messages
+
+Access threads, drafts and messages with labels
+
+    Gmail::Message.all(labelIds: ["UNREAD", "INBOX"])
+
+
+## License
+
+Copyrignt (c) 2015 Julien Hobeika
+
+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

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Gmail API for Ruby #{Gmail::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec do
+    abort 'Run `gem install rspec` to install RSpec'
+  end
+end
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO
+
+*proper errors handling
+*write test

data/gmail.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path('../lib', __FILE__)
+require 'gmail/version'
+
+Gem::Specification.new do |s|
+  s.name = "gmail-api-ruby"
+  s.summary = "A Rubyesque interface to Gmail API (NO IMAP, NO SMTP), with all the tools you will need."
+  s.description = "A Rubyesque interface to Gmail, with all the tools you will need.
+  Search, read and send multipart emails; archive, mark as read/unread,
+  delete emails; and manage labels.
+  "
+  s.version = Gmail::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Julien Hobeika"]
+  s.homepage = "http://github.com/jhk753/gmail-ruby-api"
+  
+  # runtime dependencies
+  s.add_dependency "mime", ">= 0.1"
+  s.add_dependency "mail", ">= 2.2.1"
+  s.add_dependency 'google-api-client'
+  s.add_dependency "hooks"
+  s.add_dependency "hashie"
+  
+  # development dependencies
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "mocha", ">= 0.9"
+  s.add_development_dependency "gem-release"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/gmail.rb

@@ -0,0 +1,112 @@
+require 'mail'
+require 'date'
+require 'time'
+require 'hashie'
+require 'hooks'
+require 'google/api_client'
+require 'gmail/gmail_object'
+require 'gmail/api_resource'
+#base
+require 'gmail/base/create'
+require 'gmail/base/delete'
+require 'gmail/base/get'
+require 'gmail/base/list'
+require 'gmail/base/update'
+require 'gmail/base/modify'
+require 'gmail/base/trash'
+
+#object
+require 'gmail/util'
+require 'gmail/message'
+require 'gmail/draft'
+require 'gmail/thread'
+require 'gmail/label'
+
+
+
+module Gmail
+  begin
+    @client_id ||= YAML.load_file("env.yml")["GOOGLE_CLIENT_ID"]
+    @client_secret ||= YAML.load_file("env.yml")["GOOGLE_CLIENT_SECRET"]
+    @refresh_token ||= YAML.load_file("env.yml")["GOOGLE_REFRESH_TOKEN"]
+  rescue
+
+  end
+
+  class << self
+    attr_accessor :client_id, :client_secret, :refresh_token, :client, :service
+  end
+
+  def self.request(method, params={}, body={})
+    params[:userId] ||= "me"
+    if @client.nil?
+      self.connect
+    end
+    if body.empty?
+      response = @client.execute(
+          :api_method => method,
+          :parameters => params,
+
+          :headers => {'Content-Type' => 'application/json'})
+    else
+
+     response =  @client.execute(
+          :api_method => method,
+          :parameters => params,
+          :body_object => body,
+          :headers => {'Content-Type' => 'application/json'})
+    end
+    parse(response)
+
+  end
+
+  def self.connect(client_id=@client_id, client_secret=@client_secret, refresh_token=@refresh_token)
+    unless client_id
+      raise 'No client_id specified'
+    end
+
+    unless client_secret
+      raise 'No client_secret specified'
+    end
+
+    unless refresh_token
+      raise 'No refresh_token specified'
+    end
+
+    @client = Google::APIClient.new(
+        application_name: 'Juliedesk',
+        application_version: '1.0.0'
+    )
+    @client.authorization.client_id = client_id
+    @client.authorization.client_secret = client_secret
+    @client.authorization.refresh_token = refresh_token
+    @client.authorization.grant_type = 'refresh_token'
+    @client.authorization.fetch_access_token!
+
+    @service = @client.discovered_api('gmail', 'v1')
+
+  end
+
+  def self.parse(response)
+    begin
+      # Would use :symbolize_names => true, but apparently there is
+      # some library out there that makes symbolize_names not work.
+      if response.body.empty?
+        return response.body
+      else
+        response = JSON.parse(response.body)
+      end
+
+    rescue JSON::ParserError
+      raise "error code: #{response.error},body: #{response.body})"
+    end
+
+    r = Util.symbolize_names(response)
+    if r[:error]
+      raise "#{r[:error]}"
+    end
+    r
+  end
+
+
+end # Gmail