gkv 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f2467eb9e1eae31b24010118d048f02be7ef4ad
-  data.tar.gz: 238c0c1b4a9accb2bab30f1533a4beaf94690fb7
+  metadata.gz: 174cf3ce2358008f146a194a0ce22e77e81b2064
+  data.tar.gz: b0ed3ba9d4acf07f219846638ebb00a68b76383c
 SHA512:
-  metadata.gz: 628ca18afc81b505d2786f3c37b2f5e1fac9d2c6f81bcd10db673d586115d8477d3831ec5aa518afb6f6149a2bca2d96294987f3d06de45cf61e093a7c7c546e
-  data.tar.gz: 5830828a11a1cf039ae6b47a28c4a6027fc37dd87ab7479e4441e59137c43a4014cba79ae73fbadf741f56ab239f1723ee34f863e0f39fe989fe2b7102f3dda6
+  metadata.gz: ea0d241aceabdb4e8ce126cddcb833827476c55bf5740d68ac8557d7f946988a8b6220a9f6d1939b51392b26ba189da5d6659df621cfd1643e6ac4d9d9434f81
+  data.tar.gz: ea7a7dae9e4aa1891d57eaaf2937ed37b8f2e81c6eff96b86ccab08ebed7dd7928e410baf6d5fc3f7100aa2dc0467af415c29946018c6757d9200bac76ce0299

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -1 +1,2 @@
 # [DWTFYW](http://www.wtfpl.net/)
+# Also, don't be a dick.

data/README.md

@@ -1,13 +1,17 @@
 # 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)
+<a href="https://codeclimate.com/github/ybur-yug/gkv"><img src="https://codeclimate.com/github/ybur-yug/gkv/badges/gpa.svg" /></a>
+[![Gem Version](https://badge.fury.io/rb/gkv.svg)](http://badge.fury.io/rb/gkv)
+[![Build Status](https://travis-ci.org/ybur-yug/gkv.svg?branch=master)](https://travis-ci.org/ybur-yug/gkv)
+
 
 Gkv is a simple git wrapper that allows you to use it as a kv store
 
 ![proof in our pudding](http://i.imgur.com/EKdt7oR.png)
 
-The documentation says thats what it does. So why not yo?
+[![asciicast](https://asciinema.org/a/a157ouz4ju5cy9v5r3pexhj4k.png)](https://asciinema.org/a/a157ouz4ju5cy9v5r3pexhj4k)
 
-#### DO NOT use this in real software at its current state.
+The documentation says thats what it does. So why not yo?
 
 #### This is the product of a [tutorial](https://github.com/ybur-yug/git_kv_store_tutorial) I wrote to explore git.
 
@@ -28,10 +32,21 @@ Or install it yourself as:
     $ gem install gkv
 
 ## API
+Types are implicitly understood, and are automatically set/loaded. Only symbols are excluded.
 There are 4 main functions:
 
 ### Set
 
+db[*key*] = *value*
+
+```ruby
+db = Gkv::Database.new
+db['Pants'] = 'red leather'
+# => 'red leather'
+```
+This allows a shorthand notation using operator overloading to set without invoking `set` directly.
+
+
 set(*key*, *value*)
 
 ```ruby
@@ -43,6 +58,17 @@ db.set('test', 12)
 ```
 
 ### Get
+
+db[*key*]
+
+```ruby
+db = Gkv::Database.new
+db['Pants']
+# => 'red leather'
+```
+This allows a shorthand notation using operator overloading to get without invoking `get` directly.
+
+
 get(*key*)
 
 ```ruby
@@ -87,8 +113,6 @@ db.all
 
 ## Usage
 
-[![asciicast](https://asciinema.org/a/0ss6cqmm6yhnyvz88bdy37oiq.png)](https://asciinema.org/a/0ss6cqmm6yhnyvz88bdy37oiq)
-
 ```ruby
 db = Gkv::Database.new
 

data/bench.rb

@@ -0,0 +1,13 @@
+require 'gkv'
+require 'benchmark'
+
+gkv = Gkv::Database.new
+
+n = 1000
+
+Benchmark.bm do |x|
+  x.report("set:\t\t") { n.times { gkv.set('Apple', 10) } }
+  x.report("hash set:\t") { n.times { gkv['Apple'] = 10 } }
+  x.report("get:\t\t") { n.times { gkv.get('Apple') } }
+  x.report("hash get:\t") { n.times { gkv['Apple'] } }
+end

data/example/README.md

@@ -0,0 +1,29 @@
+# Usage
+
+## Setup
+Start the server
+
+    $ bundle
+    $ ruby server.rb
+
+ With this, in another terminal start IRB:
+
+```ruby
+require 'net/http'
+require 'uri'
+
+set_uri = URI('http://localhost:4567/set')
+get_uri = URI('http://localhost:4567/get')
+
+set_params = { :key => 'your_key', :value => 'your value' }
+get_params = { :key => 'your_key' }
+set_uri.query = URI.encode_www_form(set_params)
+get_uri.query = URI.encode_www_form(set_params)
+
+set_resp = Net::HTTP.get(set_uri)
+get_resp = Net::HTTP.get(get_uri)
+puts set_resp
+# => {"key_set":"your_key"}
+puts get_resp
+# => your value
+```

data/example/server.rb

@@ -0,0 +1,28 @@
+require 'sinatra'
+require 'json'
+require 'gkv'
+
+DB = Gkv::Database.new
+
+get '/' do
+  { all_items: DB.all }.to_json
+end
+
+get '/set' do
+  begin
+    key, value = params.fetch('key'), params.fetch('value')
+    DB.set(key, value)
+    { key_set: key }.to_json
+  rescue KeyError
+    { error: 'error setting key/value pair, please send key and value params' }.to_json
+  end
+end
+
+get '/get' do
+  begin
+    key = params.fetch('key')
+    DB.get(key)
+  rescue KeyError
+    { error: 'error retrieving key. it either does not exist or you did not send a parameter `key`' }.to_json
+  end
+end

data/lib/gkv/database.rb

@@ -16,6 +16,10 @@ module Gkv
       key
     end
 
+    def []=(key, value)
+      set(key, value)
+    end
+
     def get(key)
       if $ITEMS.keys.include? key
         YAML.load(Gkv::GitFunctions.cat_file($ITEMS[key].last))
@@ -24,6 +28,10 @@ module Gkv
       end
     end
 
+    def [](key)
+      get(key)
+    end
+
     def get_version(version, key)
       YAML.load(Gkv::GitFunctions.cat_file($ITEMS[key][version.to_i - 1]))
     end

data/lib/gkv/version.rb

@@ -1,3 +1,3 @@
 module Gkv
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gkv
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - '='
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,9 +83,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench.rb
 - bin/console
 - bin/gkv
 - bin/setup
+- example/README.md
+- example/server.rb
 - gkv.gemspec
 - lib/gkv.rb
 - lib/gkv/database.rb