fauna 0.2.5 → 0.2.6

data/CHANGELOG

@@ -1,10 +1,12 @@
-v0.2.5 Anonymous class configuration
+v0.2.6 Implement set paging.
 
-v0.2.4 Event set query API
+v0.2.5 Anonymous class configuration.
 
-v0.2.3 Event set API enhancements
+v0.2.4 Event set query API.
 
-v0.2.2 Support for Fauna API version 1
+v0.2.3 Event set API enhancements.
+
+v0.2.2 Support for Fauna API version 1.
 
 v0.1.2 Fauna::User.find_by_external_id returns a User or nil, not an Array.
 

data/Manifest

@@ -17,6 +17,7 @@ lib/fauna/model/user.rb
 lib/fauna/publisher.rb
 lib/fauna/rails.rb
 lib/fauna/resource.rb
+lib/tasks/fauna.rake
 test/association_test.rb
 test/class_test.rb
 test/client_test.rb

data/README.md

@@ -95,7 +95,7 @@ Fauna::Client.context($fauna) do
 
   # fields
   user.ref       # => "users/123"
-  user.ts        # => 1359579766996758
+  user.ts        # => 2013-01-30 13:02:46 -0800
   user.deleted   # => false
   user.unique_id # => "taran77"
 
@@ -120,11 +120,16 @@ controllers, based on credentials in `config/fauna.yml`:
 development:
   email: taran@example.com
   password: secret
+  publisher_key: secret_key
 test:
   email: taran@example.com
   password: secret
 ```
 
+(In `config/fauna.yml`, if an existing publisher key is specified, the
+email and password can be omitted. If a publisher key is not
+specified, a new one will be created each time the app is started.)
+
 Then, in `config/initializers/fauna.rb`:
 
 ```ruby
@@ -170,8 +175,8 @@ Fauna.schema do
 end
 ```
 
-Install your schema on the server via a Rake task or the Rails
-console:
+Install your schema on the server via the `fauna:migrate` Rake task,
+or directly from the Rails console:
 
 ```ruby
 Fauna::Client.context(Fauna.connection) do
@@ -210,7 +215,7 @@ end
 Fauna::Client.context($fauna) do
   @pig = Pig.create!(name: "Henwen", unique_id: "henwen")
 
-  @pig = Pig.find(@pig.ref)
+  @pig = Pig.find(@pig.id)
   @pig.update(title: "Oracular Swine")
 
   @pig.title = "Most Illustrious Oracular Swine"
@@ -232,7 +237,12 @@ Fauna::Client.context($fauna) do
 
   @vision = Vision.create!(pronouncement: "In an ominous tower...")
   @pig.visions.add @vision
