vinyldns-ruby 0.8.0

data/lib/vinyldns/api.rb

@@ -0,0 +1,73 @@
+# Copyright 2018 Comcast Cable Communications Management, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require 'vinyldns/api/zone/zone'
+require 'vinyldns/api/group/group'
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'aws-sigv4'
+module Vinyldns
+  class API
+    # Make sure we can access parameters of the object
+    attr_accessor :api_url, :method, :region, :body, :content_type, :signer
+    # Required arguments:
+    # - method
+    def initialize(method, region = 'us-east-1', api_url = ENV['VINYLDNS_API_URL'], content_type = 'application/x-www-form-urlencoded')
+      @api_url = api_url
+      @method = method.upcase
+      raise(ArgumentError, 'Not a valid http request method') unless %w[GET HEAD POST PUT DELETE TRACE OPTIONS CONNECT PATCH].include?(@method)
+      @region = region
+      if @method == 'GET'
+        @content_type = content_type
+      elsif @method == 'POST' || @method == 'PUT'
+        @content_type = 'application/json'
+      end
+      # Generate a signed header for our HTTP requests
+      # http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html
+      @signer = Aws::Sigv4::Signer.new(
+          service: 'VinylDNS',
+          region: 'us-east-1',
+          access_key_id: ENV['VINYLDNS_ACCESS_KEY_ID'],
+          secret_access_key: ENV['VINYLDNS_SECRET_ACCESS_KEY'],
+          apply_checksum_header: false # Required for posting body in make_request : http://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Sigv4/Signer.html : If the 'X-Amz-Content-Sha256' header is set, the :body is optional and will not be read.
+      )
+    end
+
+    # Required arguments:
+    # - a signed object. ex: Vinyldns::API.new('get/POST/dElETe')
+    # - a uri path. ex: 'zones/92cc1c82-e2fc-424b-a178-f24b18e3b67a' -- This will pull ingest.yourdomain.net's zone
+    def self.make_request(signed_object, uri, body = '')
+      signed_headers = signed_object.signer.sign_request(
+            http_method: signed_object.method,
+            url: uri == '/' ? "#{signed_object.api_url}#{uri}" : "#{signed_object.api_url}/#{uri}",
+            headers: { 'content-type' => signed_object.content_type },
+            body: body == '' ? body : body.to_json
+      )
+      url = URI(signed_object.api_url)
+      https = Net::HTTP.new(url.host, url.port)
+      https.use_ssl = true
+      https.verify_mode = OpenSSL::SSL::VERIFY_NONE # SSL not signed? Don't care!
+      request = Net::HTTP::Post.new(uri == '/' ? uri : "/#{uri}") if signed_object.method == 'POST'
+      request = Net::HTTP::Put.new(uri == '/' ? uri : "/#{uri}") if signed_object.method == 'PUT'
+      request = Net::HTTP::Get.new(uri == '/' ? uri : "/#{uri}") if signed_object.method == 'GET'
+      signed_headers.headers.each { |k, v| request[k] = v }
+      request['content-type'] = signed_object.content_type
+      request.body = body == '' ? body : body.to_json
+      response = https.request(request)
+      case response
+      when Net::HTTPSuccess
+        JSON.parse(response.body)
+      else
+        return response
+        #"HTTP Error: #{response.code} #{response.message} : #{response.body}"
+      end
+    end
+  end
+end

data/lib/vinyldns/api/group/group.rb

@@ -0,0 +1,62 @@
+# Copyright 2018 Comcast Cable Communications Management, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module Vinyldns
+  class API
+    class Group
+      @api_uri = 'groups'
+
+      def self.create(name, distribution_email, members_array, admins_array, description = '')
+        api_request_object = Vinyldns::API.new('post')
+        Vinyldns::API.make_request(api_request_object, @api_uri, { 'name': name, 'email': distribution_email, 'description': description, 'members': members_array, 'admins': admins_array })
+      end
+
+      def self.update(id, request_params)
+        # We use request_params here as require arguments as create arguments may differ from update
+        # Validations
+        raise(ArgumentError, 'Request Parameters must be a Hash') unless request_params.is_a? Hash
+        api_request_object = Vinyldns::API.new('put')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}", request_params)
+      end
+
+      def self.delete(id)
+        api_request_object = Vinyldns::API.new('delete')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}")
+      end
+
+      def self.get(id)
+        api_request_object = Vinyldns::API.new('get')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}")
+      end
+
+      def self.list_my_groups(name_filter = nil, max_items = 5, start_from = nil)
+        api_request_object = Vinyldns::API.new('get')
+        # URI.encode matches all symbols that must be replaced with codes
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}?#{URI.encode_www_form([['groupNameFilter', name_filter], ['maxItems', max_items], ['startFrom', start_from]])}")
+      end
+
+      def self.list_group_admins(id)
+        api_request_object = Vinyldns::API.new('get')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}/admins")
+      end
+
+      def self.list_group_members(id, max_items = 5, start_from = nil)
+        api_request_object = Vinyldns::API.new('get')
+        # UNI.encode matches all symbols that must be replaced with codes
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}/members?maxItems=#{max_items}#{start_from.nil? ? '' : "&startFrom=#{start_from}"}")
+      end
+
+      def self.get_group_activity(id, max_items = 5, start_from = nil)
+        api_request_object = Vinyldns::API.new('get')
+        # UNI.encode matches all symbols that must be replaced with codes
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}/activity?maxItems=#{max_items}#{start_from.nil? ? '' : "&startFrom=#{start_from}"}")
+      end
+    end
+  end
+end

data/lib/vinyldns/api/zone/zone.rb

@@ -0,0 +1,136 @@
+# Copyright 2018 Comcast Cable Communications Management, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module Vinyldns
+  class API
+    class Zone
+      @api_uri = 'zones'
+
+      def self.connect(name, distribution_email, group_id = nil, group_name_filter = nil)
+        # Find the group ID using the group_name
+        if (group_id.nil? || group_id.empty?) && (!group_name_filter.nil? && !group_name_filter.empty?)
+          # Obtain admin group ID for body
+          group_object = Vinyldns::API::Group.list_my_groups(group_name_filter)['groups']
+          ## Validation
+          raise(StandardError, 'Parameter group_object returned nil. This is a problem with the make_request or list_my_groups methods.') if group_object.nil?
+          raise(ArgumentError, 'No group found for your group_name_filter. Please re-check the spelling so it\'s exact.') if group_object.empty?
+          raise(ArgumentError, 'Your group_name_filter used returned more than one group. Please re-check the spelling so it\'s exact.') if group_object.count > 1
+          group_id = group_object.first['id']
+        elsif (group_id.nil? || group_id.empty?) && (group_name_filter.nil? || group_name_filter.empty?)
+          raise(ArgumentError, 'You must include a group_id or group_name_filter.')
+        end # Else, we just use the group_id
+
+        # Post to API
+        api_request_object = Vinyldns::API.new('post')
+        Vinyldns::API.make_request(api_request_object, @api_uri, { adminGroupId: group_id, name: name, email: distribution_email })
+      end
+
+      def self.update(id, request_params)
+        # We use request_params here as values required by create may differ from update
+        # Validations
+        raise(ArgumentError, 'Request Parameters must be a Hash') unless request_params.is_a? Hash
+        api_request_object = Vinyldns::API.new('put')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}", request_params)
+      end
+
+      def self.delete(id)
+        api_request_object = Vinyldns::API.new('delete')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}")
+      end
+
+      def self.get(id)
+        api_request_object = Vinyldns::API.new('get')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}")
+      end
+
+      def self.search(name_filter = nil, max_items = 5, start_from = nil)
+        api_request_object = Vinyldns::API.new('get')
+        # UNI.encode matches all symbols that must be replaced with codes
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}?#{URI.encode_www_form([['nameFilter', name_filter], ['maxItems', max_items], ['startFrom', start_from]])}")
+      end
+
+      def self.sync(id)
+        api_request_object = Vinyldns::API.new('post')
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}/sync")
+      end
+
+      # Warning: Being deprecated, use list_changes
+      # def self.history(id)
+      #   api_request_object = Vinyldns::API.new('get')
+      #   Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}/history")
+      # end
+
+      def self.list_changes(id, max_items = 5, start_from = nil)
+        api_request_object = Vinyldns::API.new('get')
+        # UNI.encode matches all symbols that must be replaced with codes
+        Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{id}/changes?maxItems=#{max_items}#{start_from.nil? ? '' : "&startFrom=#{start_from}"}")
+      end
+
+      class RecordSet
+        @api_uri = 'zones'
+        @api_uri_addition = 'recordsets'
+
+        def self.create(zone_id, name, type, ttl, records_array)
+          # Post
+          api_request_object = Vinyldns::API.new('post')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{zone_id}/#{@api_uri_addition}", { 'name': name, 'type': type, 'ttl': ttl, 'records': records_array, 'zoneId': zone_id })
+        end
+
+        def self.update(zone_id, request_params)
+          # We use request_params here as values required by create may differ from update
+          # Validations
+          raise(ArgumentError, 'Request Parameters must be a Hash') unless request_params.is_a? Hash
+          api_request_object = Vinyldns::API.new('put')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{zone_id}", request_params)
+        end
+
+        def self.delete(zone_id, id)
+          api_request_object = Vinyldns::API.new('delete')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{zone_id}/#{@api_uri_addition}/#{id}")
+        end
+
+        def self.get(zone_id, id)
+          api_request_object = Vinyldns::API.new('get')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{zone_id}/#{@api_uri_addition}/#{id}")
+        end
+
+        def self.search(zone_id, name_filter = nil, max_items = 10, start_from = nil)
+          api_request_object = Vinyldns::API.new('get')
+          # UNI.encode matches all symbols that must be replaced with codes
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{zone_id}/#{@api_uri_addition}?#{name_filter.nil? ? '' : URI.encode_www_form(['recordNameFilter', name_filter], ['maxItems', max_items], ['startFrom', start_from])}")
+        end
+
+        def self.get_change(zone_id, id, change_id) # Use Vinyldns::API::Zone.list_changes to obtain change_id
+          api_request_object = Vinyldns::API.new('get')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{zone_id}/#{@api_uri_addition}/#{id}/changes/#{change_id}")
+        end
+      end
+      class BatchRecordChanges
+        @api_uri = 'zones'
+        @api_uri_addition = 'batchrecordchanges'
+
+        def self.create(changes_array, comments = nil)
+          raise(ArgumentError, 'changes_array parameter must be an Array') unless changes_array.is_a? Array
+          api_request_object = Vinyldns::API.new('post')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{@api_uri_addition}", { 'comments': comments.nil? ? 'Posted with Vinyldns-Ruby Gem' : comments, 'changes': changes_array })
+        end
+
+        def self.get(id)
+          api_request_object = Vinyldns::API.new('get')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{@api_uri_addition}/#{id}")
+        end
+
+        def self.user_recent
+          api_request_object = Vinyldns::API.new('get')
+          Vinyldns::API.make_request(api_request_object, "#{@api_uri}/#{@api_uri_addition}")
+        end
+      end
+    end
+  end
+end

data/lib/vinyldns/version.rb

@@ -0,0 +1,12 @@
+# Copyright 2018 Comcast Cable Communications Management, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module Vinyldns
+  VERSION = '0.8.0'.freeze
+end

data/vinyldns.gemspec

@@ -0,0 +1,46 @@
+# Copyright 2018 Comcast Cable Communications Management, LLC
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vinyldns/version'
+Gem::Specification.new do |gem|
+  gem.name          = 'vinyldns-ruby'
+  gem.version       = Vinyldns::VERSION
+  gem.summary       = 'Ruby gem for VinylDNS'
+  gem.description   = 'Ruby gem containing methods to perform various API requests in VinylDNS'
+  gem.authors       = ['Nathan Pierce']
+  gem.email         = 'nathan_pierce@comcast.com'
+  gem.homepage      = 'https://github.com/vinyldns/vinyldns-ruby'
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.licenses      = ['Apache-2.0']
+
+  # `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+  #   submodule.sub!("#{Dir.pwd}/",'')
+  #   Dir.chdir(submodule) do
+  #     `git ls-files`.split($/).map do |subpath|
+  #       gem.files << File.join(submodule,subpath)
+  #     end
+  #   end
+  # end
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+  gem.add_runtime_dependency 'aws-sigv4', '~> 1.0'
+  gem.add_development_dependency 'bundler', '~> 1.13'
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rspec', '3.7.0'
+  # Dependencies
+  # Licensed uses the the libgit2 bindings for Ruby provided by rugged. rugged has its own dependencies - cmake and pkg-config - which you may need to install before you can install Licensed.
+  # For example, on macOS with Homebrew: brew install cmake pkg-config and on Ubuntu: apt-get install cmake pkg-config.
+  gem.add_development_dependency 'licensed', '1.0.0'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: vinyldns-ruby
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Nathan Pierce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: licensed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Ruby gem containing methods to perform various API requests in VinylDNS
+email: nathan_pierce@comcast.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".licensed.json"
+- ".licenses/rubygem/bundler.txt"
+- ".licenses/rubygem/vinyldns-ruby.txt"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- ISSUE_TEMPLATE.md
+- LICENSE
+- Makefile
+- PULL_REQUEST_TEMPLATE.md
+- README.md
+- Rakefile
+- lib/vinyldns.rb
+- lib/vinyldns/api.rb
+- lib/vinyldns/api/group/group.rb
+- lib/vinyldns/api/zone/zone.rb
+- lib/vinyldns/version.rb
+- vinyldns.gemspec
+homepage: https://github.com/vinyldns/vinyldns-ruby
+licenses:
+- Apache-2.0
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Ruby gem for VinylDNS
+test_files: []