everypolitician 0.6.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70bd3480dd8c6504c3c21701dd0c705f75346f5b
-  data.tar.gz: bc7a9c59bdef1a226ca281b5dc5fb8b322a6f034
+  metadata.gz: 049d21610458ca4158fbc452bf99fe57b88443ff
+  data.tar.gz: a4c2bc68a937231ac8a6758f0a46ec1a32e4c7b5
 SHA512:
-  metadata.gz: 8cf500912b6c6541ef12d35ee1f702082bef9c6bf1fa70fa466ec3ba0e21612f130ecfdd8f749672f2192806eae0d03f8208d899b0ee4905304d065a385c2472
-  data.tar.gz: 3d0c46815af909d5986eeb3c947cb34b2edfb1a636ea05d9d62b87f3a0ea3a3c16bcbee76673f02d7d5895a34b4b2b9a6ea30734e7a4b485b9a09b4c346dbd03
+  metadata.gz: ba198093b9ac78b87a542c8d601634b8619732d64c16bf51f831498287e501832b72065f2d05ff162e3bd611c99e57662772d7fb98347d0fd8398bfa72d762c2
+  data.tar.gz: fe87ab19b2fc7bdafb30e38a7ebc120c402902a47ab85d75026c49a3501f140a10a1d5c9e04ef955fa4e3e62dddb6fcdba35ab611f305f302ec0bef08e50d313

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rubocop-https---raw-githubusercontent-com-everypolitician-everypolitician-data-master--rubocop-base-yml

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://raw.githubusercontent.com/everypolitician/everypolitician-data/master/.rubocop_base.yml
+  - .rubocop_todo.yml
+
+# We're OK with a class of EveryPolitician
+Style/ConstantName:
+  Exclude:
+    - 'lib/everypolitician.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,27 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-15 19:54:18 +0100 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Metrics/AbcSize:
+  Max: 24
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 152
+
+# Offense count: 20
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 144
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 11

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 cache: bundler
+sudo: false
+script:
+  - bundle exec rake test
+  - bundle exec rake rubocop
 rvm:
   - 2.0.0
   - 2.1.7

data/CHANGELOG.md

@@ -3,6 +3,61 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## Unreleased
+
+## [0.13.0] - 2016-08-18
+
+### Added
+
+- There is now an `Everypolitician::Index` class which can be instantiated with
+  a url pointing to a `countries.json` file. This replaces the need to globally
+  set a url via `Everypolitician.countries_json=`.
+  - You can access a country via the `Everypolitician::Index#country` method, which takes a (case-insensitive) slug for the country.
+  - You can get a list of all countries via the `Everypolitician::Index#countries` method.
+
+## [0.12.0] - 2016-08-16
+
+### Changed
+
+- Trying to find a non-existent country or legislature now returns `nil` rather
+  than raising an exception.
+
+## [0.11.0] - 2016-08-07
+
+### Added
+
+- Searches by slug for a Country or a Legislature are now case insensitive
+
+## [0.10.0] - 2016-08-04
+
+### Changed
+
+- The code now uses the `popolo_url` field from the data, so the url
+  host has changed from `raw.githubusercontent.com` to `cdn.rawgit.com`.
+
+## [0.9.0] - 2016-07-28
+
+### Added
+
+- The`Legislature#lastmod` attribute now returns a Time object instead of just
+a string with the time in seconds.
+
+## [0.8.0] - 2016-07-26
+
+### Added
+
+- There is now a `Legislature#statement_count` method for returning the
+  statement count of a legislature, which corresponds to the `statement_count`
+  field in the legislatures of a country coming from the data in `countries_json`.
+
+## [0.7.0] - 2016-06-21
+
+### Added
+
+- There is now a `Legislature.directory` method for returning the
+  directory path under `data` where the raw data on everypolician data
+  can be found
+
 ## [0.6.1] - 2016-05-23
 
 ## Fixed
@@ -62,3 +117,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 [0.5.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.4.0...v0.5.0
 [0.6.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.5.0...v0.6.0
 [0.6.1]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.6.0...v0.6.1
+[0.7.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.6.1...v0.7.0
+[0.8.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.7.0...v0.8.0
+[0.9.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.8.0...v0.9.0
+[0.10.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.9.0...v0.10.0
+[0.11.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.10.0...v0.11.0
+[0.12.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.11.0...v0.12.0
+[0.13.0]: https://github.com/everypolitician/everypolitician-ruby/compare/v0.12.0...v0.13.0

data/README.md

@@ -20,19 +20,39 @@ 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:
+
 ```ruby
 require 'everypolitician'
 
-australia = Everypolitician.country('Australia')
+australia = Everypolitician::Index.new.country('Australia')
 australia.code # => "AU"
 senate = australia.legislature('Senate')
 senate.popolo # => #<Everypolitician::Popolo::JSON>
+
+united_kingdom = Everypolitician::Index.new.country('UK')
+house_of_commons = united_kingdom.legislature('Commons')
+
+american_samoa = Everypolitician::Index.new.country('American-Samoa')
+house_of_representatives = american_samoa.legislature('House')
+
+united_arab_emirates = Everypolitician::Index.new.country('United-Arab-Emirates')
+national_council = united_arab_emirates.legislature('Federal-National-Council')
+
+algeria = Everypolitician::Index.new.country('Algeria')
+national_assembly = algeria.legislature('Majlis')
+
+# Iterate though all known countries
+Everypolitician::Index.new.countries do |country|
+  puts "#{country.name} has #{country.legislatures.size} legislature(s)"
+end
 ```
 
-If you want to point at a different `countries.json`, e.g. a local path or a different url, you can set it like this:
+If you want to point at a different version of `countries.json` you can supply an
+`index_url` option to `Everypolitician::Index.new`.
 
 ```ruby
-Everypolitician.countries_json = 'path/to/local/countries.json'
+Everypolitician::Index.new(index_url: 'https://cdn.rawgit.com/everypolitician/everypolitician-data/080cb46/countries.json')
 ```
 
 ## Development

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
@@ -7,4 +8,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+RuboCop::RakeTask.new
+
 task default: :test

data/everypolitician.gemspec

@@ -22,8 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'minitest', '~> 5.9.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'
+  spec.add_development_dependency 'webmock', '~> 2.0.3'
 end

data/lib/everypolitician.rb

@@ -5,8 +5,6 @@ require 'everypolitician/popolo'
 require 'csv'
 
 module Everypolitician
-  class Error < StandardError; end
-
   class << self
     attr_writer :countries_json
     attr_writer :countries
@@ -39,6 +37,35 @@ module Everypolitician
     [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
@@ -47,8 +74,10 @@ module Everypolitician
 
     def self.find(query)
       query = { slug: query } if query.is_a?(String)
-      country = Everypolitician.countries.find { |c| query.all? { |k, v| c[k] == v } }
-      fail Error, "Couldn't find country for query: #{query}" if country.nil?
+      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
 
@@ -69,31 +98,36 @@ module Everypolitician
 
     def legislature(query)
       query = { slug: query } if query.is_a?(String)
-      legislature = legislatures.find { |l| query.all? { |k, v| l.__send__(k) == v } }
-      fail Error, "Unknown legislature: #{query}" if legislature.nil?
-      legislature
+      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
+    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.find(country_slug).legislature(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 = legislature_data[:lastmod]
+      @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
@@ -102,16 +136,24 @@ module Everypolitician
       @popolo ||= Everypolitician::Popolo.parse(open(popolo_url).read)
     end
 
-    def popolo_url
-      @popolo_url ||= 'https://raw.githubusercontent.com/everypolitician' \
-        "/everypolitician-data/#{sha}/#{raw_data[:popolo]}"
-    end
-
     def legislative_periods
       @legislative_periods ||= raw_data[:legislative_periods].map do |lp|
-        LegislativePeriod.new(lp, self, self.country)
+        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
   end
 
   class LegislativePeriod

data/lib/everypolitician/version.rb

@@ -1,3 +1,3 @@
 module Everypolitician
-  VERSION = '0.6.1'
+  VERSION = '0.13.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everypolitician
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.13.0
 platform: ruby
 authors:
 - Chris Mytton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: everypolitician-popolo
@@ -56,58 +56,72 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.9.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.3
 description: 
 email:
 - chrismytton@gmail.com
@@ -116,6 +130,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile