govkit-ca 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 James McKinney
+Copyright (c) 2011 Open North Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -43,6 +43,6 @@ GovKit-CA will raise GovKit::CA::ResourceNotFound if the electoral districts wit
 
 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.
 
-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.
+Govkit-CA's main repository is on GitHub: [http://github.com/opennorth/govkit-ca](http://github.com/opennorth/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
+Copyright (c) 2011 Open North Inc., released under the MIT license

data/Rakefile

@@ -15,4 +15,4 @@ rescue LoadError
   end
 end
 
-require File.expand_path('../tasks/rid_to_edid', __FILE__)
+require File.expand_path('../tasks/tasks', __FILE__)

data/govkit-ca.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.name        = "govkit-ca"
   s.version     = GovKit::CA::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["James McKinney"]
-  s.email       = ["james@slashpoundbang.com"]
-  s.homepage    = "http://github.com/jpmckinney/govkit-ca"
+  s.authors     = ["Open North"]
+  s.email       = ["info@opennorth.ca"]
+  s.homepage    = "http://github.com/opennorth/govkit-ca"
   s.summary     = %q{Easy access to Canadian civic data around the web}
   s.description = %q{GovKit-CA lets you quickly get encapsulated Ruby objects for Canadian civic data.}
 
@@ -19,9 +19,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  #s.add_runtime_dependency('graticule', '>= 0.2.8')
-  s.add_runtime_dependency('httparty', '>= 0.6.1')
-  s.add_runtime_dependency('nokogiri', '>= 1.4.4')
-  s.add_runtime_dependency('yajl-ruby', '>= 0.7.8')
-  s.add_development_dependency('rspec', '>= 2')
+  s.add_runtime_dependency('httparty', '~> 0.7.8')
+  s.add_runtime_dependency('nokogiri', '~> 1.5.0')
+  s.add_runtime_dependency('yajl-ruby', '~> 0.8.2')
+  s.add_development_dependency('rspec', '~> 2.6.0')
+  s.add_development_dependency('fakeweb', '~> 1.3.0')
 end

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

@@ -5,9 +5,14 @@ module GovKit
         # Abstract class for implementing postal code to electoral district
         # strategies.
         #
-        # The following methods must be implemented in sub-classes:
+        # The following instance methods must be implemented in sub-classes:
         #
         # * `electoral_districts!`
+        #
+        # The following class methods must be called in sub-classes:
+        #
+        # * `http_method`
+        # * `path`
         class Base
           include HTTParty
           follow_redirects false
@@ -38,6 +43,33 @@ module GovKit
           def valid?
             true
           end
+
+          # Performs the request and returns the response.
+          # @return [HTTParty::Response] a HTTParty response object
+          def response
+            @response ||= self.class.send self.class.http_method, path
+          end
+
+          # Allows setting an HTTP method to be used for each request.
+          # @param [Symbol] http_method an HTTP method
+          # @return [Symbol] the HTTP method to use to send the request
+          def self.http_method(http_method = nil)
+            return default_options[:http_method] unless http_method
+            default_options[:http_method] = http_method
+          end
+
+          # Allows setting an absolute path to be used in each request.
+          # @param [String] path an ERB template for the absolute path
+          # @return [String] the absolute path to request
+          def self.path(path = nil)
+            return default_options[:path] unless path
+            default_options[:path] = path
+          end
+
+          # @return [String] the absolute path to be used in the request
+          def path
+            ERB.new(self.class.path).result binding
+          end
         end
       end
     end

data/lib/gov_kit-ca/postal_code/strategy/{cbc-ca.rb → cbc_ca.rb}

@@ -5,32 +5,25 @@ module GovKit
         # cbc.ca ought to be a reliable source. It is unknown if its database
         # is kept up-to-date between elections, however.
         # @see https://github.com/danielharan/pc_scraper
-        class CbcCa < Base
+        class CBCCa < Base
           base_uri 'www.cbc.ca'
+          http_method :get
+          path '/news/canadavotes/myriding/postalcodes/<%= @letter %>/<%= @fsa %>/<%= @ldu %>.html'
 
           def initialize(postal_code)
-            @fsa, @letter, @ldu = postal_code.downcase.match(/\A((.).{2})(.{3})\Z/)[1..3]
+            @fsa, @letter, @ldu = postal_code.downcase.match(/\A((.).{2})(.{3})\z/)[1..3]
             super
           end
 
-          def json_response # Yajl barfs on bad encoding
-            Yajl::Parser.parse(response.parsed_response) rescue JSON.parse(response.parsed_response)
-          end
-
         private
-
           def electoral_districts!
-            json_response.map{|x| self.class.rid_to_edid[x['rid']]}
+            Yajl::Parser.parse(Iconv.new('UTF-8', 'ISO-8859-1').iconv(response.parsed_response)).map{|x| self.class.rid_to_edid[x['rid']]}
           end
 
           def valid?
             !!response.headers['expires']
           end
 
-          def response
-            @response ||= self.class.get "/news/canadavotes/myriding/postalcodes/#{@letter}/#{@fsa}/#{@ldu}.html"
-          end
-
           # cbc.ca uses an internal riding ID, which must be matched to a
           # canonical electoral district ID.
           # @return [Hash] a map of cbc.ca riding ID to electoral district ID
@@ -39,7 +32,7 @@ module GovKit
           end
         end
 
-        StrategySet.register CbcCa
+        StrategySet.register CBCCa
       end
     end
   end

data/lib/gov_kit-ca/postal_code/strategy/{conservative-ca.rb → conservative_ca.rb}

@@ -6,6 +6,8 @@ module GovKit
         # it does not return three ridings like other sources.
         class ConservativeCa < Base
           base_uri 'www.conservative.ca'
+          http_method :get
+          path '/?section_id=1051&postal_code=<%= @postal_code %>'
 
         private
 
@@ -16,10 +18,6 @@ module GovKit
           def valid?
             # TODO
           end
-
-          def response
-            @response ||= self.class.get "/?section_id=1051&postal_code=#{@postal_code}"
-          end
         end
 
         StrategySet.register ConservativeCa

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

@@ -0,0 +1,27 @@
+module GovKit
+  module CA
+    module PostalCode
+      module Strategy
+        # digital-copyright.ca often returns more or fewer electoral districts
+        # than others. Occasionally suffers from timeout errors.
+        class DigitalCopyrightCa < Base
+          base_uri 'www.digital-copyright.ca'
+          http_method :get
+          path '/edid/postal?postalcode=<%= @postal_code %>'
+
+        private
+
+          def electoral_districts!
+            Nokogiri::HTML(response.parsed_response, nil, 'utf-8').css('.node .content a').map{|a| a[:href][/\d+\z/]}
+          end
+
+          def valid?
+            !response.parsed_response.match /\b(invalid postal code|not found)\b/
+          end
+        end
+
+        StrategySet.register DigitalCopyrightCa
+      end
+    end
+  end
+end

data/lib/gov_kit-ca/postal_code/strategy/{elections-ca.rb → elections_ca.rb}

@@ -7,6 +7,8 @@ module GovKit
         # @see https://github.com/danielharan/postal_code_to_edid_webservice
         class ElectionsCa < Base
           base_uri 'elections.ca'
+          http_method :head
+          path '/scripts/pss/FindED.aspx?PC=<%= @postal_code %>'
 
         private
 
@@ -17,10 +19,6 @@ module GovKit
           def valid?
             !!response.headers['location']
           end
-
-          def response
-            @response ||= self.class.head "/scripts/pss/FindED.aspx?PC=#{@postal_code}"
-          end
         end
 
         StrategySet.register ElectionsCa

data/lib/gov_kit-ca/postal_code/strategy/{greenparty-ca.rb → greenparty_ca.rb}

@@ -6,20 +6,18 @@ module GovKit
         # that contain multiple electoral districts.
         class GreenPartyCa < Base
           base_uri 'greenparty.ca'
+          http_method :head
+          path '/search/civicrm_lookup/<%= @postal_code %>'
 
         private
 
           def electoral_districts!
-            [ response.headers['location'][/\d+\Z/] ]
+            [ 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

data/lib/gov_kit-ca/postal_code/strategy/{liberal-ca.rb → liberal_ca.rb}

@@ -5,20 +5,18 @@ module GovKit
         # liberal.ca is unreliable during elections.
         class LiberalCa < Base
           base_uri 'www.liberal.ca'
+          http_method :get
+          path '/riding/postal/<%= @postal_code %>/'
 
         private
 
           def electoral_districts!
-            Nokogiri::HTML(response.parsed_response).css('img.RidingListImage').map{|img| img[:src][/\d{5}/]}
+            Nokogiri::HTML(response.parsed_response, nil, 'utf-8').css('img.RidingListImage').map{|img| img[:src][/\d{5}/]}
           end
 
           def valid?
             !response.parsed_response.match /\bOopsies!/
           end
-
-          def response
-            @response ||= self.class.get "/riding/postal/#{@postal_code}/"
-          end
         end
 
         StrategySet.register LiberalCa

data/lib/gov_kit-ca/postal_code/strategy/{ndp-ca.rb → ndp_ca.rb}

@@ -6,20 +6,18 @@ module GovKit
         # contain multiple electoral districts.
         class NDPCa < Base
           base_uri 'www.ndp.ca'
+          http_method :head
+          path '/riding/<%= @postal_code %>'
 
         private
 
           def electoral_districts!
-            [ response.headers['location'][/\d+\Z/] ]
+            [ response.headers['location'][/\d+\z/] ]
           end
 
           def valid?
             response.headers['location'] != 'http://www.ndp.ca/'
           end
-
-          def response
-            @response ||= self.class.head "/riding/#{@postal_code}"
-          end
         end
 
         StrategySet.register NDPCa

data/lib/gov_kit-ca/postal_code/strategy/{parl-gc-ca.rb → parl_gc_ca.rb}

@@ -5,7 +5,9 @@ module GovKit
         # parl.gc.ca seems unreliable. In the case of K0A1K0, for example, it
         # does not return seven ridings like other sources.
         class ParlGcCa < Base
-          base_uri 'www2.parl.gc.ca'
+          base_uri 'www.parl.gc.ca'
+          http_method :get
+          path '/ParlInfo/Compilations/HouseOfCommons/MemberByPostalCode.aspx?PostalCode=<%= @postal_code %>'
 
         private
 
@@ -16,10 +18,6 @@ module GovKit
           def valid?
             # TODO
           end
-
-          def response
-            @response ||= self.class.get "/parlinfo/Compilations/HouseOfCommons/MemberByPostalCode.aspx?PostalCode=#{@postal_code}"
-          end
         end
 
         StrategySet.register ParlGcCa

data/lib/gov_kit-ca/postal_code/{strategy.rb → strategy_set.rb}

@@ -2,7 +2,7 @@ module GovKit
   module CA
     module PostalCode
       # The set of postal code to electoral district strategies.
-      class StrategySet
+      module StrategySet
         # Stores the strategy set.
         # @return [Array<Strategy::Base>] the strategy set
         def self.strategies
@@ -40,9 +40,3 @@ module GovKit
     end
   end
 end
-
-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/greenparty-ca'

data/lib/gov_kit-ca/postal_code.rb

@@ -1,15 +1,15 @@
-require 'gov_kit-ca/postal_code/strategy'
-
 module GovKit
   module CA
     # A collection of postal code helpers.
     # @see http://en.wikipedia.org/wiki/Postal_codes_in_Canada Postal codes in Canada
     module PostalCode
+      autoload :StrategySet, 'gov_kit-ca/postal_code/strategy_set'
+
       # @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/)
+        !!postal_code.match(/\A[ABCEGHJKLMNPRSTVXY][0-9][ABCEGHJKLMNPRSTVWXYZ][0-9][ABCEGHJKLMNPRSTVWXYZ][0-9]\z/)
       end
 
       # Returns the electoral districts within a postal code.
@@ -78,3 +78,9 @@ module GovKit
     end
   end
 end
+
+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/greenparty_ca'

data/lib/gov_kit-ca/version.rb

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

data/lib/gov_kit-ca.rb

@@ -1,9 +1,10 @@
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'erb'
+require 'iconv'
 require 'json'
 require 'yaml'
 
-#require 'graticule'
 require 'httparty'
 require 'nokogiri'
 require 'yajl'

data/spec/cbc_ca_spec.rb

@@ -1,23 +1,30 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-class GovKit::CA::PostalCode::Strategy::CbcCa
-  describe GovKit::CA::PostalCode::Strategy::CbcCa do
+class GovKit::CA::PostalCode::Strategy::CBCCa
+  describe GovKit::CA::PostalCode::Strategy::CBCCa do
     describe '#electoral_districts' do
+      before :all do
+        %w(G0C2Y0 T5S2B9 K0A1K0 H0H0H0 X1B1B1).each do |postal_code|
+          strategy = GovKit::CA::PostalCode::Strategy::CBCCa.new(postal_code)
+          FakeWeb.register_uri strategy.class.http_method, "#{strategy.class.base_uri}#{strategy.send(:path)}", :response => fixture_path('cbc_ca', "#{postal_code}.response")
+        end
+      end
+
       it 'should return the electoral districts within a postal code' do
         { 'G0C2Y0' => [24019],
-          'T5S2B9' => [48015, 48017], # differs from elections.ca, ndp.ca
+          'T5S2B9' => [48015, 48017], # differs from elections.ca, ndp.ca, greenparty.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
+          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
+        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
+        GovKit::CA::PostalCode::Strategy::CBCCa.new('X1B1B1').electoral_districts.should be_false
       end
     end
   end

data/spec/digital-copyright_ca_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'gov_kit-ca/postal_code/strategy/digital-copyright_ca'
+
+class GovKit::CA::PostalCode::Strategy::DigitalCopyrightCa
+  describe GovKit::CA::PostalCode::Strategy::DigitalCopyrightCa do
+    describe '#electoral_districts' do
+      before :all do
+        %w(G0C2Y0 T5S2B9 K0A1K0 H0H0H0 X1B1B1).each do |postal_code|
+          strategy = GovKit::CA::PostalCode::Strategy::DigitalCopyrightCa.new(postal_code)
+          FakeWeb.register_uri strategy.class.http_method, "#{strategy.class.base_uri}#{strategy.send(:path)}", :response => fixture_path('digital-copyright_ca', "#{postal_code}.response")
+        end
+      end
+
+      it 'should return the electoral districts within a postal code' do
+        { 'G0C2Y0' => [24019, 24039], # differs from all
+          'T5S2B9' => [48012, 48013, 48014, 48015, 48017, 48018], # differs from all
+          'K0A1K0' => [35025, 35052, 35063], # differs from all
+        }.each do |postal_code,electoral_districts|
+          GovKit::CA::PostalCode::Strategy::DigitalCopyrightCa.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::DigitalCopyrightCa.new('H0H0H0').electoral_districts.should be_false
+      end
+
+      it 'should return false if a postal code does not exist' do
+        GovKit::CA::PostalCode::Strategy::DigitalCopyrightCa.new('X1B1B1').electoral_districts.should be_false
+      end
+    end
+  end
+end

data/spec/elections_ca_spec.rb

@@ -3,6 +3,13 @@ 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
+      before :all do
+        %w(G0C2Y0 T5S2B9 K0A1K0 H0H0H0 X1B1B1).each do |postal_code|
+          strategy = GovKit::CA::PostalCode::Strategy::ElectionsCa.new(postal_code)
+          FakeWeb.register_uri strategy.class.http_method, "#{strategy.class.base_uri}#{strategy.send(:path)}", :response => fixture_path('elections_ca', "#{postal_code}.response")
+        end
+      end
+
       it 'should return the electoral districts within a postal code' do
         { 'G0C2Y0' => [24019],
           'T5S2B9' => [48015], # differs from cbc.ca

data/spec/fixtures/cbc_ca/A1A1A1.response

@@ -0,0 +1,11 @@
+HTTP/1.1 200 OK
+Server: Apache/2.2.3 (Red Hat)
+Content-Length: 52
+Content-Type: text/html
+X-Origin-Server: web15:sb10
+Cache-Control: max-age=10
+Expires: Sun, 05 Jun 2011 03:16:49 GMT
+Date: Sun, 05 Jun 2011 03:16:39 GMT
+Connection: close
+
+[{"rid":7,"name":"St. John's South - Mount Pearl"}]

data/spec/fixtures/cbc_ca/G0C2Y0.response

@@ -0,0 +1,11 @@
+HTTP/1.1 200 OK
+Server: Apache/2.2.3 (Red Hat)
+Content-Length: 54
+Content-Type: text/html
+X-Origin-Server: web20:sb10
+Cache-Control: max-age=10
+Expires: Sun, 05 Jun 2011 03:16:49 GMT
+Date: Sun, 05 Jun 2011 03:16:39 GMT
+Connection: close
+
+[{"rid":52,"name":"Gasp�sie - �les-de-la-Madeleine"}]