onena 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f8a1565f05c0850fb2fe02bc4a94a47de4a20ad
+  data.tar.gz: 9ec380884063a814f4f29e792acea6a5a0e600f7
+SHA512:
+  metadata.gz: d72319d589fbdff4a9d1a50e8e50d79e2b7c6630a816994b1e9e8ae32361671bc4be9fdad7a02b2e26739a5dfdb86b9887196dc9ef0e1b9f0392ee17cd4a5cb2
+  data.tar.gz: e61181c1c3198c50b2ee50db466573d8a1dffdb40d4e81ce83af973318bb58089d362101784072e45c6f90e9849f1dfc26f10295814431e6932bb8276ce186c7

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude:
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: onena Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+---
+language: ruby
+rvm:
+  - 2.2

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.1 / 2016-02-28
+
+* Initial release
+* Based on Samwise

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,30 @@
+This project is in the public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work
+worldwide through the CC0 1.0 Universal public domain dedication.
+
+## CC0 1.0 Universal Summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+### No Copyright
+
+The person who associated a work with this deed has dedicated the work to
+the public domain by waiving all of his or her rights to the work worldwide
+under copyright law, including all related and neighboring rights, to the
+extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial
+purposes, all without asking permission.
+
+### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0,
+nor are the rights that other persons may have in the work or in how the
+work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with
+this deed makes no warranties about the work, and disclaims liability for
+all uses of the work, to the fullest extent permitted by applicable law.
+When using or citing the work, you should not imply endorsement by the
+author or the affirmer.

data/README.md

@@ -0,0 +1,140 @@
+# onena
+
+## Description
+
+Ruby cli tool to reconcile [Tock](https://github.com/18F/tock) and [Float](https://www.float.com/) data.
+
+Onena will return possible matches between Tock and Float users, clients,
+projects, and project/client combinations.  Exact matches are excluded.
+
+Possible matches are returned with [Levenshtein
+distance](https://en.wikipedia.org/wiki/Levenshtein_distance) and [White
+similarity](http://www.catalysoft.com/articles/StrikeAMatch.html).
+
+## Usage
+
+To get started, you'll need Tock and [Float API](https://github.com/floatschedule/api) keys.
+
+For flexibility, all possible matches are returned as JSON, and filtering is done by a
+separate tool.  The examples below using [jq](https://stedolan.github.io/jq/)
+to filter the results.
+
+### Configuration
+
+Set the Tock API key as the environment variable `TOCK_API_KEY` and the Float
+API Key as `FLOAT_API_KEY`, or pass the keys as arguments.  You may also set
+`TOCK_API_ENDPOINT` to override the default endpoint,
+`https://tock.18f.gov/api/`.
+
+```shell
+$ export TOCK_API_ENDPOINT=http://192.168.33.10/api
+$ export TOCK_API_KEY=...
+$ export FLOAT_API_KEY=...
+```
+
+### Get possible project matches with a Levenshtein distance of 4 or less
+
+```shell
+$ onena | jq 'select(.type == "project" and .distance <= 4)'
+{
+  "float": "First Proj",
+  "tock": "First Project",
+  "distance": 3,
+  "similarity": 0.8235294117647058,
+  "type": "project"
+}
+```
+
+### Get possible user matches with a White similarity of 0.8 or greater
+
+```shell
+$ onena | jq 'select(.type == "user" and .similarity >= 0.8)'
+{
+  "float": "Christian Warden",
+  "tock": "Christian G. Warden",
+  "distance": 3,
+  "similarity": 0.9629629629629629,
+  "type": "user"
+}
+```
+
+### Get possible client matches with a Levenshtein distance of 3 or less
+```shell
+$ onena | jq 'select(.type == "client" and .distance <= 3)'
+{
+  "float": "Acme!",
+  "tock": "Acme",
+  "distance": 1,
+  "similarity": 0.8571428571428571,
+  "type": "client"
+}
+```
+
+### Get possible project->client matches with a Levenshtein distance of 8 or less
+
+```shell
+$ onena | jq 'select(.type == "project-client" and .distance <= 8)'
+{
+  "float": "First Proj -> Acme!",
+  "tock": "First Project -> Acme",
+  "distance": 4,
+  "similarity": 0.8461538461538461,
+  "type": "project-client"
+}
+```
+
+### Library Usage
+
+Onena can also be used a ruby library.
+
+```ruby
+require 'onena'
+
+client = Onena::Client.new(tock_api_key: 'tock key ...', float_api_key: 'float key ...', tock_api_endpoint: 'http://192.168.33.10/api')
+
+# if you set the 'TOCK_API_KEY' and 'FLOAT_API_KEY' env vars, just use:
+client = Onena::Client.new
+
+client.possible_client_matches.select { |match| match[:distance] <= 4 }
+ => [{:float=>"Acme!", :tock=>"Acme", :distance=>1, :similarity=>0.8571428571428571}]
+client.possible_project_matches.select { |match| match[:distance] <= 4 }
+ => [{:float=>"First Proj", :tock=>"First Project", :distance=>3, :similarity=>0.8235294117647058}]
+client.possible_project_client_matches.select { |match| match[:distance] <= 4 }
+ => [{:float=>"First Proj -> Acme!", :tock=>"First Project -> Acme", :distance=>4, :similarity=>0.8461538461538461}]
+client.possible_user_matches.select { |match| match[:distance] <= 4 }
+ => [{:float=>"Christian Warden", :tock=>"Christian G. Warden", :distance=>3, :similarity=>0.9629629629629629}]
+```
+
+## Install
+
+From the command-line:
+
+```shell
+$ gem install onena
+```
+
+or in your Gemfile:
+
+```ruby
+gem 'onena', github: 'cwarden/onena'
+```
+
+## History
+
+This tool was developed by [Christian G. Warden](https://github.com/cwarden) as
+a [micro-purchase by 18F](https://micropurchase.18f.gov/auctions/11).  For
+consistency with other 18F projects (and because the author has almost nil
+experience with Ruby) the [samwise](https://github.com/18F/samwise) project by
+[Alan deLevie](https://github.com/adelevie) was used as a template for the
+application structure.
+
+## Public Domain
+
+This project is in the worldwide [public domain](LICENSE.md).
+
+> This project is in the public domain within the United States, and copyright
+> and related rights in the work worldwide are waived through the [CC0 1.0 > Universal public domain > dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+>
+> All contributions to this project will be released under the CC0 dedication.
+> By submitting a pull request, you are agreeing to comply with this waiver of
+> copyright interest.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/bin/onena

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'onena'
+
+client = Onena::Client.new
+client.print_possible_matches

data/lib/onena.rb

@@ -0,0 +1,5 @@
+require 'onena/version'
+require 'onena/error'
+require 'onena/util'
+require 'onena/protocol'
+require 'onena/client'

data/lib/onena/client.rb

@@ -0,0 +1,145 @@
+require 'curb'
+require 'json'
+
+module Onena
+	class Client
+		def initialize(tock_api_key: nil, float_api_key: nil, tock_api_endpoint: nil)
+			@tock_api_key  = tock_api_key  || ENV['TOCK_API_KEY']
+			@float_api_key = float_api_key || ENV['FLOAT_API_KEY']
+			@tock_api_endpoint = tock_api_endpoint || ENV['TOCK_API_ENDPOINT'] || Onena::Protocol::TOCK_API_BASE_URL
+			fail Onena::Error::ArgumentMissing, 'Float API key is missing' if @float_api_key.nil?
+		end
+
+		def float_user_names
+			float_users = get_float_users
+			float_users['people'].map { |user| user['name'] }
+		end
+
+		def tock_user_names
+			tock_users = get_tock_users
+			tock_users['results'].map { |user| [user['first_name'], user['last_name']].join(' ').strip }
+		end
+
+		def float_project_names
+			float_projects = get_float_projects
+			float_projects['projects'].map { |project| project['project_name'] }
+		end
+
+		def tock_project_names
+			tock_projects = get_tock_projects
+			tock_projects['results'].map { |project| project['name'] }
+		end
+
+		def float_client_names
+			float_projects = get_float_projects
+			clients = float_projects['projects'].map { |project| project['client_name'] }
+			clients.uniq.compact
+		end
+
+		def tock_client_names
+			tock_projects = get_tock_projects
+			clients = tock_projects['results'].map { |project| project['client'] }
+			clients.uniq
+		end
+
+		def float_project_client_names
+			float_projects = get_float_projects
+			project_clients = float_projects['projects'].map { |project| "#{project['project_name']} -> #{project['client_name']}" }
+			project_clients.uniq.compact
+		end
+
+		def tock_project_client_names
+			tock_projects = get_tock_projects
+			project_clients = tock_projects['results'].map { |project| "#{project['name']} -> #{project['client']}" }
+			project_clients.uniq
+		end
+
+		def possible_user_matches
+			Onena::Util.matches(tock_list: tock_user_names, float_list: float_user_names)
+		end
+
+		def possible_project_matches
+			Onena::Util.matches(tock_list: tock_project_names, float_list: float_project_names)
+		end
+
+		def possible_client_matches
+			Onena::Util.matches(tock_list: tock_client_names, float_list: float_client_names)
+		end
+
+		def possible_project_client_matches
+			Onena::Util.matches(tock_list: tock_project_client_names, float_list: float_project_client_names)
+		end
+
+		def tagged_possible_matches
+			[tag_matches(matches: possible_user_matches, type: :user),
+			tag_matches(matches: possible_project_matches, type: :project),
+			tag_matches(matches: possible_client_matches, type: :client),
+			tag_matches(matches: possible_project_client_matches, type: :"project-client")]
+				.flatten
+				.compact
+		end
+
+		def print_possible_matches
+			tagged_possible_matches.each { |match| $stdout.puts match.to_json }
+		end
+
+		private
+
+		def get_float_users
+			response = fetch_float_users
+			JSON.parse(response.body_str)
+		end
+
+		def get_tock_users
+			response = fetch_tock_users
+			JSON.parse(response.body_str)
+		end
+
+		def get_float_projects
+			response = fetch_float_projects
+			JSON.parse(response.body_str)
+		end
+
+		def get_tock_projects
+			response = fetch_tock_projects
+			JSON.parse(response.body_str)
+		end
+
+		def tock_request(url)
+			Curl.get(url) do |http|
+				# TODO: Confirm how authentication is done against production
+				# endpoint, https://tock.18f.gov/api/
+				http.headers['Cookie'] = '_oauth2_proxy=' + @tock_api_key unless @tock_api_key.nil?
+			end
+		end
+
+		def fetch_tock_users
+			url = Onena::Protocol.tock_users_url(endpoint: @tock_api_endpoint)
+			tock_request(url)
+		end
+
+		def fetch_float_users
+			url = Onena::Protocol.float_users_url
+			Curl.get(url) do |http|
+				 http.headers['Authorization'] = @float_api_key
+			end
+		end
+
+		def fetch_tock_projects
+			url = Onena::Protocol.tock_projects_url(endpoint: @tock_api_endpoint)
+			tock_request(url)
+		end
+
+		def fetch_float_projects
+			url = Onena::Protocol.float_projects_url
+			Curl.get(url) do |http|
+				 http.headers['Authorization'] = @float_api_key
+			end
+		end
+
+		def tag_matches(matches: [], type: nil)
+			matches.map { |match| match.merge(type: type) }
+		end
+
+	end
+end

data/lib/onena/error.rb

@@ -0,0 +1,12 @@
+module Onena
+  module Error
+	class InvalidFormat < StandardError
+	  def initialize(message: 'Invalid format')
+		super(message)
+	  end
+	end
+
+	class ArgumentMissing < StandardError
+	end
+  end
+end

data/lib/onena/protocol.rb

@@ -0,0 +1,26 @@
+module Onena
+  module Protocol
+	TOCK_API_BASE_URL   = 'https://tock.18f.gov/api/'
+	FLOAT_API_BASE_URL  = 'https://api.floatschedule.com/api'
+	FLOAT_API_VERSION   = 'v1'
+
+	def self.tock_users_url(endpoint: nil)
+		fail Onena::Error::ArgumentMissing, 'Tock endpoint is missing' if endpoint.nil?
+		"#{endpoint}/users.json?page_size=100000"
+	end
+
+	def self.tock_projects_url(endpoint: nil)
+		fail Onena::Error::ArgumentMissing, 'Tock endpoint is missing' if endpoint.nil?
+		"#{endpoint}/projects.json?page_size=100000"
+	end
+
+	def self.float_users_url
+		"#{FLOAT_API_BASE_URL}/#{FLOAT_API_VERSION}/people"
+	end
+
+	def self.float_projects_url
+		"#{FLOAT_API_BASE_URL}/#{FLOAT_API_VERSION}/projects"
+	end
+
+  end
+end