arangorb 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f10d19137d9ad901edf1f2a821b71e7f7da9f34
-  data.tar.gz: 3745c2e90ed3e1496a95d2ad0bf7ea28b7fba953
+  metadata.gz: 9682380a2dafba5778de976c70914176d480a738
+  data.tar.gz: 45635e45b4586a361b2bad070d0e74e33bd5460f
 SHA512:
-  metadata.gz: cebecdfe93d39841f2447f96407c027901b0d087b8208cafd203608afd6f743b8fe800b9289f4ec13c4555cf8db83593e778777a453e9b252d9a929690d18f05
-  data.tar.gz: ade043fc9e624d7255e169c577648b36f0a2bbdcc5cf1b17f9f3b3564ecedaeb1fde7660a396967b7f6940626e3b068688a01038ee0d48dae4b66568ae947205
+  metadata.gz: 41e041b73e5f7cabb3a50308efd1d759a3e2304f61ae9e8bbea0e79dcdaf614263e6dc518fb7e2a8608f3f946f023d4d19da9d41ae196f48d04ca91b05df8632
+  data.tar.gz: 3f4a43a9ef26271c7971642e6b582d5638cbcc639ffb9576bcb67438537cb279e6fae9743d37e9ee838b85ba2413d1d9d39a71dc3d27ef03729674bb065ad66a

data/ArangoRB.gemspec

@@ -4,7 +4,7 @@ require "rake"
 
 Gem::Specification.new do |s|
   s.name        = 'arangorb'
-  s.version	    = '2.0.0'
+  s.version	    = '2.0.1'
   s.authors     = ['Stefano Martin']
   s.email       = ['stefano@seluxit.com']
   s.homepage    = 'https://github.com/StefanoMartin/ArangoRB'

data/README.md

@@ -2,7 +2,7 @@ ArangoRB [![Gem Version](https://badge.fury.io/rb/arangorb.svg)](https://badge.f
 ===============================
 
 [ArangoDatabase](https://www.arangodb.com/) is a native multi-model database with flexible data models for document, graphs, and key-values.
-ArangoRB is a Gem to use ArangoDatabase with Ruby. ArangoRB is based on the [HTTP API of ArangoDB](https://docs.arangodb.com/3.0/HTTP/index.html).
+ArangoRB is a Gem to use ArangoDatabase with Ruby. ArangoRB is based on the [HTTP API of ArangoDB](https://docs.arangodb.com/3.4/HTTP/index.html).
 
 ArangoRB 0.1.0 - 1.3.0 have been tested with ArangoDB 3.0  with Ruby 2.3.1</br>
 ArangoRB 1.4.0 has been tested with ArangoDB 3.1 with Ruby 2.3.3</br>
@@ -14,34 +14,23 @@ To install ArangoRB: `gem install arangorb`
 
 To use it in your application: `require "arangorb"`
 
-## Differences between version 1.4 and 2.0
-
-ArangoRB 1.4 and ArangoRB 2.0 are not compatible.
-The new version provide different improvements.
-* Now all the instances are in a module Arango. This means that previous classes like Arango::Server will become Arango::Server.
-* Arango::Server is now an instance. This means that ArangoRB 2.0 will permits to use different servers.
-* ArangoRB has implemented connection_pool
-* ArangoRB has now a better implementation of Cache
-* The returned values are returned with symbols as keys
-* Oj is used for parsing instead of JSON
-* Add supports for View and Foxx. The least is untested.
-* Better hierarchy handling between the different instances. For example now myDocument.database will return the database instance that includes the document.
-* Better handling of replication (untested)
-* Clean in general the code (for future easier maintance)
-* Now errors are handled by Arango::Error
-
 ## Support
 
 This is a project managed by one single person. ArangoDB is a wonderful project that it is hard to cover completely alone. For this reason all your supports is more than welcome.
 Any pull request, issue, suggestions and ideas are more than welcome. Do not be shy to contact me, create issues on Github or pushing changes.
 
 Here something the community can help on:
+* Replication example in example/replication_year.rb is a work in progress. Any found bugs and advice to improve it will be great. I removed the IPs in the examples to make clear that it is only an example that needs work.
 * Add test and correct bugs for replication, clustering, foxx and other.
 * Improve AQL instance to implement in Rails.
 * Improve Documentation.
 
 If you like this project, please star it. It will remind me that my work has been useful for somebody.  
 
+For the differences between version 1.4.0 and 2.0.0: [Click here](#differences).
+
+For testing: [Click here](#testing).
+
 ## Classes used
 
 ArangoRB has the two type of classes.
@@ -84,11 +73,12 @@ To setup a server use the following way:
 
 ``` ruby
 server = Arango::Server.new username: "MyUsername", password: "MyPassword",
-  server: "localhost", port: "8529"
+  server: "localhost", port: "8529", tls: false
 server.username = "MyOtherUsername" # Default "root"
 server.password = "other_password"  
 server.server   = "127.0.0.1"       # Default "localhost"
 server.port     = "8765"            # Default "8529"
+server.tls      = true   # Default false, to do https requests instead of http
 ```
 
 Password is a mandatory field.
@@ -124,7 +114,7 @@ ArangoRB supports connection pool, to activate it you can setup pool to true dur
 
 ``` ruby
 server = Arango::Server.new username: "MyUsername", password: "MyPassword",
-  server: "localhost", port: "8529", pool: true, size: 5, timeout: 5
+  server: "localhost", port: "8529", pool: true, size: 5, timeout: 5, tls: false
 server.pool = true  # Defult false
 server.size = 7     # Default 5
 server.timeout = 10 # Default 5
@@ -677,7 +667,8 @@ myGraph.replaceEdgeCollections collection: "myEdgeCollection", from: "myCollecti
 myGraph.removeEdgeCollections collection: "myEdgeCollection"  # Remove an Edge Collection to our Graph
 ```
 
-<a name="ArangoVertex"></a><a name="ArangoEdge"></a>
+<a name="ArangoVertex"></a>
+<a name="ArangoEdge"></a>
 ## Arango::Vertex and Arango::Edge
 
 Both these two classes inherit the class Arango::Document.
@@ -1077,3 +1068,35 @@ rescue Arango::Error => e
   e.to_h     # Hash version of the error
 end
 ```
+
+<a name="testing"></a>
+## Testing
+
+To test ArangoRB you can use:
+
+``` ruby
+rspec spec/arangoRB_helper.rb
+ruby examples/year.rb
+ruby examples/year2.rb
+```
+
+Remember however the following:
+* Setup the correct server in lib/spec_helper.rb and in the examples
+* The test examples/year2.rb should run much after the test examples/year.rb, since the last test is dependent from the conclusion of the first test (that is running in async).
+
+<a name="differences"></a>
+## Differences between version 1.4 and 2.0
+
+ArangoRB 1.4 and ArangoRB 2.0 are not compatible.
+The new version provide different improvements.
+* Now all the instances are in a module Arango. This means that previous classes like ArangoServer will become Arango::Server.
+* Arango::Server is now an instance. This means that ArangoRB 2.0 will permits to use different servers.
+* ArangoRB has implemented connection_pool.
+* ArangoRB has now a better implementation of Cache.
+* The returned values are returned with symbols as keys.
+* Oj is used for parsing instead of JSON.
+* Add supports for View and Foxx. The least is untested.
+* Better hierarchy handling between the different instances. For example now myDocument.database will return the database instance that includes the document.
+* Better handling of replication (untested).
+* Clean in general the code (for future maintainer).
+* Now errors are handled by Arango::Error.

data/lib/Replication.rb

@@ -2,6 +2,8 @@
 
 module Arango
   class Replication
+    include Arango::Helper_Error
+
     def initialize(master:, slave:, includeSystem: true,
       initialSyncMaxWaitTime: nil, incremental: nil,
       restrictCollections: nil, connectTimeout: nil,
@@ -54,7 +56,7 @@ module Arango
 
     def restrictType=(restrictType)
       satisfy_category?(restrictType, ["include", "exclude", nil])
-      @restrictType = value
+      @restrictType = restrictType
     end
     alias assign_restrictType restrictType=
 
@@ -200,7 +202,7 @@ module Arango
       }
       @slave.request("PUT", "_api/replication/applier-config", body: body)
     end
-    alias modifyReplication modifyConfigurationReplication
+    alias modifyReplication modify
 
     # LOGGER
 

data/lib/Server.rb

@@ -5,8 +5,13 @@ module Arango
     include Arango::Helper_Error
 
     def initialize(username: "root", password:, server: "localhost",
-      warning: true, port: "8529", verbose: false, return_output: false, async: false, active_cache: false, pool: false, size: 5, timeout: 5)
-      @base_uri = "http://#{server}:#{port}"
+      warning: true, port: "8529", verbose: false, return_output: false,
+      async: false, active_cache: false, pool: false, size: 5, timeout: 5,
+      tls: false)
+      @tls = tls
+      @base_uri = "http"
+      @base_uri += "s" if tls
+      @base_uri += "://#{server}:#{port}"
       @server = server
       @port = port
       @username = username
@@ -32,7 +37,7 @@ module Arango
 # === DEFINE ===
 
     attr_reader :async, :port, :server, :base_uri, :username, :cache,
-      :verbose, :return_output, :active_cache, :pool
+      :verbose, :return_output, :active_cache, :pool, :password, :tls
     attr_accessor :warning, :size, :timeout
 
     def active_cache=(active)
@@ -89,13 +94,26 @@ module Arango
 
     def port=(port)
       @port = port
-      @base_uri = "http://#{@server}:#{@port}"
+      @base_uri = "http"
+      @base_uri += "s" if @tls
+      @base_uri += "://#{@server}:#{@port}"
       @request.base_uri = @base_uri
     end
 
     def server=(server)
       @server = server
-      @base_uri = "http://#{@server}:#{@port}"
+      @base_uri = "http"
+      @base_uri += "s" if @tls
+      @base_uri += "://#{@server}:#{@port}"
+      @request.base_uri = @base_uri
+    end
+
+    def tls=(tls)
+      satisfy_category?(tls, [false, true])
+      @tls = tls
+      @base_uri = "http"
+      @base_uri += "s" if @tls
+      @base_uri += "://#{@server}:#{@port}"
       @request.base_uri = @base_uri
     end
 
@@ -128,8 +146,10 @@ module Arango
         "async":    @async,
         "verbose":  @verbose,
         "return_output": @return_output,
-        "warning": @warning
+        "warning": @warning,
+        "tls": @tls
       }.delete_if{|k,v| v.nil?}
+      hash
     end
 
 # === REQUESTS ===

data/lib/arangorb.rb

@@ -7,6 +7,7 @@ require_relative "AQL"
 require_relative "Batch"
 require_relative "Server"
 require_relative "Collection"
+require_relative "Replication"
 require_relative "Database"
 require_relative "Document"
 require_relative "Edge"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arangorb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Stefano Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2019-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty