mediawiki_api-wikidata 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmU1ZmNjZWI2OGQ0Njc3OWU5MzA2NTQwM2JjYmE0NjExMzhkNjVkYg==
+    MzQzYTUzZTM1ZTAxZGRlMWFiZDc0ODYwNWZkZWZlMjBmOTQ4ZWUzYg==
   data.tar.gz: !binary |-
-    NGNhYzBmMjNmZTc4ODBiN2RjMzdjMTZlZmQ1NmFlNWZmMTkzZjUyZQ==
+    YTEzNjNiZTBkOWE4ZGFjNjQzZTJlMmY4ZWI2ZjlmY2Q2MTZjYWI5ZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YmEzZmYyNjJiNjQwMmZkOGU3N2NhZWMwMDg2ODc1NjhkNWQ4NzJkZTM4ZjBm
-    YTc2ZTI4MTI2ODc0OWRlYzQyNmQ0NTkyMDMzNTQ5NGY5MzcyN2VhMmIzOGZi
-    MWYzODUzNThhN2ZiYzI4YmYxYjE5YTE4NWI1Y2U0NTI0YjgwN2E=
+    OTFkMzM3MTk5NDViY2MwZmQzNjc5OTA0ODdkM2FiNTg2OWRkZGNkYmYzM2E2
+    NjEyNTIyZTQ5N2IwNDE5YTlkOGRiYmZhZTcwNTQwZWUxMmMwNDBiZGY0YTk1
+    OGJlY2Q5OGZmN2VjZThjMWEwNjRmYmNmYjVkYTBlZWJmN2Q4M2Y=
   data.tar.gz: !binary |-
-    MjA4MGU4MDk0OTE5YmViMzZmOGU1OWRhMGY2ZWUzNTAyNTkyMDg5MzcyMmNl
-    ZTUzZjY5NTVjNDZiZDI4NjI1ZDQ4NjFhMTI1ZDkzMTZhYzc0NzQ0ZTQ2ZGI1
-    NDRhZmRkMTY5MDM5YjVjMTlmY2E1MmI1YjE4MzkxODRhNTA5NTU=
+    MTNjZGU0NWQ3YTgxYWMzZDEwYmZmZTRkZDdkZWIwNDY2MmMyMWQzYzE0OTZi
+    NjI0M2M5ZDJjNDFmYjljMzE3YWE0OTBhYTkzY2FjZTk4YzY4NmFmZWU5ZTky
+    MmFiNmM4ZTE0ZmVjZGRmYThlY2UzZGZhODE3MzE5YWU5YWQ4YWU=

data/README.md

@@ -31,6 +31,15 @@ wikidata_client.create_entity "data" #create a new item specified by "data"
 
 ## Release notes
 
+### 0.0.2 (2014-10-09)
+
+- support adding sitelinks
+- support changing sitelinks
+- support removing sitelinks
+- support checking for existing sitelinks
+- provide separate methods for creating items and properties
+- removed custom edit summaries
+
 ### 0.0.1 (2014-09-29)
 
 - Initial version

data/lib/mediawiki_api/wikidata/exceptions.rb

@@ -0,0 +1,10 @@
+module MediawikiApi
+  module Wikidata
+    class WikidataApiError < ApiError
+
+    end
+
+    class EntityIdentifierMismatchError < StandardError
+    end
+  end
+end

data/lib/mediawiki_api/wikidata/version.rb

@@ -1,5 +1,5 @@
 module MediawikiApi
   module Wikidata
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/mediawiki_api/wikidata/wikidata_client.rb

@@ -2,13 +2,52 @@
 # License:: GNU GPL v2+
 
 require "mediawiki_api/wikidata/version"
+require "mediawiki_api/wikidata/exceptions"
 
 module MediawikiApi
   module Wikidata
     class WikidataClient < Client
 
-      def create_entity(data, type = "item")
-        action(:wbeditentity, token_type: "edit", new: type, data: data, summary:"Created entity using mediawiki_api/wikidata gem")
+      def create_entity(entity_data, type)
+        action(:wbeditentity, token_type: "edit", new: type, data: entity_data)
+      end
+
+      def create_item(item_data)
+        create_entity(item_data, "item")
+      end
+
+      def create_property(property_data)
+        create_entity(property_data, "property")
+      end
+
+      def set_sitelink(entity_identifier, sitelink_site_id, sitelink_title = nil, badges = nil)
+        params = { token_type: "edit", linksite: sitelink_site_id, linktitle: sitelink_title, badges: badges}
+        action(:wbsetsitelink, params.merge(parse_entity_identifier(entity_identifier)))
+      end
+
+      def add_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges = nil)
+        set_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges)
+      end
+
+      def remove_sitelink(entity_identifier, sitelink_site_id)
+        set_sitelink(entity_identifier, sitelink_site_id)
+      end
+
+      def sitelink_exists?(site_id, title)
+        resp = action(:wbgetentities, token_type: "edit", sites: [site_id], titles: [title] )
+        !resp.data["entities"]["-1"]
+      end
+
+      private
+
+      def parse_entity_identifier(identifier)
+        if identifier.is_a?(::Hash)
+          { site: identifier[:site_id], title: identifier[:title] }
+        elsif identifier.is_a?(String)
+          { id: identifier }
+        else
+          raise EntityIdentifierMismatchError, "Either entity id or site id and page title need to be set to identify the entity."
+        end
       end
 
     end

data/spec/wikidata_client_spec.rb

@@ -12,14 +12,115 @@ describe MediawikiApi::Wikidata::WikidataClient do
   describe "#create_entity" do
     subject { client.create_entity(data, type) }
 
-    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},"descriptions":{"en":{"language":"en","value":"test_description"}}}' }
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}}}' }
     let(:type) { "item" }
-    let(:summary) { "Created entity using mediawiki_api/wikidata gem" }
     let(:response) { {} }
 
     before do
       stub_token_request(:edit)
-      @edit_request = stub_action_request(:wbeditentity, data: data, new: type, summary: summary).
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: type).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_item" do
+    subject { client.create_item(data) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}}}' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: "item").
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_property" do
+    subject { client.create_property(data) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}},"datatype":"string"}' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: "property").
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#create_property" do
+    subject { client.create_property(data) }
+
+    let(:data) { '{"labels":{"en":{"language":"en","value":"test_label"}},
+                   "descriptions":{"en":{"language":"en","value":"test_description"}},"datatype":"string"}' }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:wbeditentity, data: data, new: "property").
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#set_sitelink (item identified by site/title)" do
+    subject { client.set_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges) }
+
+    let(:entity_identifier) { {site_id: "dewiki", title: "Berlin"} }
+    let(:sitelink_site_id) { "itwiki" }
+    let(:sitelink_title) { "Berlino" }
+    let(:badges) { nil }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:wbsetsitelink, site: "dewiki", title: "Berlin", linksite: sitelink_site_id,
+                                          linktitle: sitelink_title, badges: badges).
+          to_return(body: response.to_json)
+    end
+
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+  end
+
+  describe "#set_sitelink (item identified by ID)" do
+    subject { client.set_sitelink(entity_identifier, sitelink_site_id, sitelink_title, badges) }
+
+    let(:entity_identifier) { "Q1234" }
+    let(:sitelink_site_id) { "itwiki" }
+    let(:sitelink_title) { "Berlino" }
+    let(:badges) { nil }
+    let(:response) { {} }
+
+    before do
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:wbsetsitelink, id: "Q1234", linksite: sitelink_site_id,
+                                          linktitle: sitelink_title, badges: badges).
           to_return(body: response.to_json)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api-wikidata
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tobias Gritschacher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mediawiki_api
@@ -134,6 +134,7 @@ files:
 - LICENCE
 - README.md
 - lib/mediawiki_api/wikidata.rb
+- lib/mediawiki_api/wikidata/exceptions.rb
 - lib/mediawiki_api/wikidata/version.rb
 - lib/mediawiki_api/wikidata/wikidata_client.rb
 - mediawiki_api-wikidata.gemspec