govkit-ca 0.0.1 → 0.0.2

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
 .bundle
+.yardoc
 Gemfile.lock
+doc/*
 pkg/*

data/README.md

@@ -7,12 +7,15 @@ GovKit-CA is a Ruby gem that provides easy access to Canadian civic data around
 * [ndp.ca](http://www.ndp.ca/)
 * [digital-copyright.ca](http://www.digital-copyright.ca/)
 * [liberal.ca](http://www.liberal.ca/)
+* [greenparty.ca](http://www.greenparty.ca/)
+* [parl.gc.ca](http://www.parl.gc.ca/)
+* [conservative.ca](http://www.conservative.ca/)
 
 GovKit-CA follows from [Participatory Politics Foundation](http://www.participatorypolitics.org/)'s [GovKit](https://github.com/opengovernment/govkit) gem. GovKit-CA is not affiliated with the Participatory Politics Foundation or GovKit.
 
 # Installation
 
-    gem install govkit
+    gem install govkit-ca
 
 # Examples
 
@@ -21,24 +24,25 @@ GovKit-CA follows from [Participatory Politics Foundation](http://www.participat
     >> GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('A1A1A1')
     => [10007]
     >> GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('K0A1K0')
-    => [35087, 35025, 35052, 35012, 35040, 35063, 35064]
+    => [35012, 35025, 35040, 35052, 35063, 35064, 35087]
+    >> GovKit::CA::PostalCode.find_electoral_districts_by_postal_code('H0H0H0')
+    => GovKit::CA::ResourceNotFound
 
     >> GovKit::CA::PostalCode.find_province_by_postal_code('A1A1A1')
     => "Newfoundland and Labrador"
     >> GovKit::CA::PostalCode.find_province_by_postal_code('K0A1K0')
     => "Ontario"
+    >> GovKit::CA::PostalCode.find_province_by_postal_code('H0H0H0')
+    => "Quebec"
 
 Postal codes may contain lowercase letters. Spaces and non-alphanumeric characters are removed before processing.
 
-GovKit-CA will raise GovKit::CA::ResourceNotFound if the electoral districts within a postal code cannot be determined.
+GovKit-CA will raise GovKit::CA::ResourceNotFound if the electoral districts within a postal code cannot be determined, and GovKit::CA::InvalidRequest if a postal code is not properly formatted.
 
 # Bugs? Questions?
 
-Govkit-CA's main repository is on GitHub: [http://github.com/jpmckinney/govkit-ca](http://github.com/jpmckinney/govkit-ca), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
-
-# TODOs
+GovKit-CA interoperates with [Participatory Politics Foundation](http://www.participatorypolitics.org/)'s [GovKit](https://github.com/opengovernment/govkit). Please join the [GovKit Google Group](http://groups.google.com/group/govkit), especially if you'd like to talk about a new feature and get announcements.
 
-* Write tests
-* Add a `ElectoralDistrict` class to convert IDs to English and french names.
+Govkit-CA's main repository is on GitHub: [http://github.com/jpmckinney/govkit-ca](http://github.com/jpmckinney/govkit-ca), where your contributions, forks, bug reports, feature requests, and feedback are greatly welcomed.
 
 Copyright (c) 2011 James McKinney, released under the MIT license

data/Rakefile

@@ -6,4 +6,13 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end
+
 require File.expand_path('../tasks/rid_to_edid', __FILE__)

data/lib/gov_kit-ca/postal_code/strategy/base.rb

@@ -22,7 +22,7 @@ module GovKit
           # Returns the electoral districts within a postal code.
           # @return [Array<Fixnum>] the electoral districts within the postal code
           def electoral_districts
-            valid? && electoral_districts!.map(&:to_i)
+            valid? && electoral_districts!.map(&:to_i).sort
           end
 
         private

data/lib/gov_kit-ca/postal_code/strategy/digital_copyright-ca.rb

@@ -2,6 +2,7 @@ module GovKit
   module CA
     module PostalCode
       module Strategy
+        # Occasionally suffers from timeout errors.
         class DigitalCopyrightCa < Base
           base_uri 'www.digital-copyright.ca'
 

data/lib/gov_kit-ca/postal_code/strategy/greenparty-ca.rb

@@ -0,0 +1,29 @@
+module GovKit
+  module CA
+    module PostalCode
+      module Strategy
+        # greenparty.ca does not return electoral districts for postal codes
+        # that contain multiple electoral districts.
+        class GreenPartyCa < Base
+          base_uri 'greenparty.ca'
+
+        private
+
+          def electoral_districts!
+            [ response.headers['location'][/\d+\Z/] ]
+          end
+
+          def valid?
+            response.headers['location'] != 'http://greenparty.ca/find_your_riding'
+          end
+
+          def response
+            @response ||= self.class.head "/search/civicrm_lookup/#{@postal_code}"
+          end
+        end
+
+        StrategySet.register GreenPartyCa
+      end
+    end
+  end
+end

data/lib/gov_kit-ca/postal_code/strategy/liberal-ca.rb

@@ -2,6 +2,7 @@ module GovKit
   module CA
     module PostalCode
       module Strategy
+        # liberal.ca is unreliable during elections.
         class LiberalCa < Base
           base_uri 'www.liberal.ca'
 

data/lib/gov_kit-ca/postal_code/strategy/ndp-ca.rb

@@ -18,7 +18,7 @@ module GovKit
           end
 
           def response
-            @response ||= self.class.head "http://www.ndp.ca/riding/#{@postal_code}"
+            @response ||= self.class.head "/riding/#{@postal_code}"
           end
         end
 

data/lib/gov_kit-ca/postal_code/strategy.rb

@@ -24,8 +24,14 @@ module GovKit
         # @raise [ResourceNotFound] if no strategy succeeds
         def self.run(postal_code)
           strategies.each do |strategy|
-            electoral_districts = strategy.new(postal_code).electoral_districts
-            return electoral_districts if electoral_districts
+            begin
+              electoral_districts = strategy.new(postal_code).electoral_districts
+              return electoral_districts if electoral_districts
+            rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
+              Errno::ETIMEDOUT, EOFError, Net::HTTPBadResponse,
+              Net::HTTPHeaderSyntaxError, Net::ProtocolError
+              # Do nothing. Continue.
+            end
           end
 
           raise ResourceNotFound
@@ -39,7 +45,4 @@ require 'gov_kit-ca/postal_code/strategy/base'
 require 'gov_kit-ca/postal_code/strategy/elections-ca'
 require 'gov_kit-ca/postal_code/strategy/cbc-ca'
 require 'gov_kit-ca/postal_code/strategy/ndp-ca'
-require 'gov_kit-ca/postal_code/strategy/digital_copyright-ca'
-require 'gov_kit-ca/postal_code/strategy/liberal-ca'
-#require 'gov_kit-ca/postal_code/strategy/parl-gc-ca'
-#require 'gov_kit-ca/postal_code/strategy/conservative-ca'
+require 'gov_kit-ca/postal_code/strategy/greenparty-ca'

data/lib/gov_kit-ca/postal_code.rb

@@ -5,6 +5,13 @@ module GovKit
     # A collection of postal code helpers.
     # @see http://en.wikipedia.org/wiki/Postal_codes_in_Canada Postal codes in Canada
     module PostalCode
+      # @param [String] postal_code a postal code
+      # @return [Boolean] whether the postal code is properly formatted
+      # @see http://en.wikipedia.org/wiki/Postal_codes_in_Canada#Number_of_possible_postal_codes Possible postal codes
+      def self.valid?(postal_code)
+        !!postal_code.match(/\A[ABCEGHJKLMNPRSTVXY][0-9][ABCEGHJKLMNPRSTVWXYZ][0-9][ABCEGHJKLMNPRSTVWXYZ][0-9]\Z/)
+      end
+
       # Returns the electoral districts within a postal code.
       #
       # Statistics Canada charges for its Postal Codes by Federal Ridings File
@@ -12,10 +19,15 @@ module GovKit
       #
       # @param [String] postal_code a postal code
       # @return [Array<Fixnum>] the electoral districts within the postal code
+      # @raise [InvalidRequest] if the postal code is not properly formatted
       # @raise [ResourceNotFound] if the electoral districts cannot be determined
       # @see http://www.statcan.gc.ca/bsolc/olc-cel/olc-cel?lang=eng&catno=92F0193X Statistics Canada's product page for the Postal Codes by Federal Ridings File (PCFRF)
       def self.find_electoral_districts_by_postal_code(postal_code)
-        StrategySet.run format_postal_code(postal_code)
+        if valid?(format_postal_code(postal_code))
+          StrategySet.run format_postal_code(postal_code)
+        else
+          raise InvalidRequest, "The postal code is not properly formatted"
+        end
       end
 
       # Returns the province that a postal code belongs to.

data/lib/gov_kit-ca/version.rb

@@ -1,5 +1,5 @@
 module GovKit
   module CA
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/gov_kit-ca.rb

@@ -14,5 +14,6 @@ module GovKit
 
     class GovKitError < StandardError; end
     class ResourceNotFound < GovKitError; end
+    class InvalidRequest < GovKitError; end
   end
 end

data/spec/cbc_ca_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class GovKit::CA::PostalCode::Strategy::CbcCa
+  describe GovKit::CA::PostalCode::Strategy::CbcCa do
+    describe '#electoral_districts' do
+      it 'should return the electoral districts within a postal code' do
+        { 'G0C2Y0' => [24019],
+          'T5S2B9' => [48015, 48017], # differs from elections.ca, ndp.ca
+          'K0A1K0' => [35012, 35025, 35040, 35052, 35063, 35064, 35087],
+        }.each do |postal_code,electoral_districts|
+          GovKit::CA::PostalCode::Strategy::CbcCa.new(postal_code).electoral_districts.should == electoral_districts
+        end
+      end
+
+      it 'should return false if a postal code contains no electoral districts' do
+        GovKit::CA::PostalCode::Strategy::CbcCa.new('H0H0H0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code does not exist' do
+        GovKit::CA::PostalCode::Strategy::CbcCa.new('X1B1B1').electoral_districts.should be_false
+      end
+    end
+  end
+end

data/spec/elections_ca_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class GovKit::CA::PostalCode::Strategy::ElectionsCa
+  describe GovKit::CA::PostalCode::Strategy::ElectionsCa do
+    describe '#electoral_districts' do
+      it 'should return the electoral districts within a postal code' do
+        { 'G0C2Y0' => [24019],
+          'T5S2B9' => [48015], # differs from cbc.ca
+        }.each do |postal_code,electoral_districts|
+          GovKit::CA::PostalCode::Strategy::ElectionsCa.new(postal_code).electoral_districts.should == electoral_districts
+        end
+      end
+
+      it 'should (unfortunately) return false if a postal code contains multiple electoral districts' do
+        GovKit::CA::PostalCode::Strategy::ElectionsCa.new('K0A1K0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code contains no electoral districts' do
+        GovKit::CA::PostalCode::Strategy::ElectionsCa.new('H0H0H0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code does not exist' do
+        GovKit::CA::PostalCode::Strategy::ElectionsCa.new('X1B1B1').electoral_districts.should be_false
+      end
+    end
+  end
+end

data/spec/greenparty_ca_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class GovKit::CA::PostalCode::Strategy::GreenPartyCa
+  describe GovKit::CA::PostalCode::Strategy::GreenPartyCa do
+    describe '#electoral_districts' do
+      it 'should return the electoral districts within a postal code' do
+        { 'G0C2Y0' => [24019],
+          'T5S2B9' => [48015], # differs from cbc.ca
+        }.each do |postal_code,electoral_districts|
+          GovKit::CA::PostalCode::Strategy::GreenPartyCa.new(postal_code).electoral_districts.should == electoral_districts
+        end
+      end
+
+      it 'should (unfortunately) return false if a postal code contains multiple electoral districts' do
+        GovKit::CA::PostalCode::Strategy::GreenPartyCa.new('K0A1K0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code contains no electoral districts' do
+        GovKit::CA::PostalCode::Strategy::GreenPartyCa.new('H0H0H0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code does not exist' do
+        GovKit::CA::PostalCode::Strategy::GreenPartyCa.new('X1B1B1').electoral_districts.should be_false
+      end
+    end
+  end
+end

data/spec/liberal_ca_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class GovKit::CA::PostalCode::Strategy::LiberalCa
+  describe GovKit::CA::PostalCode::Strategy::LiberalCa do
+    describe '#electoral_districts' do
+      it 'should return the electoral districts within a postal code' do
+        { 'G0C2Y0' => [24019],
+          'T5S2B9' => [48015, 48017], # differs from elections.ca, ndp.ca
+          'K0A1K0' => [35012, 35025, 35040, 35052, 35063, 35064, 35087],
+        }.each do |postal_code,electoral_districts|
+          GovKit::CA::PostalCode::Strategy::LiberalCa.new(postal_code).electoral_districts.should == electoral_districts
+        end
+      end
+
+      it 'should return false if a postal code contains no electoral districts' do
+        GovKit::CA::PostalCode::Strategy::LiberalCa.new('H0H0H0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code does not exist' do
+        GovKit::CA::PostalCode::Strategy::LiberalCa.new('X1B1B1').electoral_districts.should be_false
+      end
+    end
+  end
+end

data/spec/ndp_ca_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class GovKit::CA::PostalCode::Strategy::NDPCa
+  describe GovKit::CA::PostalCode::Strategy::NDPCa do
+    describe '#electoral_districts' do
+      it 'should return the electoral districts within a postal code' do
+        { 'G0C2Y0' => [24019],
+          'T5S2B9' => [48015], # differs from cbc.ca
+        }.each do |postal_code,electoral_districts|
+          GovKit::CA::PostalCode::Strategy::NDPCa.new(postal_code).electoral_districts.should == electoral_districts
+        end
+      end
+
+      it 'should (unfortunately) return false if a postal code contains multiple electoral districts' do
+        GovKit::CA::PostalCode::Strategy::NDPCa.new('K0A1K0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code contains no electoral districts' do
+        GovKit::CA::PostalCode::Strategy::NDPCa.new('H0H0H0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code does not exist' do
+        GovKit::CA::PostalCode::Strategy::NDPCa.new('X1B1B1').electoral_districts.should be_false
+      end
+    end
+  end
+end

data/spec/postal_code_spec.rb

@@ -1,3 +1,90 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-# TODO
+module GovKit::CA::PostalCode
+  describe GovKit::CA::PostalCode do
+    describe '#valid?' do
+      it 'should return false if the postal code is not properly formatted' do
+        [ 'A1A1A', # too short
+          'A1A1A1A', # too long
+          "A1A1A1\nA1A1A1", # multiline
+          'AAAAAA', # no digits
+          '111111', # no letters
+          '1A1A1A', # wrong order
+          'Z1Z1Z1', # Z as first letter
+          'Q1Q1Q1', # Q as letter
+          'a1a1a1', # lowercase
+        ].each do |postal_code|
+          subject.valid?(postal_code).should be_false
+        end
+      end
+
+      it 'should return true if the postal code is properly formatted' do
+        [ 'A1Z1Z1', # Z not as first letter
+          'H0H0H0', # doesn't exist
+          'A1A1A1', # does exist
+        ].each do |postal_code|
+          subject.valid?(postal_code).should be_true
+        end
+      end
+    end
+
+    describe '#find_electoral_districts_by_postal_code' do
+      it 'should return the electoral districts within a postal code' do
+        { 'A1A1A1' => [10007],
+          'K0A1K0' => [35012, 35025, 35040, 35052, 35063, 35064, 35087],
+        }.each do |postal_code,electoral_districts|
+          subject.find_electoral_districts_by_postal_code(postal_code).should == electoral_districts
+        end
+      end
+
+      it 'should raise an error if the postal code cannot be determined' do
+        lambda{subject.find_electoral_districts_by_postal_code('H0H0H0')}.should raise_error(GovKit::CA::ResourceNotFound)
+      end
+
+      it 'should raise an error if the postal code is invalid' do
+        lambda{subject.find_electoral_districts_by_postal_code('AAAAAA')}.should raise_error(GovKit::CA::InvalidRequest)
+      end
+    end
+
+    describe '#find_province_by_postal_code' do
+      it 'should return the province that a postal code belongs to' do
+        { 'A' => 'Newfoundland and Labrador',
+          'B' => 'Nova Scotia',
+          'C' => 'Prince Edward Island',
+          'E' => 'New Brunswick',
+          'G' => 'Quebec',
+          'H' => 'Quebec',
+          'J' => 'Quebec',
+          'K' => 'Ontario',
+          'L' => 'Ontario',
+          'M' => 'Ontario',
+          'N' => 'Ontario',
+          'P' => 'Ontario',
+          'R' => 'Manitoba',
+          'S' => 'Saskatchewan',
+          'T' => 'Alberta',
+          'V' => 'British Columbia',
+          'X0A' => 'Nunavut',
+          'X0B' => 'Nunavut',
+          'X0C' => 'Nunavut',
+          'X0E' => 'Northwest Territories',
+          'X0G' => 'Northwest Territories',
+          'X1A' => 'Northwest Territories',
+          'Y' => 'Yukon',
+        }.each do |postal_code, province|
+          subject.find_province_by_postal_code(postal_code).should == province
+        end
+      end
+
+      it 'should raise an error if the province cannot be determined' do
+        lambda{subject.find_province_by_postal_code('X1B1B1')}.should raise_error(GovKit::CA::ResourceNotFound)
+      end
+    end
+
+    describe '#format_postal_code' do
+      it 'should format a postal code' do
+        subject.format_postal_code("+a1a 1a1\n").should == 'A1A1A1'
+      end
+    end
+  end
+end

data/tasks/rid_to_edid.rb

@@ -5,7 +5,7 @@ require File.expand_path('../../lib/gov_kit-ca', __FILE__)
 # http://www.digital-copyright.ca/pcfrf/pcfrf.tgz contains
 # `postal-code-for-districts.csv`, "which is 308 postal codes that should
 # map to each of the 308 different electoral districts." However, six of the
-# postal codes are invalid (G0A2C0, J8M1R8, J0W1B0, J0B1H0, L0J1B0, N2A1A3),
+# postal codes do not exist (G0A2C0, J8M1R8, J0W1B0, J0B1H0, L0J1B0, N2A1A3),
 # 14 are duplicate, and the remaining 294 map to 246 electoral districts.
 desc "Picks the set cover for postal codes to cbc.ca riding IDs"
 task :trim_postal_codes do |t,args|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - James McKinney
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 -05:00
+date: 2011-04-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,11 +101,17 @@ files:
 - lib/gov_kit-ca/postal_code/strategy/conservative-ca.rb
 - lib/gov_kit-ca/postal_code/strategy/digital_copyright-ca.rb
 - lib/gov_kit-ca/postal_code/strategy/elections-ca.rb
+- lib/gov_kit-ca/postal_code/strategy/greenparty-ca.rb
 - lib/gov_kit-ca/postal_code/strategy/liberal-ca.rb
 - lib/gov_kit-ca/postal_code/strategy/ndp-ca.rb
 - lib/gov_kit-ca/postal_code/strategy/parl-gc-ca.rb
 - lib/gov_kit-ca/version.rb
 - lib/govkit-ca.rb
+- spec/cbc_ca_spec.rb
+- spec/elections_ca_spec.rb
+- spec/greenparty_ca_spec.rb
+- spec/liberal_ca_spec.rb
+- spec/ndp_ca_spec.rb
 - spec/postal_code_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -143,6 +149,11 @@ signing_key:
 specification_version: 3
 summary: Easy access to Canadian civic data around the web
 test_files: 
+- spec/cbc_ca_spec.rb
+- spec/elections_ca_spec.rb
+- spec/greenparty_ca_spec.rb
+- spec/liberal_ca_spec.rb
+- spec/ndp_ca_spec.rb
 - spec/postal_code_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb