aws-sdk 1.0.0

data/lib/aws/record/attributes/boolean.rb

@@ -0,0 +1,49 @@
+# Copyright 2011 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/record/attribute'
+
+module AWS
+  module Record
+
+    # @private
+    class BooleanAttribute < Attribute
+
+      def self.type_cast raw_value, options = {}
+        case raw_value
+        when nil then nil
+        when '' then nil
+        when false, 'false', '0', 0 then false
+        else true
+        end
+      end
+
+      def self.serialize boolean, options = {}
+        case boolean
+        when false then '0'
+        when true  then '1'
+        else 
+          msg = "expected a boolean value, got #{boolean.class}"
+          raise ArgumentError, msg
+        end
+      end
+
+      # @private
+      def self.allow_set?
+        false
+      end
+
+    end
+
+  end
+end

data/lib/aws/record/attributes/datetime.rb

@@ -0,0 +1,86 @@
+# Copyright 2011 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/record/attribute'
+
+module AWS
+  module Record
+
+    # @private
+    class DateTimeAttribute < Attribute
+
+      # Returns value cast to a DateTime object.  Empty strings are cast to 
+      # nil.  Values are cast first to strings and then passed to 
+      # DateTime.parse.  Integers are treated as timestamps.
+      #
+      #   datetime_attribute.type_cast('2000-01-02')
+      #   #=> #<DateTime: 4903091/2,0,2299161>
+      #
+      #   datetime_attribute.type_cast(1306170146)
+      #   #<DateTime: 106086465073/43200,-7/24,2299161>
+      #
+      #   datetime_attribute.type_cast('')
+      #   #=> nil
+      #
+      #   datetime_attribute.type_cast(nil)
+      #   #=> nil
+      #
+      # @param [Mixed] raw_value The value to cast to a DateTime object.
+      # @param [Hash] options
+      # @return [DateTime,nil]
+      def self.type_cast raw_value, options = {}
+        case raw_value
+        when nil      then nil
+        when ''       then nil
+        when DateTime then raw_value
+        when Integer  then 
+          begin
+            DateTime.parse(Time.at(raw_value).to_s) # timestamp
+          rescue
+            nil
+          end
+        else 
+          begin
+            DateTime.parse(raw_value.to_s) # Time, Date or String
+          rescue
+            nil
+          end
+        end
+      end
+
+      # Returns a DateTime object encoded as a string (suitable for sorting).
+      #
+      #   attribute.serialize(DateTime.parse('2001-01-01'))
+      #   #=> '2001-01-01T00:00:00:Z)
+      #
+      # @param [DateTime] datetime The datetime object to serialize.
+      # @param [Hash] options
+      # @return [String] Returns the datetime object serialized to a string
+      #   in ISO8601 format (e.g. '2011-01-02T10:11:12Z')
+      def self.serialize datetime, options = {}
+        unless datetime.is_a?(DateTime)
+          msg = "expected a DateTime value, got #{datetime.class}"
+          raise ArgumentError, msg  
+        end
+        datetime.strftime('%Y-%m-%dT%H:%M:%S%Z')
+      end
+
+      # @private
+      def self.allow_set?
+        true
+      end
+
+    end
+
+  end
+end

data/lib/aws/record/attributes/float.rb

@@ -0,0 +1,48 @@
+# Copyright 2011 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/record/attribute'
+
+module AWS
+  module Record
+
+    # @private
+    class FloatAttribute < Attribute
+      
+      def self.type_cast raw_value, options = {}
+        case raw_value
+        when nil   then nil
+        when ''    then nil
+        when Float then raw_value
+        else
+          raw_value.respond_to?(:to_f) ? 
+            raw_value.to_f :
+            raw_value.to_s.to_f
+        end
+      end
+
+      def self.serialize float, options = {}
+        expect(Float, float) do
+          float.to_s
+        end
+      end
+
+      # @private
+      def self.allow_set?
+        true
+      end
+
+    end
+
+  end
+end

data/lib/aws/record/attributes/integer.rb

@@ -0,0 +1,68 @@
+# Copyright 2011 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/record/attribute'
+
+module AWS
+  module Record
+
+    # @private
+    class IntegerAttribute < Attribute
+      
+      # Returns value cast to an integer.  Empty strings are cast to 
+      # nil by default.  Type casting is done by calling #to_i on the value.
+      #
+      #   int_attribute.type_cast('123')
+      #   #=> 123
+      #
+      #   int_attribute.type_cast('')
+      #   #=> nil
+      #
+      # @param [Mixed] value The value to type cast to an integer.
+      # @return [Integer,nil] Returns the type casted integer or nil
+      def self.type_cast raw_value, options = {}
+        case raw_value
+        when nil      then nil
+        when ''       then nil
+        when Integer  then raw_value
+        else
+          raw_value.respond_to?(:to_i) ? 
+            raw_value.to_i :
+            raw_value.to_s.to_i
+        end
+      end
+
+      # Returns a serialized representation of the integer value suitable for
+      # storing in SimpleDB.
+      #
+      #   attribute.serialize(123)
+      #   #=> '123'
+      #
+      # @param [Integer] integer The number to serialize.
+      # @param [Hash] options
+      # @return [String] A serialized representation of the integer.
+      def self.serialize integer, options = {}
+        expect(Integer, integer) do
+          integer.to_s
+        end
+      end
+
+      # @private
+      def self.allow_set?
+        true
+      end
+
+    end
+
+  end
+end

data/lib/aws/record/attributes/sortable_float.rb

@@ -0,0 +1,60 @@
+# Copyright 2011 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/record/attribute'
+
+module AWS
+  module Record
+
+    # @private
+    class SortableFloatAttribute < FloatAttribute
+
+      def initialize name, options = {}
+
+        range = options[:range]
+        raise ArgumentError, "missing required option :range" unless range
+        raise ArgumentError, ":range should be an integer range" unless
+          range.is_a?(Range) and range.first.is_a?(Integer)
+
+        super(name, options)
+
+      end
+
+      def self.serialize float, options = {}
+        expect(Float, float) do 
+
+          left, right = float.to_s.split('.')
+
+          left = SortableIntegerAttribute.serialize(left.to_i, options)
+
+          SortableIntegerAttribute.check_range(float, options)
+
+          "#{left}.#{right}"
+
+        end
+      end
+
+      def self.deserialize string_value, options = {}
+
+        left, right = float.to_s.split('.')
+
+        left = SortableIntegerAttribute.deserialize(left, options)
+
+        "#{left}.#{right}".to_f
+
+      end
+
+    end
+
+  end
+end

data/lib/aws/record/attributes/sortable_integer.rb

@@ -0,0 +1,95 @@
+# Copyright 2011 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/record/attributes/integer'
+
+module AWS
+  module Record
+
+    # @private
+    class SortableIntegerAttribute < IntegerAttribute
+
+      def initialize name, options = {}
+
+        range = options[:range]
+        raise ArgumentError, "missing required option :range" unless range
+        raise ArgumentError, ":range should be a integer range" unless
+          range.is_a?(Range) and range.first.is_a?(Integer)
+
+        super(name, options)
+
+      end
+      
+      # Returns a serialized representation of the integer value suitable for
+      # storing in SimpleDB.
+      #
+      #   attribute.serialize(123)
+      #   #=> '123'
+      #
+      #   # padded to the correct number of digits
+      #   attribute.serialize('123', :range => (0..10_000)
+      #   #=> '00123'
+      #
+      #   # offset applied to make all values positive
+      #   attribute.serialize('-55', :range => (-100..10_000)
+      #   #=> '00045'
+      #
+      # @param [Integer] integer The number to serialize.
+      # @param [Hash] options
+      # @option options [required,Range] :range A range that represents the 
+      #   minimum and maximum values this integer can be.
+      #   The returned value will have an offset applied (if min is
+      #   less than 0) and will be zero padded.
+      # @return [String] A serialized representation of the integer.
+      def self.serialize integer, options = {}
+        expect(Integer, integer) do
+          check_range(integer, options)
+          offset_and_precision(options) do |offset,precision|
+            "%0#{precision}d" % (integer.to_i + offset)
+          end
+        end
+      end
+
+      def self.deserialize string_value, options = {}
+        offset_and_precision(options) do |offset,precision|
+          string_value.to_i - offset
+        end
+      end
+
+      # @private
+      protected
+      def self.offset_and_precision options, &block
+
+        min = options[:range].first
+        max = options[:range].last
+
+        offset = min < 0 ? min * -1 : 0
+        precision = (max + offset).to_s.length
+
+        yield(offset, precision)
+
+      end
+
+      # @private
+      def self.check_range number, options
+        unless options[:range].include?(number)
+          msg = "unable to serialize `#{number}`, falls outside " +
+           "the range #{options[:range]}"
+          raise msg
+        end
+      end
+
+    end
+
+  end
+end

data/lib/aws/record/attributes/string.rb

@@ -0,0 +1,69 @@
+# Copyright 2011 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/record/attribute'
+
+module AWS
+  module Record
+
+    # @private
+    class StringAttribute < Attribute
+
+      # Returns the value cast to a string.  Empty strings are returned as 
+      # nil by default.  Type casting is done by calling #to_s on the value.
+      #
+      #   string_attr.type_cast(123)
+      #   # => '123'
+      #
+      #   string_attr.type_cast('')
+      #   # => nil
+      #
+      #   string_attr.type_cast('', :preserve_empty_strings => true)
+      #   # => ''
+      #
+      # @param [Mixed] value
+      # @param [Hash] options
+      # @option options [Boolean] :preserve_empty_strings (false) When true,
+      #   empty strings are preserved and not cast to nil.  
+      # @return [String,nil] The type casted value.
+      def self.type_cast raw_value, options = {}
+        case raw_value
+        when nil     then nil
+        when ''      then options[:preserve_empty_strings] ? '' : nil
+        when String  then raw_value
+        else raw_value.to_s
+        end
+      end
+
+      # Returns a serialized representation of the string value suitable for
+      # storing in SimpleDB.
+      # @param [String] string
+      # @param [Hash] options
+      # @return [String] The serialized string.
+      def self.serialize string, options = {}
+        unless string.is_a?(String)
+          msg = "expected a String value, got #{string.class}"
+          raise ArgumentError, msg  
+        end
+        string
+      end
+
+      # @private
+      def self.allow_set?
+        true
+      end
+
+    end
+
+  end
+end