musixmatch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 319b03408f7749b40d77452a7727a1fdd43fbef9d99a6b1f8219340a7abc2f0a
+  data.tar.gz: 95025ac4a5b52580fd70d23b6948da41f9ba1a470f325a43faf054acfe7f4bd2
+SHA512:
+  metadata.gz: c8c9c9790d82ee52ea0adf939f3b7643ea817ee3da4c68731b6a53e1c2ba174004865650e749f4f7e7b2d56a2596172cd9b19085073c0006df6ec38e1fd49990
+  data.tar.gz: ad4cef3a7a3a27c5bcae4f11b44e1d493b53f84c3c1bf73419e674d7ab8fab79559d922ee0157e237a69e2f4abb3cb8a6cff7e66c60eaa30463ddb5917b9823a

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - spec/**/*
+Style/Documentation:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in musixmatch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Hondallica
+
+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,83 @@
+# Musixmatch
+
+musiXmatch API client library.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'musixmatch'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install musixmatch
+
+## Usage
+
+```ruby
+require 'musixmatch'
+```
+
+### Setting API key
+You must set the API key.
+
+Please refer to the [official API documentation](https://developer.musixmatch.com/documentation) on how to get API key.
+
+```ruby
+musixmatch = Musixmatch.new('your_api_key')
+```
+
+If environment variable MUSIXMATCH_API_KEY is set in .bash_profile etc, no argument is necessary.
+
+    export MUSIXMATCH_API_KEY=your_api_key
+
+```ruby
+musixmatch = Musixmatch.new
+```
+
+### change API key
+
+```ruby
+musixmatch.api_key = 'new_api_key'
+```
+
+### API Resources
+It supports resources of musiXmatch API version 1.1.
+Please refer to the [official API documentation](https://developer.musixmatch.com/documentation) for available parameters etc.
+
+```ruby
+res = musixmatch.chart_artists_get({ chart_name: 'top', page: 1, page_size: 5, country: 'it', f_has_lyrics: 1 })
+res = musixmatch.chart_tracks_get({ chart_name: 'top', page: 1, page_size: 5, country: 'it', f_has_lyrics: 1 })
+res = musixmatch.track_search({ q_artist: 'justin bieber', page_size: 3, page: 1, s_track_rating: 'desc' })
+res = musixmatch.track_get({ commontrack_id: 5920049 })
+res = musixmatch.track_lyrics_get({ track_id: 15953433 })
+res = musixmatch.track_snippet_get({ track_id: 16860631 })
+res = musixmatch.track_subtitle_get({ commontrack_id: 10074988 })
+res = musixmatch.track_richsync_get({ track_id: 114837357 })
+res = musixmatch.track_lyrics_translation_get({ commontrack_id: 10074988, selected_language: 'it' })
+res = musixmatch.track_subtitle_translation_get({ commontrack_id: 10074988, selected_language: 'it' })
+res = musixmatch.music_genres_get
+res = musixmatch.matcher_lyrics_get({ q_track: 'sexy and i know it', q_artist: 'lmfao' })
+res = musixmatch.matcher_track_get({ q_artist: 'eminem', q_track: 'lose yourself (soundtrack)' })
+res = musixmatch.matcher_subtitle_get({ q_track: 'sexy and i know it', q_artist: 'lmfao', f_subtitle_length: 200, f_subtitle_length_max_deviation: 3 })
+res = musixmatch.artist_get({ artist_id: 118 })
+res = musixmatch.artist_search({ q_artist: 'prodigy', page_size:5 })
+res = musixmatch.artist_albums_get({ artist_id: 1039, s_release_date: 'desc', g_album_name: 1 })
+res = musixmatch.artist_related_get({ artist_id: 56, page_size: 2, page: 1 })
+res = musixmatch.album_get({ album_id: 14250417 })
+res = musixmatch.album_tracks_get({ album_id: 13750844, page: 1, page_size: 2 })
+res = musixmatch.tracking_url_get({ domain: 'www.mylyricswebsite.com' })
+res = musixmatch.catalogue_dump_get
+```
+
+## 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/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'musixmatch'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/musixmatch.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'musixmatch/version'
+require 'musixmatch/request'
+require 'musixmatch/api_method'
+
+class Musixmatch
+  include Version
+  include Request
+  include APIMethod
+  attr_accessor :api_key, :url, :version, :api_version
+
+  def initialize(api_key = ENV['MUSIXMATCH_API_KEY'])
+    raise 'API key is required' unless api_key
+
+    @version = Version.version
+    @api_version = Version.api_version
+    @api_key = api_key
+    @url = Request.base_url
+  end
+end

data/lib/musixmatch/api_method.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module APIMethod
+  def chart_artists_get(params = {})
+    http.get("/ws/#{api_version}/chart.artists.get", _params(params))
+  end
+
+  def chart_tracks_get(params = {})
+    http.get("/ws/#{api_version}/chart.tracks.get", _params(params))
+  end
+
+  def track_search(params = {})
+    http.get("/ws/#{api_version}/track.search", _params(params))
+  end
+
+  def track_get(params = {})
+    http.get("/ws/#{api_version}/track.get", _params(params))
+  end
+
+  def track_lyrics_get(params = {})
+    http.get("/ws/#{api_version}/track.lyrics.get", _params(params))
+  end
+
+  def track_snippet_get(params = {})
+    http.get("/ws/#{api_version}/track.snippet.get", _params(params))
+  end
+
+  def track_subtitle_get(params = {})
+    http.get("/ws/#{api_version}/track.subtitle.get", _params(params))
+  end
+
+  def track_richsync_get(params = {})
+    http.get("/ws/#{api_version}/track.richsync.get", _params(params))
+  end
+
+  def track_lyrics_translation_get(params = {})
+    http.get("/ws/#{api_version}/track.lyrics.translation.get", _params(params))
+  end
+
+  def track_subtitle_translation_get(params = {})
+    http.get("/ws/#{api_version}/track.subtitle.translation.get", _params(params))
+  end
+
+  def music_genres_get(params = {})
+    http.get("/ws/#{api_version}/music.genres.get", _params(params))
+  end
+
+  def matcher_lyrics_get(params = {})
+    http.get("/ws/#{api_version}/matcher.lyrics.get", _params(params))
+  end
+
+  def matcher_track_get(params = {})
+    http.get("/ws/#{api_version}/matcher.track.get", _params(params))
+  end
+
+  def matcher_subtitle_get(params = {})
+    http.get("/ws/#{api_version}/matcher.subtitle.get", _params(params))
+  end
+
+  def artist_get(params = {})
+    http.get("/ws/#{api_version}/artist.get", _params(params))
+  end
+
+  def artist_search(params = {})
+    http.get("/ws/#{api_version}/artist.search", _params(params))
+  end
+
+  def artist_albums_get(params = {})
+    http.get("/ws/#{api_version}/artist.albums.get", _params(params))
+  end
+
+  def artist_related_get(params = {})
+    http.get("/ws/#{api_version}/artist.related.get", _params(params))
+  end
+
+  def album_get(params = {})
+    http.get("/ws/#{api_version}/album.get", _params(params))
+  end
+
+  def album_tracks_get(params = {})
+    http.get("/ws/#{api_version}/album.tracks.get", _params(params))
+  end
+
+  def tracking_url_get(params = {})
+    http.get("/ws/#{api_version}/tracking.url.get", _params(params))
+  end
+
+  def catalogue_dump_get(params = {})
+    http.get("/ws/#{api_version}/catalogue.dump.get", _params(params))
+  end
+
+  def _params(params)
+    params['apikey'] = @api_key
+    params['format'] = 'json'
+    params
+  end
+  private :_params
+end

data/lib/musixmatch/request.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module Request
+  def base_url(url = 'https://api.musixmatch.com')
+    url
+  end
+
+  def http
+    Faraday.new(url: base_url) do |f|
+      f.response :mashify
+      f.response :json
+      f.request :url_encoded
+      f.request :retry, max: 5, interval: 1.0
+      f.options[:open_timeout] = 2
+      f.options[:timeout] = 5
+      f.headers['Accept'] = 'application/json'
+      f.headers['User-Agent'] = "ruby-musixmatch/#{version}"
+      f.adapter :net_http
+    end
+  end
+
+  module_function :base_url
+end

data/lib/musixmatch/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Version
+  def version
+    '0.1.0'
+  end
+
+  def api_version(api_version = '1.1')
+    api_version
+  end
+
+  module_function :version, :api_version
+end

data/musixmatch.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/musixmatch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'musixmatch'
+  spec.version       = Version.version
+  spec.authors       = ['Hondallica']
+  spec.email         = ['hondallica@gmail.com']
+
+  spec.summary       = 'musiXmatch API client library'
+  spec.homepage      = 'https://github.com/hondallica/ruby-musixmatch'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 1.0.1'
+  spec.add_dependency 'faraday_middleware', '~> 1.0.0'
+  spec.add_dependency 'hashie', '~> 4.1.0'
+
+  spec.add_development_dependency 'bundler', '~>2.1.4'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'rake', '~> 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.84.0'
+  spec.add_development_dependency 'webmock', '~> 3.8.3'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: musixmatch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hondallica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.84.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.84.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+description: 
+email:
+- hondallica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/musixmatch.rb
+- lib/musixmatch/api_method.rb
+- lib/musixmatch/request.rb
+- lib/musixmatch/version.rb
+- musixmatch.gemspec
+homepage: https://github.com/hondallica/ruby-musixmatch
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hondallica/ruby-musixmatch
+  source_code_uri: https://github.com/hondallica/ruby-musixmatch
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: musiXmatch API client library
+test_files: []