-  @pig.visions.page.events.first.resource # => @vision
+
+  page = @pig.visions.page(:size => 2)
+  page.events.first.resource # => @vision
+
+  next_page = @pig.visions.page(:size => 2, :before => page.before)
+  prev_page = @pig.visions.page(:size => 2, :after => page.after)
 end
 ```
 

data/examples/welcome.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# Ruby 1.9 required
+
+require "rubygems"
+require "pp"
+begin
+  require "fauna"
+rescue LoadError
+  puts "Please run: sudo gem install fauna"
+  exit!
+end
+
+print "Email: "
+email = gets.chomp
+
+print "Password: "
+pass = gets.chomp
+
+puts "\nConnected to Fauna Cloud Platform."
+
+puts "\nCreating a publisher key:"
+root = Fauna::Connection.new(email: email, password: pass)
+key = root.post("keys/publisher")['resource']['key']
+$fauna = Fauna::Connection.new(publisher_key: key)
+pp key
+
+puts "\nCreating classes:"
+class User < Fauna::User
+  pp self
+end
+
+class Spell < Fauna::Class
+  pp self
+end
+
+puts "\nCreating an event set."
+Fauna.schema do
+  with User do
+    event_set :spellbook
+  end
+
+  with Spell
+end
+
+Fauna::Client.context($fauna) do
+  puts "\nMigrating."
+  Fauna.migrate_schema!
+
+  puts "\nCreating a user:"
+  user = User.create!(
+    email: "#{object_id}@example.com",
+    password: "1234",
+    data: {
+      name: "Taran",
+      profession: "Pigkeeper",
+      location: "Caer Dallben"
+  })
+  pp user.struct
+
+  puts "\nCreating an instance:"
+  spell = Spell.create!(
+    data: {
+      pronouncement: "Draw Dyrnwyn only thou of royal blood.",
+      title: "Protector of Dyrnwyn"
+  })
+  pp spell.struct
+
+  puts "\nAdding the instance to the user's event set."
+  user.spellbook.add(spell)
+
+  puts "\nFetching the event set:"
+  pp user.spellbook.page.struct
+end

data/fauna.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = "fauna"
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Fauna, Inc."]
-  s.date = "2013-03-11"
+  s.date = "2013-04-03"
   s.description = "Official Ruby client for the Fauna API."
   s.email = ""
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.md", "lib/fauna.rb", "lib/fauna/client.rb", "lib/fauna/connection.rb", "lib/fauna/ddl.rb", "lib/fauna/event_set.rb", "lib/fauna/model.rb", "lib/fauna/model/class.rb", "lib/fauna/model/user.rb", "lib/fauna/publisher.rb", "lib/fauna/rails.rb", "lib/fauna/resource.rb"]
-  s.files = ["CHANGELOG", "Gemfile", "LICENSE", "Manifest", "README.md", "Rakefile", "fauna.gemspec", "lib/fauna.rb", "lib/fauna/client.rb", "lib/fauna/connection.rb", "lib/fauna/ddl.rb", "lib/fauna/event_set.rb", "lib/fauna/model.rb", "lib/fauna/model/class.rb", "lib/fauna/model/user.rb", "lib/fauna/publisher.rb", "lib/fauna/rails.rb", "lib/fauna/resource.rb", "test/association_test.rb", "test/class_test.rb", "test/client_test.rb", "test/connection_test.rb", "test/event_set_test.rb", "test/fixtures.rb", "test/publisher_test.rb", "test/readme_test.rb", "test/test_helper.rb", "test/user_test.rb", "test/validation_test.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.md", "lib/fauna.rb", "lib/fauna/client.rb", "lib/fauna/connection.rb", "lib/fauna/ddl.rb", "lib/fauna/event_set.rb", "lib/fauna/model.rb", "lib/fauna/model/class.rb", "lib/fauna/model/user.rb", "lib/fauna/publisher.rb", "lib/fauna/rails.rb", "lib/fauna/resource.rb", "lib/tasks/fauna.rake"]
+  s.files = ["CHANGELOG", "Gemfile", "LICENSE", "Manifest", "README.md", "Rakefile", "examples/welcome.rb", "fauna.gemspec", "lib/fauna.rb", "lib/fauna/client.rb", "lib/fauna/connection.rb", "lib/fauna/ddl.rb", "lib/fauna/event_set.rb", "lib/fauna/model.rb", "lib/fauna/model/class.rb", "lib/fauna/model/user.rb", "lib/fauna/publisher.rb", "lib/fauna/rails.rb", "lib/fauna/resource.rb", "lib/tasks/fauna.rake", "test/association_test.rb", "test/class_test.rb", "test/client_test.rb", "test/connection_test.rb", "test/event_set_test.rb", "test/fixtures.rb", "test/publisher_test.rb", "test/readme_test.rb", "test/test_helper.rb", "test/user_test.rb", "test/validation_test.rb"]
   s.homepage = "http://fauna.github.com/fauna/"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fauna", "--main", "README.md"]
   s.require_paths = ["lib"]

data/lib/fauna.rb

@@ -1,5 +1,6 @@
 require "json"
 require "logger"
+require "uri"
 
 require "restclient"
 require "active_model"
@@ -7,6 +8,10 @@ require "active_support/inflector"
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/hash/slice"
 
+if defined?(Rake)
+  load "#{File.dirname(__FILE__)}/tasks/fauna.rake"
+end
+
 module Fauna
   class Invalid < RuntimeError
   end

data/lib/fauna/client.rb

@@ -48,9 +48,12 @@ module Fauna
       end
 
       def cohere(ref, res)
-        @cache[ref] = res['resource'] if ref =~ %r{^users/self}
-        @cache[res['resource']['ref']] = res['resource']
-        @cache.merge!(res['references'] || {})
+        # FIXME Implement set range caching
+        if (res['resource']['class'] != "sets")
+          @cache[ref] = res['resource'] if ref =~ %r{^users/self}
+          @cache[res['resource']['ref']] = res['resource']
+          @cache.merge!(res['references'] || {})
+        end
       end
     end
 

data/lib/fauna/connection.rb

@@ -100,6 +100,14 @@ module Fauna
       end
     end
 
+    def query_string_for_logging(query)
+      if query
+        "?" + query.map do |k,v|
+          "#{k}=#{v}"
+        end.join("&")
+      end
+    end
+
     def execute(action, ref, data = nil, query = nil)
       args = { :method => action, :url => url(ref), :headers => {} }
 
@@ -113,8 +121,7 @@ module Fauna
       end
 
       if @logger
-        log(2) { "Fauna #{action.to_s.upcase}(\"#{ref}\")" }
-        log(4) { "Request query: #{JSON.pretty_generate(query)}" } if query
+        log(2) { "Fauna #{action.to_s.upcase}(\"#{ref}#{query_string_for_logging(query)}\")" }
         log(4) { "Request JSON: #{JSON.pretty_generate(data)}" } if @debug && data
 
         t0, r0 = Process.times, Time.now

data/lib/fauna/event_set.rb

@@ -1,25 +1,30 @@
 
 module Fauna
   class SetRef
-    attr_reader :ts, :resource_ref
-
     def initialize(attrs)
-      @ts = attrs['ts']
-      @resource_ref = attrs['resource']
+      @attrs = attrs
+    end
+
+    def ts
+      Resource.time_from_usecs(@attrs['ts'])
+    end
+
+    def resource_ref
+      @attrs['resource']
     end
 
     def resource
-      Fauna::Resource.find(resource_ref)
+      Fauna::Resource.find_by_ref(resource_ref)
     end
   end
 
   class Event < SetRef
-    attr_reader :set_ref, :action
+    def set_ref
+      @attrs['set']
+    end
 
-    def initialize(attrs)
-      super(attrs)
-      @set_ref = attrs['set']
-      @action = attrs['action']
+    def action
+      @attrs['action']
     end
 
     def set
@@ -31,9 +36,22 @@ module Fauna
     include Enumerable
 
     def self.find(ref, query = nil)
+      if query
+        query = query.merge(:before => usecs_from_time(query[:before])) if query[:before]
+        query = query.merge(:after => usecs_from_time(query[:after])) if query[:after]
+      end
+
       alloc(Fauna::Client.get(ref, query).to_hash)
     end
 
+    def before
+      struct['before'] ? Resource.time_from_usecs(struct['before']) : nil
+    end
+
+    def after
+      struct['after'] ? Resource.time_from_usecs(struct['after']) : nil
+    end
+
     def events
       @events ||= struct['events'].map { |e| Event.new(e) }
     end

data/lib/fauna/model.rb

@@ -18,12 +18,20 @@ module Fauna
       Fauna::EventSet.new(fauna_class)
     end
 
-    def self.find_by_id(id)
-      Fauna::Resource.find("#{fauna_class}/#{id}")
+    def self.find_by_ref(ref)
+      Fauna::Resource.find_by_ref(URI.escape(ref))
     end
 
     def self.find_by_unique_id(unique_id)
-      find("#{fauna_class}/unique_id/#{unique_id}")
+      find_by_ref("#{fauna_class}/unique_id/#{unique_id}")
+    end
+
+    def self.find(id)
+      find_by_ref("#{fauna_class}/#{id}")
+    end
+
+    class << self
+        alias find_by_id find
     end
 
     def id

data/lib/fauna/model/class.rb

@@ -13,17 +13,17 @@ module Fauna
       end
 
       def data
-        Fauna::Resource.find(config_ref).data
+        Fauna::Resource.find_by_ref(config_ref).data
       end
 
       def update_data!(hash = {})
-        meta = Fauna::Resource.find(config_ref)
+        meta = Fauna::Resource.find_by_ref(config_ref)
         block_given? ? yield(meta.data) : meta.data = hash
         meta.save!
       end
 
       def update_data(hash = {})
-        meta = Fauna::Resource.find(config_ref)
+        meta = Fauna::Resource.find_by_ref(config_ref)
         block_given? ? yield(meta.data) : meta.data = hash
         meta.save
       end

data/lib/fauna/model/user.rb

@@ -5,15 +5,15 @@ module Fauna
     class Config < Fauna::Resource; end
 
     def self.self
-      find("users/self")
+      find_by_ref("users/self")
     end
 
     def self.find_by_email(email)
-      find("users/email/#{email}")
+      find_by_ref("users/email/#{email}")
     end
 
     def config
-      Fauna::User::Config.find("#{ref}/config")
+      Fauna::User::Config.find_by_ref("#{ref}/config")
     end
 
     # set on user create

data/lib/fauna/publisher.rb

@@ -2,7 +2,7 @@
 module Fauna
   class Publisher < Fauna::Resource
     def self.find
-      super("publisher")
+      find_by_ref("publisher")
     end
   end
 end

data/lib/fauna/rails.rb

@@ -22,16 +22,26 @@ if defined?(Rails)
         end
 
         if !@silent
-          STDERR.puts ">> Using Fauna account #{credentials["email"].inspect} for #{APP_NAME.inspect}."
+          if credentials["publisher_key"]
+            STDERR.puts ">> Using Fauna publisher key #{credentials["publisher_key"].inspect} for #{APP_NAME.inspect}."
+          else
+            STDERR.puts ">> Using Fauna account #{credentials["email"].inspect} for #{APP_NAME.inspect}."
+          end
+
           STDERR.puts ">> You can change this in config/fauna.yml or ~/.fauna.yml."
         end
 
-        self.root_connection = Connection.new(
-          :email => credentials["email"],
-          :password => credentials["password"],
-        :logger => Rails.logger)
+        if credentials["publisher_key"]
+          publisher_key = credentials["publisher_key"]
+        else
+          self.root_connection = Connection.new(
+            :email => credentials["email"],
+            :password => credentials["password"],
+          :logger => Rails.logger)
+
+          publisher_key = root_connection.post("keys/publisher")["resource"]["key"]
+        end
 
-        publisher_key = root_connection.post("keys/publisher")["resource"]["key"]
         self.connection = Connection.new(publisher_key: publisher_key, logger: Rails.logger)
       else
         if !@silent

data/lib/fauna/resource.rb

@@ -48,7 +48,7 @@ module Fauna
           define_method("#{name}_ref") { references[name] }
           define_method("#{name}_ref=") { |ref| (ref.nil? || ref.empty?) ? references.delete(name) : references[name] = ref }
 
-          define_method(name) { Fauna::Resource.find(references[name]) if references[name] }
+          define_method(name) { Fauna::Resource.find_by_ref(references[name]) if references[name] }
           define_method("#{name}=") { |obj| obj.nil? ? references.delete(name) : references[name] = obj.ref }
         end
       end
@@ -64,7 +64,7 @@ module Fauna
       end
     end
 
-    def self.find(ref, query = nil)
+    def self.find_by_ref(ref, query = nil)
       res = Fauna::Client.get(ref, query)
       Fauna.class_for_name(res.fauna_class).alloc(res.to_hash)
     end
@@ -83,6 +83,14 @@ module Fauna
       obj
     end
 
+    def self.time_from_usecs(microseconds)
+      Time.at(microseconds/1_000_000, microseconds % 1_000_000)
+    end
+
+    def self.usecs_from_time(time)
+      time.to_i * 1000000 + time.usec
+    end
+
     attr_reader :struct
 
     alias :to_hash :struct
@@ -92,9 +100,16 @@ module Fauna
       assign(attrs)
     end
 
+    def ts
+      struct['ts'] ? Resource.time_from_usecs(struct['ts']) : nil
+    end
+
+    def ts=(time)
+      struct['ts'] = Resource.usecs_from_time(time)
+    end
+
     def ref; struct['ref'] end
     def fauna_class; struct['class'] end
-    def ts; struct['ts'] end
     def deleted; struct['deleted'] end
     def unique_id; struct['unique_id'] end
     def data; struct['data'] ||= {} end
@@ -106,7 +121,6 @@ module Fauna
     end
     alias :== :eql?
 
-
     # dynamic field access
 
     def respond_to?(method, *args)

data/lib/tasks/fauna.rake

@@ -0,0 +1,11 @@
+
+task :environment
+
+namespace :fauna do
+  desc "Migrate your fauna database to the latest version"
+  task :migrate => :environment do
+    Fauna::Client.context(Fauna.connection) do
+      Fauna.migrate_schema!
+    end
+  end
+end

data/test/class_test.rb

@@ -28,12 +28,12 @@ class ClassTest < ActiveModel::TestCase
   end
 
   def test_all
-    pig = Pig.create(:visited => false)
+    pig = Pig.create
     assert Pig.all.resources.include?(pig)
   end
 
   def test_save
-    pig = Pig.new(:visited => false)
+    pig = Pig.new
     pig.save
     assert pig.persisted?
   end
@@ -52,16 +52,62 @@ class ClassTest < ActiveModel::TestCase
     assert_equal pig.changes.page.events.length, 2
   end
 
+  def test_find_by_ref
+    pig = Pig.create
+    pig1 = Pig.find_by_ref(pig.ref)
+    assert_equal pig.ref, pig1.ref
+    assert pig1.persisted?
+  end
+
+  def test_find_by_unique_id
+    pig = Pig.create(:unique_id => "the pig")
+    pig1 = Pig.find_by_unique_id("the pig")
+    assert_equal pig.ref, pig1.ref
+    assert pig1.persisted?
+  end
+
   def test_find
-    pig = Pig.create(:visited => false)
-    pig1 = Pig.find(pig.ref)
+    pig = Pig.create
+
+    pig1 = Pig.find(pig.id)
     assert_equal pig.ref, pig1.ref
     assert pig1.persisted?
+
+    pig2 = Pig.find_by_id(pig.id)
+    assert_equal pig.ref, pig2.ref
+    assert pig2.persisted?
   end
 
   def test_destroy
-    pig = Pig.create(:visited => false)
+    pig = Pig.create
     pig.destroy
     assert pig.destroyed?
   end
+
+  def test_ts
+    pig = Pig.create
+    assert_instance_of(Time, pig.ts)
+
+    pig = Pig.new
+    assert_nil pig.ts
+  end
+
+  def test_ts_assignment
+    time = Time.at(0)
+    pig = Pig.create
+    pig.ts = time
+
+    Fauna::Client.context(@publisher_connection) do
+      pig2 = Pig.find(pig.id)
+      assert_not_equal time, pig2.ts
+    end
+
+    pig.save
+
+    Fauna::Client.context(@publisher_connection) do
+      pig3 = Pig.find(pig.id)
+      # Waiting on server support for timestamp overrides
+      # assert_equal time, pig3.ts
+    end
+  end
 end

data/test/event_set_test.rb

@@ -12,8 +12,30 @@ class EventSetTest < ActiveModel::TestCase
 
   def test_page
     page = @model.posts.page
-    assert_equal page.ref, "#{@model.ref}/sets/posts"
-    assert_equal page.events.size, 0
+    assert_equal "#{@model.ref}/sets/posts", page.ref
+    assert_equal 0, page.events.size
+  end
+
+  def test_pagination
+    @model.posts.add(Post.create(:body => "Flewdyr Flam, called also Flewdyr Wledig."))
+    @model.posts.add(Post.create(:body => "Recorded in the Triads as one of the three sovereigns."))
+    @model.posts.add(Post.create(:body => "They preferred remaining as knights in the court of Arthur."))
+    @model.posts.add(Post.create(:body => "Even so, they had dominions of their own."))
+    @model.posts.add(Post.create(:body => "He is mentioned in the Mabinogi of Cilhwch and Olwen."))
+
+    page1 = @model.posts.page(:size => 2)
+    assert_equal 2, page1.events.size
+    page2 = @model.posts.page(:size => 2, :before => page1.before)
+    assert_equal 2, page2.events.size
+    page3 = @model.posts.page(:size => 2, :before => page2.before)
+    assert_equal 1, page3.events.size
+
+    page4 = @model.posts.page(:size => 2, :after => page3.events.last.ts)
+    assert_equal 2, page4.events.size
+    page5 = @model.posts.page(:size => 2, :after => page4.after)
+    assert_equal 2, page5.events.size
+    page6 = @model.posts.page(:size => 2, :after => page5.after)
+    assert_equal 1, page6.events.size
   end
 
   def test_any
@@ -25,14 +47,14 @@ class EventSetTest < ActiveModel::TestCase
   def test_event_set_add
     @model.posts.add(Post.create(:body => "Goodbye"))
     page = @model.posts.page
-    assert_equal page.events.size, 1
-    assert_equal page.events[0].resource.body, "Goodbye"
+    assert_equal 1, page.events.size
+    assert_equal "Goodbye", page.events[0].resource.body
   end
 
   def test_event_set_remove
     @model.posts.add(Post.create(:body => "Hello"))
     page = @model.posts.page
-    assert_equal page.events.size, 1
+    assert_equal 1, page.events.size
     @model.posts.remove(page.events[0].resource)
   end
 

data/test/user_test.rb

@@ -41,9 +41,9 @@ class UserTest < ActiveModel::TestCase
     assert_equal user.changes.page.events.length, 2
   end
 
-  def test_find
+  def test_find_by_ref
     user = Fauna::User.create(@attributes)
-    user1 = Fauna::User.find(user.ref)
+    user1 = Fauna::User.find_by_ref(user.ref)
     assert_equal user.ref, user1.ref
     assert user1.persisted?
     assert_equal user1.pockets, user.pockets
@@ -69,4 +69,12 @@ class UserTest < ActiveModel::TestCase
     user = Fauna::User.create(@attributes.merge(:unique_id => "henwen"))
     assert_equal user, Fauna::User.find_by_unique_id("henwen")
   end
+
+  def test_find
+    user = Fauna::User.create(@attributes)
+    user1 = Fauna::User.find(user.id)
+    assert_equal user.ref, user1.ref
+    assert user1.persisted?
+    assert_equal user1.pockets, user.pockets
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fauna
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -142,6 +142,7 @@ extra_rdoc_files:
 - lib/fauna/publisher.rb
 - lib/fauna/rails.rb
 - lib/fauna/resource.rb
+- lib/tasks/fauna.rake
 files:
 - CHANGELOG
 - Gemfile
@@ -149,6 +150,7 @@ files:
 - Manifest
 - README.md
 - Rakefile
+- examples/welcome.rb
 - fauna.gemspec
 - lib/fauna.rb
 - lib/fauna/client.rb
@@ -161,6 +163,7 @@ files:
 - lib/fauna/publisher.rb
 - lib/fauna/rails.rb
 - lib/fauna/resource.rb
+- lib/tasks/fauna.rake
 - test/association_test.rb
 - test/class_test.rb
 - test/client_test.rb