hoot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68ee23c9c0e51de3603808a780cbfa1a92746ff4
-  data.tar.gz: e0f322e4e02efb56501c82ba80263012e92b03ff
+  metadata.gz: a6fb0cf88115d0e25cb6c94222dbc960a610fb86
+  data.tar.gz: bc8b210c0f496b8405cfa7274ce211091d9157b7
 SHA512:
-  metadata.gz: 3c3a2d452d66b89739c7f424d6465a829bfdf1333992f6c0346a80379830169e8b4f59820f90bce20f910893dcc4d9b2612628b1df57edd84cfdcea4b5114971
-  data.tar.gz: 271f524f576e965219956847f30fa9303e178fd750109f30b5d8faab62af38c72b50af3ddd0c6569283afeb4448f8f58bd7ba6e8deeed7e35b60f68b924b60a3
+  metadata.gz: 9ee2b89c29e283fed65ce26616baf71ecc65d5c4f8686db26669be4b940f477f5ddc174dd6eb5395860bd22d3ee1deac1fe923ebd1346d544da29f9d643e59c5
+  data.tar.gz: 8c70ea6ad0a9ff04cc698948037ff754391ca942e44d555be274c9e4b55f650ef714f890ab34bc94636e74f4bf45990fdc8ff570e45fa7d67967f72ce817fcba

data/Gemfile.lock

@@ -1,13 +1,17 @@
 PATH
   remote: .
   specs:
-    hoot (0.1.0)
+    hoot (0.2.0)
+      commander
       json
       netrc
 
 GEM
   remote: https://rubygems.org/
   specs:
+    commander (4.3.5)
+      highline (~> 1.7.2)
+    highline (1.7.3)
     json (1.8.3)
     netrc (0.10.3)
     rake (10.4.2)

data/README.md

@@ -28,23 +28,25 @@ 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.
+Execute `hoot login`, and you will be prompted to enter your credentials.  To logout, `hoot logout` (you'll still have to remove all traces of Hoot form `~/.netrc`, though your hashed password and email are wiped).
 
 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.
+After your scraping tool/parser/long task has been completed, you'll get an alert on your phone, such as the default message.
 
 > Hoot! Your process has finished! Come back!
 
-## Development
+If you want to use a custom message, you can use a familiar `git` syntax.
+
+    hoot -m "Your custom message."
 
-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?
+## Development
 
 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
+    DEV=true hoot
 
 ## Contributing
 

data/bin/hoot

@@ -2,12 +2,62 @@
 
 require 'hoot'
 
-Signal.trap('INT') {} # Suppress backtrace when exiting command
+require 'commander/import'
 
-if Hoot::User.isAuthenticated?
-	client = Hoot::Client.new
+HighLine.track_eof = false # Fix for built-in Ruby
+# Signal.trap('INT') {} # Suppress backtrace when exiting command
 
-	client.send
-else
-	Hoot::User.authenticate
+program :version, Hoot::VERSION
+program :description, '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!'
+
+program :help, 'Author', 'Rudd Fawcett <rudd.fawcett@gmail.com>'
+program :help, 'Website', 'https://github.com/ruddfawcett'
+program :help_formatter, :compact
+
+never_trace!
+default_command :push
+
+command :login do |c|
+  c.syntax = 'hoot login'
+  c.description = 'Login into your Hoot account.'
+
+  c.example 'login', 'hoot login'
+
+  c.action do |args, options|
+		Hoot::User.login
+  end
+end
+
+command :logout do |c|
+  c.syntax = 'hoot logout'
+  c.description = 'Logout of your Hoot account.'
+
+  c.example 'logout', 'hoot logout'
+
+  c.action do |args, options|
+		Hoot::User.logout
+  end
+end
+
+command :push do |c|
+  c.syntax = 'hoot'
+  c.description = 'Send a push notification; or just use `hoot`!'
+
+  c.option '-m', '--message String', String, 'Send a notification with a custom message.'
+  c.example 'push', 'hoot -m "Custom message."'
+
+	c.action do |args, options|
+		unless Hoot::Keychain.authenticated?
+			abort('You must first login with `hoot login`.')
+		end
+
+		client.push(options.message)
+
+	end
+end
+
+private
+
+def client
+	Hoot::Client.new
 end

data/hoot.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.license       = "MIT"
 
   s.add_dependency "netrc"
+  s.add_dependency "commander"
   s.add_dependency "json"
 
   s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }

data/lib/hoot/client.rb

@@ -3,6 +3,7 @@ require 'net/https'
 require 'uri'
 
 module Hoot
+
 	unless ENV['DEV']
 		HEDWING_ENDPOINT = 'https://hedwig.herokuapp.com'
 	else
@@ -13,30 +14,58 @@ module Hoot
 		attr_accessor :hedwig
 		attr_accessor :credentials
 
-	    def initialize
-	    	@hedwig = ENV['HEDWING_ENDPOINT'] || HEDWING_ENDPOINT
-	     	@credentials = Hoot::User::credentials
-	    end
+		def initialize
+			@hedwig = ENV['HEDWING_ENDPOINT'] || HEDWING_ENDPOINT
+		end
+
+		def push(message = nil)
+			@credentials = Hoot::Keychain::credentials
 
-	    def send
-	    	# TODO: Custom messages
+			if message.nil?
+				message = 'Hoot! Your command has completed! Come back!'
+			end
 
-	    	response = request(@hedwig)
-	    	response = JSON.parse(response.body)
+			data = {
+				:credentials => {
+					:email => @credentials[0],
+					:password => @credentials[1]
+				},
+				:message => message
+			}
 
-	    	if response['error']
-	    		abort('A server error occurred.')
-	    	end
+			response = request('send', data)
+
+			if response['result']
+				abort('A Hoot was sent to your device.')
+			end
 
-	    	if response['result']
-	    		abort('A Hoot was sent to your device.')
-	    	end
-	    end
+			abort('A server error occurred.')
+		end
+
+		def authenticate(credentials)
+			data = {
+				:credentials => {
+					:email => credentials[0],
+					:password => credentials[1]
+				}
+			}
+
+			response = request('authenticate', data)
+
+			if response['result']
+				Hoot::Keychain.save(credentials)
+				abort('Authentication successful.')
+			end
 
-	    private
+			puts 'Authentication failed.'
 
-	    def request(uri)
-			uri = URI.parse(uri)
+			Hoot::User::login
+		end
+
+		private
+
+		def request(path, data)
+			uri = URI.parse(@hedwig)
 			http = Net::HTTP.new(uri.host, uri.port)
 
 			unless ENV['DEV']
@@ -44,12 +73,36 @@ module Hoot
 				http.verify_mode = OpenSSL::SSL::VERIFY_PEER
 			end
 
-			request = Net::HTTP::Post.new('/api/v1/send')
+			data = encode(data)
+
+			request = Net::HTTP::Post.new("/api/v1/#{path}")
 			request.add_field('Content-Type', 'application/json')
-			request.set_form_data({'credentials[email]' => @credentials[0], 'credentials[password]' => @credentials[1]})
+			request.set_form_data(data)
 			response = http.request(request)
 
-			response
-	    end
+			JSON.parse(response.body)
+		end
+
+		# http://dev.mensfeld.pl/2012/01/converting-nested-hash-into-http-url-params-hash-version-in-ruby/
+
+		def encode(value, key = nil, out_hash = {})
+			case value
+				when Hash  then
+					value.each { |k,v| encode(v, append_key(key,k), out_hash) }
+					out_hash
+				when Array then
+					value.each { |v| encode(v, "#{key}[]", out_hash) }
+					out_hash
+				when nil   then ''
+				else
+					out_hash[key] = value
+					out_hash
+			end
+		end
+
+		def append_key(root_key, key)
+			root_key.nil? ? :"#{key}" : :"#{root_key}[#{key.to_s}]"
+		end
+
 	end
-end
+end

data/lib/hoot/keychain.rb

@@ -0,0 +1,38 @@
+require 'netrc'
+require 'digest/sha1'
+
+module Hoot
+  module Keychain
+    @n = Netrc.read
+
+    public
+
+    def self.authenticated?
+      login, password = @n['hedwig.herokuapp.com']
+
+      if (login.nil? || login == 0) || (password.nil? || password == 0)
+        return false
+      end
+      return true
+    end
+
+    def self.credentials
+      if authenticated?
+        return @n['hedwig.herokuapp.com']
+      end
+      nil
+    end
+
+    def self.save(credentials)
+      @n['hedwig.herokuapp.com'] = credentials[0], credentials[1]
+      @n.save
+    end
+
+    def self.destroy
+      @n['hedwig.herokuapp.com'] = 0, 0
+      @n.save
+      abort('You were logged out.')
+    end
+
+  end
+end

data/lib/hoot/user.rb

@@ -1,76 +1,22 @@
-require 'netrc'
-require 'io/console'
-require 'digest/sha1'
+require 'commander/import'
 
 module Hoot
 	module User
-		@n = Netrc.read
-			
-		def self.isAuthenticated?
-			@n = Netrc.read
-			login, password = @n['hedwig.herokuapp.com']
+		@client = Hoot::Client.new
 
-			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
+		def self.login
+			puts 'Enter your Hoot credentials.'
 
-			while password.length == 0
-				puts 'Please enter a password...'
-				password = self.get_password
-			end
+			email = ask 'Email: '
+			password = Digest::SHA1.hexdigest(password 'Password: ', '*')
+			credentials = [email, password]
 
-			password = Digest::SHA1.hexdigest(password)
-
-			[login, password]
+			@client.authenticate(credentials)
 		end
 
-
-		def self.authenticate
-			credentials = self.form
-
-			@n['hedwig.herokuapp.com'] = credentials[0], credentials[1]
-			@n.save
-
-			puts
-			puts 'Your credentials have been saved.'
+		def self.logout
+			Hoot::Keychain.destroy
 		end
 
-		def self.credentials
-			if self.isAuthenticated?
-				login, password = @n['hedwig.herokuapp.com']
-
-				[login, password]
-			else
-				self.authenticate	
-			end
-		end
 	end
-end
+end

data/lib/hoot/version.rb

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

data/lib/hoot.rb

@@ -1,3 +1,4 @@
-require "hoot/version"
-require "hoot/client"
-require "hoot/user"
+require 'hoot/keychain'
+require 'hoot/client'
+require 'hoot/user'
+require 'hoot/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Rudd Fawcett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netrc
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  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
@@ -82,6 +96,7 @@ files:
 - "./hoot.gemspec"
 - "./lib/hoot.rb"
 - "./lib/hoot/client.rb"
+- "./lib/hoot/keychain.rb"
 - "./lib/hoot/user.rb"
 - "./lib/hoot/version.rb"
 - bin/hoot