fingerer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b2b3a0868aa7f6d1ced9f93f2d381d9bd9ba90c
+  data.tar.gz: b407e16d2083f0dbc534ad6e27c4a380d773588a
+SHA512:
+  metadata.gz: ff3c0c850611150cebcde23a8ada4fa14b9428c5607fb80d72279773938b0c806b466d314a7935accd3038c174761b8dd18b3cae78285d74ae3194f91d35be8a
+  data.tar.gz: e96786fc74de2191b224f600338a8b0be7bf288067b87468470f47a63dc6a5894b083cfa5bb8b9c8b931a7094b4a52b6d1fa8e23d2961e4d2b989da5b16be4cd

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fingerer.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) Zachary Flower
+
+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,85 @@
+# Fingerer
+
+[![Code Climate](https://codeclimate.com/github/zachflower/fingerer/badges/gpa.svg)](https://codeclimate.com/github/zachflower/fingerer) [![Build Status](https://travis-ci.org/zachflower/fingerer.svg?branch=master)](https://travis-ci.org/zachflower/fingerer) [![Beerpay](https://beerpay.io/zachflower/fingerer/badge.svg?style=flat)](https://beerpay.io/zachflower/fingerer)
+
+Fingerer is a [finger](https://en.wikipedia.org/wiki/Finger_protocol) server that returns the GitHub profile associated with the provided username. Quickly lookup GitHub user and organization information using a standard `finger` command.
+
+**Syntax**
+
+```
+finger zachflower@fingerer.zacharyflower.com
+```
+
+**Response**
+
+```
++-[ User ]-------------------------------------------------------------------+
+|                                                                            |
+| Username: zachflower                 Full Name: Zachary Flower             |
+| Website: http://zacharyflower.com    Email: zach@zacharyflower.com         |
+| Location: Boulder, CO                                                      |
+|                                                                            |
++-[ Stats ]------------------------------------------------------------------+
+|                                                                            |
+| Followers: 26            Following: 11            Repositories: 35         |
+|                                                                            |
++-[ Biography ]--------------------------------------------------------------+
+|                                                                            |
+| Professional nerd, avid indoorsman, technical writer, contributor          |
+| @fixateio, lead developer @emersonstone                                    |
+|                                                                            |
++----------------------------------------------------------------------------+
+
+Member since Sat Jul 16 19:20:34 2011
+```
+
+## Background
+
+Via Wikipedia:
+
+> The Name/Finger protocol, written by David Zimmerman, is based on Request for Comments document [RFC 742](https://tools.ietf.org/html/rfc742) (December 1977) as an interface to the **name** and **finger** programs that provide status reports on a particular computer system or a particular person at network sites. The finger program was written in 1971 by [Les Earnest](https://en.wikipedia.org/wiki/Les_Earnest) who created the program to solve the need of users who wanted information on other users of the network. Information on who is logged-in was useful to check the availability of a person to meet. This was probably the earliest form of [presence information](https://en.wikipedia.org/wiki/Presence_information) for remote network users.
+>
+> Prior to the finger program, the only way to get this information was with a [**who**](https://en.wikipedia.org/wiki/Who_(Unix)) program that showed IDs and terminal line numbers (the server's internal number of the communication line, over which the user's terminal is connected) for logged-in users. Earnest named his program after the idea that people would run their fingers down the who list to find what they were looking for.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'fingerer'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it yourself as:
+
+```
+gem install fingerer
+```
+
+## Usage
+
+```
+Usage: fingerer [options]
+    -d, --daemonize                  Run as a background process
+    -p, --port PORT                  Port to run on (default: 79)
+    -l, --listen IP                  IP to listen on (default: 0.0.0.0)
+```
+
+**Note: Fingerer must be run as root, as fingerd is expected to be listening on port 79.**
+
+## 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
+
+## License
+
+Fingerer is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/bin/fingerer

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'daemons'
+require 'fingerer'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opt|
+  opt.on('-d', '--daemonize', 'Run as a background process') { options[:daemonize] = TRUE }
+  opt.on('-p', '--port PORT', 'Port to run on (default: 79)') { |o| options[:port] = o }
+  opt.on('-l', '--listen IP', 'IP to listen on (default: 0.0.0.0)') { |o| options[:listen] = o }
+end.parse!
+
+Daemons.daemonize(:app_name => 'fingerer') if options[:daemonize]
+
+Fingerer::Server.start(options)

data/fingerer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fingerer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fingerer"
+  spec.version       = Fingerer::VERSION
+  spec.authors       = ["Zachary Flower"]
+  spec.email         = ["zach@zacharyflower.com"]
+  spec.description   = %q{Fingerer is a finger server that returns the GitHub profile associated with the provided username. Quickly lookup GitHub user and organization information using a standard finger command.}
+  spec.summary       = %q{Lookup GitHub profile information using a standard finger command.}
+  spec.homepage      = "https://github.com/zachflower/fingerer"
+  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 = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "octokit", "~> 4.0"
+  spec.add_development_dependency "daemons", "~> 1.2"
+  spec.add_development_dependency "rake"
+end

data/lib/fingerer.rb

@@ -0,0 +1,117 @@
+require 'octokit'
+require 'socket'
+
+require "fingerer/version"
+require "fingerer/debug"
+require "fingerer/table"
+require "fingerer/time"
+
+module Fingerer
+  class Server
+
+    def self.start(options = {})
+      options[:listen] ||= '0.0.0.0'
+      options[:port] ||= 79
+
+      Debug.info("Booting Fingerer")
+
+      server = ::TCPServer.new(options[:listen], options[:port])
+
+      Debug.info("Listening on tcp://#{options[:listen]}:#{options[:port]}");
+      Debug.info("Ctrl-C to shutdown server\n");
+
+      loop do
+        Thread.start(server.accept) do |client|
+          # start timer
+          start_time = Time.now
+          remote_ip = client.peeraddr[-1]
+          username = client.gets.strip
+
+          Debug.info("Started request for \"#{username}\" from #{remote_ip}")
+
+          begin
+            user = ::Octokit.user(username)
+
+            client.puts(response(user))
+          rescue Octokit::NotFound
+            client.puts("No such user \"#{username}\"")
+          rescue => e
+            client.puts("Something went wrong")
+            Debug.error(e.message)
+          end
+
+          client.close
+
+          # end timer
+          end_time = Time.now
+
+          Debug.info("Completed request for \"#{username}\" from #{remote_ip} in #{(end_time.to_ms - start_time.to_ms)}ms")
+        end
+      end
+    end
+
+    private_class_method def self.response(user)
+      response = []
+
+      response << ""
+      response << info(user)
+      response << stats(user)
+      response << biography(user)
+      response << ""
+      response << "Member since #{user.created_at.strftime("%c")}"
+
+      response.join("\n")
+    end
+
+    private_class_method def self.info(user)
+      response = []
+
+      if user.type == 'User'
+        response << Table.header("User")
+      else
+        response << Table.header("Organization")
+      end
+
+      response << Table.row("")
+      response << Table.row("Username: #{user.login}", "Full Name: #{user.name}")
+      response << Table.row("Website: #{user.blog}", "Email: #{user.email}") if user.blog || user.email
+      response << Table.row("Location: #{user.location}") if user.location
+      response << Table.row("")
+
+      response.join("\n")
+      response
+    end
+
+    private_class_method def self.stats(user)
+      response = []
+
+      if user.type == 'User'
+        response << Table.header("Stats")
+        response << Table.row("")
+        response << Table.row("Followers: #{user.followers}", "Following: #{user.following}", "Repositories: #{user.public_repos}")
+        response << Table.row("")
+      end
+
+      response.join("\n")
+    end
+
+    private_class_method def self.biography(user)
+      response = []
+
+      if user.bio
+        response << Table.header("Biography")
+        response << Table.row("")
+
+        user.bio.scan(/\S.{0,72}\S(?=\s|$)|\S+/).each do |line|
+          response << Table.row(line)
+        end
+
+        response << Table.row("")
+      end
+
+      response << Table.line
+
+      response.join("\n")
+    end
+  end
+end

data/lib/fingerer/debug.rb

@@ -0,0 +1,12 @@
+module Fingerer
+  class Debug
+
+    def self.info(message)
+      puts("[#{Time.now.getutc}] INFO #{message}")
+    end
+
+    def self.error(message)
+      puts("[#{Time.now.getutc}] ERROR #{message}")
+    end
+  end
+end

data/lib/fingerer/table.rb

@@ -0,0 +1,32 @@
+module Fingerer
+  class Table
+
+    @@_width = 74
+
+    def self.row(*cols)
+      count = cols.count;
+
+      return "|#{" " * (@@_width + 2)}|" if count == 0
+
+      width = ((@@_width - (count - 1)) / count).to_i
+      remainder = (@@_width - ((width * count) + (count - 1))).to_i
+      widths = Array.new(count, width)
+
+      # add remainder to last element, if needed
+      widths[-1] += remainder if remainder
+
+      widths.map!{|item| "%-#{item}.#{item}s"}
+
+      sprintf("| #{widths.join(" ")} |", *cols)
+    end
+
+    def self.header(title = "")
+      title = title[0..(@@_width - 5)]
+      "+-[ #{title} ]#{"-" * (@@_width - (title.length + 3))}+"
+    end
+
+    def self.line
+      "+#{"-" * (@@_width + 2)}+"
+    end
+  end
+end

data/lib/fingerer/time.rb

@@ -0,0 +1,8 @@
+module Fingerer
+  class Time < ::Time
+
+    def to_ms
+      (self.to_f * 1000.0).to_i
+    end
+  end
+end

data/lib/fingerer/version.rb

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

data/spec/fingerer/debug_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Fingerer::Debug do
+
+  describe ".info" do
+    context "given an empty string" do
+      it "returns an empty INFO debug statement" do
+        expect(STDOUT).to receive(:puts).with(/INFO $/)
+        Fingerer::Debug.info("")
+      end
+    end
+
+    context "given a non-empty string" do
+      it "returns an empty INFO debug statement" do
+        expect(STDOUT).to receive(:puts).with(/INFO hullabaloo$/)
+        Fingerer::Debug.info("hullabaloo")
+      end
+    end
+  end
+
+  describe ".error" do
+    context "given an empty string" do
+      it "returns an empty ERROR debug statement" do
+        expect(STDOUT).to receive(:puts).with(/ERROR $/)
+        Fingerer::Debug.error("")
+      end
+    end
+
+    context "given an empty string" do
+      it "returns a non-empty ERROR debug statement" do
+        expect(STDOUT).to receive(:puts).with(/ERROR hullabaloo$/)
+        Fingerer::Debug.error("hullabaloo")
+      end
+    end
+  end
+end

data/spec/fingerer/table_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Fingerer::Table do
+
+  describe ".row" do
+    context "given no parameters" do
+      it "returns an empty row statement" do
+        response = Fingerer::Table.row
+
+        expect(response).to eq("|#{" " * 76}|")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given an empty string" do
+      it "returns an empty row statement" do
+        response = Fingerer::Table.row("")
+        expect(response).to eq("|#{" " * 76}|")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given one column" do
+      it "returns a one-column row statement" do
+        response = Fingerer::Table.row("one")
+        expect(response).to eq("| one #{" " * 71}|")
+        expect(response.length).to be(78)
+      end
+
+      it "truncates a long string" do
+        response = Fingerer::Table.row("this is a really really really really really really really really really long string")
+        expect(response).to eq("| this is a really really really really really really really really really l |")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given two columns" do
+      it "returns a two-column row statement" do
+        response = Fingerer::Table.row("one", "two")
+        expect(response).to eq("| one                                  two                                   |")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given three columns" do
+      it "returns a three-column row statement" do
+        response = Fingerer::Table.row("one", "two", "three")
+        expect(response).to eq("| one                      two                      three                    |")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given four columns" do
+      it "returns a four-column row statement" do
+        response = Fingerer::Table.row("one", "two", "three", "four")
+        expect(response).to eq("| one               two               three             four                 |")
+        expect(response.length).to be(78)
+      end
+    end
+
+  end
+
+  describe ".header" do
+    context "given no parameter" do
+      it "returns an empty header line" do
+        response = Fingerer::Table.header
+        expect(response).to eq("+-[  ]-----------------------------------------------------------------------+")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given an empty string" do
+      it "returns an empty header line" do
+        response = Fingerer::Table.header("")
+        expect(response).to eq("+-[  ]-----------------------------------------------------------------------+")
+        expect(response.length).to be(78)
+      end
+    end
+
+    context "given a non-empty string" do
+      it "returns a non-empty header line" do
+        response = Fingerer::Table.header("header")
+        expect(response).to eq("+-[ header ]-----------------------------------------------------------------+")
+        expect(response.length).to be(78)
+      end
+
+      it "returns a truncated header line" do
+        response = Fingerer::Table.header("this is a really really really really really really really really really long string")
+        expect(response).to eq("+-[ this is a really really really really really really really really real ]-+")
+        expect(response.length).to be(78)
+      end
+    end
+  end
+
+  describe ".line" do
+    it "returns a line" do
+      response = Fingerer::Table.line
+      expect(response).to eq("+#{"-" * 76}+")
+      expect(response.length).to be(78)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'fingerer'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color = true
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fingerer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zachary Flower
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-31 00:00:00.000000000 Z
+dependencies:
+- !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: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: Fingerer is a finger server that returns the GitHub profile associated
+  with the provided username. Quickly lookup GitHub user and organization information
+  using a standard finger command.
+email:
+- zach@zacharyflower.com
+executables:
+- fingerer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/fingerer
+- fingerer.gemspec
+- lib/fingerer.rb
+- lib/fingerer/debug.rb
+- lib/fingerer/table.rb
+- lib/fingerer/time.rb
+- lib/fingerer/version.rb
+- spec/fingerer/debug_spec.rb
+- spec/fingerer/table_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zachflower/fingerer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Lookup GitHub profile information using a standard finger command.
+test_files:
+- spec/fingerer/debug_spec.rb
+- spec/fingerer/table_spec.rb
+- spec/spec_helper.rb