ridley 0.0.1 → 0.0.2

data/README.md

@@ -10,7 +10,6 @@ A reliable Chef API client with a clean syntax
 
 ## Known Issues
 
-* Search has not been implemented
 * Sandboxes has not been implemented
 * Full support for Cookbooks is not included
 * Acceptance test suite needs to be refactored
@@ -268,6 +267,12 @@ Unlike a role, node, client, or environment, a data bag is a container for other
     dbi[:host] = "reset.local"
     dbi.save => true
 
+## Searching
+
+    conn = Ridley.connection(...)
+    conn.search(:node)
+    conn.search(:node, "name:ridley-test.local")
+
 # Authors and Contributors
 
 * Jamie Winsor (<jamie@vialstudios.com>)

data/lib/ridley.rb

@@ -27,6 +27,7 @@ module Ridley
   autoload :DataBag, 'ridley/resources/data_bag'
   autoload :DataBagItem, 'ridley/resources/data_bag_item'
   autoload :Cookbook, 'ridley/resources/cookbook'
+  autoload :Search, 'ridley/resources/search'
 
   class << self
     def connection(*args)

data/lib/ridley/resources/search.rb

@@ -0,0 +1,104 @@
+module Ridley
+  class Search
+    class << self
+      # Returns an array of possible search indexes to be search on
+      #
+      # @param [Ridley::Connection]
+      #
+      # @return [Array<String, Symbol]
+      def indexes(connection)
+        connection.get("search").body.collect { |name, _| name }
+      end
+    end
+
+    attr_reader :connection
+    attr_reader :index
+    attr_reader :query
+    
+    attr_accessor :sort
+    attr_accessor :rows
+    attr_accessor :start
+
+    def initialize(connection, index, query, options = {})
+      @connection = connection
+      @index      = index
+      @query      = query
+
+      @sort       = options[:sort]
+      @rows       = options[:rows]
+      @start      = options[:start]
+    end
+
+    # Executes the built up query on the search's connection
+    #
+    # @example
+    #   Search.new(connection, :role)
+    #   search.run => 
+    #     {
+    #       total: 1,
+    #       start: 0,
+    #       rows: [
+    #         {
+    #           name: "ridley-test-role",
+    #           default_attributes: {},
+    #           json_class: "Chef::Role",
+    #           env_run_lists: {},
+    #           run_list: [],
+    #           description: "a test role for Ridley!",
+    #           chef_type: "role",
+    #           override_attributes: {}
+    #         }
+    #       ]
+    #     }
+    #
+    # @return [Hash]
+    def run
+      connection.get(query_uri, query_options).body
+    end
+
+    private
+
+      def query_uri
+        File.join("search", self.index.to_s)
+      end
+
+      def query_options
+        {}.tap do |options|
+          options[:q] = self.query unless self.query.nil?
+          options[:sort] = self.sort unless self.sort.nil?
+          options[:rows] = self.rows unless self.rows.nil?
+          options[:start] = self.start unless self.start.nil?
+        end
+      end
+    end
+
+  module DSL
+    # 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 = {})
+      Search.new(self, index, query, options).run
+    end
+
+    # Return the array of all possible search indexes for the including connection
+    #
+    # @example
+    #   conn = Ridley.connection(...)
+    #   conn.search_indexes => 
+    #     [:client, :environment, :node, :role, :"ridley-two", :"ridley-one"]
+    #
+    # @return [Array<Symbol, String>]
+    def search_indexes
+      Search.indexes(self)
+    end
+  end
+end

data/lib/ridley/version.rb

@@ -1,3 +1,3 @@
 module Ridley
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/ridley.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.name          = "ridley"
   s.require_paths = ["lib"]
   s.version       = Ridley::VERSION
+  s.required_ruby_version = ">= 1.9.1"
 
   s.add_runtime_dependency 'yajl-ruby'
   s.add_runtime_dependency 'mixlib-log'

data/spec/acceptance/search_resource_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe "Role API operations", type: "acceptance" do
+  let(:server_url) { "https://api.opscode.com" }
+  let(:client_name) { "reset" }
+  let(:client_key) { "/Users/reset/.chef/reset.pem" }
+  let(:organization) { "ridley" }
+
+  let(:connection) do
+    Ridley.connection(
+      server_url: server_url,
+      client_name: client_name,
+      client_key: client_key,
+      organization: organization
+    )
+  end
+
+  before(:all) { WebMock.allow_net_connect! }
+  after(:all) { WebMock.disable_net_connect! }
+
+  describe "listing indexes" do
+    it "returns an array of indexes" do
+      indexes = connection.search_indexes
+
+      indexes.should include(:role)
+      indexes.should include(:node)
+      indexes.should include(:client)
+    end
+  end
+
+  describe "showing an index" do
+    before(:each) do
+      @result = connection.search(:node)
+    end
+
+    it "returns a hash with a total key" do
+      @result.should have_key(:total)
+    end
+
+    it "returns a hash with a start key" do
+      @result.should have_key(:start)
+    end
+
+    it "returns a hash with a rows key" do
+      @result.should have_key(:rows)
+    end
+  end
+
+  describe "searching an index that doesn't exist" do
+    it "it raises a Ridley::Errors::HTTPNotFound error" do
+      lambda {
+        connection.search(:notthere)
+      }.should raise_error(Ridley::Errors::HTTPNotFound)
+    end
+  end
+end

data/spec/unit/ridley/resources/search_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Ridley::Search do
+  let(:connection) { double('connection') }
+  let(:index) { :role }
+  let(:query) { "*:*" }
+  let(:response) { double("response", body: Hash.new) }
+
+  describe "ClassMethods" do
+    subject { Ridley::Search }
+
+    describe "::indexes" do
+      it "sends a get request to the connection to receive the indexes" do
+        connection.should_receive(:get).with("search").and_return(response)
+
+        subject.indexes(connection)
+      end
+    end
+  end
+
+  describe "#run" do
+    subject do
+      Ridley::Search.new(connection, index, query)
+    end
+
+    it "sends a get request to the connection to the index's location with the given query" do
+      connection.should_receive(:get).with("search/#{index}", q: query).and_return(response)
+
+      subject.run
+    end
+
+    context "when 'sort' is set" do
+      let(:sort) { "DESC" }
+      before(:each) { subject.sort = sort }
+
+      it "sends a get request to the connection with a query parameter for 'set'" do
+        connection.should_receive(:get).with("search/#{index}", q: query, sort: sort).and_return(response)
+
+        subject.run
+      end
+    end
+
+    context "when 'start' is set" do
+      let(:start) { 1 }
+      before(:each) { subject.start = start }
+
+      it "sends a get request to the connection with a query parameter for 'start'" do
+        connection.should_receive(:get).with("search/#{index}", q: query, start: start).and_return(response)
+
+        subject.run
+      end
+    end
+
+    context "when 'rows' is set" do
+      let(:rows) { 1 }
+      before(:each) { subject.rows = rows }
+
+      it "sends a get request to the connection with a query parameter for 'rows'" do
+        connection.should_receive(:get).with("search/#{index}", q: query, rows: rows).and_return(response)
+
+        subject.run
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridley
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -363,6 +363,7 @@ files:
 - lib/ridley/resources/environment.rb
 - lib/ridley/resources/node.rb
 - lib/ridley/resources/role.rb
+- lib/ridley/resources/search.rb
 - lib/ridley/version.rb
 - ridley.gemspec
 - spec/acceptance/client_resource_spec.rb
@@ -372,6 +373,7 @@ files:
 - spec/acceptance/environment_resource_spec.rb
 - spec/acceptance/node_resource_spec.rb
 - spec/acceptance/role_resource_spec.rb
+- spec/acceptance/search_resource_spec.rb
 - spec/fixtures/reset.pem
 - spec/spec_helper.rb
 - spec/support/each_matcher.rb
@@ -390,6 +392,7 @@ files:
 - spec/unit/ridley/resources/environment_spec.rb
 - spec/unit/ridley/resources/node_spec.rb
 - spec/unit/ridley/resources/role_spec.rb
+- spec/unit/ridley/resources/search_spec.rb
 - spec/unit/ridley_spec.rb
 homepage: https://github.com/reset/ridley
 licenses: []
@@ -402,10 +405,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3057633279662549305
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -414,7 +414,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3057633279662549305
+      hash: -2920625488512692680
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -429,6 +429,7 @@ test_files:
 - spec/acceptance/environment_resource_spec.rb
 - spec/acceptance/node_resource_spec.rb
 - spec/acceptance/role_resource_spec.rb
+- spec/acceptance/search_resource_spec.rb
 - spec/fixtures/reset.pem
 - spec/spec_helper.rb
 - spec/support/each_matcher.rb
@@ -447,5 +448,6 @@ test_files:
 - spec/unit/ridley/resources/environment_spec.rb
 - spec/unit/ridley/resources/node_spec.rb
 - spec/unit/ridley/resources/role_spec.rb
+- spec/unit/ridley/resources/search_spec.rb
 - spec/unit/ridley_spec.rb
 has_rdoc: