fauna 0.2.6 → 1.1.0

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.1.0. Updates for Fauna 1.1. Remove schema configuration.
+
 v0.2.6 Implement set paging.
 
 v0.2.5 Anonymous class configuration.

data/Manifest

@@ -1,31 +0,0 @@
-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

data/README.md

@@ -33,20 +33,18 @@ require "fauna"
 
 All API requests start with an instance of `Fauna::Connection`.
 
-Creating a connection requires either a token, a publisher key, a
-client key, or the publisher's email and password.
+Creating a connection requires either a token, a server key, or a
+client key.
 
-Let's use the email and password to get a publisher key:
+Let's use a server key we got from our [Fauna Cloud console](https://fauna.org/console):
 
 ```ruby
-root = Fauna::Connection.new(email: "publisher@example.com", password: "secret")
-publisher_key = root.post("keys/publisher")['resource']['key']
+server_key = 'ls8AkXLdakAAAALPAJFy3LvQAAGwDRAS_Prjy6O8VQBfQAlZzwAA'
 ```
-
-Now we can make a global publisher-level connection:
+Now we can make a global database-level connection:
 
 ```ruby
-$fauna = Fauna::Connection.new(publisher_key: publisher_key)
+$fauna = Fauna::Connection.new(secret: server_key)
 ```
 
 You can optionally configure a `logger` on the connection to ease
@@ -55,7 +53,7 @@ debugging:
 ```ruby
 require "logger"
 $fauna = Fauna::Connection.new(
-  publisher_key: publisher_key,
+  secret: server_key,
   logger: Logger.new(STDERR))
 ```
 
@@ -66,11 +64,11 @@ context*, and then manipulate resources within that context:
 
 ```ruby
 Fauna::Client.context($fauna) do
-  user = Fauna::User.create!(email: "taran@example.com")
+  user = Fauna::Resource.create('users', email: "taran@example.com")
   user.data["name"] = "Taran"
   user.data["profession"] = "Pigkeeper"
-  user.save!
-  user.destroy
+  user.save
+  user.delete
 end
 ```
 
@@ -91,176 +89,46 @@ fields:
 
 ```ruby
 Fauna::Client.context($fauna) do
-  user = Fauna::User.create(unique_id: "taran77")
+  user = Fauna::Resource.create('users', constraints: "taran77")
 
   # fields
   user.ref       # => "users/123"
   user.ts        # => 2013-01-30 13:02:46 -0800
   user.deleted   # => false
-  user.unique_id # => "taran77"
+  user.constraints # => "taran77"
 
   # data and references
   user.data       # => {}
   user.references # => {}
 
-  # changes event set
-  user.changes
+  # resource events timeline
+  user.events
 end
 ```
 
 ## Rails Usage
 
-Fauna provides ActiveModel-compatible classes that can be used
-directly in Rails.
-
-Fauna also provides a Rails helper that sets up a default context in
+Fauna provides a Rails helper that sets up a default context in
 controllers, based on credentials in `config/fauna.yml`:
 
 ```yaml
 development:
   email: taran@example.com
   password: secret
-  publisher_key: secret_key
+  server_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
+(In `config/fauna.yml`, if an existing server key is specified, the
+email and password can be omitted. If a server key is not
 specified, a new one will be created each time the app is started.)
 
 Then, in `config/initializers/fauna.rb`:
 
 ```ruby
 require "fauna/rails"
-
-Fauna.schema do
-  # See below for schema setup
-end
-```
-
-### Setting Up the Schema
-
-First, create some Ruby classes to model your domain. They must
-inherit from the `Fauna::Class` base class:
-
-```ruby
-# Create a custom Pig class.
-class Pig < Fauna::Class
-    # Fields can be configured dynamically
-    field :name, :title
-end
-
-# Create a custom Vision class
-class Vision < Fauna::Class
-  field :pronouncement
-  reference :pig
-end
-```
-
-Fields and references can be configured dynamically, but the classes
-and event sets themselves must be configured with an additional
-`Fauna.schema` block (normally placed in
-`config/initializers/fauna.rb`):
-
-```ruby
-Fauna.schema do
-  with Pig do
-    # Add a custom event set
-    event_set :visions
-  end
-
-  with Vision
-end
-```
-
-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
-  Fauna.migrate_schema!
-end
-```
-
-Make sure to do this at least once, as well as every time you change
-the schema definition:
-
-### Users Class
-
-```ruby
-class Fauna::User
-  # Extend the User class with a custom field
-  field :pockets
-end
-
-# Create a user, fill their pockets, and delete them.
-Fauna::Client.context($fauna) do
-  taran = Fauna::User.new(
-    email: "taran@example.com",
-    password: "secret")
-
-  taran.save!
-  taran.pockets = "Piggy treats"
-  taran.save!
-  taran.destroy
-end
-```
-
-### Custom Classes
-
-```ruby
-# Create, find, update, and destroy Pigs.
-Fauna::Client.context($fauna) do
-  @pig = Pig.create!(name: "Henwen", unique_id: "henwen")
-
-  @pig = Pig.find(@pig.id)
-  @pig.update(title: "Oracular Swine")
-
-  @pig.title = "Most Illustrious Oracular Swine"
-  @pig.save!
-
-  @pig.destroy
-end
-```
-
-### Event Sets
-
-[Event Sets](https://fauna.org/API#event-sets) are high-cardinality,
-bidirectional event collections. Event sets must be declared in the
-Schema.
-
-```ruby
-Fauna::Client.context($fauna) do
-  @pig = Pig.create!(name: "Henwen", unique_id: "henwen")
-
-  @vision = Vision.create!(pronouncement: "In an ominous tower...")
-  @pig.visions.add @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
-```
-
-### References
-
-References are single or low-cardinality, unidirectional, and have no
-event log. They are declared dynamically, in the class.
-
-```ruby
-class Vision
-  # References can be configured dynamically, like fields
-  reference :pig
-end
-
-Fauna::Client.context($fauna) do
-  @vision.pig # => @pig
-  @vision.pig_ref # => "instances/1235921393191239"
-end
 ```
 
 ## Further Reading

data/Rakefile

@@ -5,7 +5,7 @@ Echoe.new("fauna") do |p|
   p.project = "fauna"
   p.summary = "Official Ruby client for the Fauna API."
   p.retain_gemspec = true
-  p.dependencies = ["activemodel", "activesupport", "rest-client", "json"]
+  p.dependencies = ["rest-client", "json"]
   p.development_dependencies = ["mocha", "echoe", "minitest"]
 end
 

data/examples/welcome.rb

@@ -18,10 +18,10 @@ pass = gets.chomp
 
 puts "\nConnected to Fauna Cloud Platform."
 
-puts "\nCreating a publisher key:"
+puts "\nCreating a server key:"
 root = Fauna::Connection.new(email: email, password: pass)
-key = root.post("keys/publisher")['resource']['key']
-$fauna = Fauna::Connection.new(publisher_key: key)
+key = root.post("keys", "role" => "server")['resource']['key']
+$fauna = Fauna::Connection.new(server_key: key)
 pp key
 
 puts "\nCreating classes:"

data/fauna.gemspec

@@ -2,37 +2,33 @@
 
 Gem::Specification.new do |s|
   s.name = "fauna"
-  s.version = "0.2.6"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Fauna, Inc."]
-  s.date = "2013-04-03"
+  s.date = "2013-07-31"
   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", "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.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.md", "lib/fauna.rb", "lib/fauna/cache.rb", "lib/fauna/client.rb", "lib/fauna/connection.rb", "lib/fauna/provided_classes.rb", "lib/fauna/rails.rb", "lib/fauna/resource.rb", "lib/fauna/set.rb", "lib/fauna/util.rb", "lib/tasks/fauna.rake"]
+  s.files = ["CHANGELOG", "Gemfile", "LICENSE", "Manifest", "README.md", "Rakefile", "examples/welcome.rb", "fauna.gemspec", "lib/fauna.rb", "lib/fauna/cache.rb", "lib/fauna/client.rb", "lib/fauna/connection.rb", "lib/fauna/provided_classes.rb", "lib/fauna/rails.rb", "lib/fauna/resource.rb", "lib/fauna/set.rb", "lib/fauna/util.rb", "lib/tasks/fauna.rake", "test/class_test.rb", "test/client_test.rb", "test/connection_test.rb", "test/database_test.rb", "test/readme_test.rb", "test/set_test.rb", "test/test_helper.rb"]
   s.homepage = "http://fauna.github.com/fauna/"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Fauna", "--main", "README.md"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "fauna"
   s.rubygems_version = "1.8.23"
   s.summary = "Official Ruby client for the Fauna API."
-  s.test_files = ["test/association_test.rb", "test/class_test.rb", "test/client_test.rb", "test/connection_test.rb", "test/event_set_test.rb", "test/publisher_test.rb", "test/readme_test.rb", "test/test_helper.rb", "test/user_test.rb", "test/validation_test.rb"]
+  s.test_files = ["test/class_test.rb", "test/client_test.rb", "test/connection_test.rb", "test/database_test.rb", "test/readme_test.rb", "test/set_test.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activemodel>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
       s.add_development_dependency(%q<echoe>, [">= 0"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
     else
-      s.add_dependency(%q<activemodel>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
@@ -40,8 +36,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<minitest>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activemodel>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])

data/lib/fauna.rb

@@ -1,12 +1,7 @@
-require "json"
-require "logger"
-require "uri"
-
-require "restclient"
-require "active_model"
-require "active_support/inflector"
-require "active_support/core_ext/module/delegation"
-require "active_support/core_ext/hash/slice"
+require 'json'
+require 'logger'
+require 'uri'
+require 'restclient'
 
 if defined?(Rake)
   load "#{File.dirname(__FILE__)}/tasks/fauna.rake"
@@ -18,84 +13,12 @@ module Fauna
 
   class NotFound < RuntimeError
   end
-
-  class MissingMigration < RuntimeError
-  end
 end
 
-require "fauna/connection"
-require "fauna/client"
-require "fauna/resource"
-require "fauna/publisher"
-require "fauna/event_set"
-require "fauna/model"
-require "fauna/model/class"
-require "fauna/model/user"
-require "fauna/ddl"
-
-module Fauna
-
-  DEFAULT_BLOCK = proc do
-    with User, class_name: "users"
-    with User::Config, class_name: "users/config"
-    with EventsPage, class_name: "sets"
-    with EventSetConfig, class_name: "sets/config"
-    with ClassConfig, class_name: "classes/config"
-    with Publisher, class_name: "publisher"
-  end
-
-  def self.configure_schema!
-    @classes = {}
-    @schema = Fauna::DDL.new
-    @blocks.each { |blk| @schema.instance_eval(&blk) }
-    @schema.configure!
-    nil
-  end
-
-  def self.schema(&block)
-    @blocks << block
-    configure_schema!
-  end
-
-
-  def self.reset_schema!
-    @blocks = [DEFAULT_BLOCK]
-    configure_schema!
-  end
-
-  def self.migrate_schema!
-    @schema.load!
-    nil
-  end
-
-  # these should be private to the gem
-
-  def self.exists_class_for_name?(fauna_class)
-    !!@classes[fauna_class]
-  end
-
-  def self.add_class(fauna_class, klass)
-    klass.fauna_class = fauna_class.to_s
-    @classes.delete_if { |_, v| v == klass }
-    @classes[fauna_class.to_s] = klass
-  end
-
-  def self.class_for_name(fauna_class)
-    @classes[fauna_class] ||=
-    if fauna_class =~ %r{^classes/[^/]+$}
-      klass = begin $1.classify.constantize rescue NameError; nil end
-      if klass.nil? || klass >= Fauna::Class || klass.fauna_class # e.g. already associated with another fauna_class
-        klass = ::Class.new(Fauna::Class)
-      end
-
-      klass.fauna_class = fauna_class
-      klass
-    else
-      ::Class.new(Fauna::Resource)
-    end
-  end
-
-  # apply the default schema so that the built-in classes work
-
-  reset_schema!
-end
+require 'fauna/util'
+require 'fauna/connection'
+require 'fauna/cache'
+require 'fauna/client'
+require 'fauna/resource'
+require 'fauna/set'
+require 'fauna/provided_classes'