quran-audio 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9d4aa2977f958be7f3d1544b0cefa0141a464886fbcc6681390735b1af33083
-  data.tar.gz: 467c4a4f34baf890df84fce649122fb3fca2bb483c399ee831fdb7e699b43b9b
+  metadata.gz: e4f6bb534d549b8f15007767b977d02ba66bb99b29230d208cd025beef58156e
+  data.tar.gz: fcf08060b5f19fc4404cf8620f3c4acde6e936f6080ecc5ee36f266eaa0a4f11
 SHA512:
-  metadata.gz: 00c1fef420cf3fb24b2130c04da9b8c8032f8cb101089d4f430fb1a3029e869d0359aa20e7e650f9c2b0ce3f52c09e28399710bb62cb33a246a5c99efec1dab5
-  data.tar.gz: 0c7ab62d560a4b775edfdbb596cffffa8163de8137133b84e826fd647f7654316d659490cc11c339715a8ac11e0f1f11703c1a1d5010606d23fdc873e1dca5de
+  metadata.gz: b470c6fc24757c9f77702dd1516a2ea13b853169cd8838515c911d8d9ed2c4cebccb7c502fec64df657badebb82f5f1870e3dcecce314e9e1c9e5ebf4ae69bbc
+  data.tar.gz: 0ade0f5665a4e42b2811ce6582a62ab4162954eccceee2084a8eccc2a98d59b2accae844a113fa1a4c1b71f03248291be66e0e42efc99e3c3d48b6eebb5ee5b9

data/README.md

@@ -1,16 +1,23 @@
+<p align="center">
+الْحَمْدُ لِلَّهِ رَبِّ الْعَالَمِي
+</p>
+
 ## About
 
 quran-audio is a command-line utility that
 can download recitations of The Noble Quran from
-[everyayah.com](https://everyayah.com).
-The recitations are provided as MP3 files
-(with one MP3 file per ayah).
+[al-quran-audio.reflectslight.io](https://al-quran-audio.reflectslight.io).
+The recitations are provided in the MP3 format with
+one MP3 file per ayah and a *minimum* bitrate of
+128kbps.
 
-## ~/.local/share/quran-audio/
+## share/
 
-Downloads are stored relative to ~/.local/share/quran-audio. <br>
-An example path:
-`/home/user/.local/share/quran-audio/mp3/alafasy/1/1.mp3`
+The command-line utility attempts to download MP3 files
+relative to the `~/.local/share/quran-audio/` directory.
+A single, full recitation of The Noble Quran typically
+ranges from 2.5GB to 2.8GB in size.	Each recitation is
+organized per this directory structure:
 
 * **~/.local/share/quran-audio/mp3/alafasy/** <br>
   Contains recitations by Mishari bin Rashed Alafasy
@@ -18,25 +25,50 @@ An example path:
   Contains recitations by Ahmad bin Ali Al-Ajmi
 * **~/.local/share/quran-audio/mp3/yassin/** <br>
   Contains recitations by Sahl Yassin
+* **~/.local/share/quran-audio/mp3/rifai/** <br>
+  Contains recitations by Hani ar-Rifai
+
+## Examples
+
+The following examples demonstrate how to use the quran-audio
+command-line utility to download particular recitations, and
+list available recitations as well:
+
+    ##
+	# Download recitations
+	user@localhost$ quran-audio pull -r alafasy
+	user@localhost$ quran-audio pull -r rifai
+
+    ##
+    # List available recitations
+	user@localhost$ quran-audio ls
 
 ## Install
 
-quran-audio is available via rubygems.org:
+quran-audio is available via rubygems.org
+
+    gem install quran-audio
+
+## Credit
+
+**Recitations**
+
+* Mishari bin Rashed Alafasy
+* Ahmad bin Ali Al-Ajmi
+* Sahl Yassin
+* Hani ar-Rifai
 
-    user@localhost$ gem install quran-audio
-    user@localhost$ quran-audio --help
-    user@localhost$ quran-audio ls --help
-    user@localhost$ quran-audio pull --help
+**Sources**
 
-## Thanks
+* The [everyayah.com](https://everyayah.com) website
 
-Alhamdulillah
+## See also
 
-* Thanks to the [everyayah.com](https://everyayah.com) website
-* Thanks to the reciters
+* [al-quran.reflectslight.io](https://al-quran.reflectslight.io)
+* [al-quran-audio.reflectslight.io](https://al-quran-audio.reflectslight.io)
 
 ## License
 
 The "source code" is released under the [GPL](./LICENSE) license
 <br>
-The reciters hold the copyright for the audio files
+Copyright for the recitations belongs to the reciters

data/bin/quran-audio

@@ -1,17 +1,31 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-libexec = File.realpath File.join(__dir__, "..", "libexec", "quran-audio")
-case ARGV[0]
-when "pull"
-  Process.spawn File.join(libexec, "pull"), *ARGV[1..]
+def wait
   Process.wait
-when "ls"
-  Process.spawn File.join(libexec, "ls"), *ARGV[1..]
-  Process.wait
-else
-  warn "Usage: quran-audio [COMMAND] [OPTIONS]\n\n" \
-       "Commands:\n" \
-       "  pull              Pull MP3 files from everyayah.com\n" \
-       "  ls                List reciters\n" \
+rescue Interrupt
+  retry
+end
+
+def libexec
+  File.realpath File.join(__dir__, "..", "libexec", "quran-audio")
+end
+
+def main(argv)
+  case argv[0]
+  when "pull"
+    Process.spawn File.join(libexec, "pull"), *ARGV[1..]
+    Process.wait
+  when "ls"
+    Process.spawn File.join(libexec, "ls"), *ARGV[1..]
+    Process.wait
+  else
+    warn "Usage: quran-audio [COMMAND] [OPTIONS]\n\n" \
+         "Commands:\n" \
+         "  pull              Download recitations\n" \
+         "  ls                List available recitations\n"
+  end
+rescue Interrupt
+  wait
 end
+main(ARGV)

data/lib/quran/audio/command/ls.rb

@@ -2,18 +2,11 @@
 
 module Quran::Audio
   class Command::Ls < Command
-    set_banner usage: "quran-audio ls [OPTIONS]",
-               description: "List recitations"
-
-    def run
-      recitations = Ryo.from_json(path: File.join(dir.datadir, "recitations.json"))
-      template = File.binread(File.join(dir.datadir, "erb", "recitation.erb"))
-      render(recitations, template)
-    end
-
-    private
-
-    def render(recitations, template)
+    ##
+    # @return [void]
+    def perform
+      recitations = Ryo.from_json(path: File.join(dir.json, "recitations.json"))
+      template = File.binread(File.join(dir.erb, "recitation.erb"))
       puts Ryo.each(recitations).map { |switch, recitation|
         ERB.new(template).result_with_hash({switch:, recitation: Ryo(recitation)})
       }.join("\n")

data/lib/quran/audio/command/pull.rb

@@ -2,20 +2,26 @@
 
 module Quran::Audio
   class Command::Pull < Command
-    set_banner usage: "quran-audio pull [OPTIONS]",
-               description: "Pull MP3 files from everyayah.com"
-    set_option "-r RECITATION", "--recitation RECITATION", "A recitation's name", default: "alafasy"
-    set_option "-b BITRATE", "--bitrate BITRATE", "MP3 bitrate"
-    set_option "-s NUMBERS", "--surahs NUMBERS", "Comma-separated list of surah IDs", as: Array, default: (1..114)
-    set_option "-d SECONDS", "--delay", "Delay between requests, in seconds", as: Float, default: 0.5
+    require "forwardable"
+    extend Forwardable
+    def_delegators :@options,
+      :surahs,
+      :recitation,
+      :delay,
+      :bitrate
 
-    def initialize(...)
-      super
-      @http = Net::HTTP.new("everyayah.com", 443).tap { _1.use_ssl = true }
+    ##
+    # @return [void]
+    def perform
+      summary(recitations[recitation])
+      start(surahs)
     end
 
-    def run
-      summary(recitations[recitation])
+    private
+
+    attr_reader :http
+
+    def start(surahs)
       surahs.each do |surah|
         1.upto(sizeof[surah]) do |ayah|
           mp3 = MP3.new(recitation:, surah:, ayah:, bitrate:)
@@ -27,20 +33,17 @@ module Quran::Audio
       end
     end
 
-    private
-
-    attr_reader :http
-
     def pull(mp3, delay, interrupt: false)
+      http = Net::HTTP.new(mp3.host, 443).tap { _1.use_ssl = true }
       res = http.get(mp3.remote_path)
       write(mp3, res, interrupt:)
       sleep(delay)
     rescue Interrupt
-      line.end.rewind.print("Wait for a graceful exit").end
+      line.end.print("SIGINT: exiting cleanly, please wait").end
       pull(mp3, delay, interrupt: true)
     rescue SocketError, SystemCallError, Net::OpenTimeout => e
-      line.end.rewind.print("#{e.class}: retry")
-      interrupt ? throw(:interrupt, true) : pull(mp3, delay)
+      line.end.print("#{e.class}: retry")
+      interrupt ? abort! : pull(mp3, delay)
     end
 
     def write(mp3, res, interrupt:)
@@ -48,26 +51,30 @@ module Quran::Audio
       when Net::HTTPOK
         mkdir_p File.dirname(mp3.local_path)
         File.binwrite(mp3.local_path, res.body)
-        throw(:interrupt, true) if interrupt
+        abort! if interrupt
       else
-        puts "error #{res.body}"
+        line.end.print("error: unexpected response (#{res.class})")
+        abort!
       end
     end
 
     def summary(r)
       line
-        .rewind
-        .print("Recitation".ljust(12), r.name).end
-        .print("Directory".ljust(12), format(r.dest_dir, sharedir: dir.sharedir))
+        .print("Recited by".ljust(12), r.name).end
+        .print("Directory".ljust(12), format(r.destdir, sharedir: dir.share))
         .end.end
     end
 
     def sizeof
-      @sizeof ||= Ryo.from_json(path: File.join(dir.datadir, "sizeof.json"))
+      @sizeof ||= Ryo.from_json(path: File.join(dir.json, "sizeof.json"))
     end
 
     def recitations
-      @recitations ||= Ryo.from_json(path: File.join(dir.datadir, "recitations.json"))
+      @recitations ||= Ryo.from_json(path: File.join(dir.json, "recitations.json"))
+    end
+
+    def abort!
+      throw(:abort, 1)
     end
   end
 end

data/lib/quran/audio/command.rb

@@ -4,21 +4,20 @@ module Quran::Audio
   ##
   # The {Quran::Audio::Command Quran::Audio::Command} class
   # is the superclass of all commands.
-  class Command < Cmd
+  class Command
     require_relative "command/ls"
     require_relative "command/pull"
     include FileUtils
 
-    def method_missing(m, *ary, &b)
-      Ryo.property?(options, m) ? options[m] : super
-    end
-
-    def respond_to_missing?(m, p = false)
-      Ryo.property?(options, m) || super
-    end
+    ##
+    # @return [Ryo]
+    #  Command-line options
+    attr_reader :options
 
-    def respond_to?(m, p = false)
-      Ryo.property?(options, m) || super
+    ##
+    # @param [Ryo] options
+    def initialize(options)
+      @options = options
     end
 
     private
@@ -26,16 +25,13 @@ module Quran::Audio
     def dir
       @dir ||= Ryo.from({
         localbase: File.join(Dir.home, ".local"),
-        rootdir: File.realpath(File.join(__dir__, "..", "..", "..")),
-        sharedir: Ryo.memo { File.join(localbase, "share", "quran-audio") },
-        datadir: Ryo.memo { File.join(rootdir, "share", "quran-audio", "data") }
+        share: Ryo.memo { File.join(localbase, "share", "quran-audio") },
+        root: File.realpath(File.join(__dir__, "..", "..", "..")),
+        erb: Ryo.memo { File.join(root, "share", "quran-audio", "erb") },
+        json: Ryo.memo { File.join(root, "share", "quran-audio", "json") },
       })
     end
 
-    def options
-      @options ||= parse_options(argv)
-    end
-
     def line
       @line ||= IO::Line.new($stdout)
     end

data/lib/quran/audio/mp3.rb

@@ -2,9 +2,8 @@
 
 module Quran::Audio
   ##
-  # {Quran::Audio::MP3 Quran::Audio::MP3} provides
-  # an abstract interface around an MP3 file, and
-  # within the context of the quran-audio project.
+  # {Quran::Audio::MP3 Quran::Audio::MP3} represents
+  # an ayah of The Noble Quran in the MP3 format.
   class MP3 < Struct.new(:recitation, :surah, :ayah, :bitrate, keyword_init: true)
     def initialize(recitation:, **kw)
       super(recitation: recitations[recitation], **kw)
@@ -17,12 +16,19 @@ module Quran::Audio
       super || recitation.default_bitrate
     end
 
+    ##
+    # @return [String]
+    #  Returns the host of a remote HTTP server
+    def host
+      recitation.host
+    end
+
     ##
     # @return [String]
     #  Returns the path to an MP3 file on a remote HTTP server
     def remote_path
-      filename = [surah.to_s.rjust(3, "0"), ayah.to_s.rjust(3, "0"), ".mp3"].join
-      File.join format(recitation.remote_path, bitrate:), filename
+      File.join format(recitation.path, bitrate:),
+                [surah, "/", ayah, ".mp3"].join
     end
 
     ##
@@ -30,7 +36,7 @@ module Quran::Audio
     #  Returns the path to an MP3 file on disk
     def local_path
       File.join(
-        format(recitation.dest_dir, sharedir:),
+        format(recitation.destdir, sharedir:),
         surah.to_s,
         "#{ayah}.mp3"
       )
@@ -39,7 +45,7 @@ module Quran::Audio
     private
 
     def recitations
-      @recitations ||= Ryo.from_json(path: File.join(datadir, "recitations.json"))
+      @recitations ||= Ryo.from_json(path: File.join(jsondir, "recitations.json"))
     end
 
     def sharedir
@@ -49,10 +55,10 @@ module Quran::Audio
       end
     end
 
-    def datadir
-      @datadir ||= File.realpath File.join(
+    def jsondir
+      @jsondir ||= File.realpath File.join(
         __dir__, "..", "..", "..",
-        "share", "quran-audio", "data"
+        "share", "quran-audio", "json"
       )
     end
   end

data/lib/quran/audio.rb

@@ -2,7 +2,13 @@
 
 module Quran
   module Audio
-    require "cmd"
+    def self.setup_bundle!
+      bundle = File.realpath File.join(__dir__, "..", "..", "bundle")
+      Dir[File.join(bundle, "*")].each { $:.unshift File.join(_1, "lib") }
+    end
+    setup_bundle!
+
+    require "json"
     require "ryo"
     require "ryo/json"
     require "fileutils"

data/libexec/quran-audio/ls

@@ -2,9 +2,26 @@
 # frozen_string_literal: true
 
 require "quran/audio"
+require "optparse"
+
+##
+# main
 def main(argv)
-  Quran::Audio::Command::Ls
-    .new(argv)
-    .run
+  options = Ryo({})
+  option_parser.parse(argv, into: options)
+  Quran::Audio::Command::Ls.new(options).perform
+end
+
+##
+# utils
+def option_parser
+  OptionParser.new do |o|
+    o.banner = "Usage: quran-audio ls [OPTIONS]"
+  end
 end
-main(ARGV)
+
+excode = catch(:abort) {
+  main(ARGV)
+  0
+}
+exit excode

data/libexec/quran-audio/pull

@@ -2,10 +2,35 @@
 # frozen_string_literal: true
 
 require "quran/audio"
+require "optparse"
+
+##
+# main
 def main(argv)
-  Quran::Audio::Command::Pull
-    .new(argv)
-    .run
+  options = Ryo({
+    recitation: "alafasy",
+    bitrate: 128,
+    surahs: (1..114),
+    delay: 0.5
+  })
+  option_parser.parse(argv, into: options)
+  Quran::Audio::Command::Pull.new(options).perform
+end
+
+##
+# utils
+def option_parser
+  OptionParser.new do |o|
+    o.banner = "Usage: quran-audio pull [OPTIONS]"
+    o.on("-r RECITATION", "--recitation RECITATION", "A recitation's name", String)
+    o.on("-b BITRATE"   , "--bitrate BITRATE", "MP3 bitrate", Integer)
+    o.on("-s NUMBERS"   , "--surahs NUMBERS", "Comma-separated list of surah IDs", Array)
+    o.on("-d SECONDS"   , "--delay", "Delay between requests, in seconds", Float)
+  end
 end
-interrupt = catch(:interrupt) { main(ARGV) }
-exit(1) if interrupt
+
+excode = catch(:abort) {
+  main(ARGV)
+  0
+}
+exit excode

data/share/quran-audio/CHANGELOG

@@ -0,0 +1,4 @@
+* vNEXT
+
+** Add new reciter: Nabil Al-Rifai
+At the recommendation of a friend

data/share/quran-audio/VERSION

@@ -1 +1 @@
-v0.3.2
+v0.4.0

data/share/quran-audio/json/recitations.json

@@ -0,0 +1,42 @@
+{
+  "alafasy": {
+    "id": "alafasy",
+    "name": "Mishari bin Rashed Alafasy",
+    "origin": "Kuwait",
+    "available_bitrates": [128],
+    "default_bitrate": 128,
+    "host": "al-quran-audio.reflectslight.io",
+    "path": "/alafasy/",
+    "destdir": "%{sharedir}/mp3/alafasy/"
+  },
+  "alajmi": {
+    "id": "alajmi",
+    "name": "Ahmad bin Ali Al-Ajmi",
+    "origin": "Saudi Arabia",
+    "available_bitrates": [128],
+    "default_bitrate": 128,
+    "host": "al-quran-audio.reflectslight.io",
+    "path": "/alajmi/",
+    "destdir": "%{sharedir}/mp3/alajmi/"
+  },
+  "yassin": {
+    "id": "yassin",
+    "name": "Sahl Yassin",
+    "origin": "Saudi Arabia",
+    "available_bitrates": [128],
+    "default_bitrate": 128,
+    "host": "al-quran-audio.reflectslight.io",
+    "path": "/yassin/",
+    "destdir": "%{sharedir}/mp3/yassin/"
+  },
+  "rifai": {
+    "id": "rifai",
+    "name": "Hani ar-Rifai",
+    "origin": "Saudi Arabia",
+    "available_bitrates": [192],
+    "default_bitrate": 192,
+    "host": "al-quran-audio.reflectslight.io",
+    "path": "/rifai/",
+    "destdir": "%{sharedir}/mp3/rifai/"
+  }
+}

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: quran-audio
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-13 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ryo.rb
+  name: paint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: cmd.rb
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
-  name: paint
+  name: optparse
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: net-http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: io-line.rb
+  name: forwardable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.25'
-description: Downloads recitations of The Noble Quran from everyayah.com
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: Download recitations of The Noble Quran
 email:
 - 0x1eef@protonmail.com
 executables:
@@ -112,10 +126,11 @@ files:
 - lib/quran/audio/mp3.rb
 - libexec/quran-audio/ls
 - libexec/quran-audio/pull
+- share/quran-audio/CHANGELOG
 - share/quran-audio/VERSION
-- share/quran-audio/data/erb/recitation.erb
-- share/quran-audio/data/recitations.json
-- share/quran-audio/data/sizeof.json
+- share/quran-audio/erb/recitation.erb
+- share/quran-audio/json/recitations.json
+- share/quran-audio/json/sizeof.json
 homepage: https://github.com/ReflectsLight/quran-audio#readme
 licenses:
 - GPL-3.0-or-later
@@ -135,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
-summary: Downloads recitations of The Noble Quran from everyayah.com
+summary: Download recitations of The Noble Quran
 test_files: []

data/share/quran-audio/data/recitations.json

@@ -1,26 +0,0 @@
-{
-  "alafasy": {
-    "name": "Mishari bin Rashed Alafasy",
-    "origin": "Kuwait",
-    "available_bitrates": [128, 64],
-    "default_bitrate": 128,
-    "remote_path": "/data/Alafasy_%{bitrate}kbps/",
-    "dest_dir": "%{sharedir}/mp3/alafasy/"
-  },
-  "alajmi": {
-    "name": "Ahmad bin Ali Al-Ajmi",
-    "origin": "Saudi Arabia",
-    "available_bitrates": [128],
-    "default_bitrate": 128,
-    "remote_path": "/data/ahmed_ibn_ali_al_ajamy_%{bitrate}kbps/",
-    "dest_dir": "%{sharedir}/mp3/alajmi/"
-  },
-  "yassin": {
-    "name": "Sahl Yassin",
-    "origin": "Saudi Arabia",
-    "available_bitrates": [128],
-    "default_bitrate": 128,
-    "remote_path": "/data/Sahl_Yassin_%{bitrate}kbps/",
-    "dest_dir": "%{sharedir}/mp3/yassin/"
-  }
-}