kindlemail 0.2.7 → 0.2.8

data/Changelog.md

@@ -1,5 +1,9 @@
 # kindlemail Changelog
 
+### 0.2.8
+* Added setup feature to setup the application
+* Moved configuration to a new file
+
 ### 0.2.5
 * Upgrading to use gmail-mailer 0.4.5
 

data/README.md

@@ -17,7 +17,16 @@ For kindlemail to work you will need three things
 * Anonymous OAUTH access to your gmail account 
 * Your gmail address will need to be added to the "Your Kindle Approved E-mail List" on Amazon's "Manage Your Kindle" page
 
-### How to run
+## How do I get OAUTH credentials for my gmail account?
+
+* You will need python installed on your system
+* Follow the instructions from google [located here](http://code.google.com/p/google-mail-xoauth-tools/wiki/XoauthDotPyRunThrough)
+
+## Why OAUTH, why can't I just put my password in?
+
+* I don't like the idea of storing passwords, sorry!
+
+## How to run
 If you want to run kindlemail, do the following 
 
 If you want the bleeding edge, clone this repository and...
@@ -25,14 +34,8 @@ If you want the bleeding edge, clone this repository and...
 or if you want a released gem...
     gem install kindlemail 
 
-Run kindlemail to see if it's installed correctly
-    kindlemail -i
-
-Modify the file and follow the instructions in the comments to add your gmail credentials
-    vim ~/.kindlemail/.email_conf
-
-Modify the file and follow the instructions to add your kindle address
-    vim ~/.kindlemail/.kindlemail
+Run `setup` to setup kindlemail with your gmail credentials
+    kindlemail --setup
 
 Send a file to your Kindle!
     kindlemail ~/books/my_book.mobi
@@ -48,7 +51,7 @@ This is rough code and probably won't work.
 
 ## Options
 
-    kindlemail 0.2.5. Written by djhworld. https://github.com/djhworld/kindlemail
+    kindlemail 0.2.8. Written by djhworld. https://github.com/djhworld/kindlemail
 
     kindlemail will send items to your kindle in the simplest possible manner
 
@@ -78,7 +81,7 @@ This is rough code and probably won't work.
                    --force, -f:   Send the file regardless of whether you have sent it before
             --show-history, -s:   Show the history of files that have been sent using kindlemail
            --clear-history, -d:   Clear the history of files that have been sent using kindlemail
+                   --setup, -e:   Setup kindlemail
                --show-info, -i:   Show information about the way kindlemail is setup
                  --version, -v:   Print version and exit
                     --help, -h:   Show this message
-

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.2.8

data/kindlemail.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kindlemail}
-  s.version = "0.2.7"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Harper"]
-  s.date = %q{2011-01-17}
+  s.date = %q{2011-01-22}
   s.default_executable = %q{kindlemail}
   s.description = %q{Sends documents to a designated kindle address painlessly and via the CLI. No need to fumble around with clumsy attachment boxes so forth, just whack in the documents you want to send and hit enter}
   s.email = %q{djharperuk@gmail.com}
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "conf_templates/.email_conf",
     "conf_templates/.kindlemail",
     "kindlemail.gemspec",
+    "lib/Configuration.rb",
     "lib/KindleMail.rb",
     "lib/KindleMailFileDatastore.rb",
     "lib/KindleMailer.rb",

data/lib/Configuration.rb

@@ -0,0 +1,93 @@
+require 'yaml'
+require 'constants.rb'
+require 'fileutils'
+class Configuration
+  def load_yaml(file)
+    YAML.load_file(file).inject({}){|memo,(k,v)| memo[k.to_sym] = v.to_s; memo}
+  end
+
+  # Create the user framework needed to run the application
+  def configuration_setup
+    dirname = File.expand_path(USER_DIR)
+    if !File.exists?(dirname)
+      Dir.mkdir(dirname) 
+      create_storage_dir
+      create_staging_dir
+      create_user_conf_file
+      create_user_email_conf_file
+    else     
+      create_user_conf_file if !File.exists?(USER_CONF_FILE)
+      create_storage_dir if !File.exists?(File.expand_path(STORAGE_DIR))
+      create_staging_dir if !File.exists?(File.expand_path(STAGING_DIR))
+      create_user_email_conf_file if !File.exists?(EMAIL_CONF_FILE)
+    end
+  end
+
+  def create_storage_dir
+    Dir.mkdir(File.expand_path(STORAGE_DIR))
+  end
+
+  def create_staging_dir
+    Dir.mkdir(File.expand_path(STAGING_DIR))
+  end
+
+  def create_user_conf_file
+    root = File.expand_path(File.dirname(__FILE__))
+    root = File.expand_path("../conf_templates", root)
+    FileUtils.cp(File.join(root, '/.kindlemail'), USER_CONF_FILE)
+  end
+
+  def create_user_email_conf_file
+    root = File.expand_path(File.dirname(__FILE__))
+    root = File.expand_path("../conf_templates", root)
+    FileUtils.cp(File.join(root, '/.email_conf'), EMAIL_CONF_FILE)
+  end
+
+  def set_default_kindle_address(address)
+    raise ArgumentError, "Error: No email address entered" if address.nil? or address.empty?
+
+    print "Setting up kindle credentials..."
+    File.open(USER_CONF_FILE,"w") do |file|
+      file.puts "kindle_addr: #{address}"
+    end
+    puts "Complete!"
+  end
+
+  def set_email_credentials(token, token_secret, email)
+    raise ArgumentError, "Error: Please provide a valid OAUTH token" if token.nil? or token.empty?
+    raise ArgumentError, "Error, Please provide a valid OAUTH token secret"  if token_secret.nil? or token.empty?
+    raise ArgumentError, "Error: Please provide a valid gmail address" if email.nil? or email.empty?
+    print "Setting up email credentials..."
+    File.open(EMAIL_CONF_FILE, "w") do |file|
+      file.puts "smtp_oauth_token: #{token}"
+      file.puts "smtp_oauth_token_secret: #{token_secret}"
+      file.puts "email #{email}"
+    end
+    puts "Complete!"
+  end
+
+
+  def get_email_credentials
+    raise ArgumentError, "Cannot find email credentials file #{EMAIL_CONF_FILE}." if !File.exists?(EMAIL_CONF_FILE)
+    begin
+      load_yaml(EMAIL_CONF_FILE)
+    rescue
+      raise StandardError, "Error parsing #{EMAIL_CONF_FILE}"
+    end
+  end
+
+  def get_user_credentials
+    error_msg =  "The configuration file #{USER_CONF_FILE} was found but appears to be invalid/incomplete.\nThe most likely reason for this is the fact that you need to set a default kindle address to send items to.\nYou must edit the file and follow the instructions in the comments before trying again. Alternatively use the -k flag to specify a kindle address to send the item to" 
+
+    raise ArgumentError, "Cannot find user credentials file #{USER_CONF_FILE}." if !File.exists?(USER_CONF_FILE)
+    begin
+      config = load_yaml(USER_CONF_FILE)
+    rescue
+      raise StandardError, error_msg
+    end
+
+    raise StandardError, error_msg if config.key?(:kindle_addr) == false || config[:kindle_addr].nil?
+    return config
+  end
+end
+

data/lib/KindleMail.rb

@@ -1,79 +1,10 @@
 require 'trollop'
-require 'yaml'
-require 'fileutils'
 require 'KindleMailer.rb'
 require 'constants.rb'
 require 'KindleMailFileDatastore.rb'
-
+require 'Configuration.rb'
 # This contains all the code needed to run the CLI application
 module KindleMail
-  class Configuration
-
-    def load_yaml(file)
-      YAML.load_file(file).inject({}){|memo,(k,v)| memo[k.to_sym] = v.to_s; memo}
-    end
-    # Create the user framework needed to run the application
-    def configuration_setup
-      dirname = File.expand_path(USER_DIR)
-      if !File.exists?(dirname)
-        Dir.mkdir(dirname) 
-        create_storage_dir
-        create_staging_dir
-        create_user_conf_file
-        create_user_email_conf_file
-      else     
-        create_user_conf_file if !File.exists?(USER_CONF_FILE)
-        create_storage_dir if !File.exists?(File.expand_path(STORAGE_DIR))
-        create_staging_dir if !File.exists?(File.expand_path(STAGING_DIR))
-        create_user_email_conf_file if !File.exists?(EMAIL_CONF_FILE)
-      end
-    end
-
-    def create_storage_dir
-      Dir.mkdir(File.expand_path(STORAGE_DIR))
-    end
-
-    def create_staging_dir
-      Dir.mkdir(File.expand_path(STAGING_DIR))
-    end
-
-    def create_user_conf_file
-      root = File.expand_path(File.dirname(__FILE__))
-      root = File.expand_path("../conf_templates", root)
-      FileUtils.cp(File.join(root, '/.kindlemail'), USER_CONF_FILE)
-    end
-
-    def create_user_email_conf_file
-      puts "Creating user email conf file"
-      root = File.expand_path(File.dirname(__FILE__))
-      root = File.expand_path("../conf_templates", root)
-      FileUtils.cp(File.join(root, '/.email_conf'), EMAIL_CONF_FILE)
-    end
-
-    def get_email_credentials
-      raise ArgumentError, "Cannot find email credentials file #{EMAIL_CONF_FILE}." if !File.exists?(EMAIL_CONF_FILE)
-      begin
-        load_yaml(EMAIL_CONF_FILE)
-      rescue
-        raise StandardError, "Error parsing #{EMAIL_CONF_FILE}"
-      end
-    end
-
-    def get_user_credentials
-      error_msg =  "The configuration file #{USER_CONF_FILE} was found but appears to be invalid/incomplete.\nThe most likely reason for this is the fact that you need to set a default kindle address to send items to.\nYou must edit the file and follow the instructions in the comments before trying again. Alternatively use the -k flag to specify a kindle address to send the item to" 
-
-      raise ArgumentError, "Cannot find user credentials file #{USER_CONF_FILE}." if !File.exists?(USER_CONF_FILE)
-      begin
-        config = load_yaml(USER_CONF_FILE)
-      rescue
-       raise StandardError, error_msg
-      end
-
-      raise StandardError, error_msg if config.key?(:kindle_addr) == false || config[:kindle_addr].nil?
-      return config
-    end
-  end
-
   class Application
     attr_reader :cmd_parser
     attr_reader :opts
