dogapi 1.44.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64317943c656727e705f3ba310961de9fa8b3fda8fbcb976095d634d7311ecd
-  data.tar.gz: bb3f1977f9bd6bcd6d22779e23e247803b7800a1a0770e266d461878b68d574c
+  metadata.gz: 1ef3fbebc71af23718db2e177c11400648e47e0e770c8783021a8e7a1b7df099
+  data.tar.gz: 59ef0c8d5c187e7161a25166b468fa91c640ab568dd22992aa037b38c7461ff1
 SHA512:
-  metadata.gz: f2814b96964abfc35ade6827652aed52c0b2795aa71f47a4a8a9152d7f97a013bb18680060657df015aeb0cb925cce58a16780c67df56397256d9e4c10aa8fcc
-  data.tar.gz: f9b7cb7ec7486d40af67d12ad68e44787e3e890efb0a98a9a5093875eba00eb0c19556a6b4fd35246611ffdc4cfe3b1aa2750750d001f6e145a8fe52085aac46
+  metadata.gz: 48239d6fd49a735c74eb4c95f97093c0e599a8d11d868e784cb08ce1a96ce0a6da6b942e78afadc870fcb7e09bf0b53205c0517d502029cc17d3c3a378d5bbfa
+  data.tar.gz: 658b9c7f91b18e7744b1d3761e6e1d5212e527f293d09ba4a00f3303602262c46cf0c5743ec317e4bdb353286a1c94a9de51b86285b9513f310e7f6e72f4ca0c

data/.rubocop_todo.yml

@@ -241,6 +241,7 @@ Style/AccessorMethodName:
     - 'lib/dogapi/v1/dash.rb'
     - 'lib/dogapi/v1/dashboard.rb'
     - 'lib/dogapi/v1/embed.rb'
+    - 'lib/dogapi/v1/logs_pipeline.rb'
     - 'lib/dogapi/v1/screenboard.rb'
     - 'lib/dogapi/v1/synthetics.rb'
     - 'lib/dogapi/v1/user.rb'

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changes
 
