spice 1.0.0.rc → 1.0.0

data/.gitignore

@@ -7,3 +7,5 @@ doc/**/*
 .yardoc/*
 Gemfile.lock
 fixture.rb
+coverage
+wiki

data/Gemfile

@@ -2,20 +2,6 @@ source "http://rubygems.org"
 
 gemspec
 
-group :development, :test do
-  gem 'rake'
-  gem 'rspec', '>= 2.8.0'
-  gem "webmock", ">= 1.7.10"
-  gem "timecop", ">= 0.3.5"
-  gem 'fakefs', '>= 0.3.2'
-  gem 'guard', '>= 0.10.0'
-  gem 'guard-rspec', '>= 0.6.0'
-  gem 'guard-spork', '>= 0.5.1'
-  gem 'spork', '>= 0.9.0.rc9'
-  gem 'rb-fsevent', '>= 0.4.3.1'
-  gem 'growl', '>= 1.0.3'
-end
-
 group :doc do
   gem 'yard'
   gem 'redcarpet'

data/README.md

@@ -24,7 +24,7 @@ Explicitly setting a `host`, `port`, and `scheme` value has been removed in favo
 
 ### Hat tip
 
-Spice is very heavily inspired by the [Twitter gem](http://github.com/jnunemaker/twitter). Mad props to those folks.
+The design and organization of Spice is very heavily inspired by the [Twitter gem](http://github.com/jnunemaker/twitter). Mad props to those folks.
 
 ## Contributing to spice
  

data/Rakefile

@@ -18,11 +18,11 @@ task :spork do
   sh %{bundle exec spork}
 end
 
-
 Bundler.require(:doc)
 desc "Generate documentation"
 YARD::Rake::YardocTask.new do |t|
   t.files = [ 'lib/**/*.rb' ]
+  t.options = [ "--markup-provider=redcarpet", "--markup=markdown" ]
 end
 
 desc "Generate docs"

data/TODO.md

@@ -1,2 +1,3 @@
 * Refactor classes that inherit from Spice::Chef to take config values
-* Add support for data bag item creation
+* Add support for data bag item creation
+* implement GET /cookbooks?num_versions=all

data/lib/spice.rb

@@ -1,81 +1,56 @@
-require 'virtus'
-require 'aequitas'
-require 'active_model/callbacks'
-require 'active_support/core_ext/hash/deep_merge'
-require 'active_support/core_ext/hash/keys'
-require 'mixlib/authentication'
+require 'spice/core_ext/mash'
 
 require 'spice/config'
-require 'spice/error'
-require 'spice/authentication'
-
-require 'spice/role'
-require 'spice/client'
-require 'spice/cookbook'
-require 'spice/cookbook_version'
-require 'spice/data_bag'
-require 'spice/data_bag_item'
-require 'spice/node'
-require 'spice/environment'
 require 'spice/connection'
 
-require 'spice/connection/clients'
-require 'spice/connection/cookbooks'
-require 'spice/connection/data_bags'
-require 'spice/connection/environments'
-require 'spice/connection/nodes'
-require 'spice/connection/roles'
-require 'spice/connection/search'
-
-require 'spice/version'
-require 'spice/mock'
-
 module Spice
-  extend Config
-  extend self
+  extend Spice::Config
   
-  extend Spice::Connection::Clients
-  extend Spice::Connection::Cookbooks
-  extend Spice::Connection::DataBags
-  extend Spice::Connection::Environments
-  extend Spice::Connection::Nodes
-  extend Spice::Connection::Roles
-  extend Spice::Connection::Search
+  class << self
+    # Convience alias for Spice::Connection.new
+    #
+    # return [Spice::Connection]
+    def new(options=Mash.new)
+      Spice::Connection.new(options)
+    end # def new
     
