dogapi 1.40.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03dcbb8f50795fb901c13effb712107ac78beb545d55bebccb9f2cfc83c92908
-  data.tar.gz: d6cbb3c3dd0807d8d684879fa3efb44e8a54acd7c07298261ebc11b5b9a099e4
+  metadata.gz: 1ef3fbebc71af23718db2e177c11400648e47e0e770c8783021a8e7a1b7df099
+  data.tar.gz: 59ef0c8d5c187e7161a25166b468fa91c640ab568dd22992aa037b38c7461ff1
 SHA512:
-  metadata.gz: 4b969abe11bd88812b9eb70066fb1d1fb2ff5df49a5a95de7c92893357dde80af0e5636500b1a7ed9703ce525a96d10662ff4900d09fd2676db263be17dfcaaf
-  data.tar.gz: 3b63c822096ba541151e837c16d47c0aa298baff22257be5b098e13041bba0dd00bba328d479240d17b2c58c9a1c9cacfdbf33a9416752b5a61a4dd65a999457
+  metadata.gz: 48239d6fd49a735c74eb4c95f97093c0e599a8d11d868e784cb08ce1a96ce0a6da6b942e78afadc870fcb7e09bf0b53205c0517d502029cc17d3c3a378d5bbfa
+  data.tar.gz: 658b9c7f91b18e7744b1d3761e6e1d5212e527f293d09ba4a00f3303602262c46cf0c5743ec317e4bdb353286a1c94a9de51b86285b9513f310e7f6e72f4ca0c

data/.azure-pipelines/all.yml

@@ -9,10 +9,36 @@ pr:
     include:
     - master
 
+resources:
+  containers:
+  - container: datadog-agent
+    image: datadog/agent:7
+    options: --health-cmd="exit 0" --health-interval=1s
+    ports:
+    - 8125:8125
+    - 8126:8126/tcp
+    env:
+      DD_API_KEY: $(ddAPIKey)
+      DD_APM_ENABLED: "true"
+      DD_APM_NON_LOCAL_TRAFFIC: "true"
+      DD_LOGS_ENABLED: "true"
+      DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL: "true"
+      DD_AC_EXCLUDE: "name:datadog-agent"
+    volumes:
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+      - /proc/:/host/proc/:ro
+      - /sys/fs/cgroup/:/host/sys/fs/cgroup:ro
+
 jobs:
 - job: UnitTests
   pool:
     vmImage: "Ubuntu-16.04"
+  container:
+    image: ruby:$(RUBY_VERSION)
+    options: >-
+      -l com.datadoghq.ad.logs="[{\"source\": \"Azure Pipeline\", \"service\": \"dogapi-rb\"}]"
+  services:
+    datadog-agent: datadog-agent
   strategy:
     matrix:
       Rb24:
@@ -31,17 +57,19 @@ jobs:
         RUBY_VERSION: '2.6'
         TASK: rubocop
   steps:
-    - task: UseRubyVersion@0
-      displayName: Use Ruby $(RUBY_VERSION)
-      inputs:
-        versionSpec: $(RUBY_VERSION)
-        addToPath: true
-    - script: |
-        gem install bundler
-        bundle install --retry=3 --jobs=4
+    - script: bundle install --retry=3 --jobs=4
       displayName: 'bundle install'
+      env:
+        GEM_HOME: '~/.gem'
     - script: bundle exec rake $(TASK)
       displayName: Run $(TASK) via bundle
+      env:
+        GEM_HOME: '~/.gem'
+        DD_AGENT_HOST: datadog-agent
+        DD_ENV: ci
+        DD_SERVICE: dogapi-rb
+        DD_TAGS: "team:integration-tools-and-libraries,runtime:ruby-$(RUBY_VERSION),ci.job.name:$(System.JobName),matrix:$(TASK)"
+        DD_TRACE_ANALYTICS_ENABLED: "true"
 - job: TestRuby19
   pool:
     vmImage: "Ubuntu-16.04"

data/.rubocop.yml

@@ -14,4 +14,8 @@ Metrics/LineLength:
 Metrics/ModuleLength:
   Max: 200
 
+# Our Client constructor has 8 arguments
+Metrics/ParameterLists:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

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,29 @@
 # 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).
+
+## 1.43.0 / 2020-12-07
+
+* [Fixed] find_localhost: Try both `hostname` and `hostname -f` before raising. See [#242](https://github.com/DataDog/dogapi-rb/pull/242).
+
+## 1.42.0 / 2020-09-17
+
+* [Added] Allow dashboard creation / updates using Template Variable Presets. See [#238](https://github.com/DataDog/dogapi-rb/pull/238).
+
+## 1.41.0 / 2020-07-27
+
+* [Added] Improve user-agent header to include telemetry information. See [#235](https://github.com/DataDog/dogapi-rb/pull/235).
+* [Added] Move setting hostname to end of method body in order to actually return it. See [#233](https://github.com/DataDog/dogapi-rb/pull/233).
+
 ## 1.40.0 / 2020-04-06
 
 * [Added] Re-add service level objectives support. See [#224](https://github.com/DataDog/dogapi-rb/pull/224).

data/Gemfile

@@ -3,10 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'ddtrace', git: 'https://github.com/datadog/dd-trace-rb'
   gem 'rubocop', "~> 0.49.0"
-  # NOTE: rake < 12.3.3 is vulnerable to CVE-2020-8130, but we only use it as a test dependency
-  # and neither our users nor our CI is vulnerable in any way
-  gem 'rake', '>= 2.4.2'
   gem 'rspec'
   gem 'simplecov'
   gem 'webmock'

data/Gemfile_1.9

@@ -4,10 +4,8 @@ gemspec
 
 group :test do
   gem 'rubocop', "~> 0.41.0"
-  # NOTE: rake < 12.3.3 is vulnerable to CVE-2020-8130, but we only use it as a test dependency
-  # and neither our users nor our CI is vulnerable in any way
-  gem 'rake', '>= 2.4.2'
   gem 'rspec'
   gem 'simplecov', "~> 0.11.2"
   gem 'webmock'
+  gem 'crack', '<= 0.4.4'
 end

data/RELEASING.md

@@ -43,4 +43,4 @@ Install [bundler](https://bundler.io/) and setup your RubyGems credentials:
 1. Build the gem: `bundle exec gem build dogapi.gemspec`.
 1. Push the gem: `bundle exec gem push dogapi-x.x.x.gem`.
 1. Check that the [Ruby Gem is published](https://rubygems.org/gems/dogapi).
-1. Bump the version again in `lib/dogapi/version.rb` to a dev version (e.g. `1.39.0` -> `1.40.0.dev`), open a PR and merge it to master.
+1. Bump the version again in `lib/dogapi/version.rb` to a dev version (e.g. `1.42.0` -> `1.42.1.dev`), open a PR and merge it to master.

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

@@ -4,6 +4,7 @@
 
 require 'cgi'
 require 'net/https'
+require 'rbconfig'
 require 'socket'
 require 'uri'
 require 'English'
@@ -13,7 +14,16 @@ require 'multi_json'
 require 'set'
 require 'open3'
 
+require 'dogapi/version'
+
 module Dogapi
+  USER_AGENT = format(
+    'dogapi-rb/%<version>s (ruby %<ruver>s; os %<os>s; arch %<arch>s)',
+    version: VERSION,
+    ruver: RUBY_VERSION,
+    os: RbConfig::CONFIG['host_os'].downcase,
+    arch: RbConfig::CONFIG['host_cpu']
+  )
 
   # Metadata class to hold the scope of an API call
   class Scope
@@ -76,11 +86,12 @@ module Dogapi
   # Superclass that deals with the details of communicating with the DataDog API
   class APIService
     attr_reader :api_key, :application_key
-    def initialize(api_key, application_key, silent=true, timeout=nil, endpoint=nil)
+    def initialize(api_key, application_key, silent=true, timeout=nil, endpoint=nil, skip_ssl_validation=false)
       @api_key = api_key
       @application_key = application_key
       @api_host = endpoint || Dogapi.find_datadog_host()
       @silent = silent
+      @skip_ssl_validation = skip_ssl_validation
       @timeout = timeout || 5
     end
 
@@ -100,6 +111,9 @@ module Dogapi
       session = connection.new(uri.host, uri.port)
       session.open_timeout = @timeout
       session.use_ssl = uri.scheme == 'https'
+      if @skip_ssl_validation
+        session.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
       session.start do |conn|
         conn.read_timeout = @timeout
         yield conn
@@ -138,11 +152,11 @@ module Dogapi
     def prepare_request(method, url, params, body, send_json, with_app_key)
       url_with_params = url + params
       req = method.new(url_with_params)
+      req['User-Agent'] = USER_AGENT
       unless should_set_api_and_app_keys_in_params?(url)
         req['DD-API-KEY'] = @api_key
         req['DD-APPLICATION-KEY'] = @application_key if with_app_key
       end
-
       if send_json
         req.content_type = 'application/json'
         req.body = MultiJson.dump(body)
@@ -169,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
@@ -184,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
@@ -200,14 +214,17 @@ module Dogapi
   @@hostname = nil
 
   def Dogapi.find_localhost
-    unless @@hostname
-      out, status = Open3.capture2('hostname', '-f', err: File::NULL)
-      @@hostname = out.strip
-      # Get status to check if the call was successful
-      raise SystemCallError, 'Could not get hostname with `hostname -f`' unless status.exitstatus.zero?
-    end
-  rescue SystemCallError
-    @@hostname = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
+    return @@hostname if @@hostname
+    out, status = Open3.capture2('hostname', '-f', err: File::NULL)
+    unless status.exitstatus.zero?
+      begin
+        out = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
+      rescue SocketError
+        out, status = Open3.capture2('hostname', err: File::NULL)
+        raise SystemCallError, 'Both `hostname` and `hostname -f` failed.' unless status.exitstatus.zero?
+      end
+    end
+    @@hostname = out.strip
   end
 
   def Dogapi.find_proxy

data/lib/dogapi/facade.rb

@@ -13,7 +13,8 @@ module Dogapi
   # See Dogapi::V2  for the thick underlying clients
   class ClientV2
     attr_accessor :datadog_host
-    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
+    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true,
+                   timeout=nil, endpoint=nil, skip_ssl_validation=false)
 
       if api_key
         @api_key = api_key
@@ -27,7 +28,7 @@ module Dogapi
       @device = device
 
       @dashboard_list_service_v2 = Dogapi::V2::DashboardListService.new(
-        @api_key, @application_key, silent, timeout, @datadog_host
+        @api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation
       )
 
     end
@@ -64,7 +65,7 @@ module Dogapi
     # Support for API version 2.
 
     # rubocop:disable Metrics/MethodLength, Metrics/LineLength
-    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
+    def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil, skip_ssl_validation=false)
 
       if api_key
         @api_key = api_key
@@ -78,38 +79,39 @@ module Dogapi
       @device = device
 
       # FIXME: refactor to avoid all this code duplication
-      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @dashboard_service = Dogapi::V1::DashboardService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @dashboard_service = Dogapi::V1::DashboardService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
       @dashboard_list_service = Dogapi::V1::DashboardListService.new(
-        @api_key, @application_key, silent, timeout, @datadog_host
+        @api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation
       )
-      @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @synthetics_svc = Dogapi::V1::SyntheticsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @metadata_svc = Dogapi::V1::MetadataService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @synthetics_svc = Dogapi::V1::SyntheticsService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @metadata_svc = Dogapi::V1::MetadataService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
-      @hosts_svc = Dogapi::V1::HostsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @integration_svc = Dogapi::V1::IntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @aws_integration_svc = Dogapi::V1::AwsIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @aws_logs_svc = Dogapi::V1::AwsLogsService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @usage_svc = Dogapi::V1::UsageService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @azure_integration_svc = Dogapi::V1::AzureIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
-      @gcp_integration_svc = Dogapi::V1::GcpIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @hosts_svc = Dogapi::V1::HostsService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @integration_svc = Dogapi::V1::IntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @aws_integration_svc = Dogapi::V1::AwsIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @aws_logs_svc = Dogapi::V1::AwsLogsService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @usage_svc = Dogapi::V1::UsageService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @azure_integration_svc = Dogapi::V1::AzureIntegrationService.new(@api_key, @application_key, silent, timeout, @datadog_host, skip_ssl_validation)
+      @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)
+                                                                                  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)
+      @v2 = Dogapi::ClientV2.new(@api_key, @application_key, true, true, @datadog_host, skip_ssl_validation)
 
     end
     # rubocop:enable Metrics/MethodLength, Metrics/LineLength
@@ -716,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
 
@@ -28,6 +26,11 @@ module Dogapi
       #                           e.g. '["user1@domain.com", "user2@domain.com"]'
       # :template_variables    => JSON: List of template variables for this dashboard.
       #                           e.g. [{"name": "host", "prefix": "host", "default": "my-host"}]
+      # :template_variable_presets => JSON: List of template variables saved views
+      #                           e.g. {
+      #                                  "name": "my_template_variable_preset",
+      #                                  "template_variables": [{"name": "host", "prefix": "host", "default": "my-host"}]
+      #                                }
       def create_board(title, widgets, layout_type, options)
         # Required arguments
         body = {
@@ -40,6 +43,7 @@ module Dogapi
         body[:is_read_only] = options[:is_read_only] if options[:is_read_only]
         body[:notify_list] = options[:notify_list] if options[:notify_list]
         body[:template_variables] = options[:template_variables] if options[:template_variables]
+        body[:template_variable_presets] = options[:template_variable_presets] if options[:template_variable_presets]
 
         request(Net::HTTP::Post, "/api/#{API_VERSION}/#{RESOURCE_NAME}", nil, body, true)
       end
@@ -60,6 +64,11 @@ module Dogapi
       #                           e.g. '["user1@domain.com", "user2@domain.com"]'
       # :template_variables    => JSON: List of template variables for this dashboard.
       #                           e.g. [{"name": "host", "prefix": "host", "default": "my-host"}]
+      # :template_variable_presets => JSON: List of template variables saved views
+      #                           e.g. {
+      #                                  "name": "my_template_variable_preset",
+      #                                  "template_variables": [{"name": "host", "prefix": "host", "default": "my-host"}]
+      #                                }
       def update_board(dashboard_id, title, widgets, layout_type, options)
         # Required arguments
         body = {
@@ -72,6 +81,7 @@ module Dogapi
         body[:is_read_only] = options[:is_read_only] if options[:is_read_only]
         body[:notify_list] = options[:notify_list] if options[:notify_list]
         body[:template_variables] = options[:template_variables] if options[:template_variables]
+        body[:template_variable_presets] = options[:template_variable_presets] if options[:template_variable_presets]
 
         request(Net::HTTP::Put, "/api/#{API_VERSION}/#{RESOURCE_NAME}/#{dashboard_id}", nil, body, true)
       end

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.40.0'
+  VERSION = '1.45.0'
 end

data/spec/integration/dashboard_spec.rb

@@ -26,6 +26,15 @@ describe Dogapi::Client do
     'prefix' => 'host',
     'default' => 'my-host'
   }].freeze
+  TEMPLATE_VARIABLE_PRESETS = [{
+    'name' => 'preset1',
+    'template_variables' => [
+      {
+        'name' => 'host1',
+        'value' => 'my-host'
+      }
+    ]
+  }].freeze
 
   REQUIRED_ARGS = {
     title: TITLE,
@@ -37,7 +46,8 @@ describe Dogapi::Client do
     description: DESCRIPTION,
     is_read_only: IS_READ_ONLY,
     notify_list: NOTIFY_LIST,
-    template_variables: TEMPLATE_VARIABLES
+    template_variables: TEMPLATE_VARIABLES,
+    template_variable_presets: TEMPLATE_VARIABLE_PRESETS
   }
   DASHBOARD_ARGS = REQUIRED_ARGS.values + [OPTIONS]
   DASHBOARD_PAYLOAD = REQUIRED_ARGS.merge(OPTIONS)

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/spec_helper.rb

@@ -10,7 +10,19 @@ SimpleCov.start do
   add_filter 'spec'
 end
 
-WebMock.disable_net_connect!(allow_localhost: false)
+webmock_allow = []
+
+begin
+  require 'ddtrace'
+  Datadog.configure do |c|
+    c.use :rspec, service_name: 'dogapi-rb'
+  end
+  webmock_allow << "#{Datadog::Transport::HTTP.default_hostname}:#{Datadog::Transport::HTTP.default_port}"
+rescue LoadError
+  puts 'ddtrace gem not found'
+end
+
+WebMock.disable_net_connect!(allow_localhost: false, allow: webmock_allow)
 
 # include our code and methods
 require 'dogapi'

data/spec/unit/common_spec.rb

@@ -134,6 +134,15 @@ describe 'Common' do
         expect(req['DD-APPLICATION-KEY']).to eq service.application_key
       end
     end
+
+    it 'properly sets User-Agent header' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+      params = service.prepare_params(nil, '/api/v1/validate', true)
+      req = service.prepare_request(Net::HTTP::Get, '/api/v1/validate', params, nil, false, true)
+
+      expect(req.key?('User-Agent')).to be true
+      expect(req['User-Agent']).to match(%r{dogapi-rb\/[^\s]+ \(ruby [^\s]+; os [^\s]+; arch [^\s]+\)})
+    end
   end
 end
 
@@ -173,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
@@ -195,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.40.0
+  version: 1.45.0
 platform: ruby
 authors:
 - Datadog, Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-06 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
@@ -177,7 +179,7 @@ metadata:
   changelog_uri: https://github.com/DataDog/dogapi-rb/blob/master/CHANGELOG.md
   documentation_uri: https://docs.datadoghq.com/api/
   source_code_uri: https://github.com/DataDog/dogapi-rb
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - DogAPI -- Datadog Client
@@ -199,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby bindings for Datadog's API
 test_files:
@@ -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