renshuu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 182e63b036401b107a66bf329425dd16dbc35ae63dc0326996ccae79ee95484c
+  data.tar.gz: 2ffe79bf4e6a7d9e22bf15cfe698b88b441a1ef7cfc185e4ee93d0438555ff59
+SHA512:
+  metadata.gz: b480fa63633cdb81180c5703204b8867efa75903f5e9d197df99979064a2fffd5eb314ab01cece8c237dd4cd4826de58d2dd3cbd18700ff0683208b4d869250e
+  data.tar.gz: 0dbf167eb256825633f0cb9069997042e80869e3e58eacb7b42f8cfd25db7cc015e8e356f834d4b586a59239981805481ab4f8d7ec06b85c9240e3a7f83c22c4

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+---
+plugins:
+  - rubocop-factory_bot
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+
+Layout/LineLength:
+  Max: 80
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+RSpec/ExampleLength:
+  Max: 10
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+RSpec/NestedGroups:
+  Max: 4
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - spec/renshuu/models/*_spec.rb

data/.ruby-version

@@ -0,0 +1 @@
+3.3

data/.vscode/templates.code-snippets

@@ -0,0 +1,29 @@
+{
+	// Place your listenbrainz workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
+	// Placeholders with the same ids are connected.
+	// Example:
+	// "Print to console": {
+	// 	"scope": "javascript,typescript",
+	// 	"prefix": "log",
+	// 	"body": [
+	// 		"console.log('$1');",
+	// 		"$2"
+	// 	],
+	// 	"description": "Log output to console"
+	// }
+	"Ruby template file": {
+		"isFileTemplate": true,
+		"scope": "ruby",
+		"prefix": "rubyTemplate",
+		"body": [
+			"# frozen_string_literal: true",
+			"",
+			"$0"
+		],
+		"description": "Ruby template"
+	}
+}

data/.yardopts

@@ -0,0 +1 @@
+--private

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [0.1.0] - 2025-07-31
+
+### Added
+
+- Initial release
+- User profile
+- Kanji dictionary and lookup

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Guardfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+  notification :off
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :yard, server: false do
+  watch(%r{lib/.+\.rb})
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Richard Degenne
+
+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,104 @@
+# Renshuu
+
+Ruby wrapper for [Renshuu], the Japanese learning platform.
+
+[Renshuu]: https://renshuu.org
+
+## Installation
+
+```bash
+bundle add renshuu
+```
+
+If Bundler is not being used to manage dependencies, install the gem by
+executing:
+
+```bash
+gem install renshuu
+```
+
+## Usage
+
+### Configuration
+
+The Renshuu gem can be configured either through environment variables or
+programmatically.
+
+#### Environment variables
+
+| Name | Default | Description |
+|------|---------|-------------|
+| `RENSHUU_API_URL` | `https://api.renshuu.org` | URL to the Renshuu API |
+| `RENSHUU_API_KEY` | Required | Used for authentication. You can find your user token on [Renshuu's API page][renshuu-api]. |
+
+[renshuu-api]: https://www.renshuu.org/index.php?page=misc/api
+
+#### Programmatically
+
+```ruby
+Renshuu.configure do |config|
+  config.api_url = '<CUSTOM_RENSHUU_URL>'
+  config.api_key = '<API_KEY>'
+end
+```
+
+### User profile
+
+```ruby
+# Retrieves the user profile associated with the configured API key.
+Renshuu::Profile.get
+```
+
+### Kanji dictionary
+
+```ruby
+# Searches the kanji dictionary
+Renshuu::Kanji.search('eat')
+Renshuu::Kanji.search('taberu')
+Renshuu::Kanji.search('たべる')
+
+# Retrieves a kanji from Renshuu's kanji dictionary
+Renshuu::Kanji.get('紅')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rake spec` 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`.
+
+### Visual Studio Code workspace
+
+The `renshuu.code-workspace` file contains recommended settings and extensions
+to work with Visual Studio Code. Open the workspace by running `code
+renshuu.code-workspace`.
+
+### Hot test runs
+
+The development dependencies include [Guard][guard] to run tests and generate
+documentation whenever you edit a file.
+
+[guard]: https://github.com/guard/guard
+
+Run `bundle exec guard` to start watching.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at
+<https://gitlab.com/Richard-Degenne/renshuu>. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [code of conduct].
+
+[code of conduct]: https://gitlab.com/Richard-Degenne/renshuu/blob/master/CODE_OF_CONDUCT.md
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Renshuu project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of conduct].

data/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+# RSpec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# Rubocop
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+# Yard
+require 'yard'
+YARD::Rake::YardocTask.new do |yard|
+  yard.files = ['-', 'CHANGELOG.md']
+end
+
+task default: %i[spec rubocop yard]

data/lib/renshuu/client.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # HTTP client for the Renshuu API.
+  class Client
+    ##
+    # @param [Configuration] configuration
+    def initialize(configuration = Renshuu.configuration)
+      @configuration = configuration
+    end
+
+    ##
+    # @return [Configuration]
+    attr_reader :configuration
+
+    ##
+    # @param [Symbol] method
+    # @param [String] path
+    # @param [Hash{Symbol, String => Object}] params
+    #
+    # @return [Hash{Symbol => Object}, Array]
+    def query(method, path, params: {})
+      httpx.request(method, path, params:)
+        .raise_for_status.json(symbolize_names: true)
+    end
+
+    private
+
+    ##
+    # @return [HTTPX::Session]
+    def httpx
+      @httpx ||= HTTPX.with(
+        origin: configuration.api_url,
+        headers: { authorization: "Bearer #{configuration.api_key}" }
+      )
+    end
+  end
+end

data/lib/renshuu/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Configuraiton object for the library.
+  class Configuration
+    ##
+    # URL of the Renshuu API.
+    #
+    # @return [URI]
+    def api_url
+      @api_url ||= URI('https://api.renshuu.org')
+    end
+
+    ##
+    # Sets the API URL.
+    #
+    # @param [URI, String] new_url
+    def api_url=(new_url)
+      @api_url = new_url && URI(new_url)
+    end
+
+    ##
+    # @return [String, nil]
+    attr_accessor :api_key
+  end
+end

data/lib/renshuu/models/kanji.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for kanji.
+  #
+  # @see https://api.renshuu.org/docs/#/Kanji
+  class Kanji < Model
+    ##
+    # Searches the Renshuu kanji dictionary.
+    #
+    # @param [String] value
+    #
+    # @return [Array<Kanji>]
+    def self.search(value)
+      body = Renshuu.client.query(:get, 'v1/kanji/search', params: { value: })
+
+      body.fetch(:kanjis).map { Kanji.new(_1) }
+    end
+
+    ##
+    # Retrieves a kanji from Renshuu's dictionary.
+    #
+    # @param [String] character
+    #
+    # @return [Kanji]
+    def self.get(character)
+      cgi_character = CGI.escape(character)
+      body = Renshuu.client.query(:get, "v1/kanji/#{cgi_character}")
+      new(body)
+    end
+  end
+end

data/lib/renshuu/models/model.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Base class for model objects.
+  class Model < RecursiveOpenStruct
+    ##
+    # Default options for new objects.
+    #
+    # @return [Hash{Symbol => Object}]
+    def self.default_options
+      super.merge(raise_on_missing: true, recurse_over_arrays: true)
+    end
+  end
+end

data/lib/renshuu/models/profile.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Model class for user profiles.
+  #
+  # @see https://api.renshuu.org/docs/#/User
+  class Profile < Model
+    ##
+    # @return [Profile]
+    def self.get
+      body = Renshuu.client.query(:get, 'v1/profile')
+      new(body)
+    end
+  end
+end

data/lib/renshuu/models.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Renshuu # rubocop:disable Style/Documentation
+end
+
+# Base class
+require_relative 'models/model'
+
+# Other models
+require_relative 'models/kanji'
+require_relative 'models/profile'

data/lib/renshuu/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Renshuu
+  ##
+  # Semantic version number of the library.
+  VERSION = '0.1.0'
+end

data/lib/renshuu.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# External requires
+require 'httpx'
+require 'recursive-open-struct'
+require 'uri'
+
+# Pre-module requires
+require_relative 'renshuu/configuration'
+require_relative 'renshuu/version'
+
+##
+# Top-level module of the library.
+module Renshuu
+  class << self
+    ##
+    # @return [Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    ##
+    # @yieldparam [Configuration] configuration
+    def configure
+      yield configuration
+    end
+
+    ##
+    # @return [Client]
+    def client
+      @client ||= Client.new
+    end
+
+    ##
+    # Updates the configuration according to environment variables.
+    #
+    # * +RENSHUU_API_URL+;
+    # * +RENSHUU_API_KEY+.
+    #
+    # @return [Void]
+    def configure_from_env
+      configuration.api_url = ENV.fetch('RENSHUU_API_URL', nil)
+      configuration.api_key = ENV.fetch('RENSHUU_API_KEY', nil)
+    end
+  end
+
+  configure_from_env
+end
+
+# Local requires
+require_relative 'renshuu/client'
+require_relative 'renshuu/models'

data/renshuu.code-workspace

@@ -0,0 +1,24 @@
+// spell-checker:disable
+
+{
+  "folders": [
+    {
+      "path": "."
+    }
+  ],
+  "extensions": {
+    "recommendations": [
+      "shopify.ruby-lsp",
+      "davidanson.vscode-markdownlint",
+      "streetsidesoftware.code-spell-checker"
+    ]
+  },
+  "settings": {
+    "editor.rulers": [
+      80
+    ],
+    "cSpell.words": [
+      "renshuu"
+    ]
+  }
+}

data/sample.env

@@ -0,0 +1,5 @@
+# Custom Renshuu API URL, if necessary
+# RENSHUU_API_URL=https://api.renshuu.org
+
+# Renshuu API key, available at https://www.renshuu.org/index.php?page=misc/api
+RENSHUU_API_KEY=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: renshuu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Degenne
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Ruby wrapper for the Renshuu API.
+email:
+- hello@richarddegenne.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/templates.code-snippets"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/renshuu.rb
+- lib/renshuu/client.rb
+- lib/renshuu/configuration.rb
+- lib/renshuu/models.rb
+- lib/renshuu/models/kanji.rb
+- lib/renshuu/models/model.rb
+- lib/renshuu/models/profile.rb
+- lib/renshuu/version.rb
+- renshuu.code-workspace
+- sample.env
+homepage: https://gitlab.com/Richard-Degenne/renshuu
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitlab.com/Richard-Degenne/renshuu/issues
+  changelog_uri: https://gitlab.com/Richard-Degenne/renshuu/-/blob/master/CHANGELOG.md
+  documentation_uri: https://renshuu.richarddegenne.fr
+  funding_uri: https://ko-fi.com/richarddegenne
+  homepage_uri: https://gitlab.com/Richard-Degenne/renshuu
+  source_code_uri: https://gitlab.com/Richard-Degenne/renshuu
+  rubygems_mfa_required: 'false'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the Renshuu API.
+test_files: []