wikidata-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 176a5af4ed352f7b9647a8ee712c5dcc98314abe
+  data.tar.gz: 4a1bbc872493aaeb43f0c374de9aac2244e445fe
+SHA512:
+  metadata.gz: 4e88633911b243de244e13a694cef8ad33dcd3fc3442f78e4e3c9bd1b61b2a6e10b1edbfb656c5d87f09abfc1e4468640d9e0b070c1fccabbb64fb1363e612c1
+  data.tar.gz: 318598d5c79876629b2bf334a1c60a3d5a16ff544e669335908ad61d7e26cee1594899dfe2cce27d8aff1d2014dee5f24fc46f6d636ff5ae762c4631adfcbea1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+addons:
+  code_climate:
+    repo_token: 743f972ae03be14575c4cda0bf254af861a9a788527267015c5a8d487f43c371

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    wikidata-client (0.0.1)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      hashie (~> 3.3)
+      patron (~> 0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    codeclimate-test-reporter (0.4.0)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    hashie (3.3.1)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    patron (0.4.18)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    safe_yaml (1.0.3)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    vcr (2.9.3)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  pry (~> 0.10)
+  rake (~> 10.3)
+  rspec (~> 3.1)
+  vcr (~> 2.9)
+  webmock (~> 1.18)
+  wikidata-client!

data/LICENCE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) klacointe <kevinlacointe@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,180 @@
+# Wikidata API Client
+
+[![Build Status](https://travis-ci.org/klacointe/wikidata-client.svg?branch=master)](https://travis-ci.org/klacointe/wikidata-client)
+[![Code Climate](https://codeclimate.com/github/klacointe/wikidata-client/badges/gpa.svg)](https://codeclimate.com/github/klacointe/wikidata-client)
+[![Test Coverage](https://codeclimate.com/github/klacointe/wikidata-client/badges/coverage.svg)](https://codeclimate.com/github/klacointe/wikidata-client)
+[![Dependency Status](https://gemnasium.com/klacointe/wikidata-client.svg)](https://gemnasium.com/klacointe/wikidata-client)
+
+
+[Wikidata](http://www.wikidata.org/) client library for Ruby.
+
+It provide an easy way to search for wikidata pages and read their contents.
+
+
+## Installation
+
+In bunler: `gem 'wikidata-client', '~> 0.0.1', require: 'wikidata'`
+
+Otherwise: `gem install wikidata-client`
+
+
+## Configuration
+
+Only one thing is configurable for now, the HTTP client [patron](https://github.com/toland/patron)
+
+```ruby
+Wikidata.configure do |c|
+  c.client_options = {
+    request: {
+      open_timeout: 2,
+      timeout: 9
+    }
+  }
+end
+```
+
+## Usage
+
+
+### Search
+
+```irb
+> search = Wikidata::Item.search 'Homer Simpson'
+=> <Wikidata::SearchResponse results: [
+     <Wikidata::Item id: Q7810, title: "Homer Simpson">,
+     <Wikidata::Item id: Q3577370, title: "Homer Simpson, This Is Your Wife">,
+     <Wikidata::Item id: Q2082128, title: "Homer Simpson in: "Kidney Trouble">,
+     <Wikidata::Item id: Q2715733, title: "Politically Inept, with Homer Simpson">,
+     <Wikidata::Item id: Q1626047, title: "The City of New York vs. Homer Simpson">,
+     <Wikidata::Item id: Q5966549, title: "Q5966549">,
+     <Wikidata::Item id: Q15162647, title: "Being Homer Simpson">,
+     <Wikidata::Item id: Q17653635, title: "'Homer Simpson' contributes to U.S. presidential candidate Buddy Roemer">,
+     <Wikidata::Item id: Q17713638, title: "Q17713638">,
+     <Wikidata::Item id: Q2751406, title: "Q2751406">
+   ]>
+
+> search.empty?
+=> false
+
+> search.results.first.labels['en'].value
+=> "Homer Simpson"
+
+> search.total_hits
+=> 119
+
+> search.next_page_offset
+=> 10
+```
+
+### Find by ids or titles
+
+```irb
+> homer = Wikidata::Item.find_by_title 'Homer Simpson' # Same as homer = Wikidata::Item.find 'Q7810'
+=> <Wikidata::Item id: Q7810, title: "Homer Simpson">
+
+> homer.children
+=> [<Wikidata::Item id: Q5480, title: "Bart Simpson">, <Wikidata::Item id: Q5846, title: "Lisa Simpson">, <Wikidata::Item id: Q7834, title: "Maggie Simpson">]
+
+> homer.date_of_birth.date
+=> #<DateTime: 1956-06-18T00:00:00+00:00 ((2435643j,0s,0n),+0s,2299161j)>
+```
+
+
+If you want several pages at the same time, just give an array to `find` or `find_by_title` methods:
+
+```irb
+> Wikidata::Item.find_by_title ['Sid Vicious', 'John Lydon']
+=> <Wikidata::Response results: [
+     <Wikidata::Item id: Q47878, title: "Sid Vicious">,
+     <Wikidata::Item id: Q106662, title: "John Lydon">
+   ]>
+
+> Wikidata::Item.find ['Q47878', 'Q106662']
+=> <Wikidata::Response results: [
+     <Wikidata::Item id: Q47878, title: "Sid Vicious">,
+     <Wikidata::Item id: Q106662, title: "John Lydon">
+   ]>
+```
+
+## Properties
+
+To access an item property, use the Wikidata property code and one of these
+methods:
+
+- `properties`:  to get all properties
+- `property`:  to get the first property
+
+```irb
+> homer = Wikidata::Item.find_by_title 'Homer Simpson'
+
+=> <Wikidata::Item id: Q7810, title: "Homer Simpson">
+
+> homer.properties('P40')
+=> [
+     <Wikidata::Item id: Q5480, title: "Bart Simpson">,
+     <Wikidata::Item id: Q5846, title: "Lisa Simpson">,
+     <Wikidata::Item id: Q7834, title: "Maggie Simpson">
+   ]
+
+> homer.property('P22')
+=> <Wikidata::Item id: Q842104, title: "Grampa Simpson">
+```
+
+Alternatively, you can map wikidata property codes to method names, see
+https://github.com/klacointe/wikidata-client/blob/master/config/mapping.yml to
+get the list of mapped properties.
+
+If you define the mapping under the `resources` section, accessor will be on the
+first property only. If under the `collections` sections, all properties will be
+returned:
+
+```irb
+> homer = Wikidata::Item.find_by_title 'Homer Simpson'
+
+=> <Wikidata::Item id: Q7810, title: "Homer Simpson">
+
+> homer.children
+=> [
+     <Wikidata::Item id: Q5480, title: "Bart Simpson">,
+     <Wikidata::Item id: Q5846, title: "Lisa Simpson">,
+     <Wikidata::Item id: Q7834, title: "Maggie Simpson">
+   ]
+
+> homer.father
+=> <Wikidata::Item id: Q842104, title: "Grampa Simpson">
+```
+
+
+Feel free to add yours in a topic branch and seed me a pull request.
+
+
+Finally of you want to get only ids of properties to avoid making several
+unecessary requests, you can use these methods: `property_id` and `property_ids`:
+
+```irb
+> homer = Wikidata::Item.find_by_title 'Homer Simpson'
+
+=> <Wikidata::Item id: Q7810, title: "Homer Simpson">
+
+> homer.property_ids('P40')
+=> ["Q5480", "Q5846", "Q7834"]
+
+> homer.property_id('P22')
+=> "Q842104"
+```
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version
+unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have
+your own version, that is fine but bump version in a commit by itself in another
+branch so I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+## Copyright
+
+MIT. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/config/mapping.yml

@@ -0,0 +1,19 @@
+resources:
+  creator: P170
+  place_of_birth: P19
+  place_of_death: P20
+  country_of_citizenship: P27
+  date_of_birth: P569
+  date_of_death: P570
+  date_of_foundation_or_creation: P571
+  official_website: P856
+  gender: P21
+  is_in_the_administrative_territorial_entity: P131
+  coordinate_location: P625
+  freebase_identifier: P646
+  father: P22
+collections:
+  official_websites: P856
+  instance_of: P31
+  subclass_of: P279
+  children: P40

data/config/settings.yml

@@ -0,0 +1,4 @@
+:api:
+  :url: http://www.wikidata.org/w/api.php
+:item:
+  :url: http://www.wikidata.org/wiki/:id

data/lib/wikidata.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'patron'
+require 'hashie'
+require 'yaml'
+
+require 'wikidata/config'
+
+module Wikidata
+  class << self
+    def configure &block
+      Config.configure &block
+    end
+
+    def client_options
+      Config.client_options
+    end
+
+    def settings
+      Config.settings
+    end
+
+    def mapping
+      Config.mapping
+    end
+  end
+end
+
+require 'wikidata/client'
+require 'wikidata/property'
+require 'wikidata/property/base'
+require 'wikidata/property/string'
+require 'wikidata/property/time'
+require 'wikidata/property/url'
+require 'wikidata/property/globe_coordinate'
+require 'wikidata/entity'
+require 'wikidata/item'
+require 'wikidata/response'
+require 'wikidata/search_response'

data/lib/wikidata/client.rb

@@ -0,0 +1,36 @@
+module Wikidata
+  class Client
+    DEFAULT_QUERY = {
+      format: 'json'
+    }
+
+    attr_accessor :query, :total_pages
+
+    def initialize query = {}
+      @query = DEFAULT_QUERY.merge(query)
+    end
+
+    def response
+      response_class.new api.get('', query)
+    end
+
+    private
+
+    def response_class
+      case @query[:action]
+      when 'query'
+        Wikidata::SearchResponse
+      else
+        Wikidata::Response
+      end
+    end
+
+    def api
+      Faraday.new({url: Wikidata.settings.api.url}.merge(Wikidata.client_options)) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter  :patron
+      end
+    end
+  end
+end

data/lib/wikidata/config.rb

@@ -0,0 +1,23 @@
+module Wikidata
+  class Config
+    class << self
+      attr_accessor :client_options, :settings, :mapping
+
+      def configure &block
+        yield self
+      end
+    end
+
+    @client_options = {}
+    @settings = Hashie::Mash.new(
+      YAML.load_file(
+        File.expand_path('../../../config/settings.yml', __FILE__)
+      )
+    )
+    @mapping = Hashie::Mash.new(
+      YAML.load_file(
+        File.expand_path('../../../config/mapping.yml', __FILE__)
+      )
+    )
+  end
+end

data/lib/wikidata/entity.rb

@@ -0,0 +1,83 @@
+module Wikidata
+  class Entity
+    extend Forwardable
+
+    attr_accessor :hash
+    def_delegators :@hash, :id, :labels, :aliases, :descriptions, :sitelinks
+
+    def initialize hash
+      @hash = Hashie::Mash.new hash
+      @_properties = {}
+    end
+
+    def id
+      return hash['id'] if hash['id']
+      return hash['title'] if hash['title']
+    end
+
+    def title
+      return labels['en'].value if labels && labels['en']
+      return sitelinks['en'].value if sitelinks && sitelinks['en']
+      hash['title'] if hash['title']
+    end
+
+    def url
+      Wikidata.settings.item.url.gsub(':id', id)
+    end
+
+    Wikidata.mapping.resources.each do |k, code|
+      define_method k do
+        property code
+      end
+      define_method "#{k}_id" do
+        property_id code
+      end
+    end
+
+    Wikidata.mapping.collections.each do |k, code|
+      define_method k do
+        properties code
+      end
+      define_method "#{k}_ids" do
+        property_ids code
+      end
+    end
+
+    def properties code
+      @_properties[code] ||= Array(raw_property(code)).map {|a| Wikidata::Property.build a }
+    end
+
+    def property_ids code
+      Array(raw_property(code)).map do |attribute|
+        # TODO Handle other types
+        # http://www.wikidata.org/wiki/Wikidata:Glossary#Entities.2C_items.2C_properties_and_queries
+        case attribute.mainsnak.datavalue.value['entity-type']
+          when 'item'
+            prefix = 'Q'
+          else
+            raise "Unkown wikibase-item entity-type #{attribute.mainsnak.datatype.value['entity-type']}"
+        end
+        "#{prefix}#{attribute.mainsnak.datavalue.value['numeric-id']}"
+      end
+    end
+
+    def property code
+      properties(code).first
+    end
+
+    def property_id code
+      property_ids(code).first
+    end
+
+    def inspect
+      "<#{self.class} id: #{id}, title: \"#{title}\">"
+    end
+
+    private
+
+    def raw_property code
+      return unless hash.claims
+      hash.claims[code]
+    end
+  end
+end