dnsmadeeasy 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1a352b3b93d581bfe8c2e6711071b7692abf19cf
-  data.tar.gz: 6e39787c4c754e78fd69821bc4b3ad19d582bebe
+SHA256:
+  metadata.gz: ed2f0693df9db3d005273c6ce41b114aab36b57516c84ed47ef7e27bd4a35339
+  data.tar.gz: 39389e4043a3976819594a40f4f8d64e1c653244c14783a6d08d59176bb06ed6
 SHA512:
-  metadata.gz: 2e38fc6b2cbe5fb7303458545d58d0e60ae53cea1e8518e373aff3e058bf5c7f6c77ca1506e062b5fb5e17e932afaa663526100deca97e00bf3702dda85cb067
-  data.tar.gz: b1f21eeb6ffe587c63d9ff5eab93a6afdfeb5765e14429d1951235522159d36cb8438b677480ae50a367d46e1212ef3ab99864f3ae52f60886eaaa680875b5c8
+  metadata.gz: 5f4f38240929d627ae8ad99d80255bf14d8cad007144876d856504a0a126370964dea4d521e54eceb99694bd13df4ef09ca7acea91f22a0ddaafc582e8c3fe13
+  data.tar.gz: 63a1ec57791474e042312bd6fdaa2ebaeba7b8b88f24d590bf9f5b620ea5f8dcd3dc5fcdf0a286652eee1a0bbb94ace257ee9bd20ba141e458c59b65f6d36874

data/README.md

@@ -37,18 +37,7 @@ Once you have the key and the secret, you have several choices:
 
      DnsMadeEasy.domains.data.first.name #=> 'moo.gamespot.com'     
      ```
-
-     Once you configure the keys, you can also use the shortcut module to save you some typing:
-     
-     ```ruby
-     require 'dnsmadeeasy/dme'
-     DME.domains.data.first.name #=> 'moo.gamespot.com'
-     ```
-     
-     This has the advantage of being much shorter, but might conflict with existing modules in your Ruby VM. 
-     In this case, just do not require `dnsmadeeasy/dme` and only require `dnsmadeeasy`, and you'll be fine.
-     Otherwise, using `DME` is identical to using `DnsMadeEasy`, assuming you required `dnsmadeeasy/dme` file.
-
+  
   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`.
