sifttter-redux 0.5.4 → 0.6

data/features/step_definitions/sifttter-redux_steps.rb

@@ -0,0 +1,19 @@
+Given(/^a file located at "(.*?)"$/) do |filepath|
+  expect(File).to exist(filepath)
+end
+
+Given(/^an empty file located at "(.*?)"$/) do |filepath|
+  FileUtils.touch(File.expand_path(filepath))
+end
+
+Given(/^a file located at "(.*?)" with the contents:$/) do |filepath, contents|
+  File.open(filepath, 'w') { |f| f.write(contents) }
+end
+
+Given(/^no file located at "(.*?)"$/) do |filepath|
+  step %(the file "#{ filepath }" should not exist)
+end
+
+When /^I get help for "([^"]*)"$/ do |app_name|
+  step %(I run `#{app_name} --help`)
+end

data/features/support/env.rb

@@ -0,0 +1,20 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  @aruba_timeout_seconds = 25
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+  @original_home = ENV['HOME']
+  ENV['HOME'] = "/tmp/srd"
+  FileUtils.rm_rf "/tmp/srd"
+  FileUtils.mkdir "/tmp/srd"
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+  ENV['HOME'] = @original_home
+end

data/lib/sifttter-redux/constants.rb

@@ -0,0 +1,33 @@
+module SifttterRedux
+  # The default configuration path for Dropbox Uploader
+  DEFAULT_DBU_CONFIG_FILEPATH = File.join(ENV['HOME'], '.dropbox_uploader')
+
+  # The default local filepath of the Dropbox-Uploader directory
+  DEFAULT_DBU_LOCAL_FILEPATH = '/usr/local/opt'
+
+  # The default message to display when Dropbox Uploader is running
+  DEFAULT_DBU_MESSAGE = 'RUNNING DROPBOX UPLOADER'
+
+  # The default local filepath of the Siftter Redux config file
+  DEFAULT_SRD_CONFIG_FILEPATH = File.join(ENV['HOME'], '.sifttter_redux')
+
+  # The default local filepath of the Siftter Redux log file
+  DEFAULT_SRD_LOG_FILEPATH = File.join(ENV['HOME'], '.sifttter_redux_log')
+
+  # The Gem's description
+  DESCRIPTION = 'A customized IFTTT-to-Day One service that allows for smart installation and automated running on a standalone *NIX device (such as a Raspberry Pi).'
+
+  # The last version to require a config update
+  NEWEST_CONFIG_VERSION = '0.6'
+
+  # Hash of preference files
+  PREF_FILES = {
+    'INIT' => File.join(File.dirname(__FILE__), '..', '..', 'res/preference_prompts.yaml')
+  }
+
+  # The Gem's summary
+  SUMMARY = 'Automated IFTTT to Day One engine.'
+
+  # The Gem's version
+  VERSION = '0.6'
+end

data/lib/{sifttter_redux/date_range_maker.rb → sifttter-redux/date-range-maker.rb}

@@ -1,23 +1,15 @@
 require 'chronic'
 
 module SifttterRedux
-  #  ======================================================
-  #  Configuration Module
-  #
-  #  Manages any configuration values and the flat file
-  #  into which they get stored.
-  #  ======================================================
+  # DateRangeMaker Module
+  # Returns a Range of dates based on supplied parameters
   module DateRangeMaker
 
-    #  ------------------------------------------------------
-    #  last_n_days method
-    #
-    #  Returns a date range for the last N days (including
-    #  today's date if specified).
-    #  @param num_days The number of days to look back
-    #  @param include_today Should today be included?
-    #  @return Range
-    #  ------------------------------------------------------
+    # Returns a date range for the last N days (including
+    # today's date if specified).
+    # @param [Integer} num_days The number of days to look back
+    # @param [Boolean] include_today Should today be included?
+    # @return [Range]
     def self.last_n_days(num_days, include_today = false)
       if num_days < 0
         error = 'Cannot specify a negative number of days'
@@ -31,15 +23,11 @@ module SifttterRedux
       end
     end
 
-    #  ------------------------------------------------------
-    #  last_n_weeks method
-    #
-    #  Returns a date range for the last N weeks (including
-    #  today's date if specified).
-    #  @param num_days The number of weeks to look back
-    #  @param include_today Should today be included?
-    #  @return Range
-    #  ------------------------------------------------------
+    # Returns a date range for the last N weeks (including
+    # today's date if specified).
+    # @param [Integer] num_days The number of weeks to look back
+    # @param [Boolean] include_today Should today be included?
+    # @return [Range]
     def self.last_n_weeks(num_weeks = 0, include_today = false)
       if num_weeks < 0
         error = 'Cannot specify a negative number of weeks'
@@ -60,17 +48,13 @@ module SifttterRedux
       end
     end
 
-    #  ------------------------------------------------------
-    #  range method
-    #
-    #  Returns a date range for specified start dates and
-    #  end dates. Note that specifying an end date greater
-    #  than today's date will force today to be the end date.
-    #  @param start_date The start date
-    #  @param end_date The end date
-    #  @param options Miscellaneous options hash
-    #  @return Range
-    #  ------------------------------------------------------
+    # Returns a date range for specified start dates and
+    # end dates. Note that specifying an end date greater
+    # than today's date will force today to be the end date.
+    # @param [Start] start_date The start date
+    # @param [Date] end_date The end date
+    # @param [Hash] options Miscellaneous options
+    # @return [Range]
     def self.range(start_date, end_date, include_today = false)
       if start_date.nil? && !end_date.nil?
         error = "You can't specify -t without specifying -f"
@@ -115,22 +99,14 @@ module SifttterRedux
       end
     end
 
-    #  ------------------------------------------------------
-    #  today method
-    #
-    #  Returns a date range for today
-    #  @return Range
-    #  ------------------------------------------------------
+    # Returns a date range for today
+    # @return [Range]
     def self.today
       (Date.today..Date.today)
     end
 
-    #  ------------------------------------------------------
-    #  yesterday method
-    #
-    #  Returns a date range for yesterday
-    #  @return Range
-    #  ------------------------------------------------------
+    # Returns a date range for yesterday
+    # @return [Range]
     def self.yesterday
       (Date.today - 1..Date.today - 1)
     end

data/lib/sifttter-redux/dropbox-uploader.rb

@@ -0,0 +1,64 @@
+module SifttterRedux
+  # DropboxUploader Class
+  # Wrapper class for the Dropbox Uploader project
+  class DropboxUploader
+    # Stores the local filepath.
+    # @return [String]
+    attr_accessor :local_target
+
+    # Stores the remote filepath.
+    # @return [String]
+    attr_accessor :remote_target
+
+    # Stores the message to display.
+    # @return [String]
+    attr_accessor :message
+
+    # Stores the verbosity level.
+    # @return [Boolean]
+    attr_accessor :verbose
+
+    # Loads the location of dropbox_uploader.sh.
+    # @param [String] dbu_path The local filepath to the script
+    # @param [Logger] A Logger to use
+    # @return [void]
+    def initialize(dbu_path, logger = nil)
+      @dbu = dbu_path
+      @logger = logger
+    end
+
+    # Downloads files from Dropbox (assumes that both
+    # local_target and remote_target have been set).
+    # @return [void]
+    def download
+      if !@local_target.nil? && !@remote_target.nil?
+        if @verbose
+          system "#{ @dbu } download #{ @remote_target } #{ @local_target }"
+        else
+          exec = `#{ @dbu } download #{ @remote_target } #{ @local_target }`
+        end
+      else
+        error_msg = 'Local and remote targets cannot be nil'
+        @logger.error(error_msg) if @logger
+        fail StandardError, error_msg
+      end
+    end
+
+    # Uploads files tro Dropbox (assumes that both
+    # local_target and remote_target have been set).
+    # @return [void]
+    def upload
+      if !@local_target.nil? && !@remote_target.nil?
+        if @verbose
+          system "#{ @dbu } upload #{ @local_target } #{ @remote_target }"
+        else
+          exec = `#{ @dbu } upload #{ @local_target } #{ @remote_target }`
+        end
+      else
+        error_msg = 'Local and remote targets cannot be nil'
+        @logger.error(error_msg) if @logger
+        fail StandardError, error_msg
+      end
+    end
+  end
+end

data/lib/{sifttter_redux → sifttter-redux}/sifttter.rb

@@ -1,20 +1,13 @@
 module SifttterRedux
-  #  ======================================================
-  #  Sifttter Module
-  #
-  #  Wrapper module for Sifttter itself
-  #  ======================================================
+  # Sifttter Module
+  # Wrapper module for Sifttter itself
   module Sifttter
-    #  ----------------------------------------------------
-    #  run_sifttter method
+    # Modified form of Sifttter
     #
-    #  Modified form of Sifttter
-    #
-    #  Sifttter: An IFTTT-to-Day One Logger by Craig Eley
-    #  Based on tp-dailylog.rb by Brett Terpstra 2012
-    #  @param date The date to use when scanning Sifttter
-    #  @return Void
-    #  ----------------------------------------------------
+    # Sifttter: An IFTTT-to-Day One Logger by Craig Eley
+    # Based on tp-dailylog.rb by Brett Terpstra 2012
+    # @param [Date] date The date to use when scanning Sifttter
+    # @return [void]
     def self.run(date)
       uuid = SecureRandom.uuid.upcase.gsub(/-/, '').strip
 
@@ -46,10 +39,12 @@ module SifttterRedux
       date_regex = "(?:#{ date.strftime("%B") } 0?#{ date.strftime("%-d") }, #{ date.strftime("%Y") })"
       time_regex = "(?:\d{1,2}:\d{1,2}\s?[AaPpMm]{2})"
 
-      files = `find #{ Configuration::sifttter_redux[:sifttter_local_filepath] } -type f -name "*.txt" | grep -v -i daily | sort`
+      files = `find #{ configuration.sifttter_redux[:sifttter_local_filepath] } -type f -name "*.txt" | grep -v -i daily | sort`
       if files.empty?
-        CLIMessage::error("No Sifttter files to parse; is #{ Configuration::sifttter_redux[:sifttter_remote_filepath] } the correct remote filepath?")
-        return
+        messenger.error('No Sifttter files to parse...')
+        messenger.error('Is Dropbox Uploader configured correctly?')
+        messenger.error("Is #{ configuration.sifttter_redux[:sifttter_remote_filepath] } the correct remote filepath?")
+        exit!(1)
       end
 
       projects = []
@@ -77,7 +72,7 @@ module SifttterRedux
       end
 
       if projects.length <=0
-      	CLIMessage::warning('No entries found...')
+      	messenger.warn('No entries found...')
       end
 
       if projects.length > 0
@@ -86,12 +81,12 @@ module SifttterRedux
       		entrytext += project.gsub(/.txt/, ' ') + "\n\n"
       	end
 
-        Dir.mkdir(Configuration::sifttter_redux[:dayone_local_filepath]) if !Dir.exists?(Configuration::sifttter_redux[:dayone_local_filepath])
+        Dir.mkdir(configuration.sifttter_redux[:dayone_local_filepath]) if !Dir.exists?(configuration.sifttter_redux[:dayone_local_filepath])
 
-      	fh = File.new(File.expand_path(Configuration::sifttter_redux[:dayone_local_filepath] + '/' + uuid + '.doentry'), 'w+')
+      	fh = File.new(File.expand_path(configuration.sifttter_redux[:dayone_local_filepath] + '/' + uuid + '.doentry'), 'w+')
       	fh.puts template.result(binding)
       	fh.close
-      	CLIMessage::success("Entry logged for #{ date_for_title }...")
+      	messenger.success("Entry logged for #{ date_for_title }...")
       end
     end
   end

data/lib/sifttter-redux.rb

@@ -0,0 +1,164 @@
+require 'sifttter-redux/constants'
+require 'sifttter-redux/date-range-maker'
+require 'sifttter-redux/dropbox-uploader'
+require 'sifttter-redux/sifttter'
+
+# The SifttterRedux module, which wraps everything
+# in this gem.
+module SifttterRedux
+  
+  class << self
+    # Stores whether initalization has completed.
+    # @return [Boolean]
+    attr_reader :initialized
+    
+    # Stores whether verbose output is turned on.
+    # @return [Boolean]
+    attr_accessor :verbose
+  end
+  
+  # Removes temporary directories and their contents
+  # @return [void]
+  def self.cleanup_temp_files
+    dirs = [
+      configuration.sifttter_redux[:dayone_local_filepath],
+      configuration.sifttter_redux[:sifttter_local_filepath]
+    ]
+
+    messenger.info_block('Removing temporary local files...') do 
+      dirs.each do |d|
+        FileUtils.rm_rf(d)
+        messenger.debug("Removed directory: #{ d }")
+      end
+    end
+  end
+
+  # Runs a wizard that installs Dropbox Uploader on the
+  # local filesystem.
+  # @param [Boolean] from_scratch 
+  # @return [void]
+  def self.dbu_install_wizard(from_scratch = false)
+    valid_path_chosen = false
+    
+    messenger.section_block('CONFIGURING DROPBOX UPLOADER...') do
+      until valid_path_chosen
+        # Prompt the user for a location to save Dropbox Uploader.
+        if from_scratch && !configuration.db_uploader[:base_filepath].nil?
+          default = configuration.db_uploader[:base_filepath]
+        else
+          default = DEFAULT_DBU_LOCAL_FILEPATH
+        end
+        path = messenger.prompt('Location for Dropbox-Uploader', default)
+        path = default if path.empty?
+        path.chop! if path.end_with?('/')
+        
+        # If the entered directory exists, clone the repository.
+        if Dir.exists?(File.expand_path(path))
+          valid_path_chosen = true
+          
+          dbu_path = File.join(path, 'Dropbox-Uploader')
+          executable_path = File.join(dbu_path, 'dropbox_uploader.sh')
+
+          if File.directory?(dbu_path)
+            messenger.warn("Using pre-existing Dropbox Uploader at #{ dbu_path }...")
+          else
+            messenger.info_block("Downloading Dropbox Uploader to #{ dbu_path }...", 'Done.', true) do
+              system "git clone https://github.com/andreafabrizi/Dropbox-Uploader.git #{ dbu_path }"
+            end
+          end
+
+          # If the user has never configured Dropbox Uploader, have them do it here.
+          unless File.exists?(DEFAULT_DBU_CONFIG_FILEPATH)
+            messenger.info_block('Initializing Dropbox Uploader...') { system "#{ executable_path }" }
+          end
+
+          configuration.add_section(:db_uploader) unless configuration.data.key?(:db_uploader)
+          configuration.db_uploader.merge!({
+            base_filepath: path, 
+            dbu_filepath: dbu_path,
+            exe_filepath: executable_path
+          })
+        else
+          messenger.error("Sorry, but #{ path } isn't a valid directory.")
+        end
+      end
+    end
+  end
+
+  # Creates a date range from the supplied command line
+  # options.
+  # @param [Hash] options GLI command line options
+  # @return [Range]
+  def self.get_dates_from_options(options)
+    messenger.section_block('EXECUTING...') do
+      if options[:c] || options[:n] || options[:w] || options[:y] || options[:f] || options[:t]
+        # Yesterday
+        r = DateRangeMaker.yesterday if options[:y]
+
+        # Current Week
+        r = DateRangeMaker.last_n_weeks(0, options[:i]) if options[:c]
+        
+        # Last N Days
+        r = DateRangeMaker.last_n_days(options[:n].to_i, options[:i]) if options[:n]
+
+        # Last N Weeks
+        r = DateRangeMaker.last_n_weeks(options[:w].to_i, options[:i]) if options[:w]
+
+        # Custom Range
+        if (options[:f] || options[:t])
+          _dates = DateRangeMaker.range(options[:f], options[:t], options[:i])
+
+          if _dates.last > Date.today
+            long_message = "Ignoring overextended end date and using today's date (#{ Date.today })..."
+            messenger.warn(long_message)
+            r = (_dates.first..Date.today)
+          else
+            r = (_dates.first.._dates.last)
+          end
+        end
+      else
+        r = DateRangeMaker.today
+      end
+      
+      messenger.debug("Date range: #{ r }")
+      r
+    end
+  end
+
+  # Initializes Sifttter Redux by downloading and
+  # collecting all necessary items and info.
+  # @param [Boolean] from_scratch
+  # @return [void]
+  def self.init(from_scratch = false)
+    if from_scratch
+      configuration.reset
+      configuration.add_section(:sifttter_redux)
+    end
+
+    configuration.sifttter_redux.merge!({
+      config_location: configuration.config_path,
+      log_level: 'WARN',
+      version: SifttterRedux::VERSION,
+    })
+
+    # Run the wizard to download Dropbox Uploader.
+    dbu_install_wizard(from_scratch = from_scratch)
+
+    pm = CLIUtils::Prefs.new(SifttterRedux::PREF_FILES['INIT'], configuration)
+    pm.ask
+    configuration.ingest_prefs(pm)
+
+    messenger.debug { "Configuration values after pref collection: #{ configuration.data }" }
+    configuration.save
+    @initialized = true
+  end
+
+  # Notifies the user that the config file needs to be
+  # re-done and does it.
+  # @return [void]
+  def self.update_config_file
+    messenger.info("This version needs to make some config changes. Don't worry; when prompted, your current values for existing config options will be presented (so it'll be easier to fly through the upgrade).")
+    messenger.prompt('Press enter to continue')
+    SifttterRedux.init(true)
+  end
+end