sifttter-redux 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73ab433b741563883c45e45f82c91e15c9e49295
-  data.tar.gz: 25b24954832700c6ca4df4bf7e61b669e5e0a44c
+  metadata.gz: ee3777283bf2b3748e1d5a2d835e7f875d96603f
+  data.tar.gz: 9e3caeb4839353e7ac748285e64582483d52081e
 SHA512:
-  metadata.gz: d4259f37c57045b0ab6c36705f41afeb904754d0ae7a9056a799618d5039de7f85a464f75cddc076a6ee6f57a10848c3079f85557467404c102d2d68023b4360
-  data.tar.gz: c7e12c1a9c333daf080e728e122eea96be5675307ec7f7dc0778d5c4d68b09aa66749e896e1d6f7ab5469c83bf78cdf22288c70cc49457274c4cfe106c7173e7
+  metadata.gz: d1ccdb1974ba23ecf3a143752c65ba1847c259f8636848c3814bad7872e527b269c752836303444762aa2f4c9a3b464c49ef00b4de20163291c4b6eabcdc16dc
+  data.tar.gz: 1f1a2efc918a43e59dc0e5dd620d2653da0273e15bc986a4e46227247ef723465e9e789532f974f3358a358a89ec7f11fbd0aee2358b6feb9ebbf3466a412e71

data/HISTORY.md

@@ -1,3 +1,9 @@
+# 0.3.4 (2014-02-21)
+
+* Automatically configure Dropbox Uploader during init (if needed)
+* Fixed several small bugs
+* Added more test cases
+
 # 0.3.3 (2014-02-20)
 
 * Fixed a bug in which the SifttterRedux module wouldn't load

data/README.md

@@ -7,7 +7,7 @@ Siftter Redux's primary difference is in its execution method: it intended to ru
 
 The aim of this project was to use a Raspberry Pi; as such, the instructions below are specifically catered to that platform. That said, it should be possible to install and configure on any *NIX platform.
 
-## Prerequisites
+# Prerequisites
 
 In addition to Git (which, given you being on this site, I'll assume you have), there are two prerequisites needed to run Sifttter Redux in a *NIX environment:
 
@@ -21,13 +21,13 @@ $ sudo apt-get install ruby
 $ sudo apt-get install uuid
 ```
 
-## Installation
+# Installation
 
 ```
 gem install sifttter-redux
 ```
 
-## Usage
+# Usage
 
 Syntax and usage can be accessed by running `srd help`:
 
@@ -55,7 +55,7 @@ COMMANDS
     init - Install and initialize dependencies
 ```
 
-### Initialization
+## Initialization
 
 ```
 $ srd init
@@ -70,7 +70,7 @@ Initialization will perform the following steps:
  3. The location on your filesystem where Day One files will be temporarily stored
  4. The location of your Day One files in Dropbox
 
-### Basic Execution
+## Basic Execution
 
 ```
 $ srd exec
@@ -84,13 +84,13 @@ $ srd exec
 #### EXECUTION COMPLETE!
 ```
 
-### "Catch-up" Mode
+## "Catch-up" Mode
 
 Sometimes, events occur that prevent Sifttter Redux from running (power loss to your device, a bad Cron job, etc.). In this case, Sifttter Redux's "catch-up" mode can be used to collect any valid journal on or before today's date.
 
 There are many ways to use this mode (note that "today" in these examples is **February 15, 2014**):
 
-#### Yesterday Catch-up
+### Yesterday Catch-up
 
 To create an entry for yesterday:
 
@@ -106,7 +106,7 @@ $ srd exec -y
 #### EXECUTION COMPLETE!
 ```
 
-#### Last "N" Days Catch-up
+### Last "N" Days Catch-up
 
 Sifttter Redux allows you to specify the number of days back it should look for new entries:
 
@@ -124,6 +124,7 @@ $ srd exec -n 3
 #### EXECUTION COMPLETE!
 
 $ srd exec -n 12
+#### EXECUTING...
 ---> INFO: Creating entries for dates from February 03, 2014 to February 14, 2014...
 ---> INFO: Downloading Sifttter files...DONE.
 ---> SUCCESS: February 03, 2014...
@@ -161,7 +162,7 @@ $ srd exec -i -n 3
 #### EXECUTION COMPLETE!
 ```
 
-#### Last "N" Weeks Catch-up
+### Last "N" Weeks Catch-up
 
 Sifttter Redux also allows you to specify a number of weeks back that should be scanned for new entries:
 
@@ -249,7 +250,7 @@ $ srd exec -i -w 1
 #### EXECUTION COMPLETE!
 ```
 
-#### Date Range Catch-up
+### Date Range Catch-up
 
 To create entries for a range of dates:
 
@@ -354,13 +355,13 @@ $ srd exec -f "last monday" -t "yesterday"
 
 See [Chronic's Examples section](https://github.com/mojombo/chronic#examples "Chronic Examples") for more examples.
 
-## Cron Job
+# Cron Job
 
 By installing an entry to the Raspberry Pi's `crontab`, Sifttter Redux can be run automatically on a schedule.
 
 One issue that arises is the loading of the bundled gems; because `cron` runs in a limited environment, it does not automatically know where to find installed gems.
 
-### Using RVM
+## Using RVM
 
 If your Raspberry Pi uses RVM, this `crontab` entry will do:
 
@@ -368,7 +369,7 @@ If your Raspberry Pi uses RVM, this `crontab` entry will do:
 55 23 * * * /bin/bash -l -c 'source "$HOME/.rvm/scripts/rvm" && srd exec'
 ```
 
-### Globally Installing Bundled Gems
+## Globally Installing Bundled Gems
 
 Another option is to install the bundled gems to the global gemset:
 
@@ -376,12 +377,12 @@ Another option is to install the bundled gems to the global gemset:
 $ bundle install --global
 ```
 
-## Known Issues
+# Known Issues
 
 * Sifttter Redux makes no effort to see if entries already exist in Day One for a particular date. This means that if you're not careful, you might end up with duplicate entries. A future version will address this.
 * At indeterminiate times (usually when in catch-up mode), Sifttter Redux will upload a file to Day One that Day One fails to read. Uncertain of the cause at this stage, but it's happened a few times.
 
-## Future Releases
+# Future Releases
 
 Some functionality I would like to tackle for future releases:
 
@@ -389,7 +390,7 @@ Some functionality I would like to tackle for future releases:
 * Interactive cron job installer
 * Smarter checking of the config file to see if an old version is being used
 
-## Bugs and Feature Requests
+# Bugs and Feature Requests
 
 To report bugs with or suggest features/changes for Sifttter Redux, please use the [Issues Page](http://github.com/bachya/sifttter-redux/issues).
 
@@ -401,7 +402,7 @@ Contributions are welcome and encouraged. To contribute:
 * Push to the branch (`git push origin new-feature`).
 * Create a new [Pull Request](http://github.com/bachya/sifttter-redux/compare/).
 
-## License
+# License
 
 (The MIT License)
 
@@ -413,7 +414,7 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-## Credits
+# Credits
 
 * Craig Eley for [Sifttter](http://craigeley.com/post/72565974459/sifttter-an-ifttt-to-day-one-logger "Sifttter") and for giving me the idea for Sifttter Redux
 * Dave Copeland for [GLI](https://github.com/davetron5000/gli "GLI")

data/bin/srd

@@ -162,7 +162,7 @@ command :exec do |c|
         # Specific Range
         if !command_complete && (options[:f] || options[:t])
           begin
-            dates = SifttterRedux::DateRangeMaker.from_to(options[:f], options[:t], options[:i])
+            dates = SifttterRedux::DateRangeMaker.range(options[:f], options[:t], options[:i])
 
             if dates.last > Date.today
               SifttterRedux::CliMessage.warning("Ignoring overextended end date and using today's date (#{ Date.today })")

data/lib/sifttter_redux/cli_message.rb

@@ -1,3 +1,5 @@
+require File.join(File.dirname(__FILE__), 'string_extensions.rb')
+
 module SifttterRedux
   #  ======================================================
   #  CliManager Module
@@ -36,18 +38,22 @@ module SifttterRedux
     #  @return Void
     #  ----------------------------------------------------
     def self.info_block(m1, m2 = 'Done.', multiline = false)
-      if multiline
-        info(m1)
-      else
-        print "---> INFO: #{ m1 }".blue
-      end
+      if block_given?
+        if multiline
+          info(m1)
+        else
+          print "---> INFO: #{ m1 }".blue
+        end
 
-      yield
+        yield
 
-      if multiline
-        info(m2)
+        if multiline
+          info(m2)
+        else
+          puts m2.blue
+        end
       else
-        puts m2.blue
+        fail ArgumentError, 'Did not specify a valid block'
       end
     end
 
@@ -92,13 +98,17 @@ module SifttterRedux
     #  @return Void
     #  ----------------------------------------------------
     def self.section_block(m, multiline = true)
-      if multiline
-        section(m)
+      if block_given?
+        if multiline
+          section(m)
+        else
+          print "#### #{ m }".purple
+        end
+
+        yield
       else
-        print "#### #{ m }".purple
+        fail ArgumentError, 'Did not specify a valid block'
       end
-
-      yield
     end
 
     #  ----------------------------------------------------

data/lib/sifttter_redux/configuration.rb

@@ -18,6 +18,24 @@ module SifttterRedux
     def self.[](section_name)
       @data[section_name]
     end
+    
+    #  ----------------------------------------------------
+    #  []= method
+    #
+    #  Assigns the passed hash to the section. NOTE THAT THE
+    #  PREVIOUS CONTENTS OF THAT SECTION ARE DELETED.
+    #  @param section_name The section in which to look
+    #  @param hash The Hash that gets merged into the section
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.[]=(section_name, hash)
+      if hash.is_a?(Hash)
+        @data[section_name] = {}
+        @data[section_name].merge!(hash)
+      else
+        fail ArgumentError, "Parameter is not a Hash: #{hash}"
+      end
+    end
 
     #  ----------------------------------------------------
     #  add_section method
@@ -58,6 +76,16 @@ module SifttterRedux
         CliMessage.warning("Can't delete non-existing section: #{section_name}")
       end
     end
+    
+    #  ----------------------------------------------------
+    #  dump method
+    #
+    #  Returns the data Hash
+    #  @return Hash
+    #  ----------------------------------------------------
+    def self.dump
+      @data
+    end
 
     #  ----------------------------------------------------
     #  load method
@@ -108,15 +136,5 @@ module SifttterRedux
     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

@@ -65,7 +65,7 @@ module SifttterRedux
     #  @param options Miscellaneous options hash
     #  @return Range
     #  ------------------------------------------------------
-    def self.from_to(start_date, end_date, include_today = false)
+    def self.range(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

data/lib/sifttter_redux/dbu.rb

@@ -5,6 +5,7 @@ module SifttterRedux
   #  Wrapper module for the Dropbox Uploader project
   #  ======================================================
   module DBU
+    CONFIG_FILEPATH = File.join(ENV['HOME'], '.dropbox_uploader')
     DEFAULT_MESSAGE = 'RUNNING DROPBOX UPLOADER'
 
     #  ----------------------------------------------------
@@ -57,6 +58,9 @@ module SifttterRedux
                 system "git clone https://github.com/andreafabrizi/Dropbox-Uploader.git #{ path }"
               end
             end
+            
+            # If the user has never configured Dropbox Uploader, have them do it here.
+            system "#{ @dbu }" unless File.exists?(CONFIG_FILEPATH)
 
             Configuration.add_section('db_uploader')
             Configuration['db_uploader'].merge!('local_filepath' => path)

data/lib/sifttter_redux/version.rb

@@ -1,3 +1,3 @@
 module SifttterRedux
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/lib/sifttter_redux.rb

@@ -1,7 +1,6 @@
 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'

data/test/cli_message_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+require File.join(File.dirname(__FILE__), "..", "lib/sifttter_redux/cli_message.rb")
+
+class CliMessageTest < Test::Unit::TestCase
+  def test_error_message
+    assert_output('---> ERROR: test'.red + "\n") { SifttterRedux::CliMessage.error('test') }
+  end
+
+  def test_info_message
+    assert_output('---> INFO: test'.blue + "\n") { SifttterRedux::CliMessage.info('test') }
+  end
+
+  def test_info_block_single_line
+    assert_output("---> INFO: start".blue + "body\n" + 'end'.blue + "\n") do
+      SifttterRedux::CliMessage.info_block('start', 'end') { puts 'body' }
+    end
+  end
+
+  def test_info_block_multiline
+    assert_output("---> INFO: start".blue + "\nbody\n" + '---> INFO: end'.blue + "\n") do
+      SifttterRedux::CliMessage.info_block('start', 'end', true) { puts 'body' }
+    end
+  end
+  
+  def test_info_block_no_block
+    assert_raise ArgumentError do
+      SifttterRedux::CliMessage.info_block('start', 'end', true)
+    end
+  end
+
+  def test_prompt
+    assert_equal(SifttterRedux::CliMessage.prompt('Pick the default option', 'default'), 'default')
+  end
+
+  def test_section_message
+    assert_output('#### test'.purple + "\n") { SifttterRedux::CliMessage.section('test') }
+  end
+
+  def test_section_block_single_line
+    assert_output("#### section".purple + "\nbody\n") do
+      SifttterRedux::CliMessage.section_block('section', true) { puts 'body' }
+    end
+  end
+
+  def test_success_message
+    assert_output('---> SUCCESS: test'.green + "\n") { SifttterRedux::CliMessage.success('test') }
+  end
+
+  def test_warning_message
+    assert_output('---> WARNING: test'.yellow + "\n") { SifttterRedux::CliMessage.warning('test') }
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,76 @@
+require "test_helper"
+require File.join(File.dirname(__FILE__), "..", "lib/sifttter_redux/configuration.rb")
+
+class ConfigurationTest < Test::Unit::TestCase
+  
+  def setup
+    SifttterRedux::Configuration.load('/tmp/srd_config')
+  end
+
+  def teardown
+    File.delete('/tmp/srd_config') if File.exists?('/tmp/srd_config')
+  end
+  
+  def test_add_data
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration['section1'] = { 'a' => 'test', 'b' => 'test' }
+    assert_equal(SifttterRedux::Configuration.dump, { 'section1' => { 'a' => 'test', 'b' => 'test' } })
+    
+    SifttterRedux::Configuration['section1']['a'] = 'bigger test'
+    SifttterRedux::Configuration['section1']['c'] = 'little test'
+    assert_equal(SifttterRedux::Configuration.dump, { 'section1' => { 'a' => 'bigger test', 'b' => 'test', 'c' => 'little test' } })
+  end
+  
+  def test_add_section
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration.add_section('section2')
+    assert_equal(SifttterRedux::Configuration.dump, { 'section1' => {}, 'section2' => {} })
+  end
+  
+  def test_add_section_duplicate
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration.add_section('section2')
+    SifttterRedux::Configuration.add_section('section2')
+    assert_equal(SifttterRedux::Configuration.dump, { 'section1' => {}, 'section2' => {} })
+  end
+  
+  def test_config_path
+    assert_equal(SifttterRedux::Configuration.config_path, '/tmp/srd_config')
+  end
+  
+  def test_delete_section
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration.add_section('section2')
+    SifttterRedux::Configuration.delete_section('section2')
+    assert_equal(SifttterRedux::Configuration.dump, { 'section1' => {} })
+  end
+  
+  def test_delete_section_nonexistant
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration.delete_section('section12723762323')
+    assert_equal(SifttterRedux::Configuration.dump, { 'section1' => {} })
+  end
+  
+  def test_reset
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration.add_section('section2')
+    SifttterRedux::Configuration.add_section('section3')
+    SifttterRedux::Configuration.reset
+    assert_equal(SifttterRedux::Configuration.dump, {})
+  end
+  
+  def test_save
+    SifttterRedux::Configuration.add_section('section1')
+    SifttterRedux::Configuration['section1'] = { 'a' => 'test', 'b' => 'test' }
+    SifttterRedux::Configuration.save
+    
+    File.open('/tmp/srd_config', 'r') do |f|
+      assert_output("---\nsection1:\n  a: test\n  b: test\n") { puts f.read }
+    end
+  end
+  
+  def test_section_exists
+    SifttterRedux::Configuration.add_section('section1')
+    assert_equal(SifttterRedux::Configuration.section_exists?('section1'), true)
+  end
+end

data/test/{catch_up_test.rb → date_range_maker_test.rb}

@@ -1,9 +1,8 @@
 require "date"
 require "test_helper"
-require File.join(File.dirname(__FILE__), "..", "lib/sifttter_redux/date_from_to_maker.rb")
-
-class DefaultTest < Test::Unit::TestCase
+require File.join(File.dirname(__FILE__), "..", "lib/sifttter_redux/date_range_maker.rb")
 
+class DateRangeMakerTest < Test::Unit::TestCase
   def test_today
     assert_equal(SifttterRedux::DateRangeMaker.today, (Date.today..Date.today))
   end
@@ -64,37 +63,37 @@ class DefaultTest < Test::Unit::TestCase
     assert_equal(SifttterRedux::DateRangeMaker.last_n_weeks(2, true), (Date.today - Date.today.wday - 13..end_date))
   end
 
-  def test_from_to_only_start_date
-    assert_equal(SifttterRedux::DateRangeMaker.from_to("2014-02-01", nil), (Date.parse("2014-02-01")...Date.today))
+  def test_range_only_start_date
+    assert_equal(SifttterRedux::DateRangeMaker.range("2014-02-01", nil), (Date.parse("2014-02-01")...Date.today))
   end
 
-  def test_from_to_only_start_date_include_today
-    assert_equal(SifttterRedux::DateRangeMaker.from_to("2014-02-01", nil, true), (Date.parse("2014-02-01")..Date.today))
+  def test_range_only_start_date_include_today
+    assert_equal(SifttterRedux::DateRangeMaker.range("2014-02-01", nil, true), (Date.parse("2014-02-01")..Date.today))
   end
 
-  def test_from_to_start_date_and_end_date
-    assert_equal(SifttterRedux::DateRangeMaker.from_to("2014-02-01", "2014-02-05"), (Date.parse("2014-02-01")..Date.parse("2014-02-05")))
+  def test_range_start_date_and_end_date
+    assert_equal(SifttterRedux::DateRangeMaker.range("2014-02-01", "2014-02-05"), (Date.parse("2014-02-01")..Date.parse("2014-02-05")))
   end
 
-  def test_from_to_bad_dates
-    assert_raise ArgumentError do
-      SifttterRedux::DateRangeMaker.from_to("Bad Start Date", "Bad End Date")
+  def test_range_bad_dates
+    assert_raise ArgumentError do 
+      SifttterRedux::DateRangeMaker.range("Bad Start Date", "Bad End Date")
     end
   end
 
-  def test_from_to_end_date_with_no_start_date
+  def test_range_end_date_with_no_start_date
     assert_raise ArgumentError do
-      SifttterRedux::DateRangeMaker.from_to(nil, Date.today)
+      SifttterRedux::DateRangeMaker.range(nil, Date.today)
     end
   end
 
-  def test_from_to_end_date_before_start_date
+  def test_range_end_date_before_start_date
     assert_raise ArgumentError do
-      SifttterRedux::DateRangeMaker.from_to(Date.today, Date.today - 1)
+      SifttterRedux::DateRangeMaker.range(Date.today, Date.today - 1)
     end
   end
 
-  def test_from_to_negative_look_back
+  def test_range_negative_look_back
     assert_raise ArgumentError do
       SifttterRedux::DateRangeMaker.last_n_days(-5)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sifttter-redux
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Aaron Bach
@@ -75,12 +75,14 @@ files:
 - lib/sifttter_redux/configuration.rb
 - lib/sifttter_redux/date_range_maker.rb
 - lib/sifttter_redux/dbu.rb
-- lib/sifttter_redux/extensions.rb
 - lib/sifttter_redux/os.rb
 - lib/sifttter_redux/sifttter.rb
+- lib/sifttter_redux/string_extensions.rb
 - lib/sifttter_redux/version.rb
 - sifttter_redux.gemspec
-- test/catch_up_test.rb
+- test/cli_message_test.rb
+- test/configuration_test.rb
+- test/date_range_maker_test.rb
 - test/test_helper.rb
 homepage: https://github.com/bachya/sifttter-redux
 licenses:
@@ -109,6 +111,8 @@ signing_key:
 specification_version: 4
 summary: Automated IFTTT to Day One engine.
 test_files:
-- test/catch_up_test.rb
+- test/cli_message_test.rb
+- test/configuration_test.rb
+- test/date_range_maker_test.rb
 - test/test_helper.rb
 has_rdoc: