dkv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 770065d8322f5dc034fefa9cb19deadf030d497b
+  data.tar.gz: dd393f37dc912def501b8e920e0bdbe8755411f3
+SHA512:
+  metadata.gz: f4ae0b5b2666f733eb024b6e2132b3bf3f5f09387c9c65d99f6ac59f4ae2d5a34fbb68378c40e1e1eb85d6084f98c25924ea73ebdf3b6fc5429368af03771bdf
+  data.tar.gz: c3c11747c0319f708222c403677e55f4cedfc07e7f0525f8ab9c353e8bce9673dda4de32706f3f495a9882b9f1acdea3117be5195c7e25606da877111907d82e

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sutto@sutto.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Darcy Laycock
+
+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,27 @@
+# DKV - A DynamoDB Key-value client
+
+This provides a simple, DynamoDB-backed key value store suitable for use in AWS environments.
+
+## Installation
+
+```bash
+gem install dkv
+```
+
+## Usage
+
+Once installed, we assume a working AWS-environment based setup (at a min, access key id, secret key and region) and work
+as is.
+
+With that in place,:
+
+* `dkv init [table-name]`: Creates a new table with the specified table name.
+* `dkv set [table-name] [key] [value]`: Set key in the given table to value.
+* `dkv get [table-name] [key]`: Get the value with the given key, exit with status 1 if not found.
+* `dkv clear [table-name] [key]`: Remove the given key (and it's attached value).
+
+## Implementation Details
+
+We use (and provision) a dynamodb table with 1 read unit and 1 write unit, and with a single hash key on `DataKey`.
+
+All values are stored in `DataValue` and we do very simple operations.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dkv"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/dkv.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dkv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dkv"
+  spec.version       = DKV::VERSION
+  spec.authors       = ["Darcy Laycock"]
+  spec.email         = ["sutto@sutto.net"]
+
+  spec.summary       = %q{A simple dynamodb-based key value command line client.}
+  spec.description   = %q{A simple dynamodb-based key value command line client.}
+  spec.homepage      = "https://github.com/sutto/gkv"
+  spec.license       = "MIT"
+
+  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_dependency 'thor'
+  spec.add_dependency 'aws-sdk', '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/exe/dkv

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'dkv'
+
+DKV::CLI.start ARGV

data/lib/dkv.rb

@@ -0,0 +1,7 @@
+require "dkv/version"
+require "dkv/manager"
+require "dkv/cli"
+
+module DKV
+  # Your code goes here...
+end

data/lib/dkv/cli.rb

@@ -0,0 +1,48 @@
+require 'thor'
+require 'aws-sdk'
+
+module DKV
+  class CLI < Thor
+
+    desc "init DATABASE", "Create a new database on dynamodb with the given name."
+    def init(table)
+      # Will make a dynamo db database with the minimum configuration...
+      client.create_table({
+        attribute_definitions: [{attribute_name: "DataKey", attribute_type: "S"}],
+        table_name: table.to_s,
+        key_schema: [{attribute_name: "DataKey", key_type: "HASH"}],
+        provisioned_throughput: {read_capacity_units: 1, write_capacity_units: 1}
+      })
+    end
+
+    desc "set DATABASE KEY VALUE", "Set the given key in a specified database"
+    def set(table, key, value)
+      client.put_item({
+        table_name: table,
+        item: {"DataKey" => key.to_s, "DataValue" => value.to_s}
+      })
+    end
+
+    desc "get DATABASE KEY", "Get the given key in a specified database"
+    def get(table, key)
+      result = client.get_item table_name: table, key: {"DataKey" => key.to_s}
+      if result.item.nil?
+        exit 1
+      else
+        puts result.item['DataValue']
+      end
+    end
+
+    desc "clear DATABASE KEY", "Clear the given key in a specified database"
+    def clear(table, key)
+      client.delete_item table_name: table, key: {"DataKey" => key.to_s}
+    end
+
+    private
+
+    def client
+      @client ||= Aws::DynamoDB::Client.new
+    end
+
+  end
+end

data/lib/dkv/manager.rb

@@ -0,0 +1,4 @@
+module DKV
+  class Manager
+  end
+end

data/lib/dkv/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: dkv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Darcy Laycock
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: A simple dynamodb-based key value command line client.
+email:
+- sutto@sutto.net
+executables:
+- dkv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dkv.gemspec
+- exe/dkv
+- lib/dkv.rb
+- lib/dkv/cli.rb
+- lib/dkv/manager.rb
+- lib/dkv/version.rb
+homepage: https://github.com/sutto/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.5.1
+signing_key: 
+specification_version: 4
+summary: A simple dynamodb-based key value command line client.
+test_files: []