chef-infra-api 0.9.1

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

@@ -0,0 +1,53 @@
+module ChefAPI
+  class Resource::DataBagItem < Resource::Base
+    collection_path '/data/:bag'
+
+    schema do
+      attribute :id,   type: String, primary: true, required: true
+      attribute :data, type: Hash,   default: {}
+    end
+
+    class << self
+      def from_file(path, bag = File.basename(File.dirname(path)))
+        id, contents = Util.safe_read(path)
+        data = JSON.parse(contents)
+        data[:id] = id
+
+        bag = bag.is_a?(Resource::DataBag) ? bag : Resource::DataBag.new(name: bag)
+
+        new(data, { bag: bag.name }, bag)
+      end
+    end
+
+    attr_reader :bag
+
+    #
+    # Override the initialize method to move any attributes into the +data+
+    # hash.
+    #
+    def initialize(attributes = {}, prefix = {}, bag = nil)
+      @bag = bag || Resource::DataBag.fetch(prefix[:bag])
+
+      id = attributes.delete(:id) || attributes.delete('id')
+      super({ id: id, data: attributes }, prefix)
+    end
+
+
+    #
+    # Override the to_hash method to move data to the upper scope.
+    #
+    # @see (Resource::Base#to_hash)
+    #
+    def to_hash
+      {}.tap do |hash|
+        _attributes.each do |key, value|
+          if key == :data
+            hash.merge!(value)
+          else
+            hash[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module ChefAPI
+  class Resource::Environment < Resource::Base
+    collection_path '/environments'
+
+    schema do
+      attribute :name,                type: String, primary: true, required: true
+      attribute :description,         type: String
+      attribute :default_attributes,  type: Hash,   default: {}
+      attribute :override_attributes, type: Hash,   default: {}
+      attribute :cookbook_versions,   type: Hash,   default: {}
+    end
+
+    has_many :cookbooks
+    has_many :nodes
+  end
+end

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

@@ -0,0 +1,16 @@
+module ChefAPI
+  class Resource::Group < Resource::Base
+    collection_path '/groups'
+
+    schema do
+      attribute :groupname, type: String, primary: true, required: true
+      attribute :name,      type: String
+      attribute :orgname,   type: String
+      attribute :actors,    type: Array, default: []
+      attribute :users,     type: Array, default: []
+      attribute :clients,   type: Array, default: []
+      attribute :groups,    type: Array, default: []
+    end
+  end
+end
+

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

@@ -0,0 +1,20 @@
+module ChefAPI
+  class Resource::Node < Resource::Base
+    include ChefAPI::AclAble
+    collection_path '/nodes'
+
+    schema do
+      attribute :name,         type: String, primary: true, required: true
+      attribute :automatic,    type: Hash,   default: {}
+      attribute :default,      type: Hash,   default: {}
+      attribute :normal,       type: Hash,   default: {}
+      attribute :override,     type: Hash,   default: {}
+      attribute :run_list,     type: Array,  default: []
+      attribute :policy_name,  type: String
+      attribute :policy_group, type: String
+
+      # Enterprise Chef attributes
+      attribute :chef_environment, type: String, default: '_default'
+    end
+  end
+end

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/partial_search.rb

@@ -0,0 +1,44 @@
+module ChefAPI
+  class Resource::PartialSearch < Resource::Base
+    collection_path '/search/:index'
+
+    schema do
+      attribute :total, type: Integer
+      attribute :start, type: Integer
+      attribute :rows,  type: Array
+    end
+
+    class << self
+      #
+      # About search : https://docs.chef.io/chef_search.html
+      #
+      # @param [String] index
+      #   the name of the index to search
+      # @param [Hash] keys
+      #   key paths for the attributes to be returned
+      # @param [String] query
+      #   the query string
+      # @param [Hash] options
+      #   the query string
+      #
+      # @return [self]
+      #   the current resource
+      #
+      def query(index, keys, query = '*:*', options = {})
+        return nil if index.nil?
+
+        params = {}.tap do |o|
+          o[:q]     = query
+          o[:rows]  = options[:rows]  || 1000
+          o[:sort]  = options[:sort]  || 'X_CHEF_id_CHEF_X'
+          o[:start] = options[:start] || 0
+        end
+
+        path = expanded_collection_path(index: index.to_s)
+        response = connection.post(path, keys.to_json, params)
+        response['rows'].map! { |row| row['data'] }
+        from_json(response, index: index.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module ChefAPI
+  class Resource::Principal < Resource::Base
+    collection_path '/principals'
+
+    schema do
+      attribute :name,       type: String, primary: true, required: true
+      attribute :type,       type: String
+      attribute :public_key, type: String
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module ChefAPI
+  class Resource::Role < Resource::Base
+    include ChefAPI::AclAble
+    collection_path '/roles'
+
+    schema do
+      attribute :name,                type: String, primary: true, required: true
+      attribute :json_class,          type: String, default: "Chef::Role"
+      attribute :description,         type: String
+      attribute :default_attributes,  type: Hash,   default: {}
+      attribute :override_attributes, type: Hash,   default: {}
+      attribute :run_list,            type: Array,  default: []
+      attribute :env_run_lists,       type: Hash,   default: {}
+    end
+
+    has_many :environments
+  end
+end

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

@@ -0,0 +1,47 @@
+module ChefAPI
+  class Resource::Search < Resource::Base
+    collection_path '/search/:index'
+
+    schema do
+      attribute :total, type: Integer
+      attribute :start, type: Integer
+      attribute :rows,  type: Array
+    end
+
+    class << self
+      #
+      # About search : https://docs.chef.io/chef_search.html
+      #
+      # @param [String] index
+      #   the name of the index to search
+      # @param [String] query
+      #   the query string
+      # @param [Hash] options
+      #   the query string
+      #
+      # @return [self]
+      #   the current resource
+      #
+      def query(index, query = '*:*', options = {})
+        return nil if index.nil?
+
+        params = {}.tap do |o|
+          o[:q]     = query
+          o[:rows]  = options[:rows]  || 1000
+          o[:sort]  = options[:sort]  || 'X_CHEF_id_CHEF_X'
+          o[:start] = options[:start] || 0
+        end
+
+        path = expanded_collection_path(index: index.to_s)
+
+        response = if filter_result = options[:filter_result]
+          connection.post(path, filter_result.to_json, params)
+        else
+          connection.get(path, params)
+        end
+
+        from_json(response, index: index.to_s)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module ChefAPI
+  class Resource::User < Resource::Base
+    collection_path '/users'
+
+    schema do
+      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.to_json)
+      end
+    end
+  end
+end

data/lib/chef-api/schema.rb

@@ -0,0 +1,150 @@
+module ChefAPI
+  #
+  # A wrapper class that describes a remote schema (such as the Chef Server
+  # API layer), with validation and other magic spinkled on top.
+  #
+  class Schema
+
+    #
+    # The full list of attributes defined on this schema.
+    #
+    # @return [Hash]
+    #
+    attr_reader :attributes
+
+    attr_reader :ignored_attributes
+
+    #
+    # The list of defined validators for this schema.
+    #
+    # @return [Array]
+    #
+    attr_reader :validators
+
+    #
+    # Create a new schema and evaulte the block contents in a clean room.
+    #
+    def initialize(&block)
+      @attributes = {}
+      @ignored_attributes = {}
+      @flavor_attributes = {}
+      @validators = []
+
+      unlock { instance_eval(&block) } if block
+    end
+
+    #
+    # The defined primary key for this schema. If no primary key is given, it
+    # is assumed to be the first item in the list.
+    #
+    # @return [Symbol]
+    #
+    def primary_key
+      @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.
+    #
+    # @param [Symbol] key
+    #   the key to use
+    # @param [Hash] options
+    #   a list of options to create the attribute with
+    #
+    # @return [Symbol]
+    #   the attribute
+    #
+    def attribute(key, options = {})
+      if primary_key = options.delete(:primary)
+        @primary_key = key.to_sym
+      end
+
+      @attributes[key] = options.delete(:default)
+
+      # All remaining options are assumed to be validations
+      options.each do |validation, options|
+        if options
+          @validators << Validator.find(validation).new(key, options)
+        end
+      end
+
+      key
+    end
+
+    #
+    # Ignore an attribute. This is handy if you know there's an attribute that
+    # the remote server will return, but you don't want that information
+    # exposed to the user (or the data is sensitive).
+    #
+    # @param [Array<Symbol>] keys
+    #   the list of attributes to ignore
+    #
+    def ignore(*keys)
+      keys.each do |key|
+        @ignored_attributes[key.to_sym] = true
+      end
+    end
+
+    private
+
+    #
+    # @private
+    #
+    # 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 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