route53_a_record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecfc85b3a64a280000ce590b59fca2270b162e7d
+  data.tar.gz: 90c46029cbaf7f35fc37475c84454af71811d41e
+SHA512:
+  metadata.gz: a51d04f99b99a62eb4a75f635dad45a023c57ac59446dbe06b78987f92089f8530dbb52fec0ff7f9c0b9ff6c74f67fbd131c5479516bb6501481cae4d794b43a
+  data.tar.gz: 23ba7edc0cfb0ce8405fae08176bb4e5ee63e3b1ed7a96f2b233d4d6ef8323936d188c7c0dd97180be9990b566bd34623d22ca76248decfb563de6d8478e6d60

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in route53_a_record.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 kgalli
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# Route53ARecord
+
+Create, update or delete route53 A records.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'route53_a_record'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install route53_a_record
+
+## Usage
+
+### Create, Update, or Delete an A Record
+
+```ruby
+require 'route53_a_record'
+
+# aws credentials
+aws_region = 'eu-central1'
+aws_access_key_id = 'AKIAIOSFODNN7EXAMPLE'
+aws_secret_access_key = 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
+
+# aws hosted zone and a like properties
+aws_hosted_zone = 'K5NPEL7EXAMPLE'
+aws_hosted_zone_a_entry = '10.1.1.1'
+aws_hosted_zone_domain = 'route53.example.com'
+
+# The Route53ARecord::Record is used to cescribe the record you want
+# to create, update or delete. The last parameter is the `ttl` which defaults
+# to `15` (seconds) if not specified.
+record = Route53ARecord::Record.new(aws_hosted_zone, aws_hosted_zone_domain, aws_hosted_zone_a_entry, 30)
+
+# The `Route53ARecord::Handler` is used to perform the creation or
+# update if the given `Route53ARecord::Record`. It provides a
+# parameter overwrite which has to be used for updates. If it is
+# set to `false` updates will raise an exception. The default is `true`.
+handler = Route53ARecord::Handler.new(aws_region, aws_access_key_id, aws_secret_access_key, true)
+
+# to create the A record
+handler.create(record)
+
+
+# to delete the A record
+handler.delete(record)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/route53_a_record/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task default: 'test'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end

data/lib/route53_a_record/handler.rb

@@ -0,0 +1,61 @@
+require 'aws-sdk'
+
+module Route53ARecord
+  class Handler
+    attr_accessor :overwrite
+
+    def initialize(region, access_key_id, secret_access_key, overwrite = true)
+      @region = region
+      @access_key_id = access_key_id
+      @secret_access_key = secret_access_key
+      @overwrite = overwrite
+    end
+
+    def create(resource_a_record)
+      action = action_based_on_overwrite
+      aws_client.change_resource_record_sets(a_record_change_hash(action, resource_a_record))
+    end
+
+    def delete(resource_a_record)
+      aws_client.change_resource_record_sets(a_record_change_hash("DELETE", resource_a_record))
+    end
+
+    private
+
+    def action_based_on_overwrite
+      @overwrite ? 'UPSERT' : 'CREATE'
+    end
+
+    def aws_client
+      Aws::Route53::Client.new(
+          region: @region,
+          access_key_id: @access_key_id,
+          secret_access_key: @secret_access_key
+      )
+    end
+
+    def a_record_change_hash(action, resource_a_record)
+      {
+        hosted_zone_id: resource_a_record.hosted_zone_id,
+        change_batch: {
+          changes: [
+            {
+              action: action,
+              resource_record_set: {
+                name: resource_a_record.name,
+                type: "A",
+                ttl: resource_a_record.ttl,
+                resource_records: [
+                  {
+                    value: resource_a_record.value
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      }
+    end
+  end
+end
+

data/lib/route53_a_record/record.rb

@@ -0,0 +1,17 @@
+module Route53ARecord
+  class Record
+    attr_reader :hosted_zone_id, :name, :value, :ttl
+
+    def initialize(hosted_zone_id, name, value, ttl = 5)
+      @hosted_zone_id = hosted_zone_id
+      @name = name
+      @value = value
+      @ttl = ttl
+    end
+
+    def type
+      'A'
+    end
+  end
+end
+

data/lib/route53_a_record/version.rb

@@ -0,0 +1,3 @@
+module Route53ARecord
+  VERSION = "0.0.1"
+end

data/lib/route53_a_record.rb

@@ -0,0 +1,4 @@
+require 'route53_a_record/version'
+require 'route53_a_record/record'
+require 'route53_a_record/handler'
+

data/route53_a_record.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'route53_a_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "route53_a_record"
+  spec.version       = Route53ARecord::VERSION
+  spec.authors       = ["kgalli"]
+  spec.email         = ["mail@kgalli.de"]
+  spec.summary       = %q{Create, update and delete route53 A records.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk", "~> 2.1.14"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5.1"
+
+end

data/spec/handler_spec.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+describe Route53ARecord::Handler do
+
+  let(:rh) { Route53ARecord::Handler.new('my_region', 'my_access_key_id', 'my_secret_access_key') }
+  let(:rh_overwrite_false) { Route53ARecord::Handler.new('my_region', 'my_access_key_id', 'my_secret_access_key', false) }
+  describe '#initialize' do
+
+    it 'assigns the aws region and credentials' do
+      rh.instance_variable_get(:@region).must_equal 'my_region'
+      rh.instance_variable_get(:@access_key_id).must_equal 'my_access_key_id'
+      rh.instance_variable_get(:@secret_access_key).must_equal 'my_secret_access_key'
+    end
+
+    it 'does not allow access to aws credentials' do
+      proc { rh.access_key_id }.must_raise NoMethodError
+      proc { rh.secret.access_key }.must_raise NoMethodError
+    end
+
+    it 'assigns default true for overwrite' do
+      rh.instance_variable_get(:@overwrite).must_equal true
+    end
+
+    it 'overwrites the default for overwrite' do
+      rh_overwrite_false.instance_variable_get(:@overwrite).must_equal false
+    end
+  end
+
+  describe '#action_based_on_overwrite' do
+
+    it 'returns UPSERT if overwrite is allowed' do
+      rh.send(:action_based_on_overwrite).must_equal 'UPSERT'
+    end
+
+    it 'returns CREATE if overwrite is denied' do
+      rh_overwrite_false.send(:action_based_on_overwrite).must_equal 'CREATE'
+    end
+  end
+
+  describe '#aws_client' do
+
+    it 'assigns the region and aws credentials' do
+      rh.send(:aws_client).config[:region].must_equal 'my_region'
+      rh.send(:aws_client).config[:access_key_id].must_equal 'my_access_key_id'
+      rh.send(:aws_client).config[:secret_access_key].must_equal 'my_secret_access_key'
+    end
+  end
+
+  describe '#a_record_change_hash' do
+
+    let(:a_record) { Route53ARecord::Record.new('aws_hosted_zone_id', 'resource_a_record_name', 'resource_a_record_value', 15) }
+    let(:create_record) { {
+      hosted_zone_id: "aws_hosted_zone_id", change_batch: {
+        changes: [
+          { action: "CREATE",
+            resource_record_set: {
+              name: "resource_a_record_name", type: "A", ttl: 15,
+              resource_records: [ { value: "resource_a_record_value" } ]
+            }
+          }
+        ]
+      }
+    }}
+
+   it 'replaces placeholder values by a ResourceARecord' do
+     rh.send(:a_record_change_hash, 'CREATE', a_record).must_equal create_record
+   end
+  end
+end
+

data/spec/record_spec.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+describe Route53ARecord::Record do
+
+  let(:rr) { Route53ARecord::Record.new('hosted_zone_id', 'name', 'value') }
+
+  describe '#initialize' do
+
+    it 'assigns given values' do
+      rr.hosted_zone_id.must_equal 'hosted_zone_id'
+      rr.name.must_equal 'name'
+      rr.value.must_equal 'value'
+      rr.ttl.must_equal 5
+    end
+  end
+end

data/spec/test_helper.rb

@@ -0,0 +1,4 @@
+require 'route53_a_record'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: route53_a_record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kgalli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.14
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+description: ''
+email:
+- mail@kgalli.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/route53_a_record.rb
+- lib/route53_a_record/handler.rb
+- lib/route53_a_record/record.rb
+- lib/route53_a_record/version.rb
+- route53_a_record.gemspec
+- spec/handler_spec.rb
+- spec/record_spec.rb
+- spec/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Create, update and delete route53 A records.
+test_files:
+- spec/handler_spec.rb
+- spec/record_spec.rb
+- spec/test_helper.rb