legislation-uk 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.0.1 initial alpha release

data/Manifest

@@ -0,0 +1,5 @@
+README
+CHANGELOG
+Rakefile
+lib/legislation_uk.rb
+Manifest

data/README

@@ -0,0 +1,37 @@
+Ruby API to the restful UK legislation XML service hosted at: http://www.legislation.gov.uk/
+
+= Warning: API under development
+
+The legislation-uk API is in early development so it may change slightly over
+time. It should be in working order, so please give it a test spin!
+
+The source code is hosted at github. Feel free to fork the code if you have
+something to contribute:
+
+http://github.com/robmckinnon/legislation-uk
+
+
+== Install as a Gem
+
+Should be up at rubyforge, so to install:
+
+ sudo gem install legislation-uk
+
+== To use
+
+Can be used from command line if you run irb:
+
+ irb
+
+ require 'rubygems'
+ require 'legislation_uk'
+
+ legislation = Legislation::UK.find('Channel Tunnel Rail Link Act 1996')
+
+ legislation.parts.size  #=> 3
+
+ legislation.parts.collect(&:number)  #=> ["Part I", "Part II", "Part III"]
+
+ legislation.parts.collect(&:title)  #=> ["The Channel Tunnel Rail Link",
+                                     #    "The A2 and M2 Improvement Works",
+                                     #    "Miscellaneous and General"]

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'lib/legislation_uk'
+
+begin
+  require 'spec'
+rescue LoadError
+  puts "\nYou need to install the rspec gem to perform meta operations on this gem"
+  puts "  sudo gem install rspec\n"
+end
+
+begin
+  require 'echoe'
+
+  Echoe.new("legislation-uk", Legislation::UK::VERSION) do |m|
+    m.author = ["Rob McKinnon"]
+    m.email = ["rob ~@nospam@~ rubyforge.org"]
+    m.description = File.readlines("README").first
+    m.rubyforge_name = "legislation-uk"
+    m.rdoc_options << '--inline-source'
+    m.dependencies = ["morph >=0.2.7", "activesupport >=2.0.2"]
+    m.rdoc_pattern = ["README", "CHANGELOG"] #, "LICENSE"]
+  end
+
+rescue LoadError
+  puts "\nYou need to install the echoe gem to perform meta operations on this gem"
+  puts "  sudo gem install echoe\n\n"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/legislation_uk.rb"
+end

data/legislation-uk.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{legislation-uk}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rob McKinnon"]
+  s.date = %q{2009-09-24}
+  s.description = %q{Ruby API to the restful UK legislation XML service hosted at: http://www.legislation.gov.uk/
+}
+  s.email = ["rob ~@nospam@~ rubyforge.org"]
+  s.extra_rdoc_files = ["README", "CHANGELOG"]
+  s.files = ["README", "CHANGELOG", "Rakefile", "lib/legislation_uk.rb", "Manifest", "legislation-uk.gemspec"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Legislation-uk", "--main", "README", "--inline-source"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{legislation-uk}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby API to the restful UK legislation XML service hosted at: http://www.legislation.gov.uk/}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<morph>, [">= 0.2.7"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
+    else
+      s.add_dependency(%q<morph>, [">= 0.2.7"])
+      s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+    end
+  else
+    s.add_dependency(%q<morph>, [">= 0.2.7"])
+    s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+  end
+end

data/lib/legislation_uk.rb

@@ -0,0 +1,79 @@
+require 'activesupport'
+require 'morph'
+require 'open-uri'
+
+module LegislationUK
+
+  module Title
+    def title
+      contents_title.is_a?(String) ? contents_title.strip : contents_title.title.strip
+    end
+  end
+
+  class Legislation
+    include Morph
+    def parts
+      contents ? contents.contents_parts : []
+    end
+  end
+
+  class ContentsPart
+    include Morph
+    include Title
+    def number
+      contents_number
+    end
+    def blocks
+      contents_pblocks ? contents_pblocks : []
+    end
+  end
+
+  class ContentsPblock
+    include Morph
+    include Title
+  end
+end
+
+
+# See README for usage documentation.
+module Legislation
+  module UK
+    VERSION = "0.0.1"
+
+    def self.open_uri uri
+      open(uri).read
+    end
+
+    def self.to_object xml
+      xml.gsub!(' Type=',' TheType=')
+      xml.gsub!('dc:type','dc:the_type')
+      hash = Hash.from_xml(xml)
+      namespace = LegislationUK
+      Morph.from_hash(hash, namespace)
+    end
+
+    def self.find title, number=nil
+      number_part = number ? "&number=#{number}" : ''
+      search_url = "http://www.legislation.gov.uk/id?title=#{URI.escape(title)}#{number_part}"
+      begin
+        xml = Legislation::UK.open_uri(search_url)
+        to_object(xml)
+      rescue Exception => e
+        puts 'error retrieving: ' + search_url
+        puts e.class.name
+        puts e.to_s
+        raise e
+        nil
+      end
+    end
+
+    def self.find_uri title, number=nil
+      legislation = find(title, number)
+      if legislation
+        legislation.document_uri
+      else
+        nil
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: legislation-uk
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rob McKinnon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: morph
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: |
+  Ruby API to the restful UK legislation XML service hosted at: http://www.legislation.gov.uk/
+
+email: 
+- rob ~@nospam@~ rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+files: 
+- README
+- CHANGELOG
+- Rakefile
+- lib/legislation_uk.rb
+- Manifest
+- legislation-uk.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Legislation-uk
+- --main
+- README
+- --inline-source
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: legislation-uk
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Ruby API to the restful UK legislation XML service hosted at: http://www.legislation.gov.uk/"
+test_files: []
+