hoot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68ee23c9c0e51de3603808a780cbfa1a92746ff4
+  data.tar.gz: e0f322e4e02efb56501c82ba80263012e92b03ff
+SHA512:
+  metadata.gz: 3c3a2d452d66b89739c7f424d6465a829bfdf1333992f6c0346a80379830169e8b4f59820f90bce20f910893dcc4d9b2612628b1df57edd84cfdcea4b5114971
+  data.tar.gz: 271f524f576e965219956847f30fa9303e178fd750109f30b5d8faab62af38c72b50af3ddd0c6569283afeb4448f8f58bd7ba6e8deeed7e35b60f68b924b60a3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hoot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    hoot (0.1.0)
+      json
+      netrc
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (1.8.3)
+    netrc (0.10.3)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  hoot!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rudd Fawcett
+
+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,55 @@
+# Hoot
+
+This is Hoot!  Hoot is a simple command line tool to alert you when a Terminal process has finished, with a push notification right to your device!
+
+> Hoot! Your process has finished! Come back!
+
+## Installation
+
+Hoot is currently command line only, so you can't use it in your own project.
+
+To install `hoot`, simply execute:
+
+    sudo gem install hoot
+
+## How it Works
+
+Hoot uses a Node.js middleware server that I've dubbed `hedwig`.  Hoot simply posts the email and password you used to sign up in the iOS app -- and sends a notification to that device using Parse.
+
+Because of the current setup Hoot is intended _just_ for a simple computer to iPhone alert, to come back and visit your completed process.
+
+Hedwig is also open source, and can be found at [ruddfawcett/hedwig](https://github.com/ruddfawcett/hedwig).
+
+Hoot may in the future transition over to a `npm` module.
+
+## Usage
+
+Hoot is not very fancy...
+
+When you first install hoot, you will need to authenticate yourself using the email and password you used in the iOS app.
+
+Simply execute `hoot`, and you will be prompted to enter your credentials.  Note as of right now you cannot change these with the tool, you'll have to manually edit your `.netrc` file.
+
+To use, you can do something like the following,
+
+    sh my-long-process.sh && hoot
+
+After your scraping tool/parser/long task has been completed, you'll get an alert on your phone.
+
+> Hoot! Your process has finished! Come back!
+
+## Development
+
+I'd love to flesh out the project some more, but currently it fits my needs.  Things that definitely need to be added are a more effective authentication gem (I don't know exactly which one), and `commander` (or another tool that makes processing arguments easier).  Maybe even some testing?
+
+To add features, I'd recommend also using your own branch of `hedwig` ([ruddfawcett/hedwig](https://github.com/ruddfawcett/hedwig)).  You can hack on Hoot with your local copy of Hedwig, and enable development mode using the following:
+
+    HEDWING_ENDPOINT="http://localhost:5000" DEV=true hoot
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruddfawcett/hoot.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/hoot

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'hoot'
+
+Signal.trap('INT') {} # Suppress backtrace when exiting command
+
+if Hoot::User.isAuthenticated?
+	client = Hoot::Client.new
+
+	client.send
+else
+	Hoot::User.authenticate
+end

data/hoot.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hoot/version'
+
+Gem::Specification.new do |s|
+  s.name          = "hoot"
+  s.version       = Hoot::VERSION
+  s.authors       = ["Rudd Fawcett"]
+  s.email         = ["rudd.fawcett@gmail.com"]
+
+  s.summary       = "Send push notifications to your phone when a Terminal process has completed."
+  s.description   = ""
+  s.homepage      = "https://github.com/ruddfawcett/hoot"
+  s.license       = "MIT"
+
+  s.add_dependency "netrc"
+  s.add_dependency "json"
+
+  s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
+  s.executables   = ["hoot"]
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hoot/client.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'net/https'
+require 'uri'
+
+module Hoot
+	unless ENV['DEV']
+		HEDWING_ENDPOINT = 'https://hedwig.herokuapp.com'
+	else
+		HEDWING_ENDPOINT = 'http://localhost:5000'
+	end
+
+	class Client
+		attr_accessor :hedwig
+		attr_accessor :credentials
+
+	    def initialize
+	    	@hedwig = ENV['HEDWING_ENDPOINT'] || HEDWING_ENDPOINT
+	     	@credentials = Hoot::User::credentials
+	    end
+
+	    def send
+	    	# TODO: Custom messages
+
+	    	response = request(@hedwig)
+	    	response = JSON.parse(response.body)
+
+	    	if response['error']
+	    		abort('A server error occurred.')
+	    	end
+
+	    	if response['result']
+	    		abort('A Hoot was sent to your device.')
+	    	end
+	    end
+
+	    private
+
+	    def request(uri)
+			uri = URI.parse(uri)
+			http = Net::HTTP.new(uri.host, uri.port)
+
+			unless ENV['DEV']
+				http.use_ssl = true
+				http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+			end
+
+			request = Net::HTTP::Post.new('/api/v1/send')
+			request.add_field('Content-Type', 'application/json')
+			request.set_form_data({'credentials[email]' => @credentials[0], 'credentials[password]' => @credentials[1]})
+			response = http.request(request)
+
+			response
+	    end
+	end
+end

data/lib/hoot/user.rb

@@ -0,0 +1,76 @@
+require 'netrc'
+require 'io/console'
+require 'digest/sha1'
+
+module Hoot
+	module User
+		@n = Netrc.read
+			
+		def self.isAuthenticated?
+			@n = Netrc.read
+			login, password = @n['hedwig.herokuapp.com']
+
+			if login.nil? || password.nil?
+				false
+			else
+				true
+			end
+		end
+
+		def self.form
+			puts 'Please enter your Hoot credentials.'
+
+			print 'Email: '
+			login = gets.chomp
+
+			while login.length == 0
+				puts 'Please enter an email...'
+				print 'Email: '
+				login = gets.chomp
+			end
+
+			if STDIN.respond_to?(:noecho)
+			  def self.get_password(prompt='Password: ')
+			    print prompt
+			    STDIN.noecho(&:gets).chomp
+			  end
+			else
+			  def self.get_password(prompt='Password: ')
+			    `read -s -p '#{prompt}' password; echo $password`.chomp
+			  end
+			end
+
+			password = self.get_password
+
+			while password.length == 0
+				puts 'Please enter a password...'
+				password = self.get_password
+			end
+
+			password = Digest::SHA1.hexdigest(password)
+
+			[login, password]
+		end
+
+
+		def self.authenticate
+			credentials = self.form
+
+			@n['hedwig.herokuapp.com'] = credentials[0], credentials[1]
+			@n.save
+
+			puts
+			puts 'Your credentials have been saved.'
+		end
+
+		def self.credentials
+			if self.isAuthenticated?
+				login, password = @n['hedwig.herokuapp.com']
+
+				[login, password]
+			else
+				self.authenticate	
+			end
+		end
+	end
+end

data/lib/hoot/version.rb

@@ -0,0 +1,3 @@
+module Hoot
+  VERSION = "0.1.0"
+end

data/lib/hoot.rb

@@ -0,0 +1,3 @@
+require "hoot/version"
+require "hoot/client"
+require "hoot/user"

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: hoot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rudd Fawcett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netrc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- rudd.fawcett@gmail.com
+executables:
+- hoot
+extensions: []
+extra_rdoc_files: []
+files:
+- "./Gemfile"
+- "./Gemfile.lock"
+- "./LICENSE"
+- "./README.md"
+- "./Rakefile"
+- "./hoot.gemspec"
+- "./lib/hoot.rb"
+- "./lib/hoot/client.rb"
+- "./lib/hoot/user.rb"
+- "./lib/hoot/version.rb"
+- bin/hoot
+homepage: https://github.com/ruddfawcett/hoot
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Send push notifications to your phone when a Terminal process has completed.
+test_files: []