datadog_backup 2.0.2 → 3.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985fb90b7482b78cf13ce586048eba798002d79aa0a00aa1475f2c9030fe5585
-  data.tar.gz: 34e55a0a46912ac13a06cf022f63e97474d576b28377b38695bae14606871388
+  metadata.gz: 75f5659461aa4a52626f34a4094174cc899e600695e512c9a8f9b613741cda54
+  data.tar.gz: fc74c95bdbadf48eebb12d27648f365c3e83dfe43f51df5e5f3b41e095b6162f
 SHA512:
-  metadata.gz: 5783ab3fc1be9f27f99c9039f7ea3a1b0b3c5eae72278cdf99c2b954242c93dcf932bace845adaa825ed4481a4a6f39fe502ae2fedbb9a24973eed5b1b576f6c
-  data.tar.gz: 293c615e05587b9adf6af65e719e5ff3f8ab9f1441625904248c644a5b3ddaaad51cd5c265f8e99b784fbac6ba86fa41e71e5739a95049bedcc77d84dc575d53
+  metadata.gz: a199e84cdee10ad8bfd0274dda29cdf67b540451748a8a096eafa166ff5f8063bed16dc93318063fefe085f015c85dbc6f93af202af991776f2ef5219e0e3a59
+  data.tar.gz: be2034d46ec881f89338a2c54880a6f39fd1946288e352a68bd1fcc8338b43066574650d373d9401a35203c95897775dc26773abbd17ba4b597b268fb6396622

data/.github/workflows/rspec_and_release.yml

@@ -12,7 +12,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.6, 2.7, '3.0', '3.1']
+        ruby: [2.7, '3.0', '3.1']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [3.0.0-alpha.1](https://github.com/scribd/datadog_backup/compare/v2.0.2...v3.0.0-alpha.1) (2022-08-24)
+
+
+* feat!: release 3.0 ([d09d9e6](https://github.com/scribd/datadog_backup/commit/d09d9e6c845edb35c49cbb19ec6b35878304a078))
+
+
+### BREAKING CHANGES
+
+* DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
+* ruby 2.6 is no longer supported. Please upgrade to ruby 2.7 or higher.
+* The options `--ssh` and `--ssshh` are no longer supported. Instead, please use `--quiet` to supress logging. `--debug` remains supported.
+* The environment variable `DATADOG_HOST` is no longer supported. Instead, please use `DD_SITE_URL`.
+
+refactor: The legacy [dogapi-rb ](https://github.com/DataDog/dogapi-rb) gem is replaced with [faraday](https://lostisland.github.io/faraday/).  The [official client library](https://github.com/DataDog/datadog-api-client-ruby) was considered, but was not adopted as I had a hard time grok-ing it.
+
 ## [2.0.2](https://github.com/scribd/datadog_backup/compare/v2.0.1...v2.0.2) (2022-08-11)
 
 

data/Gemfile.lock

@@ -1,25 +1,31 @@
 PATH
   remote: .
   specs:
-    datadog_backup (2.0.1)
-      amazing_print (~> 1.4.0)
-      concurrent-ruby (~> 1.1.10)
-      deepsort (~> 0.4.5)
-      diffy (~> 3.4.2)
-      dogapi (~> 1.45.0)
+    datadog_backup (2.0.2)
+      amazing_print
+      concurrent-ruby
+      deepsort
+      diffy
+      faraday
+      faraday-retry
 
 GEM
   remote: https://rubygems.org/
   specs:
     amazing_print (1.4.0)
     ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     deepsort (0.4.5)
     diff-lcs (1.5.0)
     diffy (3.4.2)
-    dogapi (1.45.0)
-      multi_json
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.0)
+    faraday-retry (2.0.0)
+      faraday (~> 2.0)
     ffi (1.15.5)
     formatador (1.1.0)
     guard (2.18.0)
@@ -42,7 +48,6 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    multi_json (1.15.0)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -53,6 +58,9 @@ GEM
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
@@ -72,14 +80,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.34.1)
+    rubocop (1.35.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.0, < 2.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.21.0)
@@ -87,21 +95,24 @@ GEM
     rubocop-rspec (2.12.1)
       rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
     shellany (0.0.1)
     thor (1.2.1)
     unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler
   datadog_backup!
   guard-rspec
   pry
+  pry-byebug
   rspec
   rubocop
   rubocop-rspec
 
 BUNDLED WITH
-   2.3.19
+   2.3.20

data/README.md

@@ -11,6 +11,20 @@ Currently supports
 
 Additional features may be built out over time.
 
+# v3 Migration
+
+## Breaking Changes
+v3 is a backwards incompatible change.
+
+- [] DATADOG_API_KEY and DATADOG_APP_KEY are no longer the environment variables used to authenticate to Datadog. Instead, set the environment variables DD_API_KEY and DD_APP_KEY.
+- [ ] ruby 2.6 is no longer supported. Please upgrade to ruby 2.7 or higher.
+- [ ] The options `--ssh` and `--ssshh` are no longer supported. Instead, please use `--quiet` to supress logging. `--debug` remains supported.
+- [ ] The environment variable `DATADOG_HOST` is no longer supported. Instead, please use `DD_SITE_URL`.
+
+## Misc
+- [ ] The legacy [dogapi-rb ](https://github.com/DataDog/dogapi-rb) gem is replaced with [faraday](https://lostisland.github.io/faraday/).  The [official client library](https://github.com/DataDog/datadog-api-client-ruby) was considered, but was not adopted as I had a hard time grok-ing it.
+
+
 ## Installation
 
 ```
@@ -22,13 +36,13 @@ gem install datadog_backup
 ![demo](images/demo.gif)
 
 ```
-DATADOG_API_KEY=example123 DATADOG_APP_KEY=example123 datadog_backup <backup|diffs|restore> [--backup-dir /path/to/backups] [--debug] [--monitors-only] [--dashboards-only] [--diff-format color|html|html_simple] [--no-color] [--json]
+DD_API_KEY=example123 DD_APP_KEY=example123 datadog_backup <backup|diffs|restore> [--backup-dir /path/to/backups] [--debug] [--monitors-only] [--dashboards-only] [--diff-format color|html|html_simple] [--no-color] [--json]
 ```
 
 ```
 gem install datadog_backup
-export DATADOG_API_KEY=abc123
-export DATADOG_APP_KEY=abc123
+export DD_API_KEY=abc123
+export DD_APP_KEY=abc123
 
 # Perform backup to `./backup/` using YAML encoding
 datadog_backup backup
@@ -49,8 +63,7 @@ Supply the following parameters in order to customize datadog_backup:
 parameter            | description                                                                                                                   | default
 ---------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------
 --debug              | log debug and above                                                                                                           | info
---shh                | log warnings and above                                                                                                        | info
---shhh               | log errors and above                                                                                                          | info
+--quiet              | only show errors and above                                                                                                    | info
 --backup-dir PATH    | path to the directory to backup to or restore from                                                                            | `./backup/`
 --monitors-only      | only backup monitors                                                                                                          | backup monitors and dashboards
 --dashboards-only    | only backup dashboards                                                                                                        | backup monitors and dashboards
@@ -66,10 +79,9 @@ The following environment variables can be set in order to further customize dat
 
 environment variable | description                                                                      | default
 ---------------------|--------------------------------------------------------------------------------|--------------------------
-DATADOG_HOST         | Describe the API endpoint to connect to (https://api.datadoghq.eu for example)   | https://api.datadoghq.com
-http_proxy           | Instruct Dogapi to connect via a differnt proxy address                          | none
-https_proxy          | Same as `http_proxy`                                                             | none
-dd_proxy_https       | Same as `http_proxy`                                                             | none
+DD_SITE_URL          | Describe the API endpoint to connect to (https://api.datadoghq.eu for example)   | https://api.datadoghq.com
+DD_API_KEY           | The API key for the Datadog account                                              | none
+DD_API_KEY           | The Application key for the Datadog account                                      | none
 
 
 ### Usage in a Github repo

data/bin/datadog_backup

@@ -10,7 +10,6 @@ LOGGER = Logger.new($stderr) unless defined?(LOGGER)
 LOGGER.level = Logger::INFO
 
 require 'datadog_backup'
-require 'dogapi'
 
 
 def fatal(message)
@@ -19,9 +18,8 @@ def fatal(message)
 end
 
 def options_valid?(options)
-  %w[backup diffs restore].include?(options[:action]) &&
-    options[:datadog_api_key] &&
-    options[:datadog_app_key]
+  %w[backup diffs restore].include?(options[:action])
+  %w[DD_API_KEY DD_APP_KEY].all? { |key| ENV[key] }
 end
 
 def prereqs(defaults)
@@ -30,7 +28,7 @@ def prereqs(defaults)
   result = defaults.dup
 
   options = OptionParser.new do |opts|
-    opts.banner = "Usage: DATADOG_API_KEY=abc123 DATADOG_APP_KEY=abc123 #{File.basename($PROGRAM_NAME)} <backup|diffs|restore>"
+    opts.banner = "Usage: DD_API_KEY=abc123 DD_APP_KEY=abc123 #{File.basename($PROGRAM_NAME)} <backup|diffs|restore>"
     opts.separator ''
     opts.on_tail('-h', '--help', 'Show this message') do
       puts opts
@@ -39,10 +37,7 @@ def prereqs(defaults)
     opts.on('--debug', 'log debug and above') do
       LOGGER.level = Logger::DEBUG
     end
-    opts.on('--shh', 'log warnings and above') do
-      LOGGER.level = Logger::WARN
-    end
-    opts.on('--shhh', 'log errors and above') do
+    opts.on('--quiet', 'log errors and above') do
       LOGGER.level = Logger::ERROR
     end
     opts.on('--backup-dir PATH', '`backup` by default') do |path|
@@ -73,7 +68,7 @@ def prereqs(defaults)
   options.parse!
 
   result[:action] = ARGV.first
-  fatal(options) unless options_valid?(result)
+  fatal(options.banner) unless options_valid?(result)
   result
 end
 
@@ -81,8 +76,6 @@ end
 # Default parameters
 defaults = {
   action: nil,
-  datadog_api_key: ENV.fetch('DATADOG_API_KEY', nil),
-  datadog_app_key: ENV.fetch('DATADOG_APP_KEY', nil),
   backup_dir: File.join(ENV.fetch('PWD'), 'backup'),
   diff_format: :color,
   resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors],
@@ -90,4 +83,9 @@ defaults = {
   force_restore: false
 }
 
+begin
 DatadogBackup::Cli.new(prereqs(defaults)).run!
+rescue => e
+  require 'pry'
+  binding.pry
+end

data/datadog_backup.gemspec

@@ -19,16 +19,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ['>= 2.6']
+  spec.required_ruby_version = ['>= 2.7']
+
+  spec.add_dependency 'amazing_print'
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'deepsort'
+  spec.add_dependency 'diffy'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-retry'
 
-  spec.add_dependency 'amazing_print', '~> 1.4.0'
-  spec.add_dependency 'concurrent-ruby', '~> 1.1.10'
-  spec.add_dependency 'deepsort', '~> 0.4.5'
-  spec.add_dependency 'diffy', '~> 3.4.2'
-  spec.add_dependency 'dogapi', '~> 1.45.0'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'

data/example/.github/workflows/backup.yml

@@ -17,8 +17,8 @@ jobs:
         ruby-version: 2.7.1
     - name: perform backup
       env:
-        DATADOG_API_KEY: ${{ secrets.DATADOG_API_KEY }}
-        DATADOG_APP_KEY: ${{ secrets.DATADOG_APP_KEY }}
+        DD_API_KEY: ${{ secrets.DD_API_KEY }}
+        DD_APP_KEY: ${{ secrets.DD_APP_KEY }}
       run: |
           gem install --no-document bundler
           bundle install --jobs 4 --retry 3

data/lib/datadog_backup/cli.rb

@@ -28,13 +28,6 @@ module DatadogBackup
       any_resource_instance.all_files
     end
 
-    def initialize_client
-      @options[:client] ||= Dogapi::Client.new(
-        datadog_api_key,
-        datadog_app_key
-      )
-    end
-
     def definitive_resource_instance(id)
       matching_resource_instance(any_resource_instance.class_from_id(id))
     end
@@ -86,7 +79,6 @@ module DatadogBackup
 
     def initialize(options)
       @options = options
-      initialize_client
     end
 
     def matching_resource_instance(klass)

data/lib/datadog_backup/core.rb

@@ -2,14 +2,45 @@
 
 require 'diffy'
 require 'deepsort'
+require 'faraday'
+require 'faraday/retry'
+
+
 
 module DatadogBackup
   class Core
     include ::DatadogBackup::LocalFilesystem
     include ::DatadogBackup::Options
 
+    @@retry_options = {
+      max: 5,
+      interval: 0.05,
+      interval_randomness: 0.5,
+      backoff_factor: 2
+    }
+
     def api_service
-      raise 'subclass is expected to implement #api_service'
+      conn ||= Faraday.new(
+          url: api_url,
+          headers: {
+            'DD-API-KEY' => ENV.fetch('DD_API_KEY'),
+            'DD-APPLICATION-KEY' => ENV.fetch('DD_APP_KEY')
+          }
+        ) do |faraday|
+            faraday.request :json
+            faraday.request :retry, @@retry_options
+            faraday.response(:logger, LOGGER, {headers: true, bodies: LOGGER.debug?, log_level: :debug}) do | logger |
+              logger.filter(/(DD-API-KEY:)([^&]+)/, '\1[REDACTED]')
+              logger.filter(/(DD-APPLICATION-KEY:)([^&]+)/, '\1[REDACTED]')
+            end
+            faraday.response :raise_error
+            faraday.response :json
+            faraday.adapter Faraday.default_adapter
+          end
+    end
+
+    def api_url
+      ENV.fetch('DD_SITE_URL', "https://api.datadoghq.com/")
     end
 
     def api_version
@@ -44,19 +75,17 @@ module DatadogBackup
     end
 
     def get(id)
-      with_200 do
-        api_service.request(Net::HTTP::Get, "/api/#{api_version}/#{api_resource_name}/#{id}", nil, nil, false)
-      end
-    rescue RuntimeError => e
-      return {} if e.message.include?('Request failed with error ["404"')
-
-      raise e.message
+      params = {}
+      headers = {}
+      response = api_service.get("/api/#{api_version}/#{api_resource_name}/#{id}", params, headers)
+      body_with_2xx(response)
     end
 
     def get_all
-      with_200 do
-        api_service.request(Net::HTTP::Get, "/api/#{api_version}/#{api_resource_name}", nil, nil, false)
-      end
+      params = {}
+      headers = {}
+      response = api_service.get("/api/#{api_version}/#{api_resource_name}", params, headers)
+      body_with_2xx(response)
     end
 
     def get_and_write_file(id)
@@ -79,20 +108,20 @@ module DatadogBackup
 
     # Calls out to Datadog and checks for a '200' response
     def create(body)
-      result = with_200 do
-        api_service.request(Net::HTTP::Post, "/api/#{api_version}/#{api_resource_name}", nil, body, true)
-      end
-      LOGGER.warn 'Successfully created in datadog.'
-      result
+      headers = {}
+      response =  api_service.post("/api/#{api_version}/#{api_resource_name}", body, headers)
+      body = body_with_2xx(response)
+      LOGGER.warn "Successfully created #{body.fetch('id')} in datadog."
+      body
     end
 
     # Calls out to Datadog and checks for a '200' response
     def update(id, body)
-      result = with_200 do
-        api_service.request(Net::HTTP::Put, "/api/#{api_version}/#{api_resource_name}/#{id}", nil, body, true)
-      end
-      LOGGER.warn 'Successfully restored to datadog.'
-      result
+      headers = {}
+      response = api_service.put("/api/#{api_version}/#{api_resource_name}/#{id}", body, headers)
+      body = body_with_2xx(response)
+      LOGGER.warn 'Successfully restored #{id} to datadog.'
+      body
     end
 
     def restore(id)
@@ -100,7 +129,7 @@ module DatadogBackup
       begin
         update(id, body)
       rescue RuntimeError => e
-        if e.message.include?('Request failed with error ["404"')
+        if e.message.include?('update failed with error 404')
           new_id = create(body).fetch('id')
 
           FileUtils.rm(find_file_by_id(id))
@@ -111,21 +140,9 @@ module DatadogBackup
       end
     end
 
-    def with_200
-      max_retries = 6
-      retries ||= 0
-
-      response = yield
-      raise "Request failed with error #{response}" unless response[0] == '200'
-
-      response[1]
-    rescue ::Net::OpenTimeout => e
-      if (retries += 1) <= max_retries
-        sleep(0.1 * retries**5) # 0.1, 3.2, 24.3, 102.4 seconds per retry
-        retry
-      else
-        raise "Net::OpenTimeout: #{e.message}"
-      end
+    def body_with_2xx(response)
+      raise "#{caller_locations(1,1)[0].label} failed with error #{response.status}" unless response.status.to_s =~ /^2/
+      response.body
     end
   end
 end

data/lib/datadog_backup/dashboards.rb

@@ -2,14 +2,6 @@
 
 module DatadogBackup
   class Dashboards < Core
-    def all_boards
-      get_all.fetch('dashboards')
-    end
-
-    def api_service
-      # The underlying class from Dogapi that talks to datadog
-      client.instance_variable_get(:@dashboard_service)
-    end
 
     def api_version
       'v1'
@@ -22,7 +14,7 @@ module DatadogBackup
     def backup
       LOGGER.info("Starting diffs on #{::DatadogBackup::ThreadPool::TPOOL.max_length} threads")
 
-      futures = all_boards.map do |board|
+      futures = all_dashboards.map do |board|
         Concurrent::Promises.future_on(::DatadogBackup::ThreadPool::TPOOL, board) do |board|
           id = board['id']
           get_and_write_file(id)
@@ -35,6 +27,10 @@ module DatadogBackup
       Concurrent::Promises.zip(*futures).value!
     end
 
+    def all_dashboards
+      get_all.fetch('dashboards')
+    end
+
     def initialize(options)
       super(options)
       @banlist = %w[modified_at url].freeze

data/lib/datadog_backup/monitors.rb

@@ -6,11 +6,6 @@ module DatadogBackup
       @all_monitors ||= get_all
     end
 
-    def api_service
-      # The underlying class from Dogapi that talks to datadog
-      client.instance_variable_get(:@monitor_svc)
-    end
-
     def api_version
       'v1'
     end

data/lib/datadog_backup/options.rb

@@ -10,22 +10,10 @@ module DatadogBackup
       @options[:backup_dir]
     end
 
-    def client
-      @options[:client]
-    end
-
     def concurrency_limit
       @options[:concurrency_limit] | 2
     end
 
-    def datadog_api_key
-      @options[:datadog_api_key]
-    end
-
-    def datadog_app_key
-      @options[:datadog_app_key]
-    end
-
     def diff_format
       @options[:diff_format]
     end

data/lib/datadog_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  VERSION = '2.0.2'
+  VERSION = '3.0.0.alpha.1'
 end

data/lib/datadog_backup.rb

@@ -2,7 +2,8 @@
 
 require 'concurrent'
 
-require 'dogapi'
+require 'pry' #TODO: remove this
+require 'pry-byebug' #TODO: remove this
 
 require_relative 'datadog_backup/local_filesystem'
 require_relative 'datadog_backup/options'

data/spec/datadog_backup/cli_spec.rb

@@ -3,63 +3,35 @@
 require 'spec_helper'
 
 describe DatadogBackup::Cli do
-  let(:api_service_double) { double(Dogapi::APIService) }
-  let(:client_double) { double }
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
   let(:tempdir) { Dir.mktmpdir }
   let(:options) do
     {
       action: 'backup',
       backup_dir: tempdir,
-      client: client_double,
-      datadog_api_key: 1,
-      datadog_app_key: 1,
       diff_format: nil,
       output_format: :json,
       resources: [DatadogBackup::Dashboards]
     }
   end
   let(:cli) { described_class.new(options) }
-  let(:dashboards) { DatadogBackup::Dashboards.new(options) }
+  let(:dashboards) do
+    dashboards = DatadogBackup::Dashboards.new(options)
+    allow(dashboards).to receive(:api_service).and_return(api_client_double)
+    return dashboards
+  end
 
   before do
     allow(cli).to receive(:resource_instances).and_return([dashboards])
   end
 
-  describe '#initialize_client' do
-    subject { described_class.new({ datadog_api_key: 1, datadog_app_key: 1 }).initialize_client }
-
-    it { is_expected.to be_a(Dogapi::Client) }
-
-    context 'when the environment variable DATADOG_HOST is set to a custom host like https://api.datadoghq.eu' do
-      before do
-        stub_const('ENV', 'DATADOG_HOST' => 'https://api.datadoghq.eu')
-      end
-
-      describe 'then #datadog_host is https://api.datadoghq.eu' do
-        subject { described_class.new({ datadog_api_key: 1, datadog_app_key: 1 }).initialize_client.datadog_host }
-
-        it { is_expected.to eq('https://api.datadoghq.eu') }
-      end
-    end
-
-    context 'when the environment variable DATADOG_HOST is not set' do
-      before do
-        stub_const('ENV', {})
-      end
-
-      describe 'then #datadog_host is https://api.datadoghq.eu' do
-        subject { described_class.new({ datadog_api_key: 1, datadog_app_key: 1 }).initialize_client.datadog_host }
-
-        it { is_expected.to eq('https://api.datadoghq.com') }
-      end
-    end
-  end
-
   describe '#backup' do
     context 'when dashboards are deleted in datadog' do
-      let(:all_boards) do
+      let(:all_dashboards) do
         [
-          '200',
+          200,
+          {},
           {
             'dashboards' => [
               { 'id' => 'stillthere' },
@@ -74,22 +46,9 @@ describe DatadogBackup::Cli do
         dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/alsostillthere.json")
         dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/deleted.json")
 
-        allow(client_double).to receive(:instance_variable_get).with(:@dashboard_service).and_return(api_service_double)
-        allow(api_service_double).to receive(:request).with(Net::HTTP::Get,
-                                                            '/api/v1/dashboard',
-                                                            nil,
-                                                            nil,
-                                                            false).and_return(all_boards)
-        allow(api_service_double).to receive(:request).with(Net::HTTP::Get,
-                                                            '/api/v1/dashboard/stillthere',
-                                                            nil,
-                                                            nil,
-                                                            false).and_return(['200', {}])
-        allow(api_service_double).to receive(:request).with(Net::HTTP::Get,
-                                                            '/api/v1/dashboard/alsostillthere',
-                                                            nil,
-                                                            nil,
-                                                            false).and_return(['200', {}])
+        stubs.get('/api/v1/dashboard') { all_dashboards }
+        stubs.get('/api/v1/dashboard/stillthere') {[200, {}, {}]}
+        stubs.get('/api/v1/dashboard/alsostillthere') {[200, {}, {}]}
       end
 
       it 'deletes the file locally as well' do
@@ -107,7 +66,6 @@ describe DatadogBackup::Cli do
       dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs2.json")
       dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs3.json")
       allow(dashboards).to receive(:get_by_id).and_return({ 'text' => 'diff2' })
-      allow(cli).to receive(:initialize_client).and_return(client_double)
     end
 
     it {
@@ -125,7 +83,6 @@ describe DatadogBackup::Cli do
     before do
       dashboards.write_file('{"text": "diff"}', "#{tempdir}/dashboards/diffs1.json")
       allow(dashboards).to receive(:get_by_id).and_return({ 'text' => 'diff2' })
-      allow(cli).to receive(:initialize_client).and_return(client_double)
     end
 
     example 'starts interactive restore' do

data/spec/datadog_backup/core_spec.rb

@@ -3,42 +3,23 @@
 require 'spec_helper'
 
 describe DatadogBackup::Core do
-  let(:api_service_double) { double(Dogapi::APIService) }
-  let(:client_double) { double }
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
   let(:tempdir) { Dir.mktmpdir }
   let(:core) do
-    described_class.new(
+    core = described_class.new(
       action: 'backup',
-      api_service: api_service_double,
-      client: client_double,
       backup_dir: tempdir,
       diff_format: nil,
       resources: [],
       output_format: :json
     )
+    allow(core).to receive(:api_service).and_return(api_client_double)
+    return core
   end
 
-  describe '#client' do
-    subject { core.client }
 
-    it { is_expected.to eq client_double }
-  end
-
-  describe '#with_200' do
-    context 'with 200' do
-      subject { core.with_200 { ['200', { foo: :bar }] } }
-
-      it { is_expected.to eq({ foo: :bar }) }
-    end
 
-    context 'with not 200' do
-      subject { core.with_200 { ['400', 'Error message'] } }
-
-      it 'raises an error' do
-        expect { subject }.to raise_error(RuntimeError)
-      end
-    end
-  end
 
   describe '#diff' do
     subject { core.diff('diff') }
@@ -83,52 +64,44 @@ describe DatadogBackup::Core do
   describe '#create' do
     subject { core.create({ 'a' => 'b' }) }
 
-    example 'it calls Dogapi::APIService.request' do
-      stub_const('Dogapi::APIService::API_VERSION', 'v1')
-      allow(core).to receive(:api_service).and_return(api_service_double)
+    example 'it will post /api/v1/dashboard' do
       allow(core).to receive(:api_version).and_return('v1')
       allow(core).to receive(:api_resource_name).and_return('dashboard')
-      expect(api_service_double).to receive(:request).with(Net::HTTP::Post,
-                                                           '/api/v1/dashboard',
-                                                           nil,
-                                                           { 'a' => 'b' },
-                                                           true).and_return(['200', { 'id' => 'whatever-id-abc' }])
+      stubs.post('/api/v1/dashboard', {'a' => 'b'}) {[200, {},  {'id' => 'whatever-id-abc' }]}
       subject
+      stubs.verify_stubbed_calls
     end
   end
 
   describe '#update' do
     subject { core.update('abc-123-def', { 'a' => 'b' }) }
 
-    example 'it calls Dogapi::APIService.request' do
-      stub_const('Dogapi::APIService::API_VERSION', 'v1')
-      allow(core).to receive(:api_service).and_return(api_service_double)
+    example 'it puts /api/v1/dashboard' do
       allow(core).to receive(:api_version).and_return('v1')
       allow(core).to receive(:api_resource_name).and_return('dashboard')
-      expect(api_service_double).to receive(:request).with(Net::HTTP::Put,
-                                                           '/api/v1/dashboard/abc-123-def',
-                                                           nil,
-                                                           { 'a' => 'b' },
-                                                           true).and_return(['200', { 'id' => 'whatever-id-abc' }])
+      stubs.put('/api/v1/dashboard/abc-123-def', {'a' => 'b'}) {[200, {},  {'id' => 'whatever-id-abc' }]}
       subject
+      stubs.verify_stubbed_calls
+    end
+
+    context 'when the id is not found' do
+      before do
+        allow(core).to receive(:api_version).and_return('v1')
+        allow(core).to receive(:api_resource_name).and_return('dashboard')
+        stubs.put('/api/v1/dashboard/abc-123-def', {'a' => 'b'}) {[404, {},  {'id' => 'whatever-id-abc' }]}
+      end
+      it 'raises an error' do
+        expect { subject }.to raise_error(RuntimeError, 'update failed with error 404')
+      end
     end
   end
 
   describe '#restore' do
     before do
-      allow(core).to receive(:api_service).and_return(api_service_double)
       allow(core).to receive(:api_version).and_return('api-version-string')
       allow(core).to receive(:api_resource_name).and_return('api-resource-name-string')
-      allow(api_service_double).to receive(:request).with(Net::HTTP::Get,
-                                                          '/api/api-version-string/api-resource-name-string/abc-123-def',
-                                                          nil,
-                                                          nil,
-                                                          false).and_return(['200', { test: :ok }])
-      allow(api_service_double).to receive(:request).with(Net::HTTP::Get,
-                                                          '/api/api-version-string/api-resource-name-string/bad-123-id',
-                                                          nil,
-                                                          nil,
-                                                          false).and_return(['404', { error: :blahblah_not_found }])
+      stubs.get('/api/api-version-string/api-resource-name-string/abc-123-def') {[200, {},  {'test'  => 'ok' }]}
+      stubs.get('/api/api-version-string/api-resource-name-string/bad-123-id') {[404, {},  {'error'  => 'blahblah_not_found' }]}
       allow(core).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
     end
 
@@ -141,19 +114,13 @@ describe DatadogBackup::Core do
       end
     end
 
-    context 'when id does not exist' do
+    context 'when id does not exist on remote' do
       subject { core.restore('bad-123-id') }
 
       before do
-        allow(api_service_double).to receive(:request).with(Net::HTTP::Put,
-                                                            '/api/api-version-string/api-resource-name-string/bad-123-id',
-                                                            nil, { 'load' => 'ok' },
-                                                            true).and_return(['404', { 'Error' => 'my not found' }])
-        allow(api_service_double).to receive(:request).with(Net::HTTP::Post,
-                                                            '/api/api-version-string/api-resource-name-string',
-                                                            nil,
-                                                            { 'load' => 'ok' },
-                                                            true).and_return(['200', { 'id' => 'my-new-id' }])
+        allow(core).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
+        stubs.put('/api/api-version-string/api-resource-name-string/bad-123-id') {[404, {},  {'error'  => 'id not found' }]}
+        stubs.post('/api/api-version-string/api-resource-name-string', {'load' => 'ok'}) {[200, {},  {'id' => 'my-new-id' }]}
       end
 
       example 'it calls out to create then saves the new file and deletes the new file' do

data/spec/datadog_backup/dashboards_spec.rb

@@ -3,17 +3,18 @@
 require 'spec_helper'
 
 describe DatadogBackup::Dashboards do
-  let(:api_service_double) { double(Dogapi::APIService) }
-  let(:client_double) { double }
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
   let(:tempdir) { Dir.mktmpdir }
   let(:dashboards) do
-    described_class.new(
+    dashboards = described_class.new(
       action: 'backup',
-      client: client_double,
       backup_dir: tempdir,
       output_format: :json,
       resources: []
     )
+    allow(dashboards).to receive(:api_service).and_return(api_client_double)
+    return dashboards
   end
   let(:dashboard_description) do
     {
@@ -22,9 +23,10 @@ describe DatadogBackup::Dashboards do
       'title' => 'foo'
     }
   end
-  let(:all_boards) do
+  let(:all_dashboards) do
     [
-      '200',
+      200,
+      {},
       {
         'dashboards' => [
           dashboard_description
@@ -34,7 +36,8 @@ describe DatadogBackup::Dashboards do
   end
   let(:example_dashboard) do
     [
-      '200',
+      200,
+      {},
       board_abc_123_def
     ]
   end
@@ -60,11 +63,8 @@ describe DatadogBackup::Dashboards do
   end
 
   before do
-    allow(client_double).to receive(:instance_variable_get).with(:@dashboard_service).and_return(api_service_double)
-    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, '/api/v1/dashboard', nil, nil,
-                                                        false).and_return(all_boards)
-    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, '/api/v1/dashboard/abc-123-def', nil, nil,
-                                                        false).and_return(example_dashboard)
+    stubs.get('/api/v1/dashboard') { all_dashboards }
+    stubs.get('/api/v1/dashboard/abc-123-def') { example_dashboard }
   end
 
   describe '#backup' do
@@ -80,8 +80,8 @@ describe DatadogBackup::Dashboards do
     end
   end
 
-  describe '#all_boards' do
-    subject { dashboards.all_boards }
+  describe '#all_dashboards' do
+    subject { dashboards.all_dashboards }
 
     it { is_expected.to eq [dashboard_description] }
   end

data/spec/datadog_backup/local_filesystem_spec.rb

@@ -3,12 +3,10 @@
 require 'spec_helper'
 
 describe DatadogBackup::LocalFilesystem do
-  let(:client_double) { double }
   let(:tempdir) { Dir.mktmpdir }
   let(:core) do
     DatadogBackup::Core.new(
       action: 'backup',
-      client: client_double,
       backup_dir: tempdir,
       resources: [DatadogBackup::Dashboards],
       output_format: :json
@@ -17,7 +15,6 @@ describe DatadogBackup::LocalFilesystem do
   let(:core_yaml) do
     DatadogBackup::Core.new(
       action: 'backup',
-      client: client_double,
       backup_dir: tempdir,
       resources: [],
       output_format: :yaml

data/spec/datadog_backup/monitors_spec.rb

@@ -3,18 +3,20 @@
 require 'spec_helper'
 
 describe DatadogBackup::Monitors do
-  let(:api_service_double) { double(Dogapi::APIService) }
-  let(:client_double) { double }
+  let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+  let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
   let(:tempdir) { Dir.mktmpdir }
   let(:monitors) do
-    described_class.new(
+    monitors = described_class.new(
       action: 'backup',
-      client: client_double,
       backup_dir: tempdir,
       output_format: :json,
       resources: []
     )
+    allow(monitors).to receive(:api_service).and_return(api_client_double)
+    return monitors
   end
+
   let(:monitor_description) do
     {
       'query' => 'bar',
@@ -35,7 +37,8 @@ describe DatadogBackup::Monitors do
   end
   let(:all_monitors) do
     [
-      '200',
+      200,
+      {},
       [
         monitor_description
       ]
@@ -43,17 +46,15 @@ describe DatadogBackup::Monitors do
   end
   let(:example_monitor) do
     [
-      '200',
+      200,
+      {},
       monitor_description
     ]
   end
 
   before do
-    allow(client_double).to receive(:instance_variable_get).with(:@monitor_svc).and_return(api_service_double)
-    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, '/api/v1/monitor', nil, nil,
-                                                        false).and_return(all_monitors)
-    allow(api_service_double).to receive(:request).with(Net::HTTP::Get, '/api/v1/dashboard/123455', nil, nil,
-                                                        false).and_return(example_monitor)
+    stubs.get('/api/v1/monitor') { all_monitors }
+    stubs.get('/api/v1/dashboard/123455') { example_monitor }
   end
 
   describe '#all_monitors' do
@@ -78,9 +79,10 @@ describe DatadogBackup::Monitors do
   describe '#diff and #except' do
     example 'it ignores `overall_state` and `overall_state_modified`' do
       monitors.write_file(monitors.dump(monitor_description), monitors.filename(123_455))
-      allow(api_service_double).to receive(:request).and_return(
+      stubs.get('/api/v1/dashboard/123455') {
         [
-          '200',
+          200,
+          {},
           [
             {
               'query' => 'bar',
@@ -92,7 +94,7 @@ describe DatadogBackup::Monitors do
             }
           ]
         ]
-      )
+      }
 
       expect(monitors.diff(123_455)).to eq ''
 

data/spec/datadog_backup_bin_spec.rb

@@ -17,13 +17,13 @@ describe 'bin/datadog_backup' do
         i.close
       end
 
-      Timeout.timeout(2.0) do
+      Timeout.timeout(4.0) do
         oe.each do |v|
           output += v
         end
       end
     rescue Timeout::Error
-      LOGGER.warn "Timing out #{t.inspect} after 2 second"
+      LOGGER.error "Timing out #{t.inspect} after 4 second"
       Process.kill(15, pid)
     ensure
       status = t.value
@@ -32,8 +32,8 @@ describe 'bin/datadog_backup' do
   end
 
   required_vars = %w[
-    DATADOG_API_KEY
-    DATADOG_APP_KEY
+    DD_API_KEY
+    DD_APP_KEY
   ]
 
   env = {}
@@ -52,7 +52,7 @@ describe 'bin/datadog_backup' do
   it 'supplies help' do
     stub_const('ENV', env)
     out_err, status = run_bin('--help')
-    expect(out_err).to match(/Usage: DATADOG_API_KEY=/)
+    expect(out_err).to match(/Usage: DD_API_KEY=/)
     expect(status).to be_success
   end
 end

data/spec/spec_helper.rb

@@ -4,12 +4,11 @@ $LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
 
 require 'logger'
 $stdout.sync = $stderr.sync = true
-LOGGER = Logger.new('/dev/null')
-LOGGER.level = Logger::INFO
+LOGGER = Logger.new($stderr)
+LOGGER.level = Logger::ERROR
 $stdout = File.new('/dev/null', 'w+')
 
 require 'tmpdir'
-require 'dogapi'
 require 'datadog_backup'
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog_backup
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0.alpha.1
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,78 +9,92 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-11 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: deepsort
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: dogapi
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.45.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.45.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -226,12 +254,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: