everypolitician 0.17.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53e74c64bd7576aa98501922b02abfdf58ce5996
-  data.tar.gz: d57337142f105a4e5b01959ec6b93510200ad9f5
+  metadata.gz: 3a2f42e4251751b073c51cc076f48eb031e8982a
+  data.tar.gz: f6a9f626ec4561e709db1e42f29d7e5b711d464f
 SHA512:
-  metadata.gz: 611b9052bc7dbee75d6514d6c665c3440ebbfbe774da31fe6fbdec5b45500c06ac1add3f3dba46bb85f7aa780e10a918d2ba0eb9555559cef287dd4931df1c26
-  data.tar.gz: 42eacfc02b5268f974d3c40769335ec8386bded77a7917592739f291f0521ee270b0c0316380c5a7a22d272222571ee10f88c89b75382856e017ebb87cebbb18
+  metadata.gz: 32661d8fc404cd8cc07e00738cff3f76eb28ead39d0f30dfad21f1b3b481459a70b5c5dc5c3fd41bddc94899e8fb94067bd1da4ea689ab41fefe5cbc73b7b572
+  data.tar.gz: 1d362621148d17b0ac2a277ea307df2233f0ecbad57d72a27a85e91e28dc180cb4d78b35e018a54a9a60f97377e384e30d06d906d0ae813c926dbdae0001a9e2

data/CHANGELOG.md

@@ -3,8 +3,28 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.20.0] - 2016-10-28
+
+### Added
+
+- Added `all_legislatures` to Index class. Returns an array of all the
+  Legislatures for all countries.
+- Added `latest_term` to Legislature class. This returns an
+  Everpolitician::Popolo::LegislativePeriod object with data from the
+  latest term. Note that this may involve a **substantial download**
+  depending on the legislature.
+
+## [0.19.0] - 2016-10-19
+
 ## Unreleased
 
+## [0.18.0] - 2016-08-25
+
+### Changed
+
+- The method to get the URL of the names file is now `Legislature.names_url`, 
+   not `Legislature.csv_url`
+
 ## [0.17.0] - 2016-08-23
 
 ### Changed
@@ -156,3 +176,6 @@ a string with the time in seconds.
 [0.15.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.14.0...v0.15.0
 [0.16.0]: https://https://github.com/everypolitician/everypolitician-ruby/compare/v0.15.0...v0.16.0
 [0.17.0]: https://https://github.com/everypolitician/everypolitician-ruby/compare/v0.16.0...v0.17.0
+[0.18.0]: https://https://github.com/everypolitician/everypolitician-ruby/compare/v0.17.0...v0.18.0
+[0.19.0]: https://https://github.com/everypolitician/everypolitician-ruby/compare/v0.18.0...v0.19.0
+[0.20.0]: https://https://github.com/everypolitician/everypolitician-ruby/compare/v0.19.0...v0.20.0

data/README.md

@@ -1,6 +1,6 @@
 # Everypolitician [![Build Status](https://travis-ci.org/everypolitician/everypolitician-ruby.svg?branch=v0.1.0)](https://travis-ci.org/everypolitician/everypolitician-ruby) [![Gem Version](https://badge.fury.io/rb/everypolitician.svg)](https://badge.fury.io/rb/everypolitician)
 
-Interface with EveryPolitician data from your Ruby application.
+Interface with [EveryPolitician](http://everypolitician.org) data from your Ruby application.
 
 ## Installation
 
@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-Use as shown below, passing the `:slug` of the country to the `country` method, and the `:slug` of the legislature to the `legislature` method. Examples:
+Pass the `:slug` of the country to the `country` method, and the `:slug` of the legislature to the `legislature` method.
+
+Examples:
 
 ```ruby
 require 'everypolitician'
@@ -43,18 +45,46 @@ algeria = Everypolitician::Index.new.country('Algeria')
 national_assembly = algeria.legislature('Majlis')
 
 # Iterate though all known countries
-Everypolitician::Index.new.countries do |country|
+Everypolitician::Index.new.countries.each do |country|
   puts "#{country.name} has #{country.legislatures.size} legislature(s)"
 end
+
+# Iterate through all known legislatures
+Everypolitician::Index.new.all_legislatures.each do |legislature|
+  puts "#{legislature.name} in #{legislature.country.name} has #{legislature.person_count} member(s)"
+end
+
+# Fetch Everypolitician::Popolo::LegislativePeriod for the latest term
+# Note that this may involve a **substantial download**
+puts 'Members of the Assembly:'
+assembly = Everypolitician::Index.new.country('Albania').lower_house
+assembly.latest_term.memberships.map(&:person).uniq(&:id).each do |person|
+  puts person.name
+end
 ```
 
-If you want to point at a different version of `countries.json` you can supply an
-`index_url` option to `Everypolitician::Index.new`.
+By default, the gem connects to EveryPolitician's data on GitHub over HTTPS and
+returns the most recent data. Specifically it uses the current index file,
+called `countries.json`, which itself contains links to specific versions of
+data files.
+
+If you want to point at a different `countries.json`, you can override this default behavour by supplying an
+`index_url` option to `Everypolitician::Index.new` like this:
 
 ```ruby
 Everypolitician::Index.new(index_url: 'https://cdn.rawgit.com/everypolitician/everypolitician-data/080cb46/countries.json')
 ```
 
+The example above is using a specific commit (indicated by the hash `080cb46`).
+If you want to use a local copy of `countries.json` you can specify a local file path as the `index_url` instead of a fully-qualified URL.
+
+For more about `countries.json`, see [this description](http://docs.everypolitician.org/repo_structure.html).
+
+Remember that EveryPolitician data is frequently updated — see this information
+about [using EveryPolitician data](http://docs.everypolitician.org/use_the_data.html).
+
+More information on [the EveryPolitician site](http://docs.everypolitician.org/).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -3,6 +3,7 @@ require 'rake/testtask'
 require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
+  t.warning = true
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']

data/everypolitician.gemspec

@@ -18,11 +18,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'everypolitician-popolo'
+  spec.add_dependency 'everypolitician-popolo', '>= 0.8.0'
+  spec.add_dependency 'require_all'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.9.0'
+  spec.add_development_dependency 'minitest-around', '~> 0.4.0'
   spec.add_development_dependency 'pry', '~> 0.10.4'
   spec.add_development_dependency 'rubocop', '~> 0.42.0'
   spec.add_development_dependency 'vcr', '~> 3.0.3'

data/lib/everypolitician.rb

@@ -1,8 +1,9 @@
 require 'everypolitician/version'
 require 'json'
 require 'open-uri'
-require 'everypolitician/popolo'
-require 'csv'
+require 'require_all'
+
+require_rel 'everypolitician'
 
 module Everypolitician
   class << self
@@ -36,178 +37,4 @@ module Everypolitician
     legislature = country.legislature(legislature_slug)
     [country, legislature]
   end
-
-  class Index
-    DEFAULT_INDEX_URL = 'https://raw.githubusercontent.com/' \
-      'everypolitician/everypolitician-data/master/countries.json'.freeze
-
-    attr_reader :index_url
-
-    def initialize(index_url: DEFAULT_INDEX_URL)
-      @index_url = index_url
-    end
-
-    def country(slug)
-      country_index[slug.to_s.downcase]
-    end
-
-    def countries
-      @countries ||= begin
-        JSON.parse(open(index_url).read, symbolize_names: true).map do |c|
-          Country.new(c)
-        end
-      end
-    end
-
-    private
-
-    def country_index
-      @country_index ||= Hash[countries.map { |c| [c.slug.downcase, c] }]
-    end
-  end
-
-  class Country
-    attr_reader :name
-    attr_reader :code
-    attr_reader :slug
-    attr_reader :raw_data
-
-    def self.find(query)
-      query = { slug: query } if query.is_a?(String)
-      country = Everypolitician.countries.find do |c|
-        query.all? { |k, v| c[k].to_s.downcase == v.to_s.downcase }
-      end
-      return if country.nil?
-      new(country)
-    end
-
-    def initialize(country_data)
-      @name = country_data[:name]
-      @code = country_data[:code]
-      @slug = country_data[:slug]
-      @raw_data = country_data
-    end
-
-    def [](key)
-      raw_data[key]
-    end
-
-    def legislatures
-      @legislatures ||= @raw_data[:legislatures].map { |l| Legislature.new(l, self) }
-    end
-
-    def legislature(query)
-      query = { slug: query } if query.is_a?(String)
-      legislatures.find do |l|
-        query.all? { |k, v| l.__send__(k).to_s.downcase == v.to_s.downcase }
-      end
-    end
-  end
-
-  class Legislature
-    attr_reader :name
-    attr_reader :slug
-    attr_reader :lastmod_str
-    attr_reader :person_count
-    attr_reader :sha
-    attr_reader :country
-    attr_reader :raw_data
-    attr_reader :statement_count
-    attr_reader :popolo_url
-
-    def self.find(country_slug, legislature_slug)
-      country = Country.find(country_slug)
-      country && country.legislature(legislature_slug)
-    end
-
-    def initialize(legislature_data, country)
-      @name = legislature_data[:name]
-      @slug = legislature_data[:slug]
-      @lastmod_str = legislature_data[:lastmod]
-      @person_count = legislature_data[:person_count]
-      @sha = legislature_data[:sha]
-      @statement_count = legislature_data[:statement_count]
-      @popolo_url = legislature_data[:popolo_url]
-      @raw_data = legislature_data
-      @country = country
-    end
-
-    def [](key)
-      raw_data[key]
-    end
-
-    def popolo
-      @popolo ||= Everypolitician::Popolo.parse(open(popolo_url).read)
-    end
-
-    def legislative_periods
-      @legislative_periods ||= raw_data[:legislative_periods].map do |lp|
-        LegislativePeriod.new(lp, self, country)
-      end
-    end
-
-    def directory
-      @directory = raw_data[:sources_directory].split('/')[1, 2].join('/')
-    end
-
-    def self.from_sources_dir(dir)
-      @index_by_sources ||= EveryPolitician.countries.map(&:legislatures).flatten.group_by(&:directory)
-      @index_by_sources[dir][0]
-    end
-
-    def lastmod
-      Time.at(lastmod_str.to_i).gmtime
-    end
-
-    def csv_url
-      @csv_url ||= 'https://cdn.rawgit.com/everypolitician' \
-        "/everypolitician-data/#{@sha}/#{raw_data[:names]}"
-    end
-  end
-
-  class LegislativePeriod
-    attr_reader :id
-    attr_reader :name
-    attr_reader :slug
-    attr_reader :legislature
-    attr_reader :country
-    attr_reader :raw_data
-    attr_reader :csv_url
-
-    def initialize(legislative_period_data, legislature, country)
-      @id = legislative_period_data[:id]
-      @name = legislative_period_data[:name]
-      @slug = legislative_period_data[:slug]
-      @csv_url = legislative_period_data[:csv_url]
-      @legislature = legislature
-      @country = country
-      @raw_data = legislative_period_data
-    end
-
-    def start_date
-      @start_date ||= parse_partial_date(raw_data[:start_date])
-    end
-
-    def end_date
-      @end_date ||= parse_partial_date(raw_data[:end_date])
-    end
-
-    def csv
-      CSV.parse(open(csv_url).read, headers: true, header_converters: :symbol, converters: nil)
-    end
-
-    def [](key)
-      raw_data[key]
-    end
-
-    private
-
-    def parse_partial_date(date)
-      return if date.to_s.empty?
-      Date.new(*date.split('-').map(&:to_i))
-    end
-  end
 end
-
-# Alternative constant name which is how it's usually capitalized in public copy.
-EveryPolitician ||= Everypolitician

data/lib/everypolitician/country.rb

@@ -0,0 +1,55 @@
+module Everypolitician
+  class Country
+    attr_reader :name
+    attr_reader :code
+    attr_reader :slug
+    attr_reader :raw_data
+
+    def self.find(query)
+      query = { slug: query } if query.is_a?(String)
+      country = Everypolitician.countries.find do |c|
+        query.all? { |k, v| c[k].to_s.downcase == v.to_s.downcase }
+      end
+      return if country.nil?
+      new(country)
+    end
+
+    def initialize(country_data)
+      @name = country_data[:name]
+      @code = country_data[:code]
+      @slug = country_data[:slug]
+      @raw_data = country_data
+    end
+
+    def [](key)
+      raw_data[key]
+    end
+
+    def legislatures
+      @legislatures ||= @raw_data[:legislatures].map { |l| Legislature.new(l, self) }
+    end
+
+    def legislature(query)
+      query = { slug: query } if query.is_a?(String)
+      legislatures.find do |l|
+        query.all? { |k, v| l.__send__(k).to_s.downcase == v.to_s.downcase }
+      end
+    end
+
+    def upper_house
+      @upper_house ||= most_recent('upper house')
+    end
+
+    def lower_house
+      @lower_house ||= most_recent('lower house')
+    end
+
+    private
+
+    def most_recent(type)
+      houses = legislatures.select { |l| l.type == type || l.type == 'unicameral legislature' }
+      return houses.first if houses.count == 1
+      houses.max_by { |h| h.legislative_periods.map(&:start_date).max }
+    end
+  end
+end

data/lib/everypolitician/index.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'open-uri'
+
+module Everypolitician
+  class Index
+    DEFAULT_INDEX_URL = 'https://raw.githubusercontent.com/' \
+      'everypolitician/everypolitician-data/master/countries.json'.freeze
+
+    attr_reader :index_url
+
+    def initialize(index_url: DEFAULT_INDEX_URL)
+      @index_url = index_url
+    end
+
+    def country(slug)
+      country_index[slug.to_s.downcase]
+    end
+
+    def countries
+      @countries ||= begin
+        JSON.parse(open(index_url).read, symbolize_names: true).map do |c|
+          Country.new(c)
+        end
+      end
+    end
+
+    def all_legislatures
+      @all_legislatures ||= countries.flat_map(&:legislatures)
+    end
+
+    private
+
+    def country_index
+      @country_index ||= Hash[countries.map { |c| [c.slug.downcase, c] }]
+    end
+  end
+end

data/lib/everypolitician/legislative_period.rb

@@ -0,0 +1,47 @@
+require 'open-uri'
+require 'csv'
+
+module Everypolitician
+  class LegislativePeriod
+    attr_reader :id
+    attr_reader :name
+    attr_reader :slug
+    attr_reader :legislature
+    attr_reader :country
+    attr_reader :raw_data
+    attr_reader :csv_url
+
+    def initialize(legislative_period_data, legislature, country)
+      @id = legislative_period_data[:id]
+      @name = legislative_period_data[:name]
+      @slug = legislative_period_data[:slug]
+      @csv_url = legislative_period_data[:csv_url]
+      @legislature = legislature
+      @country = country
+      @raw_data = legislative_period_data
+    end
+
+    def start_date
+      @start_date ||= parse_partial_date(raw_data[:start_date])
+    end
+
+    def end_date
+      @end_date ||= parse_partial_date(raw_data[:end_date])
+    end
+
+    def csv
+      CSV.parse(open(csv_url).read, headers: true, header_converters: :symbol, converters: nil)
+    end
+
+    def [](key)
+      raw_data[key]
+    end
+
+    private
+
+    def parse_partial_date(date)
+      return if date.to_s.empty?
+      Date.new(*date.split('-').map(&:to_i))
+    end
+  end
+end

data/lib/everypolitician/legislature.rb

@@ -0,0 +1,71 @@
+require 'open-uri'
+require 'everypolitician/popolo'
+
+module Everypolitician
+  class Legislature
+    attr_reader :name
+    attr_reader :slug
+    attr_reader :lastmod_str
+    attr_reader :person_count
+    attr_reader :sha
+    attr_reader :country
+    attr_reader :raw_data
+    attr_reader :statement_count
+    attr_reader :popolo_url
+    attr_reader :type
+
+    def self.find(country_slug, legislature_slug)
+      country = Country.find(country_slug)
+      country && country.legislature(legislature_slug)
+    end
+
+    def initialize(legislature_data, country)
+      @name = legislature_data[:name]
+      @slug = legislature_data[:slug]
+      @lastmod_str = legislature_data[:lastmod]
+      @person_count = legislature_data[:person_count]
+      @sha = legislature_data[:sha]
+      @statement_count = legislature_data[:statement_count]
+      @popolo_url = legislature_data[:popolo_url]
+      @raw_data = legislature_data
+      @country = country
+      @type = legislature_data[:type]
+    end
+
+    def [](key)
+      raw_data[key]
+    end
+
+    def popolo
+      @popolo ||= Everypolitician::Popolo.parse(open(popolo_url).read)
+    end
+
+    def legislative_periods
+      @legislative_periods ||= raw_data[:legislative_periods].map do |lp|
+        LegislativePeriod.new(lp, self, country)
+      end
+    end
+
+    def directory
+      @directory = raw_data[:sources_directory].split('/')[1, 2].join('/')
+    end
+
+    def latest_term
+      @latest_term ||= popolo.latest_term
+    end
+
+    def self.from_sources_dir(dir)
+      @index_by_sources ||= EveryPolitician.countries.map(&:legislatures).flatten.group_by(&:directory)
+      @index_by_sources[dir][0]
+    end
+
+    def lastmod
+      Time.at(lastmod_str.to_i).gmtime
+    end
+
+    def names_url
+      'https://cdn.rawgit.com/everypolitician/everypolitician-data/%s/%s' %
+        [sha, raw_data[:names]]
+    end
+  end
+end

data/lib/everypolitician/version.rb

@@ -1,3 +1,3 @@
 module Everypolitician
-  VERSION = '0.17.0'.freeze
+  VERSION = '0.20.0'.freeze
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: everypolitician
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Chris Mytton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: everypolitician-popolo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.9.0
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +170,10 @@ files:
 - bin/setup
 - everypolitician.gemspec
 - lib/everypolitician.rb
+- lib/everypolitician/country.rb
+- lib/everypolitician/index.rb
+- lib/everypolitician/legislative_period.rb
+- lib/everypolitician/legislature.rb
 - lib/everypolitician/version.rb
 homepage: https://github.com/everypolitician/everypolitician-ruby
 licenses: