tunnelbroker 0.1.0

data/spec/unit/tunnelbroker/configuration_spec.rb

@@ -0,0 +1,84 @@
+# -*- coding: UTF-8 -*-
+require 'spec_helper'
+
+describe TunnelBroker::Configuration do
+  describe '::FIELDS' do
+    subject { TunnelBroker::Configuration::FIELDS }
+
+    it { should be_an_instance_of Array }
+
+    it 'should contain only symbols' do
+      subject.each do |f|
+        expect(f).to be_an_instance_of Symbol
+      end
+    end
+
+    it { should eql [:url, :ip4addr, :username, :update_key, :tunnelid] }
+  end
+
+  describe '.set_default_values' do
+    context 'when given more than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          subject.send(:set_default_values, nil)
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'when called after changing values' do
+      before(:each) do
+        subject.ip4addr = ''
+        subject.tunnelid = ''
+        subject.username = ''
+        subject.update_key = ''
+      end
+
+      it 'should set ip to nil' do
+        subject.send(:set_default_values)
+
+        expect(subject.ip4addr).to be_nil
+      end
+
+      it 'should set tunnnelid to nil' do
+        subject.send(:set_default_values)
+
+        expect(subject.tunnelid).to be_nil
+      end
+
+      it 'should set username to nil' do
+        subject.send(:set_default_values)
+
+        expect(subject.username).to be_nil
+      end
+
+      it 'should set update_key to nil' do
+        subject.send(:set_default_values)
+
+        expect(subject.update_key).to be_nil
+      end
+    end
+  end
+
+  describe '#new' do
+    context 'when given more than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          TunnelBroker::Configuration.new(nil)
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'under normal conditions' do
+      subject { TunnelBroker::Configuration.new }
+
+      it { should be_an_instance_of TunnelBroker::Configuration }
+
+      it 'should set the default configuration options' do
+        expect(subject.ip4addr).to be_nil
+        expect(subject.tunnelid).to be_nil
+        expect(subject.username).to be_nil
+        expect(subject.update_key).to be_nil
+      end
+    end
+  end
+end

data/spec/unit/tunnelbroker/messenger_spec.rb

@@ -0,0 +1,194 @@
+# -*- coding: UTF-8 -*-
+require 'spec_helper'
+
+describe TunnelBroker::Messenger do
+  before do
+    @opts = {
+      url: 'test1', username: 'test2', update_key: 'test3', tunnelid: 'test4'
+    }
+    @messenger = TunnelBroker::Messenger.new(@opts)
+  end
+
+  describe '.opts_to_inst' do
+    context 'when given more than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          @messenger.send(:opts_to_inst, nil, nil)
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'when given less than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          @messenger.send(:opts_to_inst)
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'when given an option hash and inst_vars do not exist' do
+      before do
+        @messenger.remove_instance_variable(:@url)
+        @messenger.remove_instance_variable(:@username)
+        @messenger.remove_instance_variable(:@update_key)
+        @messenger.remove_instance_variable(:@tunnelid)
+      end
+
+      it 'should properly convert the hash to instance variables' do
+        t_opts = { url: 't', username: 'u', update_key: 'k', tunnelid: 'ti' }
+        @messenger.send(:opts_to_inst, t_opts)
+
+        m = @messenger.instance_variable_get(:@url)
+        expect(m).to eql t_opts[:url]
+
+        m = @messenger.instance_variable_get(:@username)
+        expect(m).to eql t_opts[:username]
+
+        m = @messenger.instance_variable_get(:@update_key)
+        expect(m).to eql t_opts[:update_key]
+
+        m = @messenger.instance_variable_get(:@tunnelid)
+        expect(m).to eql t_opts[:tunnelid]
+      end
+    end
+
+    context 'when given an option hash and inst_vars do exist' do
+      it 'should properly convert the hash to instance variables' do
+        t_opts = { url: 'w', username: 'x', update_key: 'y', tunnelid: 'z' }
+        @messenger.send(:opts_to_inst, t_opts)
+
+        m = @messenger.instance_variable_get(:@url)
+        expect(m).to eql t_opts[:url]
+
+        m = @messenger.instance_variable_get(:@username)
+        expect(m).to eql t_opts[:username]
+
+        m = @messenger.instance_variable_get(:@update_key)
+        expect(m).to eql t_opts[:update_key]
+
+        m = @messenger.instance_variable_get(:@tunnelid)
+        expect(m).to eql t_opts[:tunnelid]
+      end
+    end
+  end
+
+  describe '.call_endpoint' do
+    context 'when given more than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          @messenger.send(:call_endpoint, nil)
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'when called with no arguments and no @ipv4addr' do
+      before do
+        allow(TunnelBroker::Messenger).to receive(:get).with(
+          'test1',
+          basic_auth: {
+            username: @opts[:username], password: @opts[:update_key]
+          },
+          query: { hostname: @opts[:tunnelid] }
+        ).and_return('success!')
+      end
+
+      subject { @messenger.send(:call_endpoint) }
+
+      it { should eql 'success!' }
+    end
+
+    context 'when called with no arguments and with non-nil @ipv4addr' do
+      before do
+        @opts1 = {
+          url: 'test1', username: 'test2', update_key: 'test3',
+          tunnelid: 'test4', ip4addr: 'test5'
+        }
+        @messenger1 = TunnelBroker::Messenger.new(@opts1)
+        allow(TunnelBroker::Messenger).to receive(:get).with(
+          'test1',
+          basic_auth: {
+            username: @opts1[:username], password: @opts1[:update_key]
+          },
+          query: { hostname: @opts1[:tunnelid], myip: 'test5' }
+        ).and_return('success2!')
+      end
+
+      subject { @messenger1.send(:call_endpoint) }
+
+      it { should eql 'success2!' }
+    end
+
+    context 'when called with no arguments and with nil @ipv4addr' do
+      before do
+        @opts2 = {
+          url: 'test1', username: 'test2', update_key: 'test3',
+          tunnelid: 'test4', ip4addr: nil
+        }
+        @messenger2 = TunnelBroker::Messenger.new(@opts2)
+        allow(TunnelBroker::Messenger).to receive(:get).with(
+          'test1',
+          basic_auth: {
+            username: @opts2[:username], password: @opts2[:update_key]
+          },
+          query: { hostname: @opts2[:tunnelid] }
+        ).and_return('success3!')
+      end
+
+      subject { @messenger2.send(:call_endpoint) }
+
+      it { should eql 'success3!' }
+    end
+  end
+
+  describe '.call_api' do
+    before do
+      allow(TunnelBroker::Messenger).to receive(:get).with(
+        'test1',
+        basic_auth: {
+          username: @opts[:username], password: @opts[:update_key]
+        },
+        query: { hostname: @opts[:tunnelid] }
+      ).and_return('more practice, more success!')
+
+      allow(TunnelBroker::APIResponse).to receive(:new) do |arg1|
+        arg1
+      end
+    end
+
+    context 'when given more than one arg' do
+      it 'should raise ArgumentError' do
+        expect { @messenger.call_api(nil) }.to raise_error ArgumentError
+      end
+    end
+
+    context 'when passed on args' do
+      subject { @messenger.call_api }
+
+      it { should eql 'more practice, more success!' }
+    end
+  end
+
+  describe '#new' do
+    context 'when given more than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          TunnelBroker::Messenger.new(nil, nil)
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'when given less than one arg' do
+      it 'should raise ArgumentError' do
+        expect do
+          TunnelBroker::Messenger.new
+        end.to raise_error ArgumentError
+      end
+    end
+
+    context 'when given an option Hash' do
+      subject { @messenger }
+
+      it { should be_an_instance_of TunnelBroker::Messenger }
+    end
+  end
+end

