wikidata 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f223b20d51a96728ef812814f1812f1628a86efc
+  data.tar.gz: 0b20f8f264dca6b052f01c34d28feb98a48a4705
+SHA512:
+  metadata.gz: f29089ce4c8ab0262d00cb12cc865b9da8bba14b9259a323f75939725d8dffb581bfc473f079f88b5bb1379e728996d5fbf9d0502bdcfbcceb1c745d68f353c6
+  data.tar.gz: 370fdf6fef4555678d60e29c9ebab43b8863804f9de89be7c42a63f14aaea483033b16c03af524f584782159dfa327ea91194d8662df7610ee7cff3a9e9640e1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wikidata.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Wil Gieseler
+
+MIT License
+
+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,92 @@
+# Wikidata for Ruby
+
+Access all of the wonderful structured data on [Wikidata](http://www.wikidata.org), with Ruby! Also includes a convenient CLI.
+
+Very much a work in progress, so only a few basic things are working.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wikidata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wikidata
+
+## Usage
+
+### Command Line
+
+See all the claims for a particular topic.
+
+    $ wikidata find "Kyle Chandler"
+        
+This will fetch all the data (called "claims") Wikidata has on superstar actor Kyle Chandler and print it out in the terminal, like so:
+
+    Kyle Chandler
+    Wikidata ID: Q359604
+    Claims: 14
+    +-------------+---------------------------------------------------------------------+
+    | property_id | value                                                               |
+    +-------------+---------------------------------------------------------------------+
+    | P21         | Q6581097                                                            |
+    +-------------+---------------------------------------------------------------------+
+    | P27         | Q30                                                                 |
+    +-------------+---------------------------------------------------------------------+
+    | P106        | Q33999                                                              |
+    +-------------+---------------------------------------------------------------------+
+    | P373        | Kyle Chandler                                                       |
+    +-------------+---------------------------------------------------------------------+
+    (...)
+
+You'll notice that doesn't seem very useful for humans, because Wikidata property keys and many of its values are not human readable. To have the gem resolve all of these opaque identifiers (which adds extra network calls), pass `-r`.
+
+    $ wikidata find "Kyle Chandler" -r
+    
+That will provide more useful results:
+    
+    (...)
+    +------------------------+------+---------------------------------------------------------------------+
+    | sex (or gender)        | P21  | male (Q6581097)                                                     |
+    +------------------------+------+---------------------------------------------------------------------+
+    | country of citizenship | P27  | United States of America (Q30)                                      |
+    +------------------------+------+---------------------------------------------------------------------+
+    | occupation             | P106 | actor / actress (Q33999)                                            |
+    +------------------------+------+---------------------------------------------------------------------+
+    | IMDb identifier        | P345 | nm0151419                                                           |
+    +------------------------+------+---------------------------------------------------------------------+
+    | place of birth         | P19  | Buffalo (Q40435)                                                    |
+    +------------------------+------+---------------------------------------------------------------------+
+    | date of birth          | P569 | 1965-09-17T00:00:00+00:00                                           |
+    +------------------------+------+---------------------------------------------------------------------+
+    (...)
+
+Much better!
+
+### In Ruby
+
+You can use a convenient ActiveRecord-inspired syntax for finding information:
+
+```ruby
+los_angeles = Wikidata::Item.find_by_title "Los Angeles"
+los_angeles.id # => "Q65"
+
+# Let's find the mayor.
+mayor = los_angeles.claims_for_property_id("P6").first.mainsnak.value.entity
+mayor.label # => "Eric Garcetti"
+```
+
+That's the basics!
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/wikidata/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/wikidata

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'wikidata'
+require 'wikidata/command_line'
+
+Wikidata::CommandLine.start

data/lib/wikidata/command_line.rb

@@ -0,0 +1,46 @@
+module Wikidata
+  require 'thor'
+  require 'colorize'
+  require 'formatador'
+
+  class CommandLine < Thor
+
+    desc "find ARTICLE_NAME", "find a Wikidata entity by name"
+    method_option :resolve_properties, :default => false, type: :boolean, aliases: "-r"
+    def find(article_name)
+      display_item Wikidata::Item.find_by_title(article_name)
+    end
+
+    desc "get ID", "find a Wikidata entity by ID"
+    method_option :resolve_properties, :default => false, type: :boolean, aliases: "-r"
+    def get(article_id)
+      display_item Wikidata::Item.find_by_id(article_id)
+    end
+
+  protected
+
+    def display_item(item)
+      if item
+        puts "  #{item.label.green}" if item.label
+        puts "  #{item.description.cyan}" if item.description
+        puts "  Wikidata ID: #{item.id}"
+        puts "  Claims: #{item.claims.length}" if item.claims
+        if item.claims.length > 0
+          if options[:resolve_properties]
+            table_data = item.claims.map do |claim|
+              { :id => claim.mainsnak.property_id,
+                'Property Label' => claim.mainsnak.property.label,
+                value: claim.mainsnak.value.resolved}
+            end
+          else
+            table_data = item.claims.map do |claim|
+              {:property_id => claim.mainsnak.property_id, value: claim.mainsnak.value}
+            end
+          end
+          Formatador.display_table(table_data)
+        end
+      end
+    end
+
+  end
+end

data/lib/wikidata/datavalues/entity.rb

@@ -0,0 +1,44 @@
+module Wikidata
+  module DataValues
+    class Entity < Wikidata::DataValues::Value
+
+      def kind
+        data_hash['entity-type']
+      end
+
+      def numeric_id
+        data_hash['numeric-id']
+      end
+
+      def item_id
+        "Q#{numeric_id}"
+      end
+
+      def entity
+        if kind == 'item'
+          @item ||= Wikidata::Item.find_by_id(item_id)
+        else
+          raise "Unknown entity type"
+        end
+      end
+
+      def resolve!
+        entity
+      end
+
+      def resolved
+        resolve!
+        super
+      end
+
+      def to_s
+        if @item.nil?
+          item_id
+        else
+          "#{@item.label} (#{item_id})"
+        end
+      end
+
+    end
+  end
+end

data/lib/wikidata/datavalues/globecoordinate.rb

@@ -0,0 +1,11 @@
+module Wikidata
+  module DataValues
+    class Globecoordinate < Wikidata::DataValues::Value
+
+      def to_s
+        "#{latitude}, #{longitude}"
+      end
+
+    end
+  end
+end

data/lib/wikidata/datavalues/string.rb

@@ -0,0 +1,11 @@
+module Wikidata
+  module DataValues
+    class String < Wikidata::DataValues::Value
+
+      def to_s
+        data_hash.string
+      end
+
+    end
+  end
+end

data/lib/wikidata/datavalues/time.rb

@@ -0,0 +1,15 @@
+module Wikidata
+  module DataValues
+    class Time < Wikidata::DataValues::Value
+
+      def to_time
+        DateTime.parse(data_hash.time)
+      end
+
+      def to_s
+        to_time.iso8601
+      end
+
+    end
+  end
+end

data/lib/wikidata/datavalues/value.rb

@@ -0,0 +1,11 @@
+module Wikidata
+  module DataValues
+    class Value < Wikidata::HashedObject
+
+      def resolved
+        self
+      end
+
+    end
+  end
+end

data/lib/wikidata/entity.rb

@@ -0,0 +1,54 @@
+module Wikidata
+  class Entity < Wikidata::HashedObject
+
+    def self.find_all query
+      Wikidata::IdentityMap.cache "#{query.hash}" do
+        query = {
+          action: 'wbgetentities',
+          sites: 'enwiki',
+          format: 'json'
+        }.merge(Wikidata.default_languages_hash).merge(query)
+        response = HTTParty.get('http://www.wikidata.org/w/api.php', {query: query})
+        # puts "Getting: #{query}"
+        response['entities'].map do |entity_id, entity_hash|
+          new(entity_hash)
+        end
+      end
+    end
+
+    def self.find_all_by_id id, query = {}
+      find_all({ids: id}.merge(query))
+    end
+
+    def self.find_by_id *args
+      find_all_by_id(*args).first
+    end
+
+    def self.find_all_by_title title, query = {}
+      find_all({titles: title}.merge(query))
+    end
+
+    def self.find_by_title *args
+      find_all_by_title(*args).first
+    end
+
+    def inspect
+      "<#{self.class.to_s} id=#{id}>"
+    end
+
+    def delocalize(hash, locale = I18n.default_locale)
+      return nil unless hash
+      h = hash[locale.to_s]
+      h ? h.value : nil
+    end
+
+    def label(*args)
+      delocalize self.data_hash.labels, *args
+    end
+
+    def description(*args)
+      delocalize self.data_hash.descriptions, *args
+    end
+
+  end
+end

data/lib/wikidata/hashed_object.rb

@@ -0,0 +1,19 @@
+module Wikidata
+  class HashedObject
+
+    attr_reader :data_hash
+
+    def initialize(data_hash)
+      @data_hash = Hashie::Mash.new(data_hash)
+    end
+
+    def method_missing(meth, *args, &block)
+      if data_hash.has_key?(meth.to_s)
+        data_hash[meth.to_s]
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/wikidata/identity_map.rb

@@ -0,0 +1,21 @@
+module Wikidata
+  class IdentityMap < Wikidata::HashedObject
+
+    def self.cache(key, &block)
+      @@identity_map ||= {}
+      if cached_value = @@identity_map[key]
+        return cached_value
+      else
+        content = block.call
+        cache! key, content
+        return content
+      end
+    end
+
+    def self.cache!(key, value)
+      @@identity_map ||= {}
+      @@identity_map[key] = value
+    end
+
+  end
+end

data/lib/wikidata/item.rb

@@ -0,0 +1,23 @@
+module Wikidata
+  class Item < Wikidata::Entity
+
+    def claims
+      @claims ||= begin
+        if self.data_hash.claims
+          self.data_hash.claims.map do |statement_type, statement_array|
+            statement_array.map do |statement_hash|
+              Wikidata::Statement.new(statement_hash)
+            end
+          end.flatten
+        else
+          []
+        end
+      end
+    end
+
+    def claims_for_property_id(property_id)
+      claims.select{|c| c.mainsnak.property_id == property_id }
+    end
+
+  end
+end

data/lib/wikidata/property.rb

@@ -0,0 +1,5 @@
+module Wikidata
+  class Property < Wikidata::Entity
+
+  end
+end

data/lib/wikidata/snak.rb

@@ -0,0 +1,31 @@
+module Wikidata
+  class Snak < Wikidata::HashedObject
+
+    def property_id
+      data_hash.property
+    end
+
+    def property
+      @property ||= Wikidata::Property.find_by_id(property_id)
+    end
+
+    def value
+      if datavalue['type'] == "wikibase-entityid"
+        Wikidata::DataValues::Entity.new(datavalue.value)
+      elsif datavalue['type'] == "time"
+        Wikidata::DataValues::Time.new(datavalue.value)
+      elsif datavalue['type'] == "globecoordinate"
+        Wikidata::DataValues::Globecoordinate.new(datavalue.value)
+      elsif datavalue['type'] == 'string'
+        Wikidata::DataValues::String.new({string: datavalue.value})
+      else
+        datavalue
+      end
+    end
+
+    def inspect
+      "<#{self.class.to_s} type=#{snaktype} property_id=#{property_id}>"
+    end
+
+  end
+end

data/lib/wikidata/statement.rb

@@ -0,0 +1,9 @@
+module Wikidata
+  class Statement < Wikidata::HashedObject
+
+    def mainsnak
+      @mainsnak ||= Wikidata::Snak.new(data_hash.mainsnak)
+    end
+
+  end
+end

data/lib/wikidata/version.rb

@@ -0,0 +1,3 @@
+module Wikidata
+  VERSION = "0.0.1"
+end

data/lib/wikidata.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+require 'hashie'
+require 'i18n'
+require "wikidata/version"
+require "wikidata/hashed_object"
+require "wikidata/identity_map"
+require "wikidata/entity"
+require "wikidata/item"
+require "wikidata/property"
+require "wikidata/statement"
+require "wikidata/snak"
+require "wikidata/datavalues/value"
+require "wikidata/datavalues/string"
+require "wikidata/datavalues/time"
+require "wikidata/datavalues/globecoordinate"
+require "wikidata/datavalues/entity"
+
+module Wikidata
+
+  def self.use_only_default_language
+    true
+  end
+
+  def self.default_languages_hash
+    use_only_default_language ? {languages: I18n.default_locale} : {}
+  end
+
+end

data/wikidata.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wikidata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wikidata"
+  spec.version       = Wikidata::VERSION
+  spec.authors       = ["Wil Gieseler"]
+  spec.email         = ["wil@wilgieseler.com"]
+  spec.summary       = "Ruby client for Wikidata"
+  spec.homepage      = "http://github.com/wilg/wikidata"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "colorize"
+  spec.add_dependency "formatador"
+  spec.add_dependency "thor"
+  spec.add_dependency "i18n"
+  spec.add_dependency "hashie", ">= 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: wikidata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wil Gieseler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- wil@wilgieseler.com
+executables:
+- wikidata
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/wikidata
+- lib/wikidata.rb
+- lib/wikidata/command_line.rb
+- lib/wikidata/datavalues/entity.rb
+- lib/wikidata/datavalues/globecoordinate.rb
+- lib/wikidata/datavalues/string.rb
+- lib/wikidata/datavalues/time.rb
+- lib/wikidata/datavalues/value.rb
+- lib/wikidata/entity.rb
+- lib/wikidata/hashed_object.rb
+- lib/wikidata/identity_map.rb
+- lib/wikidata/item.rb
+- lib/wikidata/property.rb
+- lib/wikidata/snak.rb
+- lib/wikidata/statement.rb
+- lib/wikidata/version.rb
+- wikidata.gemspec
+homepage: http://github.com/wilg/wikidata
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby client for Wikidata
+test_files: []