sifttter-redux 0.3.1 → 0.3.2

data/lib/sifttter_redux.rb

@@ -0,0 +1,105 @@
+require 'sifttter_redux/cli_message.rb'
+require 'sifttter_redux/configuration.rb'
+require 'sifttter_redux/date_range_maker.rb'
+require 'sifttter_redux/extensions.rb'
+require 'sifttter_redux/dbu.rb'
+require 'sifttter_redux/os.rb'
+require 'sifttter_redux/sifttter.rb'
+
+#  ======================================================
+#  SifttterRedux Module
+#
+#  Wrapper module for all other modules in this project
+#  ======================================================
+
+module SifttterRedux
+  using CliMessage
+  using Configuration
+
+  #  ----------------------------------------------------
+  #  Constants
+  #  ----------------------------------------------------
+  DBU_LOCAL_FILEPATH = '/usr/local/opt'
+  DO_REMOTE_FILEPATH = "/Apps/Day\\ One/Journal.dayone/entries"
+  DO_LOCAL_FILEPATH = '/tmp/dayone'
+  SRD_CONFIG_FILEPATH = File.join(ENV['HOME'], '.sifttter_redux')
+  SFT_LOCAL_FILEPATH = '/tmp/sifttter'
+  SFT_REMOTE_FILEPATH = '/Apps/ifttt/sifttter'
+
+  @verbose_output = true
+
+  #  ----------------------------------------------------
+  #  initialize_procedures method
+  #
+  #  Initializes Sifttter Redux by downloading and
+  #  collecting all necessary items and info.
+  #  @return Void
+  #  ----------------------------------------------------
+  def self.init
+    # Re-initialize the configuration data.
+    Configuration.reset
+    Configuration.add_section('sifttter_redux')
+    Configuration['sifttter_redux'].merge!('config_location' => Configuration.config_path)
+
+    # Run the wizard to download Dropbox Uploader.
+    DBU::install_wizard
+
+    # Collect other misc. preferences.
+    CliMessage.section_block('COLLECTING PREFERENCES...') do
+      pref_prompts = [
+        {
+          prompt: 'Location for downloaded Sifttter files from Dropbox',
+          default: SFT_LOCAL_FILEPATH,
+          key: 'sifttter_local_filepath',
+          section: 'sifttter_redux'
+        },
+        {
+          prompt: 'Location of Sifttter files in Dropbox',
+          default: SFT_REMOTE_FILEPATH,
+          key: 'sifttter_remote_filepath',
+          section: 'sifttter_redux'
+        },
+        {
+          prompt: 'Location for downloaded Day One files from Dropbox',
+          default: DO_LOCAL_FILEPATH,
+          key: 'dayone_local_filepath',
+          section: 'sifttter_redux'
+        },
+        {
+          prompt: 'Location of Day One files in Dropbox',
+          default: DO_REMOTE_FILEPATH,
+          key: 'dayone_remote_filepath',
+          section: 'sifttter_redux'
+        }
+      ]
+
+      pref_prompts.each do |prompt|
+        pref = CliMessage.prompt(prompt[:prompt], prompt[:default])
+        Configuration[prompt[:section]].merge!(prompt[:key] => pref)
+      end
+    end
+
+    Configuration.save
+  end
+
+  #  ----------------------------------------------------
+  #  verbose method
+  #
+  #  Returns the verbosity state.
+  #  @return Bool
+  #  ----------------------------------------------------
+  def self.verbose
+    @verbose_output
+  end
+
+  #  ----------------------------------------------------
+  #  verbose= method
+  #
+  #  Sets the verbosity state.
+  #  @return Void
+  #  ----------------------------------------------------
+  def self.verbose=(verbose)
+    @verbose_output = verbose
+  end
+
+end

data/lib/sifttter_redux/cli_message.rb

@@ -0,0 +1,126 @@
+module SifttterRedux
+  #  ======================================================
+  #  CliManager Module
+  #  Singleton to manage common CLI interfacing
+  #  ======================================================
+  module CliMessage
+    #  ----------------------------------------------------
+    #  error method
+    #
+    #  Outputs a formatted-red error message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.error(m)
+      puts "---> ERROR: #{ m }".red
+    end
+
+    #  ----------------------------------------------------
+    #  info method
+    #
+    #  Outputs a formatted-blue informational message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.info(m)
+      puts "---> INFO: #{ m }".blue
+    end
+
+    #  ----------------------------------------------------
+    #  info_block method
+    #
+    #  Wraps a block in an opening and closing info message.
+    #  @param m1 The opening message to output
+    #  @param m2 The closing message to output
+    #  @param multiline Whether the message should be multiline
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.info_block(m1, m2 = 'Done.', multiline = false)
+      if multiline
+        info(m1)
+      else
+        print "---> INFO: #{ m1 }".blue
+      end
+
+      yield
+
+      if multiline
+        info(m2)
+      else
+        puts m2.blue
+      end
+    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 m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.section(m)
+      puts "#### #{ m }".purple
+    end
+
+    #  ----------------------------------------------------
+    #  section_block method
+    #
+    #  Wraps a block in an opening and closing section
+    #  message.
+    #  @param m1 The opening message to output
+    #  @param m2 The closing message to output
+    #  @param multiline A multiline message or not
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.section_block(m, multiline = true)
+      if multiline
+        section(m)
+      else
+        print "#### #{ m }".purple
+      end
+
+      yield
+    end
+
+    #  ----------------------------------------------------
+    #  success method
+    #
+    #  Outputs a formatted-green success message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.success(m)
+      puts "---> SUCCESS: #{ m }".green
+    end
+
+    #  ----------------------------------------------------
+    #  warning method
+    #
+    #  Outputs a formatted-yellow warning message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.warning(m)
+      puts "---> WARNING: #{ m }".yellow
+    end
+  end
+end

data/lib/sifttter_redux/configuration.rb

@@ -0,0 +1,122 @@
+require 'yaml'
+
+module SifttterRedux
+  #  ======================================================
+  #  Configuration Module
+  #
+  #  Manages any configuration values and the flat file
+  #  into which they get stored.
+  #  ======================================================
+  module Configuration
+    #  ----------------------------------------------------
+    #  [] method
+    #
+    #  Returns the Hash of data for a particular section.
+    #  @param section_name The section in which to look
+    #  @return Hash
+    #  ----------------------------------------------------
+    def self.[](section_name)
+      @data[section_name]
+    end
+
+    #  ----------------------------------------------------
+    #  add_section method
+    #
+    #  Creates a new section in the configuration data.
+    #  @param section_name The section to add
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.add_section(section_name)
+      if !self.section_exists?(section_name)
+        @data[section_name] = {}
+      else
+        CliMessage.warning("Can't create already-existing section: #{section_name}")
+      end
+    end
+
+    #  ----------------------------------------------------
+    #  config_path method
+    #
+    #  Returns the filepath to the flat configuration file.
+    #  @return String
+    #  ----------------------------------------------------
+    def self.config_path
+      @config_path
+    end
+
+    #  ----------------------------------------------------
+    #  delete_section method
+    #
+    #  Deletes a section from the configuration data.
+    #  @param section_name The section to delete
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.delete_section(section_name)
+      if self.section_exists?(section_name)
+        @data.delete(section_name)
+      else
+        CliMessage.warning("Can't delete non-existing section: #{section_name}")
+      end
+    end
+
+    #  ----------------------------------------------------
+    #  load method
+    #
+    #  Loads the configuration data (if it exists) and sets
+    #  the filepath to the flat file.
+    #  @param path The filepath
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.load(path)
+      @config_path = path
+
+      if File.exists?(path)
+        @data = YAML.load_file(path)
+      else
+        @data = {}
+      end
+    end
+
+    #  ----------------------------------------------------
+    #  reset method
+    #
+    #  Clears the configuration data.
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.reset
+      @data = {}
+    end
+
+    #  ----------------------------------------------------
+    #  save method
+    #
+    #  Saves the configuration data to the previously
+    #  stored flat file.
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.save
+      File.open(@config_path, 'w') { |f| f.write(@data.to_yaml) }
+    end
+
+    #  ----------------------------------------------------
+    #  section_exists? method
+    #
+    #  Checks for the existance of the passed section.
+    #  @param section_name The section to look for
+    #  @return Bool
+    #  ----------------------------------------------------
+    def self.section_exists?(section_name)
+      @data.key?(section_name)
+    end
+
+    #  ----------------------------------------------------
+    #  to_s method
+    #
+    #  Method to output this Module as a String.
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.to_s
+      puts @data
+    end
+  end
+end

data/lib/sifttter_redux/date_range_maker.rb

@@ -0,0 +1,120 @@
+require 'chronic'
+
+module SifttterRedux
+  #  ======================================================
+  #  Configuration Module
+  #
+  #  Manages any configuration values and the flat file
+  #  into which they get stored.
+  #  ======================================================
+  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
+    #  ------------------------------------------------------
+    def self.last_n_days(num_days, include_today = false)
+      fail ArgumentError, 'Cannot specify a negative number of days' if num_days < 0
+
+      if include_today
+        (Date.today - num_days..Date.today)
+      else
+        (Date.today - num_days...Date.today)
+      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
+    #  ------------------------------------------------------
+    def self.last_n_weeks(num_weeks = 0, include_today = false)
+      fail ArgumentError, 'Cannot specify a negative number of weeks' if num_weeks < 0
+
+      beginning_date = Date.today - Date.today.wday + 1
+      end_date = Date.today - Date.today.wday + 7
+
+      # We coerce the end date to be today if a date
+      # greater than today has been specified.
+      end_date = Date.today if end_date > Date.today
+
+      if include_today
+        (beginning_date - num_weeks * 7..end_date)
+      else
+        (beginning_date - num_weeks * 7...end_date)
+      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
+    #  ------------------------------------------------------
+    def self.from_to(start_date, end_date, include_today = false)
+      fail ArgumentError, "You can't specify -t without specifying -f" if start_date.nil? && !end_date.nil?
+
+      begin
+        chronic_start_date = Chronic.parse(start_date).to_date
+      rescue
+        fail ArgumentError, "Invalid date provided to Chronic: #{ start_date }" unless start_date.nil?
+        nil
+      end
+
+      begin
+        chronic_end_date = Chronic.parse(end_date).to_date
+      rescue
+        fail ArgumentError, "Invalid date provided to Chronic: #{ end_date }" unless end_date.nil?
+        nil
+      end
+
+      fail ArgumentError, 'The start date must be before or equal to the end date' if chronic_end_date && chronic_start_date > chronic_end_date
+
+      unless chronic_start_date.nil?
+        if chronic_end_date.nil?
+          if include_today
+            (chronic_start_date..Date.today)
+          else
+            (chronic_start_date...Date.today)
+          end
+        else
+          (chronic_start_date..chronic_end_date)
+        end
+      end
+    end
+
+    #  ------------------------------------------------------
+    #  today method
+    #
+    #  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
+    #  ------------------------------------------------------
+    def self.yesterday
+      (Date.today - 1..Date.today - 1)
+    end
+  end
+end