gmail 0.3.0

data/lib/gmail/version.rb

@@ -0,0 +1,12 @@
+module Gmail
+  class Version #:nodoc:
+    STRING = File.open(File.join(File.dirname(__FILE__), "../../VERSION")).read.strip
+    MAJOR  = STRING.split(".")[0]
+    MINOR  = STRING.split(".")[1]
+    TINY   = STRING.split(".")[2]
+  end # Version
+  
+  def self.version # :nodoc:
+    Version::STRING
+  end 
+end # Gmail

data/spec/client_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+describe "Gmail client" do
+  subject { Gmail::Client }
+  
+  context "on initialize" do
+    it "should set username, password and options" do
+      client = subject.new("test@gmail.com", "pass", :foo => :bar)
+      client.username.should == "test@gmail.com"
+      client.password.should == "pass"
+      client.options[:foo].should == :bar
+    end
+    
+    it "should convert simple name to gmail email" do 
+      client = subject.new("test", "pass")
+      client.username.should == "test@gmail.com"
+    end
+  end
+  
+  context "instance" do
+    def mock_client(&block) 
+      client = Gmail::Client.new(*TEST_ACCOUNT)
+      if block_given?
+        client.connect
+        yield client
+        client.logout
+      end
+      client
+    end
+   
+    it "should connect to GMail IMAP service" do 
+      lambda { 
+        client = mock_client
+        client.connect!.should be_true
+      }.should_not raise_error(Gmail::Client::ConnectionError)
+    end
+    
+    it "should properly login to valid GMail account" do
+      client = mock_client
+      client.connect.should be_true
+      client.login.should be_true
+      client.should be_logged_in
+      client.logout
+    end
+    
+    it "should raise error when given GMail account is invalid and errors enabled" do
+      lambda {
+        client = Gmail::Client.new("foo", "bar")
+        client.connect.should be_true
+        client.login!.should_not be_true
+      }.should raise_error(Gmail::Client::AuthorizationError)
+    end
+    
+    it "shouldn't login when given GMail account is invalid" do
+      lambda {
+        client = Gmail::Client.new("foo", "bar")
+        client.connect.should be_true
+        client.login.should_not be_true
+      }.should_not raise_error(Gmail::Client::AuthorizationError)
+    end
+    
+    it "should properly logout from GMail" do 
+      client = mock_client
+      client.connect
+      client.login.should be_true
+      client.logout.should be_true
+      client.should_not be_logged_in
+    end
+    
+    it "#connection should automatically log in to GMail account when it's called" do
+      mock_client do |client|
+        client.expects(:login).once.returns(false)
+        client.connection.should_not be_nil
+      end
+    end
+    
+    it "should properly compose message" do 
+      mail = mock_client.compose do
+        from "test@gmail.com"
+        to "friend@gmail.com"
+        subject "Hello world!"
+      end
+      mail.from.should == ["test@gmail.com"]
+      mail.to.should == ["friend@gmail.com"]
+      mail.subject.should == "Hello world!"
+    end
+    
+    it "#compose should automatically add `from` header when it is not specified" do
+      mail = mock_client.compose
+      mail.from.should == [TEST_ACCOUNT[0]]
+      mail = mock_client.compose(Mail.new)
+      mail.from.should == [TEST_ACCOUNT[0]]
+      mail = mock_client.compose {}
+      mail.from.should == [TEST_ACCOUNT[0]]
+    end
+    
+    it "should deliver inline composed email" do
+      mock_client do |client|
+        client.deliver do 
+          to TEST_ACCOUNT[0]
+          subject "Hello world!"
+          body "Yeah, hello there!"
+        end.should be_true
+      end
+    end
+    
+    it "should not raise error when mail can't be delivered and errors are disabled" do
+      lambda { 
+        client = mock_client
+        client.deliver(Mail.new {}).should be_false
+      }.should_not raise_error(Gmail::Client::DeliveryError)
+    end
+    
+    it "should raise error when mail can't be delivered and errors are disabled" do 
+      lambda { 
+        client = mock_client
+        client.deliver!(Mail.new {})
+      }.should raise_error(Gmail::Client::DeliveryError)
+    end
+    
+    it "should properly switch to given mailbox" do
+      mock_client do |client| 
+        mailbox = client.mailbox("TEST")
+        mailbox.should be_kind_of(Gmail::Mailbox)
+        mailbox.name.should == "TEST"
+      end 
+    end
+    
+    it "should properly switch to given mailbox using block style" do
+      mock_client do |client| 
+        client.mailbox("TEST") do |mailbox|
+          mailbox.should be_kind_of(Gmail::Mailbox)
+          mailbox.name.should == "TEST"
+        end
+      end
+    end
+    
+    context "labels" do
+      subject { 
+        client = Gmail::Client.new(*TEST_ACCOUNT)
+        client.connect
+        client.labels
+      }
+      
+      it "should get list of all available labels" do
+        labels = subject
+        labels.all.should include("TEST", "INBOX")
+      end
+      
+      it "should be able to check if there is given label defined" do
+        labels = subject
+        labels.exists?("TEST").should be_true
+        labels.exists?("FOOBAR").should be_false
+      end
+      
+      it "should be able to create given label" do
+        labels = subject
+        labels.create("MYLABEL")
+        labels.exists?("MYLABEL").should be_true
+        labels.create("MYLABEL").should be_false
+        labels.delete("MYLABEL")
+      end
+      
+      it "should be able to remove existing label" do
+        labels = subject
+        labels.create("MYLABEL")
+        labels.delete("MYLABEL").should be_true
+        labels.exists?("MYLABEL").should be_false
+        labels.delete("MYLABEL").should be_false
+      end
+    end
+  end
+end

data/spec/gmail_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe "Any object" do
+  it "should be able to convert itself to IMAP date format" do
+    "20-12-1988".to_imap_date.should == "20-December-1988"
+  end
+  
+  %w[new new!].each do |method|
+    it "##{method} should properly connect with GMail service and return valid connection object" do
+      gmail = Gmail.send(method, *TEST_ACCOUNT)
+      gmail.should be_kind_of(Gmail::Client)
+      gmail.connection.should_not be_nil
+      gmail.should be_logged_in
+    end
+    
+    it "##{method} should connect with client and give it context when block given" do
+      Gmail.send(method, *TEST_ACCOUNT) do |gmail|
+        gmail.should be_kind_of(Gmail::Client)
+        gmail.connection.should_not be_nil
+        gmail.should be_logged_in
+      end
+    end
+  end
+  
+  it "#new should not raise error when couldn't connect with given account" do
+    lambda { 
+      gmail = Gmail.new("foo", "bar")
+      gmail.should_not be_logged_in 
+    }.should_not raise_error(Gmail::Client::AuthorizationError)
+  end
+
+  it "#new! should raise error when couldn't connect with given account" do
+    lambda { 
+      gmail = Gmail.new!("foo", "bar")
+      gmail.should_not be_logged_in 
+    }.should raise_error(Gmail::Client::AuthorizationError)
+  end
+end

data/spec/mailbox_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "A Gmail mailbox" do
+  subject { Gmail::Mailbox }
+  
+  def within_gmail(&block) 
+    gmail = Gmail.connect!(*TEST_ACCOUNT)
+    yield(gmail)
+    gmail.logout if gmail
+  end
+  
+  context "on initialize" do
+    it "should set client and name" do
+      within_gmail do |gmail|
+        mailbox = subject.new(gmail, "TEST")
+        mailbox.instance_variable_get("@gmail").should == gmail
+        mailbox.name.should == "TEST"
+      end
+    end
+    
+    it "should work in INBOX by default" do
+      within_gmail do |gmail|
+        mailbox = subject.new(@gmail)
+        mailbox.name.should == "INBOX"
+      end
+    end
+  end
+  
+  context "instance" do
+    def mock_mailbox(box="INBOX", &block)
+      within_gmail do |gmail|
+        mailbox = subject.new(gmail, box)
+        yield(mailbox) if block_given?
+        mailbox
+      end
+    end
+    
+    it "should be able to count all emails" do
+      mock_mailbox do |mailbox|
+        mailbox.count.should > 0
+      end
+    end
+    
+    it "should be able to find messages" do
+      pending
+    end
+  end
+end

data/spec/message_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe "A Gmail message" do
+  context "on initialize" do
+    it "should set uid and mailbox" do
+      pending
+    end
+  end
+  
+  context "instance" do
+    it "should be able to mark itself as read" do
+      pending
+    end
+    
+    it "should be able to mark itself as unread" do
+      pending
+    end
+    
+    it "should be able to set star itself" do
+      pending
+    end
+    
+    it "should be able to unset start" do
+      pending
+    end
+    
+    it "should be able to archive itself" do
+      pending
+    end
+    
+    it "should be able to delete itself" do
+      pending
+    end
+    
+    it "should be able to move itself to spam" do
+      pending
+    end
+    
+    it "should be able to set given label" do
+      pending
+    end
+    
+    it "should be able to mark itself with given flag" do
+      pending
+    end
+    
+    it "should be able to move itself to given box" do
+      pending
+    end
+  end 
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'mocha'
+require 'gmail'
+
+RSpec.configure do |config| 
+  config.mock_with :mocha
+end
+
+TEST_ACCOUNT = ["test@gmail.com", "test"]

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: gmail
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- BehindLogic
+- Kriss 'nu7hatch' Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 1
+        version: "0.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 2
+        - 1
+        version: 2.2.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id004
+description: "      A Rubyesque interface to Gmail, with all the tools you'll need. Search, \n      read and send multipart emails; archive, mark as read/unread, delete emails; \n      and manage labels.\n"
+email: kriss.kowalik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- VERSION
+- lib/gmail.rb
+- lib/gmail/client.rb
+- lib/gmail/labels.rb
+- lib/gmail/mailbox.rb
+- lib/gmail/message.rb
+- lib/gmail/version.rb
+- spec/client_spec.rb
+- spec/gmail_spec.rb
+- spec/mailbox_spec.rb
+- spec/message_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nu7hatch/gmail
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Rubyesque interface to Gmail, with all the tools you'll need.
+test_files: 
+- spec/message_spec.rb
+- spec/mailbox_spec.rb
+- spec/spec_helper.rb
+- spec/client_spec.rb
+- spec/gmail_spec.rb