ridley 0.7.0.beta → 0.7.0.rc1

data/README.md

@@ -21,9 +21,9 @@ Require Ridley into your application
 
     require 'ridley'
 
-## Creating a new connection
+## Creating a new Ridley client
 
-    conn = Ridley::Connection.new(
+    conn = Ridley.new(
       server_url: "https://api.opscode.com",
       client_name: "reset",
       client_key: "/Users/reset/.chef/reset.pem",
@@ -38,15 +38,12 @@ Creating a new connection requires you to specify at minimum:
 
 An optional organization option can be specified if you are working with Hosted or Private Chef (OHC/OPC). For a full list of available options see the [yard documentation](http://rubydoc.info/gems/ridley).
 
-__NOTE: You do not want to specify an `organization` if you are connecting to an Open Source Chef server.__
+Connections can also be instantiated by a helper function: `Ridley.new`
 
-Connections can also be instantiated by a helper function: `Ridley.connection`
-
-    Ridley.connection(
+    Ridley.new(
       server_url: "https://api.opscode.com",
       client_name: "reset",
-      client_key: "/Users/reset/.chef/reset.pem",
-      organization: "ridley"
+      client_key: "/Users/reset/.chef/reset.pem"
     )
 
 Using a connection object you can interact with collections of resources on a Chef server. Resources are:
@@ -60,7 +57,7 @@ Using a connection object you can interact with collections of resources on a Ch
 
 Here is a simple example of instantiating a new connection and listing all of the roles on a Chef server.
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     conn.role.all => []
 
 For more information scroll down to the Manipulating Chef Resources section of this README.
@@ -69,7 +66,7 @@ For more information scroll down to the Manipulating Chef Resources section of t
 
 An alternative syntax is provided if you want to perform multiple requests, in order, on a connection.
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
 
     conn.sync do
       role.all
@@ -104,18 +101,18 @@ All resource can be listed, created, retrieved, updated, or destroyed. Some reso
 
 You use a connection to interact with the resources on the remote Chef server it is pointing to. For example, if you wanted to get a list of all of the roles on your Chef server:
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     conn.role.all           => []
 
-Calling `role.all` on the connection object will return an array of Ridley::Role objects. All of the resources can be listed, not just Roles:
+Calling `role.all` on the connection object will return an array of Ridley::RoleResource objects. All of the resources can be listed, not just Roles:
 
-    conn = Ridley.connection(...)
-    conn.node.all           => [<#Ridley::Node>]
-    conn.role.all           => [<#Ridley::Role>]
-    conn.environment.all    => [<#Ridley::Environment>]
-    conn.client.all         => [<#Ridley::Client>]
-    conn.cookbook.all       => [<#Ridley::Cookbook>]
-    conn.data_bag.all       => [<#Ridley::DataBag>]
+    conn = Ridley.new(...)
+    conn.node.all           => [<#Ridley::NodeResource>]
+    conn.role.all           => [<#Ridley::RoleResource>]
+    conn.environment.all    => [<#Ridley::EnvironmentResource>]
+    conn.client.all         => [<#Ridley::ClientResource>]
+    conn.cookbook.all       => [<#Ridley::CookbookResource>]
+    conn.data_bag.all       => [<#Ridley::DataBagResource>]
 
 ### Creating a resource
 
@@ -123,24 +120,24 @@ A new resource can be created in a few ways
 
 _Create by instantiate and save_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.role.new
 
     obj.name = "reset"
-    obj.save => <#Ridley::Role: @name="reset">
+    obj.save => <#Ridley::RoleResource: @name="reset">
 
 _Create by the `create` function with attribute hash_
 
-    conn = Ridley.connection(...)
-    conn.role.create(name: "reset") => <#Ridley::Role: @name="reset">
+    conn = Ridley.new(...)
+    conn.role.create(name: "reset") => <#Ridley::RoleResource: @name="reset">
 
 _Create by the `create` function with a resource object_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.role.new
 
     obj.name = "reset"
-    conn.role.create(obj) => <#Ridley::Role: @name="reset">
+    conn.role.create(obj) => <#Ridley::RoleResource: @name="reset">
 
 Each of these methods is identical, it is up to you on how you'd like to create new resources.
 
@@ -152,14 +149,14 @@ Both `find` and `find!` will return a resource but if the resource is not found
 
 If you were following allong in the previous section we created a role named `reset`. We'll assume that role has been created in this next example.
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
 
-    conn.role.find("reset") => <#Ridley::Role: @name="reset">
-    conn.role.find!("reset") => <#Ridley::Role: @name="reset">
+    conn.role.find("reset") => <#Ridley::RoleResource: @name="reset">
+    conn.role.find!("reset") => <#Ridley::RoleResource: @name="reset">
 
 Now if we attempt to find a role that does not exist on the Chef server
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
 
     conn.role.find("not_there") => nil
     conn.role.find!("not_there") =>
@@ -182,24 +179,24 @@ Like creating a resource, updating a resource can also be expressed a few differ
 
 _Update by the `update` function with an id and attribute hash_
 
-    conn = Ridley.connection(...)
-    conn.role.update("reset", description: "testing updates!") => <#Ridley::Role: @name="reset", @description="testing updates!">
+    conn = Ridley.new(...)
+    conn.role.update("reset", description: "testing updates!") => <#Ridley::RoleResource: @name="reset", @description="testing updates!">
 
 _Update by the `update` function with a resource object_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.role.find("reset")
     obj.description = "resource object!"
 
-    conn.role.update(obj) => <#Ridley::Role: @name="reset", @description="resource object!">
+    conn.role.update(obj) => <#Ridley::RoleResource: @name="reset", @description="resource object!">
 
 _Update by saving a resource object_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.role.find("reset")
 
     obj.description = "saving an object!"
-    obj.save => <#Ridley::Role: @name="reset", @description="saving an object!">
+    obj.save => <#Ridley::RoleResource: @name="reset", @description="saving an object!">
 
 ### Deleting a resource
 
@@ -207,19 +204,19 @@ Like creating or updating a resource, there are a few ways deleting a resource c
 
 _Delete by the `delete` function with an id_
 
-    conn = Ridley.connection(...)
-    conn.role.delete("reset") => <#Ridley::Role: @name="reset">
+    conn = Ridley.new(...)
+    conn.role.delete("reset") => <#Ridley::RoleResource: @name="reset">
 
 _Delete by the `delete` function with a resource object_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.role.find("reset")
 
-    conn.role.delete(obj) => <#Ridley::Role: @name="reset">
+    conn.role.delete(obj) => <#Ridley::RoleResource: @name="reset">
 
 _Delete by the `destroy` function on a resource object_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.role.find("reset")
 
     obj.destroy => true
@@ -228,21 +225,21 @@ _Delete by the `destroy` function on a resource object_
 
 _Regenerate function on a context with an id_
 
-    conn = Ridley.connection(...)
-    conn.client.regenerate_key("jwinsor") => <#Ridley::Client: @name="jwinsor", @private_key="HIDDEN">
+    conn = Ridley.new(...)
+    conn.client.regenerate_key("jwinsor") => <#Ridley::ClientResource: @name="jwinsor", @private_key="HIDDEN">
 
 _Regenerate function on an instantiated resource object_
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     obj = conn.client.find("jwinsor")
 
-    obj.regenerate_key => <#Ridley::Client: @name="jwinsor", @private_key="HIDDEN">
+    obj.regenerate_key => <#Ridley::ClientResource: @name="jwinsor", @private_key="HIDDEN">
 
 ## Manipulating Data Bags and Data Bag Items
 
 A data bag is managed exactly the same as any other Chef resource
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     conn.data_bag.create("ridley-test")
 
 You can create, delete, update, or retrieve a data bag exactly how you would expect if you read through the
@@ -252,15 +249,15 @@ Unlike a role, node, client, or environment, a data bag is a container for other
 
 ### Creating a Data Bag Item
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     data_bag = conn.data_bag.create("ridley-test")
 
     data_bag.item.create(id: "appconfig", host: "reset.local", user: "jwinsor") => 
-      <#Ridley::DataBagItem: @id="appconfig", @host="reset.local", @user="jwinsor">
+      <#Ridley::DataBagItemResource: @id="appconfig", @host="reset.local", @user="jwinsor">
 
 ### Saving a Data Bag Item
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     data_bag = conn.data_bag.create("ridley-test")
 
     dbi = data_bag.item.new
@@ -270,7 +267,7 @@ Unlike a role, node, client, or environment, a data bag is a container for other
 
 ## Searching
 
-    conn = Ridley.connection(...)
+    conn = Ridley.new(...)
     conn.search(:node)
     conn.search(:node, "name:ridley-test.local")
 
@@ -293,7 +290,7 @@ Given the previous example you could set the default node attribute with the `se
 
 Setting the `node[:my_app][:billing][:enabled]` node level attribute on the node "jwinsor-1"
 
-    conn = Ridley.connection
+    conn = Ridley.new
     conn.sync do
       obj = node.find("jwinsor-1")
       obj.set_attribute("my_app.billing.enabled", false)
@@ -304,7 +301,7 @@ Setting the `node[:my_app][:billing][:enabled]` node level attribute on the node
 
 Setting a default environment attribute is just like setting a node level default attribute
 
-    conn = Ridley.connection
+    conn = Ridley.new
     conn.sync do
       obj = environment.find("production")
       obj.set_default_attribute("my_app.proxy.enabled", false)
@@ -313,7 +310,7 @@ Setting a default environment attribute is just like setting a node level defaul
 
 And the same goes for setting an environment level override attribute
 
-    conn = Ridley.connection
+    conn = Ridley.new
     conn.sync do
       obj = environment.find("production")
       obj.set_override_attribute("my_app.webapp.enabled", false)
@@ -322,7 +319,7 @@ And the same goes for setting an environment level override attribute
 
 ### Role Attributes
 
-    conn = Ridley.connection
+    conn = Ridley.new
     conn.sync do
       obj = role.find("why_god_why")
       obj.set_default_attribute("my_app.proxy.enabled", false)
@@ -337,7 +334,7 @@ And the same goes for setting an environment level override attribute
 
 ## Bootstrapping nodes
 
-    conn = Ridley.connection(
+    conn = Ridley.new(
       server_url: "https://api.opscode.com",
       organization: "vialstudios",
       validator_client: "vialstudios-validator",

data/lib/ridley.rb

@@ -1,5 +1,4 @@
 require 'chozo'
-require 'active_support/core_ext'
 require 'celluloid'
 require 'faraday'
 require 'addressable/uri'
@@ -25,19 +24,13 @@ module Ridley
   CHEF_VERSION = '10.16.4'.freeze
 
   autoload :Bootstrapper, 'ridley/bootstrapper'
-  autoload :Client, 'ridley/resources/client'
+  autoload :Client, 'ridley/client'
   autoload :Connection, 'ridley/connection'
   autoload :ChainLink, 'ridley/chain_link'
-  autoload :Cookbook, 'ridley/resources/cookbook'
-  autoload :DataBag, 'ridley/resources/data_bag'
-  autoload :DataBagItem, 'ridley/resources/data_bag_item'
   autoload :DSL, 'ridley/dsl'
-  autoload :Environment, 'ridley/resources/environment'
   autoload :Logging, 'ridley/logging'
-  autoload :Node, 'ridley/resources/node'
   autoload :Resource, 'ridley/resource'
-  autoload :Role, 'ridley/resources/role'
-  autoload :Search, 'ridley/resources/search'
+  autoload :SandboxUploader, 'ridley/sandbox_uploader'
   autoload :SSH, 'ridley/ssh'
 
   class << self
@@ -49,12 +42,12 @@ module Ridley
     def_delegator "Ridley::Logging", :logger=
     def_delegator "Ridley::Logging", :set_logger
 
-    def connection(*args)
-      Connection.new(*args)
+    def new(*args)
+      Client.new(*args)
     end
 
-    def sync(*args, &block)
-      Connection.sync(*args, &block)
+    def open(*args, &block)
+      Client.open(*args, &block)
     end
 
     # @return [Pathname]
@@ -67,3 +60,4 @@ end
 Celluloid.logger = Ridley.logger
 
 require 'ridley/middleware'
+require 'ridley/resources'

data/lib/ridley/client.rb

@@ -0,0 +1,251 @@
+module Ridley
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  #
+  # @example
+  #   connection = Ridley::Client.new
+  #   connection.role.all
+  #
+  #   connection.role.find("reset") => Ridley::RoleResource.find(connection, "reset")
+  #
+  # @example instantiating new resources
+  #   connection = Ridley::Connection.new
+  #   connection.role.new(name: "hello") => <#Ridley::RoleResource: @name="hello">
+  #
+  #   New instances of resources can be instantiated by calling new on the Ridley::Context. These messages
+  #   will be send to the Chef resource's class in Ridley and can be treated as a normal Ruby object. Each
+  #   instantiated object will have the connection information contained within so you can do things like
+  #   save a role after changing it's attributes.
+  #
+  #   r = connection.role.new(name: "new-role")
+  #   r.name => "new-role"
+  #   r.name = "other-name"
+  #   r.save
+  #
+  #   connection.role.find("new-role") => <#Ridley::RoleResource: @name="new-role">
+  class Client < Celluloid::SupervisionGroup
+    class << self
+      def open(options = {}, &block)
+        cli = new(options)
+        cli.evaluate(&block)
+      ensure
+        cli.terminate if cli && cli.alive?
+      end
+
+      # @raise [ArgumentError]
+      #
+      # @return [Boolean]
+      def validate_options(options)
+        missing = (REQUIRED_OPTIONS - options.keys)
+
+        unless missing.empty?
+          missing.collect! { |opt| "'#{opt}'" }
+          raise ArgumentError, "Missing required option(s): #{missing.join(', ')}"
+        end
+
+        missing_values = options.slice(*REQUIRED_OPTIONS).select { |key, value| !value.present? }
+        unless missing_values.empty?
+          values = missing_values.keys.collect { |opt| "'#{opt}'" }
+          raise ArgumentError, "Missing value for required option(s): '#{values.join(', ')}'"
+        end
+      end
+    end
+
+    REQUIRED_OPTIONS = [
+      :server_url,
+      :client_name,
+      :client_key
+    ].freeze
+
+    extend Forwardable
+    include Ridley::Logging
+
+    def_delegator :connection, :build_url
+    def_delegator :connection, :scheme
+    def_delegator :connection, :host
+    def_delegator :connection, :port
+    def_delegator :connection, :path_prefix
+    def_delegator :connection, :url_prefix
+
+    def_delegator :connection, :client_key
+    def_delegator :connection, :client_key=
+    def_delegator :connection, :client_name
+    def_delegator :connection, :client_name=
+
+    attr_accessor :validator_client
+    attr_accessor :validator_path
+    attr_accessor :encrypted_data_bag_secret_path
+    attr_accessor :ssh
+
+    # @option options [String] :server_url
+    #   URL to the Chef API
+    # @option options [String] :client_name
+    #   name of the client used to authenticate with the Chef API
+    # @option options [String] :client_key
+    #   filepath to the client's private key used to authenticate with the Chef API
+    # @option options [String] :validator_client (nil)
+    # @option options [String] :validator_path (nil)
+    # @option options [String] :encrypted_data_bag_secret_path (nil)
+    # @option options [Hash] :ssh (Hash.new)
+    #   * :user (String) a shell user that will login to each node and perform the bootstrap command on (required)
+    #   * :password (String) the password for the shell user that will perform the bootstrap
+    #   * :keys (Array, String) an array of keys (or a single key) to authenticate the ssh user with instead of a password
+    #   * :timeout (Float) [5.0] timeout value for SSH bootstrap
+    #   * :sudo (Boolean) [true] bootstrap with sudo
+    # @option options [Hash] :params
+    #   URI query unencoded key/value pairs
+    # @option options [Hash] :headers
+    #   unencoded HTTP header key/value pairs
+    # @option options [Hash] :request
+    #   request options
+    # @option options [Hash] :ssl
+    #   * :verify (Boolean) [true] set to false to disable SSL verification
+    # @option options [URI, String, Hash] :proxy
+    #   URI, String, or Hash of HTTP proxy options
+    def initialize(options = {})
+      log.info { "Ridley starting..." }
+      options = options.reverse_merge(
+        ssh: Hash.new
+      ).deep_symbolize_keys
+      self.class.validate_options(options)
+
+      @ssh              = options[:ssh]
+      @validator_client = options[:validator_client]
+
+      options[:client_key] = File.expand_path(options[:client_key])
+
+      if options[:validator_path]
+        @validator_path = File.expand_path(options[:validator_path])
+      end
+
+      if options[:encrypted_data_bag_secret_path]
+        @encrypted_data_bag_secret_path = File.expand_path(options[:encrypted_data_bag_secret_path])
+      end
+
+      unless options[:client_key].present? && File.exist?(options[:client_key])
+        raise Errors::ClientKeyFileNotFound, "client key not found at: '#{options[:client_key]}'"
+      end
+
+      super(Celluloid::Registry.new)
+      pool(Ridley::Connection, size: 4, args: [
+        options[:server_url],
+        options[:client_name],
+        options[:client_key],
+        options.slice(*Connection::VALID_OPTIONS)
+      ], as: :connection_pool)
+    end
+
+    # @return [Ridley::ChainLink]
+    def client
+      ChainLink.new(Actor.current, Ridley::ClientResource)
+    end
+
+    # @return [Ridley::ChainLink]
+    def cookbook
+      ChainLink.new(Actor.current, Ridley::CookbookResource)
+    end
+
+    # @return [Ridley::ChainLink]
+    def data_bag
+      ChainLink.new(Actor.current, Ridley::DataBagResource)
+    end
+
+    # @return [Ridley::ChainLink]
+    def environment
+      ChainLink.new(Actor.current, Ridley::EnvironmentResource)
+    end
+
+    # @return [Ridley::ChainLink]
+    def node
+      ChainLink.new(Actor.current, Ridley::NodeResource)
+    end
+
+    # @return [Ridley::ChainLink]
+    def role
+      ChainLink.new(Actor.current, Ridley::RoleResource)
+    end
+
+    # @return [Ridley::ChainLink]
+    def sandbox
+      ChainLink.new(Actor.current, Ridley::SandboxResource)
+    end
+
+    # Creates an runs a new Ridley::Search
+    #
+    # @see Ridley::Search#run
+    #
+    # @param [String, Symbol] index
+    # @param [String, nil] query
+    #
+    # @option options [String] :sort
+    # @option options [Integer] :rows
+    # @option options [Integer] :start
+    #
+    # @return [Hash]
+    def search(index, query = nil, options = {})
+      Ridley::Search.new(Actor.current, index, query, options).run
+    end
+
+    # Return the array of all possible search indexes for the including connection
+    #
+    # @example
+    #   conn = Ridley.new(...)
+    #   conn.search_indexes => 
+    #     [:client, :environment, :node, :role, :"ridley-two", :"ridley-one"]
+    #
+    # @return [Array<Symbol, String>]
+    def search_indexes
+      Ridley::Search.indexes(Actor.current)
+    end
+
+    # The encrypted data bag secret for this connection.
+    #
+    # @raise [Ridley::Errors::EncryptedDataBagSecretNotFound]
+    #
+    # @return [String, nil]
+    def encrypted_data_bag_secret
+      return nil if encrypted_data_bag_secret_path.nil?
+
+      IO.read(encrypted_data_bag_secret_path).chomp
+    rescue Errno::ENOENT => e
+      raise Errors::EncryptedDataBagSecretNotFound, "Encrypted data bag secret provided but not found at '#{encrypted_data_bag_secret_path}'"
+    end
+
+    def server_url
+      self.url_prefix.to_s
+    end
+
+    def evaluate(&block)
+      unless block_given?
+        raise LocalJumpError, "no block given (yield)"
+      end
+
+      @self_before_instance_eval = eval("self", block.binding)
+      instance_eval(&block)
+    end
+    alias_method :sync, :evaluate
+
+    def finalize
+      connection.terminate if connection.alive?
+    end
+
+    def connection
+      registry[:connection_pool]
+    end
+
+    private
+
+      attr_reader :registry
+
+      def method_missing(method, *args, &block)
+        if block_given?
+          @self_before_instance_eval ||= eval("self", block.binding)
+        end
+
+        if @self_before_instance_eval.nil?
+          super
+        end
+
+        @self_before_instance_eval.send(method, *args, &block)
+      end
+  end
+end