wikidata 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9c2ff62426ddfda2857a629064bd3e95d269867
-  data.tar.gz: ecd1e1e45425d0f25d6dc125745e688391ac58c6
+  metadata.gz: e8e4a8a949931853b5e9f8388bdd5dd26d270e2a
+  data.tar.gz: 868a2e6298298fd9158c38c90bc1ed6040061911
 SHA512:
-  metadata.gz: ae4db34040575940a822caeb1155a4e1d4dd857ff2cb66579b92045a37709f7ab8bdad98ab6f2d4c7e3598195ef990a64d721f95640b7037ee73631883cb35a0
-  data.tar.gz: 2001dc68293fdd54b86106a397bc07f65ba92a3bf0f4a8493cb9bc5bc95b51730ebb922c0380633413101febd3c75a65473688f4499a1e34a16daa32e2128392
+  metadata.gz: b96b95417941d5d693a23e388db748a780d77daab3b050be4dd746a810c4414aba641b03da1758ae08ac3ae59424ac7b36615c80575b65ca650c9a74f60f3a03
+  data.tar.gz: b281420e1f3289d6b5fa5f5cae7b5110d2b885188215d70948718e2c946fa85d5ce452a2abfaf667235da0244f899f427de7212d275b46b0e1d52c7b3cc9601c

data/README.md

@@ -25,32 +25,14 @@ Or install it yourself as:
 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:
-    
-    (...)
+    +------------------------+------+---------------------------------------------------------------------+
+    | Property Label         | id   | value                                                               |
     +------------------------+------+---------------------------------------------------------------------+
     | sex (or gender)        | P21  | male (Q6581097)                                                     |
     +------------------------+------+---------------------------------------------------------------------+
@@ -58,34 +40,84 @@ That will provide more useful results:
     +------------------------+------+---------------------------------------------------------------------+
     | occupation             | P106 | actor / actress (Q33999)                                            |
     +------------------------+------+---------------------------------------------------------------------+
+    | Commons category       | P373 | Kyle Chandler                                                       |
+    +------------------------+------+---------------------------------------------------------------------+
+    | VIAF identifier        | P214 | 56819238                                                            |
+    +------------------------+------+---------------------------------------------------------------------+
+    | ISNI (ISO 27729)       | P213 | 0000 0001 1444 9499                                                 |
+    +------------------------+------+---------------------------------------------------------------------+
+    | LCCN identifier        | P244 | no2007102838                                                        |
+    +------------------------+------+---------------------------------------------------------------------+
+    | GND identifier         | P227 | 1016952201                                                          |
+    +------------------------+------+---------------------------------------------------------------------+
     | IMDb identifier        | P345 | nm0151419                                                           |
     +------------------------+------+---------------------------------------------------------------------+
+    | image                  | P18  | Kyle Chandler at the Texas Film Hall of Fame Awards, March 2009.jpg |
+    +------------------------+------+---------------------------------------------------------------------+
+    | instance of            | P31  | human (Q5)                                                          |
+    +------------------------+------+---------------------------------------------------------------------+
     | place of birth         | P19  | Buffalo (Q40435)                                                    |
     +------------------------+------+---------------------------------------------------------------------+
     | date of birth          | P569 | 1965-09-17T00:00:00+00:00                                           |
     +------------------------+------+---------------------------------------------------------------------+
-    (...)
+    | Freebase identifier    | P646 | /m/069nzr                                                           |
+    +------------------------+------+---------------------------------------------------------------------+
+
+For internationalization reasons, Wikidata property keys and many of its values are not human readable by default. (For example, the place of birth property is actually "P19".)
+
+The CLI will automatically resolve the opaque identifiers by fetching their full descriptions from Wikidata as well. This adds a few more HTTP requests, so if you wish you can also pass `-f` to skip the resolving and return only opaque IDs, like so:
 
-Much better!
+    $ wikidata find "Kyle Chandler" -f
+
+    Kyle Chandler
+    Wikidata ID: Q359604
+    Claims: 14
+    +-------------+---------------------------------------------------------------------+
+    | property_id | value                                                               |
+    +-------------+---------------------------------------------------------------------+
+    | P21         | Q6581097                                                            |
+    +-------------+---------------------------------------------------------------------+
+    | P27         | Q30                                                                 |
+    +-------------+---------------------------------------------------------------------+
+    | P106        | Q33999                                                              |
+    +-------------+---------------------------------------------------------------------+
+    | P373        | Kyle Chandler                                                       |
+    +-------------+---------------------------------------------------------------------+
+    | P214        | 56819238                                                            |
+    +-------------+---------------------------------------------------------------------+
 
 ### In Ruby
 
 You can use a convenient ActiveRecord-inspired syntax for finding information:
 
 ```ruby
+require 'wikidata'
+
 los_angeles = Wikidata::Item.find_by_title "Los Angeles"
 los_angeles.id # => "Q65"
 
 # Let's find the mayor.
+# The "head of government" property has an Wikidata property id of "P6".
 mayor = los_angeles.claims_for_property_id("P6").first.mainsnak.value.entity
 mayor.label # => "Eric Garcetti"
-```
 
-That's the basics!
+# There's a few convenience methods for fetching common associated entities
+item = Wikidata::Item.find_by_title("Chelsea Clinton")
+item.mothers.first.label # => "Hillary Rodham Clinton"
+
+# There's also a convenience method for finding the default image
+sf = Wikidata::Item.find_by_title("San Francisco")
+sf.image
+# => an instance of Wikidata::DataValues::CommonsMedia
+sf.image.resolved
+# => an instance of Wikidata::DataValues::CommonsMedia with additional data fetched
+sf.image.resolved.file.urls.file
+# => "http://upload.wikimedia.org/wikipedia/commons/3/3b/San_Francisco_%28Evening%29.jpg"
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/wikidata/fork )
+1. Fork it ( http://github.com/wilg/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`)

data/lib/wikidata.rb

@@ -11,12 +11,15 @@ require "wikidata/statement"
 require "wikidata/snak"
 require "wikidata/datavalues/value"
 require "wikidata/datavalues/string"
+require "wikidata/datavalues/commons_media"
 require "wikidata/datavalues/time"
 require "wikidata/datavalues/globecoordinate"
 require "wikidata/datavalues/entity"
 
 module Wikidata
 
+  @@verbose = false
+
   def self.use_only_default_language
     true
   end
@@ -25,4 +28,12 @@ module Wikidata
     use_only_default_language ? {languages: I18n.default_locale} : {}
   end
 
+  def self.verbose?
+    !!@@verbose
+  end
+
+  def self.verbose=(v)
+    @@verbose = !!v
+  end
+
 end

data/lib/wikidata/command_line.rb

@@ -6,19 +6,25 @@ module Wikidata
   class CommandLine < Thor
 
     desc "find ARTICLE_NAME", "find a Wikidata entity by name"
-    method_option :resolve_properties, :default => false, type: :boolean, aliases: "-r"
+    method_option :fast, :default => false, type: :boolean, aliases: "-f"
+    method_option :verbose, :default => false, type: :boolean, aliases: "-v"
     def find(article_name)
+      apply_options!
       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"
+    method_option :fast, :default => false, type: :boolean, aliases: "-f"
+    method_option :verbose, :default => false, type: :boolean, aliases: "-v"
     def get(article_id)
+      apply_options!
       display_item Wikidata::Item.find_by_id(article_id)
     end
 
     desc "traverse ARTICLE_NAME relation_name", "find all related items until there are no more"
+    method_option :verbose, :default => false, type: :boolean, aliases: "-v"
     def traverse(article_name, relation_name)
+      apply_options!
       item = Wikidata::Item.find_by_title(article_name)
       if item
         puts "#{item.label.green} (#{item.id})"
@@ -36,6 +42,10 @@ module Wikidata
 
   protected
 
+    def apply_options!
+      Wikidata.verbose = options[:verbose]
+    end
+
     def display_item(item)
       if item
         puts "  #{item.label.green}" if item.label
@@ -43,12 +53,16 @@ module Wikidata
         puts "  Wikidata ID: #{item.id}"
         puts "  Claims: #{item.claims.length}" if item.claims
         if item.claims.length > 0
-          if options[:resolve_properties]
+          if !options[:fast]
             item.resolve_claims!
             table_data = item.claims.map do |claim|
-              { :id => claim.mainsnak.property_id,
+              should_resolve_value = claim.mainsnak.value.class != Wikidata::DataValues::CommonsMedia
+              {
+                :id => claim.mainsnak.property_id,
                 'Property Label' => claim.mainsnak.property.label,
-                value: claim.mainsnak.value.resolved}
+                value: should_resolve_value ? claim.mainsnak.value.resolved : claim.mainsnak.value
+                # datatype: claim.mainsnak.property.datatype
+              }
             end
           else
             table_data = item.claims.map do |claim|

data/lib/wikidata/datavalues/commons_media.rb

@@ -0,0 +1,18 @@
+module Wikidata
+  module DataValues
+    class CommonsMedia < Wikidata::DataValues::Value
+
+      def to_s
+        data_hash.imagename
+      end
+
+      def resolve!
+        query = {image: data_hash.imagename, thumbwidth: 150}
+        puts "Getting: #{query}".yellow if Wikidata.verbose?
+        r = HTTParty.get('http://tools.wmflabs.org/magnus-toolserver/commonsapi.php', {query: query})
+        @data_hash = Hashie::Mash.new(r['response'].merge({imagename: data_hash.imagename}))
+      end
+
+    end
+  end
+end

data/lib/wikidata/datavalues/entity.rb

@@ -26,11 +26,6 @@ module Wikidata
         entity
       end
 
-      def resolved
-        resolve!
-        super
-      end
-
       def to_s
         if @item.nil?
           item_id

data/lib/wikidata/datavalues/value.rb

@@ -2,7 +2,11 @@ module Wikidata
   module DataValues
     class Value < Wikidata::HashedObject
 
+      def resolve!
+      end
+
       def resolved
+        resolve!
         self
       end
 

data/lib/wikidata/entity.rb

@@ -57,7 +57,7 @@ module Wikidata
 
     def self.query_and_build_objects(query)
       response = HTTParty.get('http://www.wikidata.org/w/api.php', {query: query})
-      # puts "Getting: #{query}"
+      puts "Getting: #{query}".yellow if Wikidata.verbose?
       response['entities'].map do |entity_id, entity_hash|
         item = new(entity_hash)
         IdentityMap.cache!(entity_id, item)

data/lib/wikidata/item.rb

@@ -41,5 +41,28 @@ module Wikidata
       []
     end
 
+    # Convenience methods
+
+    def image
+      image_claim = claims_for_property_id("P18").first
+      image_claim.mainsnak.value if image_claim
+    end
+
+    def mothers
+      entities_for_property_id :mother
+    end
+
+    def fathers
+      entities_for_property_id :father
+    end
+
+    def children
+      entities_for_property_id :children
+    end
+
+    def doctoral_advisors
+      entities_for_property_id :doctoral_advisor
+    end
+
   end
 end

data/lib/wikidata/snak.rb

@@ -10,16 +10,22 @@ module Wikidata
     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
+      @value ||= begin
+        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'
+          if property_id == "P18" || (@property && @property.datatype == "commonsMedia")
+            Wikidata::DataValues::CommonsMedia.new({imagename: datavalue.value})
+          else
+            Wikidata::DataValues::String.new({string: datavalue.value})
+          end
+        else
+          datavalue
+        end
       end
     end
 

data/lib/wikidata/version.rb

@@ -1,3 +1,3 @@
 module Wikidata
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: wikidata
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Wil Gieseler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-08-24 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: activesupport
   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: 
@@ -144,7 +144,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -152,6 +152,7 @@ files:
 - bin/wikidata
 - lib/wikidata.rb
 - lib/wikidata/command_line.rb
+- lib/wikidata/datavalues/commons_media.rb
 - lib/wikidata/datavalues/entity.rb
 - lib/wikidata/datavalues/globecoordinate.rb
 - lib/wikidata/datavalues/string.rb
@@ -176,17 +177,17 @@ 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
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Ruby client for Wikidata