gmail 0.4.2 → 0.5.0

data/spec/spec_helper.rb

@@ -1,29 +1,53 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
 require 'rspec'
-require 'mocha'
 require 'yaml'
 require 'gmail'
 
-RSpec.configure do |config| 
-  config.mock_with :mocha
+# require_support_files
+Dir[File.join(File.dirname(__FILE__), 'support', '*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  Spec::ImapMock.configure_rspec!(config)
 end
 
 def within_gmail(&block)
-  gmail = Gmail.connect!(*TEST_ACCOUNT)
-  yield(gmail)
-  gmail.logout if gmail
+  Gmail.connect!(*TEST_ACCOUNT) do |gmail|
+    yield(gmail)
+  end
+end
+
+def mock_client(&block)
+  client = Gmail::Client::Plain.new(*TEST_ACCOUNT)
+  client.connect
+
+  if block_given?
+    client.login
+    yield client
+    client.logout
+  end
+
+  client
 end
 
-def mock_mailbox(box="INBOX", &block)
+def mock_mailbox(box = "INBOX", &block)
   within_gmail do |gmail|
-    mailbox = subject.new(gmail, box)
+    mailbox = gmail.mailbox(box)
     yield(mailbox) if block_given?
     mailbox
   end
 end
 
+# TODO: move this to it's own dir; get rid of global variable
 # Run test by creating your own test account with credentials in account.yml
-TEST_ACCOUNT = YAML.load_file(File.join(File.dirname(__FILE__), 'account.yml'))
+# Otherwise default credentials from an obfuscated file are used.
+clear_file = File.join(File.dirname(__FILE__), 'account.yml')
+obfus_file = File.join(File.dirname(__FILE__), 'account.yml.obfus')
+if File.exist?(clear_file)
+  TEST_ACCOUNT = YAML.load_file(clear_file)
+elsif File.exist?(obfus_file)
+  TEST_ACCOUNT = Spec::Obfuscation.decrypt_file(obfus_file)
+else
+  raise 'account.yml file not found'
+end

data/spec/support/imap_mock.rb

@@ -0,0 +1,129 @@
+module Net
+  class IMAP
+    class << self
+      def recordings=(value)
+        @replaying = !value.nil?
+        @recordings = value
+      end
+
+      def recordings
+        @recordings ||= {}
+      end
+
+      def replaying?
+        @replaying
+      end
+    end
+
+    private
+
+    alias_method :_send_command, :send_command
+
+    def self.force_utf8(data)
+      case data.class.to_s
+      when /String/
+        data.force_encoding('utf-8')
+      when /Hash/
+        data.each { |k, v| data[k] = force_utf8(v) }
+      when /Array/
+        data.map { |s| force_utf8(s) }
+      end
+    end
+
+    def send_command(cmd, *args, &block)
+      # In Ruby 1.9.x, strings default to binary which causes the digest to be
+      # different.
+      clean_args = args.dup.each do |s|
+        Net::IMAP.force_utf8(s)
+      end
+
+      yaml_dump = YAML.dump([cmd] + clean_args)
+
+      if RUBY_VERSION =~ /^(1.9|2.0)/
+        # From 1.9 to 2.0 to 2.1, the way YAML encodes special characters changed.
+        # Here's what each returns for: YAML.dump(["", "%"])
+        #   1.9.x: "---\n- ''\n- ! '%'\n"
+        #   2.0.x: "---\n- ''\n- '%'\n"
+        #   2.1.x: "---\n- ''\n- \"%\"\n"
+        # The `gsub` here converts the older format into the 2.1.x.
+        yaml_dump.gsub!(/(?:! )?'(.+)'/, '"\1"')
+
+        # In 1.9 and 2.0 strings starting with `+` or `-` are not escaped in quotes, but
+        # they are in 2.1+. This addresses that.
+        yaml_dump.gsub!(/ ([+-](?:X-GM-\w+|FLAGS))/, ' "\1"')
+
+        # In 1.9 and 2.0 strings starting with `\` are not escaped in quotes, but
+        # they are in 2.1+. This addresses that. Yes we need all those backslashes :|
+        yaml_dump.gsub!(/ \\(\w+)/, ' "\\\\\\\\\1"')
+      end
+
+      digest = "#{cmd}-#{Digest::MD5.hexdigest(yaml_dump)}"
+
+      if Net::IMAP.replaying?
+        recordings = Net::IMAP.recordings[digest] || []
+        if recordings.empty?
+          # Be lenient if LOGOUT is called but wasn't explicitly recorded. This
+          # comes up often when called from `at_exit`.
+          cmd == 'LOGOUT' ? return : raise('Could not find recording')
+        end
+
+        action, response, @responses = recordings.shift
+      else
+        action = :return
+        begin
+          response = _send_command(cmd, *args, &block)
+        rescue => e
+          action = :raise
+          response = e
+        end
+
+        # @responses (the third argument here) contains untagged responses captured
+        # via the Net::IMAP#record_response method.
+        Net::IMAP.recordings[digest] ||= []
+        Net::IMAP.recordings[digest]  << [action, response.dup, @responses ? @responses.dup : nil]
+      end
+
+      raise(response) if action == :raise
+
+      response
+    end
+  end
+end
+
+module Spec
+  module ImapMock
+    # Configures RSpec with an around(:each) block to use IMAP mocks
+    def self.configure_rspec!(config)
+      config.around(:each) do |example|
+        Spec::ImapMock.run_rspec_example(example)
+      end
+    end
+
+    # Run an RSpec example using IMAP mocks
+    def self.run_rspec_example(example)
+      # The path is determined by the rspec `describe`s and `context`s
+      mock_path = example.example_group.to_s
+        .gsub(/RSpec::ExampleGroups::/, '')
+        .gsub(/(\w)([A-Z])/, '\1_\2')
+        .gsub(/::/, '/')
+        .downcase
+
+      # The name is determined by the description of the example.
+      mock_name = example.description.gsub(/[^\w\-\/]+/, '_').downcase
+
+      filename = File.join('spec/recordings/', mock_path, "#{mock_name}.yml")
+
+      # If we've already recorded this spec load the recordings
+      Net::IMAP.recordings = File.exist?(filename) ? YAML.load_file(filename) : nil
+
+      example.run
+
+      # If we haven't yet recorded the spec and there were some recordings,
+      # write them to a file.
+      unless File.exist?(filename) or Net::IMAP.recordings.empty?
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename, 'w') { |f| YAML.dump(Net::IMAP.recordings, f) }
+      end
+    end
+  end
+end

data/spec/support/obfuscation.rb

@@ -0,0 +1,52 @@
+require 'base64'
+require 'yaml'
+
+# Lightweight obfuscation wrapper used to obfuscate account.yml file.
+#
+# CAUTION; this is not intended to be a robust security mechanism. It is simple
+# obfuscation (security through obscurity). There's no strong reason why we couldn't
+# store the credentials in clear text, but just taking an extra step to prevent trouble.
+
+module Spec
+  module Obfuscation
+    def encrypt(data)
+      rot13(Base64.encode64(data))
+    end
+
+    def decrypt(data)
+      Base64.decode64(rot13(data))
+    end
+
+    def rot13(data)
+      data.tr!("A-Za-z", "N-ZA-Mn-za-m")
+    end
+
+    def encrypt_file(file)
+      data = read_if_exist!(file)
+      begin
+        File.open("#{file}.obfus", 'w') { |file| file.write(encrypt(data)) }
+      rescue Exception => e
+        raise "Unable to encrypt #{file}"
+      end
+    end
+
+    def decrypt_file(file)
+      data = read_if_exist!(file)
+      begin
+        return ::YAML::load(decrypt(data))
+      rescue Exception => e
+        raise "Unable to decrypt #{file}"
+      end
+    end
+
+    def read_if_exist!(file)
+      if File.exist?(file)
+        IO.read(file)
+      else
+        raise "File not found #{file}"
+      end
+    end
+
+    extend self
+  end
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: gmail
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Chris Kowalik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2015-01-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: mime
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +56,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -119,31 +105,93 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- TODO.md
 - gmail.gemspec
 - lib/gmail.rb
 - lib/gmail/client.rb
 - lib/gmail/client/base.rb
-- lib/gmail/client/imap_extensions.rb
 - lib/gmail/client/plain.rb
 - lib/gmail/client/xoauth.rb
+- lib/gmail/client/xoauth2.rb
+- lib/gmail/imap_extensions.rb
 - lib/gmail/labels.rb
 - lib/gmail/mailbox.rb
 - lib/gmail/message.rb
 - lib/gmail/version.rb
 - spec/account.yml.example
-- spec/client_spec.rb
+- spec/account.yml.obfus
+- spec/gmail/client/base_spec.rb
+- spec/gmail/client/plain_spec.rb
+- spec/gmail/client/xoauth2_spec.rb
+- spec/gmail/client/xoauth_spec.rb
+- spec/gmail/client_spec.rb
+- spec/gmail/imap_extensions_spec.rb
+- spec/gmail/labels_spec.rb
+- spec/gmail/mailbox_spec.rb
+- spec/gmail/message_spec.rb
 - spec/gmail_spec.rb
-- spec/mailbox_spec.rb
-- spec/message_spec.rb
+- spec/recordings/gmail/_new_connects_with_client_and_give_it_context_when_block_given.yml
+- spec/recordings/gmail/_new_connects_with_gmail_service_and_return_valid_connection_object.yml
+- spec/recordings/gmail/_new_does_not_raise_error_when_couldn_t_connect_with_given_account.yml
+- spec/recordings/gmail/_new_raises_error_when_couldn_t_connect_with_given_account.yml
+- spec/recordings/gmail_client_plain/instance/_connection_automatically_logs_in_to_gmail_account_when_it_s_called.yml
+- spec/recordings/gmail_client_plain/instance/delivers_inline_composed_email.yml
+- spec/recordings/gmail_client_plain/instance/does_not_log_in_when_given_gmail_account_is_invalid.yml
+- spec/recordings/gmail_client_plain/instance/does_not_raise_error_even_though_gmail_account_is_invalid.yml
+- spec/recordings/gmail_client_plain/instance/labels/checks_if_there_is_given_label_defined.yml
+- spec/recordings/gmail_client_plain/instance/labels/creates_given_label.yml
+- spec/recordings/gmail_client_plain/instance/labels/removes_existing_label.yml
+- spec/recordings/gmail_client_plain/instance/labels/returns_list_of_all_available_labels.yml
+- spec/recordings/gmail_client_plain/instance/properly_logs_in_to_valid_gmail_account.yml
+- spec/recordings/gmail_client_plain/instance/properly_logs_out_from_gmail.yml
+- spec/recordings/gmail_client_plain/instance/properly_switches_to_given_mailbox.yml
+- spec/recordings/gmail_client_plain/instance/properly_switches_to_given_mailbox_using_block_style.yml
+- spec/recordings/gmail_client_plain/instance/raises_error_when_given_gmail_account_is_invalid_and_errors_enabled.yml
+- spec/recordings/gmail_client_xo_auth2/instance/does_not_log_in_when_given_gmail_account_is_invalid.yml
+- spec/recordings/gmail_client_xo_auth2/instance/labels/checks_if_there_is_given_label_defined.yml
+- spec/recordings/gmail_client_xo_auth2/instance/labels/creates_given_label.yml
+- spec/recordings/gmail_client_xo_auth2/instance/labels/removes_existing_label.yml
+- spec/recordings/gmail_client_xo_auth2/instance/labels/returns_list_of_all_available_labels.yml
+- spec/recordings/gmail_client_xo_auth2/instance/properly_logs_in_to_valid_gmail_account.yml
+- spec/recordings/gmail_client_xo_auth2/instance/properly_logs_out_from_gmail.yml
+- spec/recordings/gmail_client_xo_auth2/instance/properly_switches_to_given_mailbox.yml
+- spec/recordings/gmail_client_xo_auth2/instance/properly_switches_to_given_mailbox_using_block_style.yml
+- spec/recordings/gmail_client_xo_auth2/instance/raises_error_when_given_gmail_account_is_invalid_and_errors_enabled.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/all/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/drafts/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/flagged/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/important/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/inbox/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/junk/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/sent/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_labels/localize/when_given_the_xl_is_tflag/trash/localizes_into_the_appropriate_label.yml
+- spec/recordings/gmail_mailbox/instance/counts_all_emails.yml
+- spec/recordings/gmail_mailbox/instance/finds_messages.yml
+- spec/recordings/gmail_mailbox/on_initialize/sets_client_and_name.yml
+- spec/recordings/gmail_mailbox/on_initialize/works_in_inbox_by_default.yml
+- spec/recordings/gmail_message/initialize/sets_prefetch_attrs.yml
+- spec/recordings/gmail_message/initialize/sets_uid_and_mailbox.yml
+- spec/recordings/gmail_message/instance_methods/deletes_itself.yml
+- spec/recordings/gmail_message/instance_methods/marks_itself_read.yml
+- spec/recordings/gmail_message/instance_methods/marks_itself_unread.yml
+- spec/recordings/gmail_message/instance_methods/moves_from_one_tag_to_other.yml
+- spec/recordings/gmail_message/instance_methods/removes_a_given_label.yml
+- spec/recordings/gmail_message/instance_methods/removes_a_given_label_with_old_method.yml
+- spec/recordings/gmail_message/instance_methods/sets_given_label.yml
+- spec/recordings/gmail_message/instance_methods/sets_given_label_with_old_method.yml
 - spec/spec_helper.rb
-homepage: http://github.com/nu7hatch/gmail
-licenses: []
+- spec/support/imap_mock.rb
+- spec/support/obfuscation.rb
+homepage: http://github.com/gmailgem/gmail
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -166,3 +214,4 @@ signing_key:
 specification_version: 4
 summary: A Rubyesque interface to Gmail, with all the tools you will need.
 test_files: []
+has_rdoc: 

data/TODO.md

@@ -1,12 +0,0 @@
-# TODO
-
-* Specs for xoauth 
-* Specs for message operations
-* Specs for filters in mailbox
-* Specs for current [Gmail IMAP extensions](http://code.google.com/apis/gmail/imap/)
-* Non-English accounts
-* Further implement [Gmail IMAP extensions](http://code.google.com/apis/gmail/imap/)
-  * add custom search (X-GM-RAW)
-  * add thread id (X-GM-THRID)
-* Export/Import to mbox format
-* Integration with [contacts](http://rubygems.org/gems/contacts) gem

data/lib/gmail/client/imap_extensions.rb

@@ -1,54 +0,0 @@
-# Taken from https://github.com/oxos/gmail-oauth-thread-stats/blob/master/gmail_imap_extensions_compatibility.rb
-
-module GmailImapExtensions
-
-  def self.patch_net_imap_response_parser(klass = Net::IMAP::ResponseParser)
-    klass.class_eval do
-      def msg_att
-        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