RubyGems - ripple - Versions diffs - 0.6.1 → 0.7.0 - Mend

ripple 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (110) hide show

data/Rakefile +61 -48
data/lib/ripple.rb +5 -1
data/lib/ripple/core_ext/casting.rb +3 -0
data/lib/ripple/document.rb +6 -2
data/lib/ripple/document/associations.rb +154 -0
data/lib/ripple/document/{persistence/callbacks.rb → associations/embedded.rb} +20 -24
data/lib/ripple/document/associations/instantiators.rb +41 -0
data/lib/{riak/util/translation.rb → ripple/document/associations/linked.rb} +14 -11
data/lib/ripple/document/associations/many.rb +52 -0
data/lib/ripple/document/associations/many_embedded_proxy.rb +49 -0
data/lib/{riak/i18n.rb → ripple/document/associations/one.rb} +18 -2
data/lib/ripple/document/associations/one_embedded_proxy.rb +41 -0
data/lib/ripple/document/associations/proxy.rb +125 -0
data/lib/ripple/document/attribute_methods.rb +8 -1
data/lib/ripple/document/attribute_methods/read.rb +4 -0
data/lib/ripple/document/attribute_methods/write.rb +4 -0
data/lib/ripple/document/bucket_access.rb +1 -1
data/lib/ripple/document/callbacks.rb +75 -0
data/lib/ripple/document/finders.rb +50 -3
data/lib/ripple/document/persistence.rb +14 -6
data/lib/ripple/document/validations.rb +35 -7
data/lib/ripple/document/validations/associated_validator.rb +37 -0
data/lib/ripple/embedded_document.rb +8 -2
data/lib/{riak/map_reduce_error.rb → ripple/embedded_document/conversion.rb} +19 -5
data/lib/{riak/invalid_response.rb → ripple/embedded_document/finders.rb} +17 -8
data/lib/ripple/embedded_document/persistence.rb +75 -13
data/lib/ripple/locale/en.yml +7 -1
data/{spec/riak/net_http_backend_spec.rb → lib/ripple/railtie.rb} +17 -13
data/spec/fixtures/config.yml +3 -0
data/spec/integration/ripple/associations_spec.rb +81 -0
data/spec/integration/ripple/persistence_spec.rb +54 -0
data/spec/ripple/associations/many_embedded_proxy_spec.rb +124 -0
data/spec/ripple/associations/one_embedded_proxy_spec.rb +130 -0
data/spec/ripple/associations/proxy_spec.rb +78 -0
data/spec/ripple/associations_spec.rb +111 -0
data/spec/ripple/attribute_methods_spec.rb +37 -16
data/spec/ripple/bucket_access_spec.rb +3 -14
data/spec/ripple/callbacks_spec.rb +53 -9
data/spec/ripple/document_spec.rb +22 -6
data/spec/ripple/embedded_document/conversion_spec.rb +35 -0
data/spec/{riak/headers_spec.rb → ripple/embedded_document/finders_spec.rb} +17 -14
data/spec/ripple/embedded_document/persistence_spec.rb +86 -0
data/spec/ripple/embedded_document_spec.rb +1 -26
data/spec/ripple/finders_spec.rb +66 -30
data/spec/ripple/persistence_spec.rb +33 -21
data/spec/ripple/properties_spec.rb +1 -7
data/spec/ripple/ripple_spec.rb +10 -0
data/spec/ripple/timestamps_spec.rb +12 -19
data/spec/ripple/validations_spec.rb +48 -6
data/spec/spec_helper.rb +4 -10
data/spec/support/associations/proxies.rb +16 -0
data/spec/support/integration.rb +4 -0
data/spec/support/mocks.rb +3 -0
data/spec/support/models/address.rb +8 -0
data/spec/support/models/box.rb +6 -0
data/spec/support/models/cardboard_box.rb +3 -0
data/spec/support/models/clock.rb +6 -0
data/spec/support/models/customer.rb +4 -0
data/spec/support/models/email.rb +4 -0
data/spec/support/models/family.rb +14 -0
data/spec/support/models/favorite.rb +4 -0
data/spec/support/models/invoice.rb +6 -0
data/spec/support/models/late_invoice.rb +3 -0
data/spec/support/models/note.rb +4 -0
data/spec/support/models/page.rb +4 -0
data/spec/support/models/paid_invoice.rb +4 -0
data/spec/support/models/tree.rb +3 -0
data/spec/support/models/user.rb +6 -0
data/spec/support/models/widget.rb +6 -0
metadata +111 -138
data/.document +0 -5
data/.gitignore +0 -26
data/CONTRIBUTORS.textile +0 -5
data/LICENSE +0 -13
data/README.textile +0 -128
data/RELEASE_NOTES.textile +0 -68
data/VERSION +0 -1
data/lib/riak.rb +0 -46
data/lib/riak/bucket.rb +0 -157
data/lib/riak/client.rb +0 -139
data/lib/riak/client/curb_backend.rb +0 -82
data/lib/riak/client/http_backend.rb +0 -209
data/lib/riak/client/net_http_backend.rb +0 -49
data/lib/riak/failed_request.rb +0 -37
data/lib/riak/link.rb +0 -73
data/lib/riak/locale/en.yml +0 -37
data/lib/riak/map_reduce.rb +0 -248
data/lib/riak/robject.rb +0 -258
data/lib/riak/util/escape.rb +0 -12
data/lib/riak/util/fiber1.8.rb +0 -48
data/lib/riak/util/headers.rb +0 -44
data/lib/riak/util/multipart.rb +0 -52
data/lib/riak/walk_spec.rb +0 -117
data/ripple.gemspec +0 -169
data/spec/fixtures/cat.jpg +0 -0
data/spec/fixtures/multipart-blank.txt +0 -7
data/spec/fixtures/multipart-with-body.txt +0 -16
data/spec/riak/bucket_spec.rb +0 -230
data/spec/riak/client_spec.rb +0 -174
data/spec/riak/curb_backend_spec.rb +0 -50
data/spec/riak/escape_spec.rb +0 -17
data/spec/riak/http_backend_spec.rb +0 -131
data/spec/riak/link_spec.rb +0 -82
data/spec/riak/map_reduce_spec.rb +0 -352
data/spec/riak/multipart_spec.rb +0 -36
data/spec/riak/object_spec.rb +0 -532
data/spec/riak/walk_spec_spec.rb +0 -208
data/spec/spec.opts +0 -1
data/spec/support/http_backend_implementation_examples.rb +0 -215
data/spec/support/mock_server.rb +0 -58

data/.document DELETED

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore DELETED

@@ -1,26 +0,0 @@
-## MAC OS
-.DS_Store
-## TEXTMATE
-*.tmproj
-tmtags
-## EMACS
-*~
-\#*
-.\#*
-## VIM
-*.swp
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-## PROJECT::SPECIFIC
-_notes
-doc
-.yardoc
-create
-update-rails

data/CONTRIBUTORS.textile DELETED

@@ -1,5 +0,0 @@
-These developers have contributed code to Ripple:
-* Sean Cribbs - sean@basho.com
-* John Lynch - john@rigelgroupllc.com
-* Adam Hunter - adamhunter@me.com

data/LICENSE DELETED

@@ -1,13 +0,0 @@
-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.

data/README.textile DELETED

@@ -1,128 +0,0 @@
-h1. ripple
-ripple is a rich Ruby client for Riak, Basho's distributed database. It includes two namespaces:
-* @Riak@ contains a basic wrapper around typical operations, including bucket manipulation, object CRUD, link-walking, and map-reduce.
-* @Ripple@ contains an ActiveModel-compatible modeling layer that is inspired by ActiveRecord, DataMapper, and MongoMapper.
-h2. Dependencies
-ripple requires Ruby 1.8.7 or later and versions 3 or above of ActiveModel and ActiveSupport (and their dependencies, including i18n).  Please see the Rails 3 beta release notes for installing those gems.  I highly recommend the "curb":http://curb.rubyforge.org/ gem for better HTTP client performance.
-In development, you will also need these gems:
-* jeweler
-* rspec >= 1.3
-* fakeweb >= 1.2
-* curb >= 0.6
-* rack >= 1.0
-* yard >= 0.5.2
-h2. Basic Example
-<notextile><pre>require 'riak'
-# Create a client interface
-client = Riak::Client.new
-# Retrieve a bucket
-bucket = client.bucket("doc")  # a Riak::Bucket
-# Get an object from the bucket
-object = bucket.get("index.html")   # a Riak::RObject
-# Change the object's data and save
-object.data = "<html><body>Hello, world!</body></html>"
-object.store
-# Reload an object you already have
-object.reload                  # Works if you have the key and vclock, using conditional GET
-object.reload :force => true   # Reloads whether you have the vclock or not
-# Access more like a hash, client[bucket][key]
-client['doc']['index.html']   # the Riak::RObject
-# Create a new object
-new_one = Riak::RObject.new(bucket, "application.js")
-new_one.content_type = "application/javascript" # You must set the content type.
-new_one.data = "alert('Hello, World!')"
-new_one.store</pre></notextile>
-h2. Map-Reduce Example
-<notextile><pre>
-# Assuming you've already instantiated a client, get the album titles for The Beatles
-results = Riak::MapReduce.new(client).
-                add("artists","Beatles").
-                link(:bucket => "albums").
-                map("function(v){ return [JSON.parse(v.values[0].data).title]; }", :keep => true).run
-p results # => ["Please Please Me", "With The Beatles", "A Hard Day's Night",
-          #     "Beatles For Sale", "Help!", "Rubber Soul",
-          #     "Revolver", "Sgt. Pepper's Lonely Hearts Club Band", "Magical Mystery Tour",
-          #     "The Beatles", "Yellow Submarine", "Abbey Road", "Let It Be"]</pre></notextile>
-h2. Document model Example
-<notextile><pre>
-require 'ripple'
-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 /riak/emails/37458abc752f8413e
-email.from = "someone@nowhere.net"
-email.save                               # PUT /riak/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 /riak/emails (Riak-assigned key)
-</pre></notextile>
-h2. How to Contribute
-* Fork the project on "Github":http://github.com/seancribbs/ripple.  If you have already forked, use @git pull --rebase@ to reapply your changes on top of the mainline. Example:
-  <notextile><pre>$ git checkout master
-$ git pull --rebase seancribbs master</pre></notextile>
-* Create a topic branch. If you've already created a topic branch, rebase it on top of changes from the mainline "master" branch. Examples:
-** New branch:
-  <pre>$ git checkout -b topic</pre>
-** Existing branch:
-  <pre>$ git rebase master</pre>
-* Write an RSpec example, set of examples, and/or Cucumber story that demonstrate the necessity and validity of your changes. *Patches without specs will most often be ignored. Just do it, you'll thank me later.* Documentation patches need no specs, of course.
-* Make your feature addition or bug fix. Make your specs and stories pass (green).
-* Run the suite using multiruby or rvm to ensure cross-version compatibility.
-* Cleanup any trailing whitespace in your code (try @whitespace-mode@ in Emacs, or "Remove Trailing Spaces in Document" in the "Text" bundle in Textmate).
-* Commit, do not mess with Rakefile or VERSION.  If related to an existing issue in the "tracker":http://github.com/seancribbs/ripple/issues, include "Closes #X" in the commit message (where X is the issue number).
-* Send me a pull request.
-h2. License & Copyright
-Copyright &copy;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":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.
-h2. Auxillary Licenses
-The included photo (spec/fixtures/cat.jpg) is Copyright &copy;2009 "Sean Cribbs":http://seancribbs.com/, and is
-licensed under the "Creative Commons Attribution Non-Commercial 3.0":http://creativecommons.org/licenses/by-nc/3.0 license. !http://i.creativecommons.org/l/by-nc/3.0/88x31.png!
-The "Poor Man's Fibers" implementation (lib/riak/util/fiber1.8.rb) is Copyright &copy;2008 Aman Gupta.

data/RELEASE_NOTES.textile DELETED

@@ -1,68 +0,0 @@
-h1. Ripple Release Notes
-h2. 0.6.1 Patch Release - 2010-03-17
-This is a minor release with fixes for a few issues:
-* Riak::Link objects will now be unique when added to RObject#links
-  Set. [John Lynch]
-* Attributes on Ripple::Document classes are no longer clone, which had
-  prevented non-scalar properties from being modified directly (e.g. Array).
-* Buckets, keys, and walk specs are properly escaped in URLs
-  (including slashes).
-* Time-related properties properly convert to string formats in JSON that
-  they will work in the context of MapReduce jobs.
-h2. 0.6.0 Feature Release - 2010-03-05
-This release contains enhancements and bugfixes in preparation for the
-Riak 0.9 release.
-* The CurbBackend now uses fibers to prevent curl-handle corruption when
-  a block is given to streaming operations.
-* The default prefix is now "/riak/" to match the latest version of Riak.
-* The client configuration for Ripple is now used.
-* Added Bucket#new and Bucket#get_or_new for easily creating new objects.
-* Added Bucket#allow_mult and Bucket#n_value accessors for more easily setting
-  bucket properties.
-* Added timestamps! method for easily adding created_at/updated_at to documents.
-  [Adam Hunter]
-* The 'links' collection on RObject is now a Set instead of an Array.
-* All literal messages are now stored in YAML localization files.
-* Object siblings (caused by concurrent updates when allow_mult is true) can now
-  be accessed directly.
-* Map-reduce jobs now have timeouts (in parity with Riak).
-h2. 0.5.1 Patch Release - 2010-02-22
-This is a minor release with fixes for Ruby 1.9, bundler/edge Rails,
-and a minor feature addition. Changes:
-* Qualify namespaces for Ruby 1.9.
-* Decoupled a few specs that gave the appearance of failure.
-* Added "bucket" and "key" properties on Riak::Link objects. [John Lynch]
-* Fully-qualify the @JSON@ constant, using @ActiveSupport::JSON@ instead.
-* Adjusted gem specification to accommodate edge Rails. [Preston Marshall]
-h2. 0.5 Initial Release - 2010-02-10
-This is the first release of Ripple, which would not have been possible
-without the generous support of Sonian and Basho Technologies.  Many thanks.
-It includes:
-* A robust basic client, @Riak@, with:
-** multiple HTTP backends (curb, net/http)
-** sensible client defaults (local, default port)
-** bucket access and manipulation, including key-streaming
-** object reading, storing, deleting and reloading
-** automatic de-serialization of JSON, YAML, and Marshal (when given the right content type)
-** streaming POST/PUT bodies (when given an IO)
-** method-chained map-reduce job construction
-* A document-style modeling library, Ripple, with:
-** ActiveModel 3.0 compatibility
-** Property/attribute definition with automatic type-casting
-** Bucket selection based on class name, with single-bucket inheritance (configurable)
-** Validations
-** Dirty-tracking
-** Simple finders - all documents, by key
-** Reloading

