argosnap 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58c0e9370c15fdbea9a88293750f435b115c448d
+  data.tar.gz: ebf0309dbbe124b0aa99ec8e283331f4dfafaba5
+SHA512:
+  metadata.gz: 44019bb49bb27233a27157488c3e2d159b5b20bd381f3121f024c8446283e82965fe11d72c3e171a1d766e52c89b5ec34587307e7f7a7e06172112bc98d794da
+  data.tar.gz: 43ea9a9b559d741d336c1fa91ac65be6b74c1b48b37ece810cb5b293e82df1b8b96749b69597b4adf012fe0f6127dffc42f3897e57cab7a5e567ed34ebed81cc

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'
+gem 'mechanize', '2.7.3'
+gem 'terminal-notifier', '1.6.0'
+gem 'plist', '3.1.0'
+
+# Specify your gem's dependencies in argosnap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Panagiotis Atmatzidis
+
+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,58 @@
+# Argosnap
+
+This gem allows you to displays your current amount of picodollars along with [OSX notifications](http://support.apple.com/kb/ht5362)  when your [tarsnap account](http://www.tarsnap.com/) falls bellow a predefined threshold of [picodollars](http://www.tarsnap.com/picoUSD-why.html).
+
+## Installation
+
+Install the gem via rubygems:
+
+    $ gem install argosnap plist mechanize terminal-notifier
+
+## Configure
+
+Run `install` for the script to create the configuration file like: 
+
+    $ argosnap -i config
+
+Then we configure the `config.yml` file which looks like this:
+    
+    ---
+    :email: sample@email.com
+    :password: p4sw0rd3
+    :threshold: 10
+    :seconds: 7200
+
+Just put your tarsnap login credentials. You can omit the other two variables if you are not using an OSX system. To view your account use the command:
+
+    $ argosnap -p
+
+
+## Configure Launchd under MacOSX
+
+In the `config.yml` adjust the `threshold` and `seconds` options as you see fit. Threshold is the amount of *picodollars* bellow which you'd like to start seeing notifications and the `seconds` consists of the time window. Then type:
+
+    $ argosnap -i cron
+
+Now just start the installed `.plist` file and you're done.
+
+## Options
+
+To run an osx notification use the command:
+
+  $ argosnap -p osx
+  Current balance (picodollars): 4.8812
+
+To get the amount of picodollars as an integer type:
+
+  $ argosnap -p clean
+  4.8812
+
+That's all :-)
+
+## Contributing
+
+1. Fork it ( http://github.com/atmosx/argosnap/fork )
+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,12 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/argosnap'
+  t.test_files = FileList['test/lib/argosnap/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/argosnap.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'argosnap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "argosnap"
+  spec.version       = Argosnap::VERSION
+  spec.authors       = ["Panagiotis Atmatzidis"]
+  spec.email         = ["atma@convalesco.org"]
+  spec.summary       = %q{Display osx notifications when tarsnap account runs out of picodollars}
+  spec.description   = %q{A ruby script displays OSX notifications with current ballance. If the balance of picodollars falls bellow a specific threshold}
+  spec.homepage      = "https://github.com/atmosx/argosnap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/bin/argosnap

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+require_relative File.expand_path('../../lib/argosnap', __FILE__)
+require 'optparse'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "argosnap #{Argosnap::VERSION} ( https://github.com/atmosx/argosnap/ )\nUsage: argosnap [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "     version: dislay version"
+  opt.separator  "     install [config]: installs configure file 'config.yml'"
+  opt.separator  "     install [cron]: installs Launchd script under OSX"
+  opt.separator  "     print: prints the output in picodollars"
+  opt.separator  "     print [osx]: print osx notification"
+  opt.separator  "     print [clean]: prints only the picollars (float rounded in 4 decimals), to use in cli"
+  opt.separator  ""
+
+  opt.on("-v","--version","display version") do |version|
+    options[:version] = version
+  end
+
+  opt.on("-i","--install [OPTION]", "install configuration files") do |install|
+    options[:install] = install || 'config'
+  end
+
+  opt.on("-p","--print [OPTION]","fetch current amount in picodollars") do |print|
+    options[:print] = print || 'default'
+  end
+
+  opt.on("-h","--help","help") do |h|
+    options[:help] = h
+    puts opt_parser
+  end
+end
+
+# Execution flow
+begin
+  opt_parser.parse!
+  if options[:version]
+    puts Argosnap::VERSION
+  elsif options[:install]
+    if options[:install] == 'config'
+      Argosnap::Install.new.config
+    elsif options[:install] == 'cron'
+      Argosnap::OSXNotifications.new.install_launchd_script
+    end
+  elsif options[:help]
+    # do nothing - avoids double printing of 'opt_parser'
+  elsif options[:print]
+    if options[:print] == 'osx'
+      Argosnap::OSXNotifications.new.display
+    elsif options[:print] == 'default'
+      b = Argosnap::Fetch.new.balance
+      puts "Current balance (picodollars): #{b}"
+    elsif options[:print] == 'clean'
+      b = Argosnap::Fetch.new.balance
+      puts b
+    else
+      puts "Option not recognized"
+    end
+  else
+    puts opt_parser
+  end
+rescue OptionParser::InvalidOption => e
+  puts "No such option! Type 'argosnap -h' for help!"
+  exit
+end

data/files/local.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# Load RVM into a shell session *as a function*
+if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+	# First try to load from a user install
+	source "$HOME/.rvm/scripts/rvm"
+elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+	# Then try to load from a root install
+	source "/usr/local/rvm/scripts/rvm"
+else
+	printf "ERROR: An RVM installation was not found.\n"
+fi
+
+# Executable now should be in path
+argosnap -p osx

data/lib/argosnap/balance.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+require 'mechanize'
+require 'logger'
+
+module Argosnap
+  # Given a username and a password, fetch balance from http://www.tarsnap.com
+  class Fetch
+    def initialize         
+      begin
+        user = ENV['USER']
+        raise ArgumentError.new("Please make sure you run 'asnap install' in order to install configuration files, before running asnap!") unless File.exists?("#{Dir.home}/.argosnap/config.yml")
+        r = YAML::load_file("#{Dir.home}/.argosnap/config.yml")
+        logfile = "#{Dir.home}/.argosnap/argosnap.log"
+        @email, @password, @threshold, @logger, @agent = r[:email], r[:password], r[:threshold], Logger.new(logfile), Mechanize.new
+      rescue ArgumentError => e
+        puts e.message
+        # puts e.backtrace
+        exit
+      end
+    end
+
+    # Fetch balance from tarsnap using mechanize
+    def balance
+      begin
+        page = @agent.get('https://www.tarsnap.com/account.html')
+        form = page.form_with(:action => 'https://www.tarsnap.com/manage.cgi')
+        form.address = @email
+        form.password = @password
+        panel = @agent.submit(form)
+        picodollars = panel.parser.to_s.scan(/\$\d+\.\d+/)[0].scan(/\d+\.\d+/)[0].to_f.round(4) # I'm the feeling that this can be done in a prettier way
+        @logger.info "Execution ended successfully! Picodollars: #{picodollars}" 
+        picodollars
+      rescue Exception => e
+        @logger.error "A problem with tarsnap notification occured:"
+        @logger.error "#{e}"
+      end
+    end
+  end
+end

data/lib/argosnap/install.rb

@@ -0,0 +1,22 @@
+require 'logger'
+require 'yaml'
+require 'plist'
+
+module Argosnap
+  class Install
+    # Install 'config.yml'
+    def config
+      url = 'http://atmosx.github.com/argosnap'
+      raise ArgumentError.new("This gem is made for UNIX! Please check the website for details #{url} !") unless %w{ darwin linux freebsd openbsd netbsd }.include? Gem::Platform.local.os 
+      begin
+        Dir.mkdir(File.join(Dir.home, ".argosnap"), 0700) unless Dir.exists?("/Users/#{ENV['USER']}/.argosnap")# permissions are a-rwx,u+rwx
+        config = {email: 'tarsnap_email', password: 'tarsnap_password', threshold: 10, seconds: 7200}
+        File.open("#{Dir.home}/.argosnap/config.yml", "w") {|f| f.write(config.to_yaml)}
+        puts "1. Edit the configuration file: #{Dir.home}/.argosnap/config.yml"
+        puts "2. Launch argosnap by typing in the terminal: argosnap -p"
+      rescue Exception => e
+        puts e.message
+      end
+    end
+  end
+end

data/lib/argosnap/osxnotify.rb

@@ -0,0 +1,53 @@
+require 'terminal-notifier'
+require_relative File.expand_path('../balance', __FILE__)
+require 'yaml'
+
+module Argosnap
+  class OSXNotifications
+    def initialize
+      begin
+        user = ENV['USER']
+        raise ArgumentError.new("This command is made for Darwin! Please check the website for details #{url} !") unless Gem::Platform.local.os == 'darwin'
+        r = YAML::load_file("#{Dir.home}/.argosnap/config.yml")
+        logfile = "#{Dir.home}/.argosnap/argosnap.log"
+        @threshold, @logger, @picodollars, @time_interval = r[:threshold], Logger.new(logfile), Argosnap::Fetch.new.balance, r[:seconds]
+      rescue ArgumentError => e
+        puts e.message
+        # puts e.backtrace
+        exit
+      end
+    end
+
+    # Creates launchd script with user's variables
+    def install_launchd_script 
+      raise ArgumentError.new("Please make sure you run 'asnap install' in order to install configuration files, before running asnap!") unless File.exists?("#{Dir.home}/.argosnap/config.yml")
+      user = ENV['USER']
+      c = "#{Dir.home}/.argosnap/config.yml"
+      begin
+        launch_agents = "/Users/#{user}/Library/LaunchAgents/"
+        # start_script loads the RVM environment.
+        start_script = File.expand_path('../../../files/local.sh', __FILE__)
+        if Dir.exists?(launch_agents)
+          filename = "org.#{user}.argosnap.plist"
+          if File.exist?("#{launch_agents}#{filename}")
+            puts "Please delete file: #{launch_agents}#{filename} before proceeding!"
+          else
+            hash = {"Label"=>"#{filename.scan(/(.+)(?:\.[^.]+)/).flatten[0]}", "ProgramArguments"=>["#{start_script}"], "StartInterval"=> @time_interval, "RunAtLoad"=>true} 
+            File.open("#{launch_agents}#{filename}", 'w') {|f| f.write(hash.to_plist)}
+            puts "Launchd script is installed. Type 'launchctl load -w #{launch_agents}#{filename}' to load the plist."
+          end
+        else
+          puts "No '#{launch_agents}' directory found! Aborting installation."
+        end
+      rescue Exception => e
+        puts e.message
+        # puts e.backtrace
+      end
+    end
+
+    # Display notifications
+    def display
+      TerminalNotifier.notify("Current balance: #{@picodollars}", :title => 'TarSnap', :subtitle => 'balance running out') if @picodollars < @threshold.to_i
+    end
+  end
+end

data/lib/argosnap/version.rb

@@ -0,0 +1,3 @@
+module Argosnap
+  VERSION = "0.0.2"
+end

data/lib/argosnap.rb

@@ -0,0 +1,10 @@
+# argosnap module
+
+require_relative File.expand_path("../argosnap/version", __FILE__)
+require_relative File.expand_path("../argosnap/install", __FILE__)
+require_relative File.expand_path("../argosnap/balance", __FILE__)
+require_relative File.expand_path("../argosnap/osxnotify", __FILE__)
+# require 'argosnap/install'
+# require 'argosnap/balance'
+# require 'argosnap/version'
+# require 'argosnap/osxnotify'

data/test/lib/argosnap/options_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe Argosnap do
+  it "return 'help' message" do
+     
+  end
+end

data/test/lib/argosnap/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe Argosnap do
+  it "must be defined" do
+    Argosnap::VERSION.wont_be_nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/argosnap.rb', __FILE__)

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: argosnap
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Panagiotis Atmatzidis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A ruby script displays OSX notifications with current ballance. If the
+  balance of picodollars falls bellow a specific threshold
+email:
+- atma@convalesco.org
+executables:
+- argosnap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- argosnap.gemspec
+- bin/argosnap
+- files/local.sh
+- lib/argosnap.rb
+- lib/argosnap/balance.rb
+- lib/argosnap/install.rb
+- lib/argosnap/osxnotify.rb
+- lib/argosnap/version.rb
+- test/lib/argosnap/options_test.rb
+- test/lib/argosnap/version_test.rb
+- test/test_helper.rb
+homepage: https://github.com/atmosx/argosnap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Display osx notifications when tarsnap account runs out of picodollars
+test_files:
+- test/lib/argosnap/options_test.rb
+- test/lib/argosnap/version_test.rb
+- test/test_helper.rb