dnsmadeeasy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a097d8e189dfd1af0b1e67e8c5dd6a2f3ef1f5e8
-  data.tar.gz: 1fe1562800afd9096af3ab76c447e62892c1db82
+  metadata.gz: e64f1077e858bdf6f2f0610f25435d4a5e47ba76
+  data.tar.gz: b9960e5fc0e030d18bd0cb94688ca7d816ea8547
 SHA512:
-  metadata.gz: 0b72394aa5432cd4cd0377b69ea325f486569ab42805286d6ec356fbdfc425efb550d7fd89c9c5db4f87ab8b26fd58a07a9fc0a64acea649b3b62c21e3a1da20
-  data.tar.gz: fadef2632686a40a0ac0dbf9d6f60822e191d7c6c1322aff1702a308d47c4a0f4a458167e2182a379eebfe23cd08e06738161bc152c48a98e08e6ce5421bf043
+  metadata.gz: '08d663e73e365d22490e6066e94342aedc03519ad40a2a7ce99909a7b6369aa5344d6697c0410c5a8e6bb2e4935c3eaabdf78d862a6132be837a43ed4c2311e6'
+  data.tar.gz: 8f6b7e12f70dafd2ec645ef21edad1dc81af84b69fa8193996060d0dd06dac71ed2bd27c9e23827f4225368408a88b6275b1ec734b4c21ca629bfee44b17ef6f

data/.travis.yml

@@ -1,6 +1,6 @@
 env:
   global:
-  - CC_TEST_REPORTER_ID=f8f229bdf1f374a3a9227d3bef6f57b78f88c73a2d4705c9de5852bb484eaaef
+  - CC_TEST_REPORTER_ID=6883fa6e8b9493573f7c6daeea4c33c0964a07d1b3e87bee799425cd72875a3e
 sudo: false
 language: ruby
 cache: bundler
@@ -17,10 +17,4 @@ script:
 - bundle exec rspec
 after_script:
 - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
-notifications:
-  webhooks:
-    urls:
-      - secure: fgpv34jAm3rDNjiWuQtuijE0p9B2bpsCWdoCQ82pDZwktSITmNjanYCoZC0hlEw/kqMBDKRN78HfIIidy8dS664sLz8KyaFXq7RWAFsMP9fn/GMG/r9B+S3YumifQ/Zy+3OGa+0Qz76075q291QfNSPv0Y5QDMoAU5VljIVashC/qJS6DRO+vekDaDKIhi4Dr/+JpHPnjchqS4VaMB8gEIrDpeSYNlhrj1oAI/8GwgqZ8UR4sZGxNpIzUg+XGJSYz5/cAB3P18ENSQvOwaNefJa7qIVNjMD7YwXKmfX9cyr5RHM5sibq/S5fHH/N7pig+aveTquGGVxInJr1IEDiyr2TsFARjPitp9KJSFLHLsA2jm1cZfNW0/d6ii+51HdLPKorHom3fPjb0jkIe1LPa9CrrjnfSrAE9a/w4qpSnDv7OjAzkieepz+VQCtpQGIzQxJcHWaFX32iZ6RQ6pmKc/22E0OZwsNM2FHrB5V1b+rfczl8Ej7/R1wAOtHWkbLbfwZ9Ux2N0N0EKW8r8cOjEbsxmN8FFQubTwl68uqjJLhEtrOUbM28JM/NkX+Ue1KRw+NJAdMFEZQKPb/b/X6s3nwPD4/4yLyUDCGyr8aGpzSBD5uIu5uSJNiWdNDjcnXtJJ6TlGGZqj91r7FckjA8FuSA6S3yA8epMNG3FTUxPVE=
-    on_success: always
-    on_failure: onchange
-    on_start: never
+

data/README.md

