gkv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e7086ff4e33f99aaff34e5eb12b442d856450c3
+  data.tar.gz: 18ed48d3a23cdbff795a52585df57a4c5290e065
+SHA512:
+  metadata.gz: 719eb2aab72564f373356d43b8404ff06635546848f5d85edc9664f204940dd48d85b59013b89a169fc83343f1b14b92a05992c63725251243dddb49930413c8
+  data.tar.gz: 48bf8e3495393f8f1f162531b17a4e998d517ccbb78ce34918c088c95770913303fe8375ca4f18899f458daa55f39be2cf35e3c124a1825c3db671fe81d9cb7f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+        DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 
+                    Version 2, December 2004 
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net> 
+
+ Everyone is permitted to copy and distribute verbatim or modified 
+ copies of this license document, and changing it is allowed as long 
+ as the name is changed. 
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,119 @@
+# Gkv
+[![Join the chat at https://gitter.im/ybur-yug/gkv](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ybur-yug/gkv?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Gkv is a simple git wrapper that allows you to use it as a kv store
+
+#### DO NOT use this in real software at its current state.
+
+#### This is the product of a [tutorial](https://github.com/ybur-yug/git_kv_store_tutorial) I wrote to explore git.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gkv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gkv
+
+## API
+There are 3 main functions:
+
+### Set
+
+set(*key*, *value*)
+
+```ruby
+db = Gkv::Database.new
+db.set('key', 12)
+# input is all coerced to the string type and returned when set
+# => '12'
+```
+
+### Get
+get(*key*)
+
+```ruby
+db = Gkv::Database.new
+db.set('apples', '10')
+# => '10'
+db.get('apples')
+# => '10'
+```
+
+### Get Version
+
+get_version(*version*, *key*)
+
+```ruby
+db = Gkv::Database.new
+db.set('apples', '20')
+db.set('apples', '50')
+db.get_version(1, 'apples')
+# => '20'
+db.get_version(2, 'apples')
+# => '50'
+```
+
+## Usage
+
+```ruby
+db = Gkv::Database.new
+
+db.set("Apples", "10")
+db.get("Apples")
+# => "10"
+
+# update some values
+db.set("Apples", "12")
+db.get("Apples")
+# => "12"
+db.get_version(1, "Apples")
+#=> 10
+
+# keys that do not exist return KeyError
+db.get('magic')
+# => KeyError
+
+# using it in sinatra
+require 'sinatra'
+require 'json'
+
+post '/' do
+  db.set(params['key'], params['value')
+  { msg: "#{params['key']} set to #{params['value']}" }.to_json
+  rescue
+    { error: "Please send key and value params" }.to_json
+  end
+end
+
+get '/get/:key' do
+  { key: db.get(params['key']) }.to_json
+end
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the
+tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version,
+update the version number in `version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+Feel free to check out the gitter room and ask whats on the agenda.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ybur-yug/gkv. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+See [this](http://www.wtfpl.net/about/).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gkv'
+
+DB = Gkv::Database.new
+
+require 'irb'
+IRB.start

data/bin/gkv

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'gkv'

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gkv.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gkv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gkv"
+  spec.version       = Gkv::VERSION
+  spec.authors       = ["="]
+  spec.email         = ["="]
+
+  spec.summary       = %q{Git as a key:value store.}
+  spec.description   = %q{Utilize a git repository as a trivially simple kv store.}
+  spec.homepage      = "https://www.github.com/ybur-yug/gkv"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = "gkv"
+  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"
+end

data/lib/gkv.rb

@@ -0,0 +1,6 @@
+require 'gkv/version'
+require 'gkv/git'
+require 'gkv/database'
+
+module Gkv
+end

data/lib/gkv/database.rb

@@ -0,0 +1,29 @@
+$items = {}
+module Gkv
+  class Database
+    include Gkv::DbFunctions
+    include Gkv::GitFunctions
+    attr_accessor :items
+
+    def initialize
+      `git init`
+    end
+
+    def set(key, value)
+      update_items(key, value)
+      value
+    end
+
+    def get(key)
+      if $items.keys.include? key
+        cat_file($items.fetch(key.to_s).last)
+      else
+        raise KeyError
+      end
+    end
+
+    def get_version(version, key)
+      cat_file($items[key][version.to_i - 1])
+    end
+  end
+end

data/lib/gkv/git.rb

@@ -0,0 +1,32 @@
+module Gkv
+  module GitFunctions
+    def self.hash_object(data)
+      write_tmpfile(data)
+      hash = `git hash-object -w tmp.txt`.strip!
+      File.delete('tmp.txt')
+      hash
+    end
+
+    def self.write_tmpfile(data)
+      f = File.open('tmp.txt', 'w+')
+      f.write(data.to_s)
+      f.close
+    end
+
+    def cat_file(hash)
+      `git cat-file -p #{hash}`
+    end
+  end
+
+  module DbFunctions
+    def update_items(key, value)
+      if $items.keys.include? key
+        history = $items[key]
+        history << Gkv::GitFunctions.hash_object(value.to_s)
+        $items[key] = history
+      else
+        $items[key] = [Gkv::GitFunctions.hash_object(value.to_s)]
+      end
+    end
+  end
+end

data/lib/gkv/version.rb

@@ -0,0 +1,3 @@
+module Gkv
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: gkv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- '='
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-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
+  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: Utilize a git repository as a trivially simple kv store.
+email:
+- '='
+executables:
+- gkv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/gkv
+- bin/setup
+- gkv.gemspec
+- lib/gkv.rb
+- lib/gkv/database.rb
+- lib/gkv/git.rb
+- lib/gkv/version.rb
+homepage: https://www.github.com/ybur-yug/gkv
+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: Git as a key:value store.
+test_files: []