remindmeto 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec6896f8f6f03b9fefa5ea2f7db1752ced94d901
+  data.tar.gz: dcaa0f6ba1e71653328926a34d823a4ad2a88457
+SHA512:
+  metadata.gz: 7aaba7132df7b5af8e350db4493904ee6390d8fab1fdaaafac990070b639d7cc250c773a64c25293f81fd6a72082aaf41b46d8abfdc54378e59249c809a12059
+  data.tar.gz: 19e88da6cdb07a43b6dbcade37fefd72c4c30912f69de4e94cd627cf9c46aec7f16ad0b5f368c992dab622cbe61aef6ee33c3f995ff39b4e98f22507b677d780

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hunter Clarke
+
+MIT License
+
+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,26 @@
+# Remindmeto
+
+A simple, intuitive reminder tool for the command line.
+
+Current supported UI elements include libnotify for Ubuntu and the Notification Center for Mac.
+
+## Installation
+
+    $ gem install remindmeto
+
+## Usage
+
+    $ remindmeto task {in/every} {time} {second(s)/minutes(s)/hour(s)}
+
+Examples:
+
+    $ remindmeto relax every 5 minutes
+    $ remindmeto turn over the laundry in an hour
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+require "remindmeto/version"
+
+task :default => :test
+
+RSpec::Core::RakeTask.new(:spec)
+desc 'Run RSpec tests'
+task :test => [:spec]
+
+task :build do
+  `gem build remindmeto.gemspec`
+end
+
+task :install do
+  `gem install remindmeto-#{RemindMeTo::VERSION}.gem`
+end
+
+task :dev do
+  Rake::Task["build"].invoke
+  Rake::Task["install"].invoke
+end

data/bin/remindmeto

@@ -0,0 +1,18 @@
+#! /usr/bin/env ruby
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'remindmeto'
+
+begin
+  require 'remindmeto/cli'
+  cli = RemindMeTo::CLI.new
+  cli.run
+rescue Interrupt => e
+  puts '\nQuitting RemindMeTo...'
+  exit 1
+rescue SystemExit => e
+  exit e.status
+end
+

data/lib/remindmeto.rb

@@ -0,0 +1,8 @@
+require 'remindmeto/version'
+require 'remindmeto/os'
+require 'remindmeto/cli'
+require 'remindmeto/normalizer'
+require 'remindmeto/notifier'
+require 'remindmeto/runner'
+require 'remindmeto/notifier/notification_center_notifier'
+require 'remindmeto/notifier/libnotify_notifier'

data/lib/remindmeto/cli.rb

@@ -0,0 +1,23 @@
+module RemindMeTo
+  class CLI
+
+    def initialize
+      @options = {}
+    end
+
+    def run(args = ARGV)
+      trap_interrupt
+
+      @options = Normalizer.new(args).process
+      Runner.new(@options).run
+    end
+
+    def trap_interrupt
+      Signal.trap('INT') do
+        exit!(1)
+        $stderr.puts
+        $stderr.puts 'Stopping remindmeto'
+      end
+    end
+  end
+end

data/lib/remindmeto/normalizer.rb

@@ -0,0 +1,66 @@
+module RemindMeTo
+  class Normalizer
+    def initialize(args)
+      @args = args
+      @single_interval_keywords = %w{in after}
+      @rolling_interval_keywords = %w{every}
+    end
+
+    def process()
+      @keyword_idx = split_by_interval_keyword
+
+      options = {}
+      options[:message] = get_message
+      options[:interval] = get_interval
+      options[:repeat] = get_repeat
+
+      options
+    end
+
+    private
+
+    def split_by_interval_keyword()
+      keyword_idx = 0
+      interval_keywords = [@single_interval_keywords, @rolling_interval_keywords].flatten
+      interval_keywords.each do |word|
+        idx = @args.rindex(word)
+        keyword_idx = idx unless (idx == nil || idx < keyword_idx)
+      end
+
+      abort_with_usage_message if keyword_idx == 0
+      keyword_idx
+    end
+
+    def get_message
+      @args[0..@keyword_idx-1].join(' ')
+    end
+
+    def get_interval
+      return 1 if @args.last.eql?('second')
+      return 60 if @args.last.eql?('minute')
+      return 3600 if @args.last.eql?('hour')
+
+      multiplier = @args[-2].to_i
+      abort_with_usage_message if multiplier == 0
+
+      interval = multiplier if @args.include?('seconds')
+      interval = 60*multiplier if @args.include?('minutes')
+      interval = 3600*multiplier if @args.include?('hours')
+
+      interval
+    end
+
+    def get_repeat
+      if @single_interval_keywords.include?(@args[@keyword_idx])
+        false
+      else
+        true
+      end
+    end
+
+    def abort_with_usage_message
+      abort("Usage: remindmeto { task } { every/in } { a(n)/time } { second(s)/minute(s)/hour(s) }")
+    end
+
+  end
+end

data/lib/remindmeto/notifier.rb

@@ -0,0 +1,18 @@
+require 'remindmeto/notifier/notification_center_notifier'
+require 'remindmeto/notifier/libnotify_notifier'
+
+module RemindMeTo
+  class Notifier
+    def initialize()
+      if RemindMeTo::OS.mac?
+        @notifier = NotificationCenterNotifier.new
+      else RemindMeTo::OS.linux?
+        @notifier = LibnotifyNotifier.new
+      end
+    end
+
+    def notify(message, opts = {})
+      @notifier.notify(message, opts)
+    end
+  end
+end

