cased-ruby 0.3.3 → 0.4.0

data/lib/cased/clients.rb

@@ -4,10 +4,10 @@ require 'cased/http/client'
 
 module Cased
   class Clients
-    def self.create(api_key:, url: nil)
+    def self.create(api_key:, url: nil, raise_on_errors: false)
       url ||= Cased.config.api_url
 
-      Cased::HTTP::Client.new(url: url, api_key: api_key)
+      Cased::HTTP::Client.new(url: url, api_key: api_key, raise_on_errors: raise_on_errors)
     end
 
     def organization
@@ -15,7 +15,11 @@ module Cased
     end
 
     def publish
-      @publish ||= self.class.create(url: Cased.config.publish_url, api_key: Cased.config.publish_key)
+      @publish ||= self.class.create(url: Cased.config.publish_url, api_key: Cased.config.publish_key, raise_on_errors: true)
+    end
+
+    def cli
+      @cli ||= self.class.create(api_key: Cased.config.guard_application_key)
     end
   end
 end

data/lib/cased/config.rb

@@ -37,6 +37,33 @@ module Cased
     #    end
     attr_accessor :api_url
 
+    # @example
+    #    GUARD_APPLICATION_KEY="guard_application_1ntKX0P4vUbKoc0lMWGiSbrBHcH" rails server
+    #
+    # @example
+    #    Cased.configure do |config|
+    #      config.guard_application_key = "guard_application_1ntKX0P4vUbKoc0lMWGiSbrBHcH"
+    #    end
+    attr_accessor :guard_application_key
+
+    # @example
+    #    GUARD_USER_TOKEN="user_1oFqlROLNRGVLOXJSsHkJiVmylr" rails server
+    #
+    # @example
+    #    Cased.configure do |config|
+    #      config.guard_user_token = "user_1oFqlROLNRGVLOXJSsHkJiVmylr"
+    #    end
+    attr_accessor :guard_user_token
+
+    # @example
+    #    DENY_IF_UNREACHABLE="1" rails server
+    #
+    # @example
+    #    Cased.configure do |config|
+    #      config.guard_deny_if_unreachable = true
+    #    end
+    attr_accessor :guard_deny_if_unreachable
+
     # The URL to publish audit events to. Defaults to https://publish.cased.com
     #
     # @example
@@ -115,6 +142,9 @@ module Cased
       @raise_on_errors = !ENV['CASED_RAISE_ON_ERRORS'].nil?
       @api_url = ENV.fetch('CASED_API_URL', 'https://api.cased.com')
       @publish_url = ENV.fetch('CASED_PUBLISH_URL', 'https://publish.cased.com')
+      @guard_application_key = ENV['GUARD_APPLICATION_KEY']
+      @guard_user_token = ENV['GUARD_USER_TOKEN']
+      @guard_deny_if_unreachable = parse_bool(ENV['DENY_IF_UNREACHABLE'])
       @publish_key = ENV['CASED_PUBLISH_KEY']
       @silence = !ENV['CASED_SILENCE'].nil?
       @policy_keys = Hash.new do |hash, key|
@@ -168,5 +198,15 @@ module Cased
     def silence?
       @silence || !ENV['CASED_SILENCE'].nil?
     end
+
+    def guard_deny_if_unreachable?
+      @guard_deny_if_unreachable
+    end
+
+    private
+
+    def parse_bool(val)
+      %w[1 true t].include?(val&.downcase)
+    end
   end
 end

data/lib/cased/http/client.rb

@@ -7,8 +7,9 @@ require 'faraday_middleware'
 module Cased
   module HTTP
     class Client
-      def initialize(url:, api_key:)
-        @client = Faraday.new(url: url) do |conn|
+      def initialize(url:, api_key:, raise_on_errors: false)
+        @raise_on_errors = raise_on_errors
+        @client = ::Faraday.new(url: url) do |conn|
           conn.headers[:user_agent] = "cased-ruby/v#{Cased::VERSION}"
           conn.headers[:content_type] = 'application/json'
           conn.headers[:accept] = 'application/json'
@@ -72,11 +73,17 @@ module Cased
 
       def request(method, url = nil, params_or_body = nil, headers = nil, &block)
         response = @client.send(method, url, params_or_body, headers, &block)
-        return response if response.success?
 
-        # TODO: Look to return a Cased::Response here with error wrapped.
-        klass = Cased::HTTP::Error.class_from_response(response)
-        raise klass.from_response(response)
+        if !response.success? && raise_on_errors?
+          klass = Cased::HTTP::Error.class_from_response(response)
+          raise klass.from_response(response)
+        else
+          response
+        end
+      end
+
+      def raise_on_errors?
+        @raise_on_errors
       end
     end
   end

data/lib/cased/http/error.rb

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
 require 'cased/error'
+require 'json'
 
 module Cased
   module HTTP
     class Error < Cased::Error
       attr_reader :code
+      attr_reader :json
 
-      def initialize(message = '', code = nil)
-        super(message)
+      def initialize(json = {}, code = nil)
+        @json = json
         @code = code
+        super(JSON.dump(@json))
       end
 
       def self.from_response(response)

data/lib/cased/query.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require 'cased/collection_response'
+require 'forwardable'
 
 module Cased
   class Query
+    extend Forwardable
+
     # @param client [Cased::HTTP::Client] the HTTP client authorized to query an
     #   audit trail policy
     # @param phrase [String, nil] the phrase to search for audit trail events
@@ -43,7 +46,8 @@ module Cased
     end
 
     # If any of these methods are called we need the request to fulfil the response.
-    delegate :results, \
+    def_delegators :response, \
+      :results, \
       :total_count, \
       :total_pages, \
       :next_page_url?, \
@@ -64,8 +68,7 @@ module Cased
       :last_page?, \
       :error, \
       :error?, \
-      :success?, \
-      to: :response
+      :success?
 
     def response
       return @response if defined?(@response)

data/lib/cased/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cased
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cased-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Garrett Bjerkhoel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: subprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -267,11 +295,21 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/cli
 - bin/console
 - bin/rubocop
 - cased-ruby.gemspec
 - lib/cased-ruby.rb
 - lib/cased.rb
+- lib/cased/cli.rb
+- lib/cased/cli/asciinema/file.rb
+- lib/cased/cli/asciinema/writer.rb
+- lib/cased/cli/authentication.rb
+- lib/cased/cli/identity.rb
+- lib/cased/cli/interactive_session.rb
+- lib/cased/cli/log.rb
+- lib/cased/cli/recorder.rb
+- lib/cased/cli/session.rb
 - lib/cased/clients.rb
 - lib/cased/collection_response.rb
 - lib/cased/config.rb
@@ -305,21 +343,23 @@ files:
 - lib/cased/sensitive/string.rb
 - lib/cased/test_helper.rb
 - lib/cased/version.rb
-- vendor/cache/activesupport-6.0.3.4.gem
+- vendor/cache/activesupport-6.1.3.gem
 - vendor/cache/addressable-2.7.0.gem
 - vendor/cache/ast-2.4.0.gem
 - vendor/cache/byebug-11.0.1.gem
-- vendor/cache/concurrent-ruby-1.1.7.gem
+- vendor/cache/concurrent-ruby-1.1.8.gem
 - vendor/cache/connection_pool-2.2.2.gem
 - vendor/cache/crack-0.4.3.gem
 - vendor/cache/docile-1.3.2.gem
 - vendor/cache/dotpath-0.1.0.gem
-- vendor/cache/faraday-1.1.0.gem
+- vendor/cache/faraday-1.3.0.gem
+- vendor/cache/faraday-net_http-1.0.1.gem
 - vendor/cache/faraday_middleware-1.0.0.gem
 - vendor/cache/hashdiff-1.0.1.gem
-- vendor/cache/i18n-1.8.5.gem
+- vendor/cache/i18n-1.8.9.gem
 - vendor/cache/jaro_winkler-1.5.4.gem
-- vendor/cache/json-2.3.1.gem
+- vendor/cache/json-2.5.1.gem
+- vendor/cache/jwt-2.2.2.gem
 - vendor/cache/minitest-5.13.0.gem
 - vendor/cache/mocha-1.11.2.gem
 - vendor/cache/multipart-post-2.1.1.gem
@@ -335,17 +375,17 @@ files:
 - vendor/cache/rubocop-0.78.0.gem
 - vendor/cache/rubocop-performance-1.5.2.gem
 - vendor/cache/ruby-progressbar-1.10.1.gem
-- vendor/cache/ruby2_keywords-0.0.2.gem
+- vendor/cache/ruby2_keywords-0.0.4.gem
 - vendor/cache/safe_yaml-1.0.5.gem
 - vendor/cache/sidekiq-6.0.7.gem
 - vendor/cache/simplecov-0.18.5.gem
 - vendor/cache/simplecov-html-0.12.2.gem
-- vendor/cache/thread_safe-0.3.6.gem
-- vendor/cache/tzinfo-1.2.7.gem
+- vendor/cache/subprocess-1.5.4.gem
+- vendor/cache/tzinfo-2.0.4.gem
 - vendor/cache/unicode-display_width-1.6.1.gem
 - vendor/cache/webmock-3.8.3.gem
 - vendor/cache/yard-0.9.24.gem
-- vendor/cache/zeitwerk-2.4.0.gem
+- vendor/cache/zeitwerk-2.4.2.gem
 homepage: https://github.com/cased/cased-ruby
 licenses:
 - MIT