-  def connection
-    @connection ||= Connection.new(
-      :server_url => server_url,
-      :client_name => client_name,
-      :key_file => key_file
-    )
-  end
-
-  def mock
-    Spice::Mock.setup_mock_client
-  end
-
-  # def autoconfigure!(path=nil)
-  #   path ||= "~/.chef/"
-  #   knife = File.exist?("~/.chef/knife.rb") && File.expand_path(path + "~/.chef/knife.rb")
-  #   client = File.exist?("/etc/chef/client.rb") && File.expand_path("/etc/chef/client.rb")
-  #   
-  #   if knife
-  #     raw_config = IO.read(knife)
-  #   elsif
-  #     raw_config = IO.read(client)
-  #   end
-  #   
-  #   @values = {}
-  #   raw_config.each_line do |line|
-  #     if line =~ /^chef_server_url.*/
-  #       @values[:chef_server_url] = parse_line(line)
-  #     elsif line =~ /^node_name.*/
-  #       @values[:node_name] = parse_line(line)
-  #     elsif line =~ /^client_key.*/
-  #       @values[:client_key] = parse_line(line)
-  #     end
-  #   end
-  # end
+    # Delegate methods to Spice::Connection
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end # def method_missing
+    
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end # def respond_to?
+    
+    def mock
+      Spice.server_url = 'http://localhost:4000'
+      Spice.client_name = "testclient"
+      Spice.client_key = Spice.read_key_file(File.expand_path("../../spec/fixtures/client.pem", __FILE__))
+      Spice.chef_version = "0.10.10"
+      self
+    end # def mock
+    
+    def read_key_file(key_file_path)
+
+      begin
+        raw_key = File.read(key_file_path).strip
+      rescue SystemCallError, IOError => e
+        raise IOError, "Unable to read #{key_file_path}"
+      end
+      
+      begin_rsa = "-----BEGIN RSA PRIVATE KEY-----"
+      end_rsa   = "-----END RSA PRIVATE KEY-----"
+      
+      unless (raw_key =~ /\A#{begin_rsa}$/) && (raw_key =~ /^#{end_rsa}\Z/)
+        msg = "The file #{key_file} is not a properly formatted private key.\n"
+        msg << "It must contain '#{begin_rsa}' and '#{end_rsa}'"
+        raise ArgumentError, msg
+      end
+      return OpenSSL::PKey::RSA.new(raw_key)
+    end # def read_key_file
     
+  end # class << self
+end # module Spice
 
-end

data/lib/spice/authentication.rb

@@ -1,52 +1,30 @@
 require 'openssl'
+# require 'mixlib/authentication'
 require 'mixlib/authentication/signedheaderauth'
 
 module Spice
-  class Authentication
-    attr_reader :key_file, :client_name, :key, :raw_key
+  module Authentication
     
-    def initialize(client_name=nil, key_file=nil)
-      @client_name, @key_file = client_name, key_file
-      load_signing_key if sign_requests?
-    end
-    
-    def sign_requests?
-      !!key_file
-    end
-        
-    def signature_headers(request_params={})
-      request_params             = request_params.dup
-      request_params[:timestamp] = Time.now.utc.iso8601
-      request_params[:user_id]   = client_name
-      host = request_params.delete(:host) || "localhost"
+    def signature_headers(method, path, json_body=nil)
+      uri = URI(server_url)
       
-      sign_obj = Mixlib::Authentication::SignedHeaderAuth.signing_object(request_params)
-      signed = sign_obj.sign(key).merge({:host => host})
-      signed.inject({}){|memo, kv| memo["#{kv[0].to_s.upcase}"] = kv[1];memo}
+      params = {
+        :http_method => method, 
+        :path        => path,
+        :body        => json_body || "", 
+        :host        => "#{uri.host}:#{uri.port}",
+        :timestamp   => Time.now.utc.iso8601,
+        :user_id     => client_name
+      }
+
+      signing_object = Mixlib::Authentication::SignedHeaderAuth.signing_object(params)
+      signed_headers = signing_object.sign(client_key)
+
       # Platform requires X-Chef-Version header
-      version = { "X-Chef-Version" => Spice.chef_version }
-      signed.merge!(version)      
-    end
-    
-    private
-    
-    def load_signing_key
-      begin
-        @raw_key = File.read(key_file).strip
-      rescue SystemCallError, IOError => e
-        raise IOError, "Unable to read #{key_file}"
-      end
-      assert_valid_key_format!(@raw_key)
-      @key = OpenSSL::PKey::RSA.new(@raw_key)
-    end
-    
-    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
+      signed_headers['X-Chef-Version'] = chef_version
+      # signed_headers['Content-Length'] = json_body.bytesize.to_s if json_body
+      signed_headers
+    end # def signature_headers   
+     
+  end # module Authentication
+end # module Spice

data/lib/spice/base.rb

@@ -0,0 +1,104 @@
+require 'spice/identity_map'
+
+module Spice
+  class Base
+    attr_accessor :attrs
+    alias :to_hash :attrs
+    
+    @@identity_map = IdentityMap.new
+
+    def self.identity_map
+      @@identity_map
+    end # def self.identity_map
+    
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @overload self.attr_reader(attr)
+    #   @param attr [Symbol]
+    # @overload self.attr_reader(attrs)
+    #   @param attrs [Array<Symbol>]
+    def self.attr_reader(*attrs)
+      attrs.each do |attribute|
+        class_eval do
+          define_method attribute do
+            @attrs[attribute.to_s]
+          end
+          define_method "#{attribute}=" do |value|
+            @attrs[attribute.to_s] = value
+          end
+        end
+      end
+    end # def self.attr_reader
+    
+    def self.get(attrs=Mash.new)
+      @@identity_map[self] ||= {}
+      if attrs['name']
+        @@identity_map[self][attrs['name']] && @@identity_map[self][attrs['name']].update(attrs)
+      elsif attrs['id']
+        @@identity_map[self][attrs['id']] && @@identity_map[self][attrs['id']].update(attrs)
+      else
+        @@identity_map[self][Marshal.dump(attrs)]
+      end
+    end # def self.get
+
+    # Retrieve an object from the identity map or initialize a new object
+    def self.get_or_new(attrs=Mash.new)
+      self.get(attrs) || self.new(attrs)
+    end # def self.get_or_new
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @return [Spice::Base]
+    def initialize(attrs=Mash.new)
+      self.class.attr_reader *attrs.keys
+      attrs.stringify_keys!
+      if attrs['name']
+        self.update(attrs)
+        @@identity_map[self.class] ||= {}
+        @@identity_map[self.class][attrs['name']] = self
+      elsif attrs['id']
+        self.update(attrs)
+        @@identity_map[self.class] ||= {}
+        @@identity_map[self.class][attrs['id']] = self
+      else
+        self.update(attrs)
+        @@identity_map[self.class] ||= {}
+        @@identity_map[self.class][Marshal.dump(attrs)] = self
+      end
+    end # def initialize
+
+    # Fetches an attribute of an object using hash notation
+    #
+    # @param method [String, Symbol] Message to send to the object
+    def [](method)
+      self.__send__(method.to_sym)
+    rescue NoMethodError
+      nil
+    end # def []
+
+    # Update the attributes of an object
+    #
+    # @param attrs [Hash]
+    # @return [Spice::Base]
+    def update(attrs)
+      @attrs = attrs
+      self
+    end # def update
+
+    # @return [Integer]
+    def id
+      @attrs['id']
+    end # def id
+    
+    # @return [String]
+    def name
+      @attrs['name']
+    end # def name
+    
+    def keys
+      @attrs.keys
+    end # def keys
+    
+  end
+end

data/lib/spice/client.rb

@@ -1,55 +1,15 @@
-require 'spice/persistence'
+require 'spice/base'
 
 module Spice
-  class Client
-    include Virtus
-    include Aequitas
-    include Spice::Persistence
-    extend Spice::Persistence
+  class Client < Base
+    attr_reader :name, :public_key, :private_key, :_rev, :admin
     
-    endpoint "clients"
-    
-    # @macro [attach] attribute
-    # @attribute [rw]
-    # @return [$2] the $1 attribute
-    attribute :name, String
-    attribute :public_key, String
-    attribute :private_key, String
-    attribute :_rev, String
-    attribute :json_class, String, :default => "Chef::ApiClient"
-    attribute :admin, Boolean, :default => false
-    attribute :chef_type, String, :default => "client"
-    
-    validates_presence_of :name, :json_class, :chef_type
-
-    after_create :wat
-    def wat
-      puts "WAT"
-    end
-    
-    def do_post
-      response = connection.post("/clients", :name => name)
-      update_attributes(response.body)
-      response = connection.get("/clients/#{name}")
-      update_attributes(response.body)
-    end
-    
-    def do_put
-      response = connection.put("/clients/#{name}", attributes)
+    def initialize(attrs=Mash.new)
+      super
+      @attrs['json_class'] ||= "Chef::ApiClient"
+      @attrs['chef_type'] ||= 'client'
+      @attrs['admin'] ||= false
     end
 
-    def self.get(name)
-      connection.client(name)
-    end
-    
-    # Check if the client exists on the Chef server
-    def new_record?
-      begin
-        connection.get("/clients/#{name}")
-        return false
-      rescue Spice::Error::NotFound
-        return true
-      end
-    end
   end
 end

data/lib/spice/config.rb

@@ -1,12 +1,16 @@
+require 'faraday'
+require 'spice/response/parse_json'
+require 'spice/response/client_error'
 require 'spice/version'
 
 module Spice
   module Config
+
     # The default Chef server URL
     DEFAULT_SERVER_URL = "http://localhost:4000"
     
     # The default Chef version (changing this will enable disable certain features)
-    DEFAULT_CHEF_VERSION = "0.10.8"
+    DEFAULT_CHEF_VERSION = "0.10.10"
     
     # The default Spice User-Agent header
     DEFAULT_USER_AGENT = "Spice #{Spice::VERSION}"
@@ -14,17 +18,31 @@ module Spice
     # Default connection options
     DEFAULT_CONNECTION_OPTIONS = {}
     
+    # Default client name
+    DEFAULT_CLIENT_NAME = ""
+    
+    # Default key file
+    DEFAULT_CLIENT_KEY = ""
+    
     # An array of valid config options
+    
     VALID_OPTIONS_KEYS = [
       :server_url,
       :client_name,
-      :key_file,
-      :raw_key,
+      :client_key,
       :chef_version,
       :user_agent,
-      :connection_options
+      :connection_options,
+      :middleware
     ]
     
+    # Default middleware stack
+    DEFAULT_MIDDLEWARE = Proc.new do |builder|
+      builder.use Spice::Response::ParseJSON
+      builder.use Spice::Response::ClientError
+      builder.adapter Faraday.default_adapter
+    end
+    
     VALID_OPTIONS_KEYS.each do |key|
       attr_accessor key
     end
@@ -32,40 +50,40 @@ module Spice
     # Reset all config options to default when the module is extended
     def self.extended(base)
       base.reset
-    end
+    end # def self.extended
     
     # Convenience method to configure Spice in a block
     # @example Configuring spice
     #   Spice.setup do |s|
     #     s.server_url  = "http://chef.example.com:4000"
     #     s.client_name = "admin"
-    #     s.key_file    = "/home/admin/.chef/admin.pem"
+    #     s.client_key    = Spice.read_key_file("/path/to/key_file.pem")
     #   end
     # @yieldparam Spice
-    # @yieldreturn Spice    
-    
+    # @yieldreturn Spice
     def setup
       yield self
       self
-    end
+    end # def setup
     
     # Create an options hash from valid options keys
     def options
       options = {}
       VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
       options
-    end
+    end # def options
     
     # Reset all config options to their defaults
     def reset
-      self.user_agent = DEFAULT_USER_AGENT
-      self.server_url = DEFAULT_SERVER_URL
-      self.chef_version = DEFAULT_CHEF_VERSION
-      self.client_name = nil
-      self.key_file = nil
-      self.raw_key = nil
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.server_url         = DEFAULT_SERVER_URL
+      self.chef_version       = DEFAULT_CHEF_VERSION
+      self.client_name        = DEFAULT_CLIENT_NAME
+      self.client_key         = DEFAULT_CLIENT_KEY
       self.connection_options = DEFAULT_CONNECTION_OPTIONS
-    end
+      self.middleware         = DEFAULT_MIDDLEWARE
+      self
+    end # def reset
     
-  end
-end
+  end # module Config
+end # module Spice