cabal-api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2c0db4445951ebe576c4a5bcf531beb97f3cf33
-  data.tar.gz: 0a5989567df1b010b3fdf3bea2d36172359e7191
+  metadata.gz: 20a233adbec4e526558b82962883b7bf777665ae
+  data.tar.gz: 4bcbc4c6957abb5ef2602c429d03308c87c258ae
 SHA512:
-  metadata.gz: b5940aba27b83d1b4a2ed49df5ab147ce23c3838f908c5b8f0c04382a744da3b10b6b6f63737d571979d67cf486be442cc8bd84320c3bb024ab6cc33f3d4b092
-  data.tar.gz: 07c9fc0e25fa872c4742c8438a7f66280d0e85711dc33fd53b03c46453e27d82dfc995517e053de115bfbc44e769a37f0e2502aacd8730fc75e51491ba82ca60
+  metadata.gz: 322121fd444ec9c09b610f00b8a1a54cd9fe54e8c717e244c4b9a648ce26d331d9d6edf6d4f6c67d108758f2bba39291654f0728d73f04329524e66b32c8c7a2
+  data.tar.gz: 73ce4d8efb4fd1ffcb134906fccfed26d6c7831c79fc8008663156eea0ac4bde2e4df72024a088002a48d7a081e381887c929295baf4041484e2d14d7819e818

data/.travis.yml

@@ -1,3 +1,4 @@
-language: ruby
+sudo: false
+services: redis-server
 rvm:
-  - 2.2.2
+  - "2.2.2"

data/README.md

@@ -66,6 +66,27 @@ The v2 API is made up of both public and private routes. Authentication is perfo
 > * json - Returns an object with `name` and `private_ssh_key` attributes
 > * xml - Returns a "hash" document with `name` and `private_ssh_key` elements
 
+### APIv2 ###
+
+The v3 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/v3/key/clustername*
+
+> This route is exactly equivalent to the `v1` key route.
+
+* **(private)** *GET /api/v3/private-key/clustername*
+
+> This route is exactly equivalent to the `v2` private-key route.
+
+* **(private)** *GET /api/v3/clusters*
+
+> Returns the names of the clusters known to the API in the following format:
+>
+> * text - Returns a list of cluster names, one per line
+> * json - Returns an array of objects with `name` attributes
+> * xml - Returns an "array" document containing "hash" elements with a `name` element
+
+
 ## Development ##
 
 Branches and releases for this project are managed by [git-flow](https://github.com/nvie/gitflow).

data/Rakefile

@@ -1 +1,13 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern    = 'spec/**/*_spec.rb'
+end
+
+desc "Run Cucumber suite"
+Cucumber::Rake::Task.new
+
+task :default => [:spec, :cucumber]

data/lib/cabal/api/base.rb

@@ -1,12 +1,14 @@
 require 'grape'
 require 'cabal/api/v1/base'
 require 'cabal/api/v2/base'
+require 'cabal/api/v3/base'
 
 module Cabal
   module API
     class Base < Grape::API
       mount Cabal::API::V1::Base
       mount Cabal::API::V2::Base
+      mount Cabal::API::V3::Base
     end
   end
 end

data/lib/cabal/api/common/private_key.rb

@@ -0,0 +1,49 @@
+require 'cabal/util'
+require 'cabal/api/cluster'
+require 'cabal/api/user'
+require 'cabal/api/common/authenticated'
+require 'cabal/api/common/mistakes'
+
+module Cabal
+  module API
+    module Common
+      module PrivateKey
+        def self.included(base)
+          base.class_eval do
+            include Cabal::API::Common::Authenticated
+            include Cabal::API::Common::Mistakes
+
+            formatter :txt, ->(object, env) {
+              object[:private_ssh_key]
+            }
+
+            helpers do
+              def error_if_not_found!(cluster, name)
+                unless cluster
+                  error!(
+                    messagify("The cluster '#{name}' could not be found."),
+                    404
+                  )
+                end
+              end
+            end
+
+            get '/private-key/:name' do
+              authenticate!
+
+              cluster_name = Cabal::Util.normalize(params[:name])
+              cluster = Cabal::API::Cluster.find(name: cluster_name).first
+
+              error_if_not_found!(cluster, cluster_name)
+
+              {
+                name: cluster.name,
+                private_ssh_key: cluster.private_key
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cabal/api/v2/private_key.rb

@@ -1,45 +1,11 @@
 require 'grape'
-require 'cabal/util'
-require 'cabal/api/cluster'
-require 'cabal/api/user'
-require 'cabal/api/common/authenticated'
-require 'cabal/api/common/mistakes'
+require 'cabal/api/common/private_key'
 
 module Cabal
   module API
     module V2
       class PrivateKey < Grape::API
-        include Cabal::API::Common::Authenticated
-        include Cabal::API::Common::Mistakes
-
-        formatter :txt, ->(object, env) {
-          object[:private_ssh_key]
-        }
-
-        helpers do
-          def error_if_not_found!(cluster, name)
-            unless cluster
-              error!(
-                messagify("The cluster '#{name}' could not be found."),
-                404
-              )
-            end
-          end
-        end
-
-        get '/private-key/:name' do
-          authenticate!
-
-          cluster_name = Cabal::Util.normalize(params[:name])
-          cluster = Cabal::API::Cluster.find(name: cluster_name).first
-
-          error_if_not_found!(cluster, cluster_name)
-
-          {
-            name: cluster.name,
-            private_ssh_key: cluster.private_key
-          }
-        end
+        include Cabal::API::Common::PrivateKey
       end
     end
   end

data/lib/cabal/api/v3/base.rb

@@ -0,0 +1,18 @@
+require 'grape'
+require 'cabal/api/v3/list'
+require 'cabal/api/v3/public_key'
+require 'cabal/api/v3/private_key'
+
+module Cabal
+  module API
+    module V3
+      class Base < Grape::API
+        version 'v3', using: :path
+
+        mount Cabal::API::V3::List
+        mount Cabal::API::V3::PublicKey
+        mount Cabal::API::V3::PrivateKey
+      end
+    end
+  end
+end

data/lib/cabal/api/v3/list.rb

@@ -0,0 +1,30 @@
+require 'grape'
+require 'cabal/util'
+require 'cabal/api/cluster'
+require 'cabal/api/user'
+require 'cabal/api/common/authenticated'
+require 'cabal/api/common/mistakes'
+
+module Cabal
+  module API
+    module V3
+      class List < Grape::API
+        include Cabal::API::Common::Authenticated
+        include Cabal::API::Common::Mistakes
+
+        formatter :txt, ->(object, env) {
+          object.map {|cluster| cluster[:name]}.join("\n")
+        }
+
+        get '/clusters' do
+          authenticate!
+
+          Cabal::API::Cluster.
+            all.
+            sort(&:name).
+            map {|cluster| {name: cluster.name}}
+        end
+      end
+    end
+  end
+end

data/lib/cabal/api/v3/private_key.rb

@@ -0,0 +1,12 @@
+require 'grape'
+require 'cabal/api/common/private_key'
+
+module Cabal
+  module API
+    module V3
+      class PrivateKey < Grape::API
+        include Cabal::API::Common::PrivateKey
+      end
+    end
+  end
+end

data/lib/cabal/api/v3/public_key.rb

@@ -0,0 +1,13 @@
+require 'grape'
+require 'cabal/util'
+require 'cabal/api/common'
+
+module Cabal
+  module API
+    module V3
+      class PublicKey < Grape::API
+        include Cabal::API::Common::PublicKey
+      end
+    end
+  end
+end

data/lib/cabal/api/version.rb

@@ -1,5 +1,5 @@
 module Cabal
   module Api
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cabal-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis Walters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-15 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -257,6 +257,7 @@ files:
 - lib/cabal/api/common.rb
 - lib/cabal/api/common/authenticated.rb
 - lib/cabal/api/common/mistakes.rb
+- lib/cabal/api/common/private_key.rb
 - lib/cabal/api/common/public_key.rb
 - lib/cabal/api/user.rb
 - lib/cabal/api/v1/base.rb
@@ -264,6 +265,10 @@ files:
 - lib/cabal/api/v2/base.rb
 - lib/cabal/api/v2/private_key.rb
 - lib/cabal/api/v2/public_key.rb
+- lib/cabal/api/v3/base.rb
+- lib/cabal/api/v3/list.rb
+- lib/cabal/api/v3/private_key.rb
+- lib/cabal/api/v3/public_key.rb
 - lib/cabal/api/version.rb
 homepage: http://github.com/engineyard/cabal-api
 licenses: