oso-cloud 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 460a79201e11b1f8e81db2eedea8bfd1c6651301336e1d31652a54a1ed537344
-  data.tar.gz: bd3692528348f8e9e45a36c09a3df41cef74fc47258db81471b456e0f1297f32
+  metadata.gz: 0afcafa1d502f02d19ed93b21ad4606eaf59056114c496c5a9d8b72f55994c05
+  data.tar.gz: e9bc9ad6450429c9d2c5a1574e4451316e1f043b666da2cfbdc3ae69e1e449cf
 SHA512:
-  metadata.gz: 360042f1cb0f076651160473ae092215f36773832c70aa042e26a58a2ebbd9aacf034ec7e0227136075fbe1bc000148c627629a6ddee3ca0ba91cc422b1f2818
-  data.tar.gz: 79eeab9786a8358d12c3010648ab03f3fff454e69ae217e15122fbc5ebd5e2f4619111da3727e2bb60af14bd3f11e66989c8c74594243852ab131de0e8d1396d
+  metadata.gz: 8e837b4bd3d8c16aa1859c93453756a35c844c5371ab9cad18d2afb88748dfc413993be213da260f73bff9d9b83ef28a734e2cfd994e706220c92c4d2ce62df4
+  data.tar.gz: 179d6e9639dd2cf447c4c71c6f888b5474f633ad1f323f15b46a8729e8acb86419e2e5b4f628628a4c8655d874881ee6e938d379dbd794f68ea6a18b593c580d

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  TargetRubyVersion: 3.0.0
+  Exclude:
+    - "bin/**/*"
+  NewCops: enable

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-cloud (1.0.0)
+    oso-cloud (1.1.0)
       faraday (~> 2.5.2)
       faraday-retry (~> 2.0.0)
 
@@ -11,7 +11,7 @@ GEM
     faraday (2.5.2)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
+    faraday-net_http (3.0.2)
     faraday-retry (2.0.0)
       faraday (~> 2.0)
     minitest (5.15.0)

data/lib/oso/api.rb

@@ -18,18 +18,15 @@ module OsoCloud
     end
 
     # @!visibility private
-    class ApiError
-      attr_reader :message
-
+    class ApiError < StandardError
       def initialize(message:)
-        @message = message
+        super(message)
       end
     end
 
     # @!visibility private
     class Policy
-      attr_reader :filename
-      attr_reader :src
+      attr_reader :filename, :src
 
       def initialize(filename:, src:)
         @filename = filename
@@ -42,29 +39,27 @@ module OsoCloud
       attr_reader :policy
 
       def initialize(policy:)
-        if policy.is_a? Policy
-          @policy = policy
-        else
-          @policy = Policy.new(**policy)
-        end
+        @policy = if policy.is_a? Policy
+                    policy
+                  else
+                    Policy.new(**policy)
+                  end
       end
     end
 
     # @!visibility private
     class Fact
-      attr_reader :predicate
-      attr_reader :args
+      attr_reader :predicate, :args
 
       def initialize(predicate:, args:)
         @predicate = predicate
-        @args = args.map { |v| if v.is_a? Value then v else Value.new(**v) end }
+        @args = args.map { |v| (v.is_a? Value) ? v : Value.new(**v) }
       end
     end
 
     # @!visibility private
     class Value
-      attr_reader :type
-      attr_reader :id
+      attr_reader :type, :id
 
       def initialize(type:, id:)
         @type = type
@@ -74,12 +69,11 @@ module OsoCloud
 
     # @!visibility private
     class Bulk
-      attr_reader :delete
-      attr_reader :tell
+      attr_reader :delete, :tell
 
       def initialize(delete:, tell:)
-        @delete = delete.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
-        @tell = tell.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @delete = delete.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
+        @tell = tell.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
@@ -94,12 +88,7 @@ module OsoCloud
 
     # @!visibility private
     class AuthorizeQuery
-      attr_reader :actor_type
-      attr_reader :actor_id
-      attr_reader :action
-      attr_reader :resource_type
-      attr_reader :resource_id
-      attr_reader :context_facts
+      attr_reader :actor_type, :actor_id, :action, :resource_type, :resource_id, :context_facts
 
       def initialize(actor_type:, actor_id:, action:, resource_type:, resource_id:, context_facts:)
         @actor_type = actor_type
@@ -107,7 +96,7 @@ module OsoCloud
         @action = action
         @resource_type = resource_type
         @resource_id = resource_id
-        @context_facts = context_facts.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @context_facts = context_facts.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
@@ -116,24 +105,20 @@ module OsoCloud
       attr_reader :results
 
       def initialize(results:)
-        @results = results.map { |v| if v.is_a? Value then v else Value.new(**v) end }
+        @results = results.map { |v| (v.is_a? Value) ? v : Value.new(**v) }
       end
     end
 
     # @!visibility private
     class AuthorizeResourcesQuery
-      attr_reader :actor_type
-      attr_reader :actor_id
-      attr_reader :action
-      attr_reader :resources
-      attr_reader :context_facts
+      attr_reader :actor_type, :actor_id, :action, :resources, :context_facts
 
       def initialize(actor_type:, actor_id:, action:, resources:, context_facts:)
         @actor_type = actor_type
         @actor_id = actor_id
         @action = action
-        @resources = resources.map { |v| if v.is_a? Value then v else Value.new(**v) end }
-        @context_facts = context_facts.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @resources = resources.map { |v| (v.is_a? Value) ? v : Value.new(**v) }
+        @context_facts = context_facts.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
@@ -148,18 +133,14 @@ module OsoCloud
 
     # @!visibility private
     class ListQuery
-      attr_reader :actor_type
-      attr_reader :actor_id
-      attr_reader :action
-      attr_reader :resource_type
-      attr_reader :context_facts
+      attr_reader :actor_type, :actor_id, :action, :resource_type, :context_facts
 
       def initialize(actor_type:, actor_id:, action:, resource_type:, context_facts:)
         @actor_type = actor_type
         @actor_id = actor_id
         @action = action
         @resource_type = resource_type
-        @context_facts = context_facts.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @context_facts = context_facts.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
@@ -174,18 +155,14 @@ module OsoCloud
 
     # @!visibility private
     class ActionsQuery
-      attr_reader :actor_type
-      attr_reader :actor_id
-      attr_reader :resource_type
-      attr_reader :resource_id
-      attr_reader :context_facts
+      attr_reader :actor_type, :actor_id, :resource_type, :resource_id, :context_facts
 
       def initialize(actor_type:, actor_id:, resource_type:, resource_id:, context_facts:)
         @actor_type = actor_type
         @actor_id = actor_id
         @resource_type = resource_type
         @resource_id = resource_id
-        @context_facts = context_facts.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @context_facts = context_facts.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
@@ -194,30 +171,27 @@ module OsoCloud
       attr_reader :results
 
       def initialize(results:)
-        @results = results.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @results = results.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
     # @!visibility private
     class Query
-      attr_reader :fact
-      attr_reader :context_facts
+      attr_reader :fact, :context_facts
 
       def initialize(fact:, context_facts:)
-        if fact.is_a? Fact
-          @fact = fact
-        else
-          @fact = Fact.new(**fact)
-        end
-        @context_facts = context_facts.map { |v| if v.is_a? Fact then v else Fact.new(**v) end }
+        @fact = if fact.is_a? Fact
+                  fact
+                else
+                  Fact.new(**fact)
+                end
+        @context_facts = context_facts.map { |v| (v.is_a? Fact) ? v : Fact.new(**v) }
       end
     end
 
     # @!visibility private
     class StatsResult
-      attr_reader :num_roles
-      attr_reader :num_relations
-      attr_reader :num_facts
+      attr_reader :num_roles, :num_relations, :num_facts
 
       def initialize(num_roles:, num_relations:, num_facts:)
         @num_roles = num_roles
@@ -226,31 +200,61 @@ module OsoCloud
       end
     end
 
-
     # @!visibility private
     class Api
-      def initialize(url: 'https://cloud.osohq.com', api_key: nil)
+      def initialize(url: 'https://cloud.osohq.com', api_key: nil, options: nil)
         @url = url
         @connection = Faraday.new(url: url) do |faraday|
+          faraday.request :json
+
+          # responses are processed in reverse order; this stack implies the
+          # retries are attempted before an error is raised, and the json
+          # parser is only applied if there are no errors
+          faraday.response :json, preserve_raw: true
+          faraday.response :raise_error
           faraday.request :retry, {
-            max: 15,
-            interval: 0.05,
-            interval_randomness: 0.5,
+            max: (options && options[:max_retries]) || 10,
+            interval: 0.01,
+            interval_randomness: 0.005,
+            max_interval: 1,
             backoff_factor: 2,
             retry_statuses: [429, 500, 502, 503, 504],
+            # ensure authorize and related check functions are retried because
+            # they are POST requests, which are not retried automatically
+            retry_if: lambda { |env, _exc|
+              %w[
+                /api/authorize
+                /api/authorize_resources
+                /api/list
+                /api/actions
+                /api/query
+              ].include? env.url.path
+            }
           }
 
-          faraday.request :json
-          faraday.response :json, preserve_raw: true
-          faraday.adapter :net_http
+          if options && options[:test_adapter]
+            faraday.adapter :test do |stub|
+              stub.post(options[:test_adapter][:path]) do |_env|
+                options[:test_adapter][:func].call
+              end
+              stub.get(options[:test_adapter][:path]) do |_env|
+                options[:test_adapter][:func].call
+              end
+              stub.delete(options[:test_adapter][:path]) do |_env|
+                options[:test_adapter][:func].call
+              end
+            end
+          else
+            faraday.adapter :net_http
+          end
         end
         @api_key = api_key
       end
 
-      def get_policy()
+      def get_policy
         params = {}
         data = nil
-        url = "/policy"
+        url = '/policy'
         result = GET(url, params, data)
         GetPolicyResult.new(**result)
       end
