barton 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,29 +1,35 @@
 PATH
   remote: .
   specs:
-    barton (0.0.2)
+    barton (0.0.3)
       json
+      newrelic_rpm
+      rack-test
       sinatra (~> 1.3.2)
       tire (~> 0.4.2)
+      trollop
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.6)
-      activesupport (= 3.2.6)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activesupport (3.2.6)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     builder (3.0.0)
     hashr (0.0.21)
     i18n (0.6.0)
-    json (1.7.3)
+    json (1.7.4)
     mime-types (1.19)
     multi_json (1.3.6)
+    newrelic_rpm (3.4.1)
     rack (1.4.1)
     rack-protection (1.2.0)
       rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
     rake (0.9.2.2)
     rest-client (1.6.7)
       mime-types (>= 1.16)
@@ -38,6 +44,7 @@ GEM
       multi_json (~> 1.0)
       rake
       rest-client (~> 1.6)
+    trollop (1.16.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,6 @@
 # Barton
 
-Barton is programmable, political access.  It's an API for Australian electorate and politician contact details.
+Barton is programmable, political access.  It's an API for Australian electorates and politician contact details.
 
 ## Access
 
@@ -8,12 +8,26 @@ Access the API via HTTP:
 
 	curl http://barton.experimentsindemocracy.org/api
 
+Barton is read only so you'll only ever need to GET
 
-Or download and install it yourself:
+## Download
 
-    $ gem install barton
-	$ barton --setup
-	$ barton
+If you'd like to download and install it yourself you can do this as either a gem:
+
+	$ gem install barton
+
+Or git if that tickles your fancy
+
+	git@github.com:experimentsindemocracy/barton.git
+
+But first you'll need to install [Elasticsearch][es]
+
+	$ brew install elasticsearch
+
+Then setup the data and run locally
+
+	$ barton --setup environment_name
+	$ barton --run environment_name
 
 ## Requests
 
@@ -31,15 +45,15 @@ To return a single electorate
 
 	/electorates/id
 
-To return multiple electorates
+To return multiple politicians
 
-	/electorates?params=values
+	/members?params=values
 
 Address returns all electorates bounding the supplied address.  Where ever possible, do the geocoding yourself to avoid Google's 2500 per day rate limit.
 
 	/electorates?address=676+Ann+St,+Fortitude+Valley+Qld+4006 
 
-Geo returns all electorates bounding the supplied 'long,lat' string. Using geo instead of address will result in better results.
+Geo returns all electorates bounding the supplied 'long,lat' string. Using geo instead of address will result in faster response times.
 
 	/electorates?geo=145.77602080,-16.92192860
 
@@ -47,9 +61,11 @@ Tags returns all electorates matching the comma separated tags. To find all loca
 
 	/electorates?tags=sydney,local
 
-Or get more cunning with key:value and splat tags for all Mayors in Queensland whose name that start with the letter 'G'
+Reach down into resources to filter by their children.  To find
+
+Or get more cunning with key:value and splats for all Mayors in Queensland whose name that start with the letter 'G'
 
-	/electorates?tags=name:g*,queensland,mayor
+	/members?tags=name:g*,queensland,mayor
 
 Go totally freaky by mixing tags and geo.  Try all politicians responsible for transport in Cairns
 
@@ -61,65 +77,82 @@ Finally, add your email so I can keep a handle on usage and loads
 
 ## Responses
 
-Barton will try to play HATEOAS as nicely as possible so you should be able to explore from the base api url to all resources.  Responses are will be in JSON format and limited to 100 results.
+Barton will try to play HATEOAS as nicely as possible so you should be able to explore from the base api url to all resources.  
 
-	/electorates?tags=name:sydney,local
+Responses are JSON format and limited to 100 results.  Barton will return a status 200 whenever things are dandy or a 404 if no matching resources are found.
+
+	http://barton.experimentsindemocracy.org/api/members?tags=name:newman
 	
 	{
 	  "name": "Barton API",
-	  "result_count": 3,
+	  "disclaimer": "This data is crowded sourced and provided free of charge for informational purposes only. No guarantees regarding data quality are made whatsoever apart from it's rather considerable coolness.",
+	  "license": "MIT License http://www.opensource.org/licenses/mit-license.php",
+	  "result_count": 2,
 	  "results": [
 	    {
-	      "name": "Sydney",
+	      "name": "Campbell Newman",
+	      "role": "Premier",
+	      "party": "LNP",
+	      "address": "Level 15, Executive Building, 100 George Street, Brisbane Qld 4000",
+	      "email": "thepremier@premiers.qld.gov.au",
+	      "phone": "07 3224 4500",
+	      "fax": "07 3221 1809",
+	      "id": "0db2ec",
+	      "type": "member",
 	      "tags": [
-	        "New South Wales",
-	        "Local",
-	        "Ward",
-	        "Eastern Suburbs"
+	        "Queensland",
+	        "State",
+	        "Legislative Assembly"
 	      ],
-	      "id": "1623a1"
+	      "electorate": {
+	        "name": "Queensland",
+	        "url": "http://barton.experimentsindemocracy.org/api/electorates/03d420"
+	      },
+	      "url": "http://barton.experimentsindemocracy.org/api/members/0db2ec"
 	    },
 	    {
-	      "name": "Sydney",
+	      "name": "Campbell Newman",
+	      "party": "LNP",
+	      "role": "Member for Ashgrove",
+	      "email": "ashgrove@parliament.qld.gov.au",
+	      "phone": "07 3366 6000",
+	      "web": "http://www.parliament.qld.gov.au/members/current/list/bio?member=Newman+Campbell",
+	      "post": "PO Box 40, Ashgrove Q 4060",
+	      "address": "Ashgrove Central, 221 Waterworks Road, Ashgrove",
+	      "id": "207190",
+	      "type": "member",
 	      "tags": [
-	        "New South Wales",
-	        "Local",
-	        "LGA",
-	        "Eastern Suburbs"
+	        "Queensland",
+	        "State",
+	        "Legislative Assembly",
+	        "Brisbane North"
 	      ],
-	      "id": "164e15"
-	    },
-	    {
-	      "name": "North Sydney",
-	      "tags": [
-	        "New South Wales",
-	        "Local",
-	        "LGA",
-	        "Lower North Shore"
-	      ],
-	      "id": "7b971f"
+	      "electorate": {
+	        "name": "Ashgrove",
+	        "url": "http://barton.experimentsindemocracy.org/api/electorates/e07a89"
+	      },
+	      "url": "http://barton.experimentsindemocracy.org/api/members/207190"
 	    }
 	  ],
 	  "resources": {
 	    "home": "http://barton.experimentsindemocracy.org",
 	    "api": "http://barton.experimentsindemocracy.org/api",
-	    "electorates": "http://barton.experimentsindemocracy.org/api/electorates"
+	    "electorates": "http://barton.experimentsindemocracy.org/api/electorates",
+	    "members": "http://barton.experimentsindemocracy.org/api/members"
 	  },
 	  "examples": {
-	    "electorates": {
-	      "resource_id": "http://barton.experimentsindemocracy.org/api/electorates/ccbfd1",
-	      "geo": "http://barton.experimentsindemocracy.org/api/electorates?geo=151.2054563,-33.8438383",
-	      "tags": "http://barton.experimentsindemocracy.org/api/electorates?tags=sydney,jurisidction:local",
-	      "mixed": "http://barton.experimentsindemocracy.org/api/electorates?geo=151.2054563,-33.8438383&tags=federal"
-	    }
+	    "id": "http://barton.experimentsindemocracy.org/api/members/0db2ec",
+	    "geo": "http://barton.experimentsindemocracy.org/api/electorates?geo=151.2054563,-33.8438383",
+	    "tags": "http://barton.experimentsindemocracy.org/api/members?tags=sydney,local",
+	    "mixed": "http://barton.experimentsindemocracy.org/api/electorates?geo=151.2054563,-33.8438383&tags=federal"
 	  }
 	}
 
-
 ## Contributing
 
-If you want to help then by all means jump in, fork and push a pull request.
+If you want to help then by all means jump in, fork and send a pull request.
 
 Updating politician contact details is the most pressing job. See the [data readme][data-readme] for more details.
 
-[data-readme]:https://github.com/davekinkead/barton/blob/master/data/README.md
+[data-readme]:https://github.com/davekinkead/barton/blob/master/data/README.md
+[es]:http://www.elasticsearch.org/

data/Rakefile

@@ -4,9 +4,8 @@ require 'rake/testtask'
 require 'barton/core'
 
 Rake::TestTask.new do |t|
-  ENV['RAKE_ENV'] = 'test'
-  Barton.config
-  #Barton::Data.purge_es
+  Barton.environment = 'test'
+  Barton::Data.purge_es
   Barton::Data.update_es( Barton::Setup.parse_yaml( 'specs/data/data-processed.yaml' ) )
   t.libs << "specs"
   t.test_files = FileList['specs/*_spec.rb']

data/TODO.md

@@ -0,0 +1,16 @@
+#Barton TODO list
+
+##Needs
+
+- Why my tests no worky no more?
+- Barton.setup to only run elasticsearch update if new data is available
+
+##Wants
+
+- Update readme to correct for method calls & jurisdiction
+
+
+
+##Done
+
+

data/barton.gemspec

@@ -10,15 +10,18 @@ Gem::Specification.new do |s|
   s.homepage      = "http://barton.experimentsindemocracy.org"
   s.description   = "Barton is an API for Australian electorates and politicains"
   s.summary       = "Programmable political access"
-  
+
   s.rubyforge_project = "barton"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_dependency 'sinatra', '~> 1.3.2'
   s.add_dependency 'tire',    '~> 0.4.2'
   s.add_dependency 'json'
+  s.add_dependency 'newrelic_rpm'   # only required on heroku to stop idling
+  s.add_dependency 'rack-test'      # only for testing
+  s.add_dependency 'trollop'
 end

data/bin/barton

@@ -1,5 +1,20 @@
 #!/usr/bin/env ruby
 require 'barton/app'
+require 'trollop'
 
-Barton.setup unless Barton.data_loaded
-Barton::App.run!
+opts = Trollop::options do
+  opt :setup,	"Configure and update database as <s>", :type => :string	# flag --setup, string required
+  opt :run,	"Run Baront as a webapp", :type => :string			# flag --run, default 'development'
+end
+
+if opts[:run]  
+	Barton.environment = opts[:run]
+	puts "Running Barton as #{Barton.environment}"
+	Barton.environment = opts[:run]
+	Barton::App.run!
+elsif opts[:setup]
+	Barton.environment = opts[:setup] 	
+	puts "Seting up Barton as #{Barton.environment}"
+	Barton.environment = opts[:setup] 
+	Barton.setup 
+end

data/config.ru

@@ -1,4 +1,5 @@
 require 'barton/app'
 
-Barton.setup unless Barton.data_loaded
+Barton.environment = ENV['FOUNDELASTICSEARCH_URL'] if ENV['FOUNDELASTICSEARCH_URL']
+puts "Running Barton as #{Barton.environment}"
 run Barton::App

data/data/nsw-state.yaml

@@ -9,6 +9,8 @@
   - name: Barry O'Farrell
     roles:
     - Premier of New South Wales
+    role: Member for New South Wales
+    id: 185d4f
   id: 7bd2b0
 - name: Gosford
   tags:

data/data/qld-state.yaml

@@ -6,9 +6,99 @@
   - Legislative Assembly
   members:
   - name: Campbell Newman
-    roles:
-    - Premier of Queensland
-  id: 03d420
+    role: Premier
+    party: LNP
+    address: Level 15, Executive Building, 100 George Street, Brisbane Qld 4000
+    email: thepremier@premiers.qld.gov.au
+    phone: 07 3224 4500
+    fax: 07 3221 1809
+    id: 0db2ec
+  - name: Jeff Seeney
+    role: Deputy Premier and Minister for State Development, Infrastructure and Planning
+    email: deputypremier@ministerial.qld.gov.au
+    phone: (07) 3224 4600
+    fax: (07) 3224 2490
+    web: http://www.parliament.qld.gov.au/members/current/list/bio?member=Seeney+Jeffrey
+    address: Level 12, Executive Building, 100 George Street, BRISBANE QLD 4000
+    id: f5deb4
+  - name: Tim Nicholls
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Lawrence Springborg
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: John-Paul Langbroek
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Jack Dempsey
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Jarrod Bleijie
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Scott Emerson
+    party: LNP
+    role: Minister for Transport and Main Roads
+    phone: (07) 3237 1111
+    fax: (07) 3224 2493
+    email: transportandmainRoads@ministerial.qld.gov.au
+    web: http://www.parliament.qld.gov.au/members/current/list/bio?member=Emerson+Scott
+    address: Level 15, Capital Hill, 85 George Street, BRISBANE QLD 4000
+    id: 96a1e9
+  - name: Bruce Flegg
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: John McVeigh
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Andrew Powell
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Andrew Cripps
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Mark McArdle
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: David Crisafulli
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Tracy Davis
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Ros Bates
+    party: LNP
+    role: Minister for Science, Information Technology, Innovation and the Arts
+    address: Level 5, Executive Building, 100 George Street Brisbane Qld 4000
+    phone: 07 3224 2880
+    fax: 07 3224 2492
+    email: ScienceandIT@ministerial.qld.gov.au
+    id: c1b232
+  - name: Steven Dickson
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Jann Stuckey
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  - name: Glen Elmes
+    party: LNP
+    role: Member for Queensland
+    id: 4f5f3b
+  id: !binary |-
+    MDNkNDIw
 - name: Ashgrove
   tags:
   - Queensland
@@ -18,13 +108,14 @@
   id: e07a89
   members:
   - name: Campbell Newman
-    roles:
-    - Member for Ashgrove
+    party: LNP
+    role: Member for Ashgrove
     email: ashgrove@parliament.qld.gov.au
     phone: 07 3366 6000
     web: http://www.parliament.qld.gov.au/members/current/list/bio?member=Newman+Campbell
     post: PO Box 40, Ashgrove Q 4060
     address: Ashgrove Central, 221 Waterworks Road, Ashgrove
+    id: '207190'
 - name: Aspley
   tags:
   - Queensland
@@ -284,6 +375,15 @@
   - Legislative Assembly
   - Central Queensland
   id: 2b9415
+  members:
+  - name: Steve Bennett
+    role: Member for Burnett
+    party: LNP
+    address: Shop 7, Bargara Beach Plaza, 15-19 See Street, Bargara Qld 4670
+    email: burnett@parliament.qld.gov.au
+    phone: 07 4159 1988
+    fax: 07 4159 2696
+    id: 80122e
 - name: Callide
   tags:
   - Queensland
@@ -361,6 +461,16 @@
   - Legislative Assembly
   - Gold Coast
   id: d99586
+  members:
+  - name: Verity Barton
+    role: Member for Broadwater
+    party: LNP
+    address: 102 Imperial Parade, (Cnr Government Rd and Imperial Pde), Labrador Qld
+      4215
+    email: broadwater@parliament.qld.gov.au
+    phone: 07 5563 9010
+    fax: 07 5500 5364
+    id: 42bd72
 - name: Burleigh
   tags:
   - Queensland
@@ -403,6 +513,15 @@
   - Legislative Assembly
   - Gold Coast
   id: 291a43
+  members:
+  - name: Ros Bates
+    party: LNP
+    address: Mudgeeraba Professional Centre, Swan Lane Mudgeeraba Qld 4213
+    email: mudgeeraba@parliament.qld.gov.au
+    phone: 07 5569 0482
+    fax: 07 5569 0675
+    role: Member for Mudgeeraba
+    id: 9c6e42
 - name: Southport
   tags:
   - Queensland
@@ -522,6 +641,15 @@
   - Legislative Assembly
   - SE Queensland
   id: '457031'
+  members:
+  - name: Ian Berry
+    role: Member for Ipswich
+    party: LNP
+    address: 125 Brisbane Road, Booval Qld 4304
+    email: ipswich@parliament.qld.gov.au
+    phone: 07 3202 3452
+    fax: 07 3202 4778
+    id: cf0b40
 - name: Ipswich West
   tags:
   - Queensland