@@ -81,7 +12,7 @@ module KindleMail
     def initialize
       puts "#{VERSION_STRING}\n\n"
       @datastore = KindleMailFileDatastore.new
-      @config_manager = KindleMail::Configuration.new
+      @config_manager = Configuration.new
       @config_manager.configuration_setup
     end
 
@@ -108,12 +39,40 @@ module KindleMail
         opt :force, "Send the file regardless of whether you have sent it before", :short => "-f", :default => nil
         opt :show_history, "Show the history of files that have been sent using kindlemail", :short => "-s", :default => nil
         opt :clear_history, "Clear the history of files that have been sent using kindlemail", :short => "-d", :default => nil
+        opt :setup, "Setup kindlemail", :default => nil
         opt :show_info, "Show information about the way kindlemail is setup", :short => "-i", :default => nil
       end
     end
 
     def process
       begin
+
+        if(@opts[:setup_given])
+          hyphens = "-"*79
+          puts hyphens
+          puts "kindlemail setup"
+          puts "This will overwrite any settings you have set previously"
+          puts hyphens
+          print "Kindle address to set as your default address> "
+          @config_manager.set_default_kindle_address(gets.chomp.to_s) 
+
+          puts 
+          puts hyphens
+          puts "Gmail Authentication Settings"
+          puts "To get a valid anonymous token, use the instructions located here\nhttp://code.google.com/p/google-mail-xoauth-tools/wiki/XoauthDotPyRunThrough"
+          puts hyphens
+          print "OAUTH Token> "
+          token = gets.chomp.to_s
+          print "OAUTH Token Secret> "
+          token_secret = gets.chomp.to_s
+          print "Your gmail address> "
+          email = gets.chomp.to_s
+
+          @config_manager.set_email_credentials(token, token_secret, email)
+          puts "\n\nkindlemail setup complete"
+          exit
+        end
+
         if(@opts[:show_info_given])
           print_info
           exit
@@ -182,6 +141,7 @@ module KindleMail
         puts "Error occured: - \n#{message}"
       end
     end
+
     def print_info
       puts "kindlemail was born out of my own laziness. To put things bluntly" 
       puts "I'm too lazy to pick up my beloved Kindle, get a usb cable, plug"

data/lib/KindleMailer.rb

@@ -33,7 +33,9 @@ class KindleMailer
     rescue 
       raise 
     ensure
-      FileUtils.rm(filepath) if(File.extname(filepath).eql?(".mobi"))
+      if(!filepath.nil? and File.exist?(filepath))
+         FileUtils.rm(filepath) if(File.extname(filepath).eql?(".mobi"))
+      end
     end
 
     puts "#{File.basename(file)} was successfully sent to #{@kindle_address}"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Daniel Harper
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-17 00:00:00 +00:00
+date: 2011-01-22 00:00:00 +00:00
 default_executable: kindlemail
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,6 +130,7 @@ files:
 - conf_templates/.email_conf
 - conf_templates/.kindlemail
 - kindlemail.gemspec
+- lib/Configuration.rb
 - lib/KindleMail.rb
 - lib/KindleMailFileDatastore.rb
 - lib/KindleMailer.rb
@@ -149,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2549843167680941989
+      hash: -1738991482516940866
       segments: 
       - 0
       version: "0"