basilik 0.0.1

data/lib/basilik/action.rb

@@ -0,0 +1,141 @@
+require 'basilik/faults'
+
+module Basilik
+  module Action    
+    include Basilik::Faults
+    
+    def read
+      location = json_url
+      resp = Typhoeus.get( location, gen_opts( params: {format: :export} ) )
+      res  = handle_response( resp, location )
+      res.is_a?(Map) ? Snapshot.new( res ).to_map : res.is_a?(String) ? res.to_val : res
+    end
+            
+    def set( data )
+      location = json_url
+      resp = Typhoeus.put( location, gen_opts( body: data.to_json ) )
+      handle_response( resp, location )
+    end
+
+    def update( data )
+      location = json_url
+      resp = Typhoeus.patch( location, gen_opts( body: data.to_json ) )
+      handle_response( resp, location )
+    end
+    
+    def inc( field )
+      map = read
+      current_val = map[field]
+      raise NonNumericFieldError, "The field #{field} does not have a numeric value" if current_val and !current_val.is_a? Numeric
+      if current_val
+        new_val = map[field] + 1        
+      else 
+        new_val = 0
+      end
+      update( field => new_val )
+    end
+    
+    def dec( field )
+      map = read
+      current_val = map[field]
+      raise NonNumericFieldError, "The field #{field} does not have a numeric value" if current_val and !current_val.is_a? Numeric
+      if current_val
+        new_val = map[field] - 1        
+      else
+        new_val = 0
+      end
+      update( field => new_val )
+    end
+        
+    def remove
+      location = json_url
+      resp = Typhoeus.delete( location, gen_opts )
+      unless resp.success?
+        raise InvalidRequestError, "<#{resp.return_code}> Unable to perform request #{location}"
+      end
+    end
+  
+    def push( data=nil )
+      location = json_url
+      opts     = {}      
+      if data
+        opts[:body] = data.to_json
+      else
+        opts[:body] = ''.to_json
+      end
+      resp = Typhoeus.post( location, gen_opts( opts ) )
+      res = handle_response( resp, location )
+      Basilik::Load.new( uri.to_s + '/' + res.name )
+    end
+  
+    def set_priority( priority )
+      location = json_url( true )
+      resp = Typhoeus.put( location, gen_opts( body: priority.to_json ) )
+      unless resp.success? or resp.body
+        raise InvalidRequestError, "<#{resp.return_code}> Unable to perform request #{location}"
+      end
+    end
+    
+    def get_priority
+      location = json_url( true )      
+      resp = Typhoeus.get( location, gen_opts( params: { format: :export} ) )
+      res = handle_response( resp, location )
+      res.to_i
+    rescue NoDataError
+      nil
+    end
+    
+    def get_rules
+      location = rules_url
+      resp     = Typhoeus.get( location, gen_opts )
+      handle_response( resp, location )       
+    end
+    
+    def set_rules( rules )
+      location = rules_url
+      resp     = Typhoeus.put( location, gen_opts( body: {:rules => rules}.to_json ) )
+      handle_response( resp, location )
+    end
+    
+
+    private
+   
+    def gen_opts( opts={} )
+      if @auth_token
+        opts[:params] ||= {}
+        opts[:params][:auth] = @auth_token 
+      end
+      opts
+    end
+          
+    def handle_response( resp, location )
+      if resp.response_code == 403
+        raise PermissionDeniedError, "No permission for #{location}"
+      end
+      unless resp.success?
+        raise InvalidRequestError, "<#{resp.return_code}> Unable to perform request #{location}"
+      end
+      if resp.body.empty? or resp.body == "null"
+        raise NoDataError, "No data found at location #{location}"
+      end
+      
+      results = JSON.parse( resp.body ) rescue nil
+      results ? (results.is_a?(Hash) ? Map( results ) : results ) : resp.body.gsub( /\"/, '' )        
+    end
+                
+    def json_url( priority=nil )
+      if @url =~ /\.json$/
+        loc = @url
+      elsif root?
+        loc = @url + "/.json"
+      else
+        loc = @url + ".json"
+      end
+      priority ? loc.gsub( /\.json$/, "/.priority/.json" ) : loc
+    end
+    
+    def rules_url
+      @uri.merge( '.settings/rules.json' ).to_s      
+    end    
+  end
+end

data/lib/basilik/core.rb

@@ -0,0 +1 @@
+Basilik.require_all_libs_relative_to File.expand_path( File.join( %w(basilik core_ext), Basilik::LIBPATH ) )

data/lib/basilik/core_ext/map.rb

@@ -0,0 +1,23 @@
+require 'values'
+
+class Map
+  Event = Value.new( :event_type, :ref )
+  def diff(other)
+    res = dup.
+      delete_if { |k, v| other[k] == v }.
+      merge!(other.dup.delete_if { |k, v| has_key?(k) })
+    events = []  
+    res.each_pair do |k,v|
+      if self[k]
+        if other[k]
+          events << Event.new( Basilik::Load.evt_value, k ) 
+        else
+          events << Event.new( Basilik::Load.evt_child_removed, k )
+        end
+      else
+        events << Event.new( Basilik::Load.evt_child_added, k )
+      end
+    end
+    events
+  end  
+end

data/lib/basilik/core_ext/string.rb

@@ -0,0 +1,15 @@
+class String
+  def to_val
+    if self =~ /\A[-+]?\d+$/
+      Integer( self )
+    elsif self =~ /\A[-+]?\d+\.\d+$/
+      Float( self )
+    elsif self =~ /false/
+      false
+    elsif self =~ /true/
+      true
+    else
+      self
+    end
+  end
+end

data/lib/basilik/faults.rb

@@ -0,0 +1,9 @@
+module Basilik
+  module Faults
+    class NoDataError           < RuntimeError; end
+    class InvalidRequestError   < RuntimeError; end
+    class InvalidJSONError      < RuntimeError; end
+    class PermissionDeniedError < RuntimeError; end
+    class NonNumericFieldError  < RuntimeError; end
+  end
+end

data/lib/basilik/load.rb

@@ -0,0 +1,22 @@
+require 'basilik/ref'
+
+module Basilik
+  class Load
+    include Basilik::Ref
+    include Basilik::Action
+    
+    attr_reader :url, :uri
+    
+    def self.evt_value;         :value;     end
+    def self.evt_child_added;   :add_child; end
+    def self.evt_child_changed; :mod_child; end
+    def self.evt_child_removed; :rm_child;  end
+    def self.evt_child_moved;   :mv_child;  end
+                
+    def initialize( url, auth_token=nil )
+      @url        = url
+      @uri        = URI.parse( @url )
+      @auth_token = auth_token
+    end                                
+  end
+end

data/lib/basilik/ref.rb

@@ -0,0 +1,64 @@
+require 'uri'
+
+module Basilik
+  module Ref      
+    def name
+      parse_path[-1]
+    end
+    
+    def val
+      read
+    end
+    
+    def root
+      return self if root?
+      Basilik::Load.new( @uri.scheme + '://' + @uri.host )            
+    end
+    
+    def root?
+      @uri.path.empty? or @uri.path == "/"
+    end
+  
+    def parent
+      return nil if root?
+      path = parse_path[0..-2].join( "/" )
+      Basilik::Load.new( root.uri.merge(path).to_s )
+    end
+    
+    def child( child_path )
+      Basilik::Load.new( "#{uri.to_s}/#{child_path}" )
+    end
+      
+    def child?( child_path )
+      child( child_path ).read
+      true
+    rescue
+      false
+    end
+  
+    def children?
+      data = read
+      data.is_a? Map and !data.empty?
+    end
+    
+    def num_children
+      data = read
+      if data.is_a? Map and !data.empty?
+        data.count
+      else
+        0
+      end
+    end
+      
+    def to_s
+      @url
+    end
+    
+        
+    private
+              
+    def parse_path
+      @uri.path.split( "/" )
+    end
+  end
+end

data/lib/basilik/snapshot.rb

@@ -0,0 +1,99 @@
+module Basilik
+  class Snapshot
+      
+    class Node
+      attr_accessor :priority, :name, :parent, :children, :value
+    
+      def initialize( name )
+        @name     = name
+        @priority = nil
+        @children = []
+        @value    = nil
+        @parent   = nil
+      end
+    
+      def add_child( child )
+        child.parent = self
+        children << child
+      end
+      
+      def to_map
+        map = Map.new
+        order( map )
+        map
+      end
+        
+      def dump
+        puts "#{'  '*level}#{name} [#{priority.inspect}] --#{value.inspect}"  
+        children.sort_by do |c|
+          if c.priority and c.priority.is_a? Integer
+            "b_#{c.priority}_#{c.name}"
+          elsif c.priority
+            "z_#{c.priority}_#{c.name}"
+          else
+            "a_#{c.name}"
+          end
+        end.each do |c|
+          c.dump
+        end
+      end
+      
+      private
+      
+      def order( map )
+        map[name] = children.empty? ? value : Map.new
+        children.sort_by do |c|
+          if c.priority and c.priority.is_a? Numeric
+            "b_#{'%05.2f' % c.priority}_#{c.name}"
+          elsif c.priority
+            "z_#{c.priority}_#{c.name}"
+          else
+            "a_#{c.name}"
+          end
+        end.each do |c|
+          c.send( :order, map[name] )
+        end
+      end
+             
+      def level
+        level = 0
+        node  = self
+        while node.parent do
+          level +=1
+          node = node.parent
+        end
+        level
+      end
+    end
+  
+    def initialize( map )
+      @map = map
+      @root = Node.new( 'root' )
+      build( @map, @root )
+    end
+    
+    def to_map
+      @root.to_map.root
+    end
+    
+    def dump
+      @root.dump
+    end
+        
+    private
+  
+    def build( map, root )
+      map.each_pair do |k,v|
+        node = Node.new( k )
+        if v.is_a? Hash
+          priority = v.delete('.priority')
+          node.priority = priority if priority
+          build( v, node )
+        else
+          node.value = v.is_a?(String) ? v.to_val : v
+        end
+        root.add_child( node )
+      end
+    end
+  end
+end

data/lib/basilik/version.rb

@@ -0,0 +1,3 @@
+module Basilik
+  VERSION = "0.0.1"
+end

data/lib/basilik.rb

@@ -0,0 +1,17 @@
+require 'json'
+require 'typhoeus'
+require 'map'
+
+module Basilik  
+  LIBPATH      = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH         = ::File.dirname(LIBPATH) + ::File::SEPARATOR  
+  
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+    Dir.glob(search_me).sort.each { |rb| require rb }
+  end  
+end
+
+Basilik.require_all_libs_relative_to File.expand_path( "basilik", Basilik::LIBPATH )

data/spec/basilik/core_ext/map_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Map do
+  describe '#diff' do
+    describe 'single vals' do
+      it "tracks value changes correctly" do
+        prev = Map(:a,1)
+        curr = Map(:a,2)
+        evts = prev.diff( curr )
+        evts.should have(1).item
+        evts.first.event_type.should == Basilik::Load.evt_value
+        evts.first.ref.should == 'a'
+      end    
+    
+      it "tracks adds correctly" do
+        prev = Map.new
+        curr = Map(:a,2)
+        evts = prev.diff( curr )
+        evts.should have(1).item
+        evts.first.event_type.should == Basilik::Load.evt_child_added
+        evts.first.ref.should == 'a'
+      end    
+    
+      it "tracks deletes correctly" do
+        prev = Map(:a,2)
+        curr = Map.new
+        evts = prev.diff( curr )
+        evts.should have(1).item
+        evts.first.event_type.should == Basilik::Load.evt_child_removed
+        evts.first.ref.should == 'a'
+      end
+    end
+    
+    describe 'multi vals' do
+      it 'tracks multi value changes correctly' do
+        prev = Map(:a,1)
+        curr = Map({a:{a_1:10, a_2:20}})
+        evts = prev.diff( curr )
+        evts.should have(1).item
+        evts.first.event_type.should == Basilik::Load.evt_value
+        evts.first.ref.should == 'a'
+      end
+    end
+  end
+end

data/spec/basilik/core_ext/string_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe String do
+  describe '#to_val' do
+    it "keep strings unchanged" do
+      "fred".to_val.should == "fred"
+    end
+    
+    it "converts an integer correctly" do
+      "10".to_val.should == 10
+    end
+    
+    it "converts an float correctly" do
+      "10.5".to_val.should == 10.5
+    end
+    
+    it "converts a boolean correctly" do
+      "true".to_val.should  == true
+      "false".to_val.should == false
+    end
+    
+    it 'converts null correctly' do
+      'null'.to_val.should == "null"
+    end
+  end
+end

data/spec/basilik/ref_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe Basilik::Ref do
+  before :all do
+    @ref = Basilik::Load.new( ENV['fb_url'] )
+  end
+  
+  describe '#child?' do
+    it "retrieves complex values correctly" do
+      @ref.set( a:{b:{c:1, d:"hello"}} )
+      @ref.child?( :a ).should    == true
+      @ref.child?( 'a/b' ).should == true
+      @ref.child?( :z ).should    == false
+    end
+  end
+
+  describe '#children?' do
+    it "retrieves complex values correctly" do
+      @ref.set( a:{b:{c:1, d:"hello"}} )
+      @ref.child(:a).children?.should        == true
+      @ref.child('a/b').children?.should     == true
+      @ref.child( 'a/b/c' ).children?.should == false
+    end
+  end
+
+  describe '#num_children' do
+    it "retrieves complex values correctly" do
+      @ref.set( a:{b:{c:1, d:"hello"}} )
+      @ref.child(:a).num_children.should     == 1
+      @ref.child('a/b').num_children.should  == 2
+      @ref.child( 'a/b/c' ).num_children.should == 0
+    end
+  end
+  
+  describe '#val' do
+    it "retrieves simple value correctly" do
+      @ref.set( a:1 )
+      @ref.child( :a ).val.to_i.should == 1
+    end
+    
+    it "retrieves complex values correctly" do
+      @ref.set( a:{b:{c:1, d:"hello"}} )
+      @ref.child( :a ).val.should == {b:{c:1, d:"hello"}}
+    end
+  end
+  
+  describe '#child' do
+    it "creates a child ref correctly" do
+      child_ref = @ref.child( 'fred')
+      child_ref.name.should == 'fred'
+      child_ref.parent.to_s.should == ENV['fb_url']
+    end
+    
+    it "creates a deep child ref correctly" do
+      child_ref = @ref.child( 'fred/blee/duh')
+      child_ref.name.should == 'duh'
+      child_ref.parent.to_s.should == ENV['fb_url'] + '/fred/blee'
+    end    
+  end
+  
+  describe '#name' do
+    it "identifies / as the root name correctly" do
+      @ref.name.should be_nil
+    end
+    
+    it "identifies a url name correctly" do
+      ref = Basilik::Load.new( ENV['fb_url'] + '/fred/blee' )
+      ref.name.should == 'blee'
+    end    
+  end
+  
+  describe '#root' do
+    it "identifies / as root correctly" do
+      @ref.root.should == @ref
+    end    
+
+    it "identifies non root url correctly" do
+      ref = Basilik::Load.new( ENV['fb_url'] + '/fred/blee' )
+      ref.root.to_s.should == ENV['fb_url']
+    end        
+  end
+  
+  describe '#root?' do
+    it "identifies root correctly" do
+      @ref.should be_root
+    end
+    
+    it "identifies / as root correctly" do
+      ref = Basilik::Load.new( ENV['fb_url'] + '/' )
+      ref.should be_root
+    end
+    
+    it "identifies non root correctly" do
+      ref = Basilik::Load.new( ENV['fb_url'] + '/fred' )
+      ref.should_not be_root
+    end
+  end
+  
+  describe '#parent' do
+    it "identifies parent from root correctly" do
+      @ref.parent.should be_nil
+    end
+    
+    it "identifies a parent correctly" do
+      ref = Basilik::Load.new( ENV['fb_url'] + '/fred/blee' )
+      ref.parent.to_s.should == ENV['fb_url'] + '/fred'
+    end
+  end
+end