dnsmadeeasy-rest-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9ddc73dd5d5d013d421ee073808567c2442dae3
+  data.tar.gz: 1483b6715e07ad01e3d7f50c49cd52a665919c47
+SHA512:
+  metadata.gz: bfa52525de4f9326a6a8ed564f768c39bb6198fc50129e6b83dad1c34a2840144ae0b2687a4f1dc96a44164559b50d0de5405c83efc7cc9dc235cbc2e52ce4bc
+  data.tar.gz: 8613bb2c37928fa9a88e4546c6344991d17951a6cadb85d8368fa35cbe9e6bfeaf6eb282949118ba487519253ab6f0a5a017abd4a33182c9e7a26ad3126c9fff

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    dnsmadeeasy-rest-api (1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.3)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dnsmadeeasy-rest-api!
+  rspec
+  webmock

data/README.md

@@ -0,0 +1,12 @@
+Dns Made Easy Api, but better.
+==============
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/dnsmadeeasy-rest-api.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name          = 'dnsmadeeasy-rest-api'
+  s.version       = '1.0.1'
+  s.authors       = ['Paul Henry', 'James Hart']
+  s.email         = 'ops@wanelo.com'
+  s.license       = 'Apache'
+  s.summary       = 'DNS Made Easy V2.0 REST API client for Ruby'
+  s.description   = 'DNS Made Easy V2.0 REST API client for Ruby, but better. With tests and no dependencies.'
+  s.homepage      = 'https://github.com/wanelo/dnsmadeeasy-rest-api'
+
+  s.files         = `git ls-files`.split("\n")
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+end

data/lib/dnsmadeeasy-rest-api.rb

@@ -0,0 +1,197 @@
+require 'time'
+require 'openssl'
+require 'json'
+require 'uri'
+require 'net/http'
+
+class DnsMadeEasy
+
+  attr_accessor :base_uri
+
+  def initialize (api_key, api_secret, sandbox = false)
+    raise "api_key is undefined" unless api_key
+    raise "api_secret is undefined" unless api_secret
+
+    @api_key = api_key
+    @api_secret = api_secret
+
+    if sandbox
+      self.base_uri = 'https://api.sandbox.dnsmadeeasy.com/V2.0'
+    else
+      self.base_uri = 'https://api.dnsmadeeasy.com/V2.0'
+    end
+  end
+
+  # -----------------------------------
+  # ------------- DOMAINS -------------
+  # -----------------------------------
+
+  def get_id_by_domain(domain_name)
+    get("/dns/managed/id/#{domain_name}")['id']
+  end
+
+  def domains
+    get '/dns/managed/'
+  end
+
+  def domain(domain_name)
+    get "/dns/managed/#{get_id_by_domain(domain_name)}"
+  end
+
+  def delete_domain(domain_name)
+    delete "/dns/managed/#{get_id_by_domain(domain_name)}"
+  end
+
+  def create_domains(names)
+    post('/dns/managed/', names: names)
+  end
+
+  def create_domain(domain_name)
+    create_domains([domain_name])
+  end
+
+  # -----------------------------------
+  # ------------- RECORDS -------------
+  # -----------------------------------
+
+  def records_for(domain_name)
+    get "/dns/managed/#{get_id_by_domain(domain_name)}/records"
+  end
+
+  def find_record_id(domain_name, name, type)
+    records = records_for(domain_name)
+
+    records['data'].select { |r| r['name'] == name && r['type'] == type }
+                   .map    { |r| r['id'] }
+  end
+
+  def delete_records(domain_name, ids = [])
+    id = get_id_by_domain(domain_name)
+
+    delete "/dns/managed/#{id}/records/", ids
+  end
+
+  def delete_record(domain_name, record_id)
+    delete "/dns/managed/#{get_id_by_domain(domain_name)}/records/#{record_id}/"
+  end
+
+  def create_record(domain_name, name, type, value, options = {})
+    body = {"name" => name, "type" => type, "value" => value, "ttl" => 3600, "gtdLocation" => "DEFAULT"}
+    post "/dns/managed/#{get_id_by_domain(domain_name)}/records/", body.merge(options)
+  end
+
+  def create_a_record(domain_name, name, value, options = {})
+    # todo: match IPv4 for value
+    create_record domain_name, name, "A", value, options
+  end
+
+  def create_aaaa_record(domain_name, name, value, options = {})
+    # todo: match IPv6 for value
+    create_record domain_name, name, "AAAA", value, options
+  end
+
+  def create_ptr_record(domain_name, name, value, options = {})
+    # todo: match PTR value
+    create_record domain_name, name, "PTR", value, options
+  end
+
+  def create_txt_record(domain_name, name, value, options = {})
+    # todo: match TXT value
+    create_record domain_name, name, "TXT", value, options
+  end
+
+  def create_cname_record(domain_name, name, value, options = {})
+    # todo: match CNAME value
+    create_record domain_name, name, "CNAME", value, options
+  end
+
+  def create_ns_record(domain_name, name, value, options = {})
+    # todo: match domainname for value
+    create_record domain_name, name, "NS", value, options
+  end
+
+  def create_spf_record(domain_name, name, value, options = {})
+    create_record domain_name, name, "SPF", value, options
+  end
+
+  def create_mx_record(domain_name, name, priority, value, options = {})
+    options.merge!({"mxLevel" => priority})
+
+    create_record domain_name, name, "MX", value, options
+  end
+
+  def create_srv_record(domain_name, name, priority, weight, port, value, options = {})
+    options.merge!({"priority" => priority, "weight" => weight, "port" => port})
+    create_record domain_name, name, "SRV", value, options
+  end
+
+  def create_httpred_record(domain_name, name, value, redirectType = "STANDARD - 302", description = "", keywords = "", title = "", options = {})
+    options.merge!({"redirectType" => redirectType, "description" => description, "keywords" => keywords, "title" => title})
+    create_record domain_name, name, "HTTPRED", value, options
+  end
+
+  def update_record(domain, record_id, name, type, value, options = {})
+    body = { "name" => name, "type" => type, "value" => value, "ttl" => 3600, "gtdLocation" => "DEFAULT", "id" => record_id}
+    put "/dns/managed/#{get_id_by_domain(domain)}/records/#{record_id}/", body.merge(options)
+  end
+
+  private
+
+  def get(path)
+    request(path) do |uri|
+      Net::HTTP::Get.new(uri.path)
+    end
+  end
+
+  def delete(path, body = nil)
+    request(path) do |uri|
+      req = Net::HTTP::Delete.new(uri.path)
+      req.body = body.to_json if body
+      req
+    end
+  end
+
+  def put(path, body = nil)
+    request(path) do |uri|
+      req = Net::HTTP::Put.new(uri.path)
+      req.body = body.to_json if body
+      req
+    end
+  end
+
+  def post(path, body)
+    request(path) do |uri|
+      req = Net::HTTP::Post.new(uri.path)
+      req.body = body.to_json
+      req
+    end
+  end
+
+  def request(path)
+    uri = URI("#{base_uri}#{path}")
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+
+    request = yield(uri)
+
+    request_headers.each do |key, value|
+      request[key] = value
+    end
+
+    response = http.request(request)
+
+    JSON.parse(response.body)
+  end
+
+  def request_headers
+    request_date = Time.now.httpdate
+    hmac = OpenSSL::HMAC.hexdigest('sha1', @api_secret, request_date)
+    {
+      'Accept' => 'application/json',
+      'x-dnsme-apiKey' => @api_key,
+      'x-dnsme-requestDate' => request_date,
+      'x-dnsme-hmac' => hmac
+    }
+  end
+end

data/spec/lib/dnsmadeeasyapi-rest-api_spec.rb

@@ -0,0 +1,248 @@
+require 'spec_helper'
+require_relative '../../lib/dnsmadeeasy-rest-api'
+
+describe DnsMadeEasy do
+  let(:api_key) { 'soooo secret' }
+  let(:secret_key) { 'soooo secret' }
+  let(:request_headers) do
+    {'Accept' => 'application/json',
+      'X-Dnsme-Apikey' => 'soooo secret',
+      'X-Dnsme-Hmac' => 'ff6e87e78ff909573362c9a38df13ccc5fa01846',
+      'X-Dnsme-Requestdate' => 'Wed, 21 May 2014 18:08:37 GMT'}
+  end
+
+  subject { DnsMadeEasy.new(api_key, secret_key) }
+
+  before do
+    Time.stub(:now).and_return(Time.parse('Wed, 21 May 2014 18:08:37 GMT'))
+  end
+
+  describe '#get_id_by_domain' do
+
+    let(:response) do
+      "{\"name\":\"something.wanelo.com\",\"id\":1130967}"
+    end
+
+    it 'returns the id of the domain' do
+      stub_request(:get, "https://api.dnsmadeeasy.com/V2.0/dns/managed/id/something.wanelo.com").
+        with(:headers => request_headers).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.get_id_by_domain('something.wanelo.com')).to eq(1130967)
+    end
+  end
+
+  describe '#domains' do
+    let(:response) { "{}" }
+
+    it 'returns all the domains' do
+      stub_request(:get, "https://api.dnsmadeeasy.com/V2.0/dns/managed/").
+        with(:headers => request_headers).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.domains).to eq({})
+    end
+  end
+
+  describe "#domain" do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    it "returns the domain given a domain name" do
+      stub_request(:get, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123").
+        with(:headers => request_headers).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.domain('something.wanelo.com')).to eq({})
+    end
+  end
+
+  describe '#delete_domain' do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    it 'deletes the domain' do
+      stub_request(:delete, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123").
+        with(:headers => request_headers).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.delete_domain('something.wanelo.com')).to eq({})
+    end
+  end
+
+  describe '#create_domains' do
+    let(:response) { "{}" }
+
+    it 'creates the domains' do
+      stub_request(:post, "https://api.dnsmadeeasy.com/V2.0/dns/managed/").
+        with(:headers => request_headers, :body => '{"names":["something.wanelo.com"]}').
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.create_domains(['something.wanelo.com'])).to eq({})
+    end
+  end
+
+  describe '#create_domain' do
+    it 'calls create_domains with the one domain' do
+      expect(subject).to receive(:create_domains).with(['something.wanelo.com'])
+      subject.create_domain('something.wanelo.com')
+    end
+  end
+
+  describe '#records_for' do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    it 'returns all records for a given domain' do
+      stub_request(:get, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123/records").
+        with(:headers => request_headers).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.records_for('something.wanelo.com')).to eq({})
+    end
+  end
+
+  describe '#find_record_id' do
+    let(:records_for_response) do
+      {
+        'data' => [
+          { 'name' => 'demo', 'type' => 'A', 'id' => 123},
+          { 'name' => 'demo', 'type' => 'A', 'id' => 143}
+        ]
+      }
+    end
+
+    before do
+      subject.stub(:records_for).with('something.wanelo.com').and_return(records_for_response)
+    end
+
+    it 'finds the specified record given a name and a type' do
+      expect(subject.find_record_id('something.wanelo.com', 'demo', 'A')).to eq([123, 143])
+    end
+  end
+
+  describe '#delete_records' do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    it 'deletes a list of records from a given domain' do
+      stub_request(:delete, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123/records/").
+        with(headers: request_headers, body: "[147,159]").
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.delete_records('something.wanelo.com', [147, 159])).to eq({})
+    end
+  end
+
+  describe '#delete_record' do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    it 'deletes a record' do
+      stub_request(:delete, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123/records/42/").
+        with(headers: request_headers).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(subject.delete_record('something.wanelo.com', 42)).to eq({})
+    end
+  end
+
+  describe '#create_record' do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    let(:domain_name) { 'something.wanelo.com' }
+    let(:name) { 'test' }
+
+    it 'creates a record' do
+      stub_request(:post, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123/records/").
+        with(headers: request_headers, body: {"name" => 'test', "type" => 'A', "value" => '192.168.1.1', "ttl" => 3600, "gtdLocation" => "DEFAULT"}.to_json).
+        to_return(:status => 200, :body => response, :headers => {})
+
+
+      expect(subject.create_record(domain_name, 'test', 'A', '192.168.1.1')).to eq({})
+    end
+  end
+
+  ["a", "aaaa", "ptr", "txt", "cname", "ns", "spf"].each do |record_type|
+    method_name = "create_#{record_type}_record"
+    describe "##{method_name}" do
+      upper_record_type = record_type.upcase
+
+      it "calls through to create record with \"#{upper_record_type}\"" do
+        expect(subject).to receive(:create_record).with('something.wanelo.com', 'smellyface',  upper_record_type, '192.168.1.1', {}).and_return({})
+        expect(subject.send(method_name, 'something.wanelo.com', 'smellyface', '192.168.1.1')).to eq({})
+      end
+    end
+  end
+
+  describe "#create_mx_record" do
+    it 'creates an mx record' do
+      expect(subject).to receive(:create_record).with('something.wanelo.com', 'mail', 'MX', '192.168.1.1', {'mxLevel' => 50}).and_return({})
+      expect(subject.create_mx_record('something.wanelo.com', 'mail', 50, '192.168.1.1')).to eq({})
+    end
+  end
+
+  describe "#create_srv_record" do
+    let(:weight) { '50' }
+    let(:priority) { '42' }
+    let(:port) { '4040' }
+
+    it 'creates an srv record' do
+      expect(subject).to receive(:create_record).with('something.wanelo.com', 'serv', 'SRV', '192.168.1.1', {"priority" => priority, "weight" => weight, "port" => port}).and_return({})
+
+      expect(subject.create_srv_record('something.wanelo.com', 'serv', priority, weight, port, '192.168.1.1')).to eq({})
+    end
+  end
+
+  describe "#create_httpred_record" do
+    let(:description) { 'hunky dory redirect description' }
+    let(:keywords) { 'omg,keywords,redirect' }
+    let(:redirect_type) { 'STANDARD - 302' }
+    let(:title) { 'wat' }
+
+    it 'creates an srv record' do
+      expect(subject).to receive(:create_record).with('something.wanelo.com', 'redirect', 'HTTPRED', '192.168.1.1', {"redirectType" => redirect_type, "description" => description, "keywords" => keywords, "title" => title}).and_return({})
+
+      expect(subject.create_httpred_record('something.wanelo.com', 'redirect', '192.168.1.1', redirect_type, description, keywords, title)).to eq({})
+    end
+  end
+
+  describe "#update_record" do
+    let(:response) { "{}" }
+
+    before do
+      subject.stub(:get_id_by_domain).with('something.wanelo.com').and_return(123)
+    end
+
+    it 'updates a record' do
+      body = '{"name":"mail","type":"A","value":"1.1.1.1","ttl":3600,"gtdLocation":"DEFAULT","id":21}'
+
+
+      stub_request(:put, "https://api.dnsmadeeasy.com/V2.0/dns/managed/123/records/21/").
+        with(headers: request_headers, body: body).
+        to_return(:status => 200, :body => response, :headers => {})
+
+
+      expect(subject.update_record('something.wanelo.com', 21, 'mail', 'A', '1.1.1.1', options = {})).to eq({})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.full_backtrace = true
+    config.formatter = 'doc' if config.formatters.none?
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: dnsmadeeasy-rest-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Paul Henry
+- James Hart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: webmock
+  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'
+description: DNS Made Easy V2.0 REST API client for Ruby, but better. With tests and
+  no dependencies.
+email: ops@wanelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- dnsmadeeasy-rest-api.gemspec
+- lib/dnsmadeeasy-rest-api.rb
+- spec/lib/dnsmadeeasyapi-rest-api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wanelo/dnsmadeeasy-rest-api
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: DNS Made Easy V2.0 REST API client for Ruby
+test_files: []
+has_rdoc: