sifttter-redux 0.2.0

data/lib/Sifttter-Redux/cli-message.rb

@@ -0,0 +1,135 @@
+#|  ======================================================
+#|  CliManager Module
+#|  Singleton to manage common CLI interfacing
+#|  ======================================================
+module CliMessage
+  
+  ERROR   = 1
+  INFO    = 2
+  SECTION = 3
+  WARNING = 4
+  
+  #|  ------------------------------------------------------
+  #|  error method
+  #|
+  #|  Outputs a formatted-red error message.
+  #|  @param message The message to output
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def self.error(message, addNewline = true)
+    if addNewline
+      puts "---> ERROR: #{message}".red
+    else
+      print "---> ERROR: #{message}".red 
+    end
+    
+    @@last_message_type = ERROR
+  end
+  
+  #|  ------------------------------------------------------
+  #|  finish_message method
+  #|
+  #|  Finishes a previous message by appending "DONE" in the
+  #|  correct color.
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def self.finish_message(message)
+    case @@last_message_type
+    when ERROR
+      puts message.red
+    when INFO
+      puts message.blue
+    when SECTION
+      puts message.green
+    when WARNING
+      puts message.yellow
+    end
+  end
+  
+  #|  ------------------------------------------------------
+  #|  info method
+  #|
+  #|  Outputs a formatted-blue informational message.
+  #|  @param message The message to output
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def self.info(message, addNewline = true)
+    if addNewline
+      puts "---> INFO: #{message}".blue
+    else
+      print "---> INFO: #{message}".blue 
+    end
+    
+    @@last_message_type = INFO
+  end
+  
+  #|  ------------------------------------------------------
+  #|  prompt method
+  #|
+  #|  Outputs a prompt, collects the user's response, and
+  #|  returns it.
+  #|  @param prompt The prompt to output
+  #|  @param default The default option
+  #|  @return String
+  #|  ------------------------------------------------------
+  def self.prompt(prompt, default)
+    print "#{prompt} [default: #{default}]: "
+    choice = $stdin.gets.chomp
+    if choice.empty?
+      return default
+    else
+      return choice
+    end
+  end
+  
+  #|  ------------------------------------------------------
+  #|  section method
+  #|
+  #|  Outputs a formatted-orange section message.
+  #|  @param message The message to output
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def self.section(message, addNewline = true)
+    if addNewline
+      puts "#### #{message}".green
+    else
+      print "#### #{message}".green
+    end
+    
+    @@last_message_type = SECTION
+  end
+  
+  #|  ------------------------------------------------------
+  #|  success method
+  #|
+  #|  Outputs a formatted-green success message.
+  #|  @param message The message to output
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def self.success(message, addNewline = true)
+    if addNewline
+      puts "---> SUCCESS: #{message}".green
+    else
+      print "---> SUCCESS: #{message}".green
+    end
+    
+    @@last_message_type = WARNING
+  end
+  
+  #|  ------------------------------------------------------
+  #|  warning method
+  #|
+  #|  Outputs a formatted-yellow warning message.
+  #|  @param message The message to output
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def self.warning(message, addNewline = true)
+    if addNewline
+      puts "---> WARNING: #{message}".yellow
+    else
+      print "---> WARNING: #{message}".yellow
+    end
+    
+    @@last_message_type = WARNING
+  end
+end

data/lib/Sifttter-Redux/config-manager.rb

@@ -0,0 +1,136 @@
+require 'singleton'
+
+#|  ======================================================
+#|  ConfigManager Class
+#|
+#|  Singleton to manage the YAML config file
+#|  for this script
+#|  ======================================================
+
+class ConfigManager
+  include Singleton
+  
+  attr_accessor :configFile
+  
+  #|  ------------------------------------------------------
+  #|  initialize method
+  #|
+  #|  Initializes this singleton with data from the config
+  #|  file. If the file doesn't exist, an empty hash is
+  #|  created in anticipation of future config saves.
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def initialize
+    @configFile = SifttterRedux::SRD_CONFIG_FILEPATH
+    
+    if File.exists?(SifttterRedux::SRD_CONFIG_FILEPATH) 
+      @data = YAML.load_file(SifttterRedux::SRD_CONFIG_FILEPATH)
+      @data.each do |k, v|
+        define_singleton_method(k) { return v }
+      end
+    else
+      @data = {}
+    end
+  end
+  
+  #|  ------------------------------------------------------
+  #|  _dump method
+  #|
+  #|  Convenience method that dumps the configuration hash's
+  #|  data.
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def _dump
+    puts @data
+  end
+  
+  #|  ------------------------------------------------------
+  #|  add_to_section method
+  #|
+  #|  Adds a hash to the configuration data.
+  #|  @param hash The hash to add to configuration
+  #|  @param section The section into which the hash goes
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def add_to_section(hash, section)
+    unless @data.has_key?(section)
+      CliMessage.warning("Attempting to insert into a non-existing section: #{section}; skipping...")
+      return 
+    end
+    
+    @data[section].merge!(hash)
+  end
+  
+  #|  ------------------------------------------------------
+  #|  create_section method
+  #|
+  #|  Creates a new section in the configuration hash.
+  #|  @param section The section to create
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def create_section(section)
+    if @data.has_key?(section)
+      CliMessage.warning("Attempting to create existing section (#{section}); skipping...")
+      return
+    end
+
+    define_singleton_method(section) { return @data[section] }
+    @data.merge!(section => {})
+  end
+  
+  #|  ------------------------------------------------------
+  #|  delete_section method
+  #|
+  #|  Deletes a section in the configuration hash.
+  #|  @param section The section to delete
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def delete_section(section)
+    unless @data.has_key?(section)
+      CliMessage.warning("Attempting to delete non-existing section (#{section}); skipping...")
+      return
+    end
+    
+    remove_singleton_method(section)
+    @data.delete(section)
+  end
+  
+  #|  ------------------------------------------------------
+  #|  remove_singleton_method method
+  #|
+  #|  Removes a hash from the configuration data based on
+  #|  its key.
+  #|  @param hash The hash key remove
+  #|  @param section The section from which the key comes
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def remove_from_section(key, section)
+    unless @data.has_key?(section) && @data[section].has_key?(key)
+      CliMessage.warning("Attempting to remove a non-existing key: #{section}.#{key}; skipping...")
+      return
+    end
+    
+    @data[section].delete(key)
+  end
+  
+  #|  ------------------------------------------------------
+  #|  reset method
+  #|
+  #|  Clears out the configuration data by resetting the hash.
+  #|  @return Void
+  #|  ------------------------------------------------------
+  def reset
+    @data = {}
+  end
+  
+  #|  ------------------------------------------------------
+  #|  save_configuration method
+  #|
+  #|  Saves the configuration data to the filesystem.
+  #|  @return File
+  #|  ------------------------------------------------------
+  def save_configuration
+    return File.open(@configFile, 'w') { |f| f.write(@data.to_yaml) }
+  end
+  
+end

data/lib/Sifttter-Redux/constants.rb

@@ -0,0 +1,15 @@
+module SifttterRedux
+  VERSION = "0.2.0"
+  
+  # Sifttter and Sifttter Redux Constants
+  SRD_CONFIG_FILEPATH = File.join(ENV['HOME'], '.sifttter_redux')
+  SFT_LOCAL_FILEPATH = "/tmp/sifttter"
+  SFT_REMOTE_FILEPATH = "/Apps/ifttt/sifttter"
+
+  # Dropbox Upload Constants
+  DBU_LOCAL_FILEPATH = "/usr/local/opt"
+
+  # Day One Constants
+  DO_REMOTE_FILEPATH = "/Apps/Day\\ One/Journal.dayone/entries"
+  DO_LOCAL_FILEPATH = "/tmp/dayone"
+end

data/lib/Sifttter-Redux/date-range-maker.rb

