kindlemail 0.2.1 → 0.2.3

data/Changelog.md

@@ -1,5 +1,10 @@
 # kindlemail Changelog
 
+### 0.2.3
+* Added some further validations on the KindleMailer class
+* Restructured validations
+* Unit testing 
+
 ### 0.2.1
 * Fixed bug where you needed a file name for the -s and -d flags
 * Changed output of show_history

data/Rakefile

@@ -24,4 +24,11 @@ Jeweler::Tasks.new do |gem|
   gem.add_dependency "trollop", "~> 1.16.2"
 end
 Jeweler::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
 
+task :default => :test

data/TODO.txt

@@ -3,6 +3,7 @@ Changes needed for 0.1.4
 - Fix email configuration file issues?
 
 Future stuff: -
+- Start to think about moving the lib/ stuff out into a different gem and just seeing this as a pure CLI app?
 - Add flag to view default kindle address
 - Add ability to use multiple kindle addresses?
 - Add ability to add multiple attachments?

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.3

data/kindlemail.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kindlemail}
-  s.version = "0.2.1"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harper"]
@@ -35,7 +35,8 @@ Gem::Specification.new do |s|
     "lib/KindleMail.rb",
     "lib/KindleMailFileDatastore.rb",
     "lib/KindleMailer.rb",
-    "lib/constants.rb"
+    "lib/constants.rb",
+    "test/test_kindle_mailer.rb"
   ]
   s.homepage = %q{http://github.com/djhworld/kindlemail}
   s.licenses = ["MIT"]
@@ -43,6 +44,9 @@ Gem::Specification.new do |s|
   s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Push documents to your kindle via the personal document service}
+  s.test_files = [
+    "test/test_kindle_mailer.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/KindleMailer.rb

@@ -4,28 +4,42 @@ class KindleMailer
   attr_accessor :kindle_address
   attr_accessor :email_credentials
   def initialize(email_credentials)
+    raise ArgumentError, "You must supply email credentials to use KindleMailer" if email_credentials.nil?
     @email_credentials = email_credentials
   end
 
   def send(kindle_address, file)
-    @kindle_address = kindle_address
-    filepath = File.expand_path(file)
-    raise ArgumentError, "The file you have specified does not exist #{SEE_HELP}" if file.nil? || !File.exist?(filepath)
-    raise ArgumentError, "The file you have specified is not a valid type #{SEE_HELP}" if VALID_FILE_TYPES.include?(File.extname(file)) == false
+    begin
+      validate_kindle_address(kindle_address)
+      @kindle_address = kindle_address
 
-    puts "Preparing #{File.basename(filepath)} to be sent to #{@kindle_address}"
+      filepath = File.expand_path(file)
+      validate_file_path(filepath)
+
+      puts "Preparing #{File.basename(filepath)} to be sent to #{@kindle_address}"
 
-    begin
       message = GmailMailer::Message.new(@kindle_address)
       message.add_attachment(filepath)
       
       mailer = GmailMailer::Mailer.new(@email_credentials)
       mailer.send(message)
-    rescue ArgumentError => error_msg
+    rescue 
       raise 
     end
 
     puts "#{File.basename(filepath)} was successfully sent to #{@kindle_address}"
     return true
   end
+  
+  def validate_file_path(filepath)
+    raise ArgumentError, "The file you have specified does not exist #{SEE_HELP}" if filepath.nil? || !File.exist?(filepath)
+    raise ArgumentError, "The file you have specified is not a valid type #{SEE_HELP}" if VALID_FILE_TYPES.include?(File.extname(filepath)) == false
+    return true 
+  end
+
+  def validate_kindle_address(addr)
+    raise ArgumentError, "You must supply an address to send this item to" if addr.nil?
+    raise ArgumentError, "#{addr} does not appear to be a valid kindle address" if !addr.end_with?("@kindle.com")
+    return true 
+  end
 end 

data/lib/constants.rb

@@ -17,7 +17,7 @@ USER_DIR = "~/.kindlemail"
 STORAGE_DIR = USER_DIR + "/.storage"
 EMAIL_CONF_FILE = File.expand_path(USER_DIR + "/.email_conf")
 USER_CONF_FILE = File.expand_path(USER_DIR + "/.kindlemail")
-VERSION = "0.2.1"
+VERSION = "0.2.3"
 VERSION_STRING = "kindlemail #{VERSION} (January 2011). https://github.com/djhworld/kindlemail"
 FILE_STORE = File.expand_path(STORAGE_DIR + "/sent_files.history")
 

data/test/test_kindle_mailer.rb

@@ -0,0 +1,43 @@
+require 'test/unit'
+require 'fileutils'
+require 'KindleMailer.rb'
+class TestKindleMailer < Test::Unit::TestCase
+
+  def setup
+    @mailer = KindleMailer.new({})
+  end
+
+  def test_constructor_with_nil_credentials
+    assert_raise(ArgumentError) { @mailer = KindleMailer.new(nil) }
+  end
+
+  def test_send_with_nil_kindle_address
+    assert_raise(ArgumentError) { @mailer.send(nil, "file") }
+  end
+
+  def test_validate_kindle_address_with_nil_addr
+    assert_raise(ArgumentError) { @mailer.validate_kindle_address(nil) }
+  end
+
+  def test_validate_kindle_address_with_non_kindle_addr
+    assert_raise(ArgumentError) { @mailer.validate_kindle_address("kindlemail@gmail.com") }
+  end
+
+  def test_validate_file_path_with_non_existent_file
+    assert_raise(ArgumentError) { @mailer.validate_file_path("k") }
+  end
+
+  def test_validate_file_path_with_existent_file
+    file = File.expand_path("test/file1.txt")
+    FileUtils.touch(file)
+    assert_nothing_raised { @mailer.validate_file_path(file) }
+    FileUtils.rm(file)
+  end
+
+  def test_validate_file_path_with_erroneous_file_type
+    file = File.expand_path("test/file1.xyz")
+    FileUtils.touch(file)
+    assert_raise(ArgumentError) { @mailer.validate_file_path(file) }
+    FileUtils.rm(file)
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Daniel Harper
@@ -134,6 +134,7 @@ files:
 - lib/KindleMailFileDatastore.rb
 - lib/KindleMailer.rb
 - lib/constants.rb
+- test/test_kindle_mailer.rb
 has_rdoc: true
 homepage: http://github.com/djhworld/kindlemail
 licenses: 
@@ -168,5 +169,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Push documents to your kindle via the personal document service
-test_files: []
-
+test_files: 
+- test/test_kindle_mailer.rb