rhoconnect-rb 0.2.1 → 0.2.2

data/README.md

@@ -1,9 +1,9 @@
 rhoconnect-rb
 ===
 
-A ruby client library for the [Rhoconnect](http://rhomobile.com/products/rhosync) App Integration Server.
+A ruby library for the [Rhoconnect](http://rhomobile.com/products/rhosync) App Integration Server.
 
-Using rhoconnect-rb, your application's model data will transparently synchronize with a mobile application built using the [Rhodes framework](http://rhomobile.com/products/rhodes), or any of the available [Rhoconnect clients](http://rhomobile.com/products/rhosync/).  This client includes built-in support for [ActiveRecord](http://ar.rubyonrails.org/) and [DataMapper](http://datamapper.org/) models.
+Using rhoconnect-rb, your application's model data will transparently synchronize with a mobile application built on the [Rhodes framework](http://rhomobile.com/products/rhodes), or any of the available [Rhoconnect clients](http://rhomobile.com/products/rhosync/).  This client includes built-in support for [ActiveRecord](http://ar.rubyonrails.org/) and [DataMapper](http://datamapper.org/) models.
 
 ## Getting started
 
@@ -26,13 +26,15 @@ Or, if you are using DataMapper:
 	  include DataMapper::Resource
 	  include Rhoconnect::Resource
 	end
+
+### Partitioning Datasets
 	
-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 application.  It is typically an attribute on the model or related model.  `rhoconnect-rb` supports two types of partitions:
+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 used for all users.
+* :app - No unique key will be used, a shared dataset is synchronzied 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.  The partition identifying the username would be declared as:
+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:
 
 	class Product < ActiveRecord::Base
 	  include Rhoconnect::Resource
@@ -42,9 +44,60 @@ For example, the `Product` model above might have a `belongs_to :user` relations
 	  partition lambda { self.user.username }
 	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 }
+	
 For more information about Rhoconnect partitions, please refer to the [Rhoconnect docs](http://docs.rhomobile.com/rhosync/source-adapters#data-partitioning).
 
+### Querying Datasets
+
+`rhoconnect-rb` installs a `/rhoconnect/query` route in your application which the Rhoconnect instance invokes to query the dataset for the dataset you want to synchronize.  This route is mapped to a `rhoconnect_query` method in your model.  This method should return a collection of objects:
+
+	class Product < ActiveRecord::Base
+	  include Rhoconnect::Resource
+	  
+	  belongs_to :user
+	
+	  partition lambda { self.user.username }
+	
+	  def self.rhoconnect_query(partition)
+	    Product.where(:user_id => partition)
+	  end
+	end
+
+In this example, `self.rhoconnect_query` returns a list of products where the partition string (provided by the rhoconnect instance) matches the `user_id` field in the products table.  
+
+### Configuration and Authentication
+
+Configure Rhoconnect in an initializer like `config/initializers/rhoconnect.rb` (for Rails), or directly in your application (i.e. Sinatra):
+
+	# Setup the Rhoconnect uri and api token.
+	# Use rhoconnect:get_token to get the token value.
+	
+	config.uri   = "http://myrhoconnect.com"
+	config.token = "secrettoken"
+
+Example: 
+
+   	Rhoconnect.configure do |config|
+      config.uri   = "http://myrhoconnect-server.com"
+      config.token = "secrettoken"
+	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.configure do |config|
+      config.uri   = "http://myrhoconnect-server.com"
+      config.token = "secrettoken"
+	  config.authenticate = lambda { |credentials| 
+        User.authenticate(credentials[:login], credentials[:password]) 
+	  }
+	end
+
 ## Meta
-Created and maintained by Vladimir Tarasov and Lars Burgess.
+Created and maintained by Lucas Campbell-Rossen, Vladimir Tarasov and Lars Burgess.
 
 Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

data/lib/rhoconnect/client.rb

@@ -4,8 +4,12 @@ module Rhoconnect
   class Client
     attr_accessor :uri, :token
 
-    def self.set_app_endpoint(url)
-      RestClient::Request.execute(:method => :post, :url => url, :timeout => 2000)
+    def self.set_app_endpoint(args)
+      RestClient::Request.execute(
+        :method => :post, :url => args[:url], 
+        :payload => args[:payload], :timeout => 2000,
+        :headers => args[:headers]
+      )
     end
     
     # allow configuration, uri or environment variable initialization

data/lib/rhoconnect/configuration.rb

@@ -34,7 +34,7 @@ module Rhoconnect
     yield(configuration)
     # make a call to rhoconnect instance to set app url
     endpoint_url = ENV['APP_ENDPOINT'] || self.configuration.app_endpoint
-    uri          = ENV['URI'] || self.configuration.uri
+    uri          = ENV['RHOCONNECT_URL'] || self.configuration.uri
     if uri
       uri = URI.parse(uri)
       token    = uri.user
@@ -42,7 +42,10 @@ module Rhoconnect
       uri      = uri.to_s
     end
     token ||= ENV['token'] || self.configuration.token
-    Rhoconnect::Client.set_app_endpoint(uri + "/api/source/save_adapter?attributes[adapter_url]=#{endpoint_url}&api_token=#{token}") if endpoint_url && uri && token
+    Rhoconnect::Client.set_app_endpoint(:url => uri + "/api/source/save_adapter", 
+      :payload => {:attributes => {:adapter_url => endpoint_url}, :api_token => token}.to_json,
+      :headers => {:content_type => 'application/json'}
+    ) if endpoint_url && uri && token
   end
 end
 

data/lib/rhoconnect/version.rb

@@ -1,3 +1,3 @@
 module Rhoconnect
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/client_spec.rb

@@ -4,34 +4,34 @@ describe Rhoconnect::Client do
   
   context "on initialize" do
     it "should initialize with Rhoconnect_URL environment var" do
-      ENV['RHOCONNECT_URL'] = "http://token@test.Rhoconnect.com"
+      ENV['RHOCONNECT_URL'] = "http://token@test.rhoconnect.com"
       c = Rhoconnect::Client.new
       c.token.should == 'token'
-      c.uri.should == 'http://test.Rhoconnect.com'
+      c.uri.should == 'http://test.rhoconnect.com'
       ENV.delete('Rhoconnect_URL')
     end
   
     it "should initialize with :uri parameter" do
-      c = Rhoconnect::Client.new(:uri => "http://token@test.Rhoconnect.com")
+      c = Rhoconnect::Client.new(:uri => "http://token@test.rhoconnect.com")
       c.token.should == 'token'
-      c.uri.should == 'http://test.Rhoconnect.com'
+      c.uri.should == 'http://test.rhoconnect.com'
     end
   
     it "should initialize with :token parameter" do
-      c = Rhoconnect::Client.new(:uri => "http://test.Rhoconnect.com", :token => "token")
+      c = Rhoconnect::Client.new(:uri => "http://test.rhoconnect.com", :token => "token")
       c.token.should == 'token'
-      c.uri.should == 'http://test.Rhoconnect.com'
+      c.uri.should == 'http://test.rhoconnect.com'
     end
     
     it "should initialize with configure block" do
       Rhoconnect.configure do |config|
-        config.uri = "http://test.Rhoconnect.com"
+        config.uri = "http://test.rhoconnect.com"
         config.token = "token"
       end
       begin
         c = Rhoconnect::Client.new
         c.token.should == 'token'
-        c.uri.should == 'http://test.Rhoconnect.com'
+        c.uri.should == 'http://test.rhoconnect.com'
       ensure
         Rhoconnect.configure do |config|
           config.uri = nil
@@ -47,18 +47,18 @@ describe Rhoconnect::Client do
   
     it "should raise ArugmentError if token is missing" do
       lambda { 
-        Rhoconnect::Client.new(:uri => "http://test.Rhoconnect.com")
+        Rhoconnect::Client.new(:uri => "http://test.rhoconnect.com")
       }.should raise_error(ArgumentError, "Please provide a :token or set it in uri")
     end
   end
   
   context "on create update destroy" do
     before(:each) do
-      @client = Rhoconnect::Client.new(:uri => "http://token@test.Rhoconnect.com")
+      @client = Rhoconnect::Client.new(:uri => "http://token@test.rhoconnect.com")
     end
     
     it "should create an object" do
-      stub_request(:post, "http://test.Rhoconnect.com/api/source/push_objects").with(
+      stub_request(:post, "http://test.rhoconnect.com/api/source/push_objects").with(
         :headers => {"Content-Type" => "application/json"}
       ).to_return(:status => 200, :body => "done")
       resp = @client.create("Person", "user1", 
@@ -72,7 +72,7 @@ describe Rhoconnect::Client do
     end
     
     it "should update an object" do
-      stub_request(:post, "http://test.Rhoconnect.com/api/source/push_objects").with(
+      stub_request(:post, "http://test.rhoconnect.com/api/source/push_objects").with(
         :headers => {"Content-Type" => "application/json"}
       ).to_return(:status => 200, :body => "done")
       resp = @client.update("Person", "user1", 
@@ -86,7 +86,7 @@ describe Rhoconnect::Client do
     end
     
     it "should destroy an object" do
-      stub_request(:post, "http://test.Rhoconnect.com/api/source/push_deletes").with(
+      stub_request(:post, "http://test.rhoconnect.com/api/source/push_deletes").with(
         :headers => {"Content-Type" => "application/json"}
       ).to_return(:status => 200, :body => "done")
       resp = @client.destroy("Person", "user1", 
@@ -102,11 +102,11 @@ describe Rhoconnect::Client do
   
   context "on set callbacks" do
     before(:each) do
-      @client = Rhoconnect::Client.new(:uri => "http://token@test.Rhoconnect.com")
+      @client = Rhoconnect::Client.new(:uri => "http://token@test.rhoconnect.com")
     end
     
     it "should set auth callback" do
-      stub_request(:post, "http://test.Rhoconnect.com/api/set_auth_callback").with(
+      stub_request(:post, "http://test.rhoconnect.com/api/set_auth_callback").with(
         :headers => {"Content-Type" => "application/json"}
       ).to_return(:status => 200, :body => "done")
       resp = @client.set_auth_callback("http://example.com/callback")
@@ -115,7 +115,7 @@ describe Rhoconnect::Client do
     end
     
     it "should set query callback" do
-      stub_request(:post, "http://test.Rhoconnect.com/api/set_query_callback").with(
+      stub_request(:post, "http://test.rhoconnect.com/api/set_query_callback").with(
         :headers => {"Content-Type" => "application/json"}
       ).to_return(:status => 200, :body => "done")
       resp = @client.set_query_callback("Person", "http://example.com/callback")

data/spec/endpoints_spec.rb

@@ -60,7 +60,7 @@ describe Rhoconnect::EndpointHelpers do
     
     it "should return true if no authenticate block exists" do
       Rhoconnect.configure do |config|
-        config.uri = "http://test.Rhoconnect.com"
+        config.uri = "http://test.rhoconnect.com"
         config.token = "token" 
       end
       Rhoconnect.configuration.authenticate.should be_nil

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhoconnect-rb
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Rhomobile
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 Z
+date: 2011-06-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime