chef-api 0.2.0 → 0.2.1

data/lib/chef-api/resources/base.rb

@@ -20,7 +20,7 @@ module ChefAPI
       # @todo doc
       #
       def from_url(url, prefix = {})
-        from_json(ChefAPI.connection.get(url), prefix)
+        from_json(connection.get(url), prefix)
       end
 
       #
@@ -78,13 +78,13 @@ module ChefAPI
       #   has_many :environments, class_name: 'Environment'
       #
       def has_many(method, options = {})
-        class_name    = options[:class_name] || Util.camelize(method).sub(/s$/, '')
+        class_name    = options[:class_name] || "Resource::#{Util.camelize(method).sub(/s$/, '')}"
         rest_endpoint = options[:rest_endpoint] || method
 
         class_eval <<-EOH, __FILE__, __LINE__ + 1
           def #{method}
             associations[:#{method}] ||=
-              CollectionProxy.new(self, #{class_name}, '#{rest_endpoint}')
+              Resource::CollectionProxy.new(self, #{class_name}, '#{rest_endpoint}')
           end
         EOH
       end
@@ -138,7 +138,7 @@ module ChefAPI
       #
       def post(body, prefix = {})
         path = expanded_collection_path(prefix)
-        ChefAPI.connection.post(path, body)
+        connection.post(path, body)
       end
 
       #
@@ -159,7 +159,7 @@ module ChefAPI
       #
       def put(id, body, prefix = {})
         path = resource_path(id, prefix)
-        ChefAPI.connection.put(path, body)
+        connection.put(path, body)
       end
 
       #
@@ -173,7 +173,7 @@ module ChefAPI
       #
       def delete(id, prefix = {})
         path = resource_path(id, prefix)
-        ChefAPI.connection.delete(path)
+        connection.delete(path)
         true
       rescue Error::HTTPNotFound
         true
@@ -195,7 +195,7 @@ module ChefAPI
       #
       def list(prefix = {})
         path = expanded_collection_path(prefix)
-        ChefAPI.connection.get(path).keys.sort
+        connection.get(path).keys.sort
       end
 
       #
@@ -249,7 +249,7 @@ module ChefAPI
         return nil if id.nil?
 
         path     = resource_path(id, prefix)
-        response = ChefAPI.connection.get(path)
+        response = connection.get(path)
         from_json(response, prefix)
       rescue Error::HTTPNotFound
         nil
@@ -363,7 +363,7 @@ module ChefAPI
       #
       def each(prefix = {}, &block)
         collection(prefix).each do |resource, path|
-          response = ChefAPI.connection.get(path)
+          response = connection.get(path)
           result = from_json(response, prefix)
 
           block.call(result) if block
@@ -383,9 +383,8 @@ module ChefAPI
       #
       # Return an array of all resources in the collection.
       #
-      # @warn
-      #   Unless you need the _entire_ collection, please consider using the
-      #   {size} and {each} methods instead as they are much more perforant.
+      # @note Unless you need the _entire_ collection, please consider using the
+      # {size} and {each} methods instead as they are much more perforant.
       #
       # @return [Array<Resource::Base>]
       #
@@ -470,7 +469,7 @@ module ChefAPI
       #   a list of resources in the collection
       #
       def collection(prefix = {})
-        ChefAPI.connection.get(expanded_collection_path(prefix))
+        connection.get(expanded_collection_path(prefix))
       end
 
       #
@@ -516,6 +515,15 @@ module ChefAPI
           URI.escape(value)
         end.sub(/^\//, '') # Remove leading slash
       end
+
+      #
+      # The current connection object.
+      #
+      # @return [ChefAPI::Connection]
+      #
+      def connection
+        Thread.current['chefapi.connection'] || ChefAPI.connection
+      end
     end
 
     #
@@ -546,6 +554,9 @@ module ChefAPI
     #   the list of prefix options (for nested resources)
     #
     def initialize(attributes = {}, prefix = {})
+      @schema = self.class.schema.dup
+      @schema.load_flavor(self.class.connection.flavor)
+
       @associations = {}
       @_prefix      = prefix
 
@@ -571,7 +582,7 @@ module ChefAPI
     #   the primary key for this resource
     #
     def primary_key
-      self.class.schema.primary_key
+      @schema.primary_key
     end
 
     #
@@ -596,7 +607,7 @@ module ChefAPI
     # @return [Hash<Symbol, Object>]
     #
     def _attributes
-      @_attributes ||= {}.merge(self.class.schema.attributes)
+      @_attributes ||= {}.merge(@schema.attributes)
     end
 
     #
@@ -636,8 +647,7 @@ module ChefAPI
     # so they will be reloaded the next time they are requested. If the remote
     # record does not exist, no attributes are modified.
     #
-    # @warn
-    #   This will remove any custom values you have set on the resource!
+    # @note This will remove any custom values you have set on the resource!
     #
     # @return [self]
     #   the instance of the reloaded record
@@ -748,7 +758,7 @@ module ChefAPI
     #   the list of validators for this resource
     #
     def validators
-      @validators ||= self.class.schema.validators
+      @validators ||= @schema.validators
     end
 
     #
@@ -845,8 +855,7 @@ module ChefAPI
     #   bacon.description = "My new description"
     #   bacon.diff #=> { :description => { :local => "My new description", :remote => "Old description" } }
     #
-    # @warn
-    #   This is a VERY expensive operation - use it sparringly!
+    # @note This is a VERY expensive operation - use it sparringly!
     #
     # @return [Hash]
     #
@@ -887,7 +896,7 @@ module ChefAPI
     # @return [Boolean]
     #
     def ignore_attribute?(key)
-      self.class.schema.ignored_attributes.has_key?(key.to_sym)
+      @schema.ignored_attributes.has_key?(key.to_sym)
     end
 
     #

data/lib/chef-api/resources/client.rb

@@ -26,7 +26,7 @@ module ChefAPI
       # @return [Resource::Client]
       #
       def from_file(path)
-        name, contents = Util.safe_read(path)
+        name, key = Util.safe_read(path)
 
         if client = fetch(name)
           client.private_key = key
@@ -63,15 +63,13 @@ module ChefAPI
     #   key = client.regenerate_key
     #   key #=> "-----BEGIN PRIVATE KEY-----\nMIGfMA0GCS..."
     #
-    # @warn
-    #   For security reasons, you should perform this operation sparingly! The
-    #   resulting private key is committed to this object, meaning it is saved
-    #   to memory somewhere. You should set this resource's +private_key+ to
-    #   +nil+ after you have committed it to disk and perform a manual GC to
+    # @note For security reasons, you should perform this operation sparingly!
+    #   The resulting private key is committed to this object, meaning it is
+    #   saved to memory somewhere. You should set this resource's +private_key+
+    #   to +nil+ after you have committed it to disk and perform a manual GC to
     #   be ultra-secure.
     #
-    # @warn
-    #   Regenerating the private key also regenerates the public key!
+    # @note Regenerating the private key also regenerates the public key!
     #
     # @return [self]
     #   the current resource with the new public and private key attributes

data/lib/chef-api/resources/collection_proxy.rb

@@ -157,6 +157,11 @@ module ChefAPI
     #
     #     ["item_1", "item_2"]
     #
+    # Or if the Chef Server is feeling especially magical, it might return the
+    # actual objects, but prefixed with the JSON id:
+    #
+    #     [{"organization" => {"_id" => "..."}}, {"organization" => {...}}]
+    #
     # So, this method attempts to intelligent handle these use cases. That being
     # said, I can almost guarantee that someone is going to do some crazy
     # strange edge case with this library and hit a bug here, so it will likely
@@ -165,9 +170,21 @@ module ChefAPI
     # @return [Hash]
     #
     def load_collection
-      case response = ChefAPI.connection.get(endpoint)
+      case response = Resource::Base.connection.get(endpoint)
       when Array
-        Hash[*response.map { |item| [item, klass.resource_path(item)] }.flatten]
+        if response.first.is_a?(Hash)
+          key = klass.schema.primary_key.to_s
+
+          {}.tap do |hash|
+            response.each do |results|
+              results.each do |_, info|
+                hash[key] = klass.resource_path(info[key])
+              end
+            end
+          end
+        else
+          Hash[*response.map { |item| [item, klass.resource_path(item)] }.flatten]
+        end
       when Hash
         response
       end

data/lib/chef-api/resources/data_bag.rb

@@ -47,7 +47,7 @@ module ChefAPI
         return nil if id.nil?
 
         path     = resource_path(id, prefix)
-        response = ChefAPI.connection.get(path)
+        response = connection.get(path)
         new(name: id)
       rescue Error::HTTPNotFound
         nil

data/lib/chef-api/resources/organization.rb

@@ -0,0 +1,22 @@
+module ChefAPI
+  class Resource::Organization < Resource::Base
+    collection_path '/organizations'
+
+    schema do
+      attribute :name,       type: String, primary: true, required: true
+      attribute :org_type,   type: String
+      attribute :full_name,  type: String
+      attribute :clientname, type: String
+      attribute :guid,       type: String
+
+      ignore :_id
+      ignore :_rev
+      ignore :chargify_subscription_id
+      ignore :chargify_customer_id
+      ignore :billing_plan
+      ignore :requester_id
+      ignore :assigned_at
+      ignore 'couchrest-type'
+    end
+  end
+end

data/lib/chef-api/resources/user.rb

@@ -3,9 +3,80 @@ module ChefAPI
     collection_path '/users'
 
     schema do
-      attribute :name,        type: String,  primary: true, required: true
+      flavor :enterprise do
+        attribute :username, type: String, primary: true, required: true
+
+        # "Vanity" attributes
+        attribute :first_name,      type: String
+        attribute :middle_name,     type: String
+        attribute :last_name,       type: String
+        attribute :display_name,    type: String
+        attribute :email,           type: String
+        attribute :city,            type: String
+        attribute :country,         type: String
+        attribute :twitter_account, type: String
+      end
+
+      flavor :open_source do
+        attribute :name, type: String, primary: true, required: true
+      end
+
       attribute :admin,       type: Boolean, default: false
       attribute :public_key,  type: String
+      attribute :private_key, type: [String, Boolean], default: false
+    end
+
+    has_many :organizations
+
+    class << self
+      #
+      # @see Base.each
+      #
+      def each(prefix = {}, &block)
+        users = collection(prefix)
+
+        # HEC/EC returns a slightly different response than OSC/CZ
+        if users.is_a?(Array)
+          users.each do |info|
+            name = URI.escape(info['user']['username'])
+            response = connection.get("/users/#{name}")
+            result = from_json(response, prefix)
+
+            block.call(result) if block
+          end
+        else
+          users.each do |_, path|
+            response = connection.get(path)
+            result = from_json(response, prefix)
+
+            block.call(result) if block
+          end
+        end
+      end
+
+      #
+      # Authenticate a user with the given +username+ and +password+.
+      #
+      # @note Requires Enterprise Chef
+      #
+      # @example Authenticate a user
+      #   User.authenticate(username: 'user', password: 'pass')
+      #     #=> { "status" => "linked", "user" => { ... } }
+      #
+      # @param [Hash] options
+      #   the list of options to authenticate with
+      #
+      # @option options [String] username
+      #   the username to authenticate with
+      # @option options [String] password
+      #   the plain-text password to authenticate with
+      #
+      # @return [Hash]
+      #   the parsed JSON response from the server
+      #
+      def authenticate(options = {})
+        connection.post('/authenticate_user', options)
+      end
     end
   end
 end

data/lib/chef-api/schema.rb

@@ -13,7 +13,6 @@ module ChefAPI
     attr_reader :attributes
 
     attr_reader :ignored_attributes
-    attr_reader :transformations
 
     #
     # The list of defined validators for this schema.
@@ -28,15 +27,10 @@ module ChefAPI
     def initialize(&block)
       @attributes = {}
       @ignored_attributes = {}
-      @transformations = {}
+      @flavor_attributes = {}
       @validators = []
 
-      instance_eval(&block) if block
-
-      @attributes.freeze
-      @ignored_attributes.freeze
-      @transformations.freeze
-      @validators.freeze
+      unlock { instance_eval(&block) } if block
     end
 
     #
@@ -49,6 +43,45 @@ module ChefAPI
       @primary_key ||= @attributes.first[0]
     end
 
+    #
+    # Create a lazy-loaded block for a given flavor.
+    #
+    # @example Create a block for Enterprise Chef
+    #   flavor :enterprise do
+    #     attribute :custom_value
+    #   end
+    #
+    # @param [Symbol] id
+    #   the id of the flavor to target
+    # @param [Proc] block
+    #   the block to capture
+    #
+    # @return [Proc]
+    #   the given block
+    #
+    def flavor(id, &block)
+      @flavor_attributes[id] = block
+      block
+    end
+
+    #
+    # Load the flavor block for the given id.
+    #
+    # @param [Symbol] id
+    #   the id of the flavor to target
+    #
+    # @return [true, false]
+    #   true if the flavor existed and was evaluted, false otherwise
+    #
+    def load_flavor(id)
+      if block = @flavor_attributes[id]
+        unlock { instance_eval(&block) }
+        true
+      else
+        false
+      end
+    end
+
     #
     # DSL method for defining an attribute.
     #
@@ -91,22 +124,27 @@ module ChefAPI
       end
     end
 
+    private
+
     #
-    # Transform an attribute onto another.
-    #
-    # @example Transform the +:bacon+ attribute onto the +:ham+ attribute
-    #   transform :bacon, ham: true
-    #
-    # @example Transform an attribute with a complex transformation
-    #   transform :bacon, ham: ->(value) { value.split('__', 2).last }
+    # @private
     #
-    # @param [Symbol] key
-    #   the attribute to transform
-    # @param [Hash] options
-    #   the key-value pair of the transformations to make
+    # Helper method to duplicate and unfreeze all the attributes in the schema,
+    # yield control to the user for modification in the current context, and
+    # then re-freeze the variables for modification.
     #
-    def transform(key, options = {})
-      @transformations[key.to_sym] = options
+    def unlock
+      @attributes = @attributes.dup
+      @ignored_attributes = @ignored_attributes.dup
+      @flavor_attributes = @flavor_attributes.dup
+      @validators = @validators.dup
+
+      yield
+
+      @attributes.freeze
+      @ignored_attributes.freeze
+      @flavor_attributes.freeze
+      @validators.freeze
     end
   end
 end

data/lib/chef-api/version.rb

@@ -1,3 +1,3 @@
 module ChefAPI
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/chef-api.rb

@@ -1,7 +1,11 @@
 require 'json'
+require 'logify'
 require 'pathname'
 require 'chef-api/version'
 
+# Do not inflate JSON objects
+JSON.create_id = nil
+
 module ChefAPI
   autoload :Boolean,         'chef-api/boolean'
   autoload :Configurable,    'chef-api/configurable'
@@ -9,7 +13,6 @@ module ChefAPI
   autoload :Defaults,        'chef-api/defaults'
   autoload :Error,           'chef-api/errors'
   autoload :ErrorCollection, 'chef-api/error_collection'
-  autoload :Logger,          'chef-api/logger'
   autoload :Resource,        'chef-api/resource'
   autoload :Schema,          'chef-api/schema'
   autoload :Util,            'chef-api/util'
@@ -23,6 +26,28 @@ module ChefAPI
   class << self
     include ChefAPI::Configurable
 
+    #
+    # Set the log level.
+    #
+    # @example Set the log level to :info
+    #   ChefAPI.log_level = :info
+    #
+    # @param [Symbol] level
+    #   the log level to set
+    #
+    def log_level=(level)
+      Logify.level = level
+    end
+
+    #
+    # Get the current log level.
+    #
+    # @return [Symbol]
+    #
+    def log_level
+      Logify.level
+    end
+
     #
     # The source root of the ChefAPI gem. This is useful when requiring files
     # that are relative to the root of the project.
@@ -67,10 +92,6 @@ module ChefAPI
   end
 end
 
-require 'i18n'
-I18n.enforce_available_locales = false
-I18n.load_path << Dir[ChefAPI.root.join('locales', '*.yml').to_s]
-
 # Load the initial default values
 ChefAPI.setup
 

data/spec/integration/resources/client_spec.rb

@@ -4,5 +4,59 @@ module ChefAPI
   describe Resource::Client do
     it_behaves_like 'a Chef API resource', :client,
       update: { validator: true }
+
+    describe '.from_file' do
+      let(:private_key) do
+        <<-EOH.strip.gsub(/^ {10}/, '')
+          -----BEGIN RSA PRIVATE KEY-----
+          MIIEogIBAAKCAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzI
+          w+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoP
+          kcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2
+          hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NO
+          Td0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcW
+          yLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQIBIwKCAQEA4iqWPJXtzZA68mKd
+          ELs4jJsdyky+ewdZeNds5tjcnHU5zUYE25K+ffJED9qUWICcLZDc81TGWjHyAqD1
+          Bw7XpgUwFgeUJwUlzQurAv+/ySnxiwuaGJfhFM1CaQHzfXphgVml+fZUvnJUTvzf
+          TK2Lg6EdbUE9TarUlBf/xPfuEhMSlIE5keb/Zz3/LUlRg8yDqz5w+QWVJ4utnKnK
+          iqwZN0mwpwU7YSyJhlT4YV1F3n4YjLswM5wJs2oqm0jssQu/BT0tyEXNDYBLEF4A
+          sClaWuSJ2kjq7KhrrYXzagqhnSei9ODYFShJu8UWVec3Ihb5ZXlzO6vdNQ1J9Xsf
+          4m+2ywKBgQD6qFxx/Rv9CNN96l/4rb14HKirC2o/orApiHmHDsURs5rUKDx0f9iP
+          cXN7S1uePXuJRK/5hsubaOCx3Owd2u9gD6Oq0CsMkE4CUSiJcYrMANtx54cGH7Rk
+          EjFZxK8xAv1ldELEyxrFqkbE4BKd8QOt414qjvTGyAK+OLD3M2QdCQKBgQDtx8pN
+          CAxR7yhHbIWT1AH66+XWN8bXq7l3RO/ukeaci98JfkbkxURZhtxV/HHuvUhnPLdX
+          3TwygPBYZFNo4pzVEhzWoTtnEtrFueKxyc3+LjZpuo+mBlQ6ORtfgkr9gBVphXZG
+          YEzkCD3lVdl8L4cw9BVpKrJCs1c5taGjDgdInQKBgHm/fVvv96bJxc9x1tffXAcj
+          3OVdUN0UgXNCSaf/3A/phbeBQe9xS+3mpc4r6qvx+iy69mNBeNZ0xOitIjpjBo2+
+          dBEjSBwLk5q5tJqHmy/jKMJL4n9ROlx93XS+njxgibTvU6Fp9w+NOFD/HvxB3Tcz
+          6+jJF85D5BNAG3DBMKBjAoGBAOAxZvgsKN+JuENXsST7F89Tck2iTcQIT8g5rwWC
+          P9Vt74yboe2kDT531w8+egz7nAmRBKNM751U/95P9t88EDacDI/Z2OwnuFQHCPDF
+          llYOUI+SpLJ6/vURRbHSnnn8a/XG+nzedGH5JGqEJNQsz+xT2axM0/W/CRknmGaJ
+          kda/AoGANWrLCz708y7VYgAtW2Uf1DPOIYMdvo6fxIB5i9ZfISgcJ/bbCUkFrhoH
+          +vq/5CIWxCPp0f85R4qxxQ5ihxJ0YDQT9Jpx4TMss4PSavPaBH3RXow5Ohe+bYoQ
+          NE5OgEXk2wVfZczCZpigBKbKZHNYcelXtTt/nP3rsCuGcM4h53s=
+          -----END RSA PRIVATE KEY-----
+        EOH
+      end
+
+      let(:client) { described_class.from_file('/path/to/bacon.pem') }
+
+      before do
+        File.stub(:read).and_return(private_key)
+      end
+
+      it 'loads the client from the server' do
+        chef_server.create_client('bacon', validator: true)
+
+        expect(client.name).to eq('bacon')
+        expect(client.private_key).to eq(private_key)
+        expect(client.validator).to be_true
+      end
+
+      it 'creates a new instance when the client does not exist' do
+        expect(client.name).to eq('bacon')
+        expect(client.validator).to be_false
+        expect(client.new_resource?).to be_true
+      end
+    end
   end
 end

data/spec/integration/resources/user_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+module ChefAPI
+  describe Resource::User do
+    it_behaves_like 'a Chef API resource', :user,
+      update: { admin: true }
+  end
+end

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ RSpec.configure do |config|
 
   #
   config.before(:each) do
-    ChefAPI::Logger.level = :fatal
+    Logify.level = :fatal
   end
 
   # Run specs in random order to surface order dependencies. If you find an

data/spec/support/chef_server.rb

@@ -70,6 +70,7 @@ module RSpec
       ['environments', 'environment'],
       ['nodes', 'node'],
       ['roles', 'role'],
+      ['users', 'user'],
     ].each do |plural, singular|
       define_method(plural) do
         @server.data_store.list([plural])