spice 0.0.1.alpha.2 → 0.0.2.beta

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spice (0.0.1.alpha)
+    spice (0.0.1.beta1)
       mixlib-authentication
       rest-client
       yajl-ruby
@@ -9,11 +9,56 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    abstract (1.0.0)
+    addressable (2.2.2)
+    builder (3.0.0)
+    bunny (0.6.0)
+    chef (0.9.12)
+      bunny (>= 0.6.0)
+      erubis
+      extlib
+      highline
+      json (>= 1.4.4, <= 1.4.6)
+      mixlib-authentication (>= 1.1.0)
+      mixlib-cli (>= 1.1.0)
+      mixlib-config (>= 1.1.2)
+      mixlib-log (>= 1.2.0)
+      moneta
+      ohai (>= 0.5.7)
+      rest-client (>= 1.0.4, < 1.7.0)
+      uuidtools
+    crack (0.1.8)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
     diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    extlib (0.9.15)
+    forgery (0.3.6)
+    gherkin (2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    highline (1.6.1)
+    json (1.4.6)
     mime-types (1.16)
     mixlib-authentication (1.1.4)
       mixlib-log
+    mixlib-cli (1.2.0)
+    mixlib-config (1.1.2)
     mixlib-log (1.2.0)
+    moneta (0.6.0)
+    ohai (0.5.8)
+      extlib
+      json (>= 1.4.4, <= 1.4.6)
+      mixlib-cli
+      mixlib-config
+      mixlib-log
+      systemu
+    rcov (0.9.9)
     rest-client (1.6.1)
       mime-types (>= 1.16)
     rspec (2.4.0)
@@ -24,14 +69,31 @@ GEM
     rspec-expectations (2.4.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.4.0)
+    systemu (1.2.0)
+    term-ansicolor (1.0.5)
+    timecop (0.3.5)
+    uuidtools (2.1.1)
+    vcr (1.4.0)
+    webmock (1.6.1)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
     yajl-ruby (0.7.8)
+    yard (0.6.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  chef (= 0.9.12)
+  cucumber (~> 0.10.0)
+  forgery (~> 0.3.6)
   mixlib-authentication
+  rcov
   rest-client
-  rspec (= 2.4.0)
+  rspec (~> 2.4.0)
   spice!
+  timecop (~> 0.3.5)
+  vcr (~> 1.4.0)
+  webmock (~> 1.6.1)
   yajl-ruby
+  yard (~> 0.6.4)

data/README.md

@@ -1,8 +1,87 @@
-= spice
+# spice
 
-Description goes here.
+Spice is a zesty Chef API wrapper. It's primary purpose is to let you integrate your apps with a (Chef)[http://opscode.com/chef] server easily and succinctly.  Spice provides support for the (entire released Chef API)[http://wiki.opscode.com/display/chef/Server+API]
 
-== Contributing to spice
+## Installation
+
+Install this beast via Rubygems (note that for now, you'll need the --pre flag until I deem it to be perfectly stable):
+
+    gem install spice --pre
+    
+Of course, You can always grab the source from http://github.com/danryan/spice.
+
+## Configuration
+
+Spice has five configuration variables: 
+
+    Spice.host          # default: localhost
+    Spice.port          # default: 4000
+    Spice.scheme        # default: http
+    Spice.client_name   # default: nil. Must be set to a valid admin Chef client
+    Spice.key_file      # default: nil. Must be set to a file path
+
+To connect to a Chef server at https://chef.example.com:5000 with the "admin" API client, throw this somewhere your app can initialize:
+
+    Spice.host = "chef.example.com"
+    Spice.port = "5000"
+    Spice.scheme = "https"
+    Spice.client_name = "admin"
+    Spice.key_file = "/path/to/keyfile.pem"
+
+Say you had a Chef server (or Chef solo) running locally on port 4000 over HTTP, you only need to set your `client_name` and `key_file` path:
+
+    Spice.client_name = "admin"
+    Spice.key_file = "/path/to/keyfile.pem"
+
+
+You can also use the Spice.setup block if you prefer this style:
+
+    Spice.setup do |s|
+      s.host = "chef.example.com"
+      s.port = "5000"
+      s.scheme = "https"
+      s.client_name = "admin"
+      s.key_file = "/path/to/keyfile.pem"
+    end
+
+After you have configured Spice, we need to create the connection object you'll use to sign your requests and pass them to the Chef server:
+
+    Spice.connect!
+    
+If you want to reset your config to their default values:
+
+    Spice.reset!
+
+## Usage
+
+### Low-level use
+
+Setting up spice and running `Spice.connect!` creates a connection object that can then be used to send requests to your Chef server, accessed via `Spice.connection`.  
+
+Get a list of all clients:
+
+    Spice.connection.get("/clients")
+
+Get a specific node by the name "slappypants":
+
+    Spice.connection.get("/nodes/slappypants")
+    
+Create a new role called "awesome":
+
+    Spice.connection.post("/roles", :name => "awesome")
+
+Make the client "sweet" an admin:
+    
+    Spice.connection.put("/clients/sweet", :admin => true)
+    
+Scope out (the official Chef API docs)[http://wiki.opscode.com/display/chef/Server+API] for a full list of wicked awesome things you can do.
+
+## High-level use
+
+TODO
+
+
+## Contributing to spice
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -12,7 +91,7 @@ Description goes here.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2010 Dan Ryan. See LICENSE.txt for
 further details.

data/Rakefile

@@ -1,2 +1,21 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/TODO.md

@@ -0,0 +1,2 @@
+* Allow configurable variables instead of relying on class variables
+* Refactor classes that inherity from Spice::Chef to take config values

data/features/support/env.rb

@@ -11,3 +11,4 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'spice'
 
 require 'rspec/expectations'
+require 'webmock/cucumber'

data/lib/spice.rb

@@ -1,8 +1,9 @@
-require 'yajl/json_gem'
-require 'rest-client'
+require 'bundler'
+Bundler.require
 
 require 'spice/authentication'
 require 'spice/chef'
+require 'spice/role'
 
 require 'spice/client'
 require 'spice/cookbook'
@@ -11,4 +12,88 @@ require 'spice/node'
 require 'spice/connection'
 
 module Spice
+  class << self
+    attr_writer :host, :port, :scheme, :client_name, :connection, :key_file, :raw_key
+    
+    def default_host
+      @default_host || "localhost"
+    end
+    
+    def default_port
+      @default_port || "4000"
+    end
+    
+    def default_scheme
+      @default_scheme || "http"
+    end
+    
+    def host
+      @host || default_host
+    end
+    
+    def port
+      @port || default_port
+    end
+    
+    def scheme
+      @scheme || default_scheme
+    end
+    
+    def client_name
+      @client_name
+    end
+    
+    def key_file
+      @key_file
+    end
+    
+    def raw_key
+      @raw_key
+    end
+    
+    def key_file=(new_key_file)
+      raw_key = File.read(new_key_file)
+      assert_valid_key_format!(raw_key)
+      @key_file = new_key_file
+      @raw_key = raw_key
+    end
+    
+    def connection
+      @connection
+    end
+
+    def connect!
+      @connection = Connection.new(
+        :url => "#{scheme}://#{host}:#{port}", 
+        :client_name => client_name, 
+        :key_file => key_file
+      )
+    end
+    
+    
+    def reset!
+      @host = default_host
+      @port = default_port
+      @scheme = default_scheme
+      @key_file = nil
+      @client_name = nil
+      @connection = nil
+      puts "Spice is reset"
+    end
+    
+    def setup
+      yield self
+    end
+    
+    private
+    
+    def assert_valid_key_format!(raw_key)
+      unless (raw_key =~ /\A-----BEGIN RSA PRIVATE KEY-----$/) &&
+         (raw_key =~ /^-----END RSA PRIVATE KEY-----\Z/)
+        msg = "The file #{key_file} does not contain a correctly formatted private key.\n"
+        msg << "The key file should begin with '-----BEGIN RSA PRIVATE KEY-----' and end with '-----END RSA PRIVATE KEY-----'"
+        raise ArgumentError, msg
+      end
+    end
+  end
 end

data/lib/spice/authentication.rb

@@ -29,7 +29,7 @@ module Spice
     
     def load_signing_key
       begin
-        @raw_key = IO.read(key_file, :mode => "r").strip
+        @raw_key = File.read(key_file).strip
       rescue SystemCallError, IOError => e
         raise IOError, "Unable to read #{key_file}"
       end

data/lib/spice/chef.rb

@@ -1,42 +1,46 @@
 module Spice
   class Chef
-    attr_accessor :host, :client_name, :key_file, :port, :path, :scheme, :connection
+    attr_accessor :client_name, :key_file, :connection
     
-
-    def initialize(options={})
-      @@client_name ||= @client_name = options[:client_name]
-      @@key_file    ||= @key_file = options[:key_file]
-      @@host        ||= @host   = options[:host]   || 'localhost'
-      @@port        ||= @port   = options[:port]   || 4000
-      @@path        ||= @path   = options[:path]   || '/'
-      @@scheme      ||= @scheme = options[:scheme] || 'http'
-      @@connection  ||= @connection = Connection.new(
-                           :url => "#{@scheme}://#{@host}:#{@port}#{@path}", 
-                           :client_name => options[:client_name], 
-                           :key_file => options[:key_file]
-                         )
-      @default_headers = options[:headers] || {}
-      @sign_on_redirect, @sign_request = true, true       
-    end
-    
-    def connection
-      @@connection
-    end
+    # def initialize(options={})
+    #   @client_name = options[:client_name] || Spice.client_name
+    #   @key_file    = options[:key_file]    || Spice.key_file
+    #   @host        = options[:host]        || Spice.host        
+    #   @port        = options[:port]        || Spice.port
+    #   @scheme      = options[:scheme]      || Spice.scheme
+    #   # @connection  = Connection.new(
+    #   #                  :url => "#{@scheme}://#{@host}:#{@port}", 
+    #   #                  :client_name => options[:client_name], 
+    #   #                  :key_file => options[:key_file]
+    #   #                )                     || Spice.connection
+    #   @connection = Spice.connection
+    #   @sign_on_redirect, @sign_request = true, true       
+    # end
     
     def self.connection
-      @@connection
+      @connection ||= Spice.connection
     end
     
-    def clients
-      Client.all
-    end
+    class << self
+      def clients
+        Client.all
+      end
     
-    def nodes
-      Node.all
-    end
+      def nodes
+        Node.all
+      end
     
-    def data_bags
-      DataBag.all
+      def data_bags
+        DataBag.all
+      end
+      
+      def roles
+        Role.all
+      end
+      
+      def cookbooks
+        Cookbook.all
+      end
     end
   end
 end

data/lib/spice/client.rb

@@ -32,7 +32,7 @@ module Spice
     
     def self.delete(options={})
       name = options.delete(:name)
-      connection.delete("/clients/#{name}")
+      connection.delete("/clients/#{name}", options)
     end
   end
 end

data/lib/spice/connection.rb

@@ -1,8 +1,8 @@
-require 'rest-client'
+require 'yajl/json_gem'
 
 module Spice
   class Connection
-    attr_accessor :client_name, :key_file, :auth_credentials, :url, :path, :port, :scheme
+    attr_accessor :client_name, :key_file, :auth_credentials, :url, :path, :port, :scheme, :host
     
     def initialize(options={})
       endpoint          = URI.parse(options[:url])
@@ -45,12 +45,11 @@ module Spice
       JSON.parse(response)
     end
     
-    def delete(path, payload, headers={})
+    def delete(path, headers={})
       response = RestClient::Request.execute(
         :method => :DELETE,
         :url => "#{@url}#{path}",
-        :headers => build_headers(:DELETE, path, headers, JSON.generate(payload)),
-        :payload => JSON.generate(payload)
+        :headers => build_headers(:DELETE, path, headers)
       )
       JSON.parse(response)
     end