everypolitician-popolo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 819ab96e2d0f30e3bf74ba4778a571516a159a36
-  data.tar.gz: db95c96de4e2645f3610aefa37121649599f509f
+  metadata.gz: 75d39a544d53fcdcc9692ac0825e03234a7f1ac9
+  data.tar.gz: 4dc22302c3543d088cbed60b375b0cc196026881
 SHA512:
-  metadata.gz: 111f78af9e392de63fbc5c4cda75ed9752653a2a8472b0980e60956f3cd72f850d8f63769d9e0f6bab719644f9bc3454d3a1d2c0a3e581294038e12b3d9c85ce
-  data.tar.gz: 64c9211c16d8f2f19b49266b34820db29c80ef634e2ebf320efa96947014e82eecf3ea5e2ecde1cdc4da0c7b65e710c3b164b54d3df6d5d120f52345fbd9ddeb
+  metadata.gz: 69ad80079a75686b97663ea202642ecc5a0bf52814170e641bee38eb68c3c4fac1744330ebcbad55add964b78b2741dc234fa587beac874cb35cd8d8d1c64a56
+  data.tar.gz: caad3f3004bb899da9d97674c7064f383eb0e5384afc5edf4a63fd7ce583f7093a7d05a53d08ef12e7791848e920dd31c5cc0495a97925ce6ab07eda98d46a36

data/CHANGELOG.md

@@ -3,9 +3,21 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.3.0] - 2016-05-04
+
+### Fixed
+
+- Return an empty array when no data is available for a collection (Thanks @henare)
+
+### Added
+
+- Support for Posts, which EveryPolitician has recently added support for.
+- `Collection#find_by` and `Collection#where` methods. See the README for more details on how to use these.
+- Explicit methods so that calling a known property on a document returns `nil` rather than blowing up if it's missing.
+
 ## [0.2.0] - 2016-03-11
 
-## Added
+### Added
 
 - Support for all Popolo collections that EveryPolitician uses - People, Organizations, Areas, Memberships and Events. Thanks to @equivalentideas and @henare for this contribution!
 
@@ -14,3 +26,4 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Initial release
 
 [0.2.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.1.0...v0.2.0
+[0.3.0]: https://github.com/everypolitician/everypolitician-popolo/compare/v0.2.0...v0.3.0

data/README.md

@@ -50,6 +50,28 @@ person.image # => "http://www.lagtinget.ax/files/aaltonen_carina.jpg"
 person.wikidata # => "Q4934081"
 ```
 
+You can also find individual records or collections based on their attributes:
+
+```ruby
+popolo.persons.find_by(name: "Aaltonen Carina", wikidata: "Q4934081")
+    # => #<Everypolitician::Popolo::Person:0x0000000237dfc8
+    #      @document={:id=>"0c705344-23aa-4fa2-9391-af41c1c775b7",
+    #                 :identifiers=>[{:identifier=>"Q4934081", :scheme=>"wikidata"}],
+    #                 :name=>"Aaltonen Carina"}>
+
+popolo.organizations.where(classification: "party")
+    # => [
+    #      <Everypolitician::Popolo::Organization:0x000000035779e0
+    #       @document={:classification=>"party",
+    #                  :id=>"123",
+    #                  :name=>"Sunripe Tomato Party"}>,
+    #      <Everypolitician::Popolo::Organization:0x000000035779e1
+    #       @document={:classification=>"party",
+    #                  :id=>"456",
+    #                  :name=>"The Greens"}>
+    #    ]
+```
+
 ## 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/lib/everypolitician/popolo.rb

@@ -1,9 +1,11 @@
 require 'everypolitician/popolo/version'
 require 'everypolitician/popolo/collection'
+require 'everypolitician/popolo/entity'
 require 'everypolitician/popolo/person'
 require 'everypolitician/popolo/organization'
 require 'everypolitician/popolo/area'
 require 'everypolitician/popolo/event'
+require 'everypolitician/popolo/post'
 require 'everypolitician/popolo/membership'
 require 'json'
 
@@ -43,6 +45,10 @@ module Everypolitician
         Events.new(popolo[:events])
       end
 
+      def posts
+        Posts.new(popolo[:posts])
+      end
+
       def memberships
         Memberships.new(popolo[:memberships])
       end

data/lib/everypolitician/popolo/area.rb

@@ -1,18 +1,6 @@
 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
+    class Areas < Collection; end
+    class Area < Entity; end
   end
 end

data/lib/everypolitician/popolo/collection.rb

@@ -5,6 +5,10 @@ module Everypolitician
 
       attr_reader :documents
 
+      def initialize(documents)
+        @documents = documents ? documents.map { |p| klass.new(p) } : []
+      end
+
       def each(&block)
         documents.each(&block)
       end
@@ -13,6 +17,39 @@ module Everypolitician
         other_ids = Set.new(other.documents.map(&:id))
         documents.reject { |d| other_ids.include?(d.id) }
       end
+
+      def find_by(attributes = {})
+        where(attributes).first
+      end
+
+      def where(attributes = {})
+        find_all do |object|
+          attributes.all? { |k, v| object.send(k) == v }
+        end
+      end
+
+      private
+
+      # TODO: This feels pretty nasty, is there a better way of working out the
+      # class name?
+      def klass
+        case self.class.to_s.split("::").last
+        when "People"
+          Person
+        when "Organizations"
+          Organization
+        when "Memberships"
+          Membership
+        when "Events"
+          Event
+        when "Posts"
+          Post
+        when "Areas"
+          Area
+        else
+          raise "Unknown class: #{self.class.to_s}"
+        end
+      end
     end
   end
 end

data/lib/everypolitician/popolo/entity.rb

@@ -0,0 +1,35 @@
+module Everypolitician
+  module Popolo
+    class Entity
+
+      attr_accessor :id
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+
+        document.each do |key, value|
+          if respond_to?("#{key}=")
+            __send__("#{key}=", value)
+          else
+            define_singleton_method(key) { value }
+          end
+        end
+      end
+
+      def [](key)
+        document[key]
+      end
+
+      def key?(key)
+        document.key?(key)
+      end
+
+      def ==(other)
+        id == other.id
+      end
+      alias eql? ==
+
+    end
+  end
+end

data/lib/everypolitician/popolo/event.rb

@@ -1,18 +1,6 @@
 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
+    class Events < Collection; end
+    class Event < Entity; end
   end
 end

data/lib/everypolitician/popolo/membership.rb

@@ -1,26 +1,9 @@
 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
+    class Memberships < Collection; end
 
-      def end_date
-        @document[:end_date]
-      end
+    class Membership < Entity
+      attr_accessor :person_id, :on_behalf_of_id, :organization_id, :area_id, :role, :start_date, :end_date
     end
   end
 end

data/lib/everypolitician/popolo/organization.rb

@@ -1,25 +1,6 @@
 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
+    class Organizations < Collection; end
+    class Organization < Entity; end
   end
 end

data/lib/everypolitician/popolo/person.rb

@@ -1,50 +1,39 @@
 module Everypolitician
   module Popolo
-    class People < Collection
-      def initialize(documents)
-        @documents = documents.map { |p| Person.new(p) }
-      end
-    end
+    class People < Collection; end
 
-    class Person
+    class Person < Entity
       class Error < StandardError; end
 
-      attr_reader :document
+      attr_accessor :name, :email, :image, :gender, :birth_date, :death_date
 
-      def initialize(document)
-        @document = document
-        document.each do |key, value|
-          define_singleton_method(key) { value }
-        end
+      def links
+        document.fetch(:links, [])
       end
 
-      def [](key)
-        document[key]
+      def identifiers
+        document.fetch(:identifiers, [])
       end
 
-      def key?(key)
-        document.key?(key)
+      def contact_details
+        document.fetch(:contact_details, [])
       end
 
-      def ==(other)
-        id == other.id
-      end
-      alias eql? ==
 
-      def links
-        document.fetch(:links, [])
+      def identifier(scheme)
+        identifiers.find(->{{}}) { |i| i[:scheme] == scheme }[:identifier]
       end
 
-      def identifiers
-        document.fetch(:identifiers, [])
+      def contact(type)
+        contact_details.find(->{{}}) { |i| i[:type] == type }[:value]
       end
 
-      def identifier(scheme)
-        identifiers.find(->{{}}) { |i| i[:scheme] == scheme }[:identifier]
+      def phone
+        contact('phone')
       end
 
-      def email
-        self[:email]
+      def fax
+        contact('fax')
       end
 
       def twitter
@@ -69,6 +58,10 @@ module Everypolitician
         identifier('wikidata')
       end
 
+      def sort_name
+        name
+      end
+
       def name_at(date)
         return name unless key?(:other_names)
         historic = other_names.find_all { |n| n.key?(:end_date) }
@@ -80,18 +73,6 @@ module Everypolitician
         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/post.rb

@@ -0,0 +1,6 @@
+module Everypolitician
+  module Popolo
+    class Posts < Collection; end
+    class Post < Entity; end
+  end
+end

data/lib/everypolitician/popolo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: everypolitician-popolo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Mytton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,10 +86,12 @@ files:
 - lib/everypolitician/popolo.rb
 - lib/everypolitician/popolo/area.rb
 - lib/everypolitician/popolo/collection.rb
+- lib/everypolitician/popolo/entity.rb
 - lib/everypolitician/popolo/event.rb
 - lib/everypolitician/popolo/membership.rb
 - lib/everypolitician/popolo/organization.rb
 - lib/everypolitician/popolo/person.rb
+- lib/everypolitician/popolo/post.rb
 - lib/everypolitician/popolo/version.rb
 homepage: https://github.com/everypolitician/everypolitician-popolo
 licenses: