ghkv 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c97162f2622d436bc7ff714e48923da10cedf1d
+  data.tar.gz: 495855df9966c7596efffb298f07ee485fb19182
+SHA512:
+  metadata.gz: e80c15dc9ed67e506c4e12eac95d8abb826b4044de52ac747892b77978d333910ecc5f5841e332aaea379c230d0531b02203df92f6aa04ca2f6debcb239d6cea
+  data.tar.gz: b6af58f3050486f7e541ff251afc7d1baabc8c4fb3d9daee4ffa6cf12c1d981485868ed3a1c9f4dd3b44649baa40f7e2cc54cf860184f18e82ddf6a1684db470

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,53 @@
+# Ghkv
+
+`ghkv` is a gem (and corresponding CLI tool) to allow for quick and dirty
+persistence when you really can't be bothered spining up a Redis instance.
+
+## Gem
+
+```ruby
+require 'ghkv'
+
+# token will be read from ENV['GHKV_TOKEN'] if not passed in
+kv = Ghkv::Ghkv.new repo: 'consumer-data/github_build_notifier', token: '<some hex>'
+kv['key'] = { "some" => "hash" }
+kv['key'] # => { "some" => "hash" }
+kv.keys # => ["some"]
+# kv.delete 'key'
+kv.save
+```
+
+If your repo is hosted on GitHub enterprise, you can pass in an `api_url`
+parameter (e.g. `https://git.example.com/api/v3`) or put it in
+`ENV['GHKV_API_URL']`.
+
+## CLI
+
+Tip: Put the following in your `~/.bash_profile` for quicker usage:
+
+```
+# ~/.bash_profile
+export GHKV_TOKEN=somehexvalue
+```
+
+```
+$ ghkv
+Usage:
+    ghkv [OPTIONS] SUBCOMMAND [ARG] ...
+
+Parameters:
+    SUBCOMMAND                    subcommand
+    [ARG] ...                     subcommand arguments
+
+Subcommands:
+    get                           Get value from KV and print to stdout
+    set                           Pass in value to store in KV by parameter or from stdin
+    list                          List all keys in KV, one per line
+    delete                        Delete key from KV
+
+Options:
+    --repo REPO                   Qualified (user/repo) repo name
+    --token TOKEN                 GitHub API token (default: $GHKV_TOKEN)
+    --api API                     Base URL for enterprise GitHub (default: $GHKV_API_URL)
+    -h, --help                    print help
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/exe/ghkv

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'ghkv'
+
+Ghkv::CLI.run

data/ghkv.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ghkv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ghkv'
+  spec.version       = Ghkv::VERSION
+  spec.authors       = ['Aidan Steele']
+  spec.email         = ['aidan.steele@glassechidna.com.au']
+
+  spec.summary       = %q{Use the GitHub API as a ghetto key-value store.}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'pry-rescue'
+
+  spec.add_runtime_dependency 'clamp', '>= 1.0'
+end

data/lib/ghkv.rb

@@ -0,0 +1,13 @@
+require 'set'
+require 'json'
+require 'clamp'
+require 'base64'
+require 'net/http'
+
+require 'ghkv/cli'
+require 'ghkv/ghkv'
+require 'ghkv/version'
+require 'ghkv/http_client'
+
+module Ghkv
+end

data/lib/ghkv/cli.rb

@@ -0,0 +1,48 @@
+module Ghkv
+  class CLI < Clamp::Command
+    option '--repo', 'REPO', 'Qualified (user/repo) repo name'
+    option '--token', 'TOKEN', 'GitHub API token', environment_variable: 'GHKV_TOKEN'
+    option '--api', 'API', 'Base URL for enterprise GitHub', environment_variable: 'GHKV_API_URL'
+
+    subcommand 'get', 'Get value from KV and print to stdout' do
+      parameter 'KEY', 'key'
+
+      def execute
+        puts ghkv[key].to_json
+      end
+    end
+
+    subcommand 'set', 'Pass in value to store in KV by parameter or from stdin' do
+      parameter 'KEY', 'key'
+      parameter '[VALUE]', 'value'
+
+      def execute
+        ghkv[key] = JSON.parse input
+        ghkv.save
+      end
+
+      def input
+        value || $stdin.read
+      end
+    end
+
+    subcommand 'list', 'List all keys in KV, one per line' do
+      def execute
+        puts ghkv.keys
+      end
+    end
+
+    subcommand 'delete', 'Delete key from KV' do
+      parameter 'KEY', 'key'
+
+      def execute
+        ghkv.delete key
+        ghkv.save
+      end
+    end
+
+    def ghkv
+      @ghkv ||= Ghkv.new repo: repo, api_url: api, token: token
+    end
+  end
+end

data/lib/ghkv/ghkv.rb

@@ -0,0 +1,110 @@
+module Ghkv
+  class Ghkv
+    attr_accessor :http, :cache, :dirty, :deleted, :namespace
+
+    def initialize(repo:, api_url: nil, token: ENV['GHKV_TOKEN'])
+      api_url ||= ENV['GHKV_API_URL'] || 'https://api.github.com/'
+      @http = HttpClient.new base: "#{api_url}/repos/#{repo}/", token: token
+
+      @cache = {}
+      @dirty = Set.new
+      @deleted = Set.new
+      @namespace = 'ghkv'
+    end
+
+    def [](key)
+      cache[key] ||= get key
+    end
+
+    def []=(key, value)
+      dirty << key
+      deleted.delete key
+
+      cache[key] = value
+    end
+
+    def delete(key)
+      deleted << key
+      cache.delete key
+    end
+
+    def keys
+      prefix_len = "refs/#{namespace}/".length
+
+      url = refs_url namespace
+      resp = http.request :get, url
+
+      saved_keys = resp.map { |ref| ref['ref'][prefix_len..-1] }
+      (saved_keys + cache.keys).uniq - deleted.to_a
+    end
+
+    def save
+      deleted.each do |key|
+        delete_ref key
+      end
+
+      dirty.each do |key|
+        set key, cache[key]
+      end
+
+      true
+    end
+
+    private
+
+    def get(key)
+      url = refs_url("#{namespace}/#{key}")
+      resp = http.request(:get, url)
+      object = resp['object']
+      return nil if object.nil?
+
+      blob = http.request :get, object['url']
+      decoded = Base64.decode64 blob['content']
+      Marshal.load decoded
+    end
+
+    def set(key, value)
+      sha = post_blob value
+
+      if get(key).nil?
+        create_ref sha, key
+      else
+        update_ref sha, key
+      end
+    end
+
+    def delete_ref(key)
+      http.request :delete, refs_url("#{namespace}/#{key}")
+    end
+
+    def create_ref(sha, key)
+      http.request(
+        :post,
+        refs_url,
+        ref: "refs/#{namespace}/#{key}",
+        sha: sha
+      )
+    end
+
+    def update_ref(sha, key)
+      http.request(
+        :patch,
+        refs_url("#{namespace}/#{key}"),
+        force: true,
+        sha: sha
+      )
+    end
+
+    def post_blob(value)
+      encoded = Base64.encode64 Marshal.dump value
+      payload = { encoding: 'base64', content: encoded }
+      blob = http.request :post, 'git/blobs', payload
+      blob['sha']
+    end
+
+    def refs_url(key=nil)
+      "git/refs/#{key}".chomp('/')
+    end
+  end
+end
+

data/lib/ghkv/http_client.rb

@@ -0,0 +1,37 @@
+module Ghkv
+  class HttpClient
+    attr_accessor :token
+    attr_accessor :verbose
+    attr_accessor :base
+
+    def initialize(base:, token:)
+      @base = URI.parse base
+      @token = token
+    end
+
+    def http_request(method, uri)
+      klass = Net::HTTP.const_get method.capitalize
+      klass.new(uri).tap do |r|
+        r.basic_auth token, 'x-oauth-basic'
+      end
+    end
+
+    def http(uri)
+      Net::HTTP.new(uri.host, uri.port).tap do |h|
+        h.set_debug_output($stdout) if verbose
+        h.use_ssl = uri.port == 443
+      end
+    end
+
+    def request(method, url, body=nil)
+      uri = base + url
+
+      req = http_request method, uri
+      req.body = body.to_json if body
+
+      client = http uri
+      resp = client.request req
+      JSON.parse(resp.body) rescue nil
+    end
+  end
+end

data/lib/ghkv/version.rb

@@ -0,0 +1,3 @@
+module Ghkv
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: ghkv
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Aidan Steele
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-17 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  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'
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- aidan.steele@glassechidna.com.au
+executables:
+- ghkv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- exe/ghkv
+- ghkv.gemspec
+- lib/ghkv.rb
+- lib/ghkv/cli.rb
+- lib/ghkv/ghkv.rb
+- lib/ghkv/http_client.rb
+- lib/ghkv/version.rb
+homepage: 
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Use the GitHub API as a ghetto key-value store.
+test_files: []