everypolitician-popolo 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a7b1839547390c1ed55c5b481f2f90312184676
-  data.tar.gz: 35aceb873364f94b96a918f4c6751a3fefde7d41
+  metadata.gz: 819ab96e2d0f30e3bf74ba4778a571516a159a36
+  data.tar.gz: db95c96de4e2645f3610aefa37121649599f509f
 SHA512:
-  metadata.gz: f34dd9659a86b9ccf88901b0eca4d12a721e052e16bbcb438ec397081425c27624a782dd26b146aaca9f5b7cbc29fc9a10d9bd90bf0bc0caeb82efb0efa722bb
-  data.tar.gz: 40a088519048a41ae59d2ea66fb6ab60d2d7bf5fd357e1890ade27b37b4d922612d6e951919897b11a81c2a902009613ff00a80058ada3af27cdd754cdeda444
+  metadata.gz: 111f78af9e392de63fbc5c4cda75ed9752653a2a8472b0980e60956f3cd72f850d8f63769d9e0f6bab719644f9bc3454d3a1d2c0a3e581294038e12b3d9c85ce
+  data.tar.gz: 64c9211c16d8f2f19b49266b34820db29c80ef634e2ebf320efa96947014e82eecf3ea5e2ecde1cdc4da0c7b65e710c3b164b54d3df6d5d120f52345fbd9ddeb

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.2.0] - 2016-03-11
+
+## Added
+
+- Support for all Popolo collections that EveryPolitician uses - People, Organizations, Areas, Memberships and Events. Thanks to @equivalentideas and @henare for this contribution!
+
+## 0.1.0 - 2016-01-26
+
+- Initial release
+
+[0.2.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.1.0...v0.2.0

data/README.md

@@ -1,8 +1,6 @@
 # Everypolitician::Popolo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/everypolitician/popolo`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+[EveryPolitician](http://everypolitician.org) provides its data in [Popolo](http://www.popoloproject.com/) format. If you want to interact with this data from Ruby then this library should make that task simpler.
 
 ## Installation
 
@@ -22,7 +20,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You'll need to download a Popolo file from [EveryPolitician](http://everypolitician.org/). The following example uses [Åland Lagting](https://github.com/everypolitician/everypolitician-data/raw/master/data/Aland/Lagting/ep-popolo-v1.0.json) (which is the legislature of the Åland islands,
+available as JSON data from the
+[EveryPolitician page for Åland](http://everypolitician.org/aland/)).
+
+First you'll need to require the library and read in a file from disk.
+
+```ruby
+require 'everypolitician/popolo'
+popolo = Everypolitician::Popolo.read('ep-popolo-v1.0.json')
+```
+
+All Popolo classes used by EveryPolitician are implemented:
+
+* [Person](http://www.popoloproject.com/specs/person.html)
+* [Organization](http://www.popoloproject.com/specs/organization.html)
+* [Area](http://www.popoloproject.com/specs/area.html)
+* [Event](http://www.popoloproject.com/specs/event.html)
+* [Membership](http://www.popoloproject.com/specs/membership.html)
+
+There are methods defined for each property on a class, e.g. for a Person:
+
+```
+popolo.persons.count # => 47
+person = popolo.persons.first
+person.id # => "e3aab23e-a883-4763-be0d-92e5936024e2"
+person.name # => "Aaltonen Carina"
+person.image # => "http://www.lagtinget.ax/files/aaltonen_carina.jpg"
+person.wikidata # => "Q4934081"
+```
 
 ## Development
 
@@ -32,10 +58,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/everypolitician-popolo.
+Bug reports and pull requests are welcome on GitHub at https://github.com/everypolitician/everypolitician-popolo.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/everypolitician/popolo.rb

@@ -1,4 +1,10 @@
 require 'everypolitician/popolo/version'
+require 'everypolitician/popolo/collection'
+require 'everypolitician/popolo/person'
+require 'everypolitician/popolo/organization'
+require 'everypolitician/popolo/area'
+require 'everypolitician/popolo/event'
+require 'everypolitician/popolo/membership'
 require 'json'
 
 module Everypolitician
@@ -24,89 +30,21 @@ module Everypolitician
       def persons
         People.new(popolo[:persons])
       end
-    end
-
-    class People
-      include Enumerable
-
-      attr_reader :documents
-
-      def initialize(documents)
-        @documents = documents.map { |p| Person.new(p) }
-      end
-
-      def each(&block)
-        documents.each(&block)
-      end
-    end
-
-    class Person
-      class Error < StandardError; end
-
-      attr_reader :document
-
-      def initialize(document)
-        @document = document
-        document.each do |key, value|
-          define_singleton_method(key) { value }
-        end
-      end
-
-      def [](key)
-        document[key]
-      end
-
-      def key?(key)
-        document.key?(key)
-      end
-
-      def links
-        document.fetch(:links, [])
-      end
-
-      def email
-        self[:email]
-      end
-
-      def twitter
-        if key?(:contact_details)
-          if twitter_contact = self[:contact_details].find { |d| d[:type] == 'twitter' }
-            twitter_contact[:value].strip
-          end
-        elsif key?(:links)
-          if twitter_link = self[:links].find { |d| d[:note][/twitter/i] }
-            twitter_link[:url].strip
-          end
-        end
-      end
-
-      def facebook
-        facebook_link = links.find { |d| d[:note] == 'facebook' }
-        facebook_link[:url] if facebook_link
-      end
 
-      def name_at(date)
-        return name unless key?(:other_names)
-        historic = other_names.find_all { |n| n.key?(:end_date) }
-        return name if historic.empty?
-        at_date = historic.find_all do |n|
-          n[:end_date] >= date && (n[:start_date] || '0000-00-00') <= date
-        end
-        return name if at_date.empty?
-        fail Error, "Too many names at #{date}: #{at_date}" if at_date.count > 1
-        at_date.first[:name]
+      def organizations
+        Organizations.new(popolo[:organizations])
       end
 
-      def sort_name
-        name
+      def areas
+        Areas.new(popolo[:areas])
       end
 
-      def image
-        self[:image]
+      def events
+        Events.new(popolo[:events])
       end
 
-      def gender
-        self[:gender]
+      def memberships
+        Memberships.new(popolo[:memberships])
       end
     end
   end

data/lib/everypolitician/popolo/area.rb

@@ -0,0 +1,18 @@
+module Everypolitician
+  module Popolo
+    class Areas < Collection
+      def initialize(documents)
+        @documents = documents.map { |p| Area.new(p) }
+      end
+    end
+
+    class Area
+      def initialize(document)
+        @document = document
+        document.each do |key, value|
+          define_singleton_method(key) { value }
+        end
+      end
+    end
+  end
+end

data/lib/everypolitician/popolo/collection.rb

@@ -0,0 +1,18 @@
+module Everypolitician
+  module Popolo
+    class Collection
+      include Enumerable
+
+      attr_reader :documents
+
+      def each(&block)
+        documents.each(&block)
+      end
+
+      def -(other)
+        other_ids = Set.new(other.documents.map(&:id))
+        documents.reject { |d| other_ids.include?(d.id) }
+      end
+    end
+  end
+end

data/lib/everypolitician/popolo/event.rb

@@ -0,0 +1,18 @@
+module Everypolitician
+  module Popolo
+    class Events < Collection
+      def initialize(documents)
+        @documents = documents.map { |p| Event.new(p) }
+      end
+    end
+
+    class Event
+      def initialize(document)
+        @document = document
+        document.each do |key, value|
+          define_singleton_method(key) { value }
+        end
+      end
+    end
+  end
+end

data/lib/everypolitician/popolo/membership.rb

@@ -0,0 +1,26 @@
+module Everypolitician
+  module Popolo
+    class Memberships < Collection
+      def initialize(documents)
+        @documents = documents.map { |p| Membership.new(p) }
+      end
+    end
+
+    class Membership
+      def initialize(document)
+        @document = document
+        document.each do |key, value|
+          define_singleton_method(key) { value }
+        end
+      end
+
+      def start_date
+        @document[:start_date]
+      end
+
+      def end_date
+        @document[:end_date]
+      end
+    end
+  end
+end

data/lib/everypolitician/popolo/organization.rb

@@ -0,0 +1,25 @@
+module Everypolitician
+  module Popolo
+    class Organizations < Collection
+      def initialize(documents)
+        @documents = documents.map { |p| Organization.new(p) }
+      end
+    end
+
+    class Organization
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+        document.each do |key, value|
+          define_singleton_method(key) { value }
+        end
+      end
+
+      def ==(other)
+        id == other.id
+      end
+      alias eql? ==
+    end
+  end
+end

data/lib/everypolitician/popolo/person.rb

@@ -0,0 +1,97 @@
+module Everypolitician
+  module Popolo
+    class People < Collection
+      def initialize(documents)
+        @documents = documents.map { |p| Person.new(p) }
+      end
+    end
+
+    class Person
+      class Error < StandardError; end
+
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+        document.each do |key, value|
+          define_singleton_method(key) { value }
+        end
+      end
+
+      def [](key)
+        document[key]
+      end
+
+      def key?(key)
+        document.key?(key)
+      end
+
+      def ==(other)
+        id == other.id
+      end
+      alias eql? ==
+
+      def links
+        document.fetch(:links, [])
+      end
+
+      def identifiers
+        document.fetch(:identifiers, [])
+      end
+
+      def identifier(scheme)
+        identifiers.find(->{{}}) { |i| i[:scheme] == scheme }[:identifier]
+      end
+
+      def email
+        self[:email]
+      end
+
+      def twitter
+        if key?(:contact_details)
+          if twitter_contact = self[:contact_details].find { |d| d[:type] == 'twitter' }
+            return twitter_contact[:value].strip
+          end
+        end
+        if key?(:links)
+          if twitter_link = self[:links].find { |d| d[:note][/twitter/i] }
+            return twitter_link[:url].strip
+          end
+        end
+      end
+
+      def facebook
+        facebook_link = links.find { |d| d[:note] == 'facebook' }
+        facebook_link[:url] if facebook_link
+      end
+
+      def wikidata
+        identifier('wikidata')
+      end
+
+      def name_at(date)
+        return name unless key?(:other_names)
+        historic = other_names.find_all { |n| n.key?(:end_date) }
+        return name if historic.empty?
+        at_date = historic.find_all do |n|
+          n[:end_date] >= date && (n[:start_date] || '0000-00-00') <= date
+        end
+        return name if at_date.empty?
+        fail Error, "Too many names at #{date}: #{at_date}" if at_date.count > 1
+        at_date.first[:name]
+      end
+
+      def sort_name
+        name
+      end
+
+      def image
+        self[:image]
+      end
+
+      def gender
+        self[:gender]
+      end
+    end
+  end
+end

data/lib/everypolitician/popolo/version.rb

@@ -1,5 +1,5 @@
 module Everypolitician
   module Popolo
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everypolitician-popolo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Mytton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,6 +84,12 @@ files:
 - bin/setup
 - everypolitician-popolo.gemspec
 - lib/everypolitician/popolo.rb
+- lib/everypolitician/popolo/area.rb
+- lib/everypolitician/popolo/collection.rb
+- lib/everypolitician/popolo/event.rb
+- lib/everypolitician/popolo/membership.rb
+- lib/everypolitician/popolo/organization.rb
+- lib/everypolitician/popolo/person.rb
 - lib/everypolitician/popolo/version.rb
 homepage: https://github.com/everypolitician/everypolitician-popolo
 licenses: