rhoconnect-rb 0.2.5 → 0.2.6

data/README.md

@@ -31,7 +31,7 @@ Or, if you are using DataMapper:
 	
 Next, your models will need to declare a partition key for `rhoconnect-rb`.  This partition key is used by `rhoconnect-rb` to uniquely identify the model dataset when it is stored in a rhoconnect instance.  It is typically an attribute on the model or related model.  `rhoconnect-rb` supports two types of partitions:
 
-* :app - No unique key will be used, a shared dataset is synchronzied for all users.
+* :app - No unique key will be used, a shared dataset is synchronized for all users.
 * lambda { some lambda } - Execute a lambda which returns the unique key string.
 
 For example, the `Product` model above might have a `belongs_to :user` relationship.  This provides us a simple way to organize the `Product` dataset for rhoconnect by reusing this relationship.  The partition identifying a username would be declared as:
@@ -41,12 +41,16 @@ For example, the `Product` model above might have a `belongs_to :user` relations
 	  
 	  belongs_to :user
 	
-	  partition lambda { self.user.username }
+	  def partition 
+		lambda { self.user.username }
+	  end
 	end
 	
 Now all of the `Product` data synchronized by rhoconnect will organized by `self.user.username`.  Note: You can also used a fixed key if the dataset doesn't require a dynamic value:
 
-	partition lambda { :app }
+	def partition
+	  :app
+	end
 	
 For more information about Rhoconnect partitions, please refer to the [Rhoconnect docs](http://docs.rhomobile.com/rhosync/source-adapters#data-partitioning).
 
@@ -59,7 +63,9 @@ For more information about Rhoconnect partitions, please refer to the [Rhoconnec
 	  
 	  belongs_to :user
 	
-	  partition lambda { self.user.username }
+	  def partition 
+		lambda { self.user.username }
+	  end
 	
 	  def self.rhoconnect_query(partition)
 	    Product.where(:user_id => partition)
@@ -70,24 +76,30 @@ In this example, `self.rhoconnect_query` returns a list of products where the pa
 
 ### Configuration and Authentication
 
-Configure Rhoconnect in an initializer like `config/initializers/rhoconnect.rb` (for Rails), or directly in your application (i.e. Sinatra):
+Configure Rhoconnect in an initializer like `config/initializers/rhoconnect.rb` (for Rails), or directly in your application (i.e. Sinatra).  Here you will setup the rhoconnect uri (the location of your rhoconnect instance), and app\_endpoint (the location of your ruby app):
+
 
-	# Setup the Rhoconnect uri and api token.
 	# Use rhoconnect:get_token to get the token value.
 	
 	config.uri   = "http://myrhoconnect.com"
 	config.token = "secrettoken"
+	config.app_endpoint = "http://myapp.heroku.com"
+	
+If `app_endpoint` is defined, your Rhoconnect instance will be configured to query data from the endpoint using the rhoconnect_query method in your model.  For example, if your `app_endpoint` is defined as "http://myapp.heroku.com", Rhoconnect will query data with:
+
+	POST http://myapp.heroku.com/rhoconnect/query
 
 Example: 
 
    	Rhoconnect.configure do |config|
-      config.uri   = "http://myrhoconnect-server.com"
-      config.token = "secrettoken"
+      config.uri   		  = "http://myrhoconnect-server.com"
+      config.token 		  = "secrettoken"
+	  config.app_endpoint = "http://myapp.heroku.com"
 	end
 	
 Example with authentication:
 
-Rhoconnect installs a `/rhoconnect/authenticate` route into your application which will receive credentials from the client.  Add block which handles the credentials:
+`rhoconnect-rb` installs a `/rhoconnect/authenticate` route into your application which will receive credentials from the client.  Add block which handles the credentials:
 
 	Rhoconnect.configure do |config|
       config.uri   = "http://myrhoconnect-server.com"
@@ -96,6 +108,7 @@ Rhoconnect installs a `/rhoconnect/authenticate` route into your application whi
         User.authenticate(credentials[:login], credentials[:password]) 
 	  }
 	end
+	
 
 ## Meta
 Created and maintained by Lucas Campbell-Rossen, Vladimir Tarasov and Lars Burgess.

data/lib/rhoconnect/resource.rb

@@ -11,14 +11,6 @@ module Rhoconnect
     
     
     module ClassMethods
-      def partition(p)
-        @partition = p
-      end
-      
-      def get_partition
-        @partition.is_a?(Proc) ? @partition.call : @partition
-      end
-      
       def rhoconnect_receive_create(partition, attributes)
         instance = self.send(:new)
         instance.send(:rhoconnect_apply_attributes, partition, attributes)
@@ -47,6 +39,11 @@ module Rhoconnect
     
     module InstanceMethods
       attr_accessor :skip_rhoconnect_callbacks
+
+      def get_partition
+        @partition = partition
+        @partition.is_a?(Proc) ? @partition.call : @partition
+      end
       
       def rhoconnect_create
         call_client_method(:create)
@@ -76,7 +73,7 @@ module Rhoconnect
         attribs.each do |key,value|
           attribs[key] = Time.parse(value.to_s).to_i.to_s if value.is_a?(Time) or value.is_a?(DateTime)
         end if Rhoconnect.configuration.sync_time_as_int
-        attribs    
+        attribs
       end
       
       private
@@ -85,7 +82,7 @@ module Rhoconnect
         unless self.skip_rhoconnect_callbacks
           attribs = self.normalized_attributes
           begin
-            Rhoconnect::Client.new.send(action, self.class.to_s, self.class.get_partition, attribs)
+            Rhoconnect::Client.new.send(action, self.class.to_s, self.get_partition, attribs)
           rescue RestClient::Exception => re
             warn "#{self.class.to_s}: rhoconnect_#{action} returned error: #{re.message} - #{re.http_body}"
           rescue Exception => e

data/lib/rhoconnect/version.rb

@@ -1,3 +1,3 @@
 module Rhoconnect
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/spec/resource_spec.rb

@@ -7,20 +7,24 @@ describe Rhoconnect::Resource do
       class TestModel1 < ActiveRecord::Base
         include Rhoconnect::Resource
       
-        partition :app
+        def partition 
+          :app
+        end
       end
     
-      TestModel1.get_partition.should == :app
+      TestModel1.new.get_partition.should == :app
     end
   
     it "should set resource partition with lambda" do
       class TestModel2 < ActiveRecord::Base
         include Rhoconnect::Resource
       
-        partition lambda{ 'helloworld' }
+        def partition 
+          lambda{ 'helloworld' }
+        end
       end
     
-      TestModel2.get_partition.should == 'helloworld'
+      TestModel2.new.get_partition.should == 'helloworld'
     end
   end
   
@@ -70,7 +74,9 @@ describe Rhoconnect::Resource do
     it "should call create update delete hook" do
       class TestModel7 < ActiveRecord::Base
         include Rhoconnect::Resource
-        partition :app
+        def partition 
+          :app
+        end
       end
       client = mock('Rhoconnect::Client')
       client.stub!(:send)
@@ -86,7 +92,9 @@ describe Rhoconnect::Resource do
     it "should warn on RestClient::Exception" do
       class TestModel8 < ActiveRecord::Base
         include Rhoconnect::Resource
-        partition :app
+        def partition 
+          :app
+        end
       end
       client = mock('Rhoconnect::Client')
       exception = RestClient::Exception.new(
@@ -105,7 +113,9 @@ describe Rhoconnect::Resource do
     it "should warn on Exception" do
       class TestModel8 < ActiveRecord::Base
         include Rhoconnect::Resource
-        partition :app
+        def partition 
+          :app
+        end
       end
       client = mock('Rhoconnect::Client')
       client.stub!(:send).and_return { raise Exception.new("error connecting to server") }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhoconnect-rb
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Rhomobile
@@ -15,10 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-07 00:00:00 -07:00
-default_executable: 
+date: 2011-08-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -30,11 +31,11 @@ dependencies:
         - 6
         - 1
         version: 1.6.1
-  requirement: *id001
-  prerelease: false
-  name: rest-client
   type: :runtime
+  requirement: *id001
 - !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,10 +47,8 @@ dependencies:
         - 4
         - 6
         version: 1.4.6
-  requirement: *id002
-  prerelease: false
-  name: json
   type: :runtime
+  requirement: *id002
 description: Rhoconnect rails plugin
 email: 
 - support@rhomobile.com
@@ -79,7 +78,6 @@ files:
 - spec/endpoints_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://rhomobile.com
 licenses: []
 
@@ -109,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Rhoconnect rails plugin