tidal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 758385dc62e185fd969dc7c3050ad47d24c02ce196ea3d0f79ecfb415aab439a
+  data.tar.gz: 1c3284618e5d5e90b06947b1d48b0011c68cd23fa2ec14c3860ede396b6ec3e9
+SHA512:
+  metadata.gz: 53f6804a66f35ccd446295a25b26e80138b560c5e46110259d8d4da5357329713a6228635455bbac9c95b64db5db7177c2f4a2556b094d8ec33167020e60641b
+  data.tar.gz: 8b3d7f6c794e1ad9abe988c538232905df5210b4286b46f7d3dd3d999d6de4eff890cd18a9f5f82a6f4de0251943e62364fc2b92f76c974bd8b6973b7aa3be7c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Fabrice Renard
+
+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,35 @@
+# Tidal
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tidal`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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/[USERNAME]/tidal.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/tidal/client_v1.rb

@@ -0,0 +1,201 @@
+require 'oauth2'
+require 'uri'
+
+module Tidal
+  class ClientV1
+    BASE_URL = 'https://openapi.tidal.com/'.freeze
+    TOKEN_URL = 'https://auth.tidal.com/v1/oauth2/token'.freeze
+
+    attr_reader :access_token
+
+    def initialize(client_id, client_secret)
+      @client_id = client_id
+      @client_secret = client_secret
+      @client = OAuth2::Client.new(@client_id, @client_secret, site: BASE_URL, token_url: TOKEN_URL)
+      @access_token = @client.client_credentials.get_token.token
+    end
+
+    def get_albums_by_barcode_id(barcode_id, country_code)
+      uri = URI("#{BASE_URL}/albums/byBarcodeId")
+      params = { barcodeId: barcode_id, countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_multiple_albums(ids, country_code)
+      uri = URI("#{BASE_URL}/albums/byIds")
+      params = { ids: ids.join(','), countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+
+    def get_album_items(album_id, country_code, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/albums/#{album_id}/items")
+      params = { countryCode: country_code }
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_similar_albums(album_id, country_code, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/albums/#{album_id}/similar")
+      params = { countryCode: country_code }
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_single_album(album_id, country_code)
+      uri = URI("#{BASE_URL}/albums/#{album_id}")
+      params = { countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_albums_by_artist(artist_id, country_code, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/artists/#{artist_id}/albums")
+      params = { countryCode: country_code }
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_multiple_artists(ids, country_code)
+      uri = URI("#{BASE_URL}/artists")
+      params = { ids: ids.join(','), countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_similar_artists(artist_id, country_code, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/artists/#{artist_id}/similar")
+      params = { countryCode: country_code }
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_single_artist(artist_id, country_code)
+      uri = URI("#{BASE_URL}/artists/#{artist_id}")
+      params = { countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_tracks_by_artist(artist_id, country_code, collapse_by = nil, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/artists/#{artist_id}/tracks")
+      params = { countryCode: country_code }
+      params[:collapseBy] = collapse_by if collapse_by
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_multiple_tracks(ids, country_code)
+      uri = URI("#{BASE_URL}/tracks")
+      params = { ids: ids.join(','), countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_tracks_by_isrc(isrc, country_code, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/tracks/byIsrc")
+      params = { isrc: isrc, countryCode: country_code }
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_single_track(artist_id, country_code)
+      uri = URI("#{BASE_URL}/tracks/#{artist_id}")
+      params = { countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_similar_tracks(track_id, country_code, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/tracks/#{track_id}/similar")
+      params = { countryCode: country_code }
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_multiple_videos(ids, country_code)
+      uri = URI("#{BASE_URL}/videos")
+      params = { ids: ids.join(','), countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_single_video(video_id, country_code)
+      uri = URI("#{BASE_URL}/videos/#{video_id}")
+      params = { countryCode: country_code }
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    def get_search(query, country_code, type = nil, popularity = nil, offset = nil, limit = nil)
+      uri = URI("#{BASE_URL}/search")
+      params = { query: query, countryCode: country_code }
+      params[:type] = type if type
+      params[:popularity] = popularity if popularity
+      params[:offset] = offset if offset
+      params[:limit] = limit if limit
+      uri.query = URI.encode_www_form(params)
+
+      response = @client.request(:get, uri.to_s, headers: default_headers)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def default_headers
+      {
+        'accept' => "application/vnd.tidal.v1+json",
+        'Authorization' => "Bearer #{@access_token}",
+        'Content-Type' => "application/vnd.tidal.v1+json",
+      }
+    end
+  end
+end

data/lib/tidal/version.rb

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

data/lib/tidal.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "tidal/client_v1"
+require_relative "tidal/version"
+
+module Tidal
+  class Error < StandardError; end
+end

data/sig/tidal.rbs

@@ -0,0 +1,4 @@
+module Tidal
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: tidal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabrice Renard
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: This gem provides a Ruby wrapper around the Tidal API, allowing developers
+  to easily interact with Tidal's services, including retrieving album and artist
+  information, searching for tracks, and more.
+email:
+- fabrice.renard12@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tidal.rb
+- lib/tidal/client_v1.rb
+- lib/tidal/version.rb
+- sig/tidal.rbs
+homepage: https://github.com/fabricerenard12/tidal.rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fabricerenard12/tidal.rb
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper to interact with the Tidal API
+test_files: []