arango-driver 3.5.0.alpha0

data/lib/arango/user.rb

@@ -0,0 +1,174 @@
+# === USER ===
+
+module Arango
+  class User
+    include Arango::Helper::Satisfaction
+    include Arango::Helper::Return
+    include Arango::Helper::ServerAssignment
+
+    def initialize(server:, password: "", name:, extra: {}, active: nil, cache_name: nil)
+      assign_server(server)
+      unless cache_name.nil?
+        @cache_name = cache_name
+        @server.cache.save(:user, cache_name, self)
+      end
+      @password = password
+      @name     = name
+      @extra    = extra
+      @active   = active
+    end
+
+# === DEFINE ===
+
+    attr_accessor :name, :extra, :active
+    attr_reader :server, :body, :cache_name
+    attr_writer :password
+    alias user name
+    alias user= name=
+
+    def body=(result)
+      @body     = result
+      @password = result[:password] || @password
+      @name     = result[:user]   || @name
+      @extra    = result[:extra]  || @extra
+      @active   = result[:active].nil? ? @active : result[:active]
+      if @server.active_cache && @cache_name.nil?
+        @cache_name = @name
+        @server.cache.save(:user, @cache_name, self)
+      end
+    end
+    alias assign_attributes body=
+
+# === TO HASH ===
+
+    def to_h
+      {
+        active: @active,
+        cache_name: @cache_name,
+        extra: @extra,
+        server: @server.base_uri,
+        user: @name
+      }.delete_if{|k,v| v.nil?}
+    end
+
+    def [](database)
+      if self.databases[database.to_sym] == "rw"
+        Arango::Database.new name: database, server: @server
+      else
+        "This User does not have access to Database #{database}."
+      end
+    end
+    alias database []
+
+  # == USER ACTION ==
+
+    def create(password: @password, active: @active, extra: @extra)
+      body = {
+        user: @name,
+        passwd: password,
+        extra: extra,
+        active: active
+      }
+      result = @server.request("POST", "_api/user", body: body)
+      return_element(result)
+    end
+
+    def retrieve
+      result = @server.request("GET", "_api/user/#{@name}", body: body)
+      return_element(result)
+    end
+
+    def replace(password: @password, active: @active, extra: @extra)
+      body = {
+        passwd: password,
+        active: active,
+        extra: extra
+      }
+      result = @server.request("PUT", "_api/user/#{@name}", body: body)
+      @password = password
+      return_element(result)
+    end
+
+    def update(password: @password, active: @active, extra: @extra)
+      body = {
+        passwd: password,
+        active: active,
+        extra: extra
+      }
+      result = @server.request("PATCH", "_api/user/#{@name}", body: body)
+      @password = password
+      return_element(result)
+    end
+
+    def destroy
+      result = @server.request("DELETE", "_api/user/#{@name}")
+      return return_directly?(result) ? result : true
+    end
+
+  # == ACCESS ==
+
+    def add_database_access(grant:, database:)
+      satisfy_category?(grant, %w[rw ro none])
+      satisfy_class?(database, [Arango::Database, String])
+      database = database.name if database.is_a?(Arango::Database)
+      body = { grant: grant }
+      result = @server.request("PUT", "_api/user/#{@name}/database/#{database}", body: body)
+      return return_directly?(result) ? result : result[database.to_sym]
+    end
+
+    def grant(database:)
+      add_database_access(grant: "rw", database: database)
+    end
+
+    def add_collection_access(grant:, database:, collection:)
+      satisfy_category?(grant, %w[rw ro none])
+      satisfy_class?(database, [Arango::Database, String])
+      satisfy_class?(collection, [Arango::Collection, String])
+      database = database.name     if database.is_a?(Arango::Database)
+      collection = collection.name if collection.is_a?(Arango::Collection)
+      body = { grant: grant }
+      result = @server.request("PUT", "_api/user/#{@name}/database/#{database}/#{collection}", body: body)
+      return return_directly?(result) ? result : result[:"#{database}/#{collection}"]
+    end
+
+    def revoke_database_access(database:)
+      satisfy_class?(database, [Arango::Database, String])
+      database = database.name if database.is_a?(Arango::Database)
+      result = @server.request("DELETE", "_api/user/#{@name}/database/#{database}")
+      return return_directly?(result) ? result : true
+    end
+    alias revoke revoke_database_access
+
+    def revoke_collection_access(database:, collection:)
+      satisfy_class?(database, [Arango::Database, String])
+      satisfy_class?(collection, [Arango::Collection, String])
+      database = database.name     if database.is_a?(Arango::Database)
+      collection = collection.name if collection.is_a?(Arango::Collection)
+      result = @server.request("DELETE", "_api/user/#{@name}/database/#{database}/#{collection}")
+      return return_directly?(result) ? result : true
+    end
+
+    def list_access(full: nil)
+      query = { full: full }
+      result = @server.request("GET", "_api/user/#{@name}/database", query: query)
+      return return_directly?(result) ? result : result[:result]
+    end
+    alias databases list_access
+
+    def database_access(database:)
+      satisfy_class?(database, [Arango::Database, String])
+      database = database.name if database.is_a?(Arango::Database)
+      result = @server.request("GET", "_api/user/#{@name}/database/#{database}")
+      return return_directly?(result) ? result : result[:result]
+    end
+
+    def collection_access(database:, collection:)
+      satisfy_class?(database, [Arango::Database, String])
+      satisfy_class?(collection, [Arango::Collection, String])
+      database = database.name     if database.is_a?(Arango::Database)
+      collection = collection.name if collection.is_a?(Arango::Collection)
+      result = @server.request("GET", "_api/user/#{@name}/database/#{database}/#{collection}", body: body)
+      return return_directly?(result) ? result : result[:result]
+    end
+  end
+end

data/lib/arango/version.rb

@@ -0,0 +1,3 @@
+module Arango
+  VERSION = '3.5.0.alpha0'
+end

data/lib/arango/vertex.rb

@@ -0,0 +1,112 @@
+# === GRAPH VERTEX ===
+
+module Arango
+  class Vertex < Arango::Document
+    include Arango::Helper::Traversal
+
+    def initialize(name: nil, collection:, body: {}, rev: nil, cache_name: nil)
+      assign_collection(collection)
+      unless cache_name.nil?
+        @cache_name = cache_name
+        @server.cache.save(:document, cache_name, self)
+      end
+      body[:_key] ||= name
+      body[:_rev] ||= rev
+      body[:_id]  ||= "#{@collection.name}/#{name}" unless name.nil?
+      assign_attributes(body)
+    end
+
+# === DEFINE ===
+
+    attr_reader :collection, :database, :server, :graph
+
+    def collection=(collection)
+      satisfy_class?(collection, [Arango::Collection])
+      if collection.graph.nil?
+        raise Arango::Error.new err: :collection_does_not_have_a_graph, data:
+          {name_collection: collection.name, graph: nil}
+      end
+      @collection = collection
+      @graph = @collection.graph
+      @database = @collection.database
+      @server = @database.server
+    end
+    alias assign_collection collection=
+
+# == GET ==
+
+    def retrieve(if_match: false)
+      headers = {}
+      headers[:"If-Match"] = @body[:_rev] if if_match
+      result = @graph.request("GET", "vertex/#{@collection.name}/#{@body[:_key]}", headers: headers, key: :vertex)
+      return_element(result)
+    end
+
+# == POST ==
+
+    def create(body: {}, wait_for_sync: nil)
+      body = @body.merge(body)
+      query = { waitForSync: wait_for_sync }
+      result = @graph.request("POST", "vertex/#{@collection.name}", body: body,
+        query: query, key: :vertex)
+      return result if @server.async != false
+      body2 = result.clone
+      body = body.merge(body2)
+      assign_attributes(body)
+      return return_directly?(result) ? result : self
+    end
+
+# == PUT ==
+
+    def replace(body: {}, if_match: false, keep_null: nil, wait_for_sync: nil)
+      query = {
+        waitForSync: wait_for_sync,
+        keepNull: keep_null
+      }
+      headers = {}
+      headers[:"If-Match"] = @body[:_rev] if if_match
+      result = @graph.request("PUT", "vertex/#{@collection.name}/#{@body[:_key]}",
+        body: body, query: query, headers: headers, key: :vertex)
+      return result if @server.async != false
+      body2 = result.clone
+      body = body.merge(body2)
+      assign_attributes(body)
+      return return_directly?(result) ? result : self
+    end
+
+    def update(body: {}, if_match: false, keep_null: nil, wait_for_sync: nil)
+      query = { waitForSync: wait_for_sync, keepNull: keep_null }
+      headers = {}
+      headers[:"If-Match"] = @body[:_rev] if if_match
+      result = @graph.request("PATCH", "vertex/#{@collection.name}/#{@body[:_key]}", body: body,
+        query: query, headers: headers, key: :vertex)
+      return result if @server.async != false
+      body2 = result.clone
+      body = body.merge(body2)
+      body = @body.merge(body)
+      assign_attributes(body)
+      return return_directly?(result) ? result : self
+    end
+
+# === DELETE ===
+
+    def destroy(wait_for_sync: nil, if_match: false)
+      query = { waitForSync: wait_for_sync }
+      headers = {}
+      headers[:"If-Match"] = @body[:_rev] if if_match
+      result = @graph.request("DELETE", "vertex/#{@collection.name}/#{@body[:_key]}",
+        query: query, headers: headers)
+      return_delete(result)
+    end
+
+# === WRONG ===
+
+    def from=(arg)
+      raise Arango::Error.new err: :you_cannot_assign_from_or_to_to_a_vertex
+    end
+    alias to= from=
+    alias to from=
+    alias to_r from=
+    alias from_r from=
+  end
+end

data/lib/arango/view.rb

@@ -0,0 +1,124 @@
+# ==== DOCUMENT ====
+
+module Arango
+  class View
+    include Arango::Helper::Satisfaction
+    include Arango::Helper::Return
+    include Arango::Helper::DatabaseAssignment
+
+    def initialize(database:, type: "arangosearch", name:, id: nil, cache_name: nil)
+      assign_database(database)
+      unless cache_name.nil?
+        @cache_name = cache_name
+        @server.cache.save(:view, cache_name, self)
+      end
+      satisfy_category?(type, ["arangosearch"])
+      @type = type
+      @name = name
+      @links = {}
+      @id = id
+    end
+
+# === DEFINE ===
+
+    attr_reader :type, :links, :database, :cache_name
+    attr_accessor :id, :name
+
+    def type=(type)
+      satisfy_category?(type, ["arangosearch"])
+      @type = type
+    end
+    alias assign_type type=
+
+    def add_link(collection:, analyzers: nil, fields: {}, include_all_fields: nil, track_list_positions: nil, store_values: nil)
+      satisfy_class?(collection, [Arango::Collection, String])
+      collection_name = collection.is_a?(String) ? collection : collection.name
+      satisfy_category?(store_values, ["none", "id", nil])
+      @links[collection_name] = {
+        analyzers: analyzers,
+        fields: fields,
+        includeAllFields: include_all_fields,
+        trackListPositions: track_list_positions,
+        storeValues: store_values
+      }
+      @links[collection_name].delete_if{|k,v| v.nil?}
+    end
+
+    def to_h
+      {
+        name: @name,
+        id: @id,
+        type: @type,
+        links: @links,
+        cache_name: @cache_name,
+        database: @database.name
+      }.delete_if{|k,v| v.nil?}
+    end
+
+    def body=(result)
+      @body  = result
+      @id    = result[:id] || @id
+      @type  = assign_type(result[:type] || @type)
+      @links = result[:links] || @links
+      @name  = result[:name] || name
+      if @server.active_cache && @cache_name.nil?
+        @cache_name = "#{@database.name}/#{@id}"
+        @server.cache.save(:task, @cache_name, self)
+      end
+    end
+    alias assign_attributes body=
+
+    # === COMMANDS ===
+
+    def retrieve
+      result = @database.request("GET", "_api/view/#{@name}")
+      return result.headers[:"x-arango-async-id"] if @server.async == :store
+      return_element(result)
+    end
+
+    def manage_properties(method, url, consolidation_interval_msec: nil, threshold: nil, segment_threshold: nil, cleanup_interval_step: nil)
+      body = {
+        properties: {
+          links: @links.empty? ? nil : @links,
+          consolidationIntervalMsec: consolidation_interval_msec,
+          consolidationPolicy: {
+            threshold: threshold,
+            segmentThreshold: segment_threshold
+          },
+          cleanupIntervalStep: cleanup_interval_step
+        }
+      }
+      if method == "POST"
+        body[:type] = @type
+        body[:name] = @name
+      end
+      body[:properties][:consolidationPolicy].delete_if{|k,v| v.nil?}
+      body[:properties].delete(:consolidationPolicy) if body[:properties][:consolidationPolicy].empty?
+      body[:properties].delete_if{|k,v| v.nil?}
+      body.delete(:properties) if body[:properties].empty?
+      body.delete_if{|k,v| v.nil?}
+      result = @database.request(method, url, body: body)
+      return_element(result)
+    end
+    private :manage_properties
+
+    def create(consolidation_interval_msec: nil, threshold: nil, segment_threshold: nil, cleanup_interval_step: nil)
+      manage_properties("POST", "_api/view", consolidation_interval_msec: consolidation_interval_msec, threshold: threshold, segment_threshold: segment_threshold, cleanup_interval_step: cleanup_interval_step)
+    end
+
+    def replace_properties(consolidation_interval_msec: nil, threshold: nil, segment_threshold: nil, cleanup_interval_step: nil)
+      manage_properties("PUT", "_api/view/#{@name}/properties", consolidation_interval_msec: consolidation_interval_msec, threshold: threshold, segment_threshold: segment_threshold, cleanup_interval_step: cleanup_interval_step)
+    end
+
+    def update_properties(consolidation_interval_msec: nil, threshold: nil, segment_threshold: nil, cleanup_interval_step: nil)
+      manage_properties("PATCH", "_api/view/#{@name}/properties", consolidation_interval_msec: consolidation_interval_msec, threshold: threshold, segment_threshold: segment_threshold, cleanup_interval_step: cleanup_interval_step)
+    end
+
+
+    def properties
+      @database.request("GET", "_api/view/#{@name}/properties")
+    end
+
+
+  end
+end

data/lib/arango/view/basics.rb

@@ -0,0 +1,25 @@
+module Arango
+  module View
+    module Basics
+      def exist?
+
+      end
+      alias exists? exist?
+
+      def info
+
+
+      end
+
+      def rename(name:)
+        body = {name: name}
+        result = @database.request("PUT", "_api/view/#{@name}/rename", body: body)
+        return_element(result)
+      end#
+
+      def drop
+        @database.request("DELETE", "_api/view/#{@name}", key: :result)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,296 @@
+--- !ruby/object:Gem::Specification
+name: arango-driver
+version: !ruby/object:Gem::Version
+  version: 3.5.0.alpha0
+platform: ruby
+authors:
+- Stefano Martin
+- Jan Biedermann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: isomorfeus-redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.14
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal-webpack-loader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+description: Ruby driver for ArangoDB's HTTP API
+email:
+- jan@kursator.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- arango_opal.js
+- lib/arango-driver.rb
+- lib/arango.rb
+- lib/arango/aql.rb
+- lib/arango/collection.rb
+- lib/arango/collection/documents.rb
+- lib/arango/collection/edges.rb
+- lib/arango/collection/importing.rb
+- lib/arango/collection/indexes.rb
+- lib/arango/collection/replication.rb
+- lib/arango/collection/user.rb
+- lib/arango/cursor.rb
+- lib/arango/database.rb
+- lib/arango/database/analyzer.rb
+- lib/arango/database/aql_functions.rb
+- lib/arango/database/aql_queries.rb
+- lib/arango/database/aql_query_cache.rb
+- lib/arango/database/collections.rb
+- lib/arango/database/foxx_services.rb
+- lib/arango/database/graph_access.rb
+- lib/arango/database/http_route.rb
+- lib/arango/database/replication.rb
+- lib/arango/database/stream_transactions.rb
+- lib/arango/database/tasks.rb
+- lib/arango/database/transactions.rb
+- lib/arango/database/user.rb
+- lib/arango/database/view_access.rb
+- lib/arango/document.rb
+- lib/arango/edge.rb
+- lib/arango/error.rb
+- lib/arango/error_db.rb
+- lib/arango/foxx.rb
+- lib/arango/graph.rb
+- lib/arango/graph/basics.rb
+- lib/arango/graph/edge_access.rb
+- lib/arango/graph/vertex_access.rb
+- lib/arango/helper/collection_assignment.rb
+- lib/arango/helper/database_assignment.rb
+- lib/arango/helper/request_method.rb
+- lib/arango/helper/return.rb
+- lib/arango/helper/satisfaction.rb
+- lib/arango/helper/server_assignment.rb
+- lib/arango/helper/traversal.rb
+- lib/arango/index.rb
+- lib/arango/replication.rb
+- lib/arango/request.rb
+- lib/arango/request_batch.rb
+- lib/arango/result.rb
+- lib/arango/search_view.rb
+- lib/arango/server.rb
+- lib/arango/server/administration.rb
+- lib/arango/server/agency.rb
+- lib/arango/server/async.rb
+- lib/arango/server/batch.rb
+- lib/arango/server/config.rb
+- lib/arango/server/databases.rb
+- lib/arango/server/monitoring.rb
+- lib/arango/server/opal_support.rb
+- lib/arango/server/tasks.rb
+- lib/arango/server/user.rb
+- lib/arango/task.rb
+- lib/arango/transaction.rb
+- lib/arango/traversal.rb
+- lib/arango/user.rb
+- lib/arango/version.rb
+- lib/arango/vertex.rb
+- lib/arango/view.rb
+- lib/arango/view/basics.rb
+homepage: https://github.com/isomorfeus/arango-driver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A simple ruby client for ArangoDB >= 3.5
+test_files: []