twfy 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,10 @@
+== 1.0.1 / 2008-08-02
+
+* In the near future the TWFY API will require an API Key for all calls. In preparation for this, this binding now requires an API Key. They are available at http://www.theyworkforyou.com/api/key
+* Added support for new features of TWFY API (still version 1.0.0).
+  * getMLAs - Members of the Legislative Assembly (Members of the Northern Irish Assembly to you and me)
+  * getMSPs - Members of the Scottish Parliament
+
 == 1.0.0 / 2006-11-08
 
 * Initial release supporting all services from TWFY API 1.0.0
@@ -7,4 +14,4 @@
 * Coming up:
   * Easy pagination of debates, comments, etc
   * Data mining MPInfo information (ie expenses, accessible directly from MP instance)
-  * Other stuff :-)
+  * Other stuff :-)

data/Manifest.txt

@@ -6,3 +6,4 @@ lib/data_element.rb
 lib/twfy.rb
 test/test_twfy.rb
 test/test_twfy_chain.rb
+test/api_key

data/README.txt

@@ -1,6 +1,6 @@
 twfy
     by Bruce Williams (http://codefluency.com)
-    and Martin Owens
+    and Martin Owen (http://martinowen.net)
 
 == DESCRIPTION:
   
@@ -34,7 +34,10 @@ Use is very easy.
 === Get a Client
 
   require 'twfy'
-  client = Twfy::Client.new
+  client = Twfy::Client.new(<YOUR API KEY HERE>)
+
+Note that the Twfy::Client constructor in version 1.0.1 of the binding requires an API Key
+string. If you don't have one they are available at http://www.theyworkforyou.com/api/key
 
 === Call API methods directly on client
 

data/Rakefile

@@ -16,7 +16,7 @@ EOD
     p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
     p.extra_deps = ['json', 'paginator']
     p.email = %q{bruce@codefluency.com}
-    p.author = ["Bruce Williams", "Martin Owens"]
+    p.author = ["Bruce Williams", "Martin Owen"]
 end
 
 # vim: syntax=Ruby

data/lib/twfy.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'open-uri'
 require 'json'
 require 'cgi'
@@ -8,7 +9,7 @@ require File.join(File.dirname(__FILE__), 'data_element')
 
 module Twfy
   
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   BASE = URI.parse('http://www.theyworkforyou.com/api/')
   
   API_VERSION = '1.0.0'
@@ -19,7 +20,8 @@ module Twfy
     class ServiceArgumentError < ::ArgumentError; end
     class APIError < ::StandardError; end
             
-    def initialize(log_to=$stderr)
+    def initialize(api_key, log_to=$stderr)
+      @api_key = api_key
       @logger = Logger.new(log_to)
     end
     
@@ -61,6 +63,14 @@ module Twfy
       service :getLords, validate(params, :allow => [:date, :search])
     end
 
+    def mlas(params={})
+      service :getMLAs, validate(params, :allow => [:date, :party, :search])
+    end
+
+    def msps(params={})
+      service :getMSPs, validate(params, :allow => [:date, :party, :search])
+    end
+
     def geometry(params={})
       service :getGeometry, validate(params, :allow => :name), Geometry
     end
@@ -164,10 +174,10 @@ module Twfy
     end
     
     def build_query(params)
-      params.update(:version=>API_VERSION)
+      params.update(:key=>@api_key, :version=>API_VERSION)
       params.map{|set| set.map{|i| CGI.escape(i.to_s)}.join('=') }.join('&')
     end
         
   end
   
-end
+end

data/test/api_key

@@ -0,0 +1 @@
+B47i8vFYfgWvAa89eYErLWPF

data/test/test_twfy.rb

@@ -2,9 +2,12 @@ require 'test/unit'
 require File.join(File.dirname(__FILE__), '../lib/twfy')
 
 class BasicReturnedDataTest < Test::Unit::TestCase
-  
+
+  API_KEY_LOCATION  = File.join(File.dirname(__FILE__), 'api_key')
+
   def setup
-    @client = Twfy::Client.new
+    api_key = File.open(API_KEY_LOCATION){ |f| f.readlines[0].chomp }
+    @client = Twfy::Client.new(api_key)
   end
   
   def test_convert_url
@@ -26,6 +29,14 @@ class BasicReturnedDataTest < Test::Unit::TestCase
       assert_kind_of Twfy::MP, mp
     end
   end
+
+  def test_msps
+    msps = @client.msps
+    assert_kind_of Array, msps
+    msps.each do |msp|
+      assert_kind_of OpenStruct, msp
+    end
+  end
   
   def test_constituency_and_geometry
     c = @client.constituency(:postcode => 'IP6 9PN')
@@ -41,4 +52,4 @@ class BasicReturnedDataTest < Test::Unit::TestCase
     end
   end
   
-end
+end

data/test/test_twfy_chain.rb

@@ -2,9 +2,12 @@ require 'test/unit'
 require File.join(File.dirname(__FILE__), '../lib/twfy')
 
 class ChainDataTest < Test::Unit::TestCase
-  
+
+  API_KEY_LOCATION = File.join(File.dirname(__FILE__), 'api_key')
+
   def setup
-    @client = Twfy::Client.new
+    api_key = File.open(API_KEY_LOCATION){ |f| f.readlines[0].chomp }
+    @client = Twfy::Client.new(api_key)
     @mp = @client.mp(:postcode=>'IP6 9PN')
   end
   
@@ -46,4 +49,4 @@ class ChainDataTest < Test::Unit::TestCase
   end
   
 end
-  
+  

metadata

@@ -1,71 +1,95 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
-specification_version: 1
 name: twfy
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2006-11-20 00:00:00 -07:00
-summary: Ruby library to interface with the TheyWorkForYou(.com) API; an information source on Parliament
-require_paths: 
-- lib
-- test
-email: bruce@codefluency.com
-homepage: http://twfy.rubyforge.org
-rubyforge_project: twfy
-description: Ruby library to interface with the TheyWorkForYou API. TheyWorkForYou.com is  "a non-partisan, volunteer-run website which aims to make it easy for people to keep tabs on their elected and unelected representatives in Parliament."
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 1.0.1
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
 - Bruce Williams
-- Martin Owens
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- lib/data_element.rb
-- lib/twfy.rb
-- test/test_twfy.rb
-- test/test_twfy_chain.rb
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+- Martin Owen
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2008-08-03 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: paginator
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: 1.7.0
     version: 
+description: Ruby library to interface with the TheyWorkForYou API. TheyWorkForYou.com is  "a non-partisan, volunteer-run website which aims to make it easy for people to keep tabs on their elected and unelected representatives in Parliament."
+email: bruce@codefluency.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/data_element.rb
+- lib/twfy.rb
+- test/test_twfy.rb
+- test/test_twfy_chain.rb
+- test/api_key
+has_rdoc: true
+homepage: http://twfy.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: twfy
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby library to interface with the TheyWorkForYou(.com) API; an information source on Parliament
+test_files: 
+- test/test_twfy.rb
+- test/test_twfy_chain.rb