cabal-api 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4957b73cca1d91aade54e4361f941dc513e17d2e
-  data.tar.gz: a1014f814ab8b620b427e383bb01556bc1309304
+  metadata.gz: e347e3023c8af9e9765984b986201d023f4bc13c
+  data.tar.gz: ae6ac8fc86ebb16576011b9f3265a0069396f3e4
 SHA512:
-  metadata.gz: 8d59ca9b093b66a678a03a0b343dbfdab9f34ffd1b512825ff18f672bfc63aeb3706ec3f7fa6f2dc8e86169e03f2640445c05c1dd888447b776ed2157acd02ad
-  data.tar.gz: a1ce4dde5dae99749aaff8864f285581292e995c7d042c571df96e592901bec432466c505b6b1f971a0dfc08e965a2d351893d1b613884755cb3d2a473aacce1
+  metadata.gz: 7cc38762dbe44aab4d7308eeb3773bc42991a3beba93b8437899734f601d1638b8a2e8ab1b14072ff0fa36de03336da34e3f829868291c11891a7f4804d64995
+  data.tar.gz: 0b81be37313d635bb98041164b5c86da68b55406e592a50a450282e98aeab5ab2020429f75f3ae161ff2f66df0eeb6610b3242c49422cde05f3eaa6898c07a93

data/README.md

@@ -1,15 +1,13 @@
-# Cabal::Api
+# Cabal::API #
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cabal/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+Cabal is a simple system for SSH key distribution and consumption. This is the HTTP API that acts as the basis for both of those operations.
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+## Installation ##
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cabal-api'
+gem 'cabal-api', require: 'cabal/api'
 ```
 
 And then execute:
@@ -18,22 +16,68 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install cabal-api
+    $ gem install cabal-util
+
+## Usage ##
+
+This API is implemented via Grape, which means that you can mount it the same way that you can any Rack application. You'll need a Redis endpoint for the API to use (it defaults to `redis://localhost:6379`), and this is configured via the `REDIS_URL` environment variable.
+
+Here's an example `config.ru` that mounts the API to the "/api" namespace:
+
+```ruby
+require 'cabal/api'
+
+map "/api" do
+  run Cabal::API::Base
+end
+```
+
+You can then start that configuration like so:
+
+```bash
+REDIS_URL="redis://your-redis-server:port/db" rackup config.ru
+```
+
+### APIv1 ###
+
+The v1 API is entirely public (no authenticated routes). The routes for this version are as follows (provided that the API is mounted on "/api"):
+
+* *GET /api/v1/key/clustername*
+
+> This returns the public key for the given cluster name. If the cluster is not already known, it is created and a key is generated. Supported formats are:
+>
+> * text - Returns the key raw
+> * json - Returns an object with `name` and `public_ssh_key` attributes
+> * xml - Returns a "hash" document with `name` and `public_ssh_key` elements
+
+### APIv2 ###
+
+The v2 API is made up of both public and private routes. Authentication is performed by setting the `Authorization` request header to `API_KEY:API_SECRET` prior to performing the request.
+
+* **(public)** *GET /api/v2/key/clustername*
+
+> This route is exactly equivalent to the `v1` key route.
+
+* **(private)** *GET /api/v2/private-key/clustername*
 
-## Usage
+> Returns the private key for the requested cluster. If the cluster is not already known, the request results in a 404. If authentication credentials are missing or invalid, the request results in a 404. Otherwise, the result depends on format:
+>
+> * text - Returns the raw key
+> * json - Returns an object with `name` and `private_ssh_key` attributes
+> * xml - Returns a "hash" document with `name` and `private_ssh_key` elements
 
-TODO: Write usage instructions here
+## Development ##
 
-## Development
+Branches and releases for this project are managed by [git-flow](https://github.com/nvie/gitflow).
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Contributing ##
 
-## Contributing
+**Note: Please base all feature branches on the `develop` branch.**
 
-1. Fork it ( https://github.com/[my-github-username]/cabal-api/fork )
+1. Fork it ( https://github.com/engineyard/cabal-api/fork )
 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 a new Pull Request
+5. Create a new Pull Request against the `develop` branch

data/cabal-api.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["dwalters@engineyard.com"]
 
   spec.summary       = %q{A Grape API for creating and distributing SSH keys}
-  spec.homepage      = "http://github.com/ess/cabal-api"
+  spec.homepage      = "http://github.com/engineyard/cabal-api"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|Procfile|config.ru|bin|config)/?}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", '~> 0.10'
   spec.add_development_dependency "redis"
   spec.add_development_dependency "database_cleaner"
-  spec.add_runtime_dependency "cabal", '~> 0.4'
+  spec.add_development_dependency "yard", "~> 0.8.7"
+  spec.add_runtime_dependency "cabal-util", '~> 0.1'
   spec.add_runtime_dependency "grape", '~> 0.13'
   spec.add_runtime_dependency "ohm"
   spec.add_runtime_dependency "ohm-contrib"

data/lib/cabal/api/version.rb

@@ -1,5 +1,5 @@
 module Cabal
   module Api
-    VERSION = "0.0.4"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cabal-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Dennis Walters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,19 +137,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cabal
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: cabal-util
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
@@ -236,10 +250,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - cabal-api.gemspec
-- config/cucumber.yml
 - lib/cabal/api.rb
 - lib/cabal/api/base.rb
 - lib/cabal/api/cluster.rb
@@ -254,7 +265,7 @@ files:
 - lib/cabal/api/v2/private_key.rb
 - lib/cabal/api/v2/public_key.rb
 - lib/cabal/api/version.rb
-homepage: http://github.com/ess/cabal-api
+homepage: http://github.com/engineyard/cabal-api
 licenses:
 - MIT
 metadata: {}
@@ -279,3 +290,4 @@ signing_key:
 specification_version: 4
 summary: A Grape API for creating and distributing SSH keys
 test_files: []
+has_rdoc: 

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "cabal/api"
-
-# 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

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

data/config/cucumber.yml

@@ -1,8 +0,0 @@
-<%
-rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
-rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
-std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip --tags ~@deprecated -r features"
-%>
-default: <%= std_opts %> features
-wip: --tags @wip:3 --wip features
-rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip