google-ddns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 417b854687f96dc891a708f1b4ad2a94a1fda888
+  data.tar.gz: f9ab7be5822aaa34b763bcaadd7184f95a069dd7
+SHA512:
+  metadata.gz: dff0180f6b3df1164270a63814536d9cf5bf9d19a7dce8ff657403b2ca6d15c1fd326dca31388602479d6c73db875e454985cc90e4f41688fdae9798393f6f7b
+  data.tar.gz: 8fbf801f228ff6eb972c1ad1168686d626ba69619f2225fd905864570f57cf7416cba9effc5a158217811fc347869bbcb3bfaaf28ff5b4a535e0009db8e4d24c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brian John
+
+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,36 @@
+# Google::Ddns
+
+Client for Google DDNS. Designed to be run as a scheduled job on a *nix machine (e.g. cron).
+
+## Installation
+
+```
+$ gem install google-ddns
+```    
+
+## Usage
+
+To get setup, run the `google-ddns` command and you will be prompted for your Google DDNS credentials. See [this
+documentation on how to retrieve the credentials for your domain](https://support.google.com/domains/answer/6147083?hl=en).
+
+NOTE: Your Google DDNS credentials will be stored in plaintext on your local machine.
+
+Once you've provided your credentials, you can create a scheduled task to update your IP at an interval of your
+choosing.
+
+## Development
+
+Fork the repo
+Write tests
+Submit a pull request
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/f1sherman/google-ddns.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "google/ddns"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/google-ddns

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+IN_EXECUTABLE_CONTEXT = true
+
+require "google/ddns"

data/google-ddns.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google/ddns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "google-ddns"
+  spec.version       = Google::Ddns::VERSION
+  spec.authors       = ["Brian John"]
+  spec.email         = ["brian@brianjohn.com"]
+
+  spec.summary       = %q{Google DDNS Client}
+  spec.homepage      = "https://github.com/f1sherman/google-ddns"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
+end

data/lib/google/ddns.rb

@@ -0,0 +1,102 @@
+require "google/ddns/version"
+require 'yaml'
+require 'fileutils'
+require 'io/console'
+require 'net/http'
+require 'logger'
+require 'resolv'
+
+module Google
+  module Ddns
+    def self.run
+      settings_directory = File.join Dir.home, ".google-ddns-gem"
+      settings_file = File.join settings_directory, "settings.yml"
+
+      if File.exist?(settings_file)
+        update_on_change settings_file
+      else
+        init_settings settings_directory, settings_file
+      end
+    end
+
+    def self.update_on_change(settings_file)
+      settings = YAML.load_file settings_file
+      old_ip = settings["ip_address"]
+
+      current_ip = get_current_ip
+
+      if old_ip != current_ip
+        # Using the "warn" level will cause cron to send mail, so we know when our IP address changes
+        logger.warn "IP Address changed from #{old_ip} to #{current_ip}, updating..."
+        update_ip settings, settings_file
+      else
+        logger.info "IP Address has not changed from #{old_ip}, skipping update."
+      end
+    end
+
+    def self.init_settings(settings_directory, settings_file)
+      unless $stdout.isatty
+        error "No Google DDNS setup information found! Please run google-ddns from an interactive terminal to get setup."
+      end
+
+      puts "Hi there! Looks like you don't have a settings file. Let's get you setup!"
+      FileUtils.mkdir_p settings_directory
+
+      settings = {}
+
+      print "Google DDNS Hostname: "
+      settings["hostname"] = $stdin.gets.chomp
+      print "Google DDNS Username: "
+      settings["username"] = $stdin.gets.chomp
+      print "Google DDNS Password (typing will be hidden): "
+      settings["password"] = $stdin.noecho(&:gets).chomp
+      puts
+
+      update_ip settings, settings_file
+    end
+
+    def self.update_ip(settings, settings_file)
+      response = Net::HTTP.post_form URI("https://#{settings["username"]}:#{settings["password"]}@domains.google.com/nic/update"), "hostname" => settings["hostname"]
+
+      response_type, ip_address = response.body.split
+
+      unless response.code == "200" && ["good", "nochg"].include?(response_type)
+        error "Error updating IP Address! Received response code #{response.code} and body \"#{response.body}\"."
+      end
+
+      success_message = if response_type == "good"
+                          "Updated #{settings["hostname"]} IP Address to #{ip_address}."
+                        else
+                          "Tried to update, but #{settings["hostname"]} IP Address was already set to #{ip_address}."
+                        end
+
+      logger.info success_message
+
+      settings["ip_address"] = ip_address
+      settings["updated_at"] = Time.now.utc.to_s
+
+      YAML.dump settings, File.new(settings_file, "w")
+      FileUtils.chmod 0600, settings_file
+    end
+
+    def self.get_current_ip
+      Resolv::DNS.new(:nameserver => "resolver1.opendns.com").getaddress("myip.opendns.com").to_s
+    end
+
+    def self.logger
+      @logger ||= Logger.new($stdout).tap do |logger_instance|
+        logger_instance.level = $stdout.isatty ? Logger::INFO : Logger::WARN
+        logger_instance.formatter = proc { |_severity, _time, _progname, msg|
+          "#{msg}\n"
+        }
+      end
+    end
+
+    def self.error(message)
+      logger.error message
+      exit false
+    end
+
+    run if defined? IN_EXECUTABLE_CONTEXT
+  end
+end

data/lib/google/ddns/version.rb

@@ -0,0 +1,5 @@
+module Google
+  module Ddns
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: google-ddns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian John
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-02 00:00:00.000000000 Z
+dependencies:
+- !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: '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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- brian@brianjohn.com
+executables:
+- google-ddns
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/google-ddns
+- google-ddns.gemspec
+- lib/google/ddns.rb
+- lib/google/ddns/version.rb
+homepage: https://github.com/f1sherman/google-ddns
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Google DDNS Client
+test_files: []