basilik 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTI5ZGFkMDRlODVlOTE1ODIyYmI1NmUxYWU2MDc5N2FmZjhlODlmMg==
+  data.tar.gz: !binary |-
+    NGU4M2EzNDU4M2ZkNjVlMzRlMzhhMTA3NGJmZTg1MWE5MThjYzc3MQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZmNhOTE0Nzc0MGJiMDhhNzdkOTMzYjQ2ZDU4MmM4MzViODE2MjZhZjliZTY4
+    MTg0ZWZmYjU5YWFmY2Q5ZDYwZWVkMjIyNWVmNmQ2YjBjZDA5MmYzNGNlNmYw
+    NjU1YzcwNWNjOTVkZGE2YjAzMTE1MDY3Yjg0ZmNiZWJjODY4NmI=
+  data.tar.gz: !binary |-
+    ZTBjNzEyNWZiZWI1MDM0Nzg5YmVmNjk1YTIyZmM2OWE5YzY3ZjZhNGVhY2Jk
+    MDhjMDAwNDNhOTM5MjhhOGQ3OWNlZGU1NDVhZjEyZmE3Y2U2NzU5NmY3YTM4
+    ZTViMGVlOTYyOWRhZTRlZjYyZTAzYzVlMmJkNGJmYzBhNGNhMTk=

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/growl'

data/.gitignore

@@ -0,0 +1,4 @@
+README.html
+coverage
+pkg
+*.sh

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'map'
+gem 'typhoeus'
+gem 'values'
+
+group 'test' do
+  gem "autotest"
+  gem "autotest-growl"
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,42 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.9.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-growl (0.2.16)
+    diff-lcs (1.2.1)
+    ethon (0.5.10)
+      ffi (~> 1.3.0)
+      mime-types (~> 1.18)
+    ffi (1.3.1)
+    map (6.3.0)
+    mime-types (1.21)
+    multi_json (1.7.2)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    typhoeus (0.6.2)
+      ethon (~> 0.5.10)
+    values (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  autotest-growl
+  map
+  rspec
+  simplecov
+  typhoeus
+  values

data/README.md

@@ -0,0 +1,319 @@
+# Basilik - Ruby firepower to your Firebase batteries
+
+Firebase is a real-time backend that allows one to store key-value pairs in a hierarchical fashion, without
+having to manage additional servers. Firebase offers api's for a variety of client libs such as javascript, 
+REST, IOS and now Ruby ;-). A cool thing about Firebase is that it broadcast changes to a variety of clients listening
+on a given firebase and allows disparate client to share their data. Checkout http://firebase.com for the firehose...
+
+## Requirements
+
+- Ruby >= 1.9
+- Map
+- Typhoeus
+
+## Getting Started
+
+$ gem install basilik
+
+## Usage
+
+### Setup your Firebase
+
+Sign up for a firebase account and create a new firebase of your liking.
+In the following code samples, we will use the following as our base url:
+
++ https://zerodarkthirty.firebaseio.com
+
+Then you can specify an entry point into the data using the following call:
+
+```ruby
+ref = Basilik::Load.new( 'https://zerodarkthirty.firebaseio.com' )
+```
+
+NOTE: You don't have to start a the root, but usually a good idea since this api
+offers ways to traverse the hierarchy up or down. But more on this later...
+
+
+### Populating firebase
+
+Firebase supports the following data types:
+
++ String
++ Number
++ Boolean
++ Array
++ Hash
+
+#### Adding primitive types
+
+```ruby
+data = {
+  a: 0,
+  b: %s(Hello World),
+  c: 10.5
+}
+ref.set( data )
+```
+
+Yields:
+
++ a:0
++ b:"Hello World"
++ c:10.5
+
+NOTE: Set is a destructive operation and will replace the previous content for the reference it is
+called from.
+
+Thus 
+
+```ruby
+data = {
+  a: 0
+}
+ref.set( data )
+```
+
+Yields
++ a:0
+
+Hence replacing the previously assigned content.
+
+
+#### Adding arrays
+
+```ruby
+ref.set( %w(Hello World) )
+```
+
+Yields:
+
++ 0:"Hello"
++ 1:"World"
+
+
+#### Adding arrays (ordered data)
+
+The preferred method to construct lists in your firebase is to use the push operation, which
+will automatically provide ordering to your list.
+
+```ruby
+ref.push( "BumbleBee" )
+ref.push( "Tuna" )
+```
+
+Yields:
+  
++ -IrMr3Yp1mozVNzDePKy: "BumbleBee"
++ -IrMr3cM6XjTpNebsYRh: "Tuna"
+
+NOTE: The list indexes will be autogenerated by firebase to ensure correct ordering on retrieval.
+
+
+#### Adding hashes
+
+```ruby
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: 10.5    
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+```
+
+Yields:
+
++ a:
+  + a_1:"Hello World"
+  + a_2_:10.5
++ b:
+  + b_1:10
+  + b_2:true
+    
+   
+### Reading data
+
+Fetching data in the hierarchy is done via the read operation.
+
+```ruby
+# Setup...
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: 10.5    
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+```
+
+```ruby
+ref.child( 'a/a_2' ).read # => 10.5
+a_val = ref.child( :a ).read 
+a_val.a_1    # => 'Hello World'
+a_val[:a_1]  # => 'Hello World' or use hash indexing...
+a_val.a_2    # => 10.5
+```
+
+### Updating data
+
+You can use the #update on a reference to modify nodes in the hierarchy
+
+```ruby
+# Setup...
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+```
+
+```ruby
+ref.child( :a ).update( a_1:"BumbleBee Tuna" )
+ref.child( 'a/a_2' ).update( a_2_2:"You bet!" )
+ref.child( 'a' ).child( 'a_3' ).update( a_3_1:"You better!" )
+```
+
+Yields:
+
++ a
+  + a_1:"BumbleBee Tuna"
+  + a_2
+      + a_2_1: 10.5
+      + a_2_2: "You bet!"
+  + a_3
+      + a_3_1: "You better!"
+      
+Note: the last call inserts a branch new node in the hierarchy. We could have use set here as well to
+perform the insert.
+
+You can leverage #inc/#dec to increment/decrement counter like data.
+
+IMPORTANT! Sadly Firebase currently does not offer transactions using their REST api, hence there is
+no guarantees about the atomicity of read/write operations ;-(
+
+### Deleting data
+
+Use the #remove operation to delete nodes at any level in the hierarchy.
+
+```ruby
+# Setup...
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+ref.child( 'a/a_2/a_2_2' ).remove
+ref.child( :b ).remove
+```
+
+NOTE: Calling remove on the root ref will delete the entire hierarchy.
+
+### Traversing the data
+
+You can traverse the hierarchy using the #child or #parent. These calls can be chained.
+
+```ruby
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+```
+
+```ruby
+a_2_2_ref = ref.child( 'a/a_2/a_2_2' )
+a_2_2_ref = ref.child( :a ).child( :a_2 ).child( :a_2_2 ) # or...
+a_2_2_ref.name #=> 'a_2_2'
+
+a_2_ref = a_2_2_ref.parent
+a_2_ref.name   # => 'a_2'
+
+a_ref = a_2_2_ref.parent.parent
+a_ref.name     # => 'a'
+```
+      
+### Priorities
+
+Firebase provides for setting priorities on ordered list in order to affect the retrieval. By default priority is null.
+Setting priority affects the retrieval as follows (See firebase web site for details!):
+
++ Children with no priority are retrieved first ordered lex asc by name
++ Children with number priority are next, ordered lex asc priority, name
++ Children with a non numeric priority come last, ordered lex asc priority, name
+
+```ruby
+a_ref = ref.push( {a:1, b:2} )
+b_ref = ref.push( {c:1, d:2} )
+a_ref.set_priority( 20 )
+b_ref.set_priority( 10 ) 
+a_ref.parent.read #=> {-IrNhTASqxqEpNMw8NGq: {c: 1, d: 2}, -IrNhT2vsoQ1WlgSG6op: {a: 1, b: 2} }
+```
+
+### Auth and rules
+
+You can secure you firebase store using a secret token and grant access for permissions on the store using rules.
+Please refer to the firebase docs for details.
+
+```ruby
+ref = Basilik::Load.new( 'https://bozo.firebaseio.com', my_secret_token )
+ref.set( tmp: { a: 0, b: 1 } )
+ref.set_rules( 
+  { '.read' => true, '.write' => false, 
+     "tmp"  => { '.read' => true, '.write' => false }
+  }
+)
+res = ref.child(:tmp).read # => { a: 0, b: 1 }
+ref.set( tmp: {d:0} ) } # => Basilik::Action::PermissionDeniedError
+```
+
+## Contact
+
+Fernand Galiana
+
+- http://github.com/derailed
+- http://twitter.com/kitesurfer
+- <fernand.galiana@gmail.com>
+
+## License
+
+Basilik is released under the [MIT](http://opensource.org/licenses/MIT) license.
+
+
+## History
+  0.0.1:
+    - Initial drop

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+
+Bundler.require
+
+Bundler::GemHelper.install_tasks
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.ruby_opts = "-I./spec"
+end
+
+desc 'Cleanup build artifacts'
+task :clean do
+  cov = File.expand_path( File.join( %w(.. coverage) ), __FILE__ ) 
+  FileUtils.rm_r( cov ) if File.exists?( cov )
+end
+
+task default: :spec

data/basilik.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "basilik/version"
+
+Gem::Specification.new do |s|
+  s.name        = "basilik"
+  s.version     = Basilik::VERSION
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = [
+    "Fernand Galiana"
+  ]
+
+  s.email             = ["fernand.galiana@gmail.com"]
+  s.homepage          = "https://github.com/derailed/basilik"
+  s.summary           = %q{Ruby implementation of Firebase framework}
+  s.description       = %q{Ruby implementation of Firebase framework}
+  s.rubyforge_project = "firebase"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'map'     , '~> 6.3.0'
+  s.add_dependency 'typhoeus', '~> 0.6.2'
+end

data/examples/a.rb

@@ -0,0 +1,10 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: 0,
+  b: %s(Hello World),
+  c: 10.5
+}
+ref.set( data )

data/examples/b.rb

@@ -0,0 +1,5 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+ref.set( %w(Hello World) )

data/examples/c.rb

@@ -0,0 +1,6 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+ref.push( "Bumblebee" )
+ref.push( "Tuna" )

data/examples/d.rb

@@ -0,0 +1,15 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: 10.5    
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )

data/examples/e.rb

@@ -0,0 +1,21 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+ref.child( :a ).update( a_1:"BumbleBee Tuna" )
+ref.child( 'a/a_2' ).update( a_2_2:"You bet!" )
+ref.child( 'a/a_3' ).update( a_3_1:"You bet!" )

data/examples/f.rb

@@ -0,0 +1,20 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+ref.child( 'a/a_2/a_2_2' ).remove
+ref.child( :b ).remove

data/examples/g.rb

@@ -0,0 +1,20 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+ref.child( 'a/a_2/a_2_2' ).read
+ref.child( :b ).remove

data/examples/h.rb

@@ -0,0 +1,22 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: 10.5    
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+a_2_ref = ref.child( 'a/a_2' )
+puts "A_2", a_2_ref.read
+
+val = ref.child( :a ).read
+puts val.class
+puts "A_1", val.a_1, val[:a_1]
+puts "A_2", val.a_2, val[:a_2]

data/examples/i.rb

@@ -0,0 +1,26 @@
+require 'basilik'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+data = {
+  a: {
+    a_1: %s(Hello World),    
+    a_2: {
+      a_2_1: 10.5,
+      a_2_2: "Word!"
+    }   
+  },
+  b: {
+    b_1: 10,
+    b_2: true
+  }
+}
+ref.set( data )
+a_2_2_ref = ref.child( 'a/a_2/a_2_2' )
+a_2_ref   = a_2_2_ref.parent
+puts "A_2", a_2_ref.name, a_2_ref.read.inspect
+a_ref     = a_2_2_ref.parent.parent
+puts "A", a_ref.name, a_ref.read.inspect
+
+a_2_2_ref = ref.child( :a ).child( :a_2 ).child( :a_2_2 )
+puts "A_2", a_2_ref.name, a_2_ref.read.inspect

data/examples/j.rb

@@ -0,0 +1,10 @@
+require 'basilik'
+require 'yaml'
+
+ref = Basilik::Load.new( ENV['fb_url'] )
+ref.remove
+a_ref = ref.push( {a:1, b:2} )
+b_ref = ref.push( {c:1, d:2} )
+a_ref.set_priority( 20 )
+b_ref.set_priority( 10 ) 
+puts "A", a_ref.parent.read.to_yaml