chef-api 0.2.0 → 0.2.1

data/spec/unit/errors_spec.rb

@@ -0,0 +1,294 @@
+require 'spec_helper'
+
+module ChefAPI::Error
+  describe ChefAPIError do
+    let(:instance) { described_class.new }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          Oh no! Something really bad happened. I am not sure what actually happened because this is the catch-all error, but you should most definitely report an issue on GitHub at https://github.com/sethvargo/chef-api.
+        EOH
+      }
+    end
+  end
+
+  describe AbstractMethod do
+    let(:instance) { described_class.new(method: 'Resource#load') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          'Resource#load' is an abstract method. You must override this method in your subclass with the proper implementation and logic. For more information, please see the inline documentation for Resource#load. If you are not a developer, this is most likely a bug in the ChefAPI gem. Please file a bug report at:
+
+              https://github.com/sethvargo/chef-api/issues/new
+
+          and include the command(s) or code you ran to arrive at this error.
+        EOH
+      }
+    end
+  end
+
+  describe CannotRegenerateKey do
+    let(:instance) { described_class.new }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          You attempted to regenerate the private key for a Client or User that does not yet exist on the remote Chef Server. You can only regenerate the key for an object that is persisted. Try saving this record this object before regenerating the key.
+        EOH
+      }
+    end
+  end
+
+  describe FileNotFound do
+    let(:instance) { described_class.new(path: '/path/to/file.rb') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          I could not find a file at '/path/to/file.rb'. Please make sure you have typed the path correctly and that the resource exists at the given path.
+        EOH
+      }
+    end
+  end
+
+  describe HTTPBadRequest do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The Chef Server did not understand the request because it was malformed.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe HTTPForbiddenRequest do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The Chef Server actively refused to fulfill the request.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe HTTPGatewayTimeout do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The Chef Server did not respond in an adequate amount of time.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe HTTPMethodNotAllowed do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          That HTTP method is not allowed on this URL.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe HTTPNotAcceptable do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The Chef Server identified this request as unacceptable. This usually means you have not specified the correct Accept or Content-Type headers on the request.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe HTTPNotFound do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The requested URL does not exist on the Chef Server.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe HTTPServerUnavailable do
+    let(:instance) { described_class.new }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The Chef Server is currently unavailable or is not currently accepting client connections. Please ensure the server is accessible via ping or telnet on your local network. If this error persists, please contact your network administrator.
+        EOH
+      }
+    end
+  end
+
+  describe HTTPUnauthorizedRequest do
+    let(:instance) { described_class.new(message: 'Something happened...') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The Chef Server requires authorization. Please ensure you have specified the correct client name and private key. If this error continues, please verify the given client has the proper permissions on the Chef Server.
+
+              Something happened...
+        EOH
+      }
+    end
+  end
+
+  describe InsufficientFilePermissions do
+    let(:instance) { described_class.new(path: '/path/to/file.rb') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          I cannot read the file at '/path/to/file.rb' because the permissions on the file do not permit it. Please ensure the file has the correct permissions and that this Ruby process is running as a user with access to that path.
+        EOH
+      }
+    end
+  end
+
+  describe InvalidResource do
+    let(:instance) { described_class.new(errors: 'Missing a thing!') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          There were errors saving your resource: Missing a thing!
+        EOH
+      }
+    end
+  end
+
+  describe InvalidValidator do
+    let(:instance) { described_class.new(key: 'bacon') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          'bacon' is not a valid validator. Please make sure it is spelled correctly and that the constant is properly defined. If you are using a custom validator, please ensure the validator extends ChefAPI::Validator::Base and is a subclass of ChefAPI::Validator.
+        EOH
+      }
+    end
+  end
+
+  describe MissingURLParameter do
+    let(:instance) { described_class.new(param: 'user') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The required URL parameter 'user' was not present. Please specify the parameter as an option, like Resource.new(id, user: 'value').
+        EOH
+      }
+    end
+  end
+
+  describe NotADirectory do
+    let(:instance) { described_class.new(path: '/path/to/directory') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The given path '/path/to/directory' is not a directory. Please make sure you have passed the path to a directory on disk.
+        EOH
+      }
+    end
+  end
+
+  describe ResourceAlreadyExists do
+    let(:instance) { described_class.new(type: 'client', id: 'bacon') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The client 'bacon' already exists on the Chef Server. Each client must have a unique identifier and the Chef Server indicated this client already exists. If you are trying to update the client, consider using the 'update' method instead.
+        EOH
+      }
+    end
+  end
+
+  describe ResourceNotFound do
+    let(:instance) { described_class.new(type: 'client', id: 'bacon') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          There is no client with an id of 'bacon' on the Chef Server. If you are updating the client, please make sure the client exists and has the correct Chef identifier (primary key).
+        EOH
+      }
+    end
+  end
+
+  describe ResourceNotMutable do
+    let(:instance) { described_class.new(type: 'client', id: 'bacon') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The client 'bacon' is not mutable. It may be locked by the remote Chef Server, or the Chef Server may not permit modifying the resource.
+        EOH
+      }
+    end
+  end
+
+  describe UnknownAttribute do
+    let(:instance) { described_class.new(attribute: 'name') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          'name' is not a valid attribute!
+        EOH
+      }
+    end
+  end
+end

data/spec/unit/resources/client_spec.rb

@@ -2,22 +2,6 @@ require 'spec_helper'
 
 module ChefAPI
   describe Resource::Client do
-    describe '.from_file' do
-      it 'raises a permission error when Ruby cannot read the file' do
-        File.stub(:read).and_raise(Errno::EACCES)
-        expect {
-          described_class.from_file('client.pem')
-        }.to raise_error(Error::InsufficientFilePermissions)
-      end
-
-      it 'raises an error when the file does not exist' do
-        File.stub(:read).and_raise(Errno::ENOENT)
-        expect {
-          described_class.from_file('client.pem')
-        }.to raise_error(Error::FileNotFound)
-      end
-    end
-
     describe '.initialize' do
       it 'converts an x509 certificate to a public key' do
         certificate = <<-EOH.gsub(/^ {10}/, '')

data/spec/unit/resources/connection_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Connection do
+    shared_examples 'a proxy for' do |resource, klass|
+      context "##{resource}" do
+        it 'sets Thread.current to self' do
+          subject.send(resource)
+          expect(Thread.current['chefapi.connection']).to be(subject)
+        end
+
+        it "returns an instance of #{klass}" do
+          # Fuck you Ruby 1.9.3
+          expected = klass.split('::').inject(ChefAPI) { |c, i| c.const_get(i) }
+
+          expect(subject.send(resource)).to be(expected)
+        end
+      end
+    end
+
+    it_behaves_like 'a proxy for', :clients,      'Resource::Client'
+    it_behaves_like 'a proxy for', :data_bags,    'Resource::DataBag'
+    it_behaves_like 'a proxy for', :environments, 'Resource::Environment'
+    it_behaves_like 'a proxy for', :nodes,        'Resource::Node'
+    it_behaves_like 'a proxy for', :principals,   'Resource::Principal'
+    it_behaves_like 'a proxy for', :roles,        'Resource::Role'
+    it_behaves_like 'a proxy for', :users,        'Resource::User'
+
+    context '#initialize' do
+      context 'when options are given' do
+        let(:endpoint) { 'http://endpoint.gov' }
+
+        it 'sets the option' do
+          instance = described_class.new(endpoint: endpoint)
+          expect(instance.endpoint).to eq(endpoint)
+        end
+
+        it 'uses the default options' do
+          instance = described_class.new
+          expect(instance.endpoint).to eq(ChefAPI.endpoint)
+        end
+      end
+
+      context 'when a block is given' do
+        it 'yields self' do
+          expect { |b| described_class.new(&b) }.to yield_with_args(described_class)
+        end
+      end
+    end
+  end
+end

data/templates/errors/abstract_method.erb

@@ -0,0 +1,5 @@
+'<%= @method %>' is an abstract method. You must override this method in your subclass with the proper implementation and logic. For more information, please see the inline documentation for <%= @method %>. If you are not a developer, this is most likely a bug in the ChefAPI gem. Please file a bug report at:
+
+    https://github.com/sethvargo/chef-api/issues/new
+
+and include the command(s) or code you ran to arrive at this error.

data/templates/errors/cannot_regenerate_key.erb

@@ -0,0 +1 @@
+You attempted to regenerate the private key for a Client or User that does not yet exist on the remote Chef Server. You can only regenerate the key for an object that is persisted. Try saving this record this object before regenerating the key.

data/templates/errors/chef_api_error.erb

@@ -0,0 +1 @@
+Oh no! Something really bad happened. I am not sure what actually happened because this is the catch-all error, but you should most definitely report an issue on GitHub at https://github.com/sethvargo/chef-api.

data/templates/errors/file_not_found.erb

@@ -0,0 +1 @@
+I could not find a file at '<%= @path %>'. Please make sure you have typed the path correctly and that the resource exists at the given path.

data/templates/errors/http_bad_request.erb

@@ -0,0 +1,3 @@
+The Chef Server did not understand the request because it was malformed.
+
+    <%= @message %>

data/templates/errors/http_forbidden_request.erb

@@ -0,0 +1,3 @@
+The Chef Server actively refused to fulfill the request.
+
+    <%= @message %>

data/templates/errors/http_gateway_timeout.erb

@@ -0,0 +1,3 @@
+The Chef Server did not respond in an adequate amount of time.
+
+    <%= @message %>

data/templates/errors/http_method_not_allowed.erb

@@ -0,0 +1,3 @@
+That HTTP method is not allowed on this URL.
+
+    <%= @message %>

data/templates/errors/http_not_acceptable.erb

@@ -0,0 +1,3 @@
+The Chef Server identified this request as unacceptable. This usually means you have not specified the correct Accept or Content-Type headers on the request.
+
+    <%= @message %>

data/templates/errors/http_not_found.erb

@@ -0,0 +1,3 @@
+The requested URL does not exist on the Chef Server.
+
+    <%= @message %>

data/templates/errors/http_server_unavailable.erb

@@ -0,0 +1 @@
+The Chef Server is currently unavailable or is not currently accepting client connections. Please ensure the server is accessible via ping or telnet on your local network. If this error persists, please contact your network administrator.

data/templates/errors/http_unauthorized_request.erb

@@ -0,0 +1,3 @@
+The Chef Server requires authorization. Please ensure you have specified the correct client name and private key. If this error continues, please verify the given client has the proper permissions on the Chef Server.
+
+    <%= @message %>

data/templates/errors/insufficient_file_permissions.erb

@@ -0,0 +1 @@
+I cannot read the file at '<%= @path %>' because the permissions on the file do not permit it. Please ensure the file has the correct permissions and that this Ruby process is running as a user with access to that path.

data/templates/errors/invalid_resource.erb

@@ -0,0 +1 @@
+There were errors saving your resource: <%= @errors %>

data/templates/errors/invalid_validator.erb

@@ -0,0 +1 @@
+'<%= @key %>' is not a valid validator. Please make sure it is spelled correctly and that the constant is properly defined. If you are using a custom validator, please ensure the validator extends ChefAPI::Validator::Base and is a subclass of ChefAPI::Validator.

data/templates/errors/missing_url_parameter.erb

@@ -0,0 +1 @@
+The required URL parameter '<%= @param %>' was not present. Please specify the parameter as an option, like Resource.new(id, <%= @param %>: 'value').

data/templates/errors/not_a_directory.erb

@@ -0,0 +1 @@
+The given path '<%= @path %>' is not a directory. Please make sure you have passed the path to a directory on disk.

data/templates/errors/resource_already_exists.erb

@@ -0,0 +1 @@
+The <%= @type %> '<%= @id %>' already exists on the Chef Server. Each <%= @type %> must have a unique identifier and the Chef Server indicated this <%= @type %> already exists. If you are trying to update the <%= @type %>, consider using the 'update' method instead.

data/templates/errors/resource_not_found.erb

@@ -0,0 +1 @@
+There is no <%= @type %> with an id of '<%= @id %>' on the Chef Server. If you are updating the <%= @type %>, please make sure the <%= @type %> exists and has the correct Chef identifier (primary key).

data/templates/errors/resource_not_mutable.erb

@@ -0,0 +1 @@
+The <%= @type %> '<%= @id %>' is not mutable. It may be locked by the remote Chef Server, or the Chef Server may not permit modifying the resource.

data/templates/errors/unknown_attribute.erb

@@ -0,0 +1 @@
+'<%= @attribute %>' is not a valid attribute!

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: chef-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Seth Vargo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: logify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: mixlib-authentication
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: A tiny Chef API client with minimal dependencies
@@ -45,8 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -59,8 +60,6 @@ files:
 - lib/chef-api/defaults.rb
 - lib/chef-api/error_collection.rb
 - lib/chef-api/errors.rb
-- lib/chef-api/logger.rb
-- lib/chef-api/proxy.rb
 - lib/chef-api/resource.rb
 - lib/chef-api/resources/base.rb
 - lib/chef-api/resources/client.rb
@@ -71,6 +70,7 @@ files:
 - lib/chef-api/resources/data_bag_item.rb
 - lib/chef-api/resources/environment.rb
 - lib/chef-api/resources/node.rb
+- lib/chef-api/resources/organization.rb
 - lib/chef-api/resources/principal.rb
 - lib/chef-api/resources/role.rb
 - lib/chef-api/resources/user.rb
@@ -81,16 +81,39 @@ files:
 - lib/chef-api/validators/required.rb
 - lib/chef-api/validators/type.rb
 - lib/chef-api/version.rb
-- locales/en.yml
 - spec/integration/resources/client_spec.rb
 - spec/integration/resources/environment_spec.rb
 - spec/integration/resources/node_spec.rb
 - spec/integration/resources/role_spec.rb
+- spec/integration/resources/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/chef_server.rb
 - spec/support/shared/chef_api_resource.rb
+- spec/unit/errors_spec.rb
 - spec/unit/resources/base_spec.rb
 - spec/unit/resources/client_spec.rb
+- spec/unit/resources/connection_spec.rb
+- templates/errors/abstract_method.erb
+- templates/errors/cannot_regenerate_key.erb
+- templates/errors/chef_api_error.erb
+- templates/errors/file_not_found.erb
+- templates/errors/http_bad_request.erb
+- templates/errors/http_forbidden_request.erb
+- templates/errors/http_gateway_timeout.erb
+- templates/errors/http_method_not_allowed.erb
+- templates/errors/http_not_acceptable.erb
+- templates/errors/http_not_found.erb
+- templates/errors/http_server_unavailable.erb
+- templates/errors/http_unauthorized_request.erb
+- templates/errors/insufficient_file_permissions.erb
+- templates/errors/invalid_resource.erb
+- templates/errors/invalid_validator.erb
+- templates/errors/missing_url_parameter.erb
+- templates/errors/not_a_directory.erb
+- templates/errors/resource_already_exists.erb
+- templates/errors/resource_not_found.erb
+- templates/errors/resource_not_mutable.erb
+- templates/errors/unknown_attribute.erb
 homepage: https://github.com/sethvargo/chef-api
 licenses:
 - Apache 2.0
@@ -101,17 +124,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Chef API client in Ruby
@@ -120,9 +143,12 @@ test_files:
 - spec/integration/resources/environment_spec.rb
 - spec/integration/resources/node_spec.rb
 - spec/integration/resources/role_spec.rb
+- spec/integration/resources/user_spec.rb
 - spec/spec_helper.rb
 - spec/support/chef_server.rb
 - spec/support/shared/chef_api_resource.rb
+- spec/unit/errors_spec.rb
 - spec/unit/resources/base_spec.rb
 - spec/unit/resources/client_spec.rb
+- spec/unit/resources/connection_spec.rb
 has_rdoc: