qrz-callbook 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brad McConahay
+
+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/Manifest

@@ -0,0 +1,5 @@
+LICENSE.txt
+README.rdoc
+Rakefile
+lib/qrz-callbook.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,80 @@
+= QRZCallbook
+
+This gem provides an easy object oriented front end to access Amateur Radio
+callsign data from the QRZ.COM online database.
+
+It uses the QRZ XML Database Service, which requires a subscription from QRZ.COM.
+
+The QRZ XML Database Service specification states "The data supplied by the XML port may
+be extended in a forwardly compatible manner. New XML elements and database objects
+(with their associated elements) may be transmitted at any time. It is the developers
+responsibility to have their program ignore any unrecognized objects and/or elements
+without raising an error, so long as the information received consists of properly formatted XML."
+
+Therefore, this gem will not attempt to list or manage individual elements of a callsign.  You
+will need to inspect the hash to see which elements are available for any given
+callsign, as demonstrated in the synopsis.
+
+This gem does not handle any management of reusing session keys at this time, although you can
+specify a key you have used previously when initializing, or at any time via the key accessor.
+
+== Usage
+
+  require "rubygems"
+  require "pp"
+  require "qrz-callbook"
+
+	qrz = QRZCallbook.new({
+		'callsign' => 'n8qq',
+		'username' => 'qrz_username',
+		'password' => 'qrz_password'
+	})
+
+  # get and inspect the basic listing
+
+	qrz.get_listing
+	pp qrz.listing
+
+  # get and inspect biography information
+
+	qrz.get_bio
+	pp qrz.bio
+
+	qrz.get_bio_file
+	puts "Biography: #{qrz.bio_file}"
+
+  # get and inspect dxcc information
+
+	qrz.get_dxcc
+	pp qrz.dxcc
+
+  # show the session information from the last call to the api
+
+	pp qrz.session
+
+  # set a new callsign and show some misc individual information
+
+	qrz.callsign = 'w8irc'
+	qrz.get_listing
+	qrz.get_dxcc
+
+	puts "Name: #{qrz.listing['fname']} #{qrz.listing['name']}"
+	puts "DXCC Continent: #{qrz.dxcc['continent']}"
+
+== Dependencies
+
+* xml-simple
+
+* A QRZ.COM subscription that includes access to the QRZ XML Database Service
+
+== See Also
+
+* In order to use this module you need to have a subscription for the QRZ XML Database Service.  See http://www.qrz.com/XML/index.html
+
+* The technical reference for the QRZ XML Database Service is at http://www.qrz.com/XML/current_spec.html
+
+== Copyright
+
+Copyright (c) 2010 Brad McConahay. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('qrz-callbook', '0.0.1') do |p|
+  p.description    = "A front end for the QRZ.COM Amateur Radio callsign database API."
+  p.url            = "http://github.com/bradmc/qrz-callbook"
+  p.author         = "Brad McConahay"
+  p.email          = "brad @nospam@ mcconahay.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.runtime_dependencies = ["xml-simple"]
+end
+

data/lib/qrz-callbook.rb

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'open-uri'
+require 'xmlsimple'
+require 'cgi'
+
+class QRZCallbook
+
+	@@VERSION = '0.0.1'
+
+	class SessionError < StandardError; end
+
+	attr_accessor :callsign, :username, :password, :key
+	attr_reader   :session, :listing, :bio, :bio_file, :dxcc
+
+	QRZ_URL = 'http://www.qrz.com/xml'
+	AGENT = "ruby-gem-qrz-callbook-#{@@VERSION}"
+
+	def initialize(args={})
+		@callsign = args['callsign']
+		@username = args['username']
+		@password = args['password']
+		@key = args['key']
+		raise "A QRZ API subscription username is required." if @username.to_s.empty?
+		raise "A QRZ API subscription password is required." if @password.to_s.empty?
+	end
+
+	def login
+		raise "A QRZ API subscription username is required." if @username.to_s.empty?
+		raise "A QRZ API subscription password is required." if @password.to_s.empty?
+		url = "#{QRZ_URL}/bin/xml?username=#{@username};password=#{@password};agent=#{AGENT}"
+		xml = open(url).read
+		content  = XmlSimple.xml_in( xml, { 'ForceArray' => false } )
+		@session = content['Session']
+		raise SessionError, @session['Error'] if @session['Error']
+		@key = @session['Key']
+		raise SessionError, "Unknown Error: Could not retrieve session key." if @session['Key'].to_s.empty?
+	end
+
+	def get_listing
+		raise "An amateur radio callsign is required to retrieve data." if @callsign.to_s.empty?
+		login if @key.to_s.empty?
+		url = "#{QRZ_URL}/bin/xml?s=#{@key};callsign=#{@callsign}";
+		xml = open(url).read
+		content = XmlSimple.xml_in( xml, { 'ForceArray' => false } )
+		@session = content['Session']
+		raise SessionError, @session['Error'] if @session['Error']
+		@listing = content['Callsign']			
+	end
+
+	def get_bio
+		raise "An amateur radio callsign is required to retrieve data." if @callsign.to_s.empty?
+		login if @key.to_s.empty?
+		url = "#{QRZ_URL}/bin/xml?s=#{@key};bio=#{@callsign}";
+		xml = open(url).read
+		content = XmlSimple.xml_in( xml, { 'ForceArray' => false } )
+		@session = content['Session']
+		if @session['Error'] =~ /not found/i
+			@bio = {}
+			return
+		end
+		raise SessionError, @session['Error'] if @session['Error']
+		@bio = content['Bio']
+	end
+
+	def get_bio_file
+		get_bio if @bio.to_s.empty?
+		if @bio['bio'].to_s.empty?
+			@bio_file = ''
+			return;
+		end
+		url = "#{@bio['bio']}";
+		content = open(url).read
+		content = content.gsub(/&nbsp;/," ").gsub(/<.*?>/m, '').gsub(%r{(\n\s*){2}}, "\n\n")
+		@bio_file = CGI.unescapeHTML(content)
+	end
+
+	def get_dxcc
+		raise "An amateur radio callsign is required to retrieve data." if @callsign.to_s.empty?
+		login if @key.to_s.empty?
+		url = "#{QRZ_URL}/bin/xml?s=#{@key};dxcc=#{@callsign}";
+		xml = open(url).read
+		content = XmlSimple.xml_in( xml, { 'ForceArray' => false } )
+		@session = content['Session']
+		raise SessionError, @session['Error'] if @session['Error']
+		@dxcc = content['DXCC']	
+	end
+
+end # class QRZCallbook
+
+

data/qrz-callbook.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{qrz-callbook}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brad McConahay"]
+  s.date = %q{2010-12-26}
+  s.description = %q{A front end for the QRZ.COM Amateur Radio callsign database API.}
+  s.email = %q{brad @nospam@ mcconahay.com}
+  s.extra_rdoc_files = ["LICENSE.txt", "README.rdoc", "lib/qrz-callbook.rb"]
+  s.files = ["LICENSE.txt", "README.rdoc", "Rakefile", "lib/qrz-callbook.rb", "Manifest", "qrz-callbook.gemspec"]
+  s.homepage = %q{http://github.com/bradmc/qrz-callbook}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Qrz-callbook", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{qrz-callbook}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A front end for the QRZ.COM Amateur Radio callsign database API.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+    else
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: qrz-callbook
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brad McConahay
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A front end for the QRZ.COM Amateur Radio callsign database API.
+email: brad @nospam@ mcconahay.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+- lib/qrz-callbook.rb
+files: 
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/qrz-callbook.rb
+- Manifest
+- qrz-callbook.gemspec
+has_rdoc: true
+homepage: http://github.com/bradmc/qrz-callbook
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Qrz-callbook
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: qrz-callbook
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A front end for the QRZ.COM Amateur Radio callsign database API.
+test_files: []
+