sifttter-redux 0.5.4 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac0c51854f8d85fe836c9bec7be780a4d149ef55
-  data.tar.gz: 83c7b28fe6fae8fae9c55d1e95c9b845a1fa5817
+  metadata.gz: 6967ac35281de5c0dd08146937c43fee382de50d
+  data.tar.gz: 67c9c4c56ceeea7e137cf351642b7beaf4cc6862
 SHA512:
-  metadata.gz: 952c9d9cc4d4e68ced1d567278d4294fb5551ad7c5f9ff11f9fc4ba1a8ec847137dad74f29124ae45d3d3bf6db51cf13e6a6ceb6857f96d49a3e02b6b2895b3f
-  data.tar.gz: 3f8c244c3a6872727f775a2973ecbadfdbb1ad46730cae3f05f742bab981b0f6835cd8af6dc641f86fee6447f3c599852700fae9b58f4f827491f3d6ef2c84ef
+  metadata.gz: 5f270d0de834059c6eb902f8952266614ae55f081ce4c415f50b3ccae13edeb9013c4fda4c36e86ddf4d9945132d7e5c98fa42a723faa4a07207b7f39bf564c3
+  data.tar.gz: 1b3494e3085c982ea906e36480ad7badf9f9f6ff982d07c7bf630151948b1c16baaa29a88a621b5373e5d6fb730f07fb43ce79dfe5b980559c6aa47596a57e4c

data/.gitignore

@@ -3,3 +3,4 @@ Gemfile.lock
 .DS_Store
 results.html
 *.gem
+features/3.execution.feature

data/.travis.yml

@@ -3,4 +3,8 @@ rvm:
   - 2.1.0
   - 2.0.0
   - 1.9.3
-  - jruby-19mode
+  - jruby-19mode
+env:
+  - TEST_SUITE=1.ui.feature
+script:
+  - bundle exec cucumber -f progress -r features features/$TEST_SUITE

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+
 gemspec

data/Rakefile

@@ -1,22 +1,25 @@
 require 'rake/clean'
 require 'rubygems'
-require 'rubygems/package_task'
-require 'rdoc/task'
-require 'cucumber'
-require 'cucumber/rake/task'
-Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
-  rd.title = 'Your application title'
+
+def version
+  contents = File.read File.expand_path('../lib/sifttter-redux/constants.rb', __FILE__)
+  contents[/VERSION = '([^']+)'/, 1]
 end
 
-spec = eval(File.read('sifttter_redux.gemspec'))
+spec = eval(File.read('sifttter-redux.gemspec'))
 
-Gem::PackageTask.new(spec) do |pkg|
+require 'rake/testtask'
+desc 'Run unit tests'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
 end
+
+require 'cucumber'
+require 'cucumber/rake/task'
 CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
-desc 'Run features'
+desc 'Run Cucumber features'
 Cucumber::Rake::Task.new(:features) do |t|
   opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
   opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
@@ -24,21 +27,71 @@ Cucumber::Rake::Task.new(:features) do |t|
   t.fork = false
 end
 
-desc 'Run features tagged as work-in-progress (@wip)'
-Cucumber::Rake::Task.new('features:wip') do |t|
-  tag_opts = ' --tags ~@pending'
-  tag_opts = ' --tags @wip'
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
-  t.fork = false
+desc "Release Sifttter Redux version #{ version }"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  
+  sh "git commit --allow-empty -a -m 'Release #{ version }'"
+  sh "git tag v#{ version }"
+  sh "git push origin master"
+  sh "git push origin v#{ version }"
+  sh "gem push pkg/sifttter-redux-#{ version }.gem"
 end
 
-task :cucumber => :features
-task 'cucumber:wip' => 'features:wip'
-task :wip => 'features:wip'
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+desc "Build the gem"
+task :build do
+  p version
+  FileUtils.mkdir_p "pkg"
+  sh "gem build sifttter-redux.gemspec"
+  FileUtils.mv("./sifttter-redux-#{ version }.gem", "pkg")
 end
 
-task :default => [:test]
+task :default => [:test, :features]
+
+# require 'rake/clean'
+# require 'rubygems'
+# require 'rubygems/package_task'
+# require 'rdoc/task'
+# require 'cucumber'
+# require 'cucumber/rake/task'
+# Rake::RDocTask.new do |rd|
+#   rd.main = "README.rdoc"
+#   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+#   rd.title = 'Your application title'
+# end
+# 
+# spec = eval(File.read('sifttter_redux.gemspec'))
+# 
+# Gem::PackageTask.new(spec) do |pkg|
+# end
+# CUKE_RESULTS = 'results.html'
+# CLEAN << CUKE_RESULTS
+# desc 'Run features'
+# Cucumber::Rake::Task.new(:features) do |t|
+#   opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+#   opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+#   t.cucumber_opts =  opts
+#   t.fork = false
+# end
+# 
+# desc 'Run features tagged as work-in-progress (@wip)'
+# Cucumber::Rake::Task.new('features:wip') do |t|
+#   tag_opts = ' --tags ~@pending'
+#   tag_opts = ' --tags @wip'
+#   t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+#   t.fork = false
+# end
+# 
+# task :cucumber => :features
+# task 'cucumber:wip' => 'features:wip'
+# task :wip => 'features:wip'
+# require 'rake/testtask'
+# Rake::TestTask.new do |t|
+#   t.libs << "test"
+#   t.test_files = FileList['test/*_test.rb']
+# end
+# 
+# task :default => [:test, :features]

data/bin/srd

@@ -32,12 +32,14 @@
 #  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 #  OTHER DEALINGS IN THE SOFTWARE.
 #--------------------------------------------------------------------
+require 'cliutils'
 require 'gli'
-require 'sifttter_redux'
+require 'sifttter-redux'
 require 'securerandom'
 
+include CLIUtils::Configuration
+include CLIUtils::Messenging
 include GLI::App
-include SifttterRedux
 
 #  ======================================================
 #  App Info
@@ -48,7 +50,7 @@ program_desc 'Sifttter Redux
     smart installation and automated running on a standalone
     *NIX device (such as a Raspberry Pi).'
 
-version VERSION
+version SifttterRedux::VERSION
 
 #  ======================================================
 #  Global Flags and Switches
@@ -61,44 +63,55 @@ switch([:verbose], desc: 'Turns on verbose output')
 pre do |global, command, options, args|
 
   # Load SifttterRedux configuration module.
-  Configuration::load(SRD_CONFIG_FILEPATH)
+  load_configuration(SifttterRedux::DEFAULT_SRD_CONFIG_FILEPATH)
+  file_logger = Logger.new(SifttterRedux::DEFAULT_SRD_LOG_FILEPATH)
+  file_logger.level = LOG_LEVELS[configuration.sifttter_redux[:log_level] || 'DEBUG']
+  messenger.attach(LOGFILE: file_logger)
 
-  # Set up logging.
-  CLIMessage::activate_logging
-  CLIMessage::log_level(Configuration::sifttter_redux[:log_level] || Logger::WARN)
+  if File.exists?(SifttterRedux::DEFAULT_SRD_CONFIG_FILEPATH)
+    # Check to see if there is a new config file version
+    # to be installed.
+    c_version = Gem::Version.new(configuration.sifttter_redux[:version])
+    l_version = Gem::Version.new(SifttterRedux::NEWEST_CONFIG_VERSION)
 
-  if File.exists?(SRD_CONFIG_FILEPATH)
-    current_version = Gem::Version.new(Configuration::sifttter_redux[:version])
-    last_config_change_version = Gem::Version.new(NEWEST_CONFIG_VERSION)
+    messenger.debug { "Current gem version: #{ c_version }" }
+    messenger.debug { "Last version with config change: #{ l_version }" }
 
     # If the config file needs updating, force the user to do that first.
-    if Configuration::sifttter_redux[:version].nil? || current_version < last_config_change_version
-      CLIMessage::info('This version needs to make some config changes.')
-      CLIMessage::info("Don't worry; when prompted, your current values for")
-      CLIMessage::info("existing config options will be presented (so it'll")
-      CLIMessage::info('be easier to fly through the upgrade).')
-      CLIMessage::prompt('Press enter to continue')
-      SifttterRedux::init(true)
+    if configuration.sifttter_redux[:version].nil? || c_version < l_version
+      SifttterRedux.update_config_file
       exit!(0)
     end
   else
     # Force the user to init if they try to run any command other than `init` first.
-    SifttterRedux::init(true)
+    SifttterRedux.init(true)
     exit!(0)
   end
 
   true
 end
 
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  messenger.error(exception.to_s)
+  exit!(1)
+  true
+end
+
 #  ======================================================
 #  Commands
 #  ======================================================
 #  ------------------------------------------------------
 #  exec command
 #
-#  Executes the script.
+#  Executes the app.
 #  ------------------------------------------------------
-desc 'Execute the script'
+desc 'Execute the app'
 command :exec do |c|
   c.flag([:f], desc: 'Run catch-up mode with this start date')
   c.flag([:n], desc: 'Run catch-up mode for the last N days')
@@ -113,49 +126,44 @@ command :exec do |c|
   c.action do |global_options, options, args|
     SifttterRedux.verbose = global_options[:verbose] || options[:verbose]
 
-    begin
-      dates = SifttterRedux::get_dates_from_options(options)
-      unless dates.nil?
-        first_date = dates.first
-        second_date = dates.reverse_each.first
-
-        date_string = first_date.strftime('%B %d, %Y')
-        date_string << " to #{ second_date.strftime('%B %d, %Y') }" if first_date != second_date
-        CLIMessage::info("Creating #{ first_date == second_date ? 'entry' : 'entries' }: #{ date_string }")
-
-        # Download Sifttter files from Dropbox.
-        dbu = DropboxUploader.new(Configuration::db_uploader[:exe_filepath])
-        dbu.verbose = SifttterRedux.verbose
-        dbu.local_target = Configuration::sifttter_redux[:sifttter_local_filepath]
-        dbu.remote_target = Configuration::sifttter_redux[:sifttter_remote_filepath]
-        dbu.message = 'Downloading Sifttter files...'
-
-        CLIMessage::info_block(dbu.message || dbu::DEFAULT_MESSAGE, 'Done.', SifttterRedux.verbose) do
-          dbu.download
-        end
+    dates = SifttterRedux::get_dates_from_options(options)
+    unless dates.nil?
+      first_date = dates.first
+      second_date = dates.reverse_each.first
 
-        # Process a new Sifttter entry for each date.
-        dates.each do |date|
-          Sifttter::run(date)
-        end
+      date_string = first_date.strftime('%B %d, %Y')
+      date_string << " to #{ second_date.strftime('%B %d, %Y') }" if first_date != second_date
+      messenger.info("Creating #{ first_date == second_date ? 'entry' : 'entries' }: #{ date_string }")
 
-        # Upload any Day One entries to Dropbox (if there are any).
-        unless Dir[Configuration::sifttter_redux[:dayone_local_filepath] + '/*'].empty?
-          dbu.local_target = "#{ Configuration::sifttter_redux[:dayone_local_filepath] }/*"
-          dbu.remote_target = Configuration::sifttter_redux[:dayone_remote_filepath]
-          dbu.message = 'Uploading Day One entries to Dropbox...'
+      # Download Sifttter files from Dropbox.
+      dbu = SifttterRedux::DropboxUploader.new(configuration.db_uploader[:exe_filepath])
+      dbu.verbose = SifttterRedux.verbose
+      dbu.local_target = configuration.sifttter_redux[:sifttter_local_filepath]
+      dbu.remote_target = configuration.sifttter_redux[:sifttter_remote_filepath]
+      dbu.message = 'Downloading Sifttter files...'
 
-          CLIMessage::info_block(dbu.message || dbu::DEFAULT_MESSAGE, 'Done.', SifttterRedux.verbose) do
-            dbu.upload
-          end
-        end
+      messenger.info_block(dbu.message || dbu::DEFAULT_MESSAGE, 'Done.', SifttterRedux.verbose) do
+        dbu.download
+      end
 
-        # Remove any downloaded local files that we no longer need.
-        SifttterRedux::cleanup_temp_files
+      # Process a new Sifttter entry for each date.
+      dates.each do |date|
+        SifttterRedux::Sifttter.run(date)
       end
-    rescue StandardError => e
-      CLIMessage::error(e.to_s)
-      exit!(1)
+
+      # Upload any Day One entries to Dropbox (if there are any).
+      unless Dir[configuration.sifttter_redux[:dayone_local_filepath] + '/*'].empty?
+        dbu.local_target = "#{ configuration.sifttter_redux[:dayone_local_filepath] }/*"
+        dbu.remote_target = configuration.sifttter_redux[:dayone_remote_filepath]
+        dbu.message = 'Uploading Day One entries to Dropbox...'
+
+        messenger.info_block(dbu.message || SifttterRedux::DEFAULT_MESSAGE, 'Done.', SifttterRedux.verbose) do
+          dbu.upload
+        end
+      end
+
+      # Remove any downloaded local files that we no longer need.
+      SifttterRedux.cleanup_temp_files
     end
   end
 
@@ -164,22 +172,25 @@ end
 #  ------------------------------------------------------
 #  init command
 #
-#  Initializes the script.
+#  Initializes the app by asking the user for information
+#  needed torun.
 #  ------------------------------------------------------
-desc 'Install and SifttterRedux::initialize dependencies'
+desc 'Install and initialize dependencies'
 command :init do |c|
   c.switch([:s], desc: 'Run init from scratch (i.e., clear out all values from configuration)')
-
   c.action do |global_options, options, args|
-    CLIMessage::section_block('INITIALIZING...') do
+    messenger.section_block('INITIALIZING...') do
       if options[:s]
         SifttterRedux::init(true)
       else
         long_message = "You've already initialized Sifttter Redux. Do it again?"
-        SifttterRedux::init if CLIMessage::prompt(long_message, 'N').downcase == 'y'
+        SifttterRedux::init if messenger.prompt(long_message, 'N').downcase == 'y'
       end
     end
   end
 end
 
+#  ======================================================
+#  Run!
+#  ======================================================
 exit run(ARGV)

data/features/1.ui.feature

@@ -0,0 +1,7 @@
+Feature: UI
+  As a user, when I ask for help, I should be presented
+  with instructions on how to run the app.
+
+  Scenario: Display help instructions
+    When I get help for "srd"
+    Then the exit status should be 0

data/features/2.initialization.feature

@@ -0,0 +1,130 @@
+@announce
+Feature: Initialization
+  As a user, when I initialize Sifttter Redux,
+  I should be guided through the process as
+  necessary.
+
+  Scenario: Basic Initialization
+    Given no file located at "/tmp/srd/.sifttter_redux"
+      And an empty file located at "/tmp/srd/.dropbox_uploader"
+    When I run `srd init` interactively
+      And I type ""
+      And I type "~/sifttter_download"
+      And I type "/Apps/ifttt/Sifttter"
+      And I type "~/day_one_download"
+      And I type "/Apps/Day\ One/Journal.dayone/entries"
+    Then the exit status should be 0
+      And the file "/tmp/srd/.sifttter_redux" should contain:
+    """
+    ---
+    :sifttter_redux:
+      :config_location: "/tmp/srd/.sifttter_redux"
+      :log_level: WARN
+    """
+      And the file "/tmp/srd/.sifttter_redux" should contain:
+      """
+        :sifttter_local_filepath: "/tmp/srd/sifttter_download"
+        :sifttter_remote_filepath: "/Apps/ifttt/Sifttter"
+        :dayone_local_filepath: "/tmp/srd/day_one_download"
+        :dayone_remote_filepath: "/Apps/Day\\ One/Journal.dayone/entries"
+      :db_uploader:
+        :base_filepath: "/usr/local/opt"
+        :dbu_filepath: "/usr/local/opt/Dropbox-Uploader"
+        :exe_filepath: "/usr/local/opt/Dropbox-Uploader/dropbox_uploader.sh"
+      """
+  
+  Scenario: Reinitialization (refuse)
+    Given a file located at "/tmp/srd/.sifttter_redux" with the contents:
+    """
+    ---
+    :sifttter_redux:
+      :config_location: "/tmp/srd/.sifttter_redux"
+      :log_level: WARN
+      :version: 0.5.4
+      :sifttter_local_filepath: "/tmp/srd/sifttter_download"
+      :sifttter_remote_filepath: "/Apps/ifttt/Sifttter"
+      :dayone_local_filepath: "/tmp/srd/day_one_download"
+      :dayone_remote_filepath: "/Apps/Day\\ One/Journal.dayone/entries"
+    :db_uploader:
+      :base_filepath: "/usr/local/opt"
+      :dbu_filepath: "/usr/local/opt/Dropbox-Uploader"
+      :exe_filepath: "/usr/local/opt/Dropbox-Uploader/dropbox_uploader.sh"
+    """
+      And an empty file located at "/tmp/srd/.dropbox_uploader"
+    When I run `srd init` interactively
+      And I type ""
+    Then the exit status should be 0
+    
+  Scenario: Reinitialization (accept)
+    Given a file located at "/tmp/srd/.sifttter_redux" with the contents:
+    """
+    ---
+    :sifttter_redux:
+      :config_location: "/tmp/srd/.sifttter_redux"
+      :log_level: WARN
+      :version: 0.5.4
+      :sifttter_local_filepath: "/tmp/srd/sifttter_download"
+      :sifttter_remote_filepath: "/Apps/ifttt/Sifttter"
+      :dayone_local_filepath: "/tmp/srd/day_one_download"
+      :dayone_remote_filepath: "/Apps/Day\\ One/Journal.dayone/entries"
+    :db_uploader:
+      :base_filepath: "/usr/local/opt"
+      :dbu_filepath: "/usr/local/opt/Dropbox-Uploader"
+      :exe_filepath: "/usr/local/opt/Dropbox-Uploader/dropbox_uploader.sh"
+    """
+      And an empty file located at "/tmp/srd/.dropbox_uploader"
+    When I run `srd init` interactively
+      And I type "y"
+      And I type ""
+      And I type "~/sifttter_download2"
+      And I type "/Apps/ifttt/Sifttter2"
+      And I type "~/day_one_download2"
+      And I type "/Apps/Day\ One/Journal.dayone/entries2"
+    Then the exit status should be 0
+      And the file "/tmp/srd/.sifttter_redux" should contain:
+    """
+    ---
+    :sifttter_redux:
+      :config_location: "/tmp/srd/.sifttter_redux"
+      :log_level: WARN
+    """
+      And the file "/tmp/srd/.sifttter_redux" should contain:
+      """
+        :sifttter_local_filepath: "/tmp/srd/sifttter_download2"
+        :sifttter_remote_filepath: "/Apps/ifttt/Sifttter2"
+        :dayone_local_filepath: "/tmp/srd/day_one_download2"
+        :dayone_remote_filepath: "/Apps/Day\\ One/Journal.dayone/entries2"
+      :db_uploader:
+        :base_filepath: "/usr/local/opt"
+        :dbu_filepath: "/usr/local/opt/Dropbox-Uploader"
+        :exe_filepath: "/usr/local/opt/Dropbox-Uploader/dropbox_uploader.sh"
+      """  
+
+  Scenario: Reinitialization (from scratch)
+    Given no file located at "/tmp/srd/.sifttter_redux"
+      And an empty file located at "/tmp/srd/.dropbox_uploader"
+    When I run `srd init -s` interactively
+      And I type ""
+      And I type "~/sifttter_download"
+      And I type "/Apps/ifttt/Sifttter"
+      And I type "~/day_one_download"
+      And I type "/Apps/Day\ One/Journal.dayone/entries"
+    Then the exit status should be 0
+      And the file "/tmp/srd/.sifttter_redux" should contain:
+    """
+    ---
+    :sifttter_redux:
+      :config_location: "/tmp/srd/.sifttter_redux"
+      :log_level: WARN
+    """
+      And the file "/tmp/srd/.sifttter_redux" should contain:
+      """
+        :sifttter_local_filepath: "/tmp/srd/sifttter_download"
+        :sifttter_remote_filepath: "/Apps/ifttt/Sifttter"
+        :dayone_local_filepath: "/tmp/srd/day_one_download"
+        :dayone_remote_filepath: "/Apps/Day\\ One/Journal.dayone/entries"
+      :db_uploader:
+        :base_filepath: "/usr/local/opt"
+        :dbu_filepath: "/usr/local/opt/Dropbox-Uploader"
+        :exe_filepath: "/usr/local/opt/Dropbox-Uploader/dropbox_uploader.sh"
+      """