2.0.1

Key Changes

API & Nomenclature Alignment

• Renamed RelationshipAnswer → Relationship
• Renamed client methods:
  • get_relationship_answer(s)* → get_relationship(s)*
  • add_research_metric_answer / update_research_metric_answer → add_answer / update_answer
• Updated endpoints to /Relationships.json
• Updated datasets endpoints and filters to match upstream changes

Entity Enhancements

Topic

• Added hierarchy support (title, framework, family, parent, children)
• Parse children as an array of strings

Company

• Added legal and registry identifiers (LEI, ISIN, Wikidata, company numbers)
• Aligned attribute names with latest API fields

Source

• Allow initialization from either a String or full card hash
• Normalize string inputs into minimal Source card structures
• Improve robustness against mixed-format API responses

Client Improvements

• Refactored get_answers and get_relationships to:

  • Accept keyword arguments (metric_name, metric_designer, identifier)
  • Use a shared construct_endpoint helper

• Improved str_identifier and transform_to_wr_friendly_name handling

• Expanded endpoint params and filters (topics, frameworks, sorting, view, identifiers)

• Updated list endpoints (Companies, Metrics, Sources, ResearchGroups, CompanyGroups)

Documentation & Examples

• Updated examples and documentation to reflect new method signatures
• Improved clarity around identifier-based vs name-based queries
• Updated Topic-related examples (get_topic, get_topics)
• Refreshed Get Answers documentation with new filters and usage patterns

Tests & Maintenance

• Updated tests to reflect renamed entities and methods
• Fixed card type validation issues
• Minor refactors and cleanup
• Version bump included

First official release

First release of the ruby library for WikiRate's REST API. Supported functions:

get_company
get_companies
get_metric
get_metrics
get_answer
get_answers
get_relationship_answer
get_relationship_answers
get_source
get_sources
get_project
get_projects
get_topic
get_topics
get_research_group
get_research_groups
get_company_group
get_company_groups
get_regions
add_company
add_research_metric_answer
update_research_metric_answer
add_relationship_metric_answer
update_relationship_metric_answer
add_source
update_source