simperium 0.0.2.1 → 0.0.2.2

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,2 @@
+simperium-ruby-prviate
+======================

data/VERSION

@@ -0,0 +1 @@
+0.0.2.2

data/lib/simperium/changes.rb

@@ -0,0 +1,16 @@
+module Simperium
+    class ChangeProcessor
+        def process(change)
+            if change['o'] == 'M'
+                if change.include?('sv')
+                    change['v'].each do |key|
+                        handler = self.send('on_change_#{key}')
+                        if handler
+                            handler(change['d'][key])
+                        end
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/simperium/error_handling.rb

@@ -0,0 +1,19 @@
+module ErrorHandling
+    def self.handle_restclient_error(e)
+        case e
+        when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+          message = "Could not connect to Simperium (auth.simperium.com).  Please check your internet connection and try again.  If the problem continues, you should check Simperium's service status at https://simperium.com/, or let us know at contact@simperium.com."
+        when SocketError
+          message = "Unexpected error when trying to connect to Simpierum.  HINT: You may be seeing this message because your DNS is not working.  To check, try running 'host simperium.com' from the command line."
+        else
+          message = "Unexpected error communicating with Simperium.  If this problem persists, let us know at contact@simperium.com."
+        end
+        message += "\n\n(Network error: #{e.message})"
+        raise StandardError.new(message)
+    end
+
+    def self.handle_api_error(rcode, rbody)
+        message = rcode.to_s + ' '+ rbody
+        raise StandardError.new(message)
+    end
+end

data/lib/simperium/heroku-addon-doc.md

