listenbrainz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa91d4869adbba2530463a1a70dac945046de4f49701cda50e28fd3d87c243bb
+  data.tar.gz: 921fbcd3b84c5cb3212fc713c8662f31a216784d6c874b5fddba0527c67f5a5b
+SHA512:
+  metadata.gz: 6c32fdddb83cff2bbbcd74f36904ae4d8869cf5718cd4c05f0c6313afa9532b485b888965b828c72660a79316540ccecd670932aa9d30abc3d2ac4b63b47ff78
+  data.tar.gz: 9b11e3008645817ba78d4d00aaa8322057e7d3da3dcfe4c842acdd44da3f46fa80a35b4e6e9f58c8e6be672281c70b6b289774fc0738a96c60748e4036c4b223

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.byebug_history
+/.env
+/.rspec_status
+/.yardoc
+/coverage/
+/doc/
+/pkg/
+/tmp/

data/.gitlab-ci.yml

@@ -0,0 +1,76 @@
+---
+stages:
+  - test
+  - release
+  - deploy
+
+spec:
+  stage: test
+  image: ruby:${RUBY_VERSION}
+  before_script:
+    - gem install bundler -v 2.4.19
+    - bundle config set --local path '.bundle'
+    - bundle install
+  script:
+    - bundle exec rake spec
+  coverage: '/Line Coverage: \d+.\d+\%/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/coverage.xml
+  cache:
+    paths:
+      - .bundle
+  parallel:
+    # FIXME: Matrices seem to break Cobertura from displaying.
+    matrix:
+      - RUBY_VERSION: ['3.2', '3.3', '3.4']
+
+.on-release:
+  rules:
+    # Only for tags, i.e. releases.
+    - if: $CI_COMMIT_TAG
+
+release:
+  extends:
+    - .on-release
+  stage: release
+  image: ruby:3.2
+  before_script:
+    - gem install bundler -v 2.4.19
+    - bundle config set --local path '.bundle'
+    - bundle install
+  script:
+    - bundle exec rake release:rubygem_push
+
+gitlab:
+  extends:
+    - .on-release
+  stage: deploy
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  script:
+    - echo "Creating GitLab release for $CI_COMMIT_TAG"
+  release:
+    tag_name: $CI_COMMIT_TAG
+    description: ./CHANGELOG.md
+    ref: '$CI_COMMIT_SHA'
+    assets:
+      links:
+        - name: RubyGems
+          url: https://rubygems.org/gems/listenbrainz/versions/$CI_COMMIT_TAG
+pages:
+  extends:
+    - .on-release
+  stage: deploy
+  image: ruby:3.2
+  before_script:
+    - gem install bundler -v 2.4.19
+    - bundle config set --local path '.bundle'
+    - bundle install
+  script:
+    - bundle exec rake yard
+  artifacts:
+    paths:
+      - doc
+  publish: doc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,33 @@
+---
+require:
+  - rubocop-factory_bot
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  DisplayCopNames: true
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/CaseIndentation:
+  EnforcedStyle: end
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+Layout/LineLength:
+  Max: 80
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+RSpec/ExampleLength:
+  Max: 10
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - spec/listenbrainz/models/**
+  CustomTransform:
+    ListenBrainz: listenbrainz
+

data/.ruby-version

@@ -0,0 +1 @@
+3.2

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/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][kac], and this project adheres to
+[Semantic Versioning][semver].
+
+[kac]: https://keepachangelog.com/en/1.1.0/
+[semver]: https://semver.org/spec/v2.0.0.html
+
+## [0.1.0] - 2025-01-31
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 hello@richarddegenne.fr. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at 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,142 @@
+# ListenBrainz
+
+A Ruby wrapper to the [ListenBrainz][lb] API.
+
+[lb]: https://listenbrainz.org
+
+[![pipeline status](https://gitlab.com/Richard-Degenne/listenbrainz/badges/dev/pipeline.svg)](https://gitlab.com/Richard-Degenne/listenbrainz/-/commits/dev)
+[![coverage report](https://gitlab.com/Richard-Degenne/listenbrainz/badges/dev/coverage.svg)](https://gitlab.com/Richard-Degenne/listenbrainz/-/commits/dev)
+[![Latest Release](https://gitlab.com/Richard-Degenne/listenbrainz/-/badges/release.svg)](https://gitlab.com/Richard-Degenne/listenbrainz/-/releases)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add listenbrainz
+```
+
+If bundler is not being used to manage dependencies, install the gem by
+executing:
+
+```bash
+gem install listenbrainz
+```
+
+## Usage
+
+### Configuration
+
+The ListenBrainz gem can be configured either through environment variables or
+programatically.
+
+#### Environment variables
+
+| Name | Default | Description |
+|------|---------|-------------|
+| `LISTENBRAINZ_API_ENDPOINT` | `https://api.listenbrainz.org` | URL to the ListenBrainz API |
+| `LISTENBRAINZ_USER_TOKEN` | Required | Used for authentication. You can find your user token on [ListenBrainz's settings page][lb-settings]. |
+
+[lb-settings]: https://listenbrainz.org/settings/
+
+#### Programatically
+
+```ruby
+ListenBrainz.configure do |config|
+  config.endpoint = '<CUSTOM_LISTENBRAINZ_URL>'
+  config.user_token = '<USER_TOKEN>'
+end
+```
+
+### Retrieving listens
+
+```ruby
+# Retrieve listens for the current user.
+ListenBrainz::Listen.get
+ListenBrainz::Listen.get(count: 10)
+
+# Retrieve listens for a different user
+ListenBrainz::Listen.get('Bobby')
+ListenBrainz::Listen.get('Bobby', count: 10)
+
+# Retrieve "Now playing" listens for the current user
+ListenBrainz::Listen.now_playing
+
+# Retrieve "Now playing" listens for a different user
+ListenBrainz::Listen.now_playing('Bobby')
+```
+
+### Submitting listens
+
+```ruby
+listen = ListenBrainz::Listen.new(
+  listened_at: Time.now,
+  track_metadata: {
+    artist_name: 'Joan Jett and the Blackhearts',
+    release_name: 'Sinner',
+    track_name: 'Naked',
+    additional_info: {
+      listening_from: 'Plex',
+      media_player: 'Plex',
+      track_mbid: '2b66948e-fd60-3312-a8cb-22fdecbc98b9'
+    }
+  }
+)
+
+# Submit a single listen
+listen.submit
+listen.submit(mode: :single)
+
+# Submit a "Now playing" listen
+listen.submit(mode: :playing_now)
+
+# Submit a batch of listens
+ListenBrainz::Listen.sumbit([listen])
+```
+
+## Documentation
+
+A complete YARD documentation is available below.
+
+<https://listenbrainz.richarddegenne.fr>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+### Visual Studio Code workspace
+
+The `listenbrainz.code-workspace` file contains recommended settings and
+extensions to work with Visual Studio Code. Open the workspace by running `code
+listenbrainz.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/listenbrainz>. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [code of conduct][coc].
+
+[coc]: https://gitlab.com/Richard-Degenne/listenbrainz/blob/master/CODE_OF_CONDUCT.md
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][mit].
+
+[mit]: https://opensource.org/licenses/MIT
+
+## Code of Conduct
+
+Everyone interacting in the ListenBrainz project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct][coc].

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+require 'yard'
+
+YARD::Rake::YardocTask.new
+
+task default: %i[spec rubocop yard]

data/lib/listenbrainz/client.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ListenBrainz
+  ##
+  # HTTP client for ListenBrainz.
+  class Client
+    ##
+    # @param [Configuration] configuration
+    def initialize(configuration = ListenBrainz.configuration)
+      @configuration = configuration
+    end
+
+    ##
+    # @return [Configuration]
+    attr_reader :configuration
+
+    ##
+    # Retrieves the username associated with the configured token.
+    #
+    # @return [String]
+    def username
+      @username ||= query(:get, '/1/validate-token').fetch(:user_name)
+    end
+
+    ##
+    # @param [String, Symbol] method
+    # @param [String] path
+    # @param [Hash{String, Symbol => Object}] params
+    # @param [Array, Hash, nil] json JSON object to be sent as a body
+    #
+    # @return [Array, Hash]
+    # @raise [HTTPX::Error]
+    def query(method, path, params: {}, json: nil)
+      httpx.request(method, path, params:, json:).raise_for_status
+        .json(symbolize_names: true)
+    end
+
+    private
+
+    ##
+    # @return [HTTPX::Session]
+    def httpx
+      @httpx ||= HTTPX.with(
+        origin: configuration.endpoint,
+        headers: { authorization: "Token #{configuration.user_token}" }
+      )
+    end
+  end
+end

data/lib/listenbrainz/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ListenBrainz
+  ##
+  # Stores configuration for the ListenBrainz gem
+  class Configuration
+    ##
+    # @return [URI]
+    def endpoint
+      @endpoint ||= URI('https://api.listenbrainz.org')
+    end
+
+    ##
+    # @param [String, URI, nil] new_endpoint
+    def endpoint=(new_endpoint)
+      @endpoint = new_endpoint && URI(new_endpoint)
+    end
+
+    ##
+    # @return [String, nil]
+    attr_accessor :user_token
+  end
+end

data/lib/listenbrainz/models/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ListenBrainz
+  ##
+  # Base class for ListenBrainz models.
+  class Base < Dry::Struct
+    ##
+    # Returns the model as a ListenBrainz JSON object.
+    #
+    # @return [Hash{Symbol => Object}]
+    def as_json
+      attributes.transform_values do |value|
+        case value
+        when Array
+          value.map { |item| item.try(:as_json) || item }
+        when Time
+          # HACK: ListenBrainz expects timestamps as Unix timestamps.
+          #
+          # TODO: Embed this in the `Types::Timestamp` class and use
+          #       introspection here instead?
+          value.to_i
+        else
+          value.try(:as_json) || value
+        end
+      end
+    end
+  end
+end

data/lib/listenbrainz/models/listen.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module ListenBrainz
+  ##
+  # Model class for listens.
+  #
+  # @see https://rain0r.github.io/listenbrainz-openapi/index.html#/lbCore/listensForUser
+  class Listen < Base
+    ##
+    # Retrieves listens for a given user.
+    #
+    # @param [String] username
+    # @param [Integer, nil] count Number of listens to retrieve
+    # @param [Time, Integer, nil] before Only retrieve listens before this time
+    # @param [Time, Integer, nil] after Only retrieve listens after this time
+    #
+    # @return [Payload]
+    def self.get(
+      username = ListenBrainz.client.username, count: nil, before: nil,
+      after: nil
+    )
+      max_ts = before && Types::Timestamp[before].to_i
+      min_ts = after && Types::Timestamp[after].to_i
+      params = { count:, min_ts:, max_ts: }.compact
+
+      ListenBrainz.client.query(:get, "1/user/#{username}/listens", params:)
+        .fetch(:payload).then { Payload.new(_1) }
+    end
+
+    ##
+    # Retrieves the "now playing" listens for a given user.
+    #
+    # @param [String] username
+    #
+    # @return [Payload]
+    def self.now_playing(username = ListenBrainz.client.username)
+      ListenBrainz.client.query(:get, "1/user/#{username}/playing-now")
+        .fetch(:payload).then { Payload.new(_1) }
+    end
+
+    ##
+    # Imports a batch of listens.
+    #
+    # @param [Listen, Array<Listen>] listens
+    # @param [Symbol] mode +single+, +playing_now+ or +import+
+    #
+    # @return [Void]
+    def self.submit(listens, mode: :import)
+      ListenBrainz.client.query(:post, '1/submit-listens',
+        json: { listen_type: mode, payload: Array(listens).map(&:as_json) })
+    end
+
+    ##
+    # Submits the listen to ListenBrainz.
+    #
+    # @param [Symbol] mode +single+ or +playing_now+
+    #
+    # @return [Void]
+    def submit(mode: :single)
+      self.class.submit(self, mode:)
+    end
+
+    ##
+    # Model class for listen payloads.
+    #
+    # These payloads contain the actual listens, as well as additional metadata
+    # for pagination.
+    class Payload < Base
+      ##
+      # @!attribute [r] latest_listen_ts
+      #   @return [Time, nil]
+      attribute? :latest_listen_ts, Types::Timestamp
+      ##
+      # @!attribute [r] oldest_listen_ts
+      #   @return [Time, nil]
+      attribute? :oldest_listen_ts, Types::Timestamp
+      ##
+      # @!attribute [r] user_id
+      #   @return [String]
+      attribute :user_id, Types::String
+
+      ##
+      # @!attribute [r] listens
+      #   @return [Array<Listen>]
+      attribute :listens, Types::Array.of(Listen)
+
+      ##
+      # Retrieves older listens.
+      #
+      # @param [Integer, nil] count
+      #
+      # @return [Payload] A new payload with older listens
+      def older(count = nil)
+        before = listens.map(&:listened_at).min
+        Listen.get(user_id, count:, before:)
+      end
+
+      ##
+      # Retrieves newer listens.
+      #
+      # @param [Integer, nil] count
+      #
+      # @return [Payload] A new payload with newer listens
+      def newer(count = nil)
+        after = listens.map(&:listened_at).max
+        Listen.get(user_id, count:, after:)
+      end
+    end
+
+    ##
+    # @!attribute [r] inserted_at
+    #   @return [Time, nil]
+    attribute? :inserted_at, Types::Timestamp
+    ##
+    # @!attribute [r] listened_at
+    #   @return [Time, nil]
+    attribute? :listened_at, Types::Timestamp
+    ##
+    # @!attribute [r] recording_msid
+    #   @return [String, nil]
+    attribute? :recording_msid, Types::String
+
+    ##
+    # Model class for track metadata.
+    class TrackMetadata < Base
+      ##
+      # @!attribute [r] artist_name
+      #   @return [String]
+      attribute :artist_name, Types::String
+      ##
+      # @!attribute [r] release_name
+      #   @return [String]
+      attribute :release_name, Types::String
+      ##
+      # @!attribute [r] track_name
+      #   @return [String]
+      attribute :track_name, Types::String
+
+      ##
+      # Model class for listen MBID mappings.
+      class MBIDMapping < Base
+        ##
+        # @!attribute [r] artist_mbids
+        #   @return [Array<String>, nil]
+        attribute? :artist_mbids, Types::Array.of(Types::String)
+        ##
+        # @!attribute [r] release_mbid
+        #   @return [String, nil]
+        attribute? :release_mbid, Types::String
+        ##
+        # @!attribute [r] recording_mbid
+        #   @return [String]
+        attribute :recording_mbid, Types::String
+      end
+      ##
+      # @!attribute [r] mbid_mapping
+      #   @return [MBIDMapping, nil]
+      attribute? :mbid_mapping, MBIDMapping
+
+      ##
+      # Model class for listen additional info.
+      class AdditionalInfo < Base
+        ##
+        # @!attribute [r] listening_from
+        #   @return [String]
+        attribute :listening_from, Types::String
+        ##
+        # @!attribute [r] media_player
+        #   @return [String]
+        attribute :media_player, Types::String
+        ##
+        # @!attribute [r] recording_msid
+        #   @return [String, nil]
+        attribute? :recording_msid, Types::String
+        ##
+        # @!attribute [r] track_mbid
+        #   @return [String, nil]
+        attribute? :track_mbid, Types::String
+      end
+      ##
+      # @!attribute [r] additional_info
+      #   @return [AdditionalInfo]
+      attribute :additional_info, AdditionalInfo
+    end
+    ##
+    # @!attribute [r] track_metadata
+    #   @return [TrackMetadata]
+    attribute :track_metadata, TrackMetadata
+  end
+end

data/lib/listenbrainz/models/types.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ListenBrainz
+  ##
+  # Module for Dry types.
+  module Types
+    include Dry.Types
+
+    ##
+    # Unix timestamp.
+    Timestamp = Types.Constructor(Time, ::Time.method(:at))
+  end
+end

data/lib/listenbrainz/models.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ListenBrainz; end # :nodoc:
+
+require_relative 'models/base'
+require_relative 'models/types'
+
+require_relative 'models/listen'

data/lib/listenbrainz/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ListenBrainz
+  ##
+  # Current version of the gem.
+  VERSION = '0.1.0'
+end

data/lib/listenbrainz.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require 'httpx'
+
+require_relative 'listenbrainz/configuration'
+require_relative 'listenbrainz/version'
+
+##
+# Top-level module for the ListenBrainz gem.
+module ListenBrainz
+  ##
+  # @return [Configuration]
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  ##
+  # @return [Client]
+  def self.client
+    @client ||= Client.new
+  end
+
+  ##
+  # @yieldparam config [Configuration]
+  def self.configure
+    yield configuration
+  end
+
+  ##
+  # Configures the gem from the following environment variables.
+  #
+  # * +LISTENBRAINZ_API_ENDPOINT+: URL to the ListenBrainz API;
+  # * +LISTENBRAINZ_USER_TOKEN+: ListenBrainz user token used to authenticate.
+  def self.configure_from_env
+    configuration.endpoint = ENV.fetch('LISTENBRAINZ_API_ENDPOINT', nil)
+    configuration.user_token = ENV.fetch('LISTENBRAINZ_USER_TOKEN', nil)
+  end
+end
+
+ListenBrainz.configure_from_env
+
+require_relative 'listenbrainz/client'
+require_relative 'listenbrainz/models'

data/listenbrainz.code-workspace

@@ -0,0 +1,19 @@
+{
+  "folders": [
+    {
+      "path": "."
+    }
+  ],
+  "extensions": {
+    "recommendations": [
+      "shopify.ruby-lsp",
+      "davidanson.vscode-markdownlint"
+    ]
+  },
+  "settings": {
+    "editor.rulers": [
+      80
+    ],
+    "rubyLsp.bundleGemfile": "Gemfile"
+  }
+}

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: listenbrainz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Degenne
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: httpx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description:
+email:
+- hello@richarddegenne.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/templates.code-snippets"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/listenbrainz.rb
+- lib/listenbrainz/client.rb
+- lib/listenbrainz/configuration.rb
+- lib/listenbrainz/models.rb
+- lib/listenbrainz/models/base.rb
+- lib/listenbrainz/models/listen.rb
+- lib/listenbrainz/models/types.rb
+- lib/listenbrainz/version.rb
+- listenbrainz.code-workspace
+homepage: https://gitlab.com/Richard-Degenne/listenbrainz
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://gitlab.com/Richard-Degenne/listenbrainz/issues
+  changelog_uri: https://gitlab.com/Richard-Degenne/listenbrainz/-/blob/master/CHANGELOG.md
+  documentation_uri: https://listenbrainz.richarddegenne.fr
+  funding_uri: https://ko-fi.com/richarddegenne
+  homepage_uri: https://gitlab.com/Richard-Degenne/listenbrainz
+  source_code_uri: https://gitlab.com/Richard-Degenne/listenbrainz
+  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.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the ListenBrainz API.
+test_files: []