@@ -85,16 +74,45 @@ Once you have the key and the secret, you have several choices:
      
      ```ruby
      require 'dnsmadeeasy'
-     DnsMadeEasy.configure_from_file(file, account_name = nil, encryption_key = nil)
+     DnsMadeEasy.configure_from_file(file, account = nil, encryption_key = nil)
 
      # for example:
      DnsMadeEasy.configure_from_file('config/dme.yaml', 'production')
      DnsMadeEasy.domains #=> [ ... ]
 
      # or with encrypted key passed as an argument to decrypt YAML values:
-     DnsMadeEasy.configure_from_file('config/dme.yaml', 'production', ENV['PRODUCTION_KEY'])
+     DnsMadeEasy.configure_from_file(
+         '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
+     @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.
+
+___
+
+Once you configure the keys, you can also use the shortcut module to save you some typing:
+
+```ruby
+require 'dnsmadeeasy/dme'
+DME.domains.data.first.name #=> 'moo.gamespot.com'
+```
+
+This has the advantage of being much shorter, but might conflict with existing modules in your Ruby VM. 
+In this case, just do not require `dnsmadeeasy/dme` and only require `dnsmadeeasy`, and you'll be fine.
+Otherwise, using `DME` is identical to using `DnsMadeEasy`, assuming you required `dnsmadeeasy/dme` file.
+   
+
 ### Which Namespace to Use? What is `DME` versus `DnsMadeEasy`?
 
 Since `DnsMadeEasy` is a bit of a mouthful, we decided to offer (in addition to the standard `DnsMadeEasy` namespace) the abbreviated module `DME` that simply forwards all messages to the module `DnsMadeEasy`. If in your Ruby VM there is no conflicting top-level class `DME`, then you can `require 'dnsmadeeasy/dme'` to get all of the DnsMadeEasy client library functionality without having to type the full name once. You can even do `require 'dme'`.

data/dnsmadeeasy.gemspec

@@ -6,9 +6,11 @@ require 'dnsmadeeasy/version'
 
 DnsMadeEasy::DESCRIPTION = <<-eof
 This is a fully-featured DNS API client for DnsMadeEasy.com, that includes
-both the Ruby API and (soon to follow – a CLI). This gem used to be called
-dnsmadeeasy-rest-api, but the original author Phil Cohen kindly passed on
-the RubyGems namespace, and now you can install just plane simple "dnsmadeeasy".
+both the Ruby API and a corresponding CLI interface. This gem is based on the 
+"dnsmadeeasy-rest-api". We also wish to thank the original author Phil Cohen who 
+kindly passed on the RubyGems namespace, and now you can install just plain simple
+install "dnsmadeeasy" gem. The gem additionally supports storing credentials in the
+~/.dnsmadeeasy/credentials.yml file, supports multiple accounts, encryption, and more.
 eof
 
 Gem::Specification.new do |spec|

data/lib/dme.rb

@@ -15,7 +15,3 @@ module DME
     end
   end
 end
-
-
-
-

data/lib/dnsmadeeasy.rb

@@ -3,6 +3,7 @@ module DnsMadeEasy
   API_BASE_URL_SANDBOX    = 'https://sandboxapi.dnsmadeeasy.com/V2.0'
 end
 
+require 'dnsmadeeasy/version'
 require 'dnsmadeeasy/credentials'
 require 'dnsmadeeasy/api/client'
 
@@ -31,12 +32,12 @@ module DnsMadeEasy
     end
 
     def configure_from_file(file = nil,
-                            account_name = nil,
+                            account = nil,
                             encryption_key = nil)
 
       credentials = ::DnsMadeEasy::Credentials.keys_from_file(
-        filename:       file || ::DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER']),
-        account_name:   account_name,
+        file:           file || ::DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER']),
+        account:        account,
         encryption_key: encryption_key)
       if credentials
         configure do |config|
@@ -48,6 +49,15 @@ module DnsMadeEasy
       end
     end
 
+    def credentials_from_file(file: DnsMadeEasy::Credentials.default_credentials_path,
+                              account: nil,
+                              encryption_key: nil)
+
+      DnsMadeEasy::Credentials.keys_from_file file:           file,
+                                              account:        account,
+                                              encryption_key: encryption_key
+    end
+
     def api_key=(value)
       self.default_api_key = value
     end

data/lib/dnsmadeeasy/credentials.rb

@@ -23,7 +23,7 @@ module DnsMadeEasy
   #    api_secret: 43009899-abcc-ffcc-eeee-09f809808098
   # ````
   #
-  #         @creds = DnsMadeEasy::Credentials.keys_from_file(filename: file)
+  #         @creds = DnsMadeEasy::Credentials.keys_from_file(file: file)
   #         @creds.api_key #=> '12345678-a8f8-4466-ffff-2324aaaa9098'
   #
   # #### From a default filename ~/.dnsmadeeasy/credentials.yml
@@ -55,7 +55,7 @@ module DnsMadeEasy
   # ```
   #
   # Here we have multiple credentials account, one of which can have 'default_account: true'
-  # Each account has a name that's used in `account_name` argument. Finally, if the keys
+  # Each account has a name that's used in `account` argument. Finally, if the keys
   # are encrypted, the key can either be referenced in the YAML file itself (in the above
   # case it points to a file name — see documentation on the gem Sym about various formats
   # of the key).
@@ -64,8 +64,8 @@ module DnsMadeEasy
   # actually specifies the key.
   #
   #         @creds = DnsMadeEasy::Credentials.keys_from_file(
-  #                            filename: 'spec/fixtures/credentials-multi-account.yml',
-  #                            account_name: 'production')
+  #                            file: 'spec/fixtures/credentials-multi-account.yml',
+  #                            account: 'production')
   #
   #
   # )
@@ -79,12 +79,12 @@ module DnsMadeEasy
         ApiKeys.new(key, secret, encryption_key)
       end
 
-      def keys_from_file(filename: default_credentials_path,
-                         account_name: nil,
+      def keys_from_file(file: default_credentials_path,
+                         account: nil,
                          encryption_key: nil)
 
-        YamlFile.new(filename: filename).keys(account_name:   account_name,
-                                    encryption_key: encryption_key)
+        YamlFile.new(file: file).keys(account:        account,
+                                      encryption_key: encryption_key)
       end
 
       # @return String path to the default credentials file.

data/lib/dnsmadeeasy/credentials/api_keys.rb

@@ -17,15 +17,15 @@ module DnsMadeEasy
                   :api_secret,
                   :encryption_key,
                   :default,
-                  :account_name
+                  :account
 
       include Sym
 
-      def initialize(key, secret, encryption_key = nil, default: false, account_name: nil)
+      def initialize(key, secret, encryption_key = nil, default: false, account: nil)
         raise InvalidCredentialKeys, "Key and Secret can not be nil" if key.nil? || secret.nil?
 
         @default      = default
-        @account_name = account_name
+        @account = account
 
         if !valid?(key, secret) && encryption_key
           @encryption_key = sym_resolve(encryption_key)

data/lib/dnsmadeeasy/credentials/yaml_file.rb

@@ -10,24 +10,27 @@ module DnsMadeEasy
     class YamlFile
       attr_accessor :filename, :account, :mash
 
-      def initialize(filename: default_credentials_path)
-        self.filename = filename
+      def initialize(file: default_credentials_path)
+        self.filename = file
         parse! if exist?
       end
 
-      def keys(account_name: nil, encryption_key: nil)
+      def keys(account: nil, encryption_key: nil)
         return nil unless exist?
         return nil if mash.nil?
 
         creds = if mash.accounts.is_a?(Array)
-                  account = if account_name
-                              mash.accounts.find { |a| a.name == account_name.to_s }
+                  account = if account
+                              mash.accounts.find { |a| a.name == account.to_s }
+                            elsif
+                              mash.accounts.size == 1
+                              mash.accounts.first
                             else
                               mash.accounts.find { |a| a.default_account }
                             end
 
                   raise DnsMadeEasy::APIKeyAndSecretMissingError,
-                        (account_name ? "account #{account_name} was not found" : 'default account does not exist') unless account
+                        (account ? "account #{account} was not found" : 'default account does not exist') unless account
 
                   raise DnsMadeEasy::InvalidCredentialsFormatError,
                         'Expected account entry to have "credentials" key' unless account.credentials

data/lib/dnsmadeeasy/runner.rb

@@ -107,7 +107,7 @@ module DnsMadeEasy
 
     def configure_authentication
       keys = DnsMadeEasy::Credentials.keys_from_file(
-        filename: ENV['DNSMADEEASY_CREDENTIALS_FILE'] || DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER'])
+        file: ENV['DNSMADEEASY_CREDENTIALS_FILE'] || DnsMadeEasy::Credentials.default_credentials_path(user: ENV['USER'])
       )
       if keys
         DnsMadeEasy.api_key = keys.api_key

data/lib/dnsmadeeasy/version.rb

@@ -1,3 +1,3 @@
 module DnsMadeEasy
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.3.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnsmadeeasy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sym
@@ -182,11 +182,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |
-  This is a fully-featured DNS API client for DnsMadeEasy.com, that includes
-  both the Ruby API and (soon to follow – a CLI). This gem used to be called
-  dnsmadeeasy-rest-api, but the original author Phil Cohen kindly passed on
-  the RubyGems namespace, and now you can install just plane simple "dnsmadeeasy".
+description: "This is a fully-featured DNS API client for DnsMadeEasy.com, that includes\nboth
+  the Ruby API and a corresponding CLI interface. This gem is based on the \n\"dnsmadeeasy-rest-api\".
+  We also wish to thank the original author Phil Cohen who \nkindly passed on the
+  RubyGems namespace, and now you can install just plain simple\ninstall \"dnsmadeeasy\"
+  gem. The gem additionally supports storing credentials in the\n~/.dnsmadeeasy/credentials.yml
+  file, supports multiple accounts, encryption, and more.\n"
 email:
 - kigster@gmail.com
 - letuboy@gmail.com
@@ -242,11 +243,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: This is a fully-featured DNS API client for DnsMadeEasy.com, that includes
-  both the Ruby API and (soon to follow – a CLI). This gem used to be called dnsmadeeasy-rest-api,
-  but the original author Phil Cohen kindly passed on the RubyGems namespace, and
-  now you can install just plane simple "dnsmadeeasy".
+  both the Ruby API and a corresponding CLI interface. This gem is based on the  "dnsmadeeasy-rest-api".
+  We also wish to thank the original author Phil Cohen who  kindly passed on the RubyGems
+  namespace, and now you can install just plain simple install "dnsmadeeasy" gem.
+  The gem additionally supports storing credentials in the ~/.dnsmadeeasy/credentials.yml
+  file, supports multiple accounts, encryption, and more.
 test_files: []