@@ -1,76 +1,144 @@
 [![Gem Version](https://badge.fury.io/rb/dnsmadeeasy.svg)](https://badge.fury.io/rb/dnsmadeeasy)
 [![Build Status](https://travis-ci.org/kigster/dnsmadeeasy.svg?branch=master)](https://travis-ci.org/kigster/dnsmadeeasy)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f2e66c122253167681a2/maintainability)](https://codeclimate.com/github/kigster/dnsmadeeasy/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/f2e66c122253167681a2/test_coverage)](https://codeclimate.com/github/kigster/dnsmadeeasy/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7a48648b482b5a5c9257/maintainability)](https://codeclimate.com/github/kigster/dnsmadeeasy/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7a48648b482b5a5c9257/test_coverage)](https://codeclimate.com/github/kigster/dnsmadeeasy/test_coverage)
 
-DnsMadeEasy — Ruby Client API (Supporting SDK V2.0)
-==============
 
-## Installation
+# DnsMadeEasy — Ruby Client API (Supporting SDK V2.0)
 
-Add this line to your application's Gemfile:
+This is a fully featured REST API client for DnsMadeEasy provider. DME is an **excellent** provider, and is highly recommended for their ease of use, very solid API, and great customer support. They also offer free DNS failover with business accounts, which is highly recommended for the arrays of load balancers in front of your app.
 
-```ruby
-gem 'dnsmadeeasy'
-```
+## Usage
 
-And then execute:
+**DnsMadeEasy** allows you to fetch, create, update DNS records, as long as you know your API key and the secret.
 
-```
-$ bundle
-```
+You can find your API Key and Secret on the [Account Settings Page](https://cp.dnsmadeeasy.com/account/info) of their UI.
 
-Or install it yourself:
+Once you have the key and the secret, you have several choices:
 
-```
-$ gem install dnsmadeeasy
-```
+  1. Perhaps the most conveniently, you can store them in a small YAML file, that must be placed in a specific location within your home folder:  `~/.dnsmadeeasy/credentials.yml`. The file should look like this one below (NOTE: these are not real credentials, btw):
 
-## Usage
+    ```yaml
+    # file: ~/.dnsmadeeasy/credentials.yml
+    credentials:
+      api_key: 2062259f-f666b17-b1fa3b48-042ad4030
+      api_secret: 2265bc3-e31ead-95b286312e-c215b6a0
+    ```
 
-After requiring `dnsmadeeasy` you can either:
+    With this file existing, you can query right away, by using the shortcut module `DME`, such as         
 
- * directly instantiate a new instance of the `DnsMadeEasy::Api::Client` class, 
-by passing your API key and API secret, OR:
+    ```ruby
+    require 'dnsmadeeasy/dme' # this loads a `DME` shortcut.
+    DME.domains.data.first.name #=> 'moo.gamespot.com'
+    ```
 
- * you can use the `DnsMadeEasy.client` method after configuring the key and the secret.
- 
-### Recommended Usage
+  2. Or, you can directly instantiate a new instance of the `Client` class, by passing your API key and API secrets as arguments:
 
-If you are not planning on accessing more than one DnsMadeEasy account from the same Ruby VM, you might prefer the following usage since it's a bit simpler:
+     ```ruby
+     require 'dnsmadeeasy'
+     @client = DnsMadeEasy::Api::Client.new(api_key, api_secret)
+     ```
 
+     The advantage of this method is that you can query multiple DnsMadeEasy accounts from the same Ruby VM. With other methods, only one account can be connected to.
 
-```ruby
-require 'dnsmadeeasy'
-DnsMadeEasy.configure do |config|
-  config.api_key = 'XXXX'
-  config.api_secret = 'YYYY' 
-end
+  3. Or, you can use the `DnsMadeEasy.configure` method to configure the key/secret pair, and then use `DnsMadeEasy` namespace to call the methods:
 
-@client = ::DnsMadeEasy.client
-@client.domain('test.io')
-# => Domain Object
-```
+     ```ruby
+     require 'dnsmadeeasy'
+
+     DnsMadeEasy.configure do |config|
+       config.api_key = 'XXXX'
+       config.api_secret = 'YYYY'
+     end
+
+     DnsMadeEasy.domains.data.first.name #=> 'moo.gamespot.com'     
+     ```
+
+### Shortcut Module `DME` and `DnsMadeEasy` Namespaces
+
+Since `DnsMadeEasy` is a bit of a mouthful, we decided to offer (in addition) the abbreviated module `DME` that simply forwards all method calls to `DnsMadeEasy`. You can now `require 'dme'` to get all of the DnsMadeEasy client library loaded up, assuming it does not clash with any other `dme` file in your project.
+
+And then you can use `DME.method(*args)` as you would on `DnsMadeEasy.method(*args)` or on the instance of the actual worker-horse class of this library, the gorgeous blone with a very long name: `DnsMadeEasy::Api::Client`.
+
+
+### Examples
+
+If you are not planning on accessing more than one DnsMadeEasy account from the same Ruby VM, it's recommended to save the credentials in the above mentioned file. **DO NOT check that file into any repository.**
+
+Assuming my credentials are stored, I can access everything about my domains as follows (let's pretend that I own a bunch of `gamespot` domains):
 
-### Advanced Usage
 
-You can also instantiate a `Client` object with a different set of API key and secret, should you need to manage multiple accounts from within the same Ruby VM. The `DnsMadeEasy.configure` method is not used in this case, and the values passed to the constructor will be used instead.
- 
 ```ruby
-require 'dnsmadeeasy/api/client'
 
-api_key    = 'XXXX'
-api_secret = 'YYYY'
 
-@client = ::DnsMadeEasy::Api::Client.new(api_key, api_secret)  
+IRB(main):003:0> require 'dme' #=> true
+IRB(main):003:0> DME.domains.data.map(&:name)
+ ⤷ ["demo.gamespot.systems",
+      "dev.gamespot.systems",
+             "gamespot.live",
+          "gamespot.systems",
+     "prod.gamespot.systems"
+   ]
+
+IRB(main):008:0> DME.api_key
+ ⤷ "2062259f-f666b17-b1fa3b48-042ad4030"
+
+IRB(main):009:0> DME.api_secret
+ ⤷ "2265bc3-e31ead-95b286312e-c215b6a0"
+
+IRB(main):010:0> @client = DME.client
+ ⤷ #<DnsMadeEasy::Api::Client:0x00007fb6b416a4c8
+    @api_key="2062259f-f666b17-b1fa3b48-042ad4030",
+    @api_secret="2265bc3-e31ead-95b286312e-c215b6a0",
+    @options={},
+    @requests_remaining=149,
+    @request_limit=150,
+    @base_uri="https://api.dnsmadeeasy.com/V2.0">
 ```
 
-#### Module Level Access
+### Return Values
+
+Whever DnsMadeEasy returns is typically a Hash, but we wrap it in a [`Hashie::Mash`](https://github.com/intridea/hashie) instance, which offers some additional benefits, such as the ability to call nested values via method calls instead of using square brackets. You can always call either `to_hash` or `to_h` on an instance of a `Hashie::Mash` to get a pure hash representation.
 
 All return values are the direct JSON responses from DNS Made Easy converted into a Hash.
 
 For more information on the actual JSON API, please refer to the [following PDF document](http://www.dnsmadeeasy.com/integration/pdf/API-Docv2.pdf).
 
+## Method Calls
+
+Here is the complete of all methods supported by the `DnsMadeEasy::Api::Client`:
+
+* `base_uri=`
+* `base_uri`
+* `create_a_record`
+* `create_aaaa_record`
+* `create_cname_record`
+* `create_domain`
+* `create_domains`
+* `create_httpred_record`
+* `create_mx_record`
+* `create_ns_record`
+* `create_ptr_record`
+* `create_record`
+* `create_spf_record`
+* `create_srv_record`
+* `create_txt_record`
+* `delete_all_records`
+* `delete_domain`
+* `delete_record`
+* `delete_records`
+* `domain`
+* `domains`
+* `find_record_id`
+* `find`
+* `get_id_by_domain`
+* `records_for`
+* `request_limit`
+* `requests_remaining`
+* `update_record`
+* `update_records`
+
+
 ### Managing Domains
 
 To retrieve all domains:
@@ -152,7 +220,7 @@ To create a record:
 # Arguments are: domain_name, name, priority, weight, port, value, options = {}
 @client.create_srv_record    ('test.io', 'woah', 1, 5, 80, '127.0.0.1', {})
 # Arguments are: domain_name, name, value, redirectType, description, keywords, title, options = {}
-@client.create_httpred_record('test.io', 'woah', '127.0.0.1', 'STANDARD - 302', 
+@client.create_httpred_record('test.io', 'woah', '127.0.0.1', 'STANDARD - 302',
                               'a description', 'keywords', 'a title', {})
 ```
 
@@ -166,15 +234,15 @@ To update a record:
 To update several records:
 
 ```ruby
-@client.update_records('test.io', 
+@client.update_records('test.io',
   [
-    { 'id'   => 123, 
-      'name' => 'buddy', 
+    { 'id'   => 123,
+      'name' => 'buddy',
       'type' => 'A',
       'value'=> '127.0.0.1'
     }
   ], { 'ttl' => '60' })
-  
+
 ```
 
 To get the number of API requests remaining after a call:
@@ -193,6 +261,26 @@ To get the API request total limit after a call:
 ```
 >Information is not available until an API call has been made
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dnsmadeeasy'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself:
+
+```
+$ gem install dnsmadeeasy
+```
+
 
 ## Development
 
@@ -207,7 +295,7 @@ The current maintainer [Konstantin Gredeskoul](https://github.com/kigster) wishe
  * Arnoud Vermeer for the original `dnsmadeeasy-rest-api` gem
  * Andre Arko, Paul Henry, James Hart formerly of [Wanelo](wanelo.com) fame, for bringing the REST API gem up to the level.
  * Phil Cohen, who graciously transferred the ownership of this gem on RubyGems to the current maintainer.
- 
+
 
 ## Contributing
 

data/dnsmadeeasy.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'hashie'
 
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'simplecov'

data/exe/dme

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'dnsmadeeasy'
-require 'dnsmadeeasy/cli'
+# require 'dnsmadeeasy/cli'
 
-DnsMadeEasy::CLI::Runner.new(ARGV).execute!
+# DnsMadeEasy::CLI::Runner.new(ARGV).execute!
+puts "Not yet implemented"

data/lib/dme.rb

@@ -0,0 +1,17 @@
+require 'dnsmadeeasy'
+
+module DME
+  class << self
+    def method_missing(method, *args, &block)
+      begin
+        DnsMadeEasy.send(method, *args, &block)
+      rescue NameError => e
+        puts "Error: #{e.message}"
+      end
+    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_relative 'dnsmadeeasy/credentials'
 require_relative 'dnsmadeeasy/api/client'
 
 module DnsMadeEasy
@@ -12,12 +13,20 @@ module DnsMadeEasy
   class << self
     attr_accessor :api_key, :api_secret
 
+    def credentials=(file)
+      @creds = ::DnsMadeEasy::Credentials.load(file)
+      if @creds && @creds.valid?
+        configure do |config|
+          config.api_key = @creds.api_key
+          config.api_secret = @creds.api_secret
+        end
+      end
+    end
 
     def configure
       yield(self) if block_given?
     end
 
-
     def client(**options)
       @client ||= create_client(false, **options)
     end
@@ -27,13 +36,30 @@ module DnsMadeEasy
       @sandbox_client ||= create_client(true, **options)
     end
 
+    # Basically delegate it all to the Client instance
+    # if the method call is supported.
+    #
+    def method_missing(method, *args, &block)
+      if client.respond_to?(method)
+        client.send(method, *args, &block)
+      else
+        super(method, *args, &block)
+      end
+    end
+
+    def default!
+      if Credentials.exist?
+        self.credentials = Credentials.default_file
+      end
+    end
 
     private
 
     def create_client(sandbox = false, **options)
+      default! unless api_key && api_secret
       raise APIKeyAndSecretMissingError, 'Please set #api_key and #api_secret' unless api_key && api_secret
       ::DnsMadeEasy::Api::Client.new(api_key, api_secret, sandbox, **options)
     end
-
   end
+
 end

data/lib/dnsmadeeasy/api/client.rb

@@ -3,6 +3,7 @@ require 'openssl'
 require 'json'
 require 'uri'
 require 'net/http'
+require 'hashie/mash'
 
 module DnsMadeEasy
   module Api
@@ -247,7 +248,7 @@ module DnsMadeEasy
 
         unparsed_json = response.body.to_s.empty? ? '{}' : response.body
 
-        JSON.parse(unparsed_json)
+        Hashie::Mash.new(JSON.parse(unparsed_json))
       end
 
 

data/lib/dnsmadeeasy/credentials.rb

@@ -0,0 +1,135 @@
+require 'yaml'
+
+module DnsMadeEasy
+  # Credentials file should look like this:
+  #
+  # Usage:
+  #
+  # Example 1. Assuming file ~/.dnsmadeeasy/credentials.yml exists:
+  #
+  #       DnsMadeEasy::Credentials.exist? #=> true
+  #       creds = DnsMadeEasy::Credentials.load
+  #
+  #       creds.api_key #=> key
+  #       creds.api_secret #=> secret
+  #
+  #
+  # Example 2. Assuming another file: ~/.private/dnsmadeeasy.yml:
+  #
+  #       DnsMadeEasy::Credentials.exist? #=> false
+  #       DnsMadeEasy::Credentials.exist?('~/.private/dnsmadeeasy.yml') #=> true
+  #
+  #       creds = DnsMadeEasy::Credentials.load('~/.private/dnsmadeeasy.yml')
+  #       creds.api_key #=> key
+  #       creds.api_secret #=> secret
+  #
+  #
+  class Credentials < Hash
+    DEFAULT_CREDENTIALS_FILE = File.expand_path('~/.dnsmadeeasy/credentials.yml').freeze
+
+    class CredentialsFileNotFound < StandardError
+    end
+
+    #
+    # Class Methods
+    #
+
+    class << self
+      def exist?(file = DEFAULT_CREDENTIALS_FILE)
+        File.exist?(file)
+      end
+
+      def load(file = DEFAULT_CREDENTIALS_FILE)
+        validate_argument(file)
+
+        new.tap do |local|
+          local.merge!(parse_file(file)) if exist?(file)
+          local.symbolize!
+        end
+      end
+
+      def default_file
+        DEFAULT_CREDENTIALS_FILE
+      end
+
+
+      private
+
+      def validate_argument(file)
+        unless file && File.exist?(file)
+          raise CredentialsFileNotFound, "File #{file} could not be found"
+        end
+      end
+
+
+      def parse_file(file)
+        YAML.load(read_file(file))
+      end
+
+
+      def read_file(file)
+        File.read(file)
+      end
+    end
+
+
+    # Instance Methods
+    # NOTE: we are subclassing Hash, which isn't awesome, but gets the job done.
+
+    def symbolize(param_hash = self)
+      Hash.new.tap { |hash|
+        param_hash.each_pair do |key, key_value|
+          value = recurse_if_needed(key_value)
+          symbolize_key(hash, key, value)
+        end
+      }
+    end
+
+    public
+
+    def valid?
+      api_key && api_secret
+    end
+
+
+    def symbolize!
+      hash = symbolize(self)
+      clear
+      merge!(hash)
+    end
+
+
+    def api_key
+      credentials && credentials[:api_key]
+    end
+
+
+    def api_secret
+      credentials && credentials[:api_secret]
+    end
+
+
+    private
+
+    def symbolize_key(hash, key, value)
+      case key
+        when String, Symbol
+          hash[key.to_sym] = value
+        else
+          hash[key] = value
+      end
+    end
+
+
+    def recurse_if_needed(key_value)
+      key_value.is_a?(Hash) ? symbolize(key_value) : key_value
+    end
+
+
+    def credentials
+      self[:credentials] || {}
+    end
+
+
+  end
+end

data/lib/dnsmadeeasy/dme.rb

@@ -0,0 +1,5 @@
+require_relative '../dme'
+
+
+
+

data/lib/dnsmadeeasy/version.rb

@@ -1,3 +1,3 @@
 module DnsMadeEasy
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dnsmadeeasy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -14,6 +14,20 @@ bindir: exe
 cert_chain: []
 date: 2017-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +165,11 @@ files:
 - bin/setup
 - dnsmadeeasy.gemspec
 - exe/dme
+- lib/dme.rb
 - lib/dnsmadeeasy.rb
 - lib/dnsmadeeasy/api/client.rb
+- lib/dnsmadeeasy/credentials.rb
+- lib/dnsmadeeasy/dme.rb
 - lib/dnsmadeeasy/version.rb
 homepage: https://github.com/kigster/dnsmadeeasy
 licenses: