net-ntp 2.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Jerome Waibel & Zencoder, Inc.
+
+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.markdown

@@ -0,0 +1,26 @@
+net-ntp
+=======
+
+  Originally by Jerome Waibel in 2007  
+  http://rubyforge.org/projects/net-ntp/
+
+  Revised by Zencoder in 2010  
+  http://github.com/zencoder/net-ntp
+
+DESCRIPTION
+-----------
+
+  Began as a 'Rubyfied' version of perl's Net::NTP module, (C) 2004 by James G. Willmore. Refactored and re-released in 2010 by Zencoder.
+
+SYNOPSIS
+--------
+
+    require 'net/ntp'
+
+    Net::NTP.get("us.pool.ntp.org") # => a Net::NTP::Response object
+    Net::NTP.get.time               # => A Time object
+
+INSTALL
+-------
+
+    gem install net-ntp

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+require 'lib/net/ntp/version'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "net-ntp #{Net::NTP::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+    test.rcov_opts << '--exclude "gems/*"'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end

data/lib/net/ntp.rb

@@ -0,0 +1,2 @@
+require 'net/ntp/ntp'
+require 'net/ntp/version'

data/lib/net/ntp/ntp.rb

@@ -0,0 +1,215 @@
+require 'socket'
+require 'timeout'
+
+module Net #:nodoc:
+  module NTP
+    TIMEOUT = 60         #:nodoc:
+    NTP_ADJ = 2208988800 #:nodoc:
+    NTP_FIELDS = [ :byte1, :stratum, :poll, :precision, :delay, :delay_fb,
+                   :disp, :disp_fb, :ident, :ref_time, :ref_time_fb, :org_time,
+                   :org_time_fb, :recv_time, :recv_time_fb, :trans_time,
+                   :trans_time_fb ]
+
+    MODE = {
+      0 => 'reserved',
+      1 => 'symmetric active',
+      2 => 'symmetric passive',
+      3 => 'client',
+      4 => 'server',
+      5 => 'broadcast',
+      6 => 'reserved for NTP control message',
+      7 => 'reserved for private use'
+    }
+
+    STRATUM = {
+      0 => 'unspecified or unavailable',
+      1 => 'primary reference (e.g., radio clock)'
+    }
+
+    2.upto(15) do |i|
+      STRATUM[i] = 'secondary reference (via NTP or SNTP)'
+    end
+
+    16.upto(255) do |i|
+      STRATUM[i] = 'reserved'
+    end
+
+    REFERENCE_CLOCK_IDENTIFIER = {
+      'LOCL' => 'uncalibrated local clock used as a primary reference for a subnet without external means of synchronization',
+      'PPS'  => 'atomic clock or other pulse-per-second source individually calibrated to national standards',
+      'ACTS' => 'NIST dialup modem service',
+      'USNO' => 'USNO modem service',
+      'PTB'  => 'PTB (Germany) modem service',
+      'TDF'  => 'Allouis (France) Radio 164 kHz',
+      'DCF'  => 'Mainflingen (Germany) Radio 77.5 kHz',
+      'MSF'  => 'Rugby (UK) Radio 60 kHz',
+      'WWV'  => 'Ft. Collins (US) Radio 2.5, 5, 10, 15, 20 MHz',
+      'WWVB' => 'Boulder (US) Radio 60 kHz',
+      'WWVH' => 'Kaui Hawaii (US) Radio 2.5, 5, 10, 15 MHz',
+      'CHU'  => 'Ottawa (Canada) Radio 3330, 7335, 14670 kHz',
+      'LORC' => 'LORAN-C radionavigation system',
+      'OMEG' => 'OMEGA radionavigation system',
+      'GPS'  => 'Global Positioning Service',
+      'GOES' => 'Geostationary Orbit Environment Satellite'
+    }
+
+    LEAP_INDICATOR = {
+      0 => 'no warning',
+      1 => 'last minute has 61 seconds',
+      2 => 'last minute has 59 seconds)',
+      3 => 'alarm condition (clock not synchronized)'
+    }
+
+    ###
+    # Sends an NTP datagram to the specified NTP server and returns
+    # a hash based upon RFC1305 and RFC2030.
+    def self.get(host="pool.ntp.org", port="ntp")
+      sock = UDPSocket.new
+      sock.connect(host, port)
+
+      client_time_send      = Time.new.to_i
+      client_localtime      = client_time_send
+      client_adj_localtime  = client_localtime + NTP_ADJ
+      client_frac_localtime = frac2bin(client_adj_localtime)
+
+      ntp_msg = (['00011011']+Array.new(12, 0)+[client_localtime, client_frac_localtime.to_s]).pack("B8 C3 N10 B32")
+
+      sock.print ntp_msg
+      sock.flush
+
+      data = nil
+      Timeout::timeout(TIMEOUT) do |t|
+        data = sock.recvfrom(960)[0]
+      end
+
+      Response.new(data)
+    end
+
+    def self.frac2bin(frac) #:nodoc:
+      bin  = ''
+
+      while bin.length < 32
+        bin += ( frac * 2 ).to_i.to_s
+        frac = ( frac * 2 ) - ( frac * 2 ).to_i
+      end
+
+      bin
+    end
+    private_class_method :frac2bin
+
+    class Response
+      def initialize(raw_data)
+        @raw_data = raw_data
+        @client_time_receive = Time.new.to_i
+      end
+
+      def leap_indicator
+        @leap_indicator ||= (packet_data_by_field[:byte1][0] & 0xC0) >> 6
+      end
+
+      def leap_indicator_text
+        @leap_indicator_text ||= LEAP_INDICATOR[leap_indicator]
+      end
+
+      def version_number
+        @version_number ||= (packet_data_by_field[:byte1][0] & 0x38) >> 3
+      end
+
+      def mode
+        @mode ||= (packet_data_by_field[:byte1][0] & 0x07)
+      end
+
+      def mode_text
+        @mode_text ||= MODE[mode]
+      end
+
+      def stratum
+        @stratum ||= packet_data_by_field[:stratum]
+      end
+
+      def stratum_text
+        @stratum_text ||= STRATUM[stratum]
+      end
+
+      def poll_interval
+        @poll_interval ||= packet_data_by_field[:poll]
+      end
+
+      def precision
+        @precision ||= packet_data_by_field[:precision] - 255
+      end
+
+      def root_delay
+        @root_delay ||= bin2frac(packet_data_by_field[:delay_fb])
+      end
+
+      def root_dispersion
+        @root_dispersion ||= packet_data_by_field[:disp]
+      end
+
+      def reference_clock_identifier
+        @reference_clock_identifier ||= unpack_ip(packet_data_by_field[:stratum], packet_data_by_field[:ident])
+      end
+
+      def reference_clock_identifier_text
+        @reference_clock_identifier_text ||= REFERENCE_CLOCK_IDENTIFIER[reference_clock_identifier]
+      end
+
+      def reference_timestamp
+        @reference_timestamp ||= ((packet_data_by_field[:ref_time] + bin2frac(packet_data_by_field[:ref_time_fb])) - NTP_ADJ)
+      end
+
+      def originate_timestamp
+        @originate_timestamp ||= (packet_data_by_field[:org_time] + bin2frac(packet_data_by_field[:org_time_fb]))
+      end
+
+      def receive_timestamp
+        @receive_timestamp ||= ((packet_data_by_field[:recv_time] + bin2frac(packet_data_by_field[:recv_time_fb])) - NTP_ADJ)
+      end
+
+      def transmit_timestamp
+        @transmit_timestamp ||= ((packet_data_by_field[:trans_time] + bin2frac(packet_data_by_field[:trans_time_fb])) - NTP_ADJ)
+      end
+
+      def time
+        @time ||= Time.at(receive_timestamp)
+      end
+
+
+    protected
+
+      def packet_data_by_field #:nodoc:
+        if !@packet_data_by_field
+          @packetdata = @raw_data.unpack("a C3   n B16 n B16 H8   N B32 N B32   N B32 N B32");
+          @packet_data_by_field = {}
+          NTP_FIELDS.each do |field|
+            @packet_data_by_field[field] = @packetdata.shift
+          end
+        end
+
+        @packet_data_by_field
+      end
+
+      def bin2frac(bin) #:nodoc:
+        frac = 0
+
+        bin.reverse.split("").each do |b|
+          frac = ( frac + b.to_i ) / 2.0
+        end
+
+        frac
+      end
+
+      def unpack_ip(stratum, tmp_ip) #:nodoc:
+        if stratum < 2
+          [tmp_ip].pack("H8").unpack("A4")[0]
+        else
+          ipbytes = [tmp_ip].pack("H8").unpack("C4")
+          sprintf("%d.%d.%d.%d", ipbytes[0], ipbytes[1], ipbytes[2], ipbytes[3])
+        end
+      end
+
+    end
+
+  end
+end

data/lib/net/ntp/version.rb

@@ -0,0 +1,5 @@
+module Net
+  module NTP
+    VERSION = '2.0.0'
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: net-ntp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 0
+  version: 2.0.0
+platform: ruby
+authors: 
+- Jerome Waibel
+- Nathan Sutton
+- Brandon Arbini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-09 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: This project was a rubyfied version of perl's Net::NTP module, (C) 2004 by James G. Willmore. It provides a method to query an NTP server as specified in RFC1305 and RFC2030. Updated and re-released in 2010 by Zencoder.
+email: 
+- nate@zencoder.com
+- brandon@zencoder.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/net/ntp/ntp.rb
+- lib/net/ntp/version.rb
+- lib/net/ntp.rb
+- LICENSE
+- README.markdown
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/zencoder/net-ntp
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: NTP client for ruby.
+test_files: []
+