sifttter-redux 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzllODE5NmRmZjBmZWQ3OGI0N2Q0M2M2MDhiZjBlN2YxY2Y0NzllZQ==
+  data.tar.gz: !binary |-
+    MTA2YjEzMGQ1YjI5MzZmNzUwNWFlY2NmMmVkYjgyNGJjYWY2ODU5NQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZmU3N2U3OGNhMzNmYmJlNDA3MWU0MzMwYjdjZGY5NWYxODA0ZmFiNWEwOWY4
+    ZDVlNDFkYjhlMWYwYzYyOWZiNDQ3MDEwY2MzYWEyY2IwMjA1YjQ3N2I2OGI5
+    MzdiYjc3ZDRhNTkzMjJiNzUxNTFkYWE2NTMwYTRmY2VhYjNiNGI=
+  data.tar.gz: !binary |-
+    YzE2YjJmMmI2ZTRjMGY0Yzk2NzU3MGQ3ZjE0Zjk0MWQzZTU3NGU5Y2U0YTRm
+    Mjc1NmVlZDJkNzdhOTExNGYxMTFjNDhiMTc5NGY5YmM1Y2JmMjIwYTdhYjk3
+    MTVlZjVjNDliZWY0YTZmZGE2OTdhYzhlZjhlNzdlNzcyNTUzZDc=

data/.gitignore

@@ -0,0 +1,8 @@
+Gemfile.lock
+.bundle
+.DS_Store
+features
+results.html
+README.rdoc
+Sifttter-Redux.rdoc
+*.gem

data/HISTORY.md

@@ -0,0 +1,7 @@
+# 0.2.0 
+
+* Implementation of catch-up mode
+
+# 0.1.0
+
+* Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Tom Preston-Werner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,227 @@
+Sifttter Redux
+==============
+
+Siftter Redux is a modification of Craig Eley's [Siftter](http://gist.github.com/craigeley/8301817 "Siftter"), a script to collect information from [IFTTT](http://www.ifttt.com "IFTTT") and place it in a [Day One](http://dayoneapp.com, "Day One") journal. 
+
+Siftter Redux's primary difference is in its execution method: it intended to run autonomously so that it does not need to be manually activated. This allows IFTTT data to be synchronized to Day One on a schedule.
+
+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
+
+There are three prerequisites needed to run Sifttter Redux:
+
+* Ruby (version 1.9.3 or greater)
+* Git
+* UUID
+
+These packages must be installed on your system before running Sifttter Redux. To install these packages on Raspbian:
+
+```
+$ sudo apt-get install ruby
+$ sudo apt-get install git-core
+$ sudo apt-get install uuid
+```
+
+## Installation
+
+First, clone this repository via git:
+
+```
+$ git clone https://github.com/bachya/Sifttter-Redux.git
+```
+
+Next, cd into the Sifttter Redux directory and install the necessary gems:
+
+```
+$ cd Sifttter-Redux
+$ bundle install
+```
+
+*(note that you may want to run `bundle install --global` for the sake of `cron` -- [see below](#cron-job))*
+
+Finally, make sure the script is executable and initialize it:
+
+```
+$ chmod +x srd
+$ ./srd init
+```
+
+## Usage
+
+Syntax and usage can be accessed by running `./srd help`:
+
+```
+$ ./srd help
+NAME
+    srd - Sifttter Redux v1.1
+
+    A modification of Craig Eley's Sifttter that allows for smart
+    installation on a standalone *NIX device (such as a Raspberry Pi).
+
+SYNOPSIS
+    srd [global options] command [command options] [arguments...]
+
+GLOBAL OPTIONS
+    --help - Show this message
+
+COMMANDS
+    exec - Execute the script
+    help - Shows a list of commands or help for one command
+    init - Install and initialize dependencies
+```
+
+### Initialization
+
+```
+$ ./srd init
+```
+
+Initialization will perform the following steps:
+
+1. Download [Dropbox-Uploader](https://github.com/andreafabrizi/Dropbox-Uploader "Dropbox-Uploder") to a location of your choice.
+2. Collect some user preferences:
+ 1. The location on your filesystem where Sifttter files will be temporarily stored
+ 2. The location of your Sifttter files in Dropbox
+ 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 Mode
+
+```
+# Creates an entry for today 
+$ ./srd exec
+```
+
+### "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 data before the current day.
+
+There are many ways to use this mode:
+
+#### 7-Day Catch-up
+
+To create entries for the past 7 days (not inclusive of the current day):
+
+```
+# Creates an entry for each day from from 7 days ago to yesterday
+$ ./srd exec -c
+```
+
+To include the current day:
+
+```
+# Creates an entry for each day from 7 days ago to today
+$ ./srd exec -c -i
+```
+
+#### Yesterday Catch-up
+
+To create an entry for yesterday:
+
+```
+# Creates an entry for yesterday
+$ ./srd exec -y
+```
+
+#### Date Range Catch-up
+
+To create entries for a range of dates:
+
+```
+# Creates an entry for each day from 2/1/2014 to 2/12/2014
+$ ./srd exec -f 2014-02-01 -t 2014-02-12
+```
+
+Even more simply, to create entries from a specific point until yesterday ("yesterday" because you might not be ready to have today's entries scanned):
+
+```
+# Creates an entry for each day from 2/1/2014 to yesterday's date
+$ ./srd exec -f 2014-02-01
+```
+
+Of course, if you want to include today's date, you can always use the trusty `-i` switch:
+
+```
+# Creates an entry for each day from 2/1/2014 to today's date
+$ ./srd exec -f 2014-02-01 -i
+```
+
+Two notes to be aware of:
+
+* `-f` and `-t` are *inclusive* parameters, meaning that when specified, those dates will be included when searching for Siftter data.
+* Although you can specify `-f` by itself, you cannot specify `-t` by itself.
+
+Sifttter Redux makes use of the excellent [Chronic gem](https://github.com/mojombo/chronic "Chronic"), which provides natural language parsing for dates and times. This means that you can run commands with more "human" dates:
+
+```
+# Natural language parsing is great! Thanks, Chronic!
+$ ./srd exec -f "last Thursday" -t "yesterday"
+```
+
+See [Chronic's Examples section](https://github.com/mojombo/chronic#examples "Chronic Examples") for more examples.
+
+## 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
+
+If your Raspberry Pi uses RVM, this `crontab` entry will do:
+
+```
+55 23 * * * /bin/bash -l -c 'source "$HOME/.rvm/scripts/rvm" && "$HOME/Sifttter-Redux/srd" exec'
+```
+
+### Globally Installing Bundled Gems
+
+Another option is to install the bundled gems to the global gemset:
+
+```
+$ bundle install --global
+```
+
+## 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
+
+Some functionality I would like to tackle for future releases:
+
+* Interactive cron job installer
+* Verbose mode that more explicity tells the user what's currently going on
+* Automatic gem bundling
+
+## 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).
+
+Contributions are welcome and encouraged. To contribute:
+
+* [Fork Sifttter Redux](http://github.com/bachya/Sifttter-Redux/fork).
+* Create a branch for your contribution (`git checkout -b new-feature`).
+* Commit your changes (`git commit -am 'Added this new feature'`).
+* Push to the branch (`git push origin new-feature`).
+* Create a new [Pull Request](http://github.com/bachya/Sifttter-Redux/compare/).
+
+## License
+
+(The MIT License)
+
+Copyright © 2014 Aaron Bach <bachya1208@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+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
+
+* Craig Eley for Sifttter and for giving me the idea for Sifttter Redux
+* Andrea Fabrizi for her stellar Dropbox Uploader project
+* The Chronic folks for making the aforementioned wonderful Chronic gem

data/Rakefile

@@ -0,0 +1,44 @@
+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/Sifttter-Redux.gemspec

@@ -0,0 +1,30 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','Sifttter-Redux','constants.rb'])
+
+spec = Gem::Specification.new do |s| 
+  s.name = 'sifttter-redux'
+  s.version = SifttterRedux::VERSION
+  s.author = 'Aaron Bach'
+  s.email = 'bachya1208@gmail.com'
+  s.homepage = 'https://github.com/bachya/Sifttter-Redux'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'Automated IFTTT to Day One engine.'
+  s.description = 'Sifttter Redux is a modification of Craig Eley\'s Sifttter that allows for smart installation on a standalone *NIX device (such as a Raspberry Pi).'
+
+  s.files = `git ls-files`.split($/)
+  s.test_files = `git ls-files -- test`.split($/)
+  s.require_paths << 'lib'
+  s.bindir = 'bin'
+  s.executables << 'srd'
+  
+  s.license = 'MIT'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = %w[README.md HISTORY.md LICENSE]
+  s.rdoc_options << '--title' << 'Sifttter-Redux' << '--main' << 'README.rdoc' << '-ri'
+  
+  
+  s.add_development_dependency('rake', '~> 0')
+  s.add_runtime_dependency('chronic', '0.10.2')
+  s.add_runtime_dependency('colored','1.2')
+  s.add_runtime_dependency('gli','2.9.0')
+end

data/bin/srd

@@ -0,0 +1,212 @@
+#!/usr/bin/env ruby
+#-------------------------------------------------------------------------------------------------------------
+#  Sifttter Redux
+#
+#  A modification of Craig Eley's Sifttter that allows for smart installation on a standalone *NIX
+#  device (such as a Raspberry Pi).
+#
+#  Sifttter copyright Craig Eley 2014 <http://craigeley.com>
+#
+#  Copyright (c) 2014
+#  Aaron Bach <bachya1208@gmail.com>
+#  
+#  Permission is hereby granted, free of charge, to any person
+#  obtaining a copy of this software and associated documentation
+#  files (the "Software"), to deal in the Software without
+#  restriction, including without limitation the rights to use,
+#  copy, modify, merge, publish, distribute, sublicense, and/or sell
+#  copies of the Software, and to permit persons to whom the
+#  Software is furnished to do so, subject to the following
+#  conditions:
+#  
+#  The above copyright notice and this permission notice shall be
+#  included in all copies or substantial portions of the Software.
+#  
+#  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.
+#-------------------------------------------------------------------------------------------------------------
+
+require 'colored'
+require 'fileutils'
+require 'gli'
+require 'time'
+require 'yaml'
+
+require 'Sifttter-Redux'
+
+include GLI::App
+
+$config = ConfigManager.instance
+$date_range_maker = DateRangeMaker.new
+$db_uploader = File.join($config.db_uploader["local_filepath"], "dropbox_uploader.sh")
+
+program_desc "Sifttter Redux
+
+    A modification of Craig Eley's Sifttter that allows for smart
+    installation on a standalone *NIX device (such as a Raspberry Pi)."
+
+version SifttterRedux::VERSION
+
+# desc 'Describe some switch here'
+# switch [:s,:switch]
+# 
+# desc 'Describe some flag here'
+# default_value 'the default'
+# arg_name 'The name of the argument'
+# flag [:f,:flagname]
+
+#|  ======================================================
+#|  Pre, Post, and Error 
+#|  ======================================================
+
+pre do |global,command,options,args|
+  if !File.exists?(SifttterRedux::SRD_CONFIG_FILEPATH)
+    CliMessage.info("It doesn't look like you've initlized Sifttter Redux yet. Doing that now...")
+    initialize_procedures
+  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|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+#|  ======================================================
+#|  Commands
+#|  ======================================================
+
+#|  ------------------------------------------------------
+#|  exec command
+#|
+#|  Executes the script.
+#|  ------------------------------------------------------
+
+desc 'Execute the script'
+command :exec do |c|  
+  
+  c.flag(
+    [:f, :from],
+    :desc => 'Run catch-up mode with this start date',
+  )
+  
+  c.flag(
+    [:t, :to],
+    :desc => 'Run catch-up mode with this end date (must be accompanied by --from)',
+  )
+  
+  c.switch(
+    [:c, :last_7_days],
+    :desc => 'Run catch-up mode for the last 7 days'
+  )
+  
+  c.switch(
+    [:i, :include_today],
+    :desc => 'Include today\'s date in catch-up'
+  )
+  
+  c.switch(
+    [:y, :yesterday],
+    :desc => 'Run catch-up mode for yesterday'
+  )
+  
+  c.action do |global_options, options, args|
+    command_complete = false
+    
+    CliMessage.section('EXECUTING...')
+
+    if (options[:c] || options[:y] || options[:f] || options[:t])
+      if (!command_complete && options[:c])
+        dates = $date_range_maker.last_seven_days(options[:i])
+        command_complete = true
+      end
+      
+      if (!command_complete && options[:y])
+        dates = $date_range_maker.yesterday
+        command_complete = true
+      end
+      
+      if (!command_complete && (options[:f] || options[:t]))
+        begin
+          dates = $date_range_maker.range({
+            :start_date => options[:f],
+            :end_date => options[:t],
+            :include_today => options[:i],
+          })
+
+          if (dates.last > Date.today)
+            CliMessage.warning("Ignoring overextended end date and using today's date (#{Date.today})")
+            dates = (dates.first..Date.today)
+          end
+        rescue DateRangeMakerError
+          CliMessage.error($!)
+        end
+        command_complete = true
+      end
+    else
+      dates = $date_range_maker.today
+      command_complete = true
+    end
+    
+    if (!dates.nil?)
+      CliMessage.info("Creating entries for dates from #{dates.first} to #{dates.reverse_each.first}...")
+    
+      download_sifttter_files
+      
+      dates.each do |date|
+        run_sifttter(date)
+        # puts date
+      end
+      # Upload any Day One entries to Dropbox (if there are any).
+      if (!Dir[$config.sifttter_redux["dayone_local_filepath"] + "/*"].empty?)
+        CliMessage.info("Uploading Day One entries to Dropbox...", false)
+        output = `#{$db_uploader} upload #{$config.sifttter_redux["dayone_local_filepath"] + "/*"} #{$config.sifttter_redux["dayone_remote_filepath"]}`
+        CliMessage.finish_message('DONE.')
+      end
+      
+      # Remove any downloaded local files that we no longer need.
+      CliMessage.info("Removing downloaded Day One files...", false)
+      FileUtils.rm_rf($config.sifttter_redux["dayone_local_filepath"]) if Dir.exists?($config.sifttter_redux["dayone_local_filepath"])
+      CliMessage.finish_message('DONE.')
+      
+      CliMessage.info("Removing downloaded Sifttter files...", false)
+      FileUtils.rm_rf($config.sifttter_redux["sifttter_local_filepath"]) if Dir.exists?($config.sifttter_redux["sifttter_local_filepath"])
+      CliMessage.finish_message('DONE.')
+    end
+
+    CliMessage.section('EXECUTION COMPLETE!')
+  end
+end
+
+#|  ------------------------------------------------------
+#|  init command
+#|
+#|  Initializes the script.
+#|  ------------------------------------------------------
+desc 'Install and initialize dependencies'
+command :init do |c|
+  c.action do |global_options, options, args|
+    CliMessage.section('INITIALIZING...')
+
+    if File.exists?($config.configFile)
+      initialize_procedures if CliMessage.prompt("It looks like you've already initialized Sifttter Redux. Do you want to re-initialize?", "N").downcase
+    else
+      initialize_procedures
+    end
+  end
+end
+
+exit run(ARGV)