@@ -0,0 +1,153 @@
+Simperium(http://addons.heroku.com/simperium) is an [add-on](http://addons.heroku.com) for circulating your data between mobile, web, and desktop versions of your app.
+
+Adding Simpierum to your app makes your code simpler and your users happier:
+
+* Data transparently moves across mobile, web, and desktop versions of your app
+* Your users can read and write data even when they're offline
+* Multiple users can collaborate with the same data at the same time
+* You can build unique backend services that read and write data
+
+Simperium is accessible via an API and has supported backend libraries for Ruby and Python and client libraries for Javascript and iOS/OS X. This add-on lets you mirror data circulated by Simpierum directly into your datastore.
+
+## Provisioning the add-on
+
+Simperium can be attached to a Heroku application via the CLI:
+
+<div class="callout" markdown="1">
+A list of all plans available can be found [here](http://addons.heroku.com/simperium).
+</div>
+
+    :::term
+    $ heroku addons:add simperium
+    -----> Adding simperium to sharp-mountain-4005... done, v18 (free)
+
+Once Simperium has been added a `SIMPERIUM_APP_ID` and `SIMPERIUM_ADMIN_KEY` setting will be available in the app configuration and will contain keys to access the newly provisioned Simperium app instance. This can be confirmed using the `heroku config` command.
+
+    :::term
+    $ heroku config | grep SIMPERIUM_APP_ID
+    SIMPERIUM_APP_ID    => frogs-criteria-4c4
+
+    :::term
+    $ heroku config | grep SIMPERIUM_ADMIN_KEY
+    SIMPERIUM_ADMIN_KEY    => cbbae31841ac4d44a93cd82081a5b74f
+
+After installing Simpierum your application can begin mirroring data to your datastore.
+
+## Local setup
+
+### Environment setup
+
+After provisioning the add-on you'll want to locally replicate the config vars so your development environment can operate against the service.
+
+<div class="callout" markdown="1">
+Though less portable it’s also possible to set local environment variables using `export SIMPERIUM_APP_ID=value` and `export SIMPERIUM_APP_KEY=value`.
+</div>
+
+Use [Foreman](config-vars#local_setup) to reliably configure and run the process formation specified in your app’s [Procfile](procfile). Foreman reads configuration variables from an .env file. Use the following command to add the SIMPERIUM_APP_ID and SIMPERIUM_ADMIN_KEY values retrieved from heroku config to `.env`.
+
+    :::term    
+    $ heroku config -s | grep SIMPERIUM_APP_ID >> .env
+    $ heroku config -s | grep SIMPERIUM_ADMIN_KEY >> .env
+    $ more .env
+
+<p class="warning" markdown="1">
+Credentials and other sensitive configuration values should not be committed to source-control. In Git exclude the .env file with: `echo .env >> .gitignore`.
+</p>
+
+### Mirroring Data from Simperium to MongoHQ
+
+In order to begin mirroring data from Simperium to MongoHQ, we need to install the simperium gem. 
+
+    :::term
+    sudo gem install simperium
+
+Grab a copy of the listner file that handles mirroring between MongoHQ and Simperium:
+    
+    :::term
+    $ curl -O https://raw.github.com/Simperium/simperium/master/ruby/lib/simperium/listener-export-mongohq.rb
+
+Install the mongo gem:
+    
+    :::term
+    $ sudo gem update --system
+    
+    :::term
+    sudo gem install mongo
+    sudo gem install bson_ext
+    
+Now, let Heroku know we want to run this new listener:
+    
+    :::term
+    $ echo "worker: ruby listener-export-mongohq SIMPERIUM_APP_ID SIMPERIUM_ADMIN_KEY BUCKET_NAME" > Procfile
+
+Note, BUCKET_NAME is the name of the bucket you want to mirror.
+
+Start up our mongo instance with MongoHQ:
+
+    :::term
+    heroku addons:add mongohq:free
+
+Finally, commit and re-push to Heroku:
+
+    :::term
+    $ git add .
+    $ git commit -m "realtime export to MongoHQ"
+    $ git push heroku master
+
+Simperium activity can be observed within the Heroku log-stream by running the following:
+
+    :::term
+    $ heroku logs --tail
+
+## Dashboard
+
+<div class="callout" markdown="1">
+For more information on the features available within the Simperium dashboard please see the docs at [simperium.com/docs/reference](http://simperium.com/docs/reference).
+</div>
+
+The Simpierum dashboard allows you to delete app data, debug with our data browser, and invite developers to your Simperium app.
+
+![Simperium Dashboard](http://i.imgur.com/FkuUw.png "Simpierum Dashboard")
+
+The dashboard can be accessed via the CLI:
+
+    :::term
+    $ heroku addons:open simperium
+    Opening simpierum for sharp-mountain-4005…
+
+or by visiting the [Heroku apps web interface](http://heroku.com/myapps) and selecting the application in question. Select Simperium from the Add-ons menu.
+
+![Simperium Add-ons Dropdown](http://f.cl.ly/items/1B090n1P0d3W0I0R172r/addons.png "Simperium Add-ons Dropdown")
+
+
+## Migrating between plans
+
+<div class="note" markdown="1">Application owners should carefully manage the migration timing to ensure proper application function during the migration process.</div>
+
+Use the `heroku addons:upgrade` command to migrate to a new plan.
+
+    :::term
+    $ heroku addons:upgrade simperium:pro
+    -----> Upgrading simperium:pro to sharp-mountain-4005... done, v18 ($XX/mo)
+           Your plan has been updated to: simperium:pro
+
+## Removing the add-on
+
+Simperium can be removed via the  CLI.
+
+<div class="warning" markdown="1">This will destroy all associated data and cannot be undone!</div>
+
+    :::term
+    $ heroku addons:remove simperium
+    -----> Removing simperium from sharp-mountain-4005... done, v20 (free)
+
+## Support
+
+All Simperium support and runtime issues should be logged with Heroku Support at https://support.heroku.com. Any non-support related issues or product feedback is welcome at help@simperium.com.
+
+## Additional resources
+
+Additional resources are available at:
+
+* [Site docs](http://simperium.com/docs/reference)
+* [Some screencast](https://simperium.com)

data/lib/simperium/listener-export-mongohq

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'simperium'
+require 'uri'
+require 'mongo'
+require 'optparse'
+
+MONGOHQ_URL = ENV['MONGOHQ_URL']
+
+uri = URI.parse(MONGOHQ_URL)
+conn = Mongo::Connection.from_uri(MONGOHQ_URL)
+$db = conn.db(uri.path.gsub(/^\//, ''))
+
+def main(appname, admin_key, bucket)
+    _bucket = Bucket.new(appname, admin_key, bucket)
+    
+    begin
+        cv = $db['__meta__'].find_one
+        cv = cv['cv']
+    rescue StandardError => e
+        cv = nil     
+    end
+
+    begin
+        while true do
+            changes = _bucket.all(:cv => cv, :data=>true)
+            for change in changes
+                data = change['d']
+                # update mongo with the latest version of the data
+                if data
+                    data['_id'] = change['id']
+                    # puts data
+                    $db[bucket].save(data)
+                else
+                    $db[bucket].remove({'_id' => change['id']})
+                end
+                # persist the cv to mongo, so changes don't need to be
+                # re-processed after restart
+                $db['__meta__'].save({'_id' => 'cv', 'cv' => change['cv']})
+                cv = change['cv']
+            end
+        end
+    rescue StandardError => e
+        raise StandardError.new('Mirroring failed')
+    end
+end
+
+main(ARGV[0], ARGV[1], ARGV[2])

data/lib/simperium/version.rb

@@ -1,3 +1,3 @@
 module Simperium
-  VERSION = '0.0.2.1'
+  VERSION = '0.0.2.2'
 end

data/simperium.gemspec

@@ -0,0 +1,22 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'simperium/version'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'simperium'
+  s.version = Simperium::VERSION
+  s.summary = 'Ruby bindings for the Simperium API'
+  s.description = 'Simperium moves data instantly and automatically everywhere it\'s needed.  See https://simperium.com for details.'
+  s.authors = ['Ray Ventura']
+  s.email = ['ray@simperium.com']
+  s.homepage = 'https://simperium.com/docs/reference'
+  s.require_paths = %w{lib}
+
+  s.add_dependency('rest-client', '~> 1.4')
+  s.add_dependency('uuid')
+  s.add_dependency('json')
+  s.add_dependency('mongo')
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ['lib']
+end

data/test/test_simperium.rb

@@ -0,0 +1,88 @@
+require 'rubygems'
+require 'test/unit'
+require 'uuid'
+require 'simperium'
+
+@@api_key = ENV['SIMPERIUM_CLIENT_TEST_APIKEY']
+@@appname = ENV['SIMPERIUM_CLIENT_TEST_APPNAME']
+
+# cache user create to cut down on the number of users created by the test suite
+@@_auth_token = nil
+def get_auth_token
+    if @@_auth_token.nil?
+    	auth = Simperium::Auth.new(@@appname, @@api_key)
+        uuid = UUID.new
+		username = uuid.generate(:compact) + '@foo.com'
+		password = uuid.generate(:compact)
+        @@_auth_token = auth.create(username, password)
+    end
+    return @@_auth_token
+end
+
+class TestSimperiumRuby < Test::Unit::TestCase
+	def test_auth_create
+		get_auth_token
+	end
+
+	def test_bucket_get
+		uuid = UUID.new
+		bucket = Simperium::Bucket.new(@@appname, get_auth_token, uuid.generate(:compact))
+        bucket.post('item1', {'x'=> 1})
+        assert_equal(bucket.get('item1'), {'x' => 1})
+	end
+
+	def test_bucket_index
+		uuid = UUID.new
+		bucket = Simperium::Bucket.new(@@appname, get_auth_token, uuid.generate(:compact))
+		(0..2).each { |i| bucket.post("item#{i}", {'x' => i}) }
+        
+        got = bucket.index(:data=>false,  :mark=>nil, :limit=>2, :since=>nil)
+        want = {
+            'current' => got['current'],
+            'mark' => got['mark'],
+            'index' => [
+                {'id' => 'item2', 'v' => 1},
+                {'id' => 'item1', 'v' => 1}] }
+        assert_equal(want, got)
+
+        got2 = bucket.index(:data=>false, :mark=>got['mark'], :limit=>2, :since=>nil)
+        want2 = {
+            'current'=> got['current'],
+            'index' => [
+                {'id' => 'item0', 'v' => 1}] }
+	end
+
+	def test_bucket_post
+		uuid = UUID.new
+		bucket = Simperium::Bucket.new(@@appname, get_auth_token, uuid.generate(:compact))
+        bucket.post('item1', {'a'=>1})
+        assert_equal(bucket.get('item1'), {'a'=>1})
+
+        bucket.post('item1', {'b'=>2})
+        assert_equal(bucket.get('item1'), {'a'=>1, 'b'=>2})
+
+        bucket.post('item1', {'c'=>3}, :replace=>true)
+        assert_equal(bucket.get('item1'), {'c'=>3})
+	end
+
+	def test_user_get
+		user = Simperium::User.new(@@appname, get_auth_token)
+        user.post({'x'=> 1})
+        assert_equal(user.get, {'x'=> 1})
+	end
+
+	def test_api_getitem
+        api = Simperium::Api.new(@@appname, get_auth_token)
+        assert_instance_of(Simperium::Bucket, api['bucket'], "api[bucket] should be an instance of Bucket")
+    end
+
+    def test_api_getattr
+        api = Simperium::Api.new(@@appname, get_auth_token)
+        assert_instance_of(Simperium::Bucket, api.bucket, "api.bucket should be an instance of Bucket")
+    end
+
+    def test_api_user
+        api = Simperium::Api.new(@@appname, get_auth_token)
+        assert_instance_of(Simperium::User, api.user, "api.user should be an instance of User")
+    end
+end

data/test/test_simperium_mirror.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+require 'simperium/listener-export-mongohq'
+
+@admin_key = ENV['SIMPERIUM_CLIENT_TEST_ADMINKEY']
+@appname = ENV['SIMPERIUM_CLIENT_TEST_APPNAME']
+@bucket = 'todo'
+
+class TestMirror < Test::Unit::TestCase
+	def test_simperium_mirror
+		main(@admin_key, @appname, @bucket)
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: simperium
 version: !ruby/object:Gem::Version 
-  hash: 69
+  hash: 67
   prerelease: 
   segments: 
   - 0
   - 0
   - 2
-  - 1
-  version: 0.0.2.1
+  - 2
+  version: 0.0.2.2
 platform: ruby
 authors: 
 - Ray Ventura
@@ -85,8 +85,18 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- Gemfile
+- README.md
+- VERSION
 - lib/simperium.rb
+- lib/simperium/changes.rb
+- lib/simperium/error_handling.rb
+- lib/simperium/heroku-addon-doc.md
+- lib/simperium/listener-export-mongohq
 - lib/simperium/version.rb
+- simperium.gemspec
+- test/test_simperium.rb
+- test/test_simperium_mirror.rb
 homepage: https://simperium.com/docs/reference
 licenses: []