data/lib/remindmeto/notifier/libnotify_notifier.rb

@@ -0,0 +1,12 @@
+require 'libnotify' if RemindMeTo::OS.linux?
+
+module RemindMeTo
+  class Notifier
+    class LibnotifyNotifier
+      def notify(message, opts = {})
+        title = 'RemindMeTo'
+        Libnotify.show :body => message, :summary => opts[:header]
+      end
+    end
+  end
+end

data/lib/remindmeto/notifier/notification_center_notifier.rb

@@ -0,0 +1,11 @@
+require 'terminal-notifier' if RemindMeTo::OS.mac?
+
+module RemindMeTo
+  class Notifier
+    class NotificationCenterNotifier
+      def notify(message, opts = {})
+        TerminalNotifier.notify('RemindMeTo', :title => message, :group => Process.pid)
+      end
+    end
+  end
+end

data/lib/remindmeto/os.rb

@@ -0,0 +1,28 @@
+require 'rbconfig'
+
+module RemindMeTo
+  module OS
+    module_function
+
+    def linux?
+      (/linux/ =~ RbConfig::CONFIG['host_os']) !=nil
+    end
+
+    def mac?
+      (/mac|darwin/ =~ RbConfig::CONFIG['host_os']) != nil
+    end
+
+    def windows?
+      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RbConfig::CONFIG['host_os']) != nil
+    end
+
+    def has_notification_center?
+      return false unless OS.mac?
+
+      full_version = `/usr/bin/sw_vers -productVersion`.to_s.chomp
+      version = /(10\.\d+)(\.\d+)?/.match(full_version).captures.first.to_f
+      return (version >= 10.8)
+    end
+
+  end
+end

data/lib/remindmeto/runner.rb

@@ -0,0 +1,18 @@
+module RemindMeTo
+  class Runner
+    def initialize(options)
+      @options = options
+      @notifier = Notifier.new
+      @running = true
+    end
+
+    # The main run loop for displaying the notifications
+    def run
+      while(@running)
+        sleep(@options[:interval])
+        @notifier.notify(@options[:message], {})
+        @running = false unless @options[:repeat]
+      end
+    end
+  end
+end

data/lib/remindmeto/version.rb

@@ -0,0 +1,3 @@
+module RemindMeTo
+  VERSION = "0.0.1"
+end

data/remindmeto.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'remindmeto/os'
+require 'remindmeto/version'
+
+post_install_message = "\e[32mThis gem requires the libnotify1 package on Ubuntu. Install with:\e[0m\n"
+post_install_message += "\t\e[31msudo apt-get install libnotify1\e[0m"
+
+Gem::Specification.new do |spec|
+  spec.name          = "remindmeto"
+  spec.version       = RemindMeTo::VERSION
+  spec.authors       = ["Hunter Clarke"]
+  spec.email         = ["hunter@hunterc.com"]
+  spec.description   = %q{A simple Ruby client for ubuntu notification reminders}
+  spec.summary       = %q{Intuitive command-line reminders}
+  spec.homepage      = "https://github.com/hclarke3/remindmeto"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w[lib]
+  spec.post_install_message = post_install_message
+
+  spec.add_runtime_dependency('terminal-notifier', '~> 1.5') if RemindMeTo::OS.mac?
+  spec.add_runtime_dependency('growl', '~> 1.0')             if RemindMeTo::OS.mac? || RemindMeTo::OS.windows?
+  spec.add_runtime_dependency('libnotify', '~> 0.8')         if RemindMeTo::OS.linux?
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

data/spec/remindmeto/normalizer_spec.rb

@@ -0,0 +1,12 @@
+require 'remindmeto'
+
+describe RemindMeTo::Normalizer do
+  describe '.split_by_interval_keyword' do
+    context 'given an interval keyword to split on' do
+      it 'returns the index of the interval keyword' do
+        arg = %w{remindmeto test in 10 seconds}
+        expect(RemindMeTo::Normalizer.split_by_interval_keyword(arg)).to eq 2
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: remindmeto
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hunter Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: A simple Ruby client for ubuntu notification reminders
+email:
+- hunter@hunterc.com
+executables:
+- remindmeto
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/remindmeto
+- lib/remindmeto.rb
+- lib/remindmeto/cli.rb
+- lib/remindmeto/normalizer.rb
+- lib/remindmeto/notifier.rb
+- lib/remindmeto/notifier/libnotify_notifier.rb
+- lib/remindmeto/notifier/notification_center_notifier.rb
+- lib/remindmeto/os.rb
+- lib/remindmeto/runner.rb
+- lib/remindmeto/version.rb
+- remindmeto.gemspec
+- spec/remindmeto/normalizer_spec.rb
+homepage: https://github.com/hclarke3/remindmeto
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\e[32mThis gem requires the libnotify1 package on Ubuntu. Install
+  with:\e[0m\n\t\e[31msudo apt-get install libnotify1\e[0m"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Intuitive command-line reminders
+test_files:
+- spec/remindmeto/normalizer_spec.rb