spice 0.2.0 → 0.3.0

data/.gitignore

@@ -1 +1,6 @@
 pkg/*
+examples/*
+doc/*
+doc/**/*
+.yardoc/**/*
+.yardoc/*

data/.rspec

@@ -1 +1 @@
---color
+--color --format doc

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Release Notes - Spice - Version 0.3.0
+
+## Bug
+
+* N/A
+
+## Improvement
+
+* Improved specification of DataBag class
+* Added additional documentation to DataBag class
+* Add CHANGELOG
+
+## New Feature
+
+* Data bag items can now be created
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spice (0.0.2.beta)
+    spice (0.2.0)
       mixlib-authentication
       rest-client
       yajl-ruby
@@ -43,7 +43,7 @@ GEM
     webmock (1.6.1)
       addressable (>= 2.2.2)
       crack (>= 0.1.7)
-    yajl-ruby (0.7.8)
+    yajl-ruby (0.7.9)
     yard (0.6.4)
 
 PLATFORMS
@@ -51,12 +51,9 @@ PLATFORMS
 
 DEPENDENCIES
   cucumber (~> 0.10.0)
-  mixlib-authentication
   rcov
-  rest-client
   rspec (~> 2.4.0)
   spice!
   timecop (~> 0.3.5)
   webmock (~> 1.6.1)
-  yajl-ruby
   yard (~> 0.6.4)

data/README.md

@@ -4,9 +4,9 @@ Spice is a zesty Chef API wrapper. It's primary purpose is to let you easily int
 
 ## Installation
 
-Install this beast via Rubygems (note that for now, you'll need the --pre flag until I deem it to be perfectly stable):
+Install this beast via Rubygems:
 
-    gem install spice --pre
+    gem install spice
     
 Of course, You can always grab the source from http://github.com/danryan/spice.
 

data/TODO.md

@@ -1,2 +1,2 @@
-* Allow configurable variables instead of relying on class variables
-* Refactor classes that inherity from Spice::Chef to take config values
+* Refactor classes that inherit from Spice::Chef to take config values
+* Add support for data bag item creation

data/lib/spice/chef.rb

@@ -2,21 +2,6 @@ module Spice
   class Chef
     attr_accessor :client_name, :key_file, :connection
     
-    # 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 ||= Spice.connection
     end

data/lib/spice/client.rb

@@ -24,19 +24,19 @@ module Spice
     
     def self.create(options={})
       raise ArgumentError, "Option :name must be present" unless options[:name]
-      connection.post("/clients", options)
+      connection.post("/clients", payload, options)
     end
     
     def self.update(options={})
       raise ArgumentError, "Option :name must be present" unless options[:name]
       name = options.delete(:name)
-      connection.put("/clients/#{name}", options)
+      connection.put("/clients/#{name}", payload, options)
     end
     
     def self.delete(options={})
       raise ArgumentError, "Option :name must be present" unless options[:name]
       name = options.delete(:name)
-      connection.delete("/clients/#{name}", options)
+      connection.delete("/clients/#{name}", payload, options)
     end
   end
 end

data/lib/spice/connection.rb

@@ -17,41 +17,49 @@ module Spice
     end
     
     def get(path, headers={})
-      response = RestClient::Request.execute(
-        :method => :GET,
-        :url => "#{@url}#{path}",
-        :headers => build_headers(:GET, path, headers)
-      )
-      JSON.parse(response)
+      begin
+        RestClient.get(
+          "#{@url}#{path}", 
+          build_headers(:GET, path, headers)
+        )
+      rescue => e
+        e.response
+      end
     end
     
     def post(path, payload, headers={})
-      response = RestClient::Request.execute(
-        :method => :POST,
-        :url => "#{@url}#{path}",
-        :headers => build_headers(:POST, path, headers, JSON.generate(payload)),
-        :payload => JSON.generate(payload)
-      )
-      JSON.parse(response)
+      begin
+        RestClient.post(
+          "#{@url}#{path}",
+          JSON.generate(payload),
+          build_headers(:POST, path, headers, JSON.generate(payload))
+        )
+      rescue => e
+        e.response
+      end
     end
     
     def put(path, payload, headers={})
-      response = RestClient::Request.execute(
-        :method => :PUT,
-        :url => "#{@url}#{path}",
-        :headers => build_headers(:PUT, path, headers, JSON.generate(payload)),
-        :payload => JSON.generate(payload)
-      )
-      JSON.parse(response)
+      begin
+        RestClient.put(
+          "#{@url}#{path}",
+          JSON.generate(payload),
+          build_headers(:PUT, path, headers, JSON.generate(payload))
+        )
+      rescue => e
+        e.response
+      end
     end
     
     def delete(path, headers={})
-      response = RestClient::Request.execute(
-        :method => :DELETE,
-        :url => "#{@url}#{path}",
-        :headers => build_headers(:DELETE, path, headers)
-      )
-      JSON.parse(response)
+      begin
+        RestClient.delete(
+          "#{@url}#{path}",
+          build_headers(:DELETE, path, headers)
+        )
+      rescue => e
+        e.response
+      end
     end  
     
     def sign_requests?

data/lib/spice/data_bag.rb

@@ -1,33 +1,132 @@
 module Spice
   class DataBag < Spice::Chef
+    # Get a list of all data bags in the following syntax
+    #     Spice::DataBag.all
+    #    
+    # @param [Hash] options the options hash. Currently does nothing
     def self.all(options={})
       connection.get("/data")
     end
     
+    # An alternative format for showing the contents of a data bag
+    # @example Retrieve the id and uri of items in a data bag called "users"
+    #   Spice::DataBag["users"] # => {"adam":"http://localhost:4000/data/users/adam"}
     def self.[](name)
       connection.get("/data/#{name}")
     end
     
+    # Show the contents of a data bag
+    # @example Retrieve the id and uri of items in a data bag called "users"
+    #   Spice::DataBag.show(:name => "users") # => {"adam":"http://localhost:4000/data/users/adam"}
+    # 
+    # @param [Hash] options The options hash
+    # @option options [String] :name The name of your data bag
     def self.show(options={})
       raise ArgumentError, "Option :name must be present" unless options[:name]
       name = options.delete(:name)
       connection.get("/data/#{name}")
     end
     
+    # Create a a new data bag
+    # 
+    # @example 
+    #   Spice::DataBag.create(:name => "users")
+    #
+    # @param [Hash] options the options hash from which to create a data bag
+    # @option options [String] :name The name of your data bag    
+    
     def self.create(options={})
       connection.post("/data", options)
     end
+
+    # Delete a data bag
+    # 
+    # @example 
+    #   Spice::DataBag.delete(:name => "users")
+    #
+    # @param [Hash] options the options hash from which to delete a data bag
+    # @option options [String] :name The name of your data bag    
+
+    def self.delete(options={})
+      raise ArgumentError, "Option :name must be present" unless options[:name]
+      name = options.delete(:name)
+      connection.delete("/data/#{name}", options)
+    end
+    
+    # Shows a data bag item
+    # 
+    # @example 
+    #   Spice::DataBag.show_item(:name => "users", :id => "adam")
+    #
+    # @param [Hash] options the options hash from which to create a data bag
+    # @option options [String] :name The name of your data bag    
+    # @option options [String] :id The id of the data bag item
     
-    def self.update(options={})
+    def self.show_item(options={})
       raise ArgumentError, "Option :name must be present" unless options[:name]
+      raise ArgumentError, "Option :id must be present" unless options[:id]
       name = options.delete(:name)
-      connection.put("/data/#{name}", options)
+      id = options.delete(:id)
+      connection.get("/data/#{name}/#{id}", options)
     end
     
-    def self.delete(options={})
+    # Creates a data bag item
+    # 
+    # @example 
+    #   Spice::DataBag.create_item(:name => "users", :id => "adam", :title => "Supreme Awesomer")
+    #
+    # @param [Hash] options the options hash from which to create a data bag
+    # @option options [String] :name The name of your data bag    
+    # @option options [String] :id The id of the data bag item
+    # 
+    # Any additional keys in the options hash will be used as attributes 
+    # to be stored in the data bag item
+    
+    def self.create_item(options={})
       raise ArgumentError, "Option :name must be present" unless options[:name]
+      raise ArgumentError, "Option :id must be present" unless options[:id]
       name = options.delete(:name)
-      connection.delete("/data/#{name}", options)
+      connection.post("/data/#{name}", options)   
+      
+    end
+    
+    # Update a data bag item
+    # 
+    # @example 
+    #   Spice::DataBag.update_item(:name => "users", :id => "adam", :title => "Supreme Awesomer")
+    #
+    # @param [Hash] options the options hash from which to update a data bag
+    # @option options [String] :name The name of your data bag    
+    # @option options [String] :id The id of the data bag item
+    # 
+    # Any additional keys in the options hash will be used as attributes 
+    # to be stored in the data bag item
+    
+    def self.update_item(options={})
+      raise ArgumentError, "Option :name must be present" unless options[:name]
+      raise ArgumentError, "Option :id must be present" unless options[:id]  
+      name = options.delete(:name)
+      id = options.delete(:id) 
+      connection.put("/data/#{name}/#{id}", options)   
+    end
+    
+    # Delete a data bag item
+    # 
+    # @example 
+    #   Spice::DataBag.delete_item(:name => "users", :id => "adam")
+    #
+    # @param [Hash] options the options hash from which to delete a data bag
+    # @option options [String] :name The name of your data bag    
+    # @option options [String] :id The id of the data bag item
+    #
+    
+    def self.delete_item(options={})
+      raise ArgumentError, "Option :name must be present" unless options[:name]
+      raise ArgumentError, "Option :id must be present" unless options[:id]
+      name = options.delete(:name)
+      id = options.delete(:id) 
+      connection.delete("/data/#{name}/#{id}", options)   
+         
     end
   end
 end

data/{spec/support/authentication.rb → lib/spice/mock.rb}

@@ -1,16 +1,17 @@
-require 'spec_helper'
+module Spice
+  class Mock
+    class << self
+      def setup_mock_client
+        self.setup_authentication
+        Spice.host = 'localhost'
+        Spice.client_name = "testclient"
+        Spice.key_file = "/tmp/keyfile.pem"
+        Spice.connect!
+      end
 
-def setup_chef_client
-  setup_authentication
-  Spice.host = 'localhost'
-  Spice.client_name = "testclient"
-  Spice.key_file = "/tmp/keyfile.pem"
-  Spice.connect!
-end
-
-def setup_authentication
-  File.open("/tmp/keyfile.pem","w+") do |f|
-    f.write(%Q{-----BEGIN RSA PRIVATE KEY-----
+      def setup_authentication
+        File.open("/tmp/keyfile.pem","w+") do |f|
+          f.write(%Q{-----BEGIN RSA PRIVATE KEY-----
 MIIEowIBAAKCAQEAqd1K3siOLkxiU0B98QzP+qbT3uPaCIGGR+EAO8mXMpTUNfPv
 Kr4NeIV8kqfrngghYF3Y2Ky0e3Ifl3b7UQTfrSofmyoC/EBBA4dH2ygUoYtP0aIi
 sdxnSpYhX9PXavZ4POkDuO3SKRUEuC71OzIQQ3GijXA8L1JRBTOb0QiC7vBSuwaM
@@ -37,6 +38,8 @@ mZ2vo9R9MYFQe8sv1sHwENk0zby+44afVjt5IkElFC1IWBkcKte99T+POXzu3lyb
 5h0uCkb5FfgWIOq2tCUYY/ZrSglE17wPmd8iRAN7wb+prKAHOh+o4P0k1EtviNdU
 8JgshucQzoeIygNfo2QG3vfsfA/4V9aa/yb/bqHPsJHBgnuSVjv+
 -----END RSA PRIVATE KEY-----})
+        end
+      end
+    end
   end
-end
-
+end

data/lib/spice/version.rb

@@ -1,3 +1,3 @@
 module Spice
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/spice.rb

@@ -1,6 +1,7 @@
 require 'bundler'
 Bundler.require
 
+require 'rest-client'
 require 'spice/authentication'
 require 'spice/chef'
 require 'spice/role'
@@ -11,7 +12,10 @@ require 'spice/data_bag'
 require 'spice/node'
 require 'spice/connection'
 
+require 'spice/mock'
+
 module Spice
+  
   class << self
     attr_writer :host, :port, :scheme, :client_name, :connection, :key_file, :raw_key
     
@@ -85,6 +89,10 @@ module Spice
       yield self
     end
     
+    def mock
+      Spice::Mock.setup_mock_client
+    end
+    
     private
     
     def assert_valid_key_format!(raw_key)

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ Bundler.require
 require 'rspec'
 require 'webmock/rspec'
 require 'timecop'
+require 'rest-client'
 require 'spice'
 
 # Requires supporting files with custom matchers and macros, etc,
@@ -15,6 +16,7 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.before do
     Timecop.freeze
+    Spice.mock
   end
   config.after do
     Timecop.return

data/spec/spice/chef_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Spice
   describe Chef do
     describe '.connection' do
-      before { setup_chef_client }
+      before {  }
       it "returns an instance of Spice::Connection" do
         Spice::Chef.connection.should be_an_instance_of(Spice::Connection)
       end

data/spec/spice/client_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Spice
   describe Client do
     describe ".all" do
-      before { setup_chef_client }
+      before {  }
 
       it "returns a list of clients" do
         stub_client_list
@@ -38,7 +38,7 @@ module Spice
     end
 
     describe ".create" do
-      before { setup_chef_client }
+      before {  }
 
       context "valid" do
         it "creates a valid non-admin client" do
@@ -70,7 +70,7 @@ module Spice
     end
 
     describe ".update" do
-      before { setup_chef_client }
+      before {  }
 
       context "valid" do
         it "makes a client an admin" do
@@ -86,7 +86,7 @@ module Spice
     end
 
     describe ".delete" do
-      before { setup_chef_client }
+      before {  }
 
       context "valid" do
         it "deletes a client" do

data/spec/spice/cookbook_spec.rb

@@ -3,32 +3,109 @@ require 'spec_helper'
 module Spice
   describe Cookbook do
     describe ".all" do
-      VCR.use_cassette 'cookbook/list', :record => :new_episodes do
-        Cookbook.list
+      before { setup_chef_cookbook }
+
+      it "returns a list of cookbooks" do
+        stub_cookbook_list
+        Cookbook.all.length.should == 1
       end
     end
-    
+
     describe ".show" do
-      VCR.use_cassette 'cookbook/show', :record => :new_episodes do
-        Cookbook.show(:name => "testcookbook")
+      before { setup_chef_cookbook }
+      
+      context "valid" do
+        it "returns a valid cookbook" do
+          stub_cookbook_show("monkeypants")
+          cookbook = Cookbook.show(:name => "monkeypants")
+          cookbook["name"].should == "monkeypants"
+          cookbook["admin"].should == true
+        end
+      end
+      
+      context "errors" do
+        it "return a 404 when a cookbook is not found" do
+          stub_cookbook_show("applesauce", 404)
+          lambda { Cookbook.show(:name => "applesauce") }.
+            should raise_error(RestCookbook::ResourceNotFound)
+        end
+        
+        it "raises ArgumentError if option :name not present" do
+          stub_cookbook_show("pizza")
+          lambda {Cookbook.show() }.should raise_error ArgumentError
+        end
       end
     end
-    
+
     describe ".create" do
-      VCR.use_cassette 'cookbook/create', :record => :new_episodes do
-        Cookbook.create(:name => "testcookbook")
+      before { setup_chef_cookbook }
+
+      context "valid" do
+        it "creates a valid non-admin cookbook" do
+          stub_cookbook_create("spork")
+          cookbook = Cookbook.create(:name => "spork", :admin => false)
+          cookbook["private_key"].should == "RSA PRIVATE KEY"
+          cookbook["uri"].should == "http://http://localhost:4000/cookbooks/spork"
+        end
+        
+        it "creates a valid admin cookbook" do
+          stub_cookbook_create("pants", true)
+          response = Cookbook.create(:name => "pants", :admin => true)
+          response["private_key"].should == "RSA PRIVATE KEY"
+          response["uri"].should == "http://http://localhost:4000/cookbooks/pants"
+
+          stub_cookbook_show("pants")
+          cookbook = Cookbook.show(:name => "pants")
+          cookbook["admin"].should == true
+        end
+      end
+      
+      context "errors" do
+        it "does not create a cookbook that already exists" do
+          stub_cookbook_create("pants", false, 409)
+          lambda { Cookbook.create(:name => "pants", :admin => false) }.
+            should raise_error(RestCookbook::Conflict)
+        end
       end
     end
-    
+
     describe ".update" do
-      VCR.use_cassette 'cookbook/update', :record => :new_episodes do
-        Cookbook.update(:name => "testcookbook")
+      before { setup_chef_cookbook }
+
+      context "valid" do
+        it "makes a cookbook an admin" do
+          stub_cookbook_update("awesome", true, false, 200)
+          Cookbook.update(:name => "awesome", :admin => true, :private_key => false)
+        end
+        
+        it "regenerates the cookbook private key" do
+          stub_cookbook_update("awesome", false, true, 200)
+          Cookbook.update(:name => "awesome", :admin => false, :private_key => true)
+        end
       end
     end
-    
+
     describe ".delete" do
-      VCR.use_cassette 'cookbook/delete', :record => :new_episodes do
-        Cookbook.delete(:name => "testcookbook")
+      before { setup_chef_cookbook }
+
+      context "valid" do
+        it "deletes a cookbook" do
+          stub_cookbook_delete("spork")
+          Cookbook.delete(:name => "spork")
+        end
+      end
+      
+      context "errors" do
+        it "raises ArgumentError if option :name not present" do
+          stub_cookbook_delete("pizza")
+          lambda {Cookbook.delete }.should raise_error ArgumentError
+        end
+        
+        it "does not delete a non-existent cookbook" do
+          stub_cookbook_delete("spork", 404)
+          lambda { Cookbook.delete(:name => "spork") }.
+            should raise_error(RestCookbook::ResourceNotFound)
+        end
       end
     end
   end