@@ -258,7 +262,7 @@ module OsoCloud
       def post_policy(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/policy"
+        url = '/policy'
         result = POST(url, params, data)
         ApiResult.new(**result)
       end
@@ -266,7 +270,7 @@ module OsoCloud
       def post_facts(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/facts"
+        url = '/facts'
         result = POST(url, params, data)
         Fact.new(**result)
       end
@@ -274,7 +278,7 @@ module OsoCloud
       def delete_facts(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/facts"
+        url = '/facts'
         result = DELETE(url, params, data)
         ApiResult.new(**result)
       end
@@ -282,7 +286,7 @@ module OsoCloud
       def post_bulk_load(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/bulk_load"
+        url = '/bulk_load'
         result = POST(url, params, data)
         ApiResult.new(**result)
       end
@@ -290,7 +294,7 @@ module OsoCloud
       def post_bulk_delete(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/bulk_delete"
+        url = '/bulk_delete'
         result = POST(url, params, data)
         ApiResult.new(**result)
       end
@@ -298,7 +302,7 @@ module OsoCloud
       def post_bulk(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/bulk"
+        url = '/bulk'
         result = POST(url, params, data)
         ApiResult.new(**result)
       end
@@ -306,7 +310,7 @@ module OsoCloud
       def post_authorize(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/authorize"
+        url = '/authorize'
         result = POST(url, params, data)
         AuthorizeResult.new(**result)
       end
@@ -314,7 +318,7 @@ module OsoCloud
       def post_authorize_resources(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/authorize_resources"
+        url = '/authorize_resources'
         result = POST(url, params, data)
         AuthorizeResourcesResult.new(**result)
       end
@@ -322,7 +326,7 @@ module OsoCloud
       def post_list(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/list"
+        url = '/list'
         result = POST(url, params, data)
         ListResult.new(**result)
       end
@@ -330,7 +334,7 @@ module OsoCloud
       def post_actions(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/actions"
+        url = '/actions'
         result = POST(url, params, data)
         ActionsResult.new(**result)
       end
@@ -338,33 +342,34 @@ module OsoCloud
       def post_query(data)
         params = {}
         data = OsoCloud::Helpers.to_hash(data)
-        url = "/query"
+        url = '/query'
         result = POST(url, params, data)
         QueryResult.new(**result)
       end
 
-      def get_stats()
+      def get_stats
         params = {}
         data = nil
-        url = "/stats"
+        url = '/stats'
         result = GET(url, params, data)
         StatsResult.new(**result)
       end
 
-      def clear_data()
+      def clear_data
         params = {}
         data = nil
-        url = "/clear_data"
+        url = '/clear_data'
         result = POST(url, params, data)
         ApiResult.new(**result)
       end
 
-
       # hard-coded, not generated
       def get_facts(predicate, args)
         params = {}
-        params["predicate"] = predicate
+        params['predicate'] = predicate
         args.each_with_index do |arg, i|
+          next if arg.nil?
+
           arg_query = OsoCloud::Helpers.extract_arg_query(arg)
           if arg_query
             params["args.#{i}.type"] = arg_query.type
@@ -372,24 +377,26 @@ module OsoCloud
           end
         end
         data = nil
-        url = "/facts"
+        url = '/facts'
         result = GET(url, params, data)
         result.map { |v| Fact.new(**v) }
       end
 
-      def headers()
+      def headers
         {
-          "Authorization" => "Bearer %s" % @api_key,
-          "User-Agent" => "Oso Cloud (ruby)",
-          "Accept": "application/json",
-          "Content-Type": "application/json",
-          "X-OsoApiVersion": "0"
+          'Authorization' => format('Bearer %s', @api_key),
+          'User-Agent' => 'Oso Cloud (ruby)',
+          Accept: 'application/json',
+          'Content-Type': 'application/json',
+          'X-OsoApiVersion': '0'
         }
       end
 
-      def GET(path, params, body)
-        response = @connection.get("api#{path}", params, headers )
+      def GET(path, params, _body)
+        response = @connection.get("api#{path}", params, headers)
         handle_faraday_response response
+      rescue Faraday::Error => e
+        handle_faraday_error e
       end
 
       def POST(path, params, body)
@@ -397,6 +404,8 @@ module OsoCloud
           req.params = params
         end
         handle_faraday_response response
+      rescue Faraday::Error => e
+        handle_faraday_error e
       end
 
       def DELETE(path, params, body)
@@ -404,13 +413,21 @@ module OsoCloud
           req.body = body
         end
         handle_faraday_response response
+      rescue Faraday::Error => e
+        handle_faraday_error e
       end
 
       def handle_faraday_response(response)
-        # TODO:(@patrickod) refactor duplicative JSON parsing
+        # TODO: (@patrickod) refactor duplicative JSON parsing
         JSON.parse(response.env[:raw_body], symbolize_names: true)
       end
-    end
 
+      def handle_faraday_error(error)
+        err = JSON.parse(error.response[:body], symbolize_names: true)
+        raise ApiError.new(**err)
+      rescue JSON::ParserError => e
+        raise ApiError.new(message: e.message)
+      end
+    end
   end
 end

data/lib/oso/helpers.rb

@@ -3,9 +3,9 @@ module OsoCloud
   module Helpers
     # @!visibility private
     def self.extract_value(x)
-      return OsoCloud::Core::Value.new(type: "String", id: x) if x.is_a? String
+      return OsoCloud::Core::Value.new(type: 'String', id: x) if x.is_a? String
 
-      return nil if x.nil?
+      return OsoCloud::Core::Value.new(type: nil, id: nil) if x.nil?
 
       type = (x.type.nil? ? nil : x.type.to_s)
       id = (x.id.nil? ? nil : x.id.to_s)
@@ -14,17 +14,33 @@ module OsoCloud
 
     # @!visibility private
     def self.extract_arg_query(x)
-      self.extract_value(x)
+      extract_value(x)
     end
 
     # @!visibility private
     def self.param_to_fact(predicate, args)
-      OsoCloud::Core::Fact.new(predicate: predicate, args: args.map { |a| self.extract_value(a) })
+      OsoCloud::Core::Fact.new(predicate: predicate, args: args.map { |a| extract_value(a) })
     end
 
     # @!visibility private
     def self.params_to_facts(facts)
-      facts.map { |predicate, *args| self.param_to_fact(predicate, args) }
+      facts.map { |predicate, *args| param_to_fact(predicate, args) }
+    end
+
+    # @!visibility private
+    def self.facts_to_params(facts)
+      facts.map do |f|
+        name = f.predicate
+        args = f.args.map do |a|
+          v = from_value(a)
+          if v.is_a? Hash
+            OsoCloud::Value.new(type: v[:type], id: v[:id])
+          else
+            v
+          end
+        end
+        [name, *args]
+      end
     end
 
     def self.from_value(value)
@@ -34,25 +50,24 @@ module OsoCloud
         else
           { type: value.type }
         end
+      elsif value.type == 'String'
+        value.id
       else
-        if value.type == "String"
-          value.id
-        else
-          { id: value.id, type: value.type }
-        end
+        { id: value.id, type: value.type }
       end
     end
 
     # @!visibility private
     def self.to_hash(o)
-      return o.map { |v| self.to_hash(v) } if o.is_a? Array
+      return o.map { |v| to_hash(v) } if o.is_a? Array
       return o if o.instance_variables.empty?
+
       hash = {}
-      o.instance_variables.each { |var|
-        v = var.to_s.delete("@")
+      o.instance_variables.each do |var|
+        v = var.to_s.delete('@')
         value = o.send(v)
-        hash[v] = self.to_hash(value)
-      }
+        hash[v] = to_hash(value)
+      end
       hash
     end
   end

data/lib/oso/oso.rb

@@ -10,11 +10,9 @@ require 'oso/helpers'
 # For more detailed documentation, see
 # https://www.osohq.com/docs/reference/client-apis/ruby
 module OsoCloud
-
   # Represents an object in your application, with a type and id.
   # Both "type" and "id" should be strings.
-  Value = Struct::new(:type, :id, keyword_init: true) do
-
+  Value = Struct.new(:type, :id, keyword_init: true) do
     def to_api_value
       OsoCloud::Helpers.extract_value(self)
     end
@@ -43,7 +41,7 @@ module OsoCloud
     # @param policy [String]
     # @return [nil]
     def policy(policy)
-      @api.post_policy(OsoCloud::Core::Policy.new(src: policy, filename: ""))
+      @api.post_policy(OsoCloud::Core::Policy.new(src: policy, filename: ''))
       nil
     end
 
@@ -58,18 +56,18 @@ module OsoCloud
     # @param resource [OsoCloud::Value]
     # @param context_facts [Array<fact>]
     # @return [Boolean]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def authorize(actor, action, resource, context_facts = [])
       actor_typed_id = actor.to_api_value
       resource_typed_id = resource.to_api_value
       result = @api.post_authorize(OsoCloud::Core::AuthorizeQuery.new(
-        actor_type: actor_typed_id.type,
-        actor_id: actor_typed_id.id,
-        action: action,
-        resource_type: resource_typed_id.type,
-        resource_id: resource_typed_id.id,
-        context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
-      ))
+                                     actor_type: actor_typed_id.type,
+                                     actor_id: actor_typed_id.id,
+                                     action: action,
+                                     resource_type: resource_typed_id.type,
+                                     resource_id: resource_typed_id.id,
+                                     context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
+                                   ))
       result.allowed
     end
 
@@ -84,7 +82,7 @@ module OsoCloud
     # @param resources [Array<OsoCloud::Value>]
     # @param context_facts [Array<fact>]
     # @return [Array<OsoCloud::Value>]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def authorize_resources(actor, action, resources, context_facts = [])
       return [] if resources.nil?
       return [] if resources.empty?
@@ -99,26 +97,23 @@ module OsoCloud
         actor_type: actor_typed_id.type, actor_id: actor_typed_id.id,
         action: action,
         resources: resources_extracted,
-        context_facts: OsoCloud::Helpers::params_to_facts(context_facts)
+        context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
       )
       result = @api.post_authorize_resources(data)
 
       return [] if result.results.empty?
 
-      results_lookup = Hash.new
+      results_lookup = {}
       result.results.each do |r|
         k = key.call(r.type, r.id)
-        if results_lookup[k] == nil
-          results_lookup[k] = true
-        end
+        results_lookup[k] = true if results_lookup[k].nil?
       end
 
-      results = resources.select do |r|
+      resources.select do |r|
         e = r.to_api_value
         exists = results_lookup[key.call(e.type, e.id)]
         exists
       end
-      results
     end
 
     ##
@@ -132,16 +127,16 @@ module OsoCloud
     # @param resource_type [String]
     # @param context_facts [Array<fact>]
     # @return [Array<String>]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def list(actor, action, resource_type, context_facts = [])
       actor_typed_id = actor.to_api_value
       result = @api.post_list(OsoCloud::Core::ListQuery.new(
-        actor_type: actor_typed_id.type,
-        actor_id: actor_typed_id.id,
-        action: action,
-        resource_type: resource_type,
-        context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
-      ))
+                                actor_type: actor_typed_id.type,
+                                actor_id: actor_typed_id.id,
+                                action: action,
+                                resource_type: resource_type,
+                                context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
+                              ))
       result.results
     end
 
@@ -154,17 +149,17 @@ module OsoCloud
     # @param resource [OsoCloud::Value]
     # @param context_facts [Array<fact>]
     # @return [Array<String>]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def actions(actor, resource, context_facts = [])
       actor_typed_id = actor.to_api_value
       resource_typed_id = resource.to_api_value
       result = @api.post_actions(OsoCloud::Core::ActionsQuery.new(
-        actor_type: actor_typed_id.type,
-        actor_id: actor_typed_id.id,
-        resource_type: resource_typed_id.type,
-        resource_id: resource_typed_id.id,
-        context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
-      ))
+                                   actor_type: actor_typed_id.type,
+                                   actor_id: actor_typed_id.id,
+                                   resource_type: resource_typed_id.type,
+                                   resource_id: resource_typed_id.id,
+                                   context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
+                                 ))
       result.results
     end
 
@@ -177,7 +172,7 @@ module OsoCloud
     # @param args [*[String, OsoCloud::Value]]
     # @return [nil]
     def tell(name, *args)
-      typed_args = args.map { |a| OsoCloud::Helpers.extract_value(a)}
+      typed_args = args.map { |a| OsoCloud::Helpers.extract_value(a) }
       @api.post_facts(OsoCloud::Core::Fact.new(predicate: name, args: typed_args))
       nil
     end
@@ -189,7 +184,7 @@ module OsoCloud
     #
     # @param facts [Array<fact>]
     # @return [nil]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def bulk_tell(facts)
       @api.post_bulk_load(OsoCloud::Helpers.params_to_facts(facts))
       nil
@@ -217,12 +212,32 @@ module OsoCloud
     #
     # @param facts [Array<fact>]
     # @return [nil]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def bulk_delete(facts)
       @api.post_bulk_delete(OsoCloud::Helpers.params_to_facts(facts))
       nil
     end
 
+    ##
+    # Transactionally delete and insert fact(s)
+    #
+    # Delete(s) are processed before insertion(s). nil arguments in facts to be
+    # deleted act as wildcards. Does not throw an error if facts to be deleted
+    # are not found or facts to be inserted already exist.
+    #
+    #
+    # Throws an OsoCloud::Core::Api exception if error returned from server.
+    #
+    # @param delete [Array<fact>]
+    # @param insert [Array<fact>]
+    # @return [nil]
+    # @see Oso for more information about facts
+    def bulk(delete: [], insert: [])
+      @api.post_bulk(OsoCloud::Core::Bulk.new(delete: OsoCloud::Helpers.params_to_facts(delete),
+                                              tell: OsoCloud::Helpers.params_to_facts(insert)))
+      nil
+    end
+
     ##
     # List facts
     #
@@ -233,23 +248,27 @@ module OsoCloud
     # @param name [String]
     # @param args [*[String, OsoCloud::Value, nil]]
     # @return [Array<fact>]
-    # @see Oso more information about facts
+    # @see Oso for more information about facts
     def get(name, *args)
-      @api.get_facts(name, args).map do |f|
-        name = f.predicate
-        args = f.args.map do |a|
-          v = OsoCloud::Helpers.from_value(a)
-          if v.is_a? Hash
-            OsoCloud::Value.new(type: v[:type], id: v[:id])
-          else
-            v
-          end
-        end
-        [name, *args]
-      end
+      OsoCloud::Helpers.facts_to_params(@api.get_facts(name, args))
     end
 
-
-    # TODO query, bulk
+    ##
+    # List added and derived facts
+    #
+    # Lists facts that are stored in Oso Cloud in addition to derived facts
+    # from evaluating the policy. nil arguments operate as wildcards.
+    #
+    # @param name [String]
+    # @param args [Array<[String, OsoCloud::Value, nil]>]
+    # @param context_facts [Array<fact>]
+    # @return [Array<fact>]
+    # @see Oso for more information about facts
+    def query(name, *args, context_facts: [])
+      typed_args = args.map { |a| OsoCloud::Helpers.extract_value(a) }
+      result = @api.post_query(OsoCloud::Core::Query.new(fact: OsoCloud::Helpers.param_to_fact(name, typed_args),
+                                                         context_facts: OsoCloud::Helpers.params_to_facts(context_facts)))
+      OsoCloud::Helpers.facts_to_params(result.results)
+    end
   end
 end

data/lib/oso/version.rb

@@ -1,3 +1,3 @@
 module OsoCloud
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-cloud
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Oso Security, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - README.md