data/VERSION DELETED

	@@ -1 +0,0 @@
1	- 0.6.1

data/lib/riak.rb DELETED

@@ -1,46 +0,0 @@
-# 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.
-$KCODE = "UTF8" if RUBY_VERSION < "1.9"
-require 'active_support/all'
-require 'active_support/json'
-require 'base64'
-require 'uri'
-require 'net/http'
-require 'yaml'
-require 'riak/i18n'
-# The Riak module contains all aspects of the HTTP client interface
-# to Riak.
-module Riak
-  # Domain objects
-  autoload :Bucket,          "riak/bucket"
-  autoload :Client,          "riak/client"
-  autoload :Link,            "riak/link"
-  autoload :WalkSpec,        "riak/walk_spec"
-  autoload :RObject,         "riak/robject"
-  autoload :MapReduce,       "riak/map_reduce"
-  # Exceptions
-  autoload :FailedRequest,   "riak/failed_request"
-  autoload :InvalidResponse, "riak/invalid_response"
-  autoload :MapReduceError,  "riak/map_reduce_error"
-  module Util
-    autoload :Escape,        "riak/util/escape"
-    autoload :Headers,       "riak/util/headers"
-    autoload :Multipart,     "riak/util/multipart"
-    autoload :Translation,   "riak/util/translation"
-  end
-end

data/lib/riak/bucket.rb DELETED

@@ -1,157 +0,0 @@
-# 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
-  # Represents and encapsulates operations on a Riak bucket.  You may retrieve a bucket
-  # using {Client#bucket}, or create it manually and retrieve its meta-information later.
-  class Bucket
-    include Util::Translation
-    include Util::Escape
-    # @return [Riak::Client] the associated client
-    attr_reader :client
-    # @return [String] the bucket name
-    attr_reader :name
-    # @return [Hash] Internal Riak bucket properties.
-    attr_reader :props
-    alias_attribute :properties, :props
-    # Create a Riak bucket manually.
-    # @param [Client] client the {Riak::Client} for this bucket
-    # @param [String] name the name of the bucket
-    def initialize(client, name)
-      raise ArgumentError, t("client_type", :client => client.inspect) unless Client === client
-      raise ArgumentError, t("string_type", :string => name.inspect) unless String === name
-      @client, @name, @props = client, name, {}
-    end
-    # Load information for the bucket from a response given by the {Riak::Client::HTTPBackend}.
-    # Used mostly internally - use {Riak::Client#bucket} to get a {Bucket} instance.
-    # @param [Hash] response a response from {Riak::Client::HTTPBackend}
-    # @return [Bucket] self
-    # @see Client#bucket
-    def load(response={})
-      unless response.try(:[], :headers).try(:[],'content-type').try(:first) =~ /json$/
-        raise Riak::InvalidResponse.new({"content-type" => ["application/json"]}, response[:headers], t("loading_bucket", :name => name))
-      end
-      payload = ActiveSupport::JSON.decode(response[:body])
-      @keys = payload['keys'].map {|k| URI.unescape(k) }  if payload['keys']
-      @props = payload['props'] if payload['props']
-      self
-    end
-    # Accesses or retrieves a list of keys in this bucket.
-    # If a block is given, keys will be streamed through
-    # the block (useful for large buckets). When streaming,
-    # results of the operation will not be retained in the local Bucket object.
-    # @param [Hash] options extra options
-    # @yield [Array<String>] a list of keys from the current chunk
-    # @option options [Boolean] :reload (false) If present, will force reloading of the bucket's keys from Riak
-    # @return [Array<String>] Keys in this bucket
-    def keys(options={})
-      if block_given?
-        @client.http.get(200, @client.prefix, escape(name), {:props => false}, {}) do |chunk|
-          obj = ActiveSupport::JSON.decode(chunk) rescue {}
-          yield obj['keys'].map {|k| URI.unescape(k) } if obj['keys']
-        end
-      elsif @keys.nil? || options[:reload]
-        response = @client.http.get(200, @client.prefix, escape(name), {:props => false}, {})
-        load(response)
-      end
-      @keys
-    end
-    # Sets internal properties on the bucket
-    # Note: this results in a request to the Riak server!
-    # @param [Hash] properties new properties for the bucket
-    # @return [Hash] the properties that were accepted
-    # @raise [FailedRequest] if the new properties were not accepted by the Riak server
-    def props=(properties)
-      raise ArgumentError, t("hash_type", :hash => properties.inspect) unless Hash === properties
-      body = {'props' => properties}.to_json
-      @client.http.put(204, @client.prefix, escape(name), body, {"Content-Type" => "application/json"})
-      @props = properties
-    end
-    # Retrieve an object from within the bucket.
-    # @param [String] key the key of the object to retrieve
-    # @param [Hash] options query parameters for the request
-    # @option options [Fixnum] :r - the read quorum for the request - how many nodes should concur on the read
-    # @return [Riak::RObject] the object
-    # @raise [FailedRequest] if the object is not found or some other error occurs
-    def get(key, options={})
-      code = allow_mult ? [200,300] : 200
-      response = @client.http.get(code, @client.prefix, escape(name), escape(key), options, {})
-      RObject.new(self, key).load(response)
-    end
-    alias :[] :get
-    # Create a new blank object
-    # @param [String] key the key of the new object
-    # @return [RObject] the new, unsaved object
-    def new(key=nil)
-      RObject.new(self, key).tap do |obj|
-        obj.content_type = "application/json"
-      end
-    end
-    # Fetches an object if it exists, otherwise creates a new one with the given key
-    # @param [String] key the key to fetch or create
-    # @return [RObject] the new or existing object
-    def get_or_new(key, options={})
-      begin
-        get(key, options)
-      rescue Riak::FailedRequest => fr
-        if fr.code.to_i == 404
-          new(key)
-        else
-          raise fr
-        end
-      end
-    end
-    # @return [true, false] whether the bucket allows divergent siblings
-    def allow_mult
-      props['allow_mult']
-    end
-    # Set the allow_mult property.  *NOTE* This will result in a PUT request to Riak.
-    # @param [true, false] value whether the bucket should allow siblings
-    def allow_mult=(value)
-      self.props = props.merge('allow_mult' => value)
-      value
-    end
-    # @return [Fixnum] the N value, or number of replicas for this bucket
-    def n_value
-      props['n_val']
-    end
-    # Set the N value (number of replicas). *NOTE* This will result in a PUT request to Riak.
-    # Setting this value after the bucket has objects stored in it may have unpredictable results.
-    # @param [Fixnum] value the number of replicas the bucket should keep of each object
-    def n_value=(value)
-      self.props = props.merge('n_val' => value)
-      value
-    end
-    # @return [String] a representation suitable for IRB and debugging output
-    def inspect
-      "#<Riak::Bucket #{client.http.path(client.prefix, escape(name)).to_s}#{" keys=[#{keys.join(',')}]" if defined?(@keys)}>"
-    end
-  end
-end