dx-lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53be409b66cb963cfb9e05b80c762cee71e64866
+  data.tar.gz: b67e36b333f28b7561b43a1c7a6926825e458d23
+SHA512:
+  metadata.gz: 9cbf0cf0c61140d893675d5c8a2da315703085545e1a7c09f05f519385b15fddb51d22b891c2080b0f4006bd17666feeee6bcd1294040a0ffe2416ceff937750
+  data.tar.gz: e691220c6c57e92d9409ccf4673ba6ed6d22161edc1028dcd2ca27997fb7b11e9b92425c508de4fa292adf425b2c323d919f144161bc90d236939dc591f6d8bc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dx-lookup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rockwell Schrock
+
+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.md

@@ -0,0 +1,65 @@
+# DX::Lookup
+
+Easy callsign and DXCC entity lookup utilizing third-party APIs. 
+
+Currently-supported APIs:
+
+* QRZ.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dx-lookup'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dx-lookup
+
+## Usage
+
+### QRZ.com Lookup
+
+You must have a subscription to the "XML Logbook Data" subscription on QRZ.com. Go to [your account page](https://www.qrz.com/manager) to subscribe.
+
+It is highly recommended that you store your QRZ.com username externally to your source files, for example in a configuration file, or in your environment variables.
+
+```ruby
+qrz = DX::Lookup::QRZ.new(ENV['QRZ_USERNAME'], ENV['QRZ_PASSWORD'])
+
+call = qrz.get_callsign('W1AW')
+puts call.last_name # => 'ARRL HQ OPERATORS CLUB'
+puts call.dxcc # => 291
+puts call.grid # => 'FN31pr'
+
+entity = qrz.get_dxcc_entity(291)
+puts entity.name # => 'United States'
+
+entity = qrz.get_callsign_entity('OH8X')
+puts entity.name # => 'Finland'
+
+entities = qrz.get_all_entities
+puts entities.count # => 399
+```
+
+See `lib/dx/lookup/qrz/callsign.rb` and `lib/dx/lookup/qrz/entity.rb` for a complete list of supported attributes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/schrockwell/dx-lookup.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dx/lookup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dx-lookup.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dx/lookup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dx-lookup"
+  spec.version       = DX::Lookup::VERSION
+  spec.authors       = ["Rockwell Schrock"]
+  spec.email         = ["cq@ww1x.com"]
+
+  spec.summary       = %q{Callsign detail lookup}
+  spec.homepage      = "https://github.com/schrockwell/dx-lookup"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency 'httparty', '~> 0.14'
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
+end

data/lib/dx/lookup.rb

@@ -0,0 +1,6 @@
+require 'date'
+require 'httparty'
+require 'virtus'
+
+require "dx/lookup/version"
+require 'dx/lookup/qrz'

data/lib/dx/lookup/qrz.rb

@@ -0,0 +1,81 @@
+require_relative 'qrz/callsign'
+require_relative 'qrz/entity'
+
+module DX
+  module Lookup
+    class QRZ
+      class APIError < StandardError; end
+
+      include HTTParty
+
+      API_VERSION = '1.33'
+      AGENT = "dx-lookup-#{DX::Lookup::VERSION}"
+
+      base_uri "xmldata.qrz.com/xml/#{API_VERSION}/"
+
+      attr_reader :session_key
+
+      def initialize(username, password, options={})
+        @username, @password = username, password
+      end
+
+      def get_callsign(callsign)
+        login_if_needed!
+        uri = construct_uri(:callsign => callsign)
+        response = self.class.get(uri).parsed_response
+        check_for_error(response)
+
+        callsign_response = response['QRZDatabase']['Callsign']
+        Callsign.from_response(callsign_response)
+      end
+
+      def get_dxcc_entity(dxcc)
+        get_entities(dxcc.to_s).first
+      end
+
+      def get_all_entities
+        get_entities('all')
+      end
+
+      def get_callsign_entity(callsign)
+        get_entities(callsign).first
+      end
+
+      def create_session!
+        uri = construct_uri(:username => @username, :password => @password, :agent => AGENT)
+        response = self.class.get(uri)
+        response = response.parsed_response
+        check_for_error(response)
+
+        @session_key = response['QRZDatabase']['Session']['Key']
+      end
+
+    protected
+
+      def construct_uri(params={})
+        params = params.merge(:s => session_key) if session_key && !params[:s]
+        "?#{params.map { |k, v| "#{k}=#{v}" }.join(';')}"
+      end
+
+      def login_if_needed!
+        create_session! unless session_key
+      end
+
+      def check_for_error(parsed_response)
+        error = parsed_response['QRZDatabase']['Session']['Error']
+        message = parsed_response['QRZDatabase']['Session']['Message']
+        raise(APIError, message || error) if error
+      end
+
+      def get_entities(callsign)
+        login_if_needed!
+        uri = construct_uri(:dxcc => callsign)
+        response = self.class.get(uri).parsed_response
+        check_for_error(response)
+        
+        dxccs = [response['QRZDatabase']['DXCC']].flatten
+        dxccs.map { |dxcc| Entity.from_response(dxcc) }
+      end
+    end
+  end
+end

data/lib/dx/lookup/qrz/callsign.rb

@@ -0,0 +1,83 @@
+module DX
+  module Lookup
+    class QRZ
+      class Callsign
+        include Virtus.model
+
+        attribute :callsign, String
+        attribute :aliases, Array[String]
+        attribute :dxcc, Integer
+        attribute :first_name, String
+        attribute :last_name, String
+        attribute :address_1, String
+        attribute :address_2, String
+        attribute :address_state, String
+        attribute :address_zip, String
+        attribute :address_country, String
+        attribute :address_dxcc, Integer
+        attribute :coordinate, Array[Float]
+        attribute :grid, String
+        attribute :county, String
+        attribute :dxcc_name, String
+        attribute :effective_date, Date
+        attribute :expiration_date, Date
+        attribute :fips, String
+        attribute :previous_callsign, String
+        attribute :license_class, String
+        attribute :license_codes, String
+        attribute :qsl_info, String
+        attribute :email, String
+        attribute :url, String
+        attribute :profile_views, Integer
+        attribute :qsl_accepted, Boolean
+        attribute :eqsl_accepted, Boolean
+        attribute :lotw_accepted, Boolean
+        attribute :cq_zone, Integer
+        attribute :itu_zone, Integer
+        attribute :birth_year, Integer
+        attribute :qrz_admin, String
+        attribute :iota, String
+        attribute :geo_source, Symbol
+
+        def self.from_response(xml)
+          Callsign.new(
+            :callsign => xml['call'],
+            :aliases => xml['aliases'].to_s.split(','),
+            :dxcc => xml['dxcc'],
+            :first_name => xml['fname'],
+            :last_name => xml['name'],
+            :address_1 => xml['addr1'],
+            :address_2 => xml['addr2'],
+            :address_state => xml['state'],
+            :address_zip => xml['zip'],
+            :address_country => xml['country'],
+            :address_dxcc => xml['ccode'],
+            :coordinate => [xml['lat'], xml['lon']],
+            :grid => xml['grid'],
+            :county => xml['county'],
+            :dxcc_name => xml['land'],
+            :effective_date => xml['efdate'],
+            :expiration_date => xml['expdate'],
+            :fips => xml['fips'],
+            :previous_callsign => xml['p_call'],
+            :license_class => xml['class'],
+            :license_codes => xml['codes'],
+            :qsl_info => xml['qslmgr'],
+            :email => xml['email'],
+            :url => xml['url'],
+            :profile_views => xml['u_views'],
+            :eqsl_accepted => xml['eqsl'],
+            :qsl_accepted => xml['mqsl'],
+            :cq_zone => xml['cqzone'],
+            :itu_zone => xml['ituzone'],
+            :birth_year => xml['born'],
+            :qrz_admin => xml['user'],
+            :lotw_accepted => xml['lotw'],
+            :iota => xml['iota'],
+            :geo_source => xml['geoloc']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/dx/lookup/qrz/entity.rb

@@ -0,0 +1,35 @@
+module DX
+  module Lookup
+    class QRZ
+      class Entity
+        include Virtus.model
+
+        attribute :dxcc, Integer
+        attribute :code_short, String
+        attribute :code_long, String
+        attribute :name, String
+        attribute :continent, String
+        attribute :itu_zone, Integer
+        attribute :cq_zone, Integer
+        attribute :time_zone, Integer
+        attribute :coordinate, Array[Float]
+        attribute :notes, String
+
+        def self.from_response(xml)
+          Entity.new(
+            :dxcc => xml['dxcc'],
+            :code_short => xml['cc'],
+            :code_long => xml['ccc'],
+            :name => xml['name'],
+            :continent => xml['continent'],
+            :itu_zone => xml['ituzone'],
+            :cq_zone => xml['cqzone'],
+            :time_zone => xml['timezone'],
+            :coordinate => [xml['lat'], xml['lon']],
+            :notes => xml['notes']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/dx/lookup/version.rb

@@ -0,0 +1,5 @@
+module DX
+  module Lookup
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: dx-lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rockwell Schrock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- cq@ww1x.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dx-lookup.gemspec
+- lib/dx/lookup.rb
+- lib/dx/lookup/qrz.rb
+- lib/dx/lookup/qrz/callsign.rb
+- lib/dx/lookup/qrz/entity.rb
+- lib/dx/lookup/version.rb
+homepage: https://github.com/schrockwell/dx-lookup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Callsign detail lookup
+test_files: []