tunnelbroker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6b32e7145250ea944c77ae905064d8ac32191ce
+  data.tar.gz: fc3e5e2ea04d423a63febddc8d92314ce6ce7635
+SHA512:
+  metadata.gz: 578e56159628fec166c5b0f0fba69d40ef8a7b95bf75c1e7e93230e99627b30e01b6d765d91bc818a57127ab71cee332238e7f0912830d3fb0b7b455af937b68
+  data.tar.gz: 4ba2792de994d30fdf09d9119707dd6d85f07e09c01f2d15344a98e0de69b903f8bf9a4935aca41560f27f7cf79dfec7385299b17845c7afbb5bc296fb784d7d

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+test.rb
+
+## 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/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+branches:
+  only:
+    - master
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+# -*- coding: UTF-8 -*-
+source 'https://rubygems.org/'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Heckman
+
+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,124 @@
+tunnelbroker
+============
+[![Build Status](https://img.shields.io/travis/theckman/tunnelbroker/master.svg)](https://travis-ci.org/theckman/tunnelbroker)
+[![MIT License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
+[![Coveralls Coverage](https://img.shields.io/coveralls/theckman/tunnelbroker/master.svg)](https://coveralls.io/r/theckman/tunnelbroker)
+[![Code Climate](https://img.shields.io/codeclimate/github/theckman/tunnelbroker.svg)](https://codeclimate.com/github/theckman/tunnelbroker)
+[![Gemnasium](https://img.shields.io/gemnasium/theckman/tunnelbroker.svg)](https://gemnasium.com/theckman/tunnelbroker)
+
+Ruby TunnelBroker API client
+
+LICENSE
+-------
+[tunnelbroker](https://github.com/theckman/tunnelbroker) is released under
+the [MIT](http://opensource.org/licenses/MIT) license. The full license has
+been provided in the
+[LICENSE](https://github.com/theckman/tunnelbroker/blob/master/LICENSE) file.
+
+CONTRIBUTING
+------------
+See [CONTRIBUTION.md](https://github.com/theckman/tunnelbroker/blob/master/CONTRIBUTING.md)
+for information on contributing back to this project.
+
+INSTALLATION
+------------
+To install on the commandline using `gem`:
+
+```Bash
+gem install tunnelbroker
+```
+
+If you are including this in your project's `Gemfile`:
+
+```Ruby
+gem 'tunnelbroker'
+```
+
+USAGE
+-----
+### Nitty-gritty overview
+```Ruby
+# require the gem
+require 'tunnelbroker'
+ => true
+
+# instantiate a new client
+client = TunnelBroker::Client.new
+ => #<TunnelBroker::Client:0x007fa2fbaac5d0>
+
+# configure the client
+client.configure do |c|
+  c.tunnelid = 42
+  c.username = 'theckman'
+  c.update_key = 'YourUpdateKey'
+end
+
+# check your config options
+client.config.username
+ => "theckman"
+
+# update the API, assign the response object
+response = client.submit_update
+ => #<TunnelBroker::APIResponse:0x007fa2fba20e40 @success=true, @changed=false, @response={:msg=>"nochg", :data=>{:ip=>"50.161.84.35"}}>
+
+# was it successful?
+response.success?
+ => true
+
+# did the IP address change?
+response.changed?
+ => false
+
+# configure the client, specifying an ip4addr this time
+client.configure do |c|
+  c.ip4addr = '127.0.0.1'
+end
+
+# update the API, assign the response object
+response = client.submit_update
+ => #<TunnelBroker::APIResponse:0x007fa2fb9d9c98 @success=true, @changed=true, @response={:msg=>"good", :data=>{:ip=>"127.0.0.1"}}>
+
+# was it successful?
+response.success?
+ => true
+
+# did the IP address change?
+response.changed?
+ => true
+```
+
+### Configuration
+The configuration of the client is done by sending a Ruby block to the client's
+`configure` method:
+
+```Ruby
+# henceforth, any refences to client will be this:
+client = TunnelBroker::Client.new
+
+client.configure do |cfg|
+  cfg.username = 'theckman'
+end
+```
+
+Here are the available configuration items:
+
+| Option       | Explanation |
+| ------------ | ----------- |
+| `ip4addr`    | Specify the ipv4 address that will connect to the tunnel. If not specified, the IP address of which the request came from is specified. |
+| `username`   | This is your [tunnelbroker.net](https://www.tunnelbroker.net/) username                                                                                                  |
+| `update_key` | This is the update_key for your tunnel, you can set this on the 'Advanced' tab for your tunnel.                                         |
+| `tunnelid`   | The tunnelid from the 'IPv6 Tunnel' tab of your tunnel.                                                                                 |
+| `url`        | If you want to use a custom endpoint URL, you can specify it here. Defaults to the TunnelBroker API endpoint.                           |
+
+### Updating the API
+There is a simple method to update the API. It returns a `TunnelBroker::APIResponse` object.
+```Ruby
+client.submit_update
+```
+
+### Checking the response object
+The response object has two primary methods for telling what happened:
+
+* `.success?` - returns true/false as to whether this was successful or not
+* `.changed?` - returns true/false as to whether IP had changed.
+* `.response` - Hash containing the response from the server split in to sections.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- coding: UTF-8 -*_
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rubocop::RakeTask.new(:rubocop) do |t|
+  t.patterns =
+    %w( Rakefile Gemfile tunnelbroker.gemspec lib/**/*.rb spec/*_spec.rb )
+  t.fail_on_error = true
+end
+
+task default: [:rubocop, :spec]

data/lib/tunnelbroker.rb

@@ -0,0 +1,28 @@
+# -*- coding: UTF-8 -*-
+# The MIT License (MIT)
+
+# Copyright (c) 2014 Tim Heckman
+
+# 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.
+
+require 'tunnelbroker/version'
+require 'tunnelbroker/api_response'
+require 'tunnelbroker/configuration'
+require 'tunnelbroker/messenger'
+require 'tunnelbroker/client'

data/lib/tunnelbroker/api_response.rb

@@ -0,0 +1,68 @@
+# -*- coding: UTF-8 -*-
+require 'English'
+
+module TunnelBroker
+  # class to give some helpful handling of the TunnelBroker API response
+  #
+  class APIResponse
+    attr_reader :response
+
+    BADAUTH = /^(badauth)$/
+    CHANGE = /^(good)\s(\d+\.\d+\.\d+\.\d+)$/
+    NO_CHANGE = /^(nochg)\s(\d+\.\d+\.\d+\.\d+)$/
+
+    def initialize(response)
+      parse_response(response.lines.first)
+    end
+
+    def success?
+      if @success.nil?
+        false
+      else
+        @success
+      end
+    end
+
+    def changed?
+      if @changed.nil?
+        false
+      else
+        @changed
+      end
+    end
+
+    private
+
+    def parse_response(firstline)
+      if BADAUTH.match(firstline)
+        bad_auth($LAST_MATCH_INFO)
+      elsif CHANGE.match(firstline)
+        change($LAST_MATCH_INFO)
+      elsif NO_CHANGE.match(firstline)
+        no_change($LAST_MATCH_INFO)
+      end
+    end
+
+    def bad_auth(match)
+      @success = false
+      @changed = false
+      @response = { msg: match[1], data: {} }
+    end
+
+    def change(match)
+      @success = true
+      @changed = true
+      matched_response(match)
+    end
+
+    def no_change(match)
+      @success = true
+      @changed = false
+      matched_response(match)
+    end
+
+    def matched_response(match)
+      @response = { msg: match[1], data: { ip: match[2] } }
+    end
+  end
+end

data/lib/tunnelbroker/client.rb

@@ -0,0 +1,46 @@
+# -*- coding: UTF-8 -*-
+require 'tunnelbroker/configuration'
+require 'tunnelbroker/messenger'
+
+module TunnelBroker
+  # TunnelBroker client for communication with the API
+  #
+  class Client
+    ENDPOINT ||= 'https://ipv4.tunnelbroker.net/nic/update'
+
+    def configure
+      yield(config) if Kernel.block_given?
+    end
+
+    def submit_update
+      c = build_messenger_config
+      tb = TunnelBroker::Messenger.new(c)
+      tb.call_api
+    end
+
+    def config
+      @config ||= TunnelBroker::Configuration.new
+    end
+
+    private
+
+    def build_messenger_config
+      conf = {}
+      TunnelBroker::Configuration::FIELDS.each do |k|
+        conf.merge!(config_hash_item(k))
+      end
+      conf
+    end
+
+    def config_hash_item(key)
+      c = config.send(key)
+      if c.nil? && key == :url
+        { key => ENDPOINT }
+      elsif c.nil?
+        {}
+      else
+        { key => c }
+      end
+    end
+  end
+end

data/lib/tunnelbroker/configuration.rb

@@ -0,0 +1,24 @@
+# -*- coding: UTF-8 -*-
+
+module TunnelBroker
+  # Configuration class for the TunnelBroker client
+  #
+  class Configuration
+    FIELDS = [:url, :ip4addr, :username, :update_key, :tunnelid]
+    attr_accessor(*FIELDS)
+
+    def initialize
+      set_default_values
+    end
+
+    private
+
+    def set_default_values
+      @ip4addr = nil
+      @username = nil
+      @update_key = nil
+      @tunnelid = nil
+      @url = nil
+    end
+  end
+end

data/lib/tunnelbroker/messenger.rb

@@ -0,0 +1,34 @@
+# -*- coding: UTF-8 -*-
+require 'tunnelbroker/api_response'
+require 'httparty'
+
+module TunnelBroker
+  # The class for communicating with the API
+  #
+  class Messenger
+    include HTTParty
+
+    def initialize(opts)
+      opts_to_inst(opts)
+    end
+
+    def call_api
+      TunnelBroker::APIResponse.new(call_endpoint)
+    end
+
+    private
+
+    def opts_to_inst(opts)
+      opts.each do |k, v|
+        instance_variable_set(:"@#{k}", v)
+      end
+    end
+
+    def call_endpoint
+      auth = { username: @username, password: @update_key }
+      query = { hostname: @tunnelid }
+      query.merge!(myip: @ip4addr) unless @ip4addr.nil?
+      self.class.get(@url, basic_auth: auth, query: query)
+    end
+  end
+end

data/lib/tunnelbroker/version.rb

@@ -0,0 +1,28 @@
+# -*- coding: UTF-8 -*-
+# The MIT License (MIT)
+
+# Copyright (c) 2014 Tim Heckman
+
+# 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.
+
+# The TunnelBroker API client namespace.
+#
+module TunnelBroker
+  VERSION ||= '0.1.0'
+end