argosnap 0.0.4.2 → 0.0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cce8626211d00aa0d0330a8c6fd8e5d0db4bc0fd
-  data.tar.gz: cff12a72214c7fef2af796067661429b7c5e8d2b
+  metadata.gz: 15e05625d1b29a1f605ceb9231c8834e19fb76a7
+  data.tar.gz: c2470b1958c344712af59df378155a392ab2bafb
 SHA512:
-  metadata.gz: 7d3f867e5616740ee7cb4ac9e2b8c3cf1f972f38c73a9ccfe09eab808a5f3d76ca71e9a42c666a602a79ab93561a24344546b9961b847c541353891626c1510d
-  data.tar.gz: ea90a440f7d48d92e051e05818884327323a97d5ffa91772811efd69e14701b9e3579137ec8cab82cf15f921b71b616732e68af3e51c7f1d500c6d1e6ab1974c
+  metadata.gz: 60c8ba297c156bc774093c11ab427176721cd349fca743aee64182d59208369e04ceb935432763e6f28217a79cbc3b7d8471c1ed2e596f6135fa7df294576e61
+  data.tar.gz: 42b86588dd17f1904cda331c214a6a6f46d181a51aa0ee83689d225402dfcfe4c486f4f7d049621448e1fb7147c061148e41f861409f34656eb08dc2ce44e0f7

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 .DS_Store
 notes.txt
+*syncthing*

data/bin/argosnap

@@ -55,11 +55,11 @@ begin
     if options[:notification] == 'mail'
       Argosnap::Notifications.new.send_mail
     elsif options[:notification] == 'pushover'
-      Argosnap::Notifications.new.send_pushover
+      Argosnap::Notifications.new.send_pushover_notification
     elsif options[:notification] == 'osx'
       Argosnap::Notifications.new.send_osx_notification
     elsif options[:notification] == 'osx_check'
-      Argosnap::Notifications.new.osx_check
+      Argosnap::Notifications.new.osx_check_and_notify
     elsif options[:notification] == 'notify'
       Argosnap::Notifications.new.notify
     else

data/lib/argosnap/balance.rb

@@ -1,7 +1,9 @@
 require 'mechanize'
 
+# main module
 module Argosnap
-  # Given a username and a password, fetch balance from https://www.tarsnap.com
+
+  # Given username and a password, fetch balance from www.tarsnap.com
   class Fetch
 
     # Elementary configuration file check
@@ -16,23 +18,28 @@ module Argosnap
       end
     end
 
+    # check for login errors
+    def check_login_errors(data)
+      wrong_email_message = 'No user exists with the provided email address; please try again.'
+      wrong_password_message = 'Password is incorrect; please try again.'
+      if data.body.include?(wrong_email_message)
+        config.log_and_abort('Password is incorrect; please try again.')
+      elsif data.body.include?(wrong_password_message)
+        config.log_and_abort('Bad password. Please check your configuration file tarsnap password!')
+      end
+    end
+
     # Fetch balance from tarsnap using
     def balance
       check_configuration
       agent         = Mechanize.new
       page          = agent.get('https://www.tarsnap.com/account.html')
-      form          = page.form_with(:action => 'https://www.tarsnap.com/manage.cgi')
+      form          = page.form_with(action: 'https://www.tarsnap.com/manage.cgi')
       form.address  = config.data[:email]
       form.password = config.data[:password]
       panel         = agent.submit(form)
-      wrong_email_message = 'No user exists with the provided email address; please try again.'
-      wrong_password_message = 'Password is incorrect; please try again.'
-      if panel.body.include?(wrong_email_message)
-        config.log_and_abort('Password is incorrect; please try again.')
-      elsif panel.body.include?(wrong_password_message)
-        config.log_and_abort('Bad password. Please check your configuration file tarsnap password!')
-      end
-      picodollars   = panel.parser.to_s.scan(/\$\d+\.\d+/)[0].scan(/\d+\.\d+/)[0].to_f.round(4) 
+      check_login_errors(panel)
+      picodollars = panel.parser.to_s.scan(/\$\d+\.\d+/)[0].scan(/\d+\.\d+/)[0].to_f.round(4) 
       config.logger.info("Current amount of picoUSD: #{picodollars}")
       picodollars
     end

data/lib/argosnap/config.rb

@@ -1,9 +1,13 @@
 require 'yaml'
 require 'logger'
 
+# main module
 module Argosnap
+
+  # Handle configuration files and create 'logger' object
   class Configuration
-    # configuration files
+
+    # Configuration files hash
     def files
       {
         config: "#{Dir.home}/.argosnap/config.yml", 
@@ -12,17 +16,16 @@ module Argosnap
       }
     end
 
-    # logger object
+    # Create the logger object
     def logger
       Logger.new(files[:logfile], 10, 1024000)
     end
 
-    # Config data in hash 
+    # Load configuration data as a hash 
     def data
       YAML::load_file(files[:config])
     end
 
-    # Check if gem is available
     def gem_available?(name)
          Gem::Specification.find_by_name(name)
     rescue Gem::LoadError
@@ -31,7 +34,6 @@ module Argosnap
          Gem.available?(name)
     end
 
-    # Log and Abort!
     def log_and_abort(msg)
       logger.error(msg)
       Kernel.abort(msg)

data/lib/argosnap/helpers.rb

@@ -1,3 +1,4 @@
+# main module
 module Argosnap
 
   # Helper Class

data/lib/argosnap/install.rb

@@ -1,7 +1,10 @@
+# main module
 require 'fileutils'
 
 module Argosnap
 
+  # Install configuration and log files on the system.
+  # All program files to go '$HOME/.argosnap'
   class Install
 
     # Install configuration files in the system

data/lib/argosnap/notifications.rb

@@ -1,4 +1,7 @@
+# main module
 module Argosnap
+
+  # This class handles the available notifications
   class Notifications
 
     # When tarsnap balance is bellow threshold notify me
@@ -11,14 +14,12 @@ module Argosnap
       end
     end
 
-    # Use with plist file
-    def osx_check
+    def osx_check_and_notify
       if config.data[:threshold] >= Fetch.new.balance
         send_osx_notification
       end
     end
 
-    # send notification via email
     def send_mail
       if config.data[:notifications_email]
         if config.gem_available?('mail')
@@ -32,8 +33,7 @@ module Argosnap
       end
     end
 
-    # send notification via pushover.net
-    def send_pushover
+    def send_pushover_notification
       if config.data[:notifications_pushover]
         require "net/https"
         require_relative File.expand_path("../notifications/pushover", __FILE__)
@@ -45,7 +45,7 @@ module Argosnap
       end
     end
 
-    # send notification to osx notifications (desktop)
+    # Manually send notification to osx notifications (desktop)
     def send_osx_notification
       if config.data[:notifications_osx]
         if Gem::Platform.local.os == 'darwin'

data/lib/argosnap/notifications/mailer.rb

@@ -1,4 +1,6 @@
 module Argosnap
+
+  # Send email notification to the user
   class Mailer
 
     # load configuration files

data/lib/argosnap/version.rb

@@ -1,3 +1,4 @@
+# main module
 module Argosnap
-  VERSION = "0.0.4.2"
+  VERSION = "0.0.4.3"
 end

data/test/lib/argosnap/balance_test.rb

@@ -0,0 +1,17 @@
+require_relative '../../test_helper'
+
+describe Argosnap do
+  before do
+    @balance = Argosnap::Fetch.new.balance
+    @threshold = Argosnap::Configuration.new.data[:threshold]
+  end
+
+  it 'balance is a float' do
+    @balance.must_be_kind_of Float
+  end
+
+  it 'threshold is a float' do
+    @threshold.must_be_kind_of (Fixnum || Float)
+  end
+
+end

data/test/lib/argosnap/options_test.rb

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

data/test/test_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: argosnap
 version: !ruby/object:Gem::Version
-  version: 0.0.4.2
+  version: 0.0.4.3
 platform: ruby
 authors:
 - Panagiotis Atmatzidis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ files:
 - lib/argosnap/notifications/osxnotifications.rb
 - lib/argosnap/notifications/pushover.rb
 - lib/argosnap/version.rb
+- test/lib/argosnap/balance_test.rb
 - test/lib/argosnap/options_test.rb
 - test/lib/argosnap/version_test.rb
 - test/test_helper.rb
@@ -96,6 +97,7 @@ signing_key:
 specification_version: 4
 summary: Command line utility that displays your current tarsnap picoUSD amount.
 test_files:
+- test/lib/argosnap/balance_test.rb
 - test/lib/argosnap/options_test.rb
 - test/lib/argosnap/version_test.rb
 - test/test_helper.rb