datadog_backup 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7caee2d991c55f7dfc74c86ede132f8668a84a9a3e03edf6804c887e4134f8c3
-  data.tar.gz: 3db5f4353abb8b193477ad34695d8aaa147ed0dd0757bb2e4ee7d39f02ee55c3
+  metadata.gz: 618459125bc84a9d8c48eb2ffb3256163378d26af4d80e92f2c1033110ae9467
+  data.tar.gz: 619212b26a22764af2050375426f19edba44563b867ded709d33a00384468fd9
 SHA512:
-  metadata.gz: 9c192d88ef8ed33736649a9e9672bf92e09f043d92e9909393bc327773e11de011afa22afebc0d000253cfafa25de76aa31c88cb8a903a537b389acbdc9142c2
-  data.tar.gz: f3029bf8449950a2584f0b6e6aa68ed359726e890cd5d399fb5fb715863a2a230d4f07cbfb1e23b67c4d4ae0cecdef3b875b98feae2c49073ad6f33e8edfa5ea
+  metadata.gz: e029e80229c35796bcd28432af89a7c39172b646c4e880dff8df9e1b5ccfb299706ee9b466fe1c5500126fbd03097dd3da4ef0da91d7ee77e256c8c2657c1a2c
+  data.tar.gz: 635beff60e9a93d5946c8e88f4a9ac8e11b56f08d0b03f045814ec0f799714eebc7f2b0d1fa665807151524469aebe024e7954cffd6a8b57a898d9da97f6d74c

data/.gitignore

@@ -119,3 +119,5 @@ spec/helpers/failures.txt
 backup/
 
 .envrc
+
+.vscode

data/.rubocop.yml

@@ -1 +1,78 @@
-require: rubocop-rspec
+require: rubocop-rspec
+
+Gemspec/DateAssignment: # (new in 1.10)
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # (new in 1.18)
+  Enabled: true
+Layout/SpaceBeforeBrackets: # (new in 1.7)
+  Enabled: true
+Lint/AmbiguousAssignment: # (new in 1.7)
+  Enabled: true
+Lint/DeprecatedConstants: # (new in 1.8)
+  Enabled: true
+Lint/DuplicateBranch: # (new in 1.3)
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # (new in 1.1)
+  Enabled: true
+Lint/EmptyBlock: # (new in 1.1)
+  Enabled: true
+Lint/EmptyClass: # (new in 1.3)
+  Enabled: true
+Lint/EmptyInPattern: # (new in 1.16)
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # (new in 1.8)
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # (new in 1.2)
+  Enabled: true
+Lint/NumberedParameterAssignment: # (new in 1.9)
+  Enabled: true
+Lint/OrAssignmentToConstant: # (new in 1.9)
+  Enabled: true
+Lint/RedundantDirGlobSort: # (new in 1.8)
+  Enabled: true
+Lint/SymbolConversion: # (new in 1.9)
+  Enabled: true
+Lint/ToEnumArguments: # (new in 1.1)
+  Enabled: true
+Lint/TripleQuotes: # (new in 1.9)
+  Enabled: true
+Lint/UnexpectedBlockArity: # (new in 1.5)
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # (new in 1.1)
+  Enabled: true
+Naming/InclusiveLanguage: # (new in 1.18)
+  Enabled: true
+Style/ArgumentsForwarding: # (new in 1.1)
+  Enabled: true
+Style/CollectionCompact: # (new in 1.2)
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # (new in 1.1)
+  Enabled: true
+Style/EndlessMethod: # (new in 1.8)
+  Enabled: true
+Style/HashConversion: # (new in 1.10)
+  Enabled: true
+Style/HashExcept: # (new in 1.7)
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # (new in 1.9)
+  Enabled: true
+Style/InPatternThen: # (new in 1.16)
+  Enabled: true
+Style/MultilineInPatternThen: # (new in 1.16)
+  Enabled: true
+Style/NegatedIfElseCondition: # (new in 1.2)
+  Enabled: true
+Style/NilLambda: # (new in 1.3)
+  Enabled: true
+Style/QuotedSymbols: # (new in 1.16)
+  Enabled: true
+Style/RedundantArgument: # (new in 1.4)
+  Enabled: true
+Style/StringChars: # (new in 1.12)
+  Enabled: true
+Style/SwapValues: # (new in 1.1)
+  Enabled: true
+RSpec/IdenticalEqualityAssertion: # (new in 2.4)
+  Enabled: true
+RSpec/Rails/AvoidSetupHook: # (new in 2.4)
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.0.5](https://github.com/scribd/datadog_backup/compare/v1.0.4...v1.0.5) (2021-07-12)
+
+
+### Bug Fixes
+
+* Add documentation for DATADOG_HOST usage ([69acc25](https://github.com/scribd/datadog_backup/commit/69acc2574d17310ee090486ec46cb06ab0f450db))
+
 ## [1.0.4](https://github.com/scribd/datadog_backup/compare/v1.0.3...v1.0.4) (2021-07-08)
 
 

data/Gemfile

@@ -5,7 +5,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'climate_control'
   gem 'guard-rspec'
   gem 'rspec'
   gem 'rubocop'

data/Gemfile.lock

@@ -4,7 +4,6 @@ PATH
     datadog_backup (0.6.0)
       amazing_print (= 1.3.0)
       concurrent-ruby (= 1.1.9)
-      concurrent-ruby-edge (= 0.6.0)
       deepsort (= 0.4.5)
       diffy (= 3.4.0)
       dogapi (= 1.45.0)
@@ -14,19 +13,16 @@ GEM
   specs:
     amazing_print (1.3.0)
     ast (2.4.2)
-    climate_control (1.0.1)
     coderay (1.1.3)
     concurrent-ruby (1.1.9)
-    concurrent-ruby-edge (0.6.0)
-      concurrent-ruby (~> 1.1.6)
     deepsort (0.4.5)
     diff-lcs (1.4.4)
     diffy (3.4.0)
     dogapi (1.45.0)
       multi_json
-    ffi (1.13.1)
-    formatador (0.2.5)
-    guard (2.16.2)
+    ffi (1.15.3)
+    formatador (0.3.0)
+    guard (2.17.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -40,10 +36,10 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    listen (3.2.1)
+    listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.6)
+    lumberjack (1.2.8)
     method_source (1.0.0)
     multi_json (1.15.0)
     nenv (0.3.0)
@@ -51,13 +47,13 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.20.1)
-    parser (3.0.1.1)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.0.0)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     regexp_parser (2.1.1)
@@ -66,15 +62,15 @@ GEM
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+    rspec-support (3.10.2)
     rubocop (1.18.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -91,7 +87,7 @@ GEM
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
     shellany (0.0.1)
-    thor (1.0.1)
+    thor (1.1.0)
     unicode-display_width (2.0.0)
 
 PLATFORMS
@@ -99,7 +95,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  climate_control
   datadog_backup!
   guard-rspec
   pry
@@ -108,4 +103,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.1.4
+   2.2.21

data/README.md

@@ -49,6 +49,18 @@ datadog_backup diffs --backup-dir optional/path/to/backupdir
 datadog_backup restore --backup-dir optional/path/to/backupdir
 ```
 
+## Environment variables
+
+The following environment variables can be set in order to further customize datadog_backup:
+
+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
+
+
 ### Usage in a Github repo
 
 See [example/](https://github.com/scribd/datadog_backup/tree/master/example) for an example implementation as a repo that backs up your Datadog dashboards hourly.

data/bin/datadog_backup

@@ -13,25 +13,24 @@ $stdout.sync = $stderr.sync = true
 LOGGER = Logger.new($stderr) unless defined?(LOGGER)
 LOGGER.level = Logger::INFO
 
-##
-# Default parameters
-@options = {
-  action: nil,
-  datadog_api_key: ENV.fetch('DATADOG_API_KEY'),
-  datadog_app_key: ENV.fetch('DATADOG_APP_KEY'),
-  backup_dir: File.join(ENV.fetch('PWD'), 'backup'),
-  diff_format: :color,
-  resources: [DatadogBackup::Dashboards, DatadogBackup::Monitors],
-  output_format: :yaml,
-  force_restore: false,
-  logger: LOGGER
-}
+def fatal(message)
+  LOGGER.fatal(message)
+  exit 1
+end
+
+def options_valid?(options)
+  %w[backup diffs restore].include?(options[:action]) &&
+    options[:datadog_api_key] &&
+    options[:datadog_app_key]
+end
 
-def prereqs
+def prereqs(defaults)
   ARGV << '--help' if ARGV.empty?
 
+  result = defaults.dup
+
   options = OptionParser.new do |opts|
-    opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} <backup|diffs|restore>"
+    opts.banner = "Usage: DATADOG_API_KEY=abc123 DATADOG_APP_KEY=abc123 #{File.basename($PROGRAM_NAME)} <backup|diffs|restore>"
     opts.separator ''
     opts.on_tail('-h', '--help', 'Show this message') do
       puts opts
@@ -47,40 +46,49 @@ def prereqs
       LOGGER.level = Logger::ERROR
     end
     opts.on('--backup-dir PATH', '`backup` by default') do |path|
-      @options[:backup_dir] = path
+      result[:backup_dir] = path
     end
     opts.on('--monitors-only') do
-      @options[:resources] = [DatadogBackup::Monitors]
+      result[:resources] = [DatadogBackup::Monitors]
     end
     opts.on('--dashboards-only') do
-      @options[:resources] = [DatadogBackup::Dashboards]
+      result[:resources] = [DatadogBackup::Dashboards]
     end
     opts.on(
       '--json',
       'format backups as JSON instead of YAML. Does not impact `diffs` nor `restore`, but do not mix formats in the same backup-dir.'
     ) do
-      @options[:output_format] = :json
+      result[:output_format] = :json
     end
     opts.on('--no-color', 'removes colored output from diff format') do
-      @options[:diff_format] = nil
+      result[:diff_format] = nil
     end
     opts.on('--diff-format FORMAT', 'one of `color`, `html_simple`, `html`') do |format|
-      @options[:diff_format] = format.to_sym
+      result[:diff_format] = format.to_sym
     end
     opts.on('--force-restore', 'force restore to Datadog') do
-      @options[:force_restore] = true
+      result[:force_restore] = true
     end
   end
   options.parse!
 
-  @options[:action] = ARGV.first
-  if %w[backup diffs restore].include?(@options[:action])
-  else
-    puts options
-    exit 0
-  end
+  result[:action] = ARGV.first
+  fatal(options) unless options_valid?(result)
+  result
 end
 
-prereqs
+##
+# 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],
+  output_format: :yaml,
+  force_restore: false,
+  logger: LOGGER
+}
 
-DatadogBackup::Cli.new(@options).run!
+DatadogBackup::Cli.new(prereqs(defaults)).run!

data/datadog_backup.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'amazing_print', '1.3.0'
   spec.add_dependency 'concurrent-ruby', '1.1.9'
-  spec.add_dependency 'concurrent-ruby-edge', '0.6.0'
   spec.add_dependency 'deepsort', '0.4.5'
   spec.add_dependency 'diffy', '3.4.0'
   spec.add_dependency 'dogapi', '1.45.0'

data/lib/datadog_backup.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'concurrent'
-require 'concurrent-edge'
 
 require 'dogapi'
 

data/lib/datadog_backup/cli.rb

@@ -48,7 +48,7 @@ module DatadogBackup
         Concurrent::Promises
           .zip(*futures)
           .value!
-          .reject { |_k, v| v.nil? }
+          .compact
       )
     end
 

data/lib/datadog_backup/core.rb

@@ -49,6 +49,7 @@ module DatadogBackup
       end
     rescue RuntimeError => e
       return {} if e.message.include?('Request failed with error ["404"')
+
       raise e.message
     end
 

data/lib/datadog_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
 end

data/spec/datadog_backup/cli_spec.rb

@@ -26,6 +26,36 @@ describe DatadogBackup::Cli 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

data/spec/datadog_backup_bin_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'open3'
-require 'climate_control'
 require 'timeout'
 
 describe 'bin/datadog_backup' do
@@ -37,23 +36,24 @@ describe 'bin/datadog_backup' do
     DATADOG_APP_KEY
   ]
 
-  before do
-    required_vars.each do |v|
-      ClimateControl.env[v] = v.downcase
-    end
+  env = {}
+  required_vars.each do |v|
+    env[v] = v.downcase
   end
 
+
   required_vars.map do |v|
     it "dies unless given ENV[#{v}]" do
-      ClimateControl.env[v] = nil
+      stub_const('ENV', env.dup.tap { |h| h.delete(v) })
       _, status = run_bin('backup')
       expect(status).not_to be_success
     end
   end
 
   it 'supplies help' do
+    stub_const('ENV', env)
     out_err, status = run_bin('--help')
-    expect(out_err).to match(/Usage: datadog_backup/)
+    expect(out_err).to match(/Usage: DATADOG_API_KEY=/)
     expect(status).to be_success
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog_backup
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Kamran Farhadi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -39,20 +39,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.9
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby-edge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: deepsort
   requirement: !ruby/object:Gem::Requirement