aserto 0.30.0 → 0.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4471efcec975432356d584d3d480e0ab503e139787c8f96ab88032ab15356175
-  data.tar.gz: aa46126a15fb9f583fd8dc9a1b064889f95ccfa3814bc4c6c7588c0ed7f78175
+  metadata.gz: ddb26b2da994a8a4f72162f227590060a990a31d16639994b5cd2e4bd9ce538f
+  data.tar.gz: e6969585d13f94a6e410d8763647cbc3dca69402969a194db2674239514adeeb
 SHA512:
-  metadata.gz: 61af3804724a6138e21a5233c25712213860b4e2939331f1087e728c36a6cf5fefb31c6e23b77fc219df75d84abf2ecb1675892e60663e787cd6932884be3dec
-  data.tar.gz: f73188bf7eb0a4b58944022c715fdcb65718e3d8debe3215a6a82437781f544ff78cc1012a169ffd8deb2a762650da9d0970030a2e8eeaab461abe1dc4233d3b
+  metadata.gz: c0202011d8ce67f9fc48e361fdbd00b9239e291aa7bc60e5773eed58252dec41fdbac16e28ea25f0ff54d4652a0eee247ec048f59e6df5b1ae1bc5d254638244
+  data.tar.gz: a2c5e23bcb6e18ee1babb1c13d0e39912c32aa70595c5ce8dae69e24e0f10c6c37e7251f6dad0d5059fbe801dc8bf3d5ddde3ba806c071ae96b52afd1ba84f49

data/README.md

@@ -23,7 +23,7 @@ gem install aserto
 
 ## Directory
 
-The Directory APIs can be used to get or set object instances and relation instances. They can also be used to check whether a user has a permission or relation on an object instance.
+The Directory APIs can be used to get or set object instances and relation instances. They can also be used to check whether a user has permission or relation on an object instance.
 
 ### Directory Client
 
@@ -32,7 +32,7 @@ You can initialize a directory client as follows:
 ```ruby
 require 'aserto/directory/client'
 
-directory_client =Aserto::Directory::V3::Client.new(
+directory_client = Aserto::Directory::V3::Client.new(
   url: "directory.eng.aserto.com:8443",
   tenant_id: "aserto-tenant-id",
   api_key: "basic directory api key",
@@ -42,9 +42,9 @@ directory_client =Aserto::Directory::V3::Client.new(
 - `url`: hostname:port of directory service (_required_)
 - `api_key`: API key for directory service (_required_ if using hosted directory)
 - `tenant_id`: Aserto tenant ID (_required_ if using hosted directory)
-- `cert_path`: Path to the grpc service certificate when connecting to local topaz instance.
+- `cert_path`: Path to the grpc service certificate when connecting to the local topaz instance.
 
-See https://rubydoc.info/gems/aserto/docs/Aserto/Directory/V3/Client for full documentation
+See [Aserto::Directory::V3::Client](https://rubydoc.info/gems/aserto/Aserto/Directory/V3/Client) for full documentation
 
 ## Authorizer
 `Aserto::Authorization` is a middleware that allows Ruby applications to use Aserto as the Authorization provider.
@@ -120,7 +120,7 @@ end
 By default, when computing the policy path, the middleware:
 * converts all slashes to dots
 * converts any character that is not alpha, digit, dot or underscore to underscore
-* converts uppercase characters in the URL path to lowercases
+* converts uppercase characters in the URL path to lowercase
 
 This behaviour can be overwritten by providing a custom function:
 
@@ -136,7 +136,7 @@ end
 ```
 
 ### Resource
-A resource can be any structured data that the authorization policy uses to evaluate decisions. By default, middleware does not include a resource in authorization calls.
+A resource can be any structured data the authorization policy uses to evaluate decisions. By default, middleware does not include a resource in authorization calls.
 
 This behaviour can be overwritten by providing a custom function:
 

data/VERSION

@@ -1 +1 @@
-0.30.0
+0.30.1

data/lib/aserto/directory/client.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-require "aserto/directory"
-require_relative "interceptors/headers"
-require_relative "requests"
+require_relative "v2/client"
 
 module Aserto
   module Directory
     class Client
-      include Requests
-
       # Creates a new Directory Client
       #
       # @param url [String] the gRpc url of the directory server
@@ -17,127 +13,28 @@ module Aserto
       # @param cert_path [String] the path to the certificates folder
       #
       # @return [Aserto::Directory::Client] the new Directory Client
-      def initialize(url: "directory.prod.aserto.com:8443", api_key: nil, tenant_id: nil, cert_path: nil)
-        @reader_client = ::Aserto::Directory::Reader::V2::Reader::Stub.new(
-          url,
-          load_creds(cert_path),
-          interceptors: [Interceptors::Headers.new(api_key, tenant_id)]
-        )
-        @writer_client = ::Aserto::Directory::Writer::V2::Writer::Stub.new(
-          url,
-          load_creds(cert_path),
-          interceptors: [Interceptors::Headers.new(api_key, tenant_id)]
-        )
-      end
-
-      # Check permissions
-      #
-      # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param permission [String] permission name to be checked
-      # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param trace [Boolean] whether to enable tracing
-      #
-      # @return [Boolean]
-      def check_permission(subject:, permission:, object:, trace: false)
-        reader_client.check_permission(check_permission_request(subject, permission, object, trace))
-      end
-
-      # Check relation
-      #
-      # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier] relation name to be checked
-      # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param trace [Boolean] whether to enable tracing
-      #
-      # @return [Boolean]
-      def check_relation(subject:, relation:, object:, trace: false)
-        reader_client.check_relation(check_relation_request(subject, relation, object, trace))
-      end
-
-      # Get an object by type and key
-      #
-      # @param type [String] the type of object
-      # @param key [String] the key of the object
-      #
-      # @return [::Aserto::Directory::Common::V2::Object]
-      def object(type:, key:)
-        reader_client.get_object(object_request(key, type)).result
-      end
-
-      # Set an object
-      #
-      # @param object [::Aserto::Directory::Common::V2::Object]
-      #
-      # @return [::Aserto::Directory::Common::V2::Object] the created/updated object
-      def set_object(object:)
-        writer_client.set_object(new_object_request(object)).result
-      end
-
-      # Get a list of objects by type
-      #
-      # @param type [String] the type of objects
-      # @param page [::Aserto::Directory::Common::V2::PaginationRequest]
-      #
-      # @return [Array<::Aserto::Directory::Common::V2::Object>]
-      def objects(type:, page: nil)
-        reader_client.get_objects(objects_request(type, page)).results
-      end
 
-      # Get a relation
-      #
-      # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier]
-      # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      #
-      # @return [::Aserto::Directory::Common::V2::Relation]
-      def relation(subject: nil, relation: nil, object: nil)
-        reader_client.get_relation(relation_request(subject, relation, object)).results
-      end
+      def initialize(url: "directory.prod.aserto.com:8443", api_key: nil, tenant_id: nil, cert_path: nil)
+        warn WARN_MESSAGE
 
-      # Get a list of relations
-      #
-      # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier]
-      # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      #
-      # @return [Array<::Aserto::Directory::Common::V2::Relation>]
-      def relations(subject: nil, relation: nil, object: nil, page: nil)
-        reader_client.get_relations(relations_request(subject, relation, object, page)).results
+        @v2_client = Aserto::Directory::V2::Client.new(
+          url: url, api_key: api_key, tenant_id: tenant_id, cert_path: cert_path
+        )
       end
 
-      # Set a relation
-      # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param relation [String] name of the relation
-      # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param hash [String] hash of the relation(required for updating a relation)
-      #
-      # @return [::Aserto::Directory::Common::V2::Relation] the created/updated relation
-      def set_relation(subject:, relation:, object:, hash: nil)
-        writer_client.set_relation(new_relation_request(subject, relation, object, hash)).result
+      def method_missing(method, args)
+        @v2_client.send(method, **args)
       end
 
-      # Delete a relation
-      #
-      # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier]
-      # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
-      #
-      # @return nil
-      def delete_relation(subject:, relation:, object:)
-        writer_client.delete_relation(delete_relation_request(subject, relation, object))
+      def respond_to_missing?(_name, _include_private)
+        true
       end
 
-      private
-
-      attr_reader :reader_client, :writer_client
-
-      def load_creds(cert_path)
-        if cert_path && File.file?(cert_path)
-          GRPC::Core::ChannelCredentials.new(File.read(cert_path))
-        else
-          GRPC::Core::ChannelCredentials.new
-        end
-      end
+      WARN_MESSAGE = <<~TEXT
+        Aserto::Directory::Client is deprecated and will be removed.
+        Use Aserto::Directory::V3::Client for the latest Directory Client.
+        If you need Directory V2, use Aserto::Directory::V2::Client
+      TEXT
     end
   end
 end

data/lib/aserto/directory/v2/client.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require "aserto/directory"
+require_relative "../interceptors/headers"
+require_relative "requests"
+
+module Aserto
+  module Directory
+    module V2
+      class Client
+        include Requests
+
+        # Creates a new Directory V2 Client
+        #
+        # @param url [String] the gRpc url of the directory server
+        # @param api_key [String] the api key of the directory server(for hosted directory)
+        # @param tenant_id [String] the tenant id of the directory server(for hosted directory)
+        # @param cert_path [String] the path to the certificates folder
+        #
+        # @return [Aserto::Directory::V2::Client] the new Directory Client
+        def initialize(url: "directory.prod.aserto.com:8443", api_key: nil, tenant_id: nil, cert_path: nil)
+          @reader_client = ::Aserto::Directory::Reader::V2::Reader::Stub.new(
+            url,
+            load_creds(cert_path),
+            interceptors: [Interceptors::Headers.new(api_key, tenant_id)]
+          )
+          @writer_client = ::Aserto::Directory::Writer::V2::Writer::Stub.new(
+            url,
+            load_creds(cert_path),
+            interceptors: [Interceptors::Headers.new(api_key, tenant_id)]
+          )
+        end
+
+        # Check permissions
+        #
+        # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param permission [String] permission name to be checked
+        # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param trace [Boolean] whether to enable tracing
+        #
+        # @return [Boolean]
+        def check_permission(subject:, permission:, object:, trace: false)
+          reader_client.check_permission(check_permission_request(subject, permission, object, trace))
+        end
+
+        # Check relation
+        #
+        # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier] relation name to be checked
+        # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param trace [Boolean] whether to enable tracing
+        #
+        # @return [Boolean]
+        def check_relation(subject:, relation:, object:, trace: false)
+          reader_client.check_relation(check_relation_request(subject, relation, object, trace))
+        end
+
+        # Get an object by type and key
+        #
+        # @param type [String] the type of object
+        # @param key [String] the key of the object
+        #
+        # @return [::Aserto::Directory::Common::V2::Object]
+        def object(type:, key:)
+          reader_client.get_object(object_request(key, type)).result
+        end
+
+        # Set an object
+        #
+        # @param object [::Aserto::Directory::Common::V2::Object]
+        #
+        # @return [::Aserto::Directory::Common::V2::Object] the created/updated object
+        def set_object(object:)
+          writer_client.set_object(new_object_request(object)).result
+        end
+
+        # Get a list of objects by type
+        #
+        # @param type [String] the type of objects
+        # @param page [::Aserto::Directory::Common::V2::PaginationRequest]
+        #
+        # @return [Array<::Aserto::Directory::Common::V2::Object>]
+        def objects(type:, page: nil)
+          reader_client.get_objects(objects_request(type, page)).results
+        end
+
+        # Get a relation
+        #
+        # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier]
+        # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        #
+        # @return [::Aserto::Directory::Common::V2::Relation]
+        def relation(subject: nil, relation: nil, object: nil)
+          reader_client.get_relation(relation_request(subject, relation, object)).results
+        end
+
+        # Get a list of relations
+        #
+        # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier]
+        # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        #
+        # @return [Array<::Aserto::Directory::Common::V2::Relation>]
+        def relations(subject: nil, relation: nil, object: nil, page: nil)
+          reader_client.get_relations(relations_request(subject, relation, object, page)).results
+        end
+
+        # Set a relation
+        # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param relation [String] name of the relation
+        # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param hash [String] hash of the relation(required for updating a relation)
+        #
+        # @return [::Aserto::Directory::Common::V2::Relation] the created/updated relation
+        def set_relation(subject:, relation:, object:, hash: nil)
+          writer_client.set_relation(new_relation_request(subject, relation, object, hash)).result
+        end
+
+        # Delete a relation
+        #
+        # @param subject [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        # @param relation [::Aserto::Directory::Common::V2::RelationTypeIdentifier]
+        # @param object [::Aserto::Directory::Common::V2::ObjectIdentifier]
+        #
+        # @return nil
+        def delete_relation(subject:, relation:, object:)
+          writer_client.delete_relation(delete_relation_request(subject, relation, object))
+        end
+
+        private
+
+        attr_reader :reader_client, :writer_client
+
+        def load_creds(cert_path)
+          if cert_path && File.file?(cert_path)
+            GRPC::Core::ChannelCredentials.new(File.read(cert_path))
+          else
+            GRPC::Core::ChannelCredentials.new
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aserto
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.30.1
 platform: ruby
 authors:
 - Aserto
@@ -82,7 +82,8 @@ files:
 - lib/aserto/config.rb
 - lib/aserto/directory/client.rb
 - lib/aserto/directory/interceptors/headers.rb
-- lib/aserto/directory/requests.rb
+- lib/aserto/directory/v2/client.rb
+- lib/aserto/directory/v2/requests.rb
 - lib/aserto/directory/v3/client.rb
 - lib/aserto/directory/v3/config.rb
 - lib/aserto/directory/v3/exporter.rb