fauna 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79e3f29b34209d1fd34ebfb3a878fe2210cc6a34
-  data.tar.gz: eb8887d649b435f9e1064717c04232ace5af76d2
+  metadata.gz: d8996ca66ac2a5d3c0eb4d33251e3148e4a1e4de
+  data.tar.gz: 4b29fdaad2dc9b4a6f704bd5e6df7111abf25b0a
 SHA512:
-  metadata.gz: 9b23b487d4202f26858139562129d66132cfdc0d313067381acd077504a80bee7b74b22e084dc0cc4b4564857ad8ff90c9145dc3f58e7b9c79432ba458e0468f
-  data.tar.gz: 0ae0ecc0c29346e8aeb64228c67e9ca8f059de588c9acaa3de2b4cd165ab9228ef5dd8aaf5276263b1bc5ff98400c27ecf11357951a21e21888221a1841036d3
+  metadata.gz: fa414baf0fff3c8a3e07c14fb7ec3ce000bbb4d306be7b1286be7c9495281584398d34b71505a4bc6d58ad34ebf8620f521bdc415c7822992be35f9018304045
+  data.tar.gz: e40f66fc8c23f1fb10d5e918e4788142503a017e76c74c444768c7b0efc7a2d3b6b76f729b3583d5f740c4531f782f890b21243f7402f8e58c4bfda9ae151be9

data/CHANGELOG

@@ -1,3 +1,8 @@
+2.3.0
+* Change default domain to `db.fauna.com`.
+* Added `key_from_secret` and `at` query functions.
+* Added support for `@bytes` type (via `Fauna::Bytes`).
+
 2.2.0
 * Added `create_class`, `create_index`, `create_database`, `create_key`, `database`, `class`,
   and `index` query functions.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Fauna, Inc.
+Copyright 2017 Fauna, Inc.
 
 Licensed under the Mozilla Public License, Version 2.0 (the "License"); you may
 not use this software except in compliance with the License. You may obtain a 

data/README.md

@@ -1,9 +1,9 @@
 # FaunaDB
 
-[![Build Status](https://img.shields.io/travis/faunadb/faunadb-ruby/master.svg?maxAge=21600)](https://travis-ci.org/faunadb/faunadb-ruby)
-[![Coverage Status](https://img.shields.io/codecov/c/github/faunadb/faunadb-ruby/master.svg?maxAge=21600)](https://codecov.io/gh/faunadb/faunadb-ruby/branch/master)
+[![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/faunadb/faunadb-ruby/master/LICENSE)
+[![License](https://img.shields.io/badge/license-MPL_2.0-blue.svg?maxAge=2592000)](https://raw.githubusercontent.com/fauna/faunadb-ruby/master/LICENSE)
 
 Ruby driver for [FaunaDB](https://fauna.com).
 
@@ -23,11 +23,11 @@ And then execute:
 
 ## Documentation
 
-The driver documentation is [hosted on GitHub Pages](https://faunadb.github.io/faunadb-ruby/).
+The driver documentation is [hosted on GitHub Pages](https://fauna.github.io/faunadb-ruby/).
 
 Please see the [FaunaDB Documentation](https://fauna.com/documentation) for
 a complete API reference, or look in
-[`/test`](https://github.com/faunadb/faunadb-ruby/tree/master/test) for more
+[`/test`](https://github.com/fauna/faunadb-ruby/tree/master/test) for more
 examples.
 
 ## Compatibility
@@ -130,7 +130,7 @@ GitHub pull requests are very welcome.
 
 ## LICENSE
 
-Copyright 2016 [Fauna, Inc.](https://fauna.com/)
+Copyright 2017 [Fauna, Inc.](https://fauna.com/)
 
 Licensed under the Mozilla Public License, Version 2.0 (the
 "License"); you may not use this software except in compliance with

data/fauna.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.email = 'priority@fauna.com'
   s.summary = 'FaunaDB Ruby driver'
   s.description = 'Ruby driver for FaunaDB.'
-  s.homepage = 'https://github.com/faunadb/faunadb-ruby'
+  s.homepage = 'https://github.com/fauna/faunadb-ruby'
   s.license = 'MPL-2.0'
 
   s.files = %w(CHANGELOG Gemfile LICENSE README.md Rakefile fauna.gemspec lib/fauna.rb) + Dir.glob('lib/fauna/**') + Dir.glob('spec/**')

data/lib/fauna.rb

@@ -5,6 +5,7 @@ require 'faraday'
 require 'cgi'
 require 'zlib'
 require 'time'
+require 'base64'
 
 ##
 # Main namespace for the FaunaDB driver.

data/lib/fauna/client.rb

@@ -40,7 +40,7 @@ module Fauna
     #            +:observer+:: Callback that will be passed a RequestResult after every completed request.
     #            +:adapter+:: Faraday[https://github.com/lostisland/faraday] adapter to use. Either can be a symbol for the adapter, or an array of arguments.
     def initialize(params = {})
-      @domain = params[:domain] || 'cloud.faunadb.com'
+      @domain = params[:domain] || 'db.fauna.com'
       @scheme = params[:scheme] || 'https'
       @port = params[:port] || (scheme == 'https' ? 443 : 80)
       @read_timeout = params[:read_timeout] || 60

data/lib/fauna/json.rb

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

data/lib/fauna/objects.rb

@@ -2,7 +2,7 @@ module Fauna
   ##
   # A Ref.
   #
-  # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries-values-special_types]
+  # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries#values-special_types]
   class Ref
     # The raw ref string.
     attr_accessor :value
@@ -63,7 +63,7 @@ module Fauna
   ##
   # A SetRef.
   #
-  # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries-values-special_types]
+  # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries#values-special_types]
   class SetRef
     # The raw set hash.
     attr_accessor :value
@@ -73,7 +73,7 @@ module Fauna
     #
     # +params+:: Hash of parameters to build the SetRef with.
     #
-    # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries-values-special_types]
+    # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries#values-special_types]
     def initialize(params = {})
       self.value = params
     end
@@ -91,4 +91,41 @@ module Fauna
 
     alias_method :eql?, :==
   end
+
+  ##
+  # A Bytes wrapper.
+  #
+  # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries#values-special_types]
+  class Bytes
+    # The raw bytes.
+    attr_accessor :bytes
+
+    ##
+    # Creates a new Bytes wrapper with the given parameters.
+    #
+    # +bytes+:: The bytes to be wrapped by the Bytes object.
+    #
+    # Reference: {FaunaDB Special Types}[https://fauna.com/documentation/queries#values-special_types]
+    def initialize(bytes)
+      self.bytes = bytes
+    end
+
+    # Converts the Bytes to Hash form.
+    def to_hash
+      { :@bytes => Base64.urlsafe_encode64(bytes) }
+    end
+
+    # Returns +true+ if +other+ is a Bytes and contains the same bytes.
+    def ==(other)
+      return false unless other.is_a? Bytes
+      bytes == other.bytes
+    end
+
+    alias_method :eql?, :==
+
+    # Create new Bytes object from Base64 encoded bytes.
+    def self.from_base64(enc)
+      new(Base64.urlsafe_decode64(enc))
+    end
+  end
 end

data/lib/fauna/page.rb

@@ -16,24 +16,24 @@ module Fauna
   #
   # Paging over a class index
   #
-  #   page = Page.new(client, Query.match(Ref('indexes/items')))
+  #   page = Page.new(client, Query.match(Ref.new('indexes/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('indexes/items')), size: 5) do |ref|
+  #   page = Page.new(client, Query.match(Ref.new('indexes/items')), size: 5) do |ref|
   #     select ['data', 'value'], get(ref)
   #   end
   #
   #   # Same thing, but using builders instead
   #
-  #   page = Page.new(client, Query.match(Ref('indexes/items'))).with_params(size: 5).map do |ref|
+  #   page = Page.new(client, Query.match(Ref.new('indexes/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('indexes/items'))).map do |ref|
+  #   page = Page.new(client, Query.match(Ref.new('indexes/items'))).map do |ref|
   #     select ['data', 'value'], get(ref)
   #   end.filter do |value|
   #     equals modulo(value, 2), 0

data/lib/fauna/query.rb

@@ -66,6 +66,14 @@ module Fauna
 
     # :section: Basic forms
 
+    ##
+    # An at expression
+    #
+    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
+    def at(timestamp, expr)
+      Expr.new at: Expr.wrap(timestamp), expr: Expr.wrap(expr)
+    end
+
     ##
     # A let expression
     #
@@ -243,6 +251,14 @@ module Fauna
       Expr.new Expr.wrap_values(params).merge(get: Expr.wrap(ref))
     end
 
+    ##
+    # A key_from_secret expression
+    #
+    # Reference: {FaunaDB Read functions}[https://fauna.com/documentation/queries#read_functions]
+    def key_from_secret(secret)
+      Expr.new key_from_secret: Expr.wrap(secret)
+    end
+
     ##
     # A paginate expression
     #

data/lib/fauna/version.rb

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

data/spec/bytes_spec.rb

@@ -0,0 +1,36 @@
+RSpec.describe Fauna::Bytes do
+  describe '#initalize' do
+    it 'creates from bytes' do
+      raw = random_bytes
+      expect(Fauna::Bytes.new(raw).bytes).to eq(raw)
+    end
+  end
+
+  describe '#from_base64' do
+    it 'creates from base64' do
+      raw = random_bytes
+      encoded = Base64.urlsafe_encode64(raw)
+
+      expect(Fauna::Bytes.from_base64(encoded).bytes).to eq(raw)
+    end
+  end
+
+  describe '#==' do
+    it 'equals same bytes' do
+      raw = random_bytes
+      bytes = Fauna::Bytes.new(raw)
+
+      expect(bytes).to eq(Fauna::Bytes.new(raw))
+    end
+
+    it 'does not equal different bytes' do
+      expect(Fauna::Bytes.new(random_bytes)).not_to eq(Fauna::Bytes.new(random_bytes))
+    end
+
+    it 'does not equal other type' do
+      raw = random_bytes
+
+      expect(Fauna::Bytes.new(raw)).not_to eq(raw)
+    end
+  end
+end

data/spec/fauna_helper.rb

@@ -73,6 +73,10 @@ module FaunaTestHelpers
     SecureRandom.random_number(1_000_000)
   end
 
+  def random_bytes
+    SecureRandom.random_bytes(20)
+  end
+
   def random_ref_string
     "classes/#{random_string}/#{random_number}"
   end

data/spec/json_spec.rb

@@ -40,6 +40,15 @@ RSpec.describe Fauna::FaunaJson do
       expect(Fauna::FaunaJson.deserialize(data)).to eq(obj)
     end
 
+    it 'deserializes bytes' do
+      raw = random_bytes
+
+      data = { :@bytes => Base64.urlsafe_encode64(raw) }
+      obj = Fauna::Bytes.new(raw)
+
+      expect(Fauna::FaunaJson.deserialize(data)).to eq(obj)
+    end
+
     it 'recursively deserializes hashes' do
       ref = random_ref_string
 
@@ -100,6 +109,15 @@ RSpec.describe Fauna::FaunaJson do
       expect(Fauna::FaunaJson.serialize(obj)).to eq(data)
     end
 
+    it 'serializes bytes' do
+      raw = random_bytes
+
+      data = { :@bytes => Base64.urlsafe_encode64(raw) }
+      obj = Fauna::Bytes.new(raw)
+
+      expect(Fauna::FaunaJson.serialize(obj)).to eq(data)
+    end
+
     it 'recursively serializes hashes' do
       ref = random_ref_string
       terms = random_string

data/spec/query_spec.rb

@@ -123,6 +123,20 @@ RSpec.describe Fauna::Query do
     end
   end
 
+  describe '#at' do
+    it 'performs at for given expression' do
+      instance = create_instance
+      ref = instance[:ref]
+      ts = instance[:ts]
+
+      prev_ts = ts - 1
+      value = random_number
+      client.query { insert(ref, prev_ts, :create, data: { x: value }) }
+
+      expect(client.query { at(prev_ts, get(ref)) }[:data]).to eq(x: value)
+    end
+  end
+
   describe '#let' do
     it 'performs let with expression' do
       x = random_number
@@ -284,6 +298,16 @@ RSpec.describe Fauna::Query do
     end
   end
 
+  describe '#key_from_secret' do
+    it 'gets key from secret' do
+      # Create a key
+      db_ref = admin_client.query { create(ref('databases'), name: random_string) }[:ref]
+      key = admin_client.query { create_key(database: db_ref, role: 'server') }
+
+      expect(admin_client.query { key_from_secret key[:secret] }).to eq(admin_client.query { get key[:ref] })
+    end
+  end
+
   describe '#paginate' do
     before do
       @x_value = random_number

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fauna
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Fauna, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -121,6 +121,7 @@ files:
 - lib/fauna/request_result.rb
 - lib/fauna/util.rb
 - lib/fauna/version.rb
+- spec/bytes_spec.rb
 - spec/client_logger_spec.rb
 - spec/client_spec.rb
 - spec/context_spec.rb
@@ -133,7 +134,7 @@ files:
 - spec/setref_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
-homepage: https://github.com/faunadb/faunadb-ruby
+homepage: https://github.com/fauna/faunadb-ruby
 licenses:
 - MPL-2.0
 metadata: {}
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: FaunaDB Ruby driver
@@ -173,5 +174,6 @@ test_files:
 - spec/errors_spec.rb
 - spec/setref_spec.rb
 - spec/ref_spec.rb
+- spec/bytes_spec.rb
 - spec/spec_helper.rb
 - spec/json_spec.rb