oso-cloud 1.7.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d81ade4fd246a2398c1a0224ecc8a6ff3852b968e03c0c79c1d28295358cfd
-  data.tar.gz: cdfa7bb5f957f1aaf7d801d8b5bca4e3e2dc4b1df8044d9cc30114aae5d012fe
+  metadata.gz: '09a0acf3356e34f0288272f0bf655b9894da2dff0493e147213241d04e1f2abd'
+  data.tar.gz: d0a7c5adc5c08f845cd22bca5f6cd40ec00a57ceab7c6e3a4ff9174e1582299f
 SHA512:
-  metadata.gz: dc3fa7da1c706b47ffe89e6d9ed03ed9950cb8c756051ef2cc3e7ed81e2931f34dbdad8e6c8e217f9d061a4c9a2d5ad36784acdbba0772a3d16102bc43d8e09f
-  data.tar.gz: e48be352ec530bfb99afe81723abbfca673a9c63d295388d68f34bebf97b973a8c911d68133cc11668622cef26553cb92e5336346b1410d081bd1dac41c9c881
+  metadata.gz: ad73f20bdd9a4443d871c7a234ca616dbc64e05f157fa0f529535fbd13d45d8897eb437c15df79a4c3c7eb79a5fd257ce4b8a36d2c671d1ed2c0e939f967d662
+  data.tar.gz: 57b85901e6aa9bc8c337d993b8f29c12b04eea2224c34156e48ef22a5a0389acc8476fd6f44b76caf80299f52b942e3614d8613623c80b488e93ffee9b46890a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-cloud (1.7.1)
+    oso-cloud (1.9.0)
       faraday (~> 2.5.2)
       faraday-net_http_persistent (~> 2.0)
       faraday-retry (~> 2.0.0)

data/README.md