+## 1.45.0 / 2021-01-27
+
+* [Added] Read `datadog_host` cap variable for specifying Datadog API endpoint. See [#255](https://github.com/DataDog/dogapi-rb/pull/255).
+* [Added] Added support for logs pipelines CRUD methods. See [#252](https://github.com/DataDog/dogapi-rb/pull/252). Thanks [hi-artem](https://github.com/hi-artem).
+* [Fixed] Properly handle string response code. See [#254](https://github.com/DataDog/dogapi-rb/pull/254).
+* [Fixed] Remove circular dependency. See [#253](https://github.com/DataDog/dogapi-rb/pull/253).
+
 ## 1.44.0 / 2020-12-10
 
 * [Added] Allow skipping SSL verification. See [#246](https://github.com/DataDog/dogapi-rb/pull/246).

data/Gemfile_1.9

@@ -7,4 +7,5 @@ group :test do
   gem 'rspec'
   gem 'simplecov', "~> 0.11.2"
   gem 'webmock'
+  gem 'crack', '<= 0.4.4'
 end

data/lib/capistrano/datadog.rb

@@ -28,10 +28,10 @@ module Capistrano
       @cap_version
     end
 
-    def self.submit(api_key, use_getlogin=true)
+    def self.submit(api_key, use_getlogin=true, endpoint=nil)
       begin
         if api_key
-          dog = Dogapi::Client.new(api_key)
+          dog = Dogapi::Client.new(api_key, nil, nil, nil, true, nil, endpoint, false)
           reporter.report(use_getlogin).each do |event, hosts|
             if hosts.size > 0
               hosts.each do |host|

data/lib/capistrano/datadog/v2.rb

@@ -63,9 +63,9 @@ module Capistrano
         desc 'Submit the tasks that have run to Datadog as events'
         task :submit do |ns|
           if variables[:use_getlogin].nil?
-            Capistrano::Datadog.submit variables[:datadog_api_key]
+            Capistrano::Datadog.submit variables[:datadog_api_key], true, variables[:datadog_host]
           else
-            Capistrano::Datadog.submit variables[:datadog_api_key], variables[:use_getlogin]
+            Capistrano::Datadog.submit variables[:datadog_api_key], variables[:use_getlogin], variables[:datadog_host]
           end
         end
       end

data/lib/capistrano/datadog/v3.rb

@@ -81,9 +81,10 @@ end
 at_exit do
   api_key = Capistrano::Configuration.env.fetch :datadog_api_key
   use_getlogin = Capistrano::Configuration.env.fetch :use_getlogin
+  datadog_host = Capistrano::Configuration.env.fetch :datadog_host
   if use_getlogin.nil?
-    Capistrano::Datadog.submit api_key
+    Capistrano::Datadog.submit api_key, true, datadog_host
   else
-    Capistrano::Datadog.submit api_key, use_getlogin
+    Capistrano::Datadog.submit api_key, use_getlogin, datadog_host
   end
 end

data/lib/dogapi/common.rb

@@ -183,7 +183,7 @@ module Dogapi
     end
 
     def handle_response(resp)
-      if resp.code == 204 || resp.body == '' || resp.body == 'null' || resp.body.nil?
+      if resp.code.to_i == 204 || resp.body == '' || resp.body == 'null' || resp.body.nil?
         return resp.code, {}
       end
       begin
@@ -198,7 +198,7 @@ module Dogapi
     def handle_redirect(conn, req, resp, retries=10)
       req.uri = URI.parse(resp.header['location'])
       new_response = conn.request(req)
-      if retries > 1 && new_response.code / 100 == 3
+      if retries > 1 && new_response.code.to_i / 100 == 3
         new_response = handle_redirect(conn, req, new_response, retries - 1)
       end
       new_response

data/lib/dogapi/facade.rb

@@ -108,6 +108,7 @@ module Dogapi
       @gcp_integration_svc = Dogapi::V1::GcpIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
       @service_level_objective_svc = Dogapi::V1::ServiceLevelObjectiveService.new(@api_key, @application_key, silent,
                                                                                   timeout, @datadog_host, skip_ssl_validation)
+      @logs_pipeline_svc = Dogapi::V1::LogsPipelineService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
 
       # Support for Dashboard List API v2.
       @v2 = Dogapi::ClientV2.new(@api_key, @application_key, true, true, @datadog_host, skip_ssl_validation)
@@ -717,6 +718,30 @@ module Dogapi
       @service_level_objective_svc.delete_timeframes_service_level_objective(ops)
     end
 
+    #
+    # LOGS PIPELINES
+    #
+
+    def create_logs_pipeline(name, filter, options = {})
+      @logs_pipeline_svc.create_logs_pipeline(name, filter, options)
+    end
+
+    def get_logs_pipeline(pipeline_id)
+      @logs_pipeline_svc.get_logs_pipeline(pipeline_id)
+    end
+
+    def get_all_logs_pipelines
+      @logs_pipeline_svc.get_all_logs_pipelines
+    end
+
+    def update_logs_pipeline(pipeline_id, name, filter, options = {})
+      @logs_pipeline_svc.update_logs_pipeline(pipeline_id, name, filter, options)
+    end
+
+    def delete_logs_pipeline(pipeline_id)
+      @logs_pipeline_svc.delete_logs_pipeline(pipeline_id)
+    end
+
     #
     # SERVICE CHECKS
     #

data/lib/dogapi/v1.rb

@@ -9,6 +9,7 @@ require 'dogapi/v1/dashboard'
 require 'dogapi/v1/dashboard_list'
 require 'dogapi/v1/embed'
 require 'dogapi/v1/event'
+require 'dogapi/v1/logs_pipeline'
 require 'dogapi/v1/metadata'
 require 'dogapi/v1/metric'
 require 'dogapi/v1/monitor'

data/lib/dogapi/v1/alert.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/aws_integration.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/aws_logs.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/azure_integration.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/comment.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/dash.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/dashboard.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/dashboard_list.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/embed.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/event.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/gcp_integration.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/hosts.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/integration.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/logs_pipeline.rb

@@ -0,0 +1,41 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
+module Dogapi
+  class V1 # for namespacing
+    class LogsPipelineService < Dogapi::APIService
+      API_VERSION = 'v1'
+
+      def create_logs_pipeline(name, filter, options = {})
+        body = {
+          'name' => name,
+          'filter' => filter
+        }.merge options
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/logs/config/pipelines", nil, body, true)
+      end
+
+      def get_logs_pipeline(pipeline_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/logs/config/pipelines/#{pipeline_id}", nil, nil, false)
+      end
+
+      def get_all_logs_pipelines
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/logs/config/pipelines", nil, nil, false)
+      end
+
+      def update_logs_pipeline(pipeline_id, name, filter, options = {})
+        body = {
+          'name' => name,
+          'filter' => filter
+        }.merge options
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/logs/config/pipelines/#{pipeline_id}", nil, body, true)
+      end
+
+      def delete_logs_pipeline(pipeline_id)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/logs/config/pipelines/#{pipeline_id}", nil, nil, false)
+      end
+    end
+  end
+end

data/lib/dogapi/v1/metadata.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1
 

data/lib/dogapi/v1/metric.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/monitor.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
     class MonitorService < Dogapi::APIService

data/lib/dogapi/v1/screenboard.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/search.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/service_check.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1
 

data/lib/dogapi/v1/service_level_objective.rb

@@ -1,4 +1,6 @@
-require 'dogapi'
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
 
 module Dogapi
   class V1 # for namespacing

data/lib/dogapi/v1/snapshot.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/synthetics.rb

@@ -1,4 +1,6 @@
-require 'dogapi'
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
 
 module Dogapi
   class V1 # for namespacing

data/lib/dogapi/v1/tag.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/usage.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v1/user.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V1 # for namespacing
 

data/lib/dogapi/v2/dashboard_list.rb

@@ -2,8 +2,6 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2011-Present Datadog, Inc.
 
-require 'dogapi'
-
 module Dogapi
   class V2 # for namespacing
 

data/lib/dogapi/version.rb

@@ -3,5 +3,5 @@
 # Copyright 2011-Present Datadog, Inc.
 
 module Dogapi
-  VERSION = '1.44.0'
+  VERSION = '1.45.0'
 end

data/spec/integration/logs_pipeline_spec.rb

@@ -0,0 +1,43 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the BSD-3-Clause License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2011-Present Datadog, Inc.
+
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  LOGS_PIPELINE_ID = '42'
+  LOGS_PIPELINE_NAME =  'my logs pipeline'.freeze
+  LOGS_PIPELINE_FILTER = { 'query' => 'source:my-app' }.freeze
+
+  describe '#create_logs_pipeline' do
+    it_behaves_like 'an api method with options',
+                    :create_logs_pipeline, [LOGS_PIPELINE_NAME, LOGS_PIPELINE_FILTER],
+                    :post, '/logs/config/pipelines', 'name' => LOGS_PIPELINE_NAME,
+                                                     'filter' => LOGS_PIPELINE_FILTER
+  end
+
+  describe '#get_logs_pipeline' do
+    it_behaves_like 'an api method',
+                    :get_logs_pipeline, [LOGS_PIPELINE_ID],
+                    :get, "/logs/config/pipelines/#{LOGS_PIPELINE_ID}"
+  end
+
+  describe '#get_all_logs_pipelines' do
+    it_behaves_like 'an api method',
+                    :get_all_logs_pipelines, [],
+                    :get, '/logs/config/pipelines'
+  end
+
+  describe '#update_logs_pipeline' do
+    it_behaves_like 'an api method with options',
+                    :update_logs_pipeline, [LOGS_PIPELINE_ID, LOGS_PIPELINE_NAME, LOGS_PIPELINE_FILTER],
+                    :put, "/logs/config/pipelines/#{LOGS_PIPELINE_ID}", 'name' => LOGS_PIPELINE_NAME,
+                                                                        'filter' => LOGS_PIPELINE_FILTER
+  end
+
+  describe '#delete_logs_pipeline' do
+    it_behaves_like 'an api method',
+                    :delete_logs_pipeline, [LOGS_PIPELINE_ID],
+                    :delete, "/logs/config/pipelines/#{LOGS_PIPELINE_ID}"
+  end
+end

data/spec/unit/common_spec.rb

@@ -182,21 +182,21 @@ describe Dogapi::APIService do
     context 'when receiving a correct reponse with valid json' do
       it 'parses it and return code and parsed body' do
         dog = dogapi_service
-        resp = FakeResponse.new 202, '{"test2": "test3"}'
-        expect(dog.handle_response(resp)).to eq([202, { 'test2' => 'test3' }])
+        resp = FakeResponse.new '202', '{"test2": "test3"}'
+        expect(dog.handle_response(resp)).to eq(['202', { 'test2' => 'test3' }])
       end
     end
     context 'when receiving a response with invalid json' do
       it 'raises an error' do
         dog = dogapi_service
-        resp = FakeResponse.new 202, "{'test2': }"
+        resp = FakeResponse.new '202', "{'test2': }"
         expect { dog.handle_response(resp) }.to raise_error(RuntimeError, "Invalid JSON Response: {'test2': }")
       end
     end
     context 'when receiving a non json response' do
       it 'raises an error indicating the response Content-Type' do
         dog = dogapi_service
-        resp = FakeResponse.new 202, '<html><body><h1>403 Forbidden</h1>', 'text/html'
+        resp = FakeResponse.new '202', '<html><body><h1>403 Forbidden</h1>', 'text/html'
         msg = 'Response Content-Type is not application/json but is text/html: <html><body><h1>403 Forbidden</h1>'
         expect { dog.handle_response(resp) }.to raise_error(RuntimeError, msg)
       end
@@ -204,12 +204,12 @@ describe Dogapi::APIService do
     context 'when receiving a bad response' do
       it 'returns the error code and an empty body' do
         dog = dogapi_service
-        resp = FakeResponse.new 204, ''
-        expect(dog.handle_response(resp)).to eq([204, {}])
-        resp = FakeResponse.new 202, nil
-        expect(dog.handle_response(resp)).to eq([202, {}])
-        resp = FakeResponse.new 202, 'null'
-        expect(dog.handle_response(resp)).to eq([202, {}])
+        resp = FakeResponse.new '204', ''
+        expect(dog.handle_response(resp)).to eq(['204', {}])
+        resp = FakeResponse.new '202', nil
+        expect(dog.handle_response(resp)).to eq(['202', {}])
+        resp = FakeResponse.new '202', 'null'
+        expect(dog.handle_response(resp)).to eq(['202', {}])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.44.0
+  version: 1.45.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -125,6 +125,7 @@ files:
 - lib/dogapi/v1/gcp_integration.rb
 - lib/dogapi/v1/hosts.rb
 - lib/dogapi/v1/integration.rb
+- lib/dogapi/v1/logs_pipeline.rb
 - lib/dogapi/v1/metadata.rb
 - lib/dogapi/v1/metric.rb
 - lib/dogapi/v1/monitor.rb
@@ -153,6 +154,7 @@ files:
 - spec/integration/event_spec.rb
 - spec/integration/gcp_integration_spec.rb
 - spec/integration/integration_spec.rb
+- spec/integration/logs_pipeline_spec.rb
 - spec/integration/metadata_spec.rb
 - spec/integration/metric_spec.rb
 - spec/integration/monitor_spec.rb
@@ -216,6 +218,7 @@ test_files:
 - spec/integration/event_spec.rb
 - spec/integration/gcp_integration_spec.rb
 - spec/integration/integration_spec.rb
+- spec/integration/logs_pipeline_spec.rb
 - spec/integration/metadata_spec.rb
 - spec/integration/metric_spec.rb
 - spec/integration/monitor_spec.rb