oso-oso 0.20.1.pre.beta → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a6c6bd2d2fb38245a5103c0153f943f51060c90
-  data.tar.gz: 33dcb41c1c6bd0aeeec56d88391e1e80a66b6061
+  metadata.gz: da642b9fbbfcad2d836a8db8c6ac83cbc8f1127a
+  data.tar.gz: 1012ef61aa0a1791a1c759ba9f62e108918898b6
 SHA512:
-  metadata.gz: 5c025329ad3a4eff57b2cf5e7d5ca8430ef825ee287111690f06439a7c6f623068048d27ea70358af8ffb8f9d935b926cdecf54baa848f95da9ebaa23b0c0e39
-  data.tar.gz: 2c4a4114eafb5887805a7b92015f466296ae9eaaa4ffe19f1cc60d4f2ec59b6b580ff80ebe60143e639d7f606d79f343c89e3fdd7e7a52789939af9716b9b2c3
+  metadata.gz: 48d52111b817769f31086b4adbd7252bcab4355792ba85e378ab4a27c68272e8d2af55f8d2a258e0a3bb3b2cea30b6d0c98f6e20eec7ed9d1b127011a506cab7
+  data.tar.gz: f40a6c5565655ee508ebc0c20b7f571616b42d4a76f986b51ad4349c1fe05200d8165990c98a00e2a7388ac41eb96182095b52a9f08ad022cc0880801ad87997

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-oso (0.20.1.pre.beta)
+    oso-oso (0.20.1)
       ffi (~> 1.0)
 
 GEM
@@ -116,4 +116,4 @@ DEPENDENCIES
   yard (~> 0.9.25)
 
 BUNDLED WITH
-   2.2.15
+   2.2.4

data/lib/oso/oso.rb

@@ -173,14 +173,14 @@ module Oso
       fields
     end
 
-    # Returns a query for resources of type +cls+ that +actor+  is allowed
-    # to perform +action+ on.
+    # Create a query for resources of type +cls+ that +actor+ is
+    # allowed to perform +action+ on.
     #
     # @param actor The actor whose permissions to check.
     # @param action The action being taken on the resource.
     # @param resource_cls The resource being accessed.
     #
-    # @returns A query for resources accessible to the actor.
+    # @return A query for resources accessible to the actor.
     def authorized_query(actor, action, resource_cls) # rubocop:disable Metrics/MethodLength
       resource = Polar::Variable.new 'resource'
 
@@ -204,14 +204,14 @@ module Oso
         .build_query
     end
 
-    # Returns the resources of type +resource_cls+ that +actor+  is allowed
-    # to perform +action+ on.
+    # Determine the resources of type +resource_cls+ that +actor+
+    # is allowed to perform +action+ on.
     #
     # @param actor The actor whose permissions to check.
     # @param action The action being taken on the resource.
     # @param resource_cls The resource being accessed.
     #
-    # @returns A list of resources accessible to the actor.
+    # @return A list of resources accessible to the actor.
     def authorized_resources(actor, action, resource_cls)
       q = authorized_query actor, action, resource_cls
       return [] if q.nil?

data/lib/oso/polar/data_filtering.rb

@@ -87,6 +87,11 @@ module Oso
       class Relation
         attr_reader :kind, :other_type, :my_field, :other_field
 
+        # Describe a Relation from one type to another.
+        # @param kind [String] The type of relation, either "one" or "many"
+        # @param other_type The name or class object of the related type
+        # @param my_field The field on this type that matches +other_type+
+        # @param other_field The field on +other_type+ that matches this type
         def initialize(kind:, other_type:, my_field:, other_field:)
           @kind = kind
           @other_type = other_type
@@ -125,6 +130,10 @@ module Oso
           'Contains' => ->(a, b) { a.include? b }
         }.freeze
 
+        # Create a new predicate for data filtering.
+        # @param kind [String] Represents a condition. One of "Eq", "Neq", "In", "Contains".
+        # @param field The field the condition applies to.
+        # @param value The value with which to compare the field according to the condition.
         def initialize(kind:, field:, value:)
           @kind = kind
           @field = field

data/lib/oso/polar/polar.rb

@@ -136,12 +136,12 @@ module Oso
       # @return [self] for chaining.
       #
       # @deprecated {#load_file} has been deprecated in favor of {#load_files}
-      #   as of the 0.20.0 release. Please see changelog for migration
+      #   as of the 0.20 release. Please see changelog for migration
       #   instructions:
       #   https://docs.osohq.com/project/changelogs/2021-09-15.html
       def load_file(filename)
         warn <<~WARNING
-          `Oso#load_file` has been deprecated in favor of `Oso#load_files` as of the 0.20.0 release.
+          `Oso#load_file` has been deprecated in favor of `Oso#load_files` as of the 0.20 release.
 
           Please see changelog for migration instructions: https://docs.osohq.com/project/changelogs/2021-09-15.html
         WARNING
@@ -211,6 +211,10 @@ module Oso
       #
       # @param cls [Class] the class to register.
       # @param name [String] the name to register the class as. Defaults to the name of the class.
+      # @param fields [Hash] a map from field names on instances of +cls+ to types, or Relation objects.
+      # @param build_query [Proc] a method to produce a query for +cls+ objects, given a list of Filters.
+      # @param exec_query [Proc] a method to execute a query produced by +build_query+
+      # @param combine_query [Proc] a method to merge two queries produced by +build_query+
       # @raise [DuplicateClassAliasError] if attempting to register a class
       # under a previously-registered name.
       # @raise [FFI::Error] if the FFI call returns an error.

data/lib/oso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oso
-  VERSION = '0.20.1-beta'
+  VERSION = '0.20.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-oso
 version: !ruby/object:Gem::Version
-  version: 0.20.1.pre.beta
+  version: 0.20.1
 platform: ruby
 authors:
 - Oso Security, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-10 00:00:00.000000000 Z
+date: 2021-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -197,9 +197,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14.4