data/spec/unit/tunnelbroker/version_spec.rb

@@ -0,0 +1,11 @@
+# -*- coding: UTF-8 -*-
+require 'spec_helper'
+
+describe TunnelBroker::VERSION do
+  it { should be_an_instance_of String }
+
+  it 'should match a semantic version regex check' do
+    m = /^\d+\.\d+\.\d+$/
+    expect(m.match(subject)).not_to be_nil
+  end
+end

data/tunnelbroker.gemspec

@@ -0,0 +1,32 @@
+# -*- coding: UTF-8 -*-
+require 'English'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'tunnelbroker/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'tunnelbroker'
+  spec.version     = TunnelBroker::VERSION
+  spec.date        = Time.now.strftime('%Y-%m-%d')
+  spec.description = 'Hurricane Electric IPv6 TunnelBroker API client'
+  spec.summary     = 'HE TunnelBroker API Client'
+  spec.authors     = ['Tim Heckman']
+  spec.email       = 'tim@timheckman.net'
+  spec.homepage    = 'https://github.com/theckman/tunnelbroker'
+  spec.license     = 'MIT'
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.test_files  = %x(git ls-files spec/*).split
+  spec.files       = %x(git ls-files).split
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.2', '>= 10.2.2'
+  spec.add_development_dependency 'rubocop', '~> 0.20'
+  spec.add_development_dependency 'rspec', '>= 3.0.0.beta2'
+  spec.add_development_dependency 'fuubar', '~> 1.3', '>= 1.3.2'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'simplecov', '~> 0.8', '>= 0.8.2'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13'
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: tunnelbroker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Heckman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.2.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Hurricane Electric IPv6 TunnelBroker API client
+email: tim@timheckman.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tunnelbroker.rb
+- lib/tunnelbroker/api_response.rb
+- lib/tunnelbroker/client.rb
+- lib/tunnelbroker/configuration.rb
+- lib/tunnelbroker/messenger.rb
+- lib/tunnelbroker/version.rb
+- spec/spec_helper.rb
+- spec/unit/tunnelbroker/api_response_spec.rb
+- spec/unit/tunnelbroker/client_spec.rb
+- spec/unit/tunnelbroker/configuration_spec.rb
+- spec/unit/tunnelbroker/messenger_spec.rb
+- spec/unit/tunnelbroker/version_spec.rb
+- tunnelbroker.gemspec
+homepage: https://github.com/theckman/tunnelbroker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: HE TunnelBroker API Client
+test_files:
+- spec/spec_helper.rb
+- spec/unit/tunnelbroker/api_response_spec.rb
+- spec/unit/tunnelbroker/client_spec.rb
+- spec/unit/tunnelbroker/configuration_spec.rb
+- spec/unit/tunnelbroker/messenger_spec.rb
+- spec/unit/tunnelbroker/version_spec.rb