gmail_oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bc71816a3aeaf18aa75b53396b71029ac1466ee
+  data.tar.gz: bb7a8933489d5cb03fe5cf94498fbf145b164061
+SHA512:
+  metadata.gz: d16cfc270f1eb82ba4585ddbec94e98c9dadae7c38646527f8245d89787ef7a0d255edca81263a63570298939ec2087fd1b89754917e54a2d1d172b1d575e738
+  data.tar.gz: 4fc0636d9314c11b5e7f3a269631964b89bed2c551c838ae1d6770a6508dfd8fc61d1ba8a50917d500a80cd05514199e97c12f0c038b047c8277faad172cb46a

data/lib/gmail_oauth.rb

@@ -0,0 +1,21 @@
+require 'net/imap'
+require 'mail'
+require 'gmail_xoauth'
+require 'mimemagic'
+require 'mimemagic/overlay'
+require 'gmail_oauth/version'
+require 'gmail_oauth/gmail_imap_extensions'
+require 'gmail_oauth/client'
+require 'gmail_oauth/message'
+require 'gmail_oauth/attachment'
+
+module GmailOauth
+
+  def self.authenticate(email, access_token)
+    imap_client = Net::IMAP.new('imap.gmail.com', 993, usessl=true, certs=nil, verify=false)
+    client = Client.new(imap_client, email, access_token)
+    client.connect
+    client
+  end
+
+end

data/lib/gmail_oauth/attachment.rb

@@ -0,0 +1,20 @@
+class GmailOauth::Attachment
+
+  attr_reader :content, :mime_type, :file_name
+
+  def initialize(attachment)
+    @file_name = attachment.filename
+    @content = attachment.body.decoded
+    @mime_type = get_mime_type
+  end
+
+  def file_extension
+    @file_name.split(".").last
+  end
+
+  def get_mime_type
+    if mime_obj = MimeMagic.by_magic(content[0..10000])
+      mime_obj.type
+    end
+  end
+end

data/lib/gmail_oauth/client.rb

@@ -0,0 +1,63 @@
+class GmailOauth::Client
+
+  attr_reader :imap, :email, :access_token
+
+  # Initialize a new imap session and authenticate using the oauth2 access
+  # token.
+  def initialize(imap_client, email_param, access_token_param)
+    @imap = imap_client
+    @email = email_param
+    @access_token = access_token_param
+    GmailOauth::GmailImapExtensions.patch_net_imap_response_parser imap.
+      instance_variable_get("@parser").singleton_class
+  end
+
+  def connect
+    imap.authenticate('XOAUTH2', email, access_token)
+  end
+
+  # Select appropriate mailbox. Ex: 'INBOX', '[Gmail]/All Mail',
+  # '[Gmail]/Drafts', '[Gmail]/Spam', '[Gmail]/Trash', '[Gmail]/Starred' 
+  def select_mailbox(mailbox='INBOX')
+    imap.select(mailbox)
+  end
+
+  def get_uids(last_seen_uid=0)
+    imap.uid_search(search_param(last_seen_uid))
+  end
+
+  def fetch_emails(uids, &block)
+    messages = Array.new
+    uids.each_slice(10) do |grp|
+      connect if imap.disconnected?
+      emails = imap.uid_fetch(grp.compact, 'RFC822')
+      emails.each do |email|
+        message = GmailOauth::Message.new(Mail.
+                  read_from_string(email.attr['RFC822']), email.attr['UID']) 
+        yield(message) if block_given?
+        messages << message
+      end
+    end
+    messages
+  end
+
+  def fetch_threaded_emails(thread_id, &block)
+    email_uids = imap.uid_search("X-GM-THRID #{thread_id}")
+    messages = fetch_emails(email_uids)
+    yield(thread_id, messages) if block_given?
+    messages
+  end
+
+  def get_thread_ids(uids)
+    thread_responses = imap.uid_fetch(uids, '(X-GM-THRID)')
+    thread_responses.map { |t| t.attr['X-GM-THRID'] }
+  end
+
+  private
+
+  def search_param(last_seen_uid)
+    return "ALL" if last_seen_uid == 0
+    next_uid = last_seen_uid.to_i + 1
+    return "UID #{next_uid}:*"
+  end
+end

data/lib/gmail_oauth/gmail_imap_extensions.rb

@@ -0,0 +1,57 @@
+# Net::IMAP raises an exception when fetching attributes related to 
+# Gmail IMAP extended attributes.
+# Based on the patch by https://github.com/OXOS
+# https://github.com/OXOS/gmail-oauth-thread-stats/blob/master/gmail_imap_extensions_compatibility.rb
+module GmailOauth
+  module GmailImapExtensions
+
+    def self.patch_net_imap_response_parser(klass = Net::IMAP::ResponseParser)
+      klass.class_eval do
+        def msg_att(n)
+          match(Net::IMAP::ResponseParser::T_LPAR)
+          attr = {}
+          while true
+            token = lookahead
+            case token.symbol
+            when Net::IMAP::ResponseParser::T_RPAR
+              shift_token
+              break
+            when Net::IMAP::ResponseParser::T_SPACE
+              shift_token
+              token = lookahead
+            end
+            case token.value
+            when /\A(?:ENVELOPE)\z/ni
+              name, val = envelope_data
+            when /\A(?:FLAGS)\z/ni
+              name, val = flags_data
+            when /\A(?:INTERNALDATE)\z/ni
+              name, val = internaldate_data
+            when /\A(?:RFC822(?:\.HEADER|\.TEXT)?)\z/ni
+              name, val = rfc822_text
+            when /\A(?:RFC822\.SIZE)\z/ni
+              name, val = rfc822_size
+            when /\A(?:BODY(?:STRUCTURE)?)\z/ni
+              name, val = body_data
+            when /\A(?:UID)\z/ni
+              name, val = uid_data
+
+              # Gmail extension additions.
+              # Cargo-Cult code warning: # I have no idea why the regexp - just copying a pattern
+            when /\A(?:X-GM-LABELS)\z/ni
+              name, val = flags_data
+            when /\A(?:X-GM-MSGID)\z/ni 
+              name, val = uid_data
+            when /\A(?:X-GM-THRID)\z/ni 
+              name, val = uid_data
+            else
+              parse_error("unknown attribute `%s'", token.value)
+            end
+            attr[name] = val
+          end
+          return attr
+        end
+      end
+    end
+  end
+end

data/lib/gmail_oauth/message.rb

@@ -0,0 +1,36 @@
+class GmailOauth::Message
+
+  attr_reader :uid, :email, :subject, :to, :from, :cc, :received_on
+
+  def initialize(email, uid = 0)
+    @email = email
+    @uid = uid
+    @to = email.to
+    @from = email.from
+    @subject = email.subject
+    @cc = email.cc
+    @received_on = email.date
+  end
+
+  ["text", "html"].each do |format|
+    define_method("body_#{format}") do 
+      return nil unless email.send("#{format}_part")
+      body = email.send("#{format}_part").body.raw_source
+      decoded_text = Mail::Encodings.decode_encode(body, 'UTF-8')
+      return Mail::Encodings.value_decode(decoded_text)
+    end
+  end
+
+  def has_attachments?
+    !email.attachments.blank?
+  end
+
+  def get_attachments
+    return [] unless has_attachments?
+    attachments = []
+    email.attachments.each do |attach|
+      attachments << GmailOauth::Attachment.new(attach) 
+    end
+    attachments
+  end
+end

data/lib/gmail_oauth/version.rb

@@ -0,0 +1,3 @@
+module GmailOauth
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: gmail_oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karthik Mallavarapu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.3
+- !ruby/object:Gem::Dependency
+  name: gmail_xoauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.34'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: "The library uses gmail_xoauth, mail and monkey-patched\n                          ruby
+  imap library to support gmail oauth extensions \n                          such
+  as X-GM-THRID. Supports fetching uids, emails, \n                          threaded
+  emails, attachments and much more."
+email:
+- karthik.mallavarapu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gmail_oauth.rb
+- lib/gmail_oauth/attachment.rb
+- lib/gmail_oauth/client.rb
+- lib/gmail_oauth/gmail_imap_extensions.rb
+- lib/gmail_oauth/message.rb
+- lib/gmail_oauth/version.rb
+homepage: https://github.com/karthik-mallavarapu/gmail_oauth
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby gem for accessing gmail using oauth2 tokens.
+test_files: []