radiodns 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    radiodns (0.0.1)
+    radiodns (0.0.2)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -10,7 +10,38 @@ This Ruby Gem provides utilities for working with the RadioDNS spec.
 
 ## Usage
 
+Add this to the top of your script
+
     require 'radiodns'
 
-    cname = RadioDNS::Resolver.resolve(''09580.c586.ce1.fm.radiodns.org')
+Then if you already have the Fully Qualified Domain Name as specified
+in the [RadioDNS spec](http://radiodns.org/wp-content/uploads/2009/03/rdns011.pdf), you
+can resolve it into a CNAME like so
+
+    cname = RadioDNS::Resolver.resolve('09580.c586.ce1.fm.radiodns.org')
     puts cname #=> 'rdns.musicradio.com'
+
+You can also pass in the parameters required to construct the FQDN to
+the resolve method
+
+    params = {
+      :freq => '09580',
+      :pi => 'c586',
+      :ecc => 'ce1',
+      :bearer => 'fm'
+    }
+    cname = RadioDNS::Resolver.resolve(params)
+
+The bearers `fm`, `dab`, `drm`, `amss` and `hd` are supported.
+
+## TODO
+
+ - better error checking of supplied parameters. The code current
+   checks for mandatory parameters but not if the parameters
+   themselves conform to the spec (e.g. pa should be between 0 and
+   1023)
+
+ - return an appropriate error if DNS look-up does not resolve to
+   CNAME.
+
+ - service discovery

data/lib/radiodns.rb

@@ -3,9 +3,51 @@ require 'resolv'
 module RadioDNS
   class Resolver
     def self.resolve(fqdn)
+      if fqdn.is_a? Hash
+        fqdn = construct_fqdn(fqdn)
+      end
+
       resolver = Resolv::DNS.new
       cname = resolver.getresource(fqdn, Resolv::DNS::Resource::IN::CNAME)
       cname.name.to_s
     end
+
+    def self.construct_fqdn(params)
+      bearer = params[:bearer]
+      case bearer
+        when "fm" then construct_fqdn_for_fm(params)
+        when "dab" then construct_fqdn_for_dab(params)
+        when "drm" then construct_fqdn_for_drm_or_amss(params)
+        when "amss" then construct_fqdn_for_drm_or_amss(params)
+        when "hd" then construct_fqdn_for_hd(params)
+      end
+    end
+
+    private
+    def self.construct_fqdn_for_hd(params)
+      raise ArgumentError unless params[:tx] && params[:cc]
+      [params[:tx], params[:cc], 'hd.radiodns.org'].join('.')
+    end
+    def self.construct_fqdn_for_drm_or_amss(params)
+      raise ArgumentError unless params[:sid]
+      [params[:sid], params[:bearer], 'radiodns.org'].join('.')
+    end
+    def self.construct_fqdn_for_dab(params)
+      raise ArgumentError unless params[:scids] && params[:sid] && params[:eid] && params[:ecc]
+      [params[:appty_uatype] || params[:pa],
+       params[:scids],
+       params[:sid],
+       params[:eid],
+       params[:ecc],
+       'dab.radiodns.org'].reject{|a| a.nil?}.join('.')
+    end
+    def self.construct_fqdn_for_fm(params)
+      raise ArgumentError if params[:ecc] && params[:country]
+      raise ArgumentError if params[:ecc].nil? && params[:country].nil?
+      [params[:freq],
+       params[:pi],
+       params[:ecc] || params[:country],
+       'fm.radiodns.org'].join('.')
+    end
   end
 end

data/lib/radiodns/version.rb

@@ -1,3 +1,3 @@
 module Radiodns
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/radiodns.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Chris Lowis"]
   s.email       = ["chris.lowis@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/chrislo/radiodns"
   s.summary     = %q{Perform RadioDNS resolutions and service lookups}
   s.description = %q{Perform RadioDNS resolutions and service lookups}
 

data/spec/radiodns_spec.rb

@@ -5,7 +5,7 @@ require 'radiodns'
 
 describe "RadioDNS::Resolver" do
   describe "resolve" do
-    it "should query radiodns.org" do
+    before(:each) do
       mock_resolver = mock()
       mock_cname = mock()
       mock_resolver.expects(:getresource).
@@ -14,9 +14,156 @@ describe "RadioDNS::Resolver" do
       mock_cname.expects(:name).returns('rdns.musicradio.com')
 
       Resolv::DNS.expects(:new).returns(mock_resolver)
-
+    end
+    it "should query radiodns.org" do
       cname = RadioDNS::Resolver.resolve('09580.c586.ce1.fm.radiodns.org')
       assert_equal 'rdns.musicradio.com', cname
     end
+
+    it "should accept hash params too" do
+      params = {
+        :freq => '09580',
+        :pi => 'c586',
+        :ecc => 'ce1',
+        :bearer => 'fm'
+      }
+      cname = RadioDNS::Resolver.resolve(params)
+      assert_equal 'rdns.musicradio.com', cname
+    end
+  end
+
+  describe "construct_fqdn" do
+    describe "for FM/VHF bearer" do
+      it "should construct a fqdn when ecc is supplied" do
+        params = {
+          :bearer => 'fm',
+          :ecc => 'ce1',
+          :pi => 'c585',
+          :freq => '09580'
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal '09580.c585.ce1.fm.radiodns.org', fqdn
+      end
+      it "should construct a fqdn when country is supplied" do
+        params = {
+          :bearer => 'fm',
+          :country => 'gb',
+          :pi => 'c585',
+          :freq => '09580'
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal '09580.c585.gb.fm.radiodns.org', fqdn
+      end
+      it "should raise when country and ecc is supplied" do
+        params = {
+          :bearer => 'fm',
+          :country => 'gb',
+          :ecc => 'ce1',
+          :pi => 'c585',
+          :freq => '09580'
+        }
+        assert_raises(ArgumentError) {RadioDNS::Resolver.construct_fqdn(params)}
+      end
+      it "should raise when neither country nor ecc is supplied" do
+        params = {
+          :bearer => 'fm',
+          :pi => 'c585',
+          :freq => '09580'
+        }
+        assert_raises(ArgumentError) {RadioDNS::Resolver.construct_fqdn(params)}
+      end
+    end
+    describe "for DAB bearer" do
+      it "should construct a fqdn" do
+        params = {
+          :bearer => 'dab',
+          :ecc => 'ecc',
+          :eid => 'eid',
+          :sid => 'sid',
+          :scids => 'scids'
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal 'scids.sid.eid.ecc.dab.radiodns.org', fqdn
+      end
+      it "should raise if parameters are missing" do
+        params = {
+          :bearer => 'dab',
+        }
+        assert_raises(ArgumentError) {RadioDNS::Resolver.construct_fqdn(params)}
+      end
+      it "should prepend appty-uatype if provided" do
+        params = {
+          :bearer => 'dab',
+          :ecc => 'ecc',
+          :eid => 'eid',
+          :sid => 'sid',
+          :scids => 'scids',
+          :appty_uatype => 'appty-uatype'
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal 'appty-uatype.scids.sid.eid.ecc.dab.radiodns.org', fqdn
+      end
+      it "should prepend pa if provided" do
+        params = {
+          :bearer => 'dab',
+          :ecc => 'ecc',
+          :eid => 'eid',
+          :sid => 'sid',
+          :scids => 'scids',
+          :pa => 'pa'
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal 'pa.scids.sid.eid.ecc.dab.radiodns.org', fqdn
+      end
+    end
+    describe "for DRM bearer" do
+      it "should construct a fqdn" do
+        params = {
+          :bearer => 'drm',
+          :sid => 'sid',
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal 'sid.drm.radiodns.org', fqdn
+      end
+      it "should raise if sid is missing" do
+        params = {
+          :bearer => 'drm',
+        }
+        assert_raises(ArgumentError) {RadioDNS::Resolver.construct_fqdn(params)}
+      end
+    end
+    describe "for AMSS bearer" do
+      it "should construct a fqdn" do
+        params = {
+          :bearer => 'amss',
+          :sid => 'sid',
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal 'sid.amss.radiodns.org', fqdn
+      end
+      it "should raise if sid is missing" do
+        params = {
+          :bearer => 'amss',
+        }
+        assert_raises(ArgumentError) {RadioDNS::Resolver.construct_fqdn(params)}
+      end
+    end
+    describe "for hd bearer" do
+      it "should construct a fqdn" do
+        params = {
+          :bearer => 'hd',
+          :tx => 'tx',
+          :cc => 'cc',
+        }
+        fqdn = RadioDNS::Resolver.construct_fqdn(params)
+        assert_equal 'tx.cc.hd.radiodns.org', fqdn
+      end
+      it "should raise if tx or cc is missing" do
+        params = {
+          :bearer => 'hd',
+        }
+        assert_raises(ArgumentError) {RadioDNS::Resolver.construct_fqdn(params)}
+      end
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: radiodns
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chris Lowis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-05 00:00:00 +00:00
+date: 2011-03-06 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,7 @@ files:
 - radiodns.gemspec
 - spec/radiodns_spec.rb
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/chrislo/radiodns
 licenses: []
 
 post_install_message: