noip 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bcf997ac319fd48ed1b67f31f4d7f985d8b1be6
-  data.tar.gz: c1ecfca9c825fc289cab3b515f6fad09d46c6d72
+  metadata.gz: 3e79babb898c9f0fc1f48a58a2897091f656ffd4
+  data.tar.gz: 30e0329f1be0f3e820d52fbfa66c47c1e00ad832
 SHA512:
-  metadata.gz: 8f85d623a85aaffce2c67b140257a8ea77d9f5b49d5b01ae7df484c6665538d0083ffb01640d03fab26f4ce1ab7ecf6189919c4502efface892fa2b8ac4cc6f9
-  data.tar.gz: dc13e1dacc583c0b739fb873e8c38351cd8c8a13df7887923f706068ccc6aa6ee34574c2859ef978bcc82c23d76338fae9d89f7983240d8117b5d2ae08ba2729
+  metadata.gz: 7c5e7cb3b5670ca2e589213d635c03c069c4611f6cd75dbdefc0b928693bfcb8883d37a219d672788387956875e4b2dcade0bc81e611549c14a7eb6699b62f6a
+  data.tar.gz: 8b0b61a1e4c5ec8dd6d971273b2ef0ab49eeda4162bb9914ed64126317b767cbc45d7c46598bf8eae9c9cf7ac4a4582ecbeb9865e494dfff8095b1cc9fe56602

data/.gitignore

@@ -1 +1,2 @@
 pkg
+coverage

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,13 +1,18 @@
 PATH
   remote: .
   specs:
-    noip (0.1)
+    noip (0.2)
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    json (1.8.3)
     method_source (0.8.2)
     pry (0.10.3)
       coderay (~> 1.1.0)
@@ -27,13 +32,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
+    thor (0.19.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
+  codeclimate-test-reporter
   noip!
   pry
   rake

data/README.md

@@ -1,5 +1,10 @@
 # noip
 
+[![Gem Version](https://badge.fury.io/rb/noip.svg)](http://badge.fury.io/rb/noip)
+[![Build Status](https://travis-ci.org/asellitt/noip.svg?branch=master)](https://travis-ci.org/asellitt/noip)
+[![Code Climate](https://codeclimate.com/github/asellitt/noip/badges/gpa.svg)](https://codeclimate.com/github/asellitt/noip)
+[![Test Coverage](https://codeclimate.com/github/asellitt/noip/badges/coverage.svg)](https://codeclimate.com/github/asellitt/noip/coverage)
+
 A simple utility for updating [noip](https://www.noip.com/integrate/request)
 dynamic DNS records for when your router kinda shit.
 
@@ -7,18 +12,20 @@ dynamic DNS records for when your router kinda shit.
 
 ### Command Line Interface 
 
-You will need to provide your credentials and host to update as environment variables:
+`noip` required three parameters: username, password, and host
 
 ```bash
-NOIP_HOST=host.to.update NOIP_USERNAME=username NOIP_PASSWORD=h4h-t0tez-l3g1t noip
+noip update -u username -p h4h-t0tez-l3g1t -h host.to.update
 ```
 
+See `noip help update` for more information
+
 ### Crontab
 
-As before, environment variables will need to be provided, here's a sample crontab that will run every 4 hours:
+Here's a sample crontab entry that will schedule the update every 4 hours
 
 ```crontab
-0 0,4,8,12,16,20 * * * NOIP_HOST=host.to.update NOIP_USERNAME=username NOIP_PASSWORD=h4h-t0tez-l3g1t noip
+0 0,4,8,12,16,20 * * * noip update -u username -p h4h-t0tez-l3g1t -h host.to.update
 ```
 
 ## Contributing

data/Rakefile

@@ -4,4 +4,3 @@ require 'rspec/core/rake_task'
 task :default => :spec
 
 RSpec::Core::RakeTask.new(:spec)
-Rake.add_rakelib 'lib/tasks'

data/bin/noip

@@ -2,4 +2,4 @@
 
 require 'noip'
 
-Noip.update
+Noip::Update.start( ARGV )

data/lib/noip.rb

@@ -1,4 +1,5 @@
 require 'noip/agent'
+require 'noip/cli'
 require 'noip/credentials'
 require 'noip/remote_ip'
 require 'noip/updater'
@@ -6,8 +7,11 @@ require 'noip/version'
 
 module Noip
 
-  def self.update
-    Noip::Updater.new.update
+  def self.update(username, password, host)
+    credentials = Noip::Credentials.new(username, password, host)
+    updater = Noip::Updater.new(credentials)
+
+    updater.update
   end
 
 end

data/lib/noip/cli.rb

@@ -0,0 +1,24 @@
+require 'thor'
+
+module Noip
+  class Update < Thor
+    option :username, :aliases => '-u', :type => :string, :required => true
+    option :password, :aliases => '-p', :type => :string, :required => true
+    option :host,     :aliases => '-h', :type => :string, :required => true
+
+    desc "update", "Update the Dynamic DNS record at noip"
+
+    long_desc <<-DESC
+    `update` Update the Dynamic DNS record at noip.
+
+    A simple utility for updating noip (https://www.noip.com/integrate/request)
+    dynamic DNS records for when your router kinda shit.
+
+    https://github.com/asellitt/noip
+    DESC
+
+    def update
+      Noip.update(options[:username], options[:password], options[:host])
+    end
+  end
+end

data/lib/noip/credentials.rb

@@ -1,10 +1,10 @@
 module Noip
   class Credentials
 
-    def initialize(username = nil, password = nil, host = nil)
-      @username = username || ENV['NOIP_USERNAME']
-      @password = password || ENV['NOIP_PASSWORD']
-      @host     = host || ENV['NOIP_HOST']
+    def initialize(username, password, host)
+      @username = username
+      @password = password
+      @host     = host
     end
 
     attr_reader :username, :password, :host

data/lib/noip/updater.rb

@@ -3,7 +3,8 @@ require 'net/http'
 module Noip
   class Updater
 
-    def initialize
+    def initialize(credentials)
+      @credentials = credentials
       initialize_http_request
     end
 
@@ -13,7 +14,7 @@ module Noip
 
   private
 
-    attr_reader :http, :request, :response
+    attr_reader :credentials, :http, :request, :response
 
     def initialize_http_request
       @http = Net::HTTP.new('dynupdate.no-ip.com')
@@ -36,9 +37,5 @@ module Noip
       @remote_ip ||= Noip::RemoteIp.new
     end
 
-    def credentials
-      @credentials ||= Noip::Credentials.new
-    end
-
   end
 end

data/lib/noip/version.rb

@@ -1,3 +1,3 @@
 module Noip
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/noip.gemspec

@@ -6,7 +6,6 @@ require "noip/version"
 Gem::Specification.new do |spec|
   spec.name          = "noip"
   spec.version       = Noip::VERSION
-  spec.executables   = ["noip"]
   spec.authors       = ["Anthony Sellitti"]
   spec.email         = ["anthony.noip_gem@asellitt.com"]
   spec.summary       = "Dynamic DNS updater for No-IP"
@@ -18,6 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "thor"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/noip/credentials_spec.rb

@@ -1,71 +1,20 @@
 require 'spec_helper'
 
 describe Noip::Credentials do
-  context 'with ENV variables set' do
-    before do
-      allow(ENV).to receive(:[]).with('NOIP_USERNAME').and_return('env_noip_username')
-      allow(ENV).to receive(:[]).with('NOIP_PASSWORD').and_return('env_noip_password')
-      allow(ENV).to receive(:[]).with('NOIP_HOST').and_return('env_noip_host')
-    end
+  subject(:credentials) { Noip::Credentials.new('username', 'password', 'host') }
 
-    describe 'username' do
-      subject(:username) { Noip::Credentials.new(username, password, host).username }
-
-      context 'with values provided' do
-        let(:username) { 'provided_username'}
-        let(:password) { 'provided_password'}
-        let(:host)     { 'provided_host'}
-
-        it { is_expected.to eq 'provided_username' }
-      end
-
-      context 'with no values provided' do
-        let(:username) { nil }
-        let(:password) { nil }
-        let(:host)     { nil }
-
-        it { is_expected.to eq 'env_noip_username' }
-      end
-    end
-
-    describe 'password' do
-      subject(:password) { Noip::Credentials.new(username, password, host).password }
-
-      context 'with values provided' do
-        let(:username) { 'provided_username'}
-        let(:password) { 'provided_password'}
-        let(:host)     { 'provided_host'}
-
-        it { is_expected.to eq 'provided_password' }
-      end
-
-      context 'with no values provided' do
-        let(:username) { nil }
-        let(:password) { nil }
-        let(:host)     { nil }
-
-        it { is_expected.to eq 'env_noip_password' }
-      end
-    end
-
-    describe 'host' do
-      subject(:host) { Noip::Credentials.new(username, password, host).host }
-
-      context 'with values provided' do
-        let(:username) { 'provided_username'}
-        let(:password) { 'provided_password'}
-        let(:host)     { 'provided_host'}
-
-        it { is_expected.to eq 'provided_host' }
-      end
+  describe '.username' do
+    subject(:username) { credentials.username }
+    it { is_expected.to eq 'username' }
+  end
 
-      context 'with no values provided' do
-        let(:username) { nil }
-        let(:password) { nil }
-        let(:host)     { nil }
+  describe '.password' do
+    subject(:password) { credentials.password }
+    it { is_expected.to eq 'password' }
+  end
 
-        it { is_expected.to eq 'env_noip_host' }
-      end
-    end
+  describe '.host' do
+    subject(:host) { credentials.host }
+    it { is_expected.to eq 'host' }
   end
 end

data/spec/noip/updater_spec.rb

@@ -16,15 +16,6 @@ describe Noip::Updater do
     end
     before { allow(Noip::RemoteIp).to receive(:new).and_return(remote_ip) }
 
-    let(:credentials) do
-      instance_double(Noip::Credentials,
-        :username => 'username',
-        :password => 'password',
-        :host => 'host',
-      )
-    end
-    before { allow(Noip::Credentials).to receive(:new).and_return(credentials) }
-
     let(:http) { instance_double(Net::HTTP) }
     before do
       allow(http).to receive(:request)
@@ -37,7 +28,15 @@ describe Noip::Updater do
       allow(Net::HTTP::Get).to receive(:new).and_return(request)
     end
 
-    subject(:update) { Noip::Updater.new.update }
+    let(:credentials) do
+      instance_double(Noip::Credentials,
+        :username => 'username',
+        :password => 'password',
+        :host => 'host',
+      )
+    end
+
+    subject(:update) { Noip::Updater.new(credentials).update }
     before { update }
 
     it 'requests the correct domain' do

data/spec/noip_spec.rb

@@ -2,15 +2,26 @@ require 'spec_helper'
 
 describe Noip do
   describe '.update' do
+    let(:credentials) { instance_double(Noip::Credentials) }
+    before { allow(Noip::Credentials).to receive(:new).and_return(credentials) }
+
     let(:updater) { instance_double(Noip::Updater) }
     before do
       allow(updater).to receive(:update)
       allow(Noip::Updater).to receive(:new).and_return(updater)
     end
 
-    subject(:update) { Noip.update }
+    subject(:update) { Noip.update('username', 'password', 'host') }
     before { update }
 
+    it 'properly constructs the credentials' do
+      expect(Noip::Credentials).to have_received(:new).with('username', 'password', 'host')
+    end
+
+    it 'provides the updater with the correct credentials' do
+      expect(Noip::Updater).to have_received(:new).with(credentials)
+    end
+
     it 'pushes a new update to noip' do
       expect(updater).to have_received(:update)
     end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'noip'
 
 RSpec.configure do |config|
   config.color = true
 end
+

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: noip
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Anthony Sellitti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby_version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
@@ -84,11 +99,11 @@ files:
 - bin/noip
 - lib/noip.rb
 - lib/noip/agent.rb
+- lib/noip/cli.rb
 - lib/noip/credentials.rb
 - lib/noip/remote_ip.rb
 - lib/noip/updater.rb
 - lib/noip/version.rb
-- lib/tasks/noip.rake
 - noip.gemspec
 - spec/noip/agent_spec.rb
 - spec/noip/credentials_spec.rb

data/lib/tasks/noip.rake

@@ -1,9 +0,0 @@
-require 'noip'
-namespace :noip do
-
-  desc "Push a dynamic DNS update to noip"
-  task :update do
-    Noip.update
-  end
-
-end