fauna 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8996ca66ac2a5d3c0eb4d33251e3148e4a1e4de
-  data.tar.gz: 4b29fdaad2dc9b4a6f704bd5e6df7111abf25b0a
+  metadata.gz: aeba4b71fb3aa58412e5f78514faa422f3d71eab
+  data.tar.gz: 0a53bd599a46461131c1c552b7ef6e1893833cd0
 SHA512:
-  metadata.gz: fa414baf0fff3c8a3e07c14fb7ec3ce000bbb4d306be7b1286be7c9495281584398d34b71505a4bc6d58ad34ebf8620f521bdc415c7822992be35f9018304045
-  data.tar.gz: e40f66fc8c23f1fb10d5e918e4788142503a017e76c74c444768c7b0efc7a2d3b6b76f729b3583d5f740c4531f782f890b21243f7402f8e58c4bfda9ae151be9
+  metadata.gz: 5f4b77c6451c409b30135a918ddacd7bc6751658d9ddb4c38733b8503032be6c148a0cf9e78b105259e444150b68a0a0054b909fac48ce977c2386136afaf9d4
+  data.tar.gz: 524c60bcada18bc69e7411cac1fbc17afc58624aaa448763bf38f467b43edd4063f5a5d0eed6b0c9ba834fb4f5bb3d452725dbd4e83c300489cf49ad45182317

data/CHANGELOG

@@ -1,3 +1,9 @@
+2.4.0
+* Handle HTTP errors 502 and 504 as `Fauna::UnavailableError`.
+* Added support for user-defined functions.
+* Added support for the `@query` type (via `Fauna::QueryV`).
+* Added `create_function`, `function`, and `call` query functions.
+
 2.3.0
 * Change default domain to `db.fauna.com`.
 * Added `key_from_secret` and `at` query functions.

data/lib/fauna/client.rb

@@ -215,9 +215,7 @@ module Fauna
         end_time = Time.now
 
         message = e.class.name
-        unless e.message.nil?
-          message += ": #{e.message}"
-        end
+        message += ": #{e.message}" unless e.message.nil?
 
         request_result = RequestResult.new(self,
             action, path, query, data,
@@ -238,10 +236,6 @@ module Fauna
 
       @observer.call(request_result) unless @observer.nil?
 
-      if response_json.nil? && response.status != 503
-        fail UnexpectedError.new('Invalid JSON.', request_result)
-      end
-
       FaunaError.raise_for_status_code(request_result)
       UnexpectedError.get_or_raise request_result, response_content, :resource
     end

data/lib/fauna/errors.rb

@@ -48,8 +48,12 @@ module Fauna
         fail MethodNotAllowed.new(request_result)
       when 500
         fail InternalError.new(request_result)
+      when 502
+        fail UnavailableError.new(request_result)
       when 503
         fail UnavailableError.new(request_result)
+      when 504
+        fail UnavailableError.new(request_result)
       else
         fail UnexpectedError.new('Unexpected status code.', request_result)
       end
@@ -63,6 +67,10 @@ module Fauna
         @request_result = request_result
 
         begin
+          if request_result.response_content.nil?
+            fail UnexpectedError.new('Invalid JSON.', request_result)
+          end
+
           errors_raw = UnexpectedError.get_or_raise request_result, request_result.response_content, :errors
           @errors = catch :invalid_response do
             throw :invalid_response unless errors_raw.is_a? Array
@@ -89,7 +97,7 @@ module Fauna
             msg
           end.join(' ')
         rescue UnexpectedError => e
-          if request_result.status_code != 503
+          unless self.is_a?(UnavailableError) && [502, 503, 504].include?(request_result.status_code)
             raise e
           end
 
@@ -126,8 +134,7 @@ module Fauna
   # failure within the database.
   class InternalError < FaunaError; end
 
-  ##
-  # An exception thrown if FaunaDB responds with an HTTP 503.
+  # An exception thrown if FaunaDB responds with an HTTP 502, 503, or 504.
   class UnavailableError < FaunaError; end
 
   # Data for one error returned by the server.

data/lib/fauna/json.rb

@@ -22,6 +22,8 @@ module Fauna
           Date.iso8601 obj[:@date]
         elsif obj.key? :@bytes
           Bytes.from_base64 obj[:@bytes]
+        elsif obj.key? :@query
+          QueryV.new deserialize(obj[:@query])
         else
           Hash[obj.collect { |k, v| [k, deserialize(v)] }]
         end

data/lib/fauna/objects.rb

@@ -128,4 +128,36 @@ module Fauna
       new(Base64.urlsafe_decode64(enc))
     end
   end
+
+  ##
+  # A QueryV.
+  #
+  # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries-values-special_types]
+  class QueryV
+    # The raw query hash.
+    attr_accessor :value
+
+    ##
+    # Creates a new QueryV with the given parameters.
+    #
+    # +params+:: Hash of parameters to build the QueryV with.
+    #
+    # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries-values-special_types]
+    def initialize(params = {})
+      self.value = params
+    end
+
+    # Converts the QueryV to Hash form.
+    def to_hash
+      { :@query => value }
+    end
+
+    # Returns +true+ if +other+ is a QueryV and contains the same value.
+    def ==(other)
+      return false unless other.is_a? QueryV
+      value == other.value
+    end
+
+    alias_method :eql?, :==
+  end
 end

data/lib/fauna/query.rb

@@ -64,6 +64,14 @@ module Fauna
       Expr.new object: Expr.wrap_values(fields)
     end
 
+    ##
+    # A query expression
+    #
+    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
+    def query(expr)
+      Expr.new query: Expr.wrap(expr)
+    end
+
     # :section: Basic forms
 
     ##
@@ -174,6 +182,14 @@ module Fauna
       Expr.new lambda: Expr.wrap(var), expr: Expr.wrap(expr)
     end
 
+    ##
+    # A call expression
+    #
+    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
+    def call(name, *args)
+      Expr.new call: Expr.wrap(name), arguments: Expr.wrap_varargs(args)
+    end
+
     # :section: Collection Functions
 
     ##
@@ -357,6 +373,14 @@ module Fauna
       Expr.new create_key: Expr.wrap(params)
     end
 
+    ##
+    # A create function expression
+    #
+    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
+    def create_function(params)
+      Expr.new create_function: Expr.wrap(params)
+    end
+
     # :section: Set Functions
 
     ##
@@ -518,6 +542,14 @@ module Fauna
       Expr.new index: Expr.wrap(name)
     end
 
+    ##
+    # A function function
+    #
+    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
+    def function(name)
+      Expr.new function: Expr.wrap(name)
+    end
+
     ##
     # An equals function
     #

data/lib/fauna/version.rb

@@ -1,4 +1,4 @@
 module Fauna
   # The version of the Fauna gem
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/spec/errors_spec.rb

@@ -128,11 +128,26 @@ RSpec.describe 'Fauna Errors' do
       expect { stub_client.get '' }.to raise_fauna_error(Fauna::UnavailableError, 'unavailable')
     end
 
+    it 'handles upstream 502' do
+      stub_client = stub_get 502, 'Bad gateway'
+      expect { stub_client.get '' }.to raise_error(Fauna::UnavailableError, 'Bad gateway')
+    end
+
     it 'handles upstream 503' do
       stub_client = stub_get 503, 'Unable to reach server'
       expect { stub_client.get '' }.to raise_error(Fauna::UnavailableError, 'Unable to reach server')
     end
 
+    it 'handles upstream 504' do
+      stub_client = stub_get 504, 'Server timeout'
+      expect { stub_client.get '' }.to raise_error(Fauna::UnavailableError, 'Server timeout')
+    end
+
+    it 'handles upstream json 503' do
+      stub_client = stub_get 503, '{ "error" : "service unavailable" }'
+      expect { stub_client.get '' }.to raise_error(Fauna::UnavailableError, '{ "error" : "service unavailable" }')
+    end
+
     it 'handles timeout error' do
       stub_client = stub_error Faraday::TimeoutError.new('timeout')
       expect { stub_client.get '' }.to raise_error(Fauna::UnavailableError, 'Faraday::TimeoutError: timeout')

data/spec/json_spec.rb

@@ -19,6 +19,13 @@ RSpec.describe Fauna::FaunaJson do
       expect(Fauna::FaunaJson.deserialize(data)).to eq(obj)
     end
 
+    it 'deserializes query' do
+      query = { lambda: 'a', expr: { add: [{ var: 'a' }, 1] } }
+      obj = Fauna::QueryV.new(query)
+
+      expect(Fauna::FaunaJson.deserialize(:@query => query)).to eq(obj)
+    end
+
     it 'deserializes obj' do
       obj = { a: random_string, b: random_string }
       data = { :@obj => obj }
@@ -88,6 +95,13 @@ RSpec.describe Fauna::FaunaJson do
       expect(Fauna::FaunaJson.serialize(obj)).to eq(data)
     end
 
+    it 'serializes query' do
+      query = { lambda: 'a', expr: { add: [{ var: 'a' }, 1] } }
+      obj = Fauna::QueryV.new(query)
+
+      expect(Fauna::FaunaJson.serialize(obj)).to eq(:@query => query)
+    end
+
     it 'serializes expr' do
       data = { a: random_string, b: random_number }
       obj = Fauna::Query::Expr.new(data)

data/spec/query_spec.rb

@@ -123,6 +123,13 @@ RSpec.describe Fauna::Query do
     end
   end
 
+  describe '#query' do
+    it 'wraps fields in query' do
+      data = Fauna::Query::Expr.new(lambda: random_string, expr: Fauna::Query::Expr.new(add: Fauna::Query::Expr.wrap([1, 1])))
+      expect(Fauna::Query.query(data).raw).to eq(query: data)
+    end
+  end
+
   describe '#at' do
     it 'performs at for given expression' do
       instance = create_instance
@@ -215,6 +222,38 @@ RSpec.describe Fauna::Query do
     end
   end
 
+  describe '#call' do
+    it 'performs called function' do
+      test_func = client.query do
+        func_body = lambda do |x|
+          [add(x, 1), add(x, 2), add(x, 3)]
+        end
+
+        create ref('functions'), name: 'call_func_test', body: query(func_body)
+      end
+
+      x = random_number
+
+      expect(client.query { call(test_func[:ref], x) }).to eq([x + 1, x + 2, x + 3])
+    end
+
+    it 'handles multiple arguments' do
+      test_func = client.query do
+        func_body = lambda do |x, y, z|
+          [multiply(x, 2), multiply(y, 3), multiply(z, 4)]
+        end
+
+        create ref('functions'), name: 'call_multiarg_test', body: query(func_body)
+      end
+
+      x = random_number
+      y = random_number
+      z = random_number
+
+      expect(client.query { call(test_func[:ref], x, y, z) }).to eq([x * 2, y * 3, z * 4])
+    end
+  end
+
   describe '#map' do
     it 'performs map from expression' do
       input = (1..3).collect { random_number }
@@ -458,6 +497,16 @@ RSpec.describe Fauna::Query do
     end
   end
 
+  describe '#create_function' do
+    it 'creates a function' do
+      # Create a function
+      ref = client.query { create_function(name: random_string, body: query(lambda { |a| add(a, 1) })) }[:ref]
+
+      # Assert it was created
+      expect(client.query { exists(ref) }).to be(true)
+    end
+  end
+
   describe 'sets' do
     before do
       @x_value = random_number
@@ -656,7 +705,7 @@ RSpec.describe Fauna::Query do
     end
   end
 
-  describe '#class' do
+  describe '#class_' do
     it 'gets an existing class' do
       # Create a class
       name = random_string
@@ -679,6 +728,17 @@ RSpec.describe Fauna::Query do
     end
   end
 
+  describe '#function' do
+    it 'gets an existing function' do
+      # Create a function
+      name = random_string
+      ref = client.query { create_function(name: name, body: query(lambda { |a| add(a, 1) })) }[:ref]
+
+      # Get the function ref
+      expect(client.query { function(name) }).to eq(ref)
+    end
+  end
+
   describe '#equals' do
     it 'performs equals' do
       expect(client.query { equals(1, 1, 1) }).to be(true)

data/spec/queryv_spec.rb

@@ -0,0 +1,25 @@
+RSpec.describe Fauna::QueryV do
+  describe '#==' do
+    it 'equals same query' do
+      lambda = Fauna::Query.expr { lambda_expr([:a], add(var(:a), var(:a))) }
+      query = Fauna::QueryV.new(lambda)
+
+      expect(query).to eq(Fauna::QueryV.new(lambda))
+    end
+
+    it 'does not equal different query' do
+      lambda = Fauna::Query.expr { lambda_expr([:a], add(var(:a), var(:a))) }
+      query = Fauna::QueryV.new(lambda)
+
+      other_lambda = Fauna::Query.expr { lambda_expr([:b], multiply(var(:b), var(:b))) }
+      expect(query).not_to eq(Fauna::QueryV.new(other_lambda))
+    end
+
+    it 'does not equal other type' do
+      lambda = Fauna::Query.expr { lambda_expr([:a], add(var(:a), var(:a))) }
+      query = Fauna::QueryV.new(lambda)
+
+      expect(query).not_to eq(lambda)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fauna
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Fauna, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +130,7 @@ files:
 - spec/json_spec.rb
 - spec/page_spec.rb
 - spec/query_spec.rb
+- spec/queryv_spec.rb
 - spec/ref_spec.rb
 - spec/setref_spec.rb
 - spec/spec_helper.rb
@@ -159,21 +160,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: FaunaDB Ruby driver
 test_files:
-- spec/util_spec.rb
+- spec/queryv_spec.rb
+- spec/client_spec.rb
+- spec/setref_spec.rb
+- spec/json_spec.rb
 - spec/context_spec.rb
 - spec/client_logger_spec.rb
 - spec/page_spec.rb
-- spec/query_spec.rb
-- spec/fauna_helper.rb
-- spec/client_spec.rb
-- spec/errors_spec.rb
-- spec/setref_spec.rb
+- spec/spec_helper.rb
+- spec/util_spec.rb
 - spec/ref_spec.rb
 - spec/bytes_spec.rb
-- spec/spec_helper.rb
-- spec/json_spec.rb
+- spec/errors_spec.rb
+- spec/query_spec.rb
+- spec/fauna_helper.rb