@@ -0,0 +1,102 @@
+require 'chronic'
+
+class DateRangeMakerError < StandardError
+  def initialize(msg = "You've triggered a DateRangeMakerError")
+    super
+  end
+end
+
+class BadChronicDateError < DateRangeMakerError
+  def initialize(msg = "Invalid date provided to Chronic...")
+    super
+  end
+end
+
+class BadDateOrderError < DateRangeMakerError
+  def initialize(msg = "The start date must be before or equal to the end date...")
+    super
+  end
+end
+
+class InvalidFlagsError < DateRangeMakerError
+  def initialize(msg = "You can't specify -t without specifying -f...")
+    super
+  end
+end
+
+#|  ======================================================
+#|  DateRangeMaker Class
+#|
+#|  Singleton to manage the YAML config file
+#|  for this script
+#|  ======================================================
+class DateRangeMaker 
+  
+  def initialize
+
+  end
+  
+  def last_seven_days(include_today = false)
+    if (include_today)
+      _r = (Date.today - 7..Date.today)
+    else
+      _r = (Date.today - 7...Date.today)
+    end
+    
+    return _r
+  end
+  
+  def range(options = {})
+    
+    opts = {
+      :start_date => Date.today,
+      :end_date => nil,
+      :include_today => false
+    }
+    
+    options.each do |k, v|
+      k = k.to_sym
+      raise ArgumentError, "Unknown property: #{k}" unless opts.key?(k)
+      opts[k] = v
+    end
+    
+    begin
+      chronic_start_date = Chronic.parse(opts[:start_date]).to_date
+    rescue 
+      raise BadChronicDateError.new("Invalid date provided to Chronic: #{opts[:start_date]}") if !opts[:start_date].nil?
+      nil
+    end
+    
+    begin
+      chronic_end_date = Chronic.parse(opts[:end_date]).to_date
+    rescue  
+      raise BadChronicDateError.new("Invalid date provided to Chronic: #{opts[:end_date]}") if !opts[:end_date].nil?
+      nil
+    end
+    
+    raise InvalidFlagsError.new if (opts[:start_date].nil? && !opts[:end_date].nil?)
+    raise BadDateOrderError.new if (chronic_end_date && chronic_start_date > chronic_end_date)
+    
+    if (!chronic_start_date.nil?)
+      if (chronic_end_date.nil?)
+        if (opts[:include_today])
+          dates = (chronic_start_date..Date.today)
+        else
+          dates = (chronic_start_date...Date.today)
+        end
+      else
+        dates = (chronic_start_date..chronic_end_date)
+      end
+    end
+    
+    return dates
+  end
+  
+  def today
+    return (Date.today..Date.today)
+  end
+  
+  def yesterday
+    return (Date.today - 1..Date.today - 1)
+  end
+end

data/lib/Sifttter-Redux/methods.rb

@@ -0,0 +1,190 @@
+#|  ======================================================
+#|  METHODS
+#|  ======================================================
+
+#|  ------------------------------------------------------
+#|  collect_preferences method
+#|
+#|  Collects preferences from the user and stores the
+#|  entered values into a configuration file.
+#|  @return Void
+#|  ------------------------------------------------------
+def collect_preferences
+  CliMessage.section('COLLECTING PREFERENCES...')
+  
+  pref = CliMessage.prompt("Location for downloaded Sifttter files from Dropbox", SifttterRedux::SFT_LOCAL_FILEPATH)
+  $config.add_to_section({"sifttter_local_filepath" => pref}, "sifttter_redux")
+  
+  pref = CliMessage.prompt("Location of Sifttter files in Dropbox", SifttterRedux::SFT_REMOTE_FILEPATH)
+  $config.add_to_section({"sifttter_remote_filepath" => pref}, "sifttter_redux")
+  
+  pref = CliMessage.prompt("Location for downloaded Day One files from Dropbox", SifttterRedux::DO_LOCAL_FILEPATH)
+  $config.add_to_section({"dayone_local_filepath" => pref}, "sifttter_redux")
+  
+  pref = CliMessage.prompt("Location of Day One files in Dropbox", SifttterRedux::DO_REMOTE_FILEPATH)
+  $config.add_to_section({"dayone_remote_filepath" => pref}, "sifttter_redux")
+end
+
+#|  ------------------------------------------------------
+#|  download_sifttter_files method
+#|
+#|  Downloads Sifttter files from Dropbox
+#|  @return Void
+#|  ------------------------------------------------------
+def download_sifttter_files
+  # Download all Sifttter files from Dropbox.
+  CliMessage.info('Downloading Sifttter files...', false)
+  `#{$db_uploader} download #{$config.sifttter_redux["sifttter_remote_filepath"]} #{$config.sifttter_redux["sifttter_local_filepath"]}`
+  CliMessage.finish_message('DONE.')
+end
+
+#|  ------------------------------------------------------
+#|  initialize_procedures method
+#|
+#|  Initializes Sifttter Redux by downloading and collecting
+#|  all necessary items and info.
+#|  @return Void
+#|  ------------------------------------------------------
+def initialize_procedures
+  $config.reset
+  $config.create_section("sifttter_redux")
+  $config.add_to_section({"config_location" => $config.configFile}, "sifttter_redux")
+  
+  install_db_uploader 
+  collect_preferences
+  
+  CliMessage.section("INITIALIZATION COMPLETE!")
+  
+  $config.save_configuration
+end
+
+#|  ------------------------------------------------------
+#|  install_db_uploader method
+#|
+#|  Installs Dropbox Uploader to a user-specified location
+#|  by cloning the git repository.
+#|  @return Void
+#|  ------------------------------------------------------
+def install_db_uploader
+  valid_directory_chosen = false
+  
+  CliMessage.section('DOWNLOADING DROPBOX UPLOADER...')
+  
+  # Create a new configuration section for Dropbox-Uploader
+  $config.create_section("db_uploader")
+  
+  until valid_directory_chosen
+    # Prompt the user for a location to save Dropbox Uploader. "
+    db_uploader_location = CliMessage.prompt("Location for Dropbox-Uploader", SifttterRedux::DBU_LOCAL_FILEPATH)
+    db_uploader_location.chop! if db_uploader_location.end_with?('/')
+    db_uploader_location = "/usr/local/opt" if db_uploader_location.empty?
+    
+    # If the entered directory exists, clone the repository.
+    if File.directory?(db_uploader_location)
+      valid_directory_chosen = true
+      db_uploader_location << "/Dropbox-Uploader"
+      
+      # If, for some reason, Dropbox Uploader alread exists at this location,
+      # skip the clone.
+      if File.directory?(db_uploader_location)
+        CliMessage.info("You seem to already have Dropbox Uploader at this location; skipping...")
+      else
+        %x{git clone https://github.com/andreafabrizi/Dropbox-Uploader.git #{db_uploader_location}}
+      end
+      
+      # Save config data to YAML.
+      $config.add_to_section({"local_filepath" => db_uploader_location}, "db_uploader")
+    else
+      puts "Sorry, but #{db_uploader_location} isn't a valid directory."
+    end
+  end
+end
+
+#|  ------------------------------------------------------
+#|  run_sifttter method
+#|
+#|  Modified form of Sifttter
+#| 
+#|  Sifttter: An IFTTT-to-Day One Logger by Craig Eley 2014
+#|  Based on tp-dailylog.rb by Brett Terpstra 2012
+#|  @param date The date to use when scanning Sifttter files
+#|  @return Void
+#|  ------------------------------------------------------
+def run_sifttter(date)
+  uuid_command = "uuidgen" if OS.mac?
+  uuid_command = "uuid" if OS.linux?
+  uuid = %x{#{uuid_command}}.gsub(/-/,'').strip 
+  
+  date_for_title = date.strftime('%B %d, %Y')
+  datestamp = date.to_time.utc.iso8601
+  starred = false
+
+  template = ERB.new <<-XMLTEMPLATE
+  <?xml version="1.0" encoding="UTF-8"?>
+  <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+  <plist version="1.0">
+  <dict>
+  	<key>Creation Date</key>
+  	<date><%= datestamp %></date>
+  	<key>Entry Text</key>
+  	<string><%= entrytext %></string>
+  	<key>Starred</key>
+  	<<%= starred %>/>
+  	<key>Tags</key>
+  	<array>
+  		<string>daily logs</string>
+  	</array>
+  	<key>UUID</key>
+  	<string><%= uuid %></string>
+  </dict>
+  </plist>
+  XMLTEMPLATE
+
+  date_regex = "#{date.strftime('%B')} 0?#{date.strftime('%-d')}, #{date.strftime('%Y')}"
+  time_regex = "\d{1,2}:\d{1,2}\s?[AaPpMm]{2}"
+
+  files = %x{find #{$config.sifttter_redux["sifttter_local_filepath"]} -type f -name '*.txt' | grep -v -i daily | sort}
+
+  projects = []
+  files.split("\n").each do |file|
+  	if File.exists?(file.strip)
+  		f = File.open(file.strip, encoding: 'UTF-8')
+  		lines = f.read
+  		f.close
+  		project = "### " + File.basename(file).gsub(/^.*?\/([^\/]+)$/,"\\1") + "\n"
+
+  		found_completed = false
+  		lines.each_line do |line|
+  			if line =~ /&/
+  				line.gsub!(/[&]/, 'and')
+  			end
+  			if line =~ /#{date_regex}/
+  				found_completed = true
+  				project += line.gsub(/@done/,'').gsub(/#{date_regex}\s(-|at)\s/, '').gsub(/#{time_regex}\s-\s/, '').strip + "\n"
+  			end
+  		end
+  	end
+  	if found_completed
+  		projects.push(project)
+  	end
+  end
+  
+  if projects.length <=0
+  	CliMessage.error("No entries found...")
+    exit!
+  end
+
+  if projects.length > 0  
+  	entrytext = "# Things done on #{date_for_title}\n\n"
+  	projects.each do |project|
+  		entrytext += project.gsub(/.txt/, ' ') + "\n\n"
+  	end
+    
+    Dir.mkdir($config.sifttter_redux["dayone_local_filepath"]) if !Dir.exists?($config.sifttter_redux["dayone_local_filepath"])
+    
+  	fh = File.new(File.expand_path($config.sifttter_redux["dayone_local_filepath"] + "/" + uuid + ".doentry"), 'w+')
+  	fh.puts template.result(binding)
+  	fh.close
+  	CliMessage.success("Entry logged for #{date_for_title}...")
+  end
+end

data/lib/Sifttter-Redux/os.rb

@@ -0,0 +1,47 @@
+#|  ======================================================
+#|  OS Module
+#|
+#|  Module to easily find the running operating system
+#|  ======================================================
+module OS
+
+  #|  ------------------------------------------------------
+  #|  linux? method
+  #|
+  #|  Returns true if the host OS is Linux (false otherwise).
+  #|  @return Bool
+  #|  ------------------------------------------------------
+  def OS.linux?
+    OS.unix? and not OS.mac?
+  end
+  
+  #|  ------------------------------------------------------
+  #|  mac? method
+  #|
+  #|  Returns true if the host OS is OS X (false otherwise).
+  #|  @return Bool
+  #|  ------------------------------------------------------
+  def OS.mac?
+   (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  #|  ------------------------------------------------------
+  #|  unix? method
+  #|
+  #|  Returns true if the host OS is Unix (false otherwise).
+  #|  @return Bool
+  #|  ------------------------------------------------------
+  def OS.unix?
+    !OS.windows?
+  end
+  
+  #|  ------------------------------------------------------
+  #|  windows? method
+  #|
+  #|  Returns true if the host OS is Windows (false otherwise).
+  #|  @return Bool
+  #|  ------------------------------------------------------
+  def OS.windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+end

data/lib/Sifttter-Redux.rb

@@ -0,0 +1,6 @@
+require 'Sifttter-Redux/cli-message.rb'
+require 'Sifttter-Redux/config-manager.rb'
+require 'Sifttter-Redux/constants.rb'
+require 'Sifttter-Redux/date-range-maker.rb'
+require 'Sifttter-Redux/methods.rb'
+require 'Sifttter-Redux/os.rb'

data/test/catch_up_test.rb

@@ -0,0 +1,56 @@
+require 'date'
+require 'test_helper'
+require File.join(File.dirname(__FILE__), '..', 'lib/Sifttter-Redux/date-range-maker.rb')
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+    $drm = DateRangeMaker.new
+  end
+
+  def test_today
+    assert_equal($drm.today, (Date.today..Date.today))
+  end
+  
+  def test_yesterday
+    assert_equal($drm.yesterday, (Date.today - 1..Date.today - 1))
+  end
+  
+  def test_last_7_days
+    assert_equal($drm.last_seven_days, (Date.today - 7...Date.today))
+  end
+  
+  def test_last_7_days_include_today
+    assert_equal($drm.last_seven_days(true), (Date.today - 7..Date.today))
+  end
+  
+  def test_range_only_start_date
+    assert_equal($drm.range({:start_date => "2014-02-01"}), (Date.parse("2014-02-01")...Date.today))
+  end
+  
+  def test_range_only_start_date_include_today
+    assert_equal($drm.range({:start_date => "2014-02-01", :include_today => true}), (Date.parse("2014-02-01")..Date.today))
+  end
+  
+  def test_range_start_date_and_end_date
+    assert_equal($drm.range({:start_date => "2014-02-01", :end_date => "2014-02-05"}), (Date.parse("2014-02-01")..Date.parse("2014-02-05")))
+  end
+  
+  def test_range_bad_dates
+    assert_raise BadChronicDateError do
+      $drm.range({:start_date => "Bad Start Date", :end_date => "Bad End Date"})
+    end
+  end
+  
+  def test_range_end_date_with_no_start_date
+    assert_raise InvalidFlagsError do
+      $drm.range({:start_date => nil, :end_date => Date.today})
+    end
+  end
+  
+  def test_range_end_date_before_start_date
+    assert_raise BadDateOrderError do
+      $drm.range({:start_date => Date.today, :end_date => Date.today - 1})
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end