genius-api 0.3.0

data/rbs_collection.lock.yaml

@@ -0,0 +1,232 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: bigdecimal
+  version: 4.1.2
+  source:
+    type: rubygems
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: csv
+  version: '3.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ffi
+  version: 1.17.4
+  source:
+    type: rubygems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: httparty
+  version: '0.18'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: lint_roller
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: listen
+  version: '3.9'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '1.7'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: mini_mime
+  version: '0.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: multi_xml
+  version: 0.9.1
+  source:
+    type: rubygems
+- name: net-http
+  version: '0'
+  source:
+    type: stdlib
+- name: net-protocol
+  version: '0'
+  source:
+    type: stdlib
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parser
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: prism
+  version: 1.9.0
+  source:
+    type: rubygems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: random-formatter
+  version: '0'
+  source:
+    type: stdlib
+- name: rbs
+  version: 4.0.2
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: regexp_parser
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ripper
+  version: '0'
+  source:
+    type: stdlib
+- name: rubocop
+  version: '1.57'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rubocop-ast
+  version: '1.46'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: stringio
+  version: '0'
+  source:
+    type: stdlib
+- name: strscan
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+- name: yard
+  version: '0.9'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 3f5e8df1ce89ea06067fa42263012c968b4e583e
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,14 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: activesupport
+    ignore: true

data/sig/lib/extensions/deep_find.rbs

@@ -0,0 +1,30 @@
+class Hash[unchecked out K, unchecked out V]
+  # +Hash#deep_find+                                  -> value
+  #
+  # @param [Object] key A key, which value should be found
+  # @param [FalseClass] uniq A flag to make values unique in an array
+  # @return [Object] output depends on key value
+  # This method is an extension for Hash core class to search for a value of a key in N-nested
+  # hash. It provides search for multiple values if key appears more than once. For e.g.:
+  #
+  # @example
+  #     musicians = { "Travis Scott" => { "28" => ["Highest in the Room", "Franchise"] },
+  #                 "Adele" => { "19" => ["Day Dreamer", "Best for Last"] },
+  #                 "Ed Sheeran" => { "28" => ["Shape of You", "Castle on the Hill"] } }
+  #     musicians.deep_find("19") #=> ["Day Dreamer", "Best for Last"]
+  #     musicians.deep_find("Adele") #=> {"19"=>["Day Dreamer", "Best for Last"]}
+  #     musicians.deep_find("28") #=> [["Highest in the Room", "Franchise"], ["Shape of You", "Castle on the Hill"]]
+  #
+  # If values are identical, they will be returned in a single copy. You can disable this
+  # feature with special param +uniq+, which is +true+ by default. For e.g.:
+  #
+  # @example
+  #     h = {"a" => "b", "c" => {"a" => "b"}}
+  #     h.deep_find("a") #=> "b", instead ["b", "b"]
+  # @todo change uniq true to uniq false
+  def deep_find: (untyped key, ?uniq: bool) -> (nil | untyped)
+
+  private
+
+  def collect_values: (untyped key) -> Array[untyped]
+end

data/sig/lib/extensions/options_helper.rbs

@@ -0,0 +1,3 @@
+class Object
+  def options_helper: (Hash[Symbol, untyped] options, Array[Symbol] arry) -> String
+end

data/sig/lib/extensions/token_ext.rbs

@@ -0,0 +1,3 @@
+class Object
+  def token_ext: (String? token) -> String
+end

data/sig/lib/extensions/unescape.rbs

@@ -0,0 +1,3 @@
+class String
+  def unescape: -> String
+end

data/sig/lib/genius/api/account.rbs

@@ -0,0 +1,23 @@
+module Genius
+  # +Genius::Account+ module provides methods to work with Genius account
+  module Account
+    # +Genius::Account.account+                     -> value
+    #
+    # An alias to {Genius::Account.account me} method
+    #
+    # @param [String] token Token to access https://api.genius.com.
+    # @raise [TokenError] if +token+ or +Genius::Auth.token+ are invalid.
+    # @return [Hash]
+    # @return [NilClass] if TokenError exception raised.
+    # This method is a standard Genius API {request}[https://docs.genius.com/#search-h2] to get
+    # account info. Output +JSON+ is translated to Hash structure to make it easy to work with account fields.
+    #
+    # @example
+    #     Genius::Auth.login="yuiaYqbncErCVwItjQxFspNWUZLhGpXrPbkvgbgHSEKJRAlToamzMfdOeDB"
+    #     Genius::Account.account #=> {"meta"=>{"status"=>200}, "response"=>{"user"=>{...}}}
+    # @todo somehow refactor 50/52 exceptions
+    def self.account: (?token: String?) -> (Hash[String, untyped] | nil)
+
+    alias self.me self.account
+  end
+end

data/sig/lib/genius/api/annotations.rbs

@@ -0,0 +1,13 @@
+module Genius
+  module Annotations
+    def self.annotations: (id: Integer, action: String?, token: String?, http_verb: String, ?options: Hash[Symbol, untyped]) -> (Hash[String, untyped] | nil)
+
+    private
+
+    def self.request: (id: Integer, action: String?, token: String?, http_verb: String, options: Hash[Symbol, untyped]) -> HTTParty::Response
+
+    def self.put_request: (id: Integer, action: String?, token: String?, options: Hash[Symbol, untyped]) -> HTTParty::Response
+
+    def self.post_payload: (?options: Hash[Symbol, untyped]) -> String
+  end
+end

data/sig/lib/genius/api/artists.rbs

@@ -0,0 +1,15 @@
+module Genius
+  module Artists
+    def self.artists: (?token: String?, ?id: Integer?) -> (Hash[String, untyped] | nil)
+
+    def self.artists_songs: (?token: String?, ?id: Integer?, ?options: Hash[Symbol, untyped]) -> (Hash[String, untyped] | nil)
+
+    private
+
+    def self.validate: (Array[String] sort_values, **untyped options) -> void
+
+    def self.validate_sort: (String? sort, Array[String] sort_values) -> void
+
+    def self.validate_page_per_page: (Integer? page_per_page) -> void
+  end
+end

data/sig/lib/genius/api/authorization.rbs

@@ -0,0 +1,11 @@
+module Genius
+  module Auth
+    def self.token=: (String token) -> String
+
+    def self.authorized?: (?String token, ?method_name: String) -> bool
+
+    def self.logout!: -> nil
+
+    # alias login= token=
+  end
+end

data/sig/lib/genius/api/errors.rbs

@@ -0,0 +1,46 @@
+module Genius
+  module Errors
+    ENDPOINT: String
+
+    class GeniusExceptionSuperClass < StandardError
+    end
+
+    class TokenError < GeniusExceptionSuperClass
+      attr_reader msg: String
+      attr_reader exception_type: String
+      attr_reader method_name: String?
+
+      def initialize: (?msg: String, ?exception_type: String, ?method_name: String?) -> void
+    end
+
+    class LyricsNotFoundError < GeniusExceptionSuperClass
+      attr_reader msg: String
+      attr_reader exception_type: String
+
+      def initialize: (?msg: String, ?exception_type: String) -> void
+    end
+
+    class PageNotFound < GeniusExceptionSuperClass
+      attr_reader msg: String
+      attr_reader exception_type: String
+
+      def initialize: (?msg: String, ?exception_type: String) -> void
+
+      def self.page_not_found?: (untyped html) -> bool
+    end
+
+    module DynamicRescue
+      def self.rescue: (Module klass) -> Array[Symbol]
+
+      def self.rescue_from: (Array[Symbol] meths, Module klass, Module exception) { (untyped) -> void } -> Array[Symbol]
+    end
+
+    def self.validate_token: (String? token, ?method_name: String?) -> void
+
+    def self.error_handle?: (String? token, ?method_name: String?) -> bool
+
+    private
+
+    def self.check_status?: (String token) -> bool
+  end
+end

data/sig/lib/genius/api/referents.rbs

@@ -0,0 +1,7 @@
+module Genius
+  module Referents
+    ENDPOINT: String
+
+    def self.referents: (?token: String?, ?options: Hash[Symbol, untyped]) -> (Hash[String, untyped] | nil)
+  end
+end

data/sig/lib/genius/api/search.rbs

@@ -0,0 +1,5 @@
+module Genius
+  module Search
+    def self.search: (?token: String?, ?query: String?, ?search_by: String?) -> (Hash[String, untyped] | String | nil)
+  end
+end

data/sig/lib/genius/api/songs.rbs

@@ -0,0 +1,15 @@
+module Genius
+  module Songs
+    def self.songs: (?token: String?, ?song_id: Integer?, ?combine: bool) -> (Hash[String, untyped] | String | nil)
+
+    private
+
+    def self.merge_lyrics: (Integer song_id, Hash[String, untyped] response) -> (Hash[String, untyped] | String)
+
+    def self.parse_preloaded_state: (untyped output_html) -> Hash[String, untyped]
+
+    public
+
+    def self.get_lyrics: (Integer song_id) -> String
+  end
+end

data/sig/lib/genius/api/version.rbs

@@ -0,0 +1,5 @@
+module Genius
+  module Api
+    VERSION: String
+  end
+end

data/sig/lib/genius/api/web_pages.rbs

@@ -0,0 +1,5 @@
+module Genius
+  module WebPages
+    def self.lookup: (?token: String?, ?options: Hash[Symbol, untyped]) -> (Hash[String, untyped] | nil)
+  end
+end

data/sig/lib/genius/api.rbs

@@ -0,0 +1,9 @@
+# Base module which contains all of other methods/classes/etc.
+module Genius
+  # +Genius::Api+ is a base module with different constants.
+  module Api
+    # +Genius::Api::RESOURCE+ constant contains reference to
+    # {Genius API}[https://api.genius.com] resource.
+    RESOURCE: "https://api.genius.com"
+  end
+end