@@ -32,7 +32,7 @@ architecture, check out the
 - To get up and running with Oso Cloud, try the
   [Quickstart guide](https://www.osohq.com/docs/get-started/quickstart).
 - For method-level documentation, see the
-  [Ruby Client API documentation](https://www.osohq.com/docs/reference/client-apis/ruby).
+  [Ruby Client API documentation](https://www.osohq.com/docs/app-integration/client-apis/ruby).
 - Full documentation is available at
   [osohq.com/docs](https://www.osohq.com/docs).
 - To learn about authorization best practices (not specific to Oso), read the

data/lib/oso/api.rb

@@ -80,10 +80,10 @@ module OsoCloud
 
       def initialize(metadata:)
         @metadata = if metadata.is_a? PolicyMetadata
-          metadata
-        else
-          PolicyMetadata.new(**metadata)
-        end
+                      metadata
+                    else
+                      PolicyMetadata.new(**metadata)
+                    end
       end
     end
 
@@ -293,7 +293,7 @@ module OsoCloud
           faraday.response :raise_error
           faraday.response :json, parser_options: { symbolize_names: true }
           faraday.request :retry, {
-            max: (options && options[:max_retries]) || 10,
+            max: (options && options[:max_retries]) || 3,
             interval: 0.01,
             interval_randomness: 0.005,
             max_interval: 1,
@@ -301,7 +301,7 @@ module OsoCloud
             retry_statuses: [429, 500, 502, 503, 504],
             # This is the default set of methods plus POST.
             # ref: https://github.com/lostisland/faraday-retry#specify-which-methods-will-be-retried
-            methods: %i[delete get head options post put],
+            methods: %i[delete get head options post put]
           }
 
           if options && options[:test_adapter]
@@ -336,12 +336,23 @@ module OsoCloud
         @client_id = SecureRandom.uuid
       end
 
-      def fallback_eligible(path)
-        !@fallback_connection.nil? && ['/authorize',
-                                       '/authorize_resources',
-                                       '/list',
-                                       '/actions',
-                                       '/query'].include?(path)
+      def fallback_eligible(path, method:)
+        path_eligible = if method == 'get'
+                          ['/facts', '/policy_metadata'].include?(path)
+                        elsif method == 'post'
+                          ['/authorize',
+                           '/authorize_resources',
+                           '/list',
+                           '/actions',
+                           '/query',
+                           '/authorize_query',
+                           '/list_query',
+                           '/actions_query'].include?(path)
+                        else
+                          false
+                        end
+
+        !@fallback_connection.nil? && path_eligible
       end
 
       def get_policy
@@ -496,13 +507,14 @@ module OsoCloud
 
       def GET(path, params)
         begin
-          response = @connection.get("api#{path}")  do |req|
+          response = @connection.get("api#{path}") do |req|
             req.params = params unless params.nil?
             req.headers = headers
           end
           response.body
-        rescue Faraday::ServerError, Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::SSLError => e
-          raise e unless fallback_eligible(path)
+        rescue Faraday::BadRequestError, Faraday::ServerError, Faraday::ConnectionFailed, Faraday::TimeoutError,
+               Faraday::SSLError => e
+          raise e unless fallback_eligible(path, method: 'get')
 
           response = @fallback_connection.get("api#{path}") do |req|
             req.params = params unless params.nil?
@@ -515,6 +527,14 @@ module OsoCloud
       end
 
       def POST(path, params, body, isMutation)
+        max_body_size = 10 * 1024 * 1024
+        hash = OsoCloud::Helpers.to_hash(body) unless body.nil?
+        json_str = JSON.generate(hash)
+        body_size_bytes = json_str&.bytesize || 0
+        if body_size_bytes > max_body_size
+          raise ApiError.new(message: "Request payload too large (body_size_bytes: #{body_size_bytes}, max_body_size #{max_body_size})")
+        end
+
         begin
           response = @connection.post("api#{path}") do |req|
             req.params = params unless params.nil?
@@ -522,13 +542,12 @@ module OsoCloud
             req.headers = headers
           end
 
-          if isMutation
-            @last_offset = response.headers[:OsoOffset]
-          end
+          @last_offset = response.headers[:OsoOffset] if isMutation
           response.body
         # only attempt fallback on 5xx, and connection failure conditions
-        rescue Faraday::ServerError, Faraday::ConnectionFailed, Faraday::TimeoutError, Faraday::SSLError => e
-          raise e unless fallback_eligible(path)
+        rescue Faraday::BadRequestError, Faraday::ServerError, Faraday::ConnectionFailed, Faraday::TimeoutError,
+               Faraday::SSLError => e
+          raise e unless fallback_eligible(path, method: 'post')
 
           response = @fallback_connection.post("api#{path}") do |req|
             req.params = params unless params.nil?
@@ -542,6 +561,14 @@ module OsoCloud
       end
 
       def DELETE(path, body)
+        max_body_size = 10 * 1024 * 1024
+        hash = OsoCloud::Helpers.to_hash(body) unless body.nil?
+        json_str = JSON.generate(hash)
+        body_size_bytes = json_str&.bytesize || 0
+        if body_size_bytes > max_body_size
+          raise ApiError.new(message: "Request payload too large (body_size_bytes: #{body_size_bytes}, max_body_size #{max_body_size})")
+        end
+
         response = @connection.delete("api#{path}") do |req|
           req.headers = headers
           req.body = OsoCloud::Helpers.to_hash(body) unless body.nil?
@@ -554,16 +581,16 @@ module OsoCloud
       def handle_faraday_error(error)
         resp = error.response
         formatted_request_id = if resp.nil? || resp[:headers].nil? || resp[:headers]['X-Request-ID'].nil?
-          ""
-        else
-          " (Request ID: " + resp[:headers]['X-Request-ID'] + ")"
-        end
+                                 ''
+                               else
+                                 ' (Request ID: ' + resp[:headers]['X-Request-ID'] + ')'
+                               end
 
         err = if resp.nil? || resp[:body].nil? || resp[:body][:message].nil?
-          error.message
-        else
-          resp[:body][:message]
-        end
+                error.message
+              else
+                resp[:body][:message]
+              end
         raise ApiError.new(message: err + formatted_request_id)
       end
     end

data/lib/oso/oso.rb

@@ -8,7 +8,7 @@ require 'oso/helpers'
 
 ##
 # For more detailed documentation, see
-# https://www.osohq.com/docs/reference/client-apis/ruby
+# https://www.osohq.com/docs/app-integration/client-apis/ruby
 module OsoCloud
   # Represents an object in your application, with a type and id.
   # Both "type" and "id" should be strings.
@@ -41,8 +41,9 @@ module OsoCloud
     # @param actor [OsoCloud::Value]
     # @param action [String]
     # @param resource [OsoCloud::Value]
+    # @param context_facts [Array<fact>]
     # @return [String]
-    def authorize_local(actor, action, resource)
+    def authorize_local(actor, action, resource, context_facts = [])
       actor_typed_id = actor.to_api_value
       resource_typed_id = resource.to_api_value
       result = @api.post_authorize_query(
@@ -52,7 +53,7 @@ module OsoCloud
           action: action,
           resource_type: resource_typed_id.type,
           resource_id: resource_typed_id.id,
-          context_facts: []
+          context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
         )
       )
       result.sql
@@ -67,8 +68,9 @@ module OsoCloud
     # @param action [String]
     # @param resource_type [String]
     # @param column [String]
+    # @param context_facts [Array<fact>]
     # @return [String]
-    def list_local(actor, action, resource_type, column)
+    def list_local(actor, action, resource_type, column, context_facts = [])
       actor_typed_id = actor.to_api_value
       result = @api.post_list_query(
         query: OsoCloud::Core::ListQuery.new(
@@ -76,7 +78,7 @@ module OsoCloud
           actor_id: actor_typed_id.id,
           action: action,
           resource_type: resource_type,
-          context_facts: []
+          context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
         ),
         column: column
       )
@@ -90,8 +92,9 @@ module OsoCloud
     #
     # @param actor [OsoCloud::Value]
     # @param resource [OsoCloud::Value]
+    # @param context_facts [Array<fact>]
     # @return [String]
-    def actions_local(actor, resource)
+    def actions_local(actor, resource, context_facts = [])
       actor_typed_id = actor.to_api_value
       resource_typed_id = resource.to_api_value
       result = @api.post_actions_query(
@@ -100,7 +103,7 @@ module OsoCloud
           actor_id: actor_typed_id.id,
           resource_type: resource_typed_id.type,
           resource_id: resource_typed_id.id,
-          context_facts: []
+          context_facts: OsoCloud::Helpers.params_to_facts(context_facts)
         )
       )
       result.sql

data/lib/oso/version.rb

@@ -1,3 +1,3 @@
 module OsoCloud
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-cloud
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Oso Security, Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-06 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '7.0'
-description: 
+description:
 email:
 - support@osohq.com
 executables: []
@@ -119,7 +119,7 @@ homepage: https://www.osohq.com/
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -135,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.33
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Oso Cloud Ruby client
 test_files: []