dnsmadeeasy 0.3.2 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed2f0693df9db3d005273c6ce41b114aab36b57516c84ed47ef7e27bd4a35339
-  data.tar.gz: 39389e4043a3976819594a40f4f8d64e1c653244c14783a6d08d59176bb06ed6
+  metadata.gz: 071e02ddbb88d13234c3a135672e186062472b44f6a0b3227fd4f9b5c5097205
+  data.tar.gz: '04249c110d948a410e2235716b2e05c70fa76667a7dd338d409883f8f03dfa6d'
 SHA512:
-  metadata.gz: 5f4f38240929d627ae8ad99d80255bf14d8cad007144876d856504a0a126370964dea4d521e54eceb99694bd13df4ef09ca7acea91f22a0ddaafc582e8c3fe13
-  data.tar.gz: 63a1ec57791474e042312bd6fdaa2ebaeba7b8b88f24d590bf9f5b620ea5f8dcd3dc5fcdf0a286652eee1a0bbb94ace257ee9bd20ba141e458c59b65f6d36874
+  metadata.gz: df525957ac6b092b428fbd236e85b19ea0d5fda02b7c3a91d813e06ac22376ff7c94e5434fb4b39aa90969c03f926c73efb73b9704686f44c7b84ca10121a8e5
+  data.tar.gz: 356ea81dffbf405a73ffce3e0c8278e6b329746769c983b9397793c50773ec3ec853b430f6f31781f5e9f3a1ca424e3a173a7c54d5727ac79a9be94a081de7ea

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,174 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-12-03 14:53:41 -0800 using RuboCop version 0.77.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: space, no_space
+Layout/HeredocIndentation:
+  Exclude: 
+    - dnsmadeeasy.gemspec
+
+Layout/SpaceInsideParens:
+  Exclude:
+    - 'Rakefile'
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# Offense count: 3
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/credentials/api_keys_spec.rb'
+    - 'spec/lib/dnsmadeeasy/runner_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: MaximumRangeSize.
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'dnsmadeeasy.gemspec'
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 37
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 250
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 12
+
+# Offense count: 11
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 29
+
+# Offense count: 3
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 8
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 1
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Exclude:
+    - 'lib/dnsmadeeasy/credentials.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+    - 'spec/lib/dnsmadeeasy/credentials/yaml_file_spec.rb'
+
+# Offense count: 6
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/dme.rb'
+    - 'lib/dnsmadeeasy.rb'
+    - 'lib/dnsmadeeasy/api/client.rb'
+    - 'lib/dnsmadeeasy/credentials.rb'
+    - 'lib/dnsmadeeasy/credentials/yaml_file.rb'
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 5
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/dnsmadeeasy.rb'
+    - 'lib/dnsmadeeasy/api/client.rb'
+    - 'lib/dnsmadeeasy/credentials/api_keys.rb'
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'Rakefile'
+    - 'dnsmadeeasy.gemspec'
+    - 'lib/dnsmadeeasy/runner.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'lib/dnsmadeeasy.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: only_raise, only_fail, semantic
+Style/SignalException:
+  Exclude:
+    - 'lib/dnsmadeeasy/api/client.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'lib/dnsmadeeasy/credentials/api_keys.rb'
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInArrayLiteral:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'spec/lib/dnsmadeeasy/api/client_spec.rb'
+
+# Offense count: 97
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 305

data/.travis.yml

@@ -5,16 +5,20 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-- 2.4.1
-- 2.3.5
-before_install: gem install bundler -v 1.15.4
+- 2.3.6
+- 2.4.3
+- 2.5.0
+- 2.6.5
+- jruby-9.1.15.0
+before_install: gem install bundler -v 2.0.2
 before_script:
+- gem update --system
 - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
   > ./cc-test-reporter
 - chmod +x ./cc-test-reporter
 - "./cc-test-reporter before-build"
 script:
 - bundle exec rspec
+- bundle exec rubocop
 after_script:
 - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
-

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in dnsmadeeasy.gemspec

data/README.md

@@ -39,40 +39,40 @@ Once you have the key and the secret, you have several choices:
      ```
   
   3. Configuring API keys as above is easy, and can be done using environment variables. Alternatively, it may be convenient to store credentials in a YAML file. 
-
-     * If filename is not specified, there is default location where this file is searched, which is `~/.dnsmadeeasy/credentials.yml`.
-     * If filename is provided, it will be read, and must conform to the following format:
+ 
+    * If filename is not specified, there is default location where this file is searched, which is `~/.dnsmadeeasy/credentials.yml`.
+    * If filename is provided, it will be read, and must conform to the following format:
    
-     **Simple Credentials Format**
+ **Simple Credentials Format**
 
-      ```yaml
-      # file: ~/.dnsmadeeasy/credentials.yml
-      credentials:
-          api_key: 2062259f-f666b17-b1fa3b48-042ad4030
-          api_secret: 2265bc3-e31ead-95b286312e-c215b6a0
-      ```
+  ```yaml
+  # file: ~/.dnsmadeeasy/credentials.yml
+  credentials:
+      api_key: 2062259f-f666b17-b1fa3b48-042ad4030
+      api_secret: 2265bc3-e31ead-95b286312e-c215b6a0
+  ```
 
-     **Multi-Account Credentials Format**
+  **Multi-Account Credentials Format**
      
-     Below you see two accounts, with production key and secret being encrypted. See [further below](#encryption) about encrypting your key and secrets.
-
-      ```yaml
-      accounts:
-        - name: development
-          default_account: true
-          credentials:
-            api_key: 12345678-a8f8-4466-ffff-2324aaaa9098
-            api_secret: 43009899-abcc-ffcc-eeee-09f809808098
-        - name: production
-          credentials:
-            api_key: "BAhTOh1TeW06OkRhdGE6OldyYXBwZXJT............"
-            api_secret: "BAhTOh1TeW06OkRhdGE6OldyYXBwZ............"
-            encryption_key: spec/fixtures/sym.key
-      ```
+  Below you see two accounts, with production key and secret being encrypted. See [further below](#encryption) about encrypting your key and secrets.
 
-     You can use the following method to access both simple and multi-account YAML configurations:
+  ```yaml
+  accounts:
+    - name: development
+      default_account: true
+      credentials:
+        api_key: 12345678-a8f8-4466-ffff-2324aaaa9098
+        api_secret: 43009899-abcc-ffcc-eeee-09f809808098
+    - name: production
+      credentials:
+        api_key: "BAhTOh1TeW06OkRhdGE6OldyYXBwZXJT............"
+        api_secret: "BAhTOh1TeW06OkRhdGE6OldyYXBwZ............"
+        encryption_key: spec/fixtures/sym.key
+  ```
+
+ You can use the following method to access both simple and multi-account YAML configurations:
      
-     ```ruby
+  ```ruby
      require 'dnsmadeeasy'
      DnsMadeEasy.configure_from_file(file, account = nil, encryption_key = nil)
 
@@ -85,17 +85,17 @@ Once you have the key and the secret, you have several choices:
          'config/dme.yaml', 
          'production', 
          ENV['PRODUCTION_KEY'])
-     ```
+   ```
    
   3. Finally, you can use `DME.credentials_from_file` method that, unlike the method above, uses hash arguments:
   
-     ```ruby
+   ```ruby
      @creds = DnsMadeEasy.credentials_from_file(file: 'my-creds.yml', 
                                              account: 'production', 
                                       encryption_key: 'MY_KEY')
      @creds.api_key    # => ...
      @creds.api_secret # => ...
-     ```     
+   ```     
 
      Method above simply returns the credentials instance, but does not "save" it as the default credentials like `configure_from_file`. Therefore, if you need to access multiple accounts at the same time, this method will help you maintain multiple credentials at the same time.
 
@@ -250,6 +250,21 @@ Here is the complete of all methods supported by the `DnsMadeEasy::Api::Client`:
 * `find_first`
 * `find_record_ids`
 
+#### Secondary Domains
+* `secondary_domain`
+* `secondary_domains`
+* `get_id_by_secondary_domain`
+* `create_secondary_domain`
+* `create_secondary_domains`
+* `update_secondary_domains`
+* `delete_secondary_domain`
+
+#### Secondary IpSets
+* `secondary_ip_set`
+* `secondary_ip_sets`
+* `create_secondary_ip_set`
+* `update_secondary_ip_set`
+* `delete_secondary_ip_set`
 
 <a name="encryption"></a>
 
@@ -337,6 +352,9 @@ Valid Operations Are:
   create_ns_record
   create_ptr_record
   create_record
+  create_secondary_domain
+  create_secondary_domains
+  create_secondary_ip_set
   create_spf_record
   create_srv_record
   create_txt_record
@@ -344,15 +362,24 @@ Valid Operations Are:
   delete_domain
   delete_record
   delete_records
+  delete_secondary_domain
+  delete_secondary_ip_set
   domain
   domains
   find_all
   find_first
   find_record_ids
   get_id_by_domain
+  get_id_by_secondary_domain
   records_for
+  secondary_domain
+  secondary_domains
+  secondary_ip_set
+  secondary_ip_sets
   update_record
   update_records
+  update_secondary_domains
+  update_secondary_ip_set
 ```
 
 For example:
@@ -419,6 +446,81 @@ To delete a domain:
 DME.delete_domain        ('test.io')
 ```
 
+### Managing Secondary Domains
+
+To retrieve all secondary domains:
+```ruby
+DME.secondary_domains
+```
+
+To retrieve secondary domain by id:
+
+```ruby
+DME.secondary_domain(domain_id)
+```
+
+To retrieve the id of a domain by the secondary domain name:
+
+```ruby
+DME.get_id_by_secondary_domain('test.io')
+```
+
+To create a secondary domain:
+
+```ruby
+# IP_SET_ID is id of ip_set you want to associate domain with
+DME.create_secondary_domain('test.io', IP_SET_ID)
+
+# Multiple domains can be created by:
+DME.create_secondary_domains(%w[test.io moo.re], IP_SET_ID)
+```
+
+To update a secondary domain:
+
+```ruby
+# IP_SET_ID is id of ip_set you want to associate 
+# DOMAIN_ID is id of domain 
+DME.update_secondary_domains([DOMAIN_ID], IP_SET_ID)
+```
+
+To delete a secondary domain:
+
+```ruby
+DME.delete_secondary_domain('test.io')
+```
+
+### Managing Secondary IpSets
+
+To retrieve all secondary IpSets:
+```ruby
+DME.secondary_ip_sets
+```
+
+To retrieve single ipSet:
+
+```ruby
+DME.secondary_ip_set(IP_SET_ID)
+```
+
+To create an ipSet:
+
+```ruby
+# IP_LIST is list of ips to be associated with this ip_set, like %w[8.8.8.8, 1.1.1.1]
+DME.create_secondary_ip_set('ip-set-name', IP_LIST)
+```
+
+To update an ipSet:
+
+```ruby
+DME.update_secondary_ip_set(IP_SET_ID, 'ip-list-name', IP_LIST)
+```
+
+To delete an ipSet:
+
+```ruby
+DME.delete_secondary_ip_set(IP_SET_ID)
+```
+
 ### Managing Records
 
 To retrieve all records for a given domain name:

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yard'
@@ -13,22 +15,21 @@ task :permissions do
   shell("find . -type d -exec chmod o+x,g+x {} \\;")
 end
 
-task :build => :permissions
+task build: :permissions
 
 YARD::Rake::YardocTask.new(:doc) do |t|
   t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
-  t.options.unshift('--title','DNS Client for DnsMadeEasy')
-  t.after = ->() { exec('open doc/index.html') }
+  t.options.unshift('--title', 'DNS Client for DnsMadeEasy')
+  t.after = -> { exec('open doc/index.html') }
 end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-task :gem => :install do
+task default: :spec
+task gem: :install do
   gem = `ls -1 *.gemspec | sed 's/\.gemspec//g'`.chomp
   puts "gem is #{gem}"
   puts `gem uninstall -ax #{gem}`.chomp
-  file=`ls -1 pkg`.chomp
+  file = `ls -1 pkg`.chomp
   puts `gem install pkg/#{file}`
 end
-