auth0 4.14.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc1dbd26961a59010e19ffa75076a5e28080735900aaaf4c9c8537656094809e
-  data.tar.gz: 27520c6efd37f253b532d6521b5e46599d9a093dd46500d46997ff3e7f9030ad
+  metadata.gz: 7d5a0bd117bd194aa40c596db3da2cce8f1d73e155e725408fad834453b9c8bc
+  data.tar.gz: bb572e0e64599762214ea303a943dba8f0ac6685c9e2241a6a5381b9a63a8591
 SHA512:
-  metadata.gz: a95ccde21a047bd9689f04cb972caf49d7a1cfb409bb72275b0bd0464d6c75f29d1ddb2475ec377b619230c71dfa13f08543557c33a8fc93f40521c322b190d7
-  data.tar.gz: fe75df00376402b03ba921d0bd7bba8d1df3c725966f282bca92948ba18a7343a1c544edc2b722e98b963678d7469d884204e1579d3bf9056fa65574fd4df851
+  metadata.gz: 6905e324867b2d9f5127d05a2bbcbefb00f781bb472c572d0f81903aca19602676b22f05b5933d34364758b1cca72fde4b2ee3474c1299203e18a93e528f84e5
+  data.tar.gz: 441bfbbc17cbb148b11a11885f6fe41fd9157a93909b9cbb476aba5fde96419a89eb478d4ead1075d1689068164f4f26d509b0b5c6e8d15c6d6a44f9b1540f3d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## [v4.15.0](https://github.com/auth0/ruby-auth0/tree/v4.15.0) (2020-09-04)
+
+**Added**
+
+- Add log streaming endpoints [\#233](https://github.com/auth0/ruby-auth0/pull/233) ([davidpatrick](https://github.com/davidpatrick))
+
 ## [v4.14.0](https://github.com/auth0/ruby-auth0/tree/v4.14.0) (2020-07-20)
 
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v4.13.0...v4.14.0)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    auth0 (4.14.0)
+    auth0 (4.15.0)
       jwt (~> 2.2.0)
       rest-client (~> 2.0.0)
       zache (~> 0.12.0)
@@ -32,13 +32,11 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     builder (3.2.4)
-    codecov (0.2.2)
-      colorize
+    codecov (0.2.9)
       json
       simplecov
     coderay (1.1.3)
-    colorize (0.8.1)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     coveralls (0.7.1)
       multi_json (~> 1.3)
       rest-client
@@ -82,23 +80,23 @@ GEM
     hashdiff (1.0.1)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.8.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     json (2.3.1)
-    jwt (2.2.1)
+    jwt (2.2.2)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.6.0)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    lumberjack (1.2.6)
+    lumberjack (1.2.8)
     method_source (0.8.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
     mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    minitest (5.14.2)
     multi_json (1.15.0)
     nenv (0.3.0)
     netrc (0.11.0)
@@ -116,7 +114,7 @@ GEM
       slop (~> 3.4)
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rack (2.1.4)
     rack-test (0.8.3)
       rack (>= 1.0, < 3)
@@ -155,25 +153,25 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.88.0)
+    rubocop (0.90.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.2.0)
-      parser (>= 2.7.0.1)
-    rubocop-rails (2.7.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-rails (2.7.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 0.87.0)
     ruby-progressbar (1.10.1)
     safe_yaml (1.0.5)
     shellany (0.0.1)
-    simplecov (0.18.5)
+    simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)

data/lib/auth0/api/v2.rb

@@ -16,6 +16,7 @@ require 'auth0/api/v2/user_blocks'
 require 'auth0/api/v2/tenants'
 require 'auth0/api/v2/tickets'
 require 'auth0/api/v2/logs'
+require 'auth0/api/v2/log_streams'
 require 'auth0/api/v2/resource_servers'
 require 'auth0/api/v2/guardian'
 
@@ -41,6 +42,7 @@ module Auth0
       include Auth0::Api::V2::Tenants
       include Auth0::Api::V2::Tickets
       include Auth0::Api::V2::Logs
+      include Auth0::Api::V2::LogStreams
       include Auth0::Api::V2::ResourceServers
       include Auth0::Api::V2::Guardian
     end

data/lib/auth0/api/v2/log_streams.rb

@@ -0,0 +1,78 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the log streams endpoints
+      module LogStreams
+        attr_reader :log_streams_path
+
+        # Retrieves a list of all log streams.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams
+        # @return [json] Returns the log streams.
+        def log_streams()
+          get(log_streams_path)
+        end
+        alias get_log_streams log_streams
+
+        # Retrieves a log stream by its ID.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams_by_id
+        # @param id [string] The id of the log stream to retrieve.
+        #
+        # @return [json] Returns the log stream.
+        def log_stream(id)
+          raise Auth0::InvalidParameter, 'Must supply a valid log stream id' if id.to_s.empty?
+          path = "#{log_streams_path}/#{id}"
+          get(path)
+        end
+        alias get_log_stream log_stream
+
+        # Creates a new log stream according to the JSON object received in body.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/post_log_streams
+        # @param name [string] The name of the log stream.
+        # @param type [string] The type of log stream
+        # @param options [hash] The Hash options used to define the log streams's properties.
+        #
+        # @return [json] Returns the log stream.
+        def create_log_stream(name, type, options)
+          raise Auth0::InvalidParameter, 'Name must contain at least one character' if name.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a valid type' if type.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid hash for options' unless options.is_a? Hash
+
+          request_params = {}
+          request_params[:name] = name
+          request_params[:type] = type
+          request_params[:sink] = options
+          post(log_streams_path, request_params)
+        end
+
+        # Deletes a log stream by its ID.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/delete_log_streams_by_id
+        # @param id [string] The id of the log stream to delete.
+        def delete_log_stream(id)
+          raise Auth0::InvalidParameter, 'Must supply a valid log stream id' if id.to_s.empty?
+          path = "#{log_streams_path}/#{id}"
+          delete(path)
+        end
+
+        # Updates a log stream.
+        # @see https://auth0.com/docs/api/management/v2#!/Log_Streams/patch_log_streams_by_id
+        # @param id [string] The id or audience of the log stream to update.
+        # @param status [string] The Hash options used to define the log streams's properties.
+        def patch_log_stream(id, status)
+          raise Auth0::InvalidParameter, 'Must specify a log stream id' if id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a valid status' if status.to_s.empty?
+
+          request_params = {}
+          request_params[:status] = status
+          path = "#{log_streams_path}/#{id}"
+          patch(path, request_params)
+        end
+        
+        private
+        # Log Streams API path
+        def log_streams_path
+          @log_streams_path ||= '/api/v2/log-streams'
+        end
+      end
+    end
+  end
+end

data/lib/auth0/version.rb

@@ -1,4 +1,4 @@
 # current version of gem
 module Auth0
-  VERSION = '4.14.0'.freeze
+  VERSION = '4.15.0'.freeze
 end

data/spec/lib/auth0/api/v2/log_streams_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+describe Auth0::Api::V2::LogStreams do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::LogStreams)
+    dummy_instance.extend(Auth0::Mixins::Initializer)
+    @instance = dummy_instance
+  end
+
+  context '.log_streams' do
+    it { expect(@instance).to respond_to(:log_streams) }
+    it { expect(@instance).to respond_to(:get_log_streams) }
+    it 'is expected to call get /api/v2/log-streams' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/log-streams'
+      )
+      expect { @instance.log_streams }.not_to raise_error
+    end
+  end
+
+  context '.log_stream' do
+    it { expect(@instance).to respond_to(:log_stream) }
+    it 'is expected to call get /api/v2/log-streams/test' do
+      expect(@instance).to receive(:get).with('/api/v2/log-streams/test')
+      expect { @instance.log_stream('test') }.not_to raise_error
+    end
+    it 'expect to raise an error when calling with empty log stream id' do
+      expect { @instance.log_stream(nil) }.to raise_error 'Must supply a valid log stream id'
+    end
+  end
+
+  context '.create_log_stream' do
+    it { expect(@instance).to respond_to(:create_log_stream) }
+    it 'is expected to call post /api/v2/log-streams' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/log-streams',
+        name: 'test',
+        type: 'https',
+        sink: {
+          httpEndpoint: "https://mycompany.com",
+          httpContentType: "string",
+          httpContentFormat: "JSONLINES",
+          httpAuthorization: "string"
+        }
+      )
+
+      @instance.create_log_stream('test', 'https',
+        httpEndpoint: "https://mycompany.com",
+        httpContentType: "string",
+        httpContentFormat: "JSONLINES",
+        httpAuthorization: "string")
+    end
+    it 'expect to raise an error when calling with empty name' do
+      expect { @instance.create_log_stream('', '', '') }.to raise_error 'Name must contain at least one character'
+    end
+    it 'expect to raise an error when calling with empty type' do
+      expect { @instance.create_log_stream('name', '', '') }.to raise_error 'Must specify a valid type'
+    end
+    it 'expect to raise an error when calling without options' do
+      expect { @instance.create_log_stream('name', 'https', nil) }.to raise_error 'Must supply a valid hash for options'
+    end
+  end
+
+  context '.delete_log_stream' do
+    it { expect(@instance).to respond_to(:delete_log_stream) }
+    it 'is expected to call delete /api/v2/log-streams/test' do
+      expect(@instance).to receive(:delete).with('/api/v2/log-streams/test')
+      expect { @instance.delete_log_stream('test') }.not_to raise_error
+    end
+    it 'expect to raise an error when calling with empty log stream id' do
+      expect { @instance.delete_log_stream(nil) }.to raise_error 'Must supply a valid log stream id'
+    end
+  end
+
+  context '.patch_log_stream' do
+    it { expect(@instance).to respond_to(:patch_log_stream) }
+    it 'is expected to send patch to /api/v2/log_streams/test' do
+      expect(@instance).to receive(:patch).with('/api/v2/log-streams/test', status: 'paused')
+      expect { @instance.patch_log_stream('test', 'paused') }.not_to raise_error
+    end
+    it { expect { @instance.patch_log_stream('', nil) }.to raise_error 'Must specify a log stream id' }
+    it { expect { @instance.patch_log_stream('test', nil) }.to raise_error 'Must specify a valid status' }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auth0
 version: !ruby/object:Gem::Version
-  version: 4.14.0
+  version: 4.15.0
 platform: ruby
 authors:
 - Auth0
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -143,22 +143,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -368,6 +368,7 @@ files:
 - lib/auth0/api/v2/emails.rb
 - lib/auth0/api/v2/guardian.rb
 - lib/auth0/api/v2/jobs.rb
+- lib/auth0/api/v2/log_streams.rb
 - lib/auth0/api/v2/logs.rb
 - lib/auth0/api/v2/prompts.rb
 - lib/auth0/api/v2/resource_servers.rb
@@ -589,6 +590,7 @@ files:
 - spec/lib/auth0/api/v2/emails_spec.rb
 - spec/lib/auth0/api/v2/guardian_spec.rb
 - spec/lib/auth0/api/v2/jobs_spec.rb
+- spec/lib/auth0/api/v2/log_streams_spec.rb
 - spec/lib/auth0/api/v2/logs_spec.rb
 - spec/lib/auth0/api/v2/prompts_spec.rb
 - spec/lib/auth0/api/v2/resource_servers_spec.rb
@@ -630,7 +632,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Auth0 API Client
@@ -832,6 +834,7 @@ test_files:
 - spec/lib/auth0/api/v2/emails_spec.rb
 - spec/lib/auth0/api/v2/guardian_spec.rb
 - spec/lib/auth0/api/v2/jobs_spec.rb
+- spec/lib/auth0/api/v2/log_streams_spec.rb
 - spec/lib/auth0/api/v2/logs_spec.rb
 - spec/lib/auth0/api/v2/prompts_spec.rb
 - spec/lib/auth0/api/v2/resource_servers_spec.rb