ripple 0.5.0

data/lib/riak/util/headers.rb

@@ -0,0 +1,44 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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 'riak'
+
+module Riak
+  module Util
+    # Represents headers from an HTTP response
+    class Headers
+      include Net::HTTPHeader
+
+      def initialize
+        initialize_http_header({})
+      end
+      
+      # Parse a single header line into its key and value
+      # @param [String] chunk a single header line
+      def self.parse(chunk)
+        line = chunk.strip
+        # thanks Net::HTTPResponse
+        return [nil,nil] if chunk =~ /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)\s*(.*)\z/in
+        m = /\A([^:]+):\s*/.match(line)
+        [m[1], m.post_match] rescue [nil, nil]
+      end
+      
+      # Parses a header line and adds it to the header collection
+      # @param [String] chunk a single header line
+      def parse(chunk)
+        key, value = self.class.parse(chunk)
+        add_field(key, value) if key && value
+      end
+    end
+  end
+end

data/lib/riak/util/multipart.rb

@@ -0,0 +1,52 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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 'riak'
+
+module Riak
+  module Util
+    # Utility methods for handling multipart/mixed responses
+    module Multipart
+      extend self
+      # Parses a multipart/mixed body into its constituent parts, including nested multipart/mixed sections
+      # @param [String] data the multipart body data
+      # @param [String] boundary the boundary string given in the Content-Type header
+      def parse(data, boundary)
+        contents = data.match(/\n--#{Regexp.escape(boundary)}--\n/).pre_match rescue ""
+        contents.split(/\n--#{Regexp.escape(boundary)}\n/).reject(&:blank?).map do |part|
+          headers = Headers.new
+          if md = part.match(/\r?\n\r?\n/)
+            body = md.post_match
+            md.pre_match.split(/\r?\n/).each do |line|
+              headers.parse(line)
+            end
+
+            if headers["content-type"] =~ /multipart\/mixed/
+              boundary = extract_boundary(headers.to_hash["content-type"].first)
+              parse(body, boundary)
+            else
+              {:headers => headers.to_hash, :body => body}
+            end
+          end
+        end.compact
+      end
+
+      # Extracts the boundary string from a Content-Type header that is a multipart type
+      # @param [String] header_string the Content-Type header
+      # @return [String] the boundary string separating each part
+      def extract_boundary(header_string)
+        $1 if header_string =~ /boundary=([A-Za-z0-9\'()+_,-.\/:=?]+)/
+      end
+    end
+  end
+end

data/lib/riak/util/translation.rb

@@ -0,0 +1,29 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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 'riak'
+
+module Riak
+  module Util
+    module Translation
+      def i18n_scope
+        :riak
+      end
+
+      def t(message, options={})
+        I18n.t("#{i18n_scope}.#{message}", options)
+      end
+    end
+  end
+end
+

data/lib/riak/walk_spec.rb

@@ -0,0 +1,113 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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 'riak'
+
+module Riak
+
+  # The specification of how to follow links from one object to another in Riak,
+  # when using the link-walker resource.
+  # Example link-walking operation:
+  #   GET /raw/artists/REM/albums,_,_/tracks,_,1
+  # This operation would have two WalkSpecs:
+  #   Riak::WalkSpec.new({:bucket => 'albums'})
+  #   Riak::WalkSpec.new({:bucket => 'tracks', :result => true})
+  class WalkSpec
+    include Util::Translation
+    # @return [String] The bucket followed links should be restricted to. "_" represents all buckets.
+    attr_accessor :bucket
+
+    # @return [String] The "riaktag" or "rel" that followed links should be restricted to. "_" represents all tags.
+    attr_accessor :tag
+
+    # @return [Boolean] Whether objects should be returned from this phase of link walking. Default is false.
+    attr_accessor :keep
+
+    # Normalize a list of walk specs into WalkSpec objects.
+    def self.normalize(*params)
+      params.flatten!
+      specs = []
+      while params.length > 0
+        param = params.shift
+        case param
+        when Hash
+          specs << new(param)
+        when WalkSpec
+          specs << param
+        else
+          if params.length >= 2
+            specs << new(param, params.shift, params.shift)
+          else
+            raise ArgumentError, t("too_few_arguments", :params => params.inspect)
+          end
+        end
+      end
+      specs
+    end
+
+    # Creates a walk-spec for use in finding other objects in Riak.
+    # @overload initialize(hash)
+    #   Creates a walk-spec from a hash.
+    #   @param [Hash] hash options for the walk-spec
+    #   @option hash [String] :bucket ("_") the bucket the links should point to (default '_' is all)
+    #   @option hash [String] :tag ("_") the tag to filter links by (default '_' is all)
+    #   @option hash [Boolean] :keep (false) whether to return results from following this link specification
+    # @overload initialize(bucket, tag, keep)
+    #   Creates a walk-spec from a bucket-tag-result triple.
+    #   @param [String] bucket the bucket the links should point to (default '_' is all)
+    #   @param [String] tag the tag to filter links by (default '_' is all)
+    #   @param [Boolean] keep whether to return results from following this link specification
+    # @see {Riak::RObject#walk}
+    def initialize(*args)
+      args.flatten!
+      case args.size
+      when 1
+        hash = args.first
+        raise ArgumentError, t("hash_type", :hash => hash.inspect) unless Hash === hash
+        assign(hash[:bucket], hash[:tag], hash[:keep])
+      when 3
+        assign(*args)
+      else
+        raise ArgumentError, t("wrong_argument_count_walk_spec")
+      end
+    end
+
+    # Converts the walk-spec into the form required by the link-walker resource URL
+    def to_s
+      "#{@bucket || '_'},#{@tag || '_'},#{@keep ? '1' : '_'}"
+    end
+
+    def ==(other)
+      other.is_a?(WalkSpec) && other.bucket == bucket && other.tag == tag && other.keep == keep
+    end
+
+    def ===(other)
+      self == other || case other
+                       when WalkSpec
+                         other.keep == keep &&
+                           (bucket == "_" || bucket == other.bucket) &&
+                           (tag == "_" || tag == other.tag)
+                       when Link
+                         (bucket == "_" || bucket == other.url.split("/")[2]) &&
+                           (tag == "_" || tag == other.rel)
+                       end
+    end
+
+    private
+    def assign(bucket, tag, result)
+      @bucket = bucket || "_"
+      @tag = tag || "_"
+      @keep = result || false
+    end
+  end
+end

data/lib/ripple.rb

@@ -0,0 +1,48 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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 'riak'
+require 'active_support/all'
+require 'active_model'
+require 'ripple/i18n'
+
+# Contains the classes and modules related to the ODM built on top of
+# the basic Riak client.
+module Ripple
+  extend ActiveSupport::Autoload
+  include ActiveSupport::Configurable
+
+  autoload :EmbeddedDocument
+  autoload :Document
+  autoload :PropertyTypeMismatch
+  autoload :Translation
+
+  class << self
+    # @return [Riak::Client] The client for the current thread.
+    def client
+      Thread.current[:ripple_client] ||= Riak::Client.new
+    end
+
+    # Sets the client for the current thread.
+    # @param [Riak::Client] value the client
+    def client=(value)
+      Thread.current[:ripple_client] = value
+    end
+
+    def config=(value)
+      self.client = nil
+      super
+    end
+  end
+end

data/lib/ripple/core_ext/casting.rb

@@ -0,0 +1,96 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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.
+
+# @private
+class Object
+  def self.ripple_cast(value)
+    value
+  end
+end
+
+# @private
+class Symbol
+  def self.ripple_cast(value)
+    return nil if value.nil?
+    value.respond_to?(:to_s) && value.to_s.intern or raise Ripple::PropertyTypeMismatch.new(self, value)
+  end
+end
+
+# @private
+class Numeric
+  def self.ripple_cast(value)
+    return nil if value.nil?
+    raise Ripple::PropertyTypeMismatch.new(self,value) unless value.respond_to?(:to_i) && value.respond_to?(:to_f)
+    float_value = value.to_f
+    int_value = value.to_i
+    float_value == int_value ? int_value : float_value
+  end
+end
+
+# @private
+class Integer
+  def self.ripple_cast(value)
+    return nil if value.nil?
+    value.respond_to?(:to_i) && value.to_i or raise Ripple::PropertyTypeMismatch.new(self, value)
+  end
+end
+
+# @private
+class Float
+  def self.ripple_cast(value)
+    return nil if value.nil?
+    value.respond_to?(:to_f) && value.to_f or raise Ripple::PropertyTypeMismatch.new(self, value)
+  end
+end
+
+# @private
+class String
+  def self.ripple_cast(value)
+    value.respond_to?(:to_s) && value.to_s or raise Ripple::PropertyTypeMismatch.new(self, value)
+  end
+end
+
+# Stand-in for true/false property types.
+module Boolean
+  def self.ripple_cast(value)
+    case value
+    when NilClass
+      nil
+    when Numeric
+      !value.zero?
+    when TrueClass, FalseClass
+      value
+    when /^\s*t/i
+      true
+    when /^\s*f/i
+      false
+    else
+      value.present?
+    end
+  end
+end
+
+# @private
+class TrueClass
+  def self.ripple_cast(value)
+    Boolean.ripple_cast(value)
+  end
+end
+
+# @private
+class FalseClass
+  def self.ripple_cast(value)
+    Boolean.ripple_cast(value)
+  end
+end

data/lib/ripple/document.rb

@@ -0,0 +1,60 @@
+# Copyright 2010 Sean Cribbs, Sonian Inc., and Basho Technologies, Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License 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 'ripple'
+
+module Ripple
+  # Represents a model stored in Riak, serialized in JSON object (document).
+  # Ripple::Document models aim to be fully ActiveModel compatible, with a keen
+  # eye toward features that developers expect from ActiveRecord, DataMapper and MongoMapper.
+  #
+  # Example:
+  #
+  #   class Email
+  #     include Ripple::Document
+  #     property :from,    String, :presence => true
+  #     property :to,      String, :presence => true
+  #     property :sent,    Time,   :default => proc { Time.now }
+  #     property :body,    String
+  #   end
+  #
+  #   email = Email.find("37458abc752f8413e")  # GET /raw/emails/37458abc752f8413e
+  #   email.from = "someone@nowhere.net"
+  #   email.save                               # PUT /raw/emails/37458abc752f8413e
+  #
+  #   reply = Email.new
+  #   reply.from = "justin@bashoooo.com"
+  #   reply.to   = "sean@geeemail.com"
+  #   reply.body = "Riak is a good fit for scalable Ruby apps."
+  #   reply.save                               # POST /raw/emails (Riak-assigned key)
+  #
+  module Document
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Autoload
+
+    autoload :AttributeMethods
+    autoload :BucketAccess
+    autoload :Finders
+    autoload :Persistence
+    autoload :Properties
+    autoload :Property, "ripple/document/properties"
+    autoload :Validations
+
+    included do
+      extend BucketAccess
+      include Persistence
+      include EmbeddedDocument
+      include Finders
+    end
+  end
+end