warrant 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8782e5ba0cc2c866761a7c4d906eebe324202b9ea12a14f50b0f250c62483c20
-  data.tar.gz: cfe03ef0070f0e60d8c88f1a8e636c93eb7265d5a367e6f1d99cb787a2e0aff3
+  metadata.gz: eedc398b4f1277eabdabf8252acde068e1a1398f0b3752d217793ec1d22570b3
+  data.tar.gz: 035f98bda116c4177ead75b9895a86582b2b37fd7d04b1b2175e68f73c0adff5
 SHA512:
-  metadata.gz: 7e7a48c244de2fa3a9e402682c3775f84e429e1330404dc1b06281dd5c689379cb974e47c6fc0fc0b8175d52edbaea34e893946c3bcbec029d7d579201e05ffc
-  data.tar.gz: 966d6a67910a9d001f26a592fc226813b9d82acd61b2cb684c84fff8adc9e1b63e50970c366c217022f5bf5a57316d977f1d0736930c038a9af79171f99dd2f1
+  metadata.gz: b5d81834bffb0ac19ed371259e6b321ca23aa42a8ab0dd1bcf8c720fec168910ed8dcfe620942d17d4d399834593856080dbe802f786d273466db347089b10b4
+  data.tar.gz: 717cce9e98093c01c7412323894e7eb9f87742ae412eac1564e8e91184a3cea327dbb76ee7d5131196389c8df7e6b5a112ed24a6ccbd270f75a0277f2356b651

data/README.md

@@ -44,13 +44,36 @@ You can also build the gem from source:
 require 'warrant'
 Warrant.api_key = 'api_test_f5dsKVeYnVSLHGje44zAygqgqXiLJBICbFzCiAg1E='
 
-# create a user
+# Create a user
 Warrant::User.create(user_id: "user123")
 
-# check whether user slp951 has view access to report 7asm24
+# Check whether user slp951 has view access to report 7asm24
 Warrant::Warrant.is_authorized?(object_type: "report", object_id: "7asm24", relation: "viewer", subject: { object_id: "user", object_id: "slp951" })
 ```
 
+## Configuring the API and Authorize Endpoints
+---
+The API and Authorize endpoints the SDK makes requests to is configurable via the `Warrant.api_base` and `Warrant.authorize_endpoint` attributes:
+
+```ruby
+require 'warrant'
+
+# Set api and authorize endpoints to http://localhost:8000
+Warrant.api_base = 'http://localhost:8000'
+Warrant.authorize_endpoint = 'http://localhost:8000'
+```
+
+## Configuring SSL
+---
+By default, the SDK will attempt to use SSL when making requests to the API. This setting is configurable via the `Warrant.use_ssl` attribute:
+
+```ruby
+require 'warrant'
+
+# Disable ssl
+Warrant.use_ssl = false
+```
+
 
 We’ve used a random API key in these code examples. Replace it with your [actual publishable API keys](https://app.warrant.dev) to
 test this code through your own Warrant account.

data/lib/warrant/api_operations.rb

@@ -4,21 +4,21 @@ module Warrant
     # @!visibility private
     class APIOperations
         class << self
-            def post(uri, params = {}, use_ssl = true)
+            def post(uri, params = {})
                 http = Net::HTTP.new(uri.host, uri.port)
-                http.use_ssl = use_ssl
+                http.use_ssl = ::Warrant.config.use_ssl
                 headers = {
-                    "Authorization": "ApiKey #{::Warrant.config.api_key}",
                     "User-Agent": "warrant-ruby/#{VERSION}"
                 }
+                headers["Authorization"] = "ApiKey #{::Warrant.config.api_key}" unless ::Warrant.config.api_key.empty?
                 http.post(uri.path, params.to_json, headers)
             end
 
             def delete(uri, params = {})
                 http = Net::HTTP.new(uri.host, uri.port)
-                http.use_ssl = true
+                http.use_ssl = ::Warrant.config.use_ssl
                 request = Net::HTTP::Delete.new(uri.path)
-                request["Authorization"] = "ApiKey #{::Warrant.config.api_key}"
+                request["Authorization"] = "ApiKey #{::Warrant.config.api_key}" unless ::Warrant.config.api_key.empty?
                 request["User-Agent"] = "warrant-ruby/#{VERSION}"
 
                 http.request(request, params.to_json)
@@ -26,11 +26,11 @@ module Warrant
 
             def get(uri, params = {})
                 http = Net::HTTP.new(uri.host, uri.port)
-                http.use_ssl = true
+                http.use_ssl = ::Warrant.config.use_ssl
                 headers = {
-                    "Authorization": "ApiKey #{::Warrant.config.api_key}",
                     "User-Agent": "warrant-ruby/#{VERSION}"
                 }
+                headers["Authorization"] = "ApiKey #{::Warrant.config.api_key}" unless ::Warrant.config.api_key.empty?
 
                 unless params.empty?
                     normalized_params = Util.normalize_params(params.compact)
@@ -42,11 +42,11 @@ module Warrant
 
             def put(uri, params = {})
                 http = Net::HTTP.new(uri.host, uri.port)
-                http.use_ssl = true
+                http.use_ssl = ::Warrant.config.use_ssl
                 headers = {
-                    "Authorization": "ApiKey #{::Warrant.config.api_key}",
                     "User-Agent": "warrant-ruby/#{VERSION}"
                 }
+                headers["Authorization"] = "ApiKey #{::Warrant.config.api_key}" unless ::Warrant.config.api_key.empty?
                 http.put(uri.path, params.to_json, headers)
             end
 

data/lib/warrant/models/warrant.rb

@@ -413,7 +413,7 @@ module Warrant
 
         def self.edge_authorize?(params = {})
             request_url = URI.parse("#{::Warrant.config.authorize_endpoint}/v2/authorize")
-            res = APIOperations.post(request_url, Util.normalize_params(params), request_url.scheme === "https")
+            res = APIOperations.post(request_url, Util.normalize_params(params))
             res_json = JSON.parse(res.body)
 
             case res

data/lib/warrant/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Warrant
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/lib/warrant/warrant_configuration.rb

@@ -3,14 +3,16 @@
 module Warrant
     # @!visibility private
     class WarrantConfiguration
-        attr_accessor :api_key, :api_base, :authorize_endpoint
+        attr_accessor :api_key, :api_base, :authorize_endpoint, :use_ssl
 
         attr_reader :self_service_dash_url_base
 
         def initialize
+            @api_key = ""
             @api_base = "https://api.warrant.dev"
             @authorize_endpoint = "https://api.warrant.dev"
             @self_service_dash_url_base = "https://self-serve.warrant.dev"
+            @use_ssl = true
         end
     end
 end

data/lib/warrant.rb

@@ -31,6 +31,6 @@ module Warrant
 
         attr_reader :config
 
-        def_delegators :@config, :api_key, :api_key=, :api_base, :api_base=, :authorize_endpoint, :authorize_endpoint=
+        def_delegators :@config, :api_key, :api_key=, :api_base, :api_base=, :authorize_endpoint, :authorize_endpoint=, :use_ssl, :use_ssl=
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warrant
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Warrant
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies: []
 description: Ruby library for the Warrant API at https://warrant.dev.
 email: hello@warrant.dev
@@ -50,7 +50,7 @@ metadata:
   source_code_uri: https://github.com/warrant-dev/warrant-ruby
   changelog_uri: https://github.com/warrant-dev/warrant-ruby/CHANGELOG.md
   documentation_uri: https://docs.warrant.dev/
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: Warrant Ruby Library
 test_files: []