fauna 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeba4b71fb3aa58412e5f78514faa422f3d71eab
-  data.tar.gz: 0a53bd599a46461131c1c552b7ef6e1893833cd0
+  metadata.gz: dfcff73c948e3e884ab373e09ff77948e625a4f7
+  data.tar.gz: 43059c04a28d0fa4b3d03cf50827194372f67508
 SHA512:
-  metadata.gz: 5f4b77c6451c409b30135a918ddacd7bc6751658d9ddb4c38733b8503032be6c148a0cf9e78b105259e444150b68a0a0054b909fac48ce977c2386136afaf9d4
-  data.tar.gz: 524c60bcada18bc69e7411cac1fbc17afc58624aaa448763bf38f467b43edd4063f5a5d0eed6b0c9ba834fb4f5bb3d452725dbd4e83c300489cf49ad45182317
+  metadata.gz: 12916b7c045128f1e0f311f2b83e2dce14bf188268c28b086c19af48e946139d132a160b1a0692d4d75f077d7e078a9becf02cc25407154bdd7198f4fa37825c
+  data.tar.gz: c6a24431d0f0a50ef6e327318ac8beb698beb11d9fa845f35eb23de454bab5b49911e8c433366f7f757d914e8ec869d4bafddbd44cde9dc2b175cf089798d42b

data/CHANGELOG

@@ -1,3 +1,14 @@
+3.0.0
+* Adds support for recursive references.
+* Removed REST api support from `Client`.
+* Added `abort` function.
+* Added `normalizer` argument to `casefold` function.
+* Added `new_id` function.
+* Deprecated `next_id` function in favor of `new_id`.
+* Added `identity` and `has_identity` functions.
+* Added `singleton` and `events` functions.
+* Added `select_all` function.
+
 2.4.0
 * Handle HTTP errors 502 and 504 as `Fauna::UnavailableError`.
 * Added support for user-defined functions.

data/README.md

@@ -1,6 +1,5 @@
 # FaunaDB
 
-[![Build Status](https://img.shields.io/travis/fauna/faunadb-ruby/master.svg?maxAge=21600)](https://travis-ci.org/fauna/faunadb-ruby)
 [![Coverage Status](https://img.shields.io/codecov/c/github/fauna/faunadb-ruby/master.svg?maxAge=21600)](https://codecov.io/gh/fauna/faunadb-ruby/branch/master)
 [![Gem Version](https://img.shields.io/gem/v/fauna.svg?maxAge=21600)](https://rubygems.org/gems/fauna)
 [![License](https://img.shields.io/badge/license-MPL_2.0-blue.svg?maxAge=2592000)](https://raw.githubusercontent.com/fauna/faunadb-ruby/master/LICENSE)
@@ -124,6 +123,10 @@ Coverage is automatically run as part of the tests. After running tests, check
 `JRUBY_OPTS="--debug" bundle exec rake spec` to ensure coverage is generated
 correctly.
 
+Tests can also be run via a Docker container with
+`FAUNA_ROOT_KEY="your-cloud-secret" make docker-test` (an alternate
+Alpine-based Ruby image can be provided via `RUNTIME_IMAGE`).
+
 ## Contributing
 
 GitHub pull requests are very welcome.

data/fauna.gemspec

@@ -22,5 +22,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'json', '~> 1.8'
   s.add_development_dependency 'rspec', '~> 3.4'
   s.add_development_dependency 'rubocop', '~> 0.38.0'
-  s.add_development_dependency 'codecov', '~> 0.1.5'
+  s.add_development_dependency 'simplecov-json', '~> 0.2.0'
+  s.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
 end

data/lib/fauna.rb

@@ -11,6 +11,7 @@ require 'base64'
 # Main namespace for the FaunaDB driver.
 module Fauna; end
 
+require 'fauna/deprecate.rb'
 require 'fauna/version'
 require 'fauna/json'
 require 'fauna/util'

data/lib/fauna/client.rb

@@ -7,8 +7,8 @@ module Fauna
   # Hash keys are always Symbols.
   #
   # Any Ref, SetRef, Time or Date values in it will also be parsed.
-  # (So instead of <code>{ "@ref": "classes/frogs/123" }</code>,
-  # you will get <code>Fauna::Ref.new("classes/frogs/123")</code>).
+  # (So instead of <code>{ "@ref": { "id": "123", "class": { "@ref": { "id": "frogs", "class": { "@ref": { "id": "classes" } } } } } }</code>,
+  # you will get <code>Fauna::Ref.new("123", Fauna::Ref.new("frogs", Fauna::Native.classes))</code>).
   class Client
     # The domain requests will be sent to.
     attr_reader :domain
@@ -84,9 +84,9 @@ module Fauna
     # :category: Query Methods
     def query(expression = nil, &expr_block)
       if expr_block.nil?
-        post '', Fauna::Query::Expr.wrap(expression)
+        execute(:post, :'', nil, Fauna::Query::Expr.wrap(expression))
       else
-        post '', Fauna::Query.expr(&expr_block)
+        execute(:post, :'', nil, Fauna::Query.expr(&expr_block))
       end
     end
 
@@ -101,70 +101,6 @@ module Fauna
       Fauna::Page.new(self, set, params, &fauna_map)
     end
 
-    ##
-    # Performs a +GET+ request for a REST endpoint.
-    #
-    # +path+:: Path to +GET+.
-    # +query+:: Query parameters to append to the path.
-    #
-    # Reference: {FaunaDB REST API}[https://fauna.com/documentation/rest]
-    #
-    # :category: REST Methods
-    def get(path, query = {})
-      execute(:get, path.to_s, query)
-    end
-
-    ##
-    # Performs a +POST+ request for a REST endpoint.
-    #
-    # +path+:: Path to +POST+.
-    # +data+:: Data to post as the body. +data+ is automatically converted to JSON.
-    #
-    # Reference: {FaunaDB REST API}[https://fauna.com/documentation/rest]
-    #
-    # :category: REST Methods
-    def post(path, data = {})
-      execute(:post, path, nil, data)
-    end
-
-    ##
-    # Performs a +PUT+ request for a REST endpoint.
-    #
-    # +path+:: Path to +PUT+.
-    # +data+:: Data to post as the body. +data+ is automatically converted to JSON.
-    #
-    # Reference: {FaunaDB REST API}[https://fauna.com/documentation/rest]
-    #
-    # :category: REST Methods
-    def put(path, data = {})
-      execute(:put, path, nil, data)
-    end
-
-    ##
-    # Performs a +PATCH+ request for a REST endpoint.
-    #
-    # +path+:: Path to +PATCH+.
-    # +data+:: Data to post as the body. +data+ is automatically converted to JSON.
-    #
-    # Reference: {FaunaDB REST API}[https://fauna.com/documentation/rest]
-    #
-    # :category: REST Methods
-    def patch(path, data = {})
-      execute(:patch, path, nil, data)
-    end
-
-    ##
-    # Performs a +DELETE+ request for a REST endpoint.
-    #
-    # +path+:: Path to +DELETE+.
-    #
-    # Reference: {FaunaDB REST API}[https://fauna.com/documentation/rest]
-    #
-    # :category: REST Methods
-    def delete(path)
-      execute(:delete, path)
-    end
-
     ##
     # Ping FaunaDB.
     #
@@ -172,7 +108,7 @@ module Fauna
     #
     # :category: REST Methods
     def ping(params = {})
-      get 'ping', params
+      execute(:get, :ping, params)
     end
 
   private
@@ -195,6 +131,7 @@ module Fauna
           'Accept-Encoding' => 'gzip,deflate',
           'Content-Type' => 'application/json;charset=utf-8',
           'User-Agent' => "FaunaDB-Ruby/#{Fauna::VERSION}",
+          'X-FaunaDB-API-Version' => '2.1'
         },
         request: { timeout: read_timeout, open_timeout: connection_timeout },
       ) do |conn|

data/lib/fauna/deprecate.rb

@@ -0,0 +1,29 @@
+module Fauna
+  module Deprecate
+    ##
+    # Deprecates a method
+    #
+    # class AClass
+    #   extend Fauna::Deprecate
+    #
+    #   def method
+    #   end
+    #
+    #   deprecate :method, :new_method
+    #
+    #   def new_method
+    #   end
+    # end
+    #
+    # +name+:: The method name to be deprecated
+    # +replacement+:: The new method that should be used instead
+    def deprecate(name, replacement)
+      old_name = "deprecated_#{name}"
+      alias_method old_name, name
+      define_method name do |*args, &block|
+        warn "Method #{name} called from #{Gem.location_of_caller.join(':')} is deprecated. Use #{replacement} instead"
+        self.__send__ old_name, *args, &block
+      end
+    end
+  end
+end

data/lib/fauna/json.rb

@@ -11,7 +11,16 @@ module Fauna
     def self.deserialize(obj)
       if obj.is_a?(Hash)
         if obj.key? :@ref
-          Ref.new obj[:@ref]
+          ref = obj[:@ref]
+          id = ref[:id]
+
+          if !ref.key?(:class) && !ref.key?(:database)
+            Native.from_name(id)
+          else
+            cls = self.deserialize(ref[:class])
+            db = self.deserialize(ref[:database])
+            Ref.new(id, cls, db)
+          end
         elsif obj.key? :@set
           SetRef.new deserialize(obj[:@set])
         elsif obj.key? :@obj
@@ -35,7 +44,7 @@ module Fauna
     end
 
     def self.json_load(body)
-      JSON.load body, nil, max_nesting: false, symbolize_names: true
+      JSON.load body, nil, max_nesting: false, symbolize_names: true, create_additions: false
     end
 
     def self.json_load_or_nil(body)

data/lib/fauna/objects.rb

@@ -4,62 +4,64 @@ module Fauna
   #
   # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries#values-special_types]
   class Ref
-    # The raw ref string.
-    attr_accessor :value
+    # The raw attributes of ref.
+    attr_accessor :id, :class_, :database
 
     ##
     # Creates a Ref object.
     #
     # :call-seq:
-    #   Ref.new('databases/prydain')
+    #   Ref.new('prydain', Native.databases)
     #
-    # +value+: A string.
-    def initialize(value)
-      @value = value
-    end
+    # +id+: A string.
+    # +class_+: A Ref.
+    # +database+: A Ref.
+    def initialize(id, class_ = nil, database = nil)
+      fail ArgumentError.new 'id cannot be nil' if id.nil?
 
-    ##
-    # Gets the class part out of the Ref.
-    # This is done by removing ref.id().
-    # So <code>Fauna::Ref.new('a/b/c').to_class</code> will be
-    # <code>Fauna::Ref.new('a/b')</code>.
-    def to_class
-      parts = value.split '/'
-      if parts.length == 1
-        self
-      else
-        Fauna::Ref.new(parts[0...-1].join('/'))
-      end
-    end
-
-    ##
-    # Removes the class part of the ref, leaving only the id.
-    # This is everything after the last /.
-    def id
-      parts = value.split '/'
-      fail ArgumentError.new 'The Ref does not have an id.' if parts.length == 1
-      parts.last
+      @id = id
+      @class_ = class_ unless class_.nil?
+      @database = database unless database.nil?
     end
 
     # Converts the Ref to a string
     def to_s
-      value
+      cls = class_.nil? ? '' : ",class=#{class_.to_s}"
+      db = database.nil? ? '' : ",database=#{database.to_s}"
+      "Ref(id=#{id}#{cls}#{db})"
     end
 
     # Converts the Ref in Hash form.
     def to_hash
-      { :@ref => value }
+      ref = { id: id }
+      ref[:class] = class_ unless class_.nil?
+      ref[:database] = database unless database.nil?
+      { :@ref => ref }
     end
 
     # Returns +true+ if +other+ is a Ref and contains the same value.
     def ==(other)
       return false unless other.is_a? Ref
-      value == other.value
+      id == other.id && class_ == other.class_ && database == other.database
     end
 
     alias_method :eql?, :==
   end
 
+  class Native
+    @@natives = %w(classes indexes databases functions keys tokens credentials).freeze
+
+    @@natives.each do |id|
+      instance_variable_set "@#{id}", Ref.new(id).freeze
+      self.class.send :attr_reader, id.to_sym
+    end
+
+    def self.from_name(id)
+      return Ref.new(id) unless @@natives.include? id
+      send id.to_sym
+    end
+  end
+
   ##
   # A SetRef.
   #

data/lib/fauna/page.rb

@@ -16,24 +16,24 @@ module Fauna
   #
   # Paging over a class index
   #
-  #   page = Page.new(client, Query.match(Ref.new('indexes/items')))
+  #   page = Page.new(client, Query.match(Query.index('items')))
   #
   # Paging over a class index 5 at a time, mapping the refs to the +data.value+ for each instance
   #
-  #   page = Page.new(client, Query.match(Ref.new('indexes/items')), size: 5) do |ref|
+  #   page = Page.new(client, Query.match(Query.index('items')), size: 5) do |ref|
   #     select ['data', 'value'], get(ref)
   #   end
   #
   #   # Same thing, but using builders instead
   #
-  #   page = Page.new(client, Query.match(Ref.new('indexes/items'))).with_params(size: 5).map do |ref|
+  #   page = Page.new(client, Query.match(Query.index('items'))).with_params(size: 5).map do |ref|
   #     select ['data', 'value'], get(ref)
   #   end
   #
   # Paging over a class index, mapping refs to the +data.value+ for each instance, filtering out odd numbers, and
   # multiplying the value:
   #
-  #   page = Page.new(client, Query.match(Ref.new('indexes/items'))).map do |ref|
+  #   page = Page.new(client, Query.match(Query.index('items'))).map do |ref|
   #     select ['data', 'value'], get(ref)
   #   end.filter do |value|
   #     equals modulo(value, 2), 0

data/lib/fauna/query.rb

@@ -5,17 +5,17 @@ module Fauna
   # Helpers are usually used via a concise DSL notation. A DSL block
   # may be used directly with Fauna::Client
   #
-  #   client.query { create(ref('classes', 'spells'), { data: { name: 'Magic Missile' } }) }
+  #   client.query { create(class_('spells'), { data: { name: 'Magic Missile' } }) }
   #
   # To build and return an query expression to execute later, use Fauna::Query.expr
   #
-  #   Fauna::Query.expr { create(ref('classes', 'spells'), { data: { name: 'Magic Missile' } }) }
+  #   Fauna::Query.expr { create(class_('spells'), { data: { name: 'Magic Missile' } }) }
   #
   # Or, you may directly use the helper methods:
   #
-  #   Fauna::Query.create(Fauna::Query.ref('classes', 'spells'), { data: { name: 'Magic Missile' } })
+  #   Fauna::Query.create(Fauna::Query.class_('spells'), { data: { name: 'Magic Missile' } })
   module Query
-    extend self
+    extend self, Deprecate
 
     class QueryDSLContext < DSLContext # :nodoc:
       include Query
@@ -45,12 +45,20 @@ module Fauna
     # Reference: {FaunaDB Values}[https://fauna.com/documentation/queries#values]
     def ref(str, id = nil)
       if id.nil?
-        Ref.new(str)
+        Expr.new :@ref => Expr.wrap(str)
       else
         Expr.new ref: Expr.wrap(str), id: Expr.wrap(id)
       end
     end
 
+    ##
+    # An abort expression
+    #
+    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
+    def abort(msg)
+      Expr.new abort: Expr.wrap(msg)
+    end
+
     ##
     # An object expression
     #
@@ -383,6 +391,22 @@ module Fauna
 
     # :section: Set Functions
 
+    ##
+    # A singleton expression
+    #
+    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
+    def singleton(ref)
+      Expr.new singleton: Expr.wrap(ref)
+    end
+
+    ##
+    # An events expression
+    #
+    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
+    def events(ref_set)
+      Expr.new events: Expr.wrap(ref_set)
+    end
+
     ##
     # A match expression
     #
@@ -460,6 +484,22 @@ module Fauna
       Expr.new identify: Expr.wrap(ref), password: Expr.wrap(password)
     end
 
+    ##
+    # An identity function
+    #
+    # Reference: {FaunaDB Authentication}[https://fauna.com/documentation/queries#auth_functions]
+    def identity
+      Expr.new identity: nil
+    end
+
+    ##
+    # A has_identity function
+    #
+    # Reference: {FaunaDB Authentication}[https://fauna.com/documentation/queries#auth_functions]
+    def has_identity
+      Expr.new has_identity: nil
+    end
+
     # :section: String Functions
 
     ##
@@ -478,8 +518,12 @@ module Fauna
     # A casefold function
     #
     # Reference: {FaunaDB String Functions}[https://fauna.com/documentation/queries#string_functions]
-    def casefold(string)
-      Expr.new casefold: Expr.wrap(string)
+    def casefold(string, normalizer = nil)
+      if normalizer.nil?
+        Expr.new casefold: Expr.wrap(string)
+      else
+        Expr.new casefold: Expr.wrap(string), normalizer: Expr.wrap(normalizer)
+      end
     end
 
     # :section: Time and Date Functions
@@ -518,36 +562,110 @@ module Fauna
       Expr.new next_id: nil
     end
 
+    deprecate :next_id, :new_id
+
+    ##
+    # A new_id function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def new_id
+      Expr.new new_id: nil
+    end
+
     ##
     # A database function
     #
     # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
-    def database(name)
-      Expr.new database: Expr.wrap(name)
+    def database(name, scope = nil)
+      return Expr.new database: Expr.wrap(name) if scope.nil?
+
+      Expr.new database: Expr.wrap(name), scope: Expr.wrap(scope)
     end
 
     ##
     # A class function
     #
     # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
-    def class_(name)
-      Expr.new class: Expr.wrap(name)
+    def class_(name, scope = nil)
+      return Expr.new class: Expr.wrap(name) if scope.nil?
+
+      Expr.new class: Expr.wrap(name), scope: Expr.wrap(scope)
     end
 
     ##
     # An index function
     #
     # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
-    def index(name)
-      Expr.new index: Expr.wrap(name)
+    def index(name, scope = nil)
+      return Expr.new index: Expr.wrap(name) if scope.nil?
+
+      Expr.new index: Expr.wrap(name), scope: Expr.wrap(scope)
     end
 
     ##
     # A function function
     #
     # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
-    def function(name)
-      Expr.new function: Expr.wrap(name)
+    def function(name, scope = nil)
+      return Expr.new function: Expr.wrap(name) if scope.nil?
+
+      Expr.new function: Expr.wrap(name), scope: Expr.wrap(scope)
+    end
+
+    ##
+    # A databases function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def databases(scope = nil)
+      Expr.new databases: Expr.wrap(scope)
+    end
+
+    ##
+    # A classes function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def classes(scope = nil)
+      Expr.new classes: Expr.wrap(scope)
+    end
+
+    ##
+    # An indexes function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def indexes(scope = nil)
+      Expr.new indexes: Expr.wrap(scope)
+    end
+
+    ##
+    # A functions function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def functions(scope = nil)
+      Expr.new functions: Expr.wrap(scope)
+    end
+
+    ##
+    # A tokens function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def tokens(scope = nil)
+      Expr.new tokens: Expr.wrap(scope)
+    end
+
+    ##
+    # A keys function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def keys(scope = nil)
+      Expr.new keys: Expr.wrap(scope)
+    end
+
+    ##
+    # A credentials function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def credentials(scope = nil)
+      Expr.new credentials: Expr.wrap(scope)
     end
 
     ##
@@ -574,6 +692,14 @@ module Fauna
       Expr.new Expr.wrap_values(params).merge(select: Expr.wrap(path), from: Expr.wrap(from))
     end
 
+    ##
+    # A select_all function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
+    def select_all(path, from)
+      Expr.new select_all: Expr.wrap(path), from: Expr.wrap(from)
+    end
+
     ##
     # An add function
     #