govkit-ca 0.0.6 → 0.0.7

data/spec/represent_spec.rb

@@ -0,0 +1,279 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe GovKit::CA::Represent do
+  describe '#boundary_sets' do
+    let :api do
+      GovKit::CA::Represent.new
+    end
+
+    it 'should return boundary sets' do
+      response = api.boundary_sets
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+    end
+
+    it 'should return a boundary set' do
+      response = api.boundary_sets(:boundary_set => 'federal-electoral-districts')
+      response.should be_a(Hash)
+      response.should have_key('related')
+    end
+
+    it 'should raise an error if the boundary set does not exist' do
+      expect{api.boundary_sets(:boundary_set => 'foo')}.to raise_error(GovKit::CA::ResourceNotFound, "404 http://represent.opennorth.ca/boundary-sets/foo/?")
+    end
+
+    it 'should raise an error if the limit is invalid' do
+      expect{api.boundary_sets(:limit => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/boundary-sets/?limit=-1 Invalid limit '-1' provided. Please provide a positive integer >= 0.")
+    end
+
+    it 'should raise an error if the offset is invalid' do
+      expect{api.boundary_sets(:offset => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/boundary-sets/?offset=-1 Invalid offset '-1' provided. Please provide a positive integer >= 0.")
+    end
+  end
+
+  describe '#representative_sets' do
+    let :api do
+      GovKit::CA::Represent.new
+    end
+
+    it 'should return representative sets' do
+      response = api.representative_sets
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+    end
+
+    it 'should return a representative set' do
+      response = api.representative_sets(:representative_set => 'house-of-commons')
+      response.should be_a(Hash)
+      response.should have_key('related')
+    end
+
+    it 'should raise an error if the representative set does not exist' do
+      expect{api.representative_sets(:representative_set => 'foo')}.to raise_error(GovKit::CA::ResourceNotFound, "404 http://represent.opennorth.ca/representative-sets/foo/?")
+    end
+
+    it 'should raise an error if the limit is invalid' do
+      expect{api.representative_sets(:limit => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/representative-sets/?limit=-1 Invalid limit '-1' provided. Please provide a positive integer >= 0.")
+    end
+
+    it 'should raise an error if the offset is invalid' do
+      expect{api.representative_sets(:offset => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/representative-sets/?offset=-1 Invalid offset '-1' provided. Please provide a positive integer >= 0.")
+    end
+  end
+
+  describe '#postcodes' do
+    let :api do
+      GovKit::CA::Represent.new
+    end
+
+    it 'should query by postal code' do
+      response = api.postcodes('A1A1A1')
+      response.should be_a(Hash)
+      response.should have_key('code')
+    end
+
+    it 'should accept an array of boundary sets' do
+      response = api.postcodes('A1A1A1', :sets => ['federal-electoral-districts', 'census-subdivisions'])
+      response.should be_a(Hash)
+      response['boundaries_centroid'].should have(2).items
+    end
+
+    it 'should accept a comma-separated list of boundary sets' do
+      response = api.postcodes('A1A1A1', :sets => 'federal-electoral-districts,census-subdivisions')
+      response.should be_a(Hash)
+      response['boundaries_centroid'].should have(2).items
+    end
+
+    it 'should raise an error if the postal code does not exist' do
+      expect{api.postcodes('foo')}.to raise_error(GovKit::CA::ResourceNotFound, "404 http://represent.opennorth.ca/postcodes/foo/?")
+    end
+  end
+
+  describe '#boundaries' do
+    let :api do
+      GovKit::CA::Represent.new
+    end
+
+    it 'should return boundaries' do
+      response = api.boundaries
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should_not be_nil
+    end
+
+    it 'should return boundaries from a boundary set' do
+      response = api.boundaries(:boundary_set => 'st-johns-wards')
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['objects'].should have(5).items
+    end
+
+    it 'should return a boundary from a boundary set' do
+      response = api.boundaries(:boundary_set => 'st-johns-wards', :boundary => 'ward-1')
+      response.should be_a(Hash)
+      response.should have_key('related')
+    end
+
+    it 'should return the representatives of a boundary from a boundary set' do
+      response = api.boundaries(:boundary_set => 'st-johns-wards', :boundary => 'ward-1', :representatives => true)
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should return boundaries from many boundary sets as an array' do
+      response = api.boundaries(:sets => ['st-johns-wards','caledon-wards'])
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['objects'].should have(10).items
+    end
+
+    it 'should return boundaries from many boundary sets as a comma-separated list' do
+      response = api.boundaries(:sets => 'st-johns-wards,caledon-wards')
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['objects'].should have(10).items
+    end
+
+    it 'should accept a point as an array' do
+      response = api.boundaries(:contains => ['47.5699', '-52.6954'])
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should accept a point as a comma-separated list' do
+      response = api.boundaries(:contains => '47.5699,-52.6954')
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should raise an error if the point is invalid' do
+      expect{api.boundaries(:contains => '0,0,0')}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/boundaries/?contains=0,0,0 Invalid lat/lon values")
+    end
+
+    it 'should raise an error if the boundary set does not exist' do
+      expect{api.boundaries(:boundary_set => 'foo')}.to raise_error(GovKit::CA::ResourceNotFound, "404 http://represent.opennorth.ca/boundaries/foo/?")
+    end
+
+    context 'when retrieving a boundary' do
+      it 'should raise an error if the boundary set does not exist' do
+        expect{api.boundaries(:boundary_set => 'foo', :boundary => 'ward-1')}.to raise_error(GovKit::CA::ResourceNotFound, "404 http://represent.opennorth.ca/boundaries/foo/ward-1/?")
+      end
+
+      it 'should raise an error if the boundary does not exist' do
+        expect{api.boundaries(:boundary_set => 'st-johns-wards', :boundary => 'foo')}.to raise_error(GovKit::CA::ResourceNotFound, "404 http://represent.opennorth.ca/boundaries/st-johns-wards/foo/?")
+      end
+
+      it 'should raise an error if the boundary set is not given' do
+        expect{api.boundaries(:boundary => 'ward-1')}.to raise_error(ArgumentError, ':boundary_set must be set if :boundary is set')
+      end
+    end
+
+    context 'when retrieving the representatives of a boundary' do
+      it 'should not raise an error if the boundary set does not exist' do
+        expect{api.boundaries(:boundary_set => 'foo', :boundary => 'ward-1', :representatives => true)}.to_not raise_error
+      end
+
+      it 'should not raise an error if the boundary does not exist' do
+        expect{api.boundaries(:boundary_set => 'st-johns-wards', :boundary => 'foo', :representatives => true)}.to_not raise_error
+      end
+
+      it 'should raise an error if the boundary set is not given' do
+        expect{api.boundaries(:representatives => true)}.to raise_error(ArgumentError, ':boundary_set and :boundary must be set if :representatives is true')
+      end
+
+      it 'should raise an error if the boundary is not given' do
+        expect{api.boundaries(:boundary_set => 'st-johns-wards', :representatives => true)}.to raise_error(ArgumentError, ':boundary_set and :boundary must be set if :representatives is true')
+      end
+    end
+
+    it 'should raise an error if the limit is invalid' do
+      expect{api.boundaries(:limit => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/boundaries/?limit=-1 Invalid limit '-1' provided. Please provide a positive integer >= 0.")
+    end
+
+    it 'should raise an error if the offset is invalid' do
+      expect{api.boundaries(:offset => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/boundaries/?offset=-1 Invalid offset '-1' provided. Please provide a positive integer >= 0.")
+    end
+  end
+
+  describe '#representatives' do
+    let :api do
+      GovKit::CA::Represent.new
+    end
+
+    it 'should return representatives' do
+      response = api.representatives
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should_not be_nil
+    end
+
+    it 'should return representatives from a representative set' do
+      response = api.representatives(:representative_set => 'st-johns-city-council')
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should accept a point as an array' do
+      response = api.representatives(:point => ['47.5699', '-52.6954'])
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should accept a point as a comma-separated list' do
+      response = api.representatives(:point => '47.5699,-52.6954')
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should accept an array of districts' do
+      response = api.representatives(:districts => ['federal-electoral-districts/10007', 'census-subdivisions/1001519'])
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should accept a comma-separated list of districts' do
+      response = api.representatives(:districts => 'federal-electoral-districts/10007,census-subdivisions/1001519')
+      response.should be_a(Hash)
+      response.should have_key('objects')
+      response.should have_key('meta')
+      response['meta']['next'].should be_nil
+    end
+
+    it 'should raise an error if the point is invalid' do
+      expect{api.representatives(:point => '0,0,0')}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/representatives/?point=0,0,0 Invalid lat/lon values")
+    end
+
+    it 'should not raise an error if the representative set does not exist' do
+      expect{api.representatives(:representative_set => 'foo')}.to_not raise_error
+    end
+
+    it 'should raise an error if the limit is invalid' do
+      expect{api.representatives(:limit => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/representatives/?limit=-1 Invalid limit '-1' provided. Please provide a positive integer >= 0.")
+    end
+
+    it 'should raise an error if the offset is invalid' do
+      expect{api.representatives(:offset => -1)}.to raise_error(GovKit::CA::InvalidRequest, "400 http://represent.opennorth.ca/representatives/?offset=-1 Invalid offset '-1' provided. Please provide a positive integer >= 0.")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,11 +4,8 @@ require 'coveralls'
 Coveralls.wear!
 
 require 'rspec'
-require 'fakeweb'
 require File.dirname(__FILE__) + '/../lib/gov_kit-ca'
 
-FakeWeb.allow_net_connect = true
-
 module Helpers
   def fixture_path(*args)
     File.join(File.dirname(__FILE__), 'fixtures', *args)
@@ -17,5 +14,5 @@ end
 
 RSpec.configure do |config|
   config.include Helpers
-  config.filter_run_excluding broken: true
+  config.filter_run_excluding :broken => true
 end

data/spec/strategy_set_spec.rb

@@ -1,5 +1,58 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-module GovKit::CA::PostalCode::StrategySet
-  # @todo
+describe GovKit::CA::PostalCode::StrategySet do
+  let :strategy do
+    Class.new
+  end
+
+  describe '#strategies' do
+    it 'should return the strategies' do
+      GovKit::CA::PostalCode::StrategySet.strategies[0..4].should == [
+        GovKit::CA::PostalCode::Strategy::ElectionsCa,
+        GovKit::CA::PostalCode::Strategy::NDPCa,
+        # GovKit::CA::PostalCode::Strategy::LiberalCa,
+        GovKit::CA::PostalCode::Strategy::GreenPartyCa,
+        GovKit::CA::PostalCode::Strategy::CBCCa,
+        GovKit::CA::PostalCode::Strategy::ConservativeCa,
+      ]
+    end
+  end
+
+  describe '#register' do
+    it 'should append a strategy' do
+      GovKit::CA::PostalCode::StrategySet.register(strategy)
+      GovKit::CA::PostalCode::StrategySet.strategies.last.should == strategy
+    end
+  end
+
+  describe '#run' do
+    it 'should run the strategies' do
+      GovKit::CA::PostalCode::StrategySet.run('A1A1A1').should == [10007]
+    end
+  end
+
+  context 'with empty strategy set' do
+    before :each do
+      GovKit::CA::PostalCode::StrategySet.strategies.clear
+    end
+
+    describe '#strategies' do
+      it 'should return the strategies' do
+        GovKit::CA::PostalCode::StrategySet.strategies.should == []
+      end
+    end
+
+    describe '#register' do
+      it 'should add a strategy' do
+        GovKit::CA::PostalCode::StrategySet.register(strategy)
+        GovKit::CA::PostalCode::StrategySet.strategies.should == [strategy]
+      end
+    end
+
+    describe '#run' do
+      it 'should raise an error' do
+        expect{GovKit::CA::PostalCode::StrategySet.run('A1A1A1')}.to raise_error(GovKit::CA::ResourceNotFound)
+      end
+    end
+  end
 end

data/tasks/tasks.rb

@@ -42,31 +42,3 @@ task :trim_postal_codes, :file do |t,args|
 
   puts postal_codes.sort
 end
-
-desc "Generate RSpec fixtures"
-task :generate_rspec_fixtures do |t,args|
-  require 'fileutils'
-
-  { 'CBCCa'              => 'cbc_ca',
-    'ConservativeCa'     => 'conservative_ca',
-    'DigitalCopyrightCa' => 'digital-copyright_ca',
-    'ElectionsCa'        => 'elections_ca',
-    'GreenPartyCa'       => 'greenparty_ca',
-    'LiberalCa'          => 'liberal_ca',
-    'NDPCa'              => 'ndp_ca',
-  }.each do |const,path|
-    require "gov_kit-ca/postal_code/strategy/#{path}"
-    FileUtils.mkdir_p File.expand_path("../../spec/fixtures/#{path}", __FILE__)
-
-    %w(A1A1A1 G0C2Y0 T5S2B9 K0A1K0 H0H0H0 X1B1B1).each do |postal_code|
-      File.open(File.expand_path("../../spec/fixtures/#{path}/#{postal_code}.response", __FILE__), 'w') do |f|
-        response = GovKit::CA::PostalCode::Strategy.const_get(const).new(postal_code).send(:response)
-        f.write "HTTP/#{response.http_version} #{response.code} #{response.message}\n"
-        response.headers.each_capitalized do |name,value|
-          f.write "#{name}: #{value}\n"
-        end
-        f.write "\n#{response.body}"
-      end
-    end
-  end
-end