aws-sdk 1.2.6 → 1.3.0

data/lib/aws/record/finder_methods.rb

@@ -1,230 +0,0 @@
-# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-require 'aws/simple_db'
-require 'aws/record/scope'
-
-module AWS
-  module Record
-
-    module FinderMethods
-  
-      # @param [String] id The id of the record to load.
-      # @param [Hash] options
-      # @option options [String] :domain Specifies what domain
-      #   should be searched.
-      # @raise [RecordNotFound] Raises a record not found exception if there
-      #   was no data found for the given id.
-      # @return [Record::Base] Returns the record, as a sub-class of 
-      #   Record::Base
-      def find_by_id id, options = {}
-
-        domain = sdb_domain(options[:domain])
-
-        data = domain.items[id].data.attributes
-
-        raise RecordNotFound, "no data found for id: #{id}" if data.empty?
-
-        obj = self.new(:domain => domain)
-        obj.send(:hydrate, id, data)
-        obj
-
-      end
-      alias_method :[], :find_by_id
-
-      # Finds records in SimpleDB and returns them as objects of the 
-      # current class.
-      #
-      # Finding +:all+ returns an enumerable scope object
-      #
-      #  People.find(:all, :order => [:age, :desc], :limit => 10).each do |person|
-      #    puts person.name
-      #  end
-      #
-      # Finding +:first+ returns a single record (or nil)
-      #
-      #  boss = People.find(:first, :where => { :boss => true })
-      #
-      # Find accepts a hash of find modifiers (+:where+, +:order+ and
-      # +:limit+).  You can also choose to omit these modifiers and
-      # chain them on the scope object returned.  In the following
-      # example only one request is made to SimpleDB (when #each is
-      # called)
-      #
-      #   people = People.find(:all)
-      #
-      #   johns = people.where(:name => 'John Doe')
-      #
-      #   johns.order(:age, :desc).limit(10).each do |suspects|
-      #     # ...
-      #   end
-      #
-      # See also {#where}, {#order} and {#limit} for more
-      # information and options.
-      #
-      # @overload find(id)
-      #   @param id The record to find, raises an exception if the record is
-      #     not found.
-      #
-      # @overload find(mode, options = {})
-      #   @param [:all,:first] mode (:all) When finding +:all+ matching records
-      #     and array is returned of records.  When finding +:first+ then
-      #     +nil+ or a single record will be returned.
-      #   @param [Hash] options
-      #   @option options [Mixed] :where Conditions that determine what
-      #     records are returned.
-      #   @option options [String,Array] :sort The order records should be 
-      #     returned in.
-      #   @option options [Integer] :limit The max number of records to fetch.
-      def find *args
-        _new_scope.find(*args)
-      end
-
-      # Returns a chainable scope object that restricts further scopes to a
-      # particular domain
-      #
-      #  Book.domain('shard_3').all.each do |book|
-      #    # ...
-      #  end
-      #
-      # @param [String] domain
-      # @return [Scope] Returns a scope for restricting the domain of subsequent
-      def domain name
-        _new_scope.domain(name)
-      end
-
-      # Returns an enumerable scope object represents all records.
-      #
-      #   Book.all.each do |book|
-      #     # ...
-      #   end
-      #
-      # This method is equivalent to +find(:all)+, and therefore you can also
-      # pass aditional options.  See {#find} for more information on what 
-      # options you can pass.
-      #
-      #   Book.all(:where => { :author' => 'me' }).each do |my_book|
-      #     # ...
-      #   end
-      #
-      # @return [Scope] Returns an enumerable scope object.
-      def all options = {}
-        _new_scope.find(:all, options)
-      end
-
-      # Counts records in SimpleDB.
-      #
-      # With no arguments, counts all records:
-      #
-      #   People.count
-      #
-      # Accepts query options to count a subset of records:
-      #
-      #   People.count(:where => { :boss => true })
-      #
-      # You can also count records on a scope object:
-      #
-      #   People.find(:all).where(:boss => true).count
-      #
-      # See {#find} and {Scope#count} for more details.
-      #
-      # @param [Hash] options (<code>{}</code>) Options for counting
-      #   records.
-      #
-      # @option options [Mixed] :where Conditions that determine what
-      #   records are counted.
-      # @option options [Integer] :limit The max number of records to count.
-      def count(options = {})
-        _new_scope.count(options)
-      end
-      alias_method :size, :count
-
-      # @return [Object,nil] Returns the first record found for the current
-      #   class.  If there are no records in the current classes domain, then
-      #   nil is returned.
-      def first options = {}
-        _new_scope.first(options)
-      end
-
-      # Limits which records are retried from SimpleDB when performing a find.
-      #   
-      # Simple string condition
-      #
-      #   Car.where('color = "red" or color = "blue"').each {|car| ... }
-      #   
-      # String with placeholders for quoting params
-      #
-      #   Car.where('color = ?', 'red')
-      #
-      #   Car.where('color = ? OR style = ?', 'red', 'compact')
-      #
-      #   # produces a condition using in, like: WHERE color IN ('red', 'blue')
-      #   Car.where('color IN ?', ['red','blue'])
-      # 
-      # Hash arguments
-      #
-      #   # WHERE age = '40' AND gender = 'male'
-      #   People.where(:age => 40, :gender => 'male').each {|person| ... }
-      #
-      #   # WHERE name IN ('John', 'Jane')
-      #   People.where(:name => ['John', 'Jane']).each{|person| ... }
-      #
-      # Chaining where with other scope modifiers
-      #
-      #   # 10 most expensive red cars
-      #   Car.where(:color => 'red').order(:price, :desc).limit(10)
-      #   
-      # @overload where(conditions_hash)
-      # @overload where(sql_fragment[, quote_params, ...])
-      #
-      # @param [Hash] conditions_hash A hash of attributes to values.  Each 
-      #   key/value pair from the hash becomes a find condition.  All conditions
-      #   are joined by AND.
-      def where *args
-        _new_scope.where(*args)
-      end
-
-      # Defines the order in which records are returned when performing a find.
-      # SimpleDB only allows sorting by one attribute per request.
-      #
-      #   # oldest to youngest
-      #   People.order(:age, :desc).each {|person| ... }
-      #
-      # You can chain order with the other scope modifiers:
-      #
-      #   Pepole.order(:age, :desc).limit(10).each {|person| ... }
-      #
-      # @overload order(attribute, direction = :asc)
-      # @param [String,Symbol] attribute The attribute in SimpleDB to sort by.
-      # @param [:asc,:desc] direction (:asc) The direction to sort, ascending
-      #   or descending order.
-      def order *args
-        _new_scope.order(*args)
-      end
-
-      # The maximum number of records to return.  By default, all records
-      # matching the where conditions will be returned from a find.
-      # 
-      #   People.limit(10).each {|person| ... }
-      #
-      # Limit can be chained with other scope modifiers:
-      #
-      #   People.where(:age => 40).limit(10).each {|person| ... }
-      #
-      def limit limit
-        _new_scope.limit(limit)
-      end
-
-    end
-  end
-end

data/lib/aws/record/scopes.rb

@@ -1,55 +0,0 @@
-# Copyright 2011-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"). You
-# may not use this file except in compliance with the License. A copy of
-# the License is located at
-#
-#     http://aws.amazon.com/apache2.0/
-#
-# or in the "license" file accompanying this file. This file is
-# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-# ANY KIND, either express or implied. See the License for the specific
-# language governing permissions and limitations under the License.
-
-require 'aws/simple_db'
-require 'aws/record/scope'
-
-module AWS
-  module Record
-
-    module Scopes
-
-      # Adds a scoped finder method to this class.  Given a call
-      # to scope like:
-      #
-      #   scope :top_10, order(:popularity, :desc).limit(10) 
-      #
-      # Then you can call the method +top_10+ on the class and it will
-      # return an enumerable scope object with the given find conditions.
-      #
-      # @param [Symbol] name The name of the scope.  Scope names should be
-      #   method-safe and should not conflict with any other class methods.
-      #
-      def scope name, scope = nil, &block
-        
-        raise ArgumentError, "only a scope or block may be passed, not both" if
-          scope and block_given?
-
-        method_definition = scope ? 
-          lambda{ scope } :
-          block
-
-        extend(Module.new { define_method(name, &method_definition) })
-
-      end
-
-      # @return [Scope] Returns a new scope object for this class.
-      # @private
-      private
-      def _new_scope
-        Scope.new(self)
-      end
-
-    end
-  end
-end