riak-cs-user-mgmt 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "fog", git: "git://github.com/hectcastro/fog.git", ref: "hc-riakcs-usage-connection-options"
+
+group :development do
+  gem "rake", "~> 10.1.0"
+  gem "aruba", "~> 0.5.3"
+  gem "ronn", "~> 0.7.3"
+end

data/README.md

@@ -0,0 +1,41 @@
+# riak-cs-user-mgmt
+
+`mgmt` is a command-line tool that aids in [Riak
+CS](https://github.com/basho/riak_cs) user management.
+
+## Installation
+
+```bash
+$ git clone git://github.com/hectcastro/riak-cs-user-mgmt.git
+$ cd riak-cs-user-mgmt
+$ rake install
+```
+
+## Usage
+
+```bash
+$ mgmt list
+email  display_name  name  key_id  key_secret  id  status
+...
+$ mgmt create -v test3 test3@example.com
+{"email":"test3@example.com","display_name":"test3","name":"test3","key_id":"LLBMUDS0KC7D3VRV6PZS","key_secret":"NJKY-7bNU9d7G_EioIMj1UIV4qmM7Ov8ryhK1w==","id":"1270290a292867033583634dcf195d6387886e54cf91a1833fa6750b45ff72bd","status":"enabled"}
+```
+
+## Testing
+
+The test suite for `riak-cs-user-mgmt` was built using
+[Cucumber](https://github.com/cucumber/cucumber) and
+[Aruba](https://github.com/cucumber/aruba). In order to run the tests, you'll
+need an active instnace of Riak.
+
+```bash
+$ cucumber features/
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/mgmt

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "mgmt/cli"
+
+Mgmt::CLI.start

data/features/create.feature

@@ -0,0 +1,28 @@
+Feature: Create
+  Scenario: No arguments
+    When I run `mgmt create`
+    And the stderr should contain:
+    """
+    ERROR: mgmt create was called with no arguments
+    Usage: "mgmt create [NAME] [EMAIL]".
+    """
+
+  Scenario: Only a name argument
+    When I run `mgmt create name`
+    And the stderr should contain:
+    """
+    ERROR: mgmt create was called with arguments ["name"]
+    Usage: "mgmt create [NAME] [EMAIL]".
+    """
+
+  Scenario: A name and an e-mail address
+    When I run `mgmt create name admin@admin.com`
+    Then the exit status should be 0
+
+  Scenario: A name and an e-mail address that already exists
+    When I run `mgmt create name admin@admin.com`
+    Then the exit status should be 1
+    And the stderr should contain:
+    """
+    User already exists.
+    """

data/features/list.feature

@@ -0,0 +1,11 @@
+Feature: List
+  Scenario: No arguments
+    When I run `mgmt list`
+    Then the exit status should be 0
+    And the output should contain "email"
+    And the output should contain "display_name"
+    And the output should contain "name"
+    And the output should contain "key_id"
+    And the output should contain "key_secret"
+    And the output should contain "id"
+    And the output should contain "status"

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require "aruba/cucumber"
+
+Before do
+  @aruba_timeout_seconds = 5
+end

data/lib/mgmt.rb

@@ -0,0 +1,5 @@
+require "mgmt/version"
+
+module Mgmt
+  class AppDoesNotExist < Exception; end
+end

data/lib/mgmt/cli.rb

@@ -0,0 +1,55 @@
+require "mgmt"
+require "thor"
+require "fog"
+
+class Mgmt::CLI < Thor
+  class_option :verbose, type: :boolean, aliases: "-v", desc: "Increase verbosity."
+
+  desc "create [NAME] [EMAIL]", "Create a new user"
+  def create(name, email)
+    begin
+      response = client.create_user(email, name)
+      say(JSON.generate(response.body)) if options[:verbose]
+    rescue Fog::RiakCS::Provisioning::UserAlreadyExists => e
+      error("User already exists.")
+      exit(1)
+    end
+  end
+
+  desc "list", "List the users in the system"
+  def list
+    response  = client.list_users
+    headers   = response.body.first.keys
+    users     = response.body.map(&:values)
+    print_table([ headers, *users ])
+  end
+
+  private
+
+  def client
+    Fog::RiakCS::Provisioning.new(
+      riakcs_access_key_id: options["access_key"],
+      riakcs_secret_access_key: options["secret_key"],
+      host: "s3.amazonaws.com",
+      port: 80,
+      connection_options: {
+        proxy: "http://localhost:8080"
+      }
+    )
+  end
+
+  def options
+    original_options = super
+    default_options  = {
+      "access_key" => ENV["RIAKCS_ACCESS_KEY_ID"],
+      "secret_key" => ENV["RIAKCS_SECRET_ACCESS_KEY"]
+    }
+
+    if default_options["access_key"].nil? && default_options["secret_key"].nil?
+      error("Please set your RIAKCS_ACCESS_KEY_ID and RIAKCS_SECRET_ACCESS_KEY enviromental variables.")
+      exit(1)
+    end
+
+    Thor::CoreExt::HashWithIndifferentAccess.new(original_options.merge(default_options))
+  end
+end

data/lib/mgmt/version.rb

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

data/man/mgmt.1

@@ -0,0 +1,67 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "MGMT" "1" "July 2013" "" ""
+.
+.SH "NAME"
+\fBmgmt\fR \- manage users in Riak CS
+.
+.SH "SYNOPSIS"
+\fBmgmt create admin admin@admin\.com\fR
+.
+.SH "DESCRIPTION"
+\fBmgmt\fR is a command\-line tool that aids in Riak CS user management\.
+.
+.SH "RUNNING"
+\fBmgmt create\fR is used to create users within Riak CS\.
+.
+.P
+If a valid username ane e\-mail address is provided, \fBmgmt\fR will create that user in Riak CS\.
+.
+.P
+\fBmgmt list\fR is used to list the users in Riak CS\.
+.
+.SH "OPTIONS"
+These options control all modes of \fBmgmt\fR\'s operation:
+.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Increase verbosity\.
+.
+.SH "CONFIGURATION"
+\fBmgmt\fR expects the following environmental variables to be present when it is invoked:
+.
+.IP "\(bu" 4
+\fBRIAKCS_ACCESS_KEY_ID\fR: Your Riak CS access key ID\.
+.
+.IP "\(bu" 4
+\fBRIAKCS_SECRET_ACCESS_KEY\fR Your Riak CS secret access key\.
+.
+.IP "" 0
+.
+.SH "EXAMPLE"
+Create a user named \fBadmin\fR with the e\-mail address \fBadmin@admin\.com\fR:
+.
+.IP "" 4
+.
+.nf
+
+$ mgmt create admin admin@admin\.com
+.
+.fi
+.
+.IP "" 0
+.
+.P
+List all of the users in the system:
+.
+.IP "" 4
+.
+.nf
+
+$ mgmt list
+.
+.fi
+.
+.IP "" 0
+

data/man/mgmt.1.html

@@ -0,0 +1,136 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>mgmt(1) - manage users in Riak CS</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#RUNNING">RUNNING</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#CONFIGURATION">CONFIGURATION</a>
+    <a href="#EXAMPLE">EXAMPLE</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>mgmt(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>mgmt(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>mgmt</code> - <span class="man-whatis">manage users in Riak CS</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>mgmt create admin admin@admin.com</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><strong>mgmt</strong> is a command-line tool that aids in Riak CS user management.</p>
+
+<h2 id="RUNNING">RUNNING</h2>
+
+<p><code>mgmt create</code> is used to create users within Riak CS.</p>
+
+<p>If a valid username ane e-mail address is provided, <code>mgmt</code> will create that
+user in Riak CS.</p>
+
+<p><code>mgmt list</code> is used to list the users in Riak CS.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>These options control all modes of <code>mgmt</code>'s operation:</p>
+
+<dl>
+<dt><code>-v</code>, <code>--verbose</code></dt><dd>Increase verbosity.</dd>
+</dl>
+
+
+<h2 id="CONFIGURATION">CONFIGURATION</h2>
+
+<p><code>mgmt</code> expects the following environmental variables to be present when it is
+invoked:</p>
+
+<ul>
+<li><code>RIAKCS_ACCESS_KEY_ID</code>:
+Your Riak CS access key ID.</li>
+<li><code>RIAKCS_SECRET_ACCESS_KEY</code>
+Your Riak CS secret access key.</li>
+</ul>
+
+
+<h2 id="EXAMPLE">EXAMPLE</h2>
+
+<p>Create a user named <code>admin</code> with the e-mail address <code>admin@admin.com</code>:</p>
+
+<pre><code>$ mgmt create admin admin@admin.com
+</code></pre>
+
+<p>List all of the users in the system:</p>
+
+<pre><code>$ mgmt list
+</code></pre>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>July 2013</li>
+    <li class='tr'>mgmt(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/mgmt.1.ronn

@@ -0,0 +1,46 @@
+mgmt(1) -- manage users in Riak CS
+=======================================================================
+
+## SYNOPSIS ##
+
+`mgmt create admin admin@admin.com`
+
+## DESCRIPTION ##
+
+__mgmt__ is a command-line tool that aids in Riak CS user management.
+
+## RUNNING ##
+
+`mgmt create` is used to create users within Riak CS.
+
+If a valid username ane e-mail address is provided, `mgmt` will create that
+user in Riak CS.
+
+`mgmt list` is used to list the users in Riak CS.
+
+## OPTIONS ##
+
+These options control all modes of `mgmt`'s operation:
+
+  * `-v`, `--verbose`:
+    Increase verbosity.
+
+## CONFIGURATION ##
+
+`mgmt` expects the following environmental variables to be present when it is
+invoked:
+
+  * `RIAKCS_ACCESS_KEY_ID`:
+    Your Riak CS access key ID.
+  * `RIAKCS_SECRET_ACCESS_KEY`
+    Your Riak CS secret access key.
+
+## EXAMPLE ##
+
+Create a user named `admin` with the e-mail address `admin@admin.com`:
+
+    $ mgmt create admin admin@admin.com
+
+List all of the users in the system:
+
+    $ mgmt list

data/riak-cs-user-mgmt.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mgmt/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "riak-cs-user-mgmt"
+  gem.version       = Mgmt::VERSION
+  gem.authors       = ["Hector Castro"]
+  gem.email         = ["hector@basho.com"]
+  gem.homepage      = "https://hectcastro.github.com/riak-cs-user-mgmt"
+  gem.summary       = %q{`mgmt` is a command-line tool that aids in Riak CS user management.}
+  gem.description   = gem.summary
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(features)/})
+  gem.executables   = ["mgmt"]
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "thor"
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: riak-cs-user-mgmt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Hector Castro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ! '`mgmt` is a command-line tool that aids in Riak CS user management.'
+email:
+- hector@basho.com
+executables:
+- mgmt
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/mgmt
+- features/create.feature
+- features/list.feature
+- features/support/env.rb
+- lib/mgmt.rb
+- lib/mgmt/cli.rb
+- lib/mgmt/version.rb
+- man/mgmt.1
+- man/mgmt.1.html
+- man/mgmt.1.ronn
+- riak-cs-user-mgmt.gemspec
+homepage: https://hectcastro.github.com/riak-cs-user-mgmt
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! '`mgmt` is a command-line tool that aids in Riak CS user management.'
+test_files:
+- features/create.feature
+- features/list.feature
+- features/support/env.rb