homebase 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69f312ad0d13dc58a0556e73f83eb6136022fbda
+  data.tar.gz: 67a97e3c2acf7df9870d5128feca34d839a4d912
+SHA512:
+  metadata.gz: fd5a6939b138190eaf381f619ff6782332aa54f8f29b90d714bb51314073a0f7c62698c2e78dac82de9d048de60fa545a8dfc32b7129d53148b05dc960677d2e
+  data.tar.gz: 138f01e761458acb805a5a8e11b8c4cfad3f02fa08516dbfa092c64605e0fda788af16068aeeeef7e05cf5883439749086a6cfac50c0381ef8d29d22fcfae0d5

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+    - '**/*.rb'
+    - homebase.gemspec
+    - bin/homebase
+Metrics/AbcSize:
+  Enabled: no
+Metrics/CyclomaticComplexity:
+  Enabled: no
+Metrics/MethodLength:
+  Enabled: no
+Metrics/PerceivedComplexity:
+  Enabled: no
+Style/CaseIndentation:
+  Enabled: no
+Style/Documentation:
+  Enabled: no
+Style/GuardClause:
+  Enabled: no
+Style/LineEndConcatenation:
+  Enabled: no
+Style/NumericLiterals:
+  Enabled: no
+Style/PercentLiteralDelimiters:
+  Enabled: no
+Style/RegexpLiteral:
+  Enabled: no
+Style/RedundantSelf:
+  Enabled: no
+Style/SignalException:
+  Enabled: no
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: no
+
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bsdavidson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Brian Davidson
+
+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 @@
+# Homebase
+
+Homebase grabs your current public IP address and updates a Digital Ocean hostname
+to point to the IP.  You can use this to provide your own dynamic DNS for home
+computers.
+
+## Installation
+
+Install it yourself with:
+
+    $ gem install homebase
+
+## Usage
+
+Run from commandline:
+
+    $ homebase --domain example.com --record subdomain --token YOUR_API_TOKEN
+
+Your domain will need to be hosted with Digital Ocean and you'll need a
+[Digital Ocean API token](https://cloud.digitalocean.com/settings/api/tokens).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/homebase. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,17 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => e
+  STDERR.puts "Error importing RSpec: #{e}"
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError => e
+  STDERR.puts "Error importing RuboCop: #{e}"
+end
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'homebase'
+
+# 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/homebase

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'homebase'
+require 'trollop'
+
+BANNER = %(
+#{DATA}
+
+Usage: #{File.basename $PROGRAM_NAME} [options]
+
+Lookup your current public IP and update a Digital Ocean domain record with your
+new address.
+
+Options:
+)
+
+opts = Trollop.options do
+  banner BANNER
+  opt :domain, 'Domain name hosted with Digital Ocean', type: :string,
+                                                        required: true
+  opt :record, 'Subdomain to update', type: :string, required: true
+  opt :token, 'Digital Ocean API token', type: :string, required: true
+end
+
+begin
+  homebase = Homebase.new
+  result = homebase.update_record_with_public_ip(opts[:domain],
+                                                 opts[:record],
+                                                 opts[:token])
+  puts result[:ip]
+rescue => e
+  STDERR.puts "Error: #{e}"
+  exit 1
+end
+
+__END__
+
+  _    _  ____  __  __ ______ ____           _____ ______
+ | |  | |/ __ \|  \/  |  ____|  _ \   /\    / ____|  ____|  o____
+ | |__| | |  | | \  / | |__  | |_) | /  \  | (___ | |__     |\\//|
+ |  __  | |  | | |\/| |  __| |  _ < / /\ \  \___ \|  __|    |//\\|
+ | |  | | |__| | |  | | |____| |_) / ____ \ ____) | |____   |
+ |_|  |_|\____/|_|  |_|______|____/_/    \_\_____/|______|  |

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/homebase.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'homebase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'homebase'
+  spec.version       = Homebase::VERSION
+  spec.authors       = ['Brian Davidson']
+  spec.email         = ['bsdavidson@gmail.com']
+
+  spec.summary       = 'Host your own dynamic DNS via Digital Ocean'
+  spec.homepage      = 'https://github.com/bsdavidson/homebase-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['homebase']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'trollop', '~> 2.1'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
+end

data/lib/homebase/version.rb

@@ -0,0 +1,3 @@
+class Homebase
+  VERSION = '0.1.0'
+end

data/lib/homebase.rb

@@ -0,0 +1,71 @@
+require 'json'
+require 'ipaddr'
+require 'net/http'
+require_relative 'homebase/version'
+
+class Homebase
+  API_PREFIX = 'https://api.digitalocean.com/v2'
+  PUBLIC_IP_URI = URI('https://api.ipify.org/?format=text')
+  DOMAIN_RECORDS_FORMAT = "#{API_PREFIX}/domains/%<domain_name>s/records"
+  DOMAIN_RECORD_FORMAT =
+    "#{API_PREFIX}/domains/%<domain_name>s/records/%<record_id>d"
+
+  class Error < StandardError; end
+  class RequestError < Error; end
+  class ParseError < Error; end
+
+  def public_ip(opts = {})
+    return @public_ip if @public_ip && !opts[:force]
+    res = Net::HTTP.get_response(PUBLIC_IP_URI)
+    raise(RequestError, "Invalid IP response #{res.code}",
+          caller) if res.code != '200'
+    ip = res.body.strip
+    begin
+      IPAddr.new(ip)
+    rescue IPAddr::InvalidAddressError
+      raise ParseError, 'Invalid Public IP', caller
+    end
+    @public_ip = ip
+  end
+
+  def get_record_by_name(domain_name, record_name, token)
+    uri = URI(DOMAIN_RECORDS_FORMAT % {domain_name: domain_name})
+
+    req = Net::HTTP::Get.new(uri)
+    req['Content-Type'] = 'application/json'
+    req['Authorization'] = "Bearer #{token}"
+    body = Net::HTTP.start(uri.host, uri.port,
+                           use_ssl: uri.scheme == 'https') do |http|
+      res = http.request req
+      raise RequestError, "Error - #{res.code}", caller if res.code != '200'
+      res.body
+    end
+    begin
+      records = JSON.parse(body, symbolize_names: true)[:domain_records]
+    rescue JSON::ParserError
+      raise ParseError, 'Invalid JSON Response', caller
+    end
+    records.find { |record| record[:name] == record_name }
+  end
+
+  def update_record(domain_name, record_id, data, token)
+    uri = URI(DOMAIN_RECORD_FORMAT % {domain_name: domain_name,
+                                      record_id: record_id})
+    req = Net::HTTP::Put.new(uri)
+    req['Content-Type'] = 'application/json'
+    req['Authorization'] = "Bearer #{token}"
+    req.body = { data: data }.to_json
+    Net::HTTP.start(uri.host, uri.port,
+                    use_ssl: uri.scheme == 'https') do |http|
+      res = http.request req
+      raise RequestError, "Error - #{res.code}", caller if res.code != '200'
+      res
+    end
+  end
+
+  def update_record_with_public_ip(domain_name, record_name, token)
+    record = get_record_by_name(domain_name, record_name, token)
+    result = update_record(domain_name, record[:id], public_ip, token)
+    { result: result, ip: public_ip }
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: homebase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Davidson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+description: 
+email:
+- bsdavidson@gmail.com
+executables:
+- homebase
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/homebase
+- bin/setup
+- homebase.gemspec
+- lib/homebase.rb
+- lib/homebase/version.rb
+homepage: https://github.com/bsdavidson/homebase-ruby
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Host your own dynamic DNS via Digital Ocean
+test_files: []
+has_rdoc: