wikidatum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5aa9e8eb9fccc24e9c423dcba185ef7550ad465426f90c57128968e06e99d51
+  data.tar.gz: 19fc905557859d97d1e604155d08d56d416eb332d6f285246c5354bdc1f024a9
+SHA512:
+  metadata.gz: 6ee9f49ee6689d953f308a9e2f4deaad71226080f70bf6fe3d7f375ac86bbd887e3494d50eed06b96308e6965165c86596fc7dae6abbdf2367e5f4302e49d73a
+  data.tar.gz: 4147886d03d2f17e2743d0b9309a22e278cbe2e0febb95acc77dbdebeb30319058b1cb33f2b142d0f1f0c84858fa3d59b40039492ff393b89fa19f04e516f54b

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Unreleased
+
+## 0.1.0 - 2022-06-20
+### Added
+
+- Initial release, nothing is really usable yet.
+

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wikidatum.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'minitest', '~> 5.16'
+gem 'rubocop', '~> 1.30'
+gem 'yard', '~> 0.9'

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    wikidatum (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.16.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.16)
+  rake (~> 13.0)
+  rubocop (~> 1.30)
+  wikidatum!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.3.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Connor Shea
+
+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,39 @@
+# Wikidatum
+
+This gem will support making requests with the [new Wikidata/Wikibase REST API](https://doc.wikimedia.org/Wikibase/master/js/rest-api/).
+
+**Currently it is in very early development and is not ready for actual usage**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wikidatum'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wikidatum
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/connorshea/wikidatum.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "wikidatum"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wikidatum/client.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class Wikidatum::Client
+  # @return [String] The root URL of the Wikibase instance we want to interact
+  #                  with. If not provided, will default to Wikidata.
+  attr_reader :wikibase_url
+
+  # @return [Boolean] Whether this client instance should identify itself
+  #                   as a bot when making requests.
+  attr_reader :bot
+
+  # @param wikibase_url [String] The root URL of the Wikibase instance we want
+  #                              to interact with. If not provided, will
+  #                              default to Wikidata.
+  # @param bot [Boolean] Whether requests sent by this client instance should
+  #                      be registered as bot requests.
+  # @return [Wikidatum::Client]
+  def initialize(wikibase_url: 'https://www.wikidata.org', bot: true)
+    @wikibase_url = wikibase_url
+    @bot = bot
+  end
+end

data/lib/wikidatum/item.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+class Wikidatum::Item
+  # @!visibility private
+  #
+  # @param labels [Array<Wikidatum::Term>] An array of {Wikidatum::Term}s representing labels for this item.
+  # @param descriptions [Array<Wikidatum::Term>] An array of {Wikidatum::Term}s representing descriptions for this item.
+  # @param aliases [Array<Wikidatum::Term>] An array of {Wikidatum::Term}s representing aliases for this item.
+  # @param statements [Array<Wikidatum::Statement>] Statements for this item.
+  # @param sitelinks [Array<Wikidatum::Sitelink>] Sitelinks for this item.
+  # @return [Wikidatum::Item]
+  def initialize(labels:, descriptions:, aliases:, statements:, sitelinks:)
+    @labels = labels
+    @descriptions = descriptions
+    @aliases = aliases
+    @statements = statements
+    @sitelinks = sitelinks
+  end
+
+  # @param property [String] Wikidata property, in the format of 'P123'. If unspecified, will return all statements for the item.
+  # @return [Array<Wikidatum::Statement>]
+  def statements(property: nil)
+    return @statements if property.nil?
+
+    # TODO
+    @statements
+  end
+
+  # @param lang [String, Symbol]
+  # @return [Wikidatum::Term, nil]
+  def label(lang:)
+    @labels.find { |label| label.lang == lang.to_s }
+  end
+
+  # @param langs [Array<String, Symbol>]
+  # @return [Array<Wikidatum::Term>]
+  def labels(langs: [])
+    return @labels if langs.empty?
+
+    langs.map!(&:to_s)
+    @labels.filter { |label| langs.include?(label.lang) }
+  end
+
+  # @param lang [String, Symbol]
+  # @return [Wikidatum::Term, nil]
+  def description(lang:)
+    @descriptions.find { |desc| desc.lang == lang.to_s }
+  end
+
+  # @param langs [Array<String, Symbol>]
+  # @return [Array<Wikidatum::Term>]
+  def descriptions(langs: [])
+    return @descriptions if langs.empty?
+
+    langs.map!(&:to_s)
+    @descriptions.filter { |desc| langs.include?(desc.lang) }
+  end
+
+  # @param langs [Array<Symbol, String>] If unspecified, will return all aliases for all languages.
+  # @return [Array<Wikidatum::Term>]
+  def aliases(langs: [])
+    return @aliases if langs.empty?
+
+    langs.map!(&:to_s)
+    @aliases.filter { |al| langs.include?(al.lang) }
+  end
+
+  # Get a specific sitelink based on its shortcode.
+  #
+  # @example
+  #   item.sitelink(site: 'enwiki')
+  # @example Using a symbol key
+  #   item.sitelink(site: :enwiki)
+  #
+  # @param site [String, Symbol] The shortcode for the sitelink you want to access, e.g. 'enwiki' or 'commons'. Can be a string or a symbol.
+  # @return [Wikidatum::Sitelink, nil]
+  def sitelink(site:)
+    @sitelinks.find { |sitelink| sitelink.site == site.to_s }
+  end
+
+  # Get the sitelinks on the item.
+  #
+  # @example Getting all sitelinks for the item.
+  #   item.sitelinks
+  # @example Getting only a few specific sitelinks.
+  #   item.sitelink(sites: ['enwiki', 'eswiki', 'commons'])
+  #
+  # @param sites [Array<String, Symbol>] An array of sitelink shortcodes to return (e.g. ['enwiki', 'eswiki']), if not provided then all sitelinks will be returned.
+  # @return [Array<Wikidatum::Sitelink>]
+  def sitelinks(sites: [])
+    return @sitelinks if sites.empty?
+
+    sites.map!(&:to_s)
+    @sitelinks.filter { |sitelink| sites.include?(sitelink.site) }
+  end
+end

data/lib/wikidatum/qualifier.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Wikidatum::Qualifier
+end

data/lib/wikidatum/reference.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Wikidatum::Reference
+end

data/lib/wikidatum/sitelink.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Wikidatum::Sitelinks represent associated sitelinks on a Wikidata item.
+class Wikidatum::Sitelink
+  # @return [String]
+  attr_reader :site
+
+  # @return [String]
+  attr_reader :title
+
+  # @return [Array<String>]
+  attr_reader :badges
+
+  # @!visibility private
+  #
+  # @param site [String, Symbol] The shortcode for the given site (e.g. 'enwiki', 'commons', etc.), can be either a string or a symbol.
+  # @param title [String] The title of the page in the associated Wikimedia site.
+  # @param badges [Array<String>] An array of badge names, optional.
+  # @return [Wikidatum::Sitelink]
+  def initialize(site:, title:, badges: [])
+    @site = site.to_s
+    @title = title
+    @badges = badges
+  end
+end

data/lib/wikidatum/snak.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Wikidatum::Snak
+end

data/lib/wikidatum/statement.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Wikidatum::Statement
+end

data/lib/wikidatum/term.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Wikidatum::Term represents "Terms", which are pairs of language codes and
+# values. They're used for things like item labels, descriptions, and aliases.
+class Wikidatum::Term
+  # @return [String]
+  attr_reader :lang
+
+  # @return [String]
+  attr_reader :value
+
+  # @!visibility private
+  #
+  # @param lang [String, Symbol] A language code ('en', 'zh-mo', etc), can be a symbol or a string.
+  # @param value [String] The value of the term.
+  # @return [Wikidatum::Term]
+  def initialize(lang:, value:)
+    @lang = lang.to_s
+    @value = value
+  end
+end

data/lib/wikidatum/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Wikidatum
+  VERSION = '0.1.0'
+end

data/lib/wikidatum.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'wikidatum/client'
+require_relative 'wikidatum/item'
+require_relative 'wikidatum/qualifier'
+require_relative 'wikidatum/reference'
+require_relative 'wikidatum/snak'
+require_relative 'wikidatum/statement'
+require_relative 'wikidatum/term'
+require_relative 'wikidatum/version'
+
+module Wikidatum
+  class Error < StandardError; end
+end

data/wikidatum.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/wikidatum/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "wikidatum"
+  spec.version = Wikidatum::VERSION
+  spec.authors = ["Connor Shea"]
+  spec.email = ["connor.james.shea+rubygems@gmail.com"]
+
+  spec.summary = "Ruby gem for the new Wikidata REST API."
+  spec.description = "Interact with the Wikidata/Wikibase REST API from Ruby."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = "https://github.com/connorshea/wikidatum"
+  spec.metadata["source_code_uri"] = "https://github.com/connorshea/wikidatum"
+  spec.metadata["changelog_uri"] = "https://github.com/connorshea/wikidatum/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|))})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: wikidatum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Connor Shea
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-20 00:00:00.000000000 Z
+dependencies: []
+description: Interact with the Wikidata/Wikibase REST API from Ruby.
+email:
+- connor.james.shea+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wikidatum.rb
+- lib/wikidatum/client.rb
+- lib/wikidatum/item.rb
+- lib/wikidatum/qualifier.rb
+- lib/wikidatum/reference.rb
+- lib/wikidatum/sitelink.rb
+- lib/wikidatum/snak.rb
+- lib/wikidatum/statement.rb
+- lib/wikidatum/term.rb
+- lib/wikidatum/version.rb
+- wikidatum.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/connorshea/wikidatum
+  source_code_uri: https://github.com/connorshea/wikidatum
+  changelog_uri: https://github.com/connorshea/wikidatum/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Ruby gem for the new Wikidata REST API.
+test_files: []