wikimelon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e0c68c9927e39f872a5570907ac9b9a4ca43c792b322feb95c18c7e71fe188
-  data.tar.gz: 4838097e4e1bbceab2c099ed10249880fd0cb7dd3544e41c929a7dc61efccc7e
+  metadata.gz: 677a3d97dca869666cc396285f938cb8c7031a8a1a0069509a19c4da03674cc1
+  data.tar.gz: 5ef0d3e678a81524ec039ae5ad1ef195fcd6d8c99f99409b664a912763a0d935
 SHA512:
-  metadata.gz: 42240519777be349015be2d74361e5fd35720c15197bf1446758651bf0255205cf0afd8e88327d7dc10ff6813c88ffb54b36691d16d216c0549792dcf409e11d
-  data.tar.gz: f3fed8067a8f116aa464562047552ea2f382d07d336848920ae5a35d01882c479fcc5c64c1201c58c53ad7dd6148eb1e83ab84ed058f49920763c1b896081b8c
+  metadata.gz: f5355abc87792d30d7a83095ed7c03af7ccab2fb8bc582b72112cc93982d46ac054ad14f9a6ca986246fecd92e78dd13b2408ce443cead076501686222e6adc6
+  data.tar.gz: 55853e53bc9287a429a413de4dc030d5e94d3efddc37feadae5a4f481a6d2ecae38577acfc3b45848a590b2cd44f6f81d6f57af1bdc3856796f1f7f337030b54

data/.gitignore

@@ -1,3 +1,4 @@
+.byebug_history
 .idea
 /.bundle/
 /.yardoc

data/CHANGELOG.md

@@ -1,11 +1,7 @@
 ## [Unreleased]
- - Updated license from NCSA to MIT
+ 
+## [0.0.2] - 2025-03-06
+- Added entity endpoint
 
-## [0.1.1] - 2024-09-11
- - Updated documentation
- - Removed Gemfile.lock
- - Bumped development depency versions to avoid CVE-2024-43398
-
-## [0.1.0] - 2022-01-20
-
-- Initial release
+## [0.0.1] - 2025-03-04
+- Initial release wrapping the SPARQL query endpoint

data/Gemfile

@@ -7,4 +7,4 @@ gemspec
 
 gem "rake", "~> 13.0"
 
-gem "minitest", "~> 5.0"
+gem "minitest", "~> 5.0"

data/README.md

@@ -1,6 +1,6 @@
 # Wikimelon
 
-Wikimelon is a Ruby wrapper on the [Wikidata](https://wikidata.org) API. Code follow the spirit/approach of the Gem [serrano](https://github.com/sckott/serrano), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).
+Wikimelon is a lightweight Ruby wrapper on the [Wikidata](https://wikidata.org) API. Code follow the spirit/approach of the Gem [serrano](https://github.com/sckott/serrano), and indeed much of the wrapping utility is copied 1:1 from that repo, thanks [@sckott](https://github.com/sckott).
 
 ## Installation
 
@@ -25,16 +25,36 @@ Or install it yourself as:
 ### Queries
 Run a Wikidata query:
 ```ruby
-query = """
+query = "
 SELECT ?human ?humanLabel ?zoobank WHERE {
   ?human wdt:P31 wd:Q5.
   ?human wdt:P2006 ?zoobank.
   SERVICE wikibase:label { bd:serviceParam wikibase:language "[AUTO_LANGUAGE],en". }
 } LIMIT 100 OFFSET 0
-"""
+"
 Wikimelon.query(query) #  => MultiJson object
 ```
 
+---
+### Entities
+Fetch data on an item:
+```ruby
+entity_id = "Q13"
+Wikimelon.entity(entity_id) #  => MultiJson object
+```
+
+Fetch data on a property:
+```ruby
+entity_id = "P31"
+Wikimelon.entity(entity_id) #  => MultiJson object
+```
+
+Fetch data on an entity with a specific revision ID:
+```ruby
+entity_id = "Q13"
+Wikimelon.entity(entity_id, revision_id: 109) #  => MultiJson object
+```
+
 ---
 
 ## Development

data/lib/wikimelon/request.rb

@@ -12,7 +12,7 @@ module Wikimelon
     attr_accessor :options
 
     def initialize(**args)
-      @endpoint = args[:endpoint]
+      @url = args[:url]
       @verbose = args[:verbose]
       @query = args[:query]
       @limit = args[:limit]
@@ -27,17 +27,10 @@ module Wikimelon
 
       Faraday::Utils.default_space_encoding = "+"
 
-      conn = if verbose
-               Faraday.new(url: Wikimelon.base_url) do |f|
-                 f.response :logger
-                 f.use Faraday::WikimelonErrors::Middleware
-                 f.adapter Faraday.default_adapter
-               end
-             else
-               Faraday.new(url: Wikimelon.base_url) do |f|
-                 f.use Faraday::WikimelonErrors::Middleware
-                 f.adapter Faraday.default_adapter
-               end
+      conn = Faraday.new(url: @url) do |f|
+              f.response :logger if verbose
+              f.use Faraday::WikimelonErrors::Middleware
+              f.adapter Faraday.default_adapter
              end
 
       conn.headers['Accept'] = 'application/json,*/*'

data/lib/wikimelon/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wikimelon
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/wikimelon.rb

@@ -9,10 +9,9 @@ require "wikimelon/helpers/configuration"
 module Wikimelon
   extend Configuration
 
-  define_setting :base_url, "https://query.wikidata.org/sparql"
   define_setting :mailto, ENV["WIKIMELON_API_EMAIL"]
 
-  # Run a Wikidata query
+  # Run a Wikidata SPARQL query
   #
   # @param query [String] a Wikidata query
   #
@@ -21,9 +20,27 @@ module Wikimelon
   # @return [Array, Boolean] An array of hashes
   def self.query(query, verbose: false)
     Request.new(
-      endpoint: "",
+      url: "https://query.wikidata.org/sparql",
       query: query,
       verbose: verbose
     ).perform
   end
+
+
+  # Get Wikidata entity data
+  #
+  # @param entity_id [String] a Wikidata entity ID
+  # @param revision_id [int] a revision ID
+  #
+  # @param verbose [Boolean] Print headers to STDOUT
+  #
+  # @return [Array, Boolean] An array of hashes
+  def self.entity(entity_id, revision_id: nil, verbose: false)
+    url = "https://www.wikidata.org/wiki/Special:EntityData/#{entity_id}.json"
+    url = "#{url}?revision=#{revision_id}" unless revision_id.nil?
+    Request.new(
+      url: url,
+      verbose: verbose
+    ).perform
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikimelon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Geoff Ower, Matt Yoder
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,7 +197,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/SpeciesFileGroup/wikimelon
   source_code_uri: https://github.com/SpeciesFileGroup/wikimelon
-  changelog_uri: https://github.com/SpeciesFileGroup/wikimelon/releases/tag/v0.0.1
+  changelog_uri: https://github.com/SpeciesFileGroup/wikimelon/releases/tag/v0.0.2
 post_install_message:
 rdoc_options: []
 require_paths: