From 09154058bc81a9d02282bfe2b172b598155a3c02 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 7 Jun 2019 22:46:54 -0700 Subject: [PATCH 01/26] init --- .editorconfig | 9 + .gitignore | 35 +- .travis.yml | 6 + LICENSE | 695 ++------------------------------------- README.md | 90 +---- irs/__init__.py | 0 irs/cli/__init__.py | 0 irs/cli/cli.py | 51 --- irs/cli/config_parser.py | 52 --- irs/glue/__init__.py | 0 irs/glue/album.py | 14 - irs/glue/list.py | 51 --- irs/glue/playlist.py | 39 --- irs/glue/song.py | 193 ----------- irs/install | 1 - irs/interact/__init__.py | 0 irs/interact/ripper.py | 50 --- irs/interact/tagger.py | 67 ---- irs/search/__init__.py | 0 irs/search/spotify.py | 119 ------- irs/search/youtube.py | 191 ----------- setup.cfg | 5 - setup.py | 25 -- shard.lock | 6 + shard.yml | 17 + spec/irs_spec.cr | 9 + spec/spec_helper.cr | 2 + src/irs.cr | 6 + src/search/spotify.cr | 104 ++++++ 29 files changed, 201 insertions(+), 1636 deletions(-) create mode 100644 .editorconfig create mode 100644 .travis.yml delete mode 100644 irs/__init__.py delete mode 100644 irs/cli/__init__.py delete mode 100644 irs/cli/cli.py delete mode 100644 irs/cli/config_parser.py delete mode 100644 irs/glue/__init__.py delete mode 100644 irs/glue/album.py delete mode 100644 irs/glue/list.py delete mode 100644 irs/glue/playlist.py delete mode 100644 irs/glue/song.py delete mode 160000 irs/install delete mode 100644 irs/interact/__init__.py delete mode 100644 irs/interact/ripper.py delete mode 100644 irs/interact/tagger.py delete mode 100644 irs/search/__init__.py delete mode 100644 irs/search/spotify.py delete mode 100644 irs/search/youtube.py delete mode 100644 setup.cfg delete mode 100644 setup.py create mode 100644 shard.lock create mode 100644 shard.yml create mode 100644 spec/irs_spec.cr create mode 100644 spec/spec_helper.cr create mode 100644 src/irs.cr create mode 100644 src/search/spotify.cr diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..163eb75 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*.cr] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true diff --git a/.gitignore b/.gitignore index dbde338..0bb75ea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,30 +1,5 @@ -# General stuff to ignore. -*.pyc -/dist/ -/*.egg-info/ -/build/ -__pycache__/ -.eggs - -# For easy updating of stuff. -update_pypi_and_github.py - -# Currently in progress -/flexx-app/ -/.idea/ -*test.py - -# Temporarily downloaded files -*.mp3 -*.zip -*.part -*.webm - -# Coverage files -.coverage - -# Temporarily built binaries -ffmpeg binaries/ - -# vscode work space -.vscode/ \ No newline at end of file +/docs/ +/lib/ +/bin/ +/.shards/ +*.dwarf diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..765f0e9 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +language: crystal + +# Uncomment the following if you'd like Travis to run specs and check code formatting +# script: +# - crystal spec +# - crystal tool format --check diff --git a/LICENSE b/LICENSE index 9cecc1d..191c7f4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - {project} Copyright (C) {year} {fullname} - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +The MIT License (MIT) + +Copyright (c) 2019 Cooper Hammond + +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. diff --git a/README.md b/README.md index 7818c0f..38f9dfa 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,27 @@ -# Ironic Redistribution System +# irs -[![License: GNU](https://img.shields.io/badge/license-gnu-yellow.svg?style=flat-square)](http://www.gnu.org/licenses/gpl.html) -[![Stars](https://img.shields.io/github/stars/kepoorhampond/irs.svg?style=flat-square)](https://github.com/kepoorhampond/irs/stargazers) -[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg?style=flat-square)](https://saythanks.io/to/kepoorhampond) -[![PyPI](https://img.shields.io/badge/pypi-irs-blue.svg?style=flat-square)](https://pypi.python.org/pypi/irs) +TODO: Write a description here -> A music downloader that understands your metadata needs. +## Installation -A tool to download your music with metadata. It uses [Spotify](https://www.spotify.com/) for finding metadata and [Youtube](https://www.youtube.com/) for the actual audio source. You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens). +TODO: Write installation instructions here -Works with Python 2 and 3. +## Usage -## Install and Setup -``` -$ sudo pip install irs -$ irs --setup -``` +TODO: Write usage instructions here -**You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens).** +## Development +TODO: Write development instructions here -## Demo and Usages +## Contributing -The usages can be found with the `-h` or `--help` flag: -``` -usage: irs [-h] [-S] [-a ARTIST] [-s SONG] [-A ALBUM] [-p PLAYLIST] - [-u USERNAME] [-o ORGANIZATION] +1. Fork it () +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request -optional arguments: - -h, --help show this help message and exit - -S, --setup Run this by itself to setup config files and folder - for irs and download the ffmpeg binaries - -a ARTIST, --artist ARTIST - Specify artist name. Must be used with -s/--song or - -A/--album - -s SONG, --song SONG Specify song name. Must be used with -a/--artist - -A ALBUM, --album ALBUM - Specify album name. Can be used by itself. - -p PLAYLIST, --playlist PLAYLIST - Specify playlist name. Must be used with -A/--album - -u USERNAME, --username USERNAME - Specify user name for playlist. Must be used with - -A/--album - -o ORGANIZATION, --organization ORGANIZATION - Specify type of organization for list. Used when - downloading spotify playlist/album -``` +## Contributors -So all of these are valid commands: -``` -$ irs -a "Brandon Flowers" -s "Lonely Town" -$ irs -u "spotify" -p "Brain Food" -$ irs -A "Suicide Squad: The Album" -``` -But these are not: -``` -$ irs -s "Bohemian Rhapsody" -$ irs -p "Best Nirvana" -``` - -## Spotify Tokens - -To download metadata through spotify, you'll want to head to their Dev Apps page, [here](https://developer.spotify.com/my-applications/). After doing that you'll want to create a new app. Name it whatever you want and then once you've done that, find the `Client ID` and `Client Secret` keys. You'll want to take those keys and paste them into your system's environment variables as `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`, correspondingly. Voilà! You can now download metadata with IRS! - -## Metadata - -Currently, the program attaches the following metadata to the downloaded files: - - Title - - Artist - - Album - - Album Art - - Genre - - Track Number - - Disc Number - -## Wishlist - - - [x] Full album downloading - - [x] Album art metadata correctly displayed - - [x] Spotify playlist downloading - - [ ] Comment metadata - - [ ] Compilation metadata - - [ ] GUI/Console interactive version - *in progress* - - [ ] Lyric metadata +- [Cooper Hammond](https://github.com/your-github-user) - creator and maintainer diff --git a/irs/__init__.py b/irs/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/cli/__init__.py b/irs/cli/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/cli/cli.py b/irs/cli/cli.py deleted file mode 100644 index 8079625..0000000 --- a/irs/cli/cli.py +++ /dev/null @@ -1,51 +0,0 @@ -import argparse - -from ..glue.song import Song -from ..glue.album import Album -from ..glue.playlist import Playlist -from ..install.setup import set_it_up -from .config_parser import parse_config - -def main(): - """The main cli method. Parses arguments from the command line.""" - - parser = argparse.ArgumentParser() - - parser.add_argument("-S", "--setup", dest="setup", action='store_true', - help="Run this by itself to setup config files " - "and folder for irs and download the ffmpeg binaries") - - parser.add_argument("-a", "--artist", dest="artist", - help="Specify artist name. Must be used with -s/--song or -A/--album") - - parser.add_argument("-s", "--song", dest="song", - help="Specify song name. Must be used with -a/--artist") - - parser.add_argument("-A", "--album", dest="album", - help="Specify album name. Can be used by itself.") - - parser.add_argument("-p", "--playlist", dest="playlist", - help="Specify playlist name. Must be used with -A/--album") - - parser.add_argument("-u", "--username", dest="username", - help="Specify user name for playlist. Must be used with -A/--album") - - parser.add_argument("-o", "--organization", dest="organization", - default="single-folder", help="Specify type of organization for list." - " Used when downloading spotify playlist/album") - - args = parser.parse_args() - - if args.setup: - set_it_up() - - parse_config() - - if args.song and args.artist: # single song - Song(args.song, args.artist).grab_it() - elif args.album and args.artist: # album with an artist - Album(args.album, args.artist).grab_it() - elif args.album: # album without artist - Album(args.album).grab_it() - elif args.playlist and args.username: # playlist - Playlist(args.playlist, args.username, args.organization).grab_it() diff --git a/irs/cli/config_parser.py b/irs/cli/config_parser.py deleted file mode 100644 index 6104591..0000000 --- a/irs/cli/config_parser.py +++ /dev/null @@ -1,52 +0,0 @@ -import os -import sys - -import yaml - - -def parse_config(): - """Parses config using environment variables.""" - - home = os.environ.get("HOME") or os.path.expanduser("~/") - - check_for_and_set("irs_config_dir", home + "/.irs", ".irs/") - - check_for = [home + "/.irs/config.yml", home + "/.irs/bin/ffmpeg", - home + "/.irs/bin/ffprobe"] - - for path in check_for: - if not os.path.exists(path): - print("There's no config set up. Set up a configuration folder by " - "running `irs --setup`") - sys.exit(1) - - config = {} - - with open(os.environ["irs_config_dir"] + "/config.yml", "r") as stream: - try: - config = yaml.safe_load(stream) - except yaml.YAMLError as exc: - print(exc) - - check_for_and_set("SPOTIFY_CLIENT_ID", config.get( - "SPOTIFY_KEYS").get("CLIENT_ID"), None) - check_for_and_set("SPOTIFY_CLIENT_SECRET", config.get( - "SPOTIFY_KEYS").get("CLIENT_SECRET"), None) - - check_for_and_set("irs_music_dir", os.path.expanduser(config.get("music_directory")), - home + "/Music") - check_for_and_set("irs_ffmpeg_dir", os.environ["irs_config_dir"] + "/bin", None) - - -def check_for_and_set(key, val, else_): - """Checks for an environment variable and if it doesn't exist, then set it - equal to the val given. - :param key: string, key to check for existence - :param val: value to replace key value with if it doesn't exists - :param else_: if val doesn't exist, use else_ instead - """ - if not os.environ.get(key): - if key: - os.environ[key] = val - else: - os.environ[key] = else_ diff --git a/irs/glue/__init__.py b/irs/glue/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/glue/album.py b/irs/glue/album.py deleted file mode 100644 index 8f6af7a..0000000 --- a/irs/glue/album.py +++ /dev/null @@ -1,14 +0,0 @@ -from .list import SpotifyList - -class Album(SpotifyList): - """A class for downloading albums as a whole.""" - - def _SpotifyList__find_it(self): - album = self.spotify_searcher.find_album( - self.list_title, - self.list_author - ) - return album - - def _SpotifyList__set_organization(self, song_index, song): - pass \ No newline at end of file diff --git a/irs/glue/list.py b/irs/glue/list.py deleted file mode 100644 index b7f9a7b..0000000 --- a/irs/glue/list.py +++ /dev/null @@ -1,51 +0,0 @@ -import sys -import abc - -from ..search import spotify -from .song import Song - -class SpotifyList(object): - """A parent class for downloading spotify albums and playlists""" - - def __init__(self, list_title, list_author=None): - self.spotify_searcher = spotify.SpotifySearcher().authorize() - self.list_title = list_title - self.list_author = list_author - self.file_names = [] - - def grab_it(self): - """Downloads the songs! - """ - spotify_list = self.__find_it() - list_contents = spotify_list["tracks"]["items"] - - for index, s in enumerate(list_contents): - # if it's a playlist, get the actual track, not the metadata of - # the playlist - if s.get("track"): - s = s["track"] - - song = Song(s["name"], s["artists"][0]["name"]) - song.provide_spotify(self.spotify_searcher) - song.provide_metadata(self.spotify_searcher.song(s["uri"])) - song.get_relevant_tags() - self.__set_organization(index, song) - song.grab_it() - - # These following functions are named weird b/c PEP8 and python are in - # conflict. An error gets raised when private methods - # (prefix = __ due to PEP8) are overriden by child class with the same - # name b/c python is dumb with how it concatenates class names and method - # names with underscores - - def __find_it(self): - """Finds the list and return it""" - raise NotImplementedError("Must override __find_it with" - "_SpotifyList__find_it") - - def __set_organization(self, song_index, song): - """Post processing method for a single song - :param song: Song class - """ - raise NotImplementedError("Must override __post_process with" - "_SpotifyList__set_organization") \ No newline at end of file diff --git a/irs/glue/playlist.py b/irs/glue/playlist.py deleted file mode 100644 index 1c2695a..0000000 --- a/irs/glue/playlist.py +++ /dev/null @@ -1,39 +0,0 @@ -import os - -from .list import SpotifyList - -class Playlist(SpotifyList): - """A class for downloading albums as a whole. - The majority of specs for methods can be found in the SpotifyList file""" - - def __init__(self, playlist_name, username, organization="single-folder"): - """ - :param playlist_name: a string, the name of the playlist - :param username: a string, the username of the creator of the playlist - :param organization: a string, following options: - "single-folder": All of the songs downloaded will be put into a - single folder. root-music-dir>playlist-name - "standard": All of the songs downloaded will be - organized by root-music-dir>artist>album - """ - super(Playlist, self).__init__(playlist_name, username) - self.organization = organization - - def _SpotifyList__find_it(self): - playlist = self.spotify_searcher.find_playlist( - self.list_title, - self.list_author - ) - return playlist - - def _SpotifyList__set_organization(self, song_index, song): - if self.organization == "standard": - song.set_standard_organization() - elif self.organization == "single-folder": - # reindex the file names in order to keep them in alphabetical order - song.provide_new_file_name("{} - {}.mp3".format( - song_index + 1, song.tags["title"] - )) - song.provide_new_location(os.path.join( - os.getcwd(), self.list_title - )) \ No newline at end of file diff --git a/irs/glue/song.py b/irs/glue/song.py deleted file mode 100644 index 1486a2f..0000000 --- a/irs/glue/song.py +++ /dev/null @@ -1,193 +0,0 @@ -import os -import sys -import errno -import string - -from ..search import spotify, youtube -from ..interact import ripper, tagger - - -class Song(object): - """A grabber for a single song. Unless provided, gets metadata, finds url, - downloads, converts, tags, and moves it.""" - def __init__(self, song_title, artist_name): - self.song_title = song_title - self.artist_name = artist_name - - self.spotify_searcher = None - self.spotify_authenticated = False - - self.metadata = None - self.tags = {} - self.parsed_tags = False - - self.file_name = song_title + ".mp3" - self.end_file_name = None - - self.current_location = os.getcwd() - self.end_location = None - - def grab_it(self, post_process=True): - """The main method to call for this class. Unless provided, grabs - metadata, finds the url, downloads the video, converts it, and - tags it. - :param post_process: boolean, - :rtype: a string, the file_name - """ - - self.metadata = self.__parse_data() - - self.tags = self.get_relevant_tags() - - print("'{}' by {}:".format(self.tags["title"], self.tags["artist"])) - - print("Searching youtube ...") - song_url = youtube.find_url(self.tags["title"], self.tags["artist"]) - - if self.metadata: - self.file_name = '{} - {}.mp3'.format( - self.tags["tracknumber"], - self.tags["title"] - ) - - print("Downloading ...") - ripper.rip_from_url(song_url, self.file_name) - print("Converting to mp3 ...") # TODO: add this into a hook for ydl - - print("Tagging ...") - song_tags = tagger.Tagger(self.file_name) - - for tag in self.tags: - if tag is "albumart": - song_tags.add_album_art(self.tags[tag]) - else: - song_tags.add_tag(tag, self.tags[tag]) - - if post_process: - self.__organize() - - def provide_spotify(self, spotify_searcher): - """This function will set this class's spotify searcher to the one - provided to prevent the need to authenticate twice - :param spotify_searcher: an instance of - irs.searcher.spotify.SpotifySearcher, the spotify searcher to use - :rtype: self class - """ - self.spotify_searcher = spotify_searcher - self.spotify_authenticated = True - return self - - def provide_metadata(self, metadata): - """Provides metadata for the song so searches don't have to be - performed twice. If this is called with new metadata, - other metadata won't be searched. - :param metadata: a dict, the new metadata from a spotipy track search - :rtype: self class - """ - self.metadata = metadata - return self - - def provide_tag(self, key, value): - """Provides tags for the song. Tags will still be parsed, but will not - overwrite these provided tags. - :param: a dict, the tags that will overwrite the metadata provided tags - :rtype: self class - """ - self.tags[key] = value - return self - - def provide_new_location(self, new_loc): - """Provides a new, non-default location for the song. - :param new_loc: a string, the path of the new location WITHOUT filename - :rtype: self class - """ - self.end_location = new_loc - return self - - def provide_new_file_name(self, new_name): - """Provides a new file name for the song file. DOESNT append .mp3 - :param new_name: string - :rtype: self class - """ - self.end_file_name = new_name - return self - - def set_standard_organization(self): - """Sets standard organization for the file, which is - root-music-dir>artist-folder>album-folder>song - """ - if not self.parsed_tags: - self.tags = self.get_relevant_tags() - self.end_location = os.path.join( - os.environ.get("irs_music_dir"), self.tags["artist"], - self.tags["album"] - ) - self.end_file_name = "{} - {}.mp3".format( - self.tags["tracknumber"], self.tags["title"] - ) - - def get_relevant_tags(self): - """Sorts relevant info from the spotipy metadata. Merges with any - provided tags from provide_tags method. - :rtype: a dict, parsed tags - """ - # TODO: come up with fallback solution if there's no metadata found - # follows this pattern: - # if this does not exist: - # set the thing that doesn't exist to a - # specific value from the metadata dict - tags = self.tags - metadata = self.metadata - - if not tags.get("title"): - tags["title"] = metadata["name"] - if not tags.get("artist"): - tags["artist"] = metadata["artists"][0]["name"] - if not tags.get("album"): - tags["album"] = metadata["album"]["name"] - if not tags.get("tracknumber"): - tags["tracknumber"] = str(metadata["track_number"]) - if not tags.get("albumart"): - tags["albumart"] = metadata["album"]["images"][0]["url"] - if not tags.get("genre") and self.spotify_searcher: - tags["genre"] = string.capwords(self.spotify_searcher.artist( - metadata["artists"][0]["uri"])["genres"][0]) - - self.tags = tags - return self.tags - - def __organize(self): - """Based off of self.current_location, self.end_location, and self. - file_name, this function creates folders for the end location and moves - the file there. - """ - if not self.end_location: - self.set_standard_organization() - - if not os.path.exists(self.end_location): - # try loop to prevent against race conditions with os.path.exists - # and os.makedirs - try: - os.makedirs(self.end_location) - except OSError as exc: - if exc.errno != errno.EEXIST: - raise - - os.rename( - self.current_location + "/" + self.file_name, - self.end_location + "/" + self.end_file_name, - ) - - def __parse_data(self): - """If a spotify searcher has not been provided, create one.""" - if not self.spotify_authenticated and not self.metadata: - self.spotify_searcher = spotify.SpotifySearcher().authorize() - self.spotify_authenticated = True - - """If metadata has not been provided, search for it.""" - if not self.metadata: - self.metadata = self.spotify_searcher.find_song( - self.song_title, self.artist_name - ) - - return self.metadata diff --git a/irs/install b/irs/install deleted file mode 160000 index 3a8323f..0000000 --- a/irs/install +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 3a8323f39eda597ac5c4b4e2559577ca757aedc0 diff --git a/irs/interact/__init__.py b/irs/interact/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/interact/ripper.py b/irs/interact/ripper.py deleted file mode 100644 index b6dd57e..0000000 --- a/irs/interact/ripper.py +++ /dev/null @@ -1,50 +0,0 @@ -import os -import sys -import glob -import shutil - -import youtube_dl - - -def rip_from_url(video_url, output_name): - """This method downloads a video, converts it to an MP3 and renames it - :param video_url: a string, youtube url of the video you want to download - :param output_name: a string, the name of the output file - """ - - ydl_opts = { - 'format': 'bestaudio/best', - 'postprocessors': [{ - 'key': 'FFmpegExtractAudio', - 'preferredcodec': 'mp3', - 'preferredquality': '192', - }], - 'logger': _DownloadLogger(), - 'progress_hooks': [_download_hook], - 'output': "tmp_file", - 'prefer-ffmpeg': True, - 'ffmpeg_location': os.environ["irs_ffmpeg_dir"], - } - - with youtube_dl.YoutubeDL(ydl_opts) as ydl: - ydl.download([video_url]) - - for f in glob.glob("./*%s*" % video_url.split("/watch?v=")[-1]): - shutil.move(f, output_name) - - -class _DownloadLogger(object): - def debug(self, msg): - pass - - def warning(self, msg): - pass - - def error(self, msg): - print(msg) - - -# TODO: update the download log -def _download_hook(d): - if d['status'] == 'finished': - print("Done!") \ No newline at end of file diff --git a/irs/interact/tagger.py b/irs/interact/tagger.py deleted file mode 100644 index 26a6409..0000000 --- a/irs/interact/tagger.py +++ /dev/null @@ -1,67 +0,0 @@ -import sys - -if sys.version_info[0] >= 3: - from urllib.request import urlopen -elif sys.version_info[0] < 3: - from urllib import quote_plus, quote - from urllib import urlopen - -from mutagen.mp3 import EasyMP3 -from mutagen.easyid3 import EasyID3, EasyID3KeyError -from mutagen.id3 import APIC, ID3 - - -class Tagger(object): - """Attaches ID3 tags to MP3 files.""" - - def __init__(self, location): - """Initializes the class and generates ID3 tags for the mp3 - :param location: a string, the location of the mp3 that you want ID3 - tags on - """ - EasyID3.RegisterTextKey("comment", "COMM") - self.location = location - self.mp3 = EasyID3(self.location) - - def add_tag(self, tag, data): - """Adds a tag to the mp3 file you specified in __init__ and saves it - :param tag: a string, the name of the tag you want to add to the mp3 - valid tag names: - "title", "artist", "album", "genre", "tracknumber" (string), - "discnumber" (string), - "compilation" ("1" for true, "" for false) - :param data: a string, the data that you want to attach to the mp3 - under the specified tag name - """ - # For valid tags: `EasyID3.valid_keys.keys()` - self.mp3[tag] = data - self.mp3.save() - - def read_tag(self, tag): - """Tries to read a tag from the initialized mp3 file - :param tag: a string, the name of the tag you want to read - :rtype: an array with a string inside. The string inside the array is - the data you're requesting. If there's no tag associated or no data - attached with your requested tag, a blank array will be returned. - """ - try: - return self.mp3[tag] - except EasyID3KeyError or KeyError: - return [] - - def add_album_art(self, image_url): - """Adds album art to the initialized mp3 file - :param image_url: a string, the url of the image you want to attach to - the mp3 - """ - mp3 = EasyMP3(self.location, ID3=ID3) - mp3.tags.add( - APIC( - encoding = 3, - mime = 'image/png', - type = 3, - desc = 'cover', - data = urlopen(image_url).read() - ) - ) - mp3.save() \ No newline at end of file diff --git a/irs/search/__init__.py b/irs/search/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/irs/search/spotify.py b/irs/search/spotify.py deleted file mode 100644 index 742ea9f..0000000 --- a/irs/search/spotify.py +++ /dev/null @@ -1,119 +0,0 @@ -import os -import sys -import re - -import spotipy -from spotipy.oauth2 import SpotifyClientCredentials - - -class SpotifySearcher(object): - """Searches spotify for song, album, and playlist metadata.""" - - def authorize(self, client_id=None, client_secret=None): - """Authorizes this class with spotify using client ids - :rtype: returns self class - """ - - # TODO: remove these when you finish config files - if not client_id: - client_id = os.environ["SPOTIFY_CLIENT_ID"] - if not client_secret: - client_secret = os.environ["SPOTIFY_CLIENT_SECRET"] - - try: - creds = SpotifyClientCredentials(client_id, client_secret) - self.authorized = True - self.spotify = spotipy.Spotify(client_credentials_manager=creds) - except Exception: - self.authorized = False - self.spotify = spotipy.Spotify() - - return self - - def find_song(self, song_title, artist_name, limit=50, offset=0): - """Searches spotify for a song and grabs its metadata - :param song_title: a string, the title of the song you're looking for - :param artist_name: a string, the artist of the above song - :rtype: a dictionary of metadata about the song - """ - songs = self.spotify.search(q=song_title, type="track")["tracks"] - - for song in songs["items"]: - if _simplify(song_title) in _simplify(song["name"]) and \ - _simplify(artist_name) in _simplify(song["artists"][0]["name"]): - return song - - if songs['next']: - return self.find_song(song_title, artist_name, - offset=offset + limit) - else: - print("There were no songs found by that name with that artist.") - sys.exit(1) - - def find_album(self, album_title, artist_name=None, limit=50, offset=0): - """Searches spotify for an album and grabs its contents and metadata - :param album_title: a string, the title of the album - :param artist_name: a string, the name of the artist of the album - :rtype: a dictionary of metadata about the album - """ - query = album_title - if artist_name: - query += " " + artist_name - albums = self.spotify.search(q=query, type="album")['albums'] - - for album in albums['items']: - if _simplify(album_title) in _simplify(album["name"]): - return self.spotify.album(album['uri']) - - if albums['next']: - return self.find_album(album_title, artist_name, - offset=offset + limit) - else: - print("There were no albums found by that name with that artist.") - sys.exit(1) - - def find_playlist(self, playlist_title, username, limit=50, offset=0): - """Searches spotify for a playlist and grabs its contents and metadata - :param playlist_title: a string, the title of the playlist - :param username: a string, the username of the playlist creator/owner - :rtype: a dictionary of metadata about the playlist - """ - playlists = [] - playlists = self.spotify.user_playlists(username, limit, offset) - - for playlist in playlists['items']: - if _simplify(playlist_title) in _simplify(playlist['name']): - return self.spotify.user_playlist(username, playlist['id']) - - if playlists['next']: - return self.find_playlist(playlist_title, username, - offset=offset + limit) - else: - print("There were no playlists by that name found.") - sys.exit(1) - - def artist(self, artist_uri): - """Gets artist metadata from uri - :param artist_uri: the spotify uri for the artist - :rtype: a dict of info about the artist - """ - return self.spotify.artist(artist_uri) - - def song(self, song_uri): - """Gets song metadata from uri - :param song_uri: the spotify uri for the artist - :rtype: a dict of info about the artist - """ - return self.spotify.track(song_uri) - - - -# TODO: export this function to a utilities file -def _simplify(string): - """Lowercases and strips all non alphanumeric characters from the string - :param string: a string to be modified - :rtype: the modified string - """ - if type(string) == bytes: - string = string.decode() - return re.sub(r'[^a-zA-Z0-9]+', '', string.lower()) \ No newline at end of file diff --git a/irs/search/youtube.py b/irs/search/youtube.py deleted file mode 100644 index 3cecc33..0000000 --- a/irs/search/youtube.py +++ /dev/null @@ -1,191 +0,0 @@ -import sys -import re - -if sys.version_info[0] >= 3: - from urllib.parse import urlencode - from urllib.request import urlopen -elif sys.version_info[0] < 3: - from urllib import urlencode - from urllib import urlopen -else: - print("Must be using Python 2 or 3") - sys.exit(1) - -from bs4 import BeautifulSoup - - -def find_url(song_title, artist_name, search_terms=None, caught_by_google=False, download_first=False): - """Finds the youtube video url for the requested song. The youtube - query is constructed like this: - " " - so plugging in "Bohemian Rhapsody", "Queen", and "lyrics" would end - up with a search for "Bohemian Rhapsody Queen lyrics" on youtube - :param-required song: song name - :param-required artist: artist name - :param search_terms: any additional search terms you may want to - add to the search query - :param caught_by_google: a boolean, if not false or none, turns on - the captcha catcher - :param download_first: a boolean, if true, downloads first video - that youtube returns - :rtype: A string of the youtube url for the song - """ - - query = artist_name + " " + song_title - if search_terms: - query += " " + search_terms - - encoded_query = urlencode({"search_query": query}) - - url = "http://www.youtube.com/results?" + encoded_query - - soup = _get_url_data(url, caught_by_google) - - # if you want to inspect the html being requested - # print(soup.prettify()) - # with open("index.html", "wb") as f: - # f.write(soup.prettify().encode('utf-8')) - - # Each of the tags in the results list have the following relevant - # attributes: - # "title": the title of the youtube video - # "href": the youtube video code, namely the X's of - # https://www.youtube.com/watch?v=XXXXXXXXXXX - # "class": the classes of the link, used to identify the youtube title - results = _find_links(soup) - - best_guess = None - total_tries_counter = 0 - - if len(results) <= 0: - raise Exception('There were no search results for "{}"'.format(query)) - - if download_first == True: - return "https://youtube.com" + results[0]["href"] - - scores = [] - - for index, link in enumerate(results): - scores.append([ - index, - _score_song(song_title, artist_name, link["title"]), - link["href"] - ]) - - # sort by the score of the song - sorted(scores, key=lambda x: x[1]) - - return "https://youtube.com" + results[scores[0][0]]["href"] - - -def _score_song(song_title, artist_name, video_title): - """Scores the likelihood of the song audio being in the video based off of - the video title. - :param song_title: a string, the title of the song that you're looking for - :param video_title: a string, the title of the video you're analyzing - :rtype: an integer, the score of the song - """ - points = 0 - - song_title = _simplify(song_title) - artist_name = _simplify(artist_name) - video_title = _simplify(video_title) - - if song_title in video_title: - points += 3 - - if artist_name in video_title: - points += 3 - - points -= _count_garbage_phrases(video_title, song_title) - - return points - - -def _simplify(string): - """Lowercases and strips all non alphanumeric characters from the string - :param string: a string to be modified - :rtype: the modified string - """ - if type(string) == bytes: - string = string.decode() - return re.sub(r'[^a-zA-Z0-9]+', '', string.lower()) - - -def _count_garbage_phrases(video_title, song_title): - """Checks if there are any phrases in the title of the video that would - indicate it doesn't have the audio we want - :param string: a string, the youtube video title - :param title: a string, the actual title of the song we're looking for - :rtype: an integer, of the number of bad phrases in the song - """ - - # Garbage phrases found through experiences of downloading the wrong song - # TODO: add this into the config so the user can mess with it if they want - garbage_phrases = ( - "cover album live clean rare version full full album row at " - "@ session how to npr music reimagined hr version" - ).split(" ") - - bad_phrases = 0 - - for gphrase in garbage_phrases: - # make sure we're not invalidating part of the title of the song - if gphrase in song_title.lower(): - continue - - # check if the garbage phrase is not in the video title - if gphrase in video_title.lower(): - bad_phrases += 1 - - return bad_phrases - - -def _find_links(soup): - """Finds youtube video links in the html soup - :param soup: a BeautifulSoup(...) element - :rtype: returns a list of valid youtube video links - """ - return list(filter(None, map(_find_link, soup.find_all("a")))) - - -def _find_link(link): - """Tests html tags to see if they contain a youtube video link. - Should be used only with the find_links function in a map func. - :param link: accepts an element from BeautifulSoup(...).find_all(...) - :rtype: returns the link if it's an actual video link, otherwise, None - """ - try: - class_to_check = str(" ".join(link["class"])) - except KeyError: - return - - # these classes are found by inspecting the html soup of a youtube search. - valid_classes = [ - "yt-simple-endpoint style-scope ytd-video-renderer", - ("yt-uix-tile-link yt-ui-ellipsis yt-ui-ellipsis-2 " - "yt-uix-sessionlink spf-link ") - ] - - try: - # Make sure it's not a playlist - if "&list=" in link["href"]: - return - - for valid_class in valid_classes: - if valid_class in class_to_check: - return link - except KeyError: - pass - - -# TODO: build in the captcha cheater if the user is "caught" by google -def _get_url_data(url, caught_by_google): - """Gets parsed html from the specified url - :param url: A string, the url to request and parse. - :param caught_by_google: A boolean, will open and use the captcha - cheat to get around google's captcha. - :rtype: A BeautifulSoup class - """ - html_content = urlopen(url).read() - return BeautifulSoup(html_content, 'html.parser') \ No newline at end of file diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 79bc678..0000000 --- a/setup.cfg +++ /dev/null @@ -1,5 +0,0 @@ -[bdist_wheel] -# This flag says that the code is written to work on both Python 2 and Python -# 3. If at all possible, it is good practice to do this. If you cannot, you -# will need to generate wheels for each Python version that you support. -universal=1 diff --git a/setup.py b/setup.py deleted file mode 100644 index 05a66af..0000000 --- a/setup.py +++ /dev/null @@ -1,25 +0,0 @@ -from setuptools import setup - -setup( - name = 'irs', - version = '7.0.2', - description = 'A music downloader that gets metadata too.', - url = 'https://github.com/kepoorhampond/irs', - author = 'Kepoor Hampond', - author_email = 'kepoorh@gmail.com', - license = 'GPL', - packages = ['irs', 'irs.search', 'irs.interact', 'irs.glue', - 'irs.install', 'irs.cli'], - install_requires = [ - 'bs4', # HTML parsing - 'mutagen', # MP3 tags - 'argparse', # CLI arg parsing - 'spotipy', # Interfacing w/ Spotify API - 'ydl-binaries', # Downloading ffmpeg/ffprobe binaries - 'pyyaml', # Config files done simply - 'youtube-dl' # Download youtube videos - ], - entry_points = { - 'console_scripts': ['irs = irs.cli.cli:main'], - }, -) diff --git a/shard.lock b/shard.lock new file mode 100644 index 0000000..de2e9e8 --- /dev/null +++ b/shard.lock @@ -0,0 +1,6 @@ +version: 1.0 +shards: + spotify: + github: marceloboeira/spotify.cr + commit: 347727a4ebe4f3f4e55f6032de17cdd554a676bd + diff --git a/shard.yml b/shard.yml new file mode 100644 index 0000000..c54c51d --- /dev/null +++ b/shard.yml @@ -0,0 +1,17 @@ +name: irs +version: 0.1.0 + +authors: + - Cooper Hammond + +targets: + irs: + main: src/irs.cr + +crystal: 0.28.0 + +license: MIT + +dependencies: + spotify: + github: marceloboeira/spotify.cr \ No newline at end of file diff --git a/spec/irs_spec.cr b/spec/irs_spec.cr new file mode 100644 index 0000000..9562b57 --- /dev/null +++ b/spec/irs_spec.cr @@ -0,0 +1,9 @@ +require "./spec_helper" + +describe Irs do + # TODO: Write tests + + it "works" do + false.should eq(true) + end +end diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr new file mode 100644 index 0000000..5c3c333 --- /dev/null +++ b/spec/spec_helper.cr @@ -0,0 +1,2 @@ +require "spec" +require "../src/irs" diff --git a/src/irs.cr b/src/irs.cr new file mode 100644 index 0000000..e493a31 --- /dev/null +++ b/src/irs.cr @@ -0,0 +1,6 @@ +# TODO: Write documentation for `IRS` +module IRS + VERSION = "0.1.0" + + # TODO: Put your code here +end diff --git a/src/search/spotify.cr b/src/search/spotify.cr new file mode 100644 index 0000000..edfe811 --- /dev/null +++ b/src/search/spotify.cr @@ -0,0 +1,104 @@ +require "base64" + +require "spotify" + + +class SpotifySearcher + @root_url = Path["https://api.spotify.com/v1/"] + + @access_header : (HTTP::Headers | Nil) = nil + @authorized = false + + # Saves an access token for future program use with spotify using client IDs. + # Specs defined on spotify's developer api: + # https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow + # + # ``` + # SpotifySearcher.new().authorize("XXXXXXXXXX", "XXXXXXXXXX") + # ``` + def authorize(client_id : String, client_secret : String) + auth_url = "https://accounts.spotify.com/api/token" + + headers = HTTP::Headers{ + "Authorization" => "Basic " + + Base64.strict_encode "#{client_id}:#{client_secret}" + } + + payload = "grant_type=client_credentials" + + response = HTTP::Client.post(auth_url, headers: headers, form: payload) + + if response.status_code == 200 + access_token = JSON.parse(response.body)["access_token"] + + @access_header = HTTP::Headers{ + "Authorization" => "Bearer #{access_token}" + } + + @authorized = true + + end + + return self + end + + # Searches spotify and returns track metadata in `Hash` format. + # + # ``` + # spotify_searcher.find_track("Bohemian Rhapsody", "Queen") + # => hash of metadata + # ``` + def find_track(track_name : String, artist_name : String) + + query = "track:#{track_name.sub(" ", "+")}+" + + "artist:#{artist_name.sub(" ", "+")}" + + "&type=track" + + url = @root_url.join("search?q=#{query}").to_s() + + response = HTTP::Client.get(url, headers: @access_header) + + puts response.body + + end + + # Searches spotify with the specified parameters for the specified items + # + # ``` + # spotify_searcher.find_item("track", { + # "artist" => "Queen", + # "track" => "Bohemian Rhapsody" + # }) + # ``` + def find_item(item_type : String, item_parameters : Hash) + query = "" + + item_parameters.keys.each do |i| + query += "#{i.sub(" ", "+")}:#{item_parameters[i].sub(" ", "+")}+" + end + query += "&type=#{item_type}" + + url = @root_url.join("search?q=#{query}").to_s() + + response = HTTP::Client.get(url, headers: @access_header) + + if response.status_code != 200 + puts "There was an error with your request." + puts "Status code #{response.status_code}" + return nil + end + + items = JSON.parse(response.body)[item_type + "s"] + + end + +end + + +SpotifySearcher.new + .authorize("e4198f6a3f7b48029366f22528b5dc66", + "ba057d0621a5496bbb64edccf758bde5") + .find_item("track", { + "artist" => "Queen", + "track" => "Bohemian Rhapsody" + }) \ No newline at end of file From ddcd611585c2810fe9c4bde278edcdfd2f1b09c8 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Tue, 11 Jun 2019 13:57:57 -0700 Subject: [PATCH 02/26] Spotify searcher is now minimum viable product. --- src/search/spotify.cr | 143 +++++++++++++++++++++++++++++++++--------- 1 file changed, 112 insertions(+), 31 deletions(-) diff --git a/src/search/spotify.cr b/src/search/spotify.cr index edfe811..cb5f847 100644 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -42,26 +42,6 @@ class SpotifySearcher return self end - # Searches spotify and returns track metadata in `Hash` format. - # - # ``` - # spotify_searcher.find_track("Bohemian Rhapsody", "Queen") - # => hash of metadata - # ``` - def find_track(track_name : String, artist_name : String) - - query = "track:#{track_name.sub(" ", "+")}+" + - "artist:#{artist_name.sub(" ", "+")}" + - "&type=track" - - url = @root_url.join("search?q=#{query}").to_s() - - response = HTTP::Client.get(url, headers: @access_header) - - puts response.body - - end - # Searches spotify with the specified parameters for the specified items # # ``` @@ -69,14 +49,11 @@ class SpotifySearcher # "artist" => "Queen", # "track" => "Bohemian Rhapsody" # }) + # => {track metadata} # ``` - def find_item(item_type : String, item_parameters : Hash) - query = "" + def find_item(item_type : String, item_parameters : Hash, offset=0, limit=20) - item_parameters.keys.each do |i| - query += "#{i.sub(" ", "+")}:#{item_parameters[i].sub(" ", "+")}+" - end - query += "&type=#{item_type}" + query = __generate_query(item_type, item_parameters, offset, limit) url = @root_url.join("search?q=#{query}").to_s() @@ -84,21 +61,125 @@ class SpotifySearcher if response.status_code != 200 puts "There was an error with your request." - puts "Status code #{response.status_code}" + puts "Status code: #{response.status_code}" + puts "Reponse: \n#{response.body}" return nil end - items = JSON.parse(response.body)[item_type + "s"] + items = JSON.parse(response.body)[item_type + "s"]["items"].as_a + points = __rank_items(items, item_parameters) + + return items[points[0][1]] + + end + + # Generates url to run a GET request against + private def __generate_query(item_type : String, item_parameters : Hash, + offset : Int32, limit : Int32) + query = "" + + # parameter keys to exclude in the api request. These values will be put + # in, just not their keys. + query_exclude = ["username"] + + item_parameters.keys.each do |k| + # This will map album, playlist, and track from the name key to the query + if k == "name" + query += __param_encode(item_type, item_parameters[k]) + + # check if the key is to be excluded + elsif !query_exclude.includes?(k) + query += item_parameters[k].gsub(" ", "+") + "+" + + # if it's none of the above, treat it normally + else + query += __param_encode(k, item_parameters[k]) + end + end + + # extra api info + query += "&type=#{item_type}&offset=#{offset}&limit=#{limit}" + + return query + end + + # Ranks the given items based off of the info from parameters. + # Meant to find the item that the user desires. + private def __rank_items(items : Array, parameters : Hash) + points = [] of Array(Int32) + index = 0 + + items.each do |item| + pts = 0 + + # Think about whether this following logic is worth having in one method. + # Is it nice to have a single method that handles it all or having a few + # methods for each of the item types? (track, album, playlist) + parameters.keys.each do |k| + val = parameters[k] + + # The key to compare to for artist + if k == "artist" + pts += __points_compare(item["artists"][0]["name"].to_s, val) + end + + # The key to compare to for playlists + if k == "username" + pts += __points_compare(item["owner"]["display_name"].to_s, val) + end + + # The key regardless of whether item is track, album,or playlist + if k == "name" + pts += __points_compare(item["name"].to_s, val) + end + end + + points.push([pts, index]) + index += 1 + end + + points.sort!{ |a, b| b[0] <=> a[0] } + + return points + end + + # Returns an `Int` based off the number of points worth assigning to the + # matchiness of the string. First the strings are downcased and then all + # nonalphanumeric characters are stripped. + # If the strings are the exact same, return 3 pts. + # If *item1* includes *item2*, return 1 pt. + # Else, return 0 pts. + private def __points_compare(item1 : String, item2 : String) + item1 = item1.downcase.gsub(/[^a-z0-9]/, "") + item2 = item2.downcase.gsub(/[^a-z0-9]/, "") + + if item1 == item2 + return 3 + elsif item1.includes?(item2) + return 1 + else + return 0 + end + end + + # Returns a parameter encoded for the spotify api + # + # ``` + # __query_encode("album", "A Night At The Opera") + # => "album:A+Night+At+The+Opera" + # ``` + private def __param_encode(key : String, value : String) + return key.gsub(" ", "+") + ":" + value.gsub(" ", "+") + "+" end end -SpotifySearcher.new +puts SpotifySearcher.new() .authorize("e4198f6a3f7b48029366f22528b5dc66", "ba057d0621a5496bbb64edccf758bde5") .find_item("track", { - "artist" => "Queen", - "track" => "Bohemian Rhapsody" + "name" => "Bohemian Rhapsody", + "artist" => "Queen" }) \ No newline at end of file From 45f4d998a4392a2aa9c69f14676e666e793f921a Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Wed, 12 Jun 2019 12:52:37 -0700 Subject: [PATCH 03/26] finished youtube searcher --- src/search/spotify.cr | 24 +++++---- src/search/youtube.cr | 119 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 132 insertions(+), 11 deletions(-) create mode 100644 src/search/youtube.cr diff --git a/src/search/spotify.cr b/src/search/spotify.cr index cb5f847..4130f86 100644 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -1,7 +1,7 @@ +require "http" +require "json" require "base64" -require "spotify" - class SpotifySearcher @root_url = Path["https://api.spotify.com/v1/"] @@ -74,7 +74,8 @@ class SpotifySearcher end - # Generates url to run a GET request against + # Generates url to run a GET request against to the Spotify open API + # Returns a `String.` private def __generate_query(item_type : String, item_parameters : Hash, offset : Int32, limit : Int32) query = "" @@ -106,6 +107,7 @@ class SpotifySearcher # Ranks the given items based off of the info from parameters. # Meant to find the item that the user desires. + # Returns an `Array` of `Array(Int32)` or [[3, 1], [...], ...] private def __rank_items(items : Array, parameters : Hash) points = [] of Array(Int32) index = 0 @@ -163,7 +165,7 @@ class SpotifySearcher end end - # Returns a parameter encoded for the spotify api + # Returns a `String` encoded for the spotify api # # ``` # __query_encode("album", "A Night At The Opera") @@ -176,10 +178,10 @@ class SpotifySearcher end -puts SpotifySearcher.new() - .authorize("e4198f6a3f7b48029366f22528b5dc66", - "ba057d0621a5496bbb64edccf758bde5") - .find_item("track", { - "name" => "Bohemian Rhapsody", - "artist" => "Queen" - }) \ No newline at end of file +# puts SpotifySearcher.new() +# .authorize("e4198f6a3f7b48029366f22528b5dc66", +# "ba057d0621a5496bbb64edccf758bde5") +# .find_item("album", { +# "name" => "A Night At The Opera", +# "artist" => "Queen" +# }) \ No newline at end of file diff --git a/src/search/youtube.cr b/src/search/youtube.cr new file mode 100644 index 0000000..c6f98d3 --- /dev/null +++ b/src/search/youtube.cr @@ -0,0 +1,119 @@ +require "http" +require "xml" + + +module Youtube + + extend self + + VALID_LINK_CLASSES = [ + "yt-simple-endpoint style-scope ytd-video-renderer", + "yt-uix-tile-link yt-ui-ellipsis yt-ui-ellipsis-2 yt-uix-sessionlink spf-link " + ] + + # Finds a youtube url based off of the given information. + # The query to youtube is constructed like this: + # " " + # If *download_first* is provided, the first link found will be downloaded. + # + # ``` + # Youtube.find_url("Bohemian Rhapsody", "Queen") + # => "https://www.youtube.com/watch?v=dQw4w9WgXcQ" + # ``` + def find_url(song_name : String, artist_name : String, search_terms = "", download_first = false) + query = (song_name + " " + artist_name + " " + search_terms).strip.gsub(" ", "+") + + url = "https://www.youtube.com/results?search_query=" + query + + response = HTTP::Client.get(url) + + valid_nodes = __get_video_link_nodes(response.body) + + if valid_nodes.size == 0 + puts "There were no results for that query." + return nil + end + + root = "https://youtube.com" + + return root + valid_nodes[0]["href"] if download_first + + ranked = __rank_videos(song_name, artist_name, valid_nodes) + + return root + valid_nodes[ranked[0][1]]["href"] + end + + # Will rank videos according to their title and the user input + # Returns an `Array` of Arrays each layed out like + # [, ]. + private def __rank_videos(song_name, artist_name, nodes : Array(XML::Node)) + points = [] of Array(Int32) + index = 0 + + nodes.each do |node| + pts = 0 + + pts += __points_compare(song_name, node["title"]) + pts += __points_compare(artist_name, node["title"]) + + points.push([pts, index]) + index += 1 + end + + points.sort!{ |a, b| b[0] <=> a[0] } + + return points + end + + # Returns an `Int` based off the number of points worth assigning to the + # matchiness of the string. First the strings are downcased and then all + # nonalphanumeric characters are stripped. + # If *item1* includes *item2*, return 3 pts. + # If after the items have been blanked, *item1* includes *item2*, + # return 1 pts. + # Else, return 0 pts. + private def __points_compare(item1 : String, item2 : String) + if item1.includes?(item2) + return 3 + end + + item1 = item1.downcase.gsub(/[^a-z0-9]/, "") + item2 = item2.downcase.gsub(/[^a-z0-9]/, "") + + if item1.includes?(item2) + return 1 + else + return 0 + end + end + + # Finds valid video links from a `HTTP::Client.get` request + # Returns an `Array` of `XML::Node` + private def __get_video_link_nodes(doc : String) + nodes = XML.parse(doc).xpath_nodes("//a") + valid_nodes = [] of XML::Node + + nodes.each do |node| + if __video_link_node?(node) + valid_nodes.push(node) + end + end + + return valid_nodes + end + + # Tests if the provided `XML::Node` has a valid link to a video + # Returns a `Bool` + private def __video_link_node?(node : XML::Node) + # If this passes, then the node links to a playlist, not a video + if node["href"]? + return false if node["href"].includes?("&list=") + end + + VALID_LINK_CLASSES.each do |valid_class| + if node["class"]? + return true if node["class"].includes?(valid_class) + end + end + end +end \ No newline at end of file From 253efd1e119264ccff41dceca38bf4f6724ae2ae Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Wed, 12 Jun 2019 22:11:16 -0700 Subject: [PATCH 04/26] ripper module finished --- shard.yml | 4 ++-- src/interact/ripper.cr | 37 +++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 2 deletions(-) create mode 100644 src/interact/ripper.cr diff --git a/shard.yml b/shard.yml index c54c51d..2862560 100644 --- a/shard.yml +++ b/shard.yml @@ -13,5 +13,5 @@ crystal: 0.28.0 license: MIT dependencies: - spotify: - github: marceloboeira/spotify.cr \ No newline at end of file + ydl_binaries: + github: cooperhammond/ydl-binaries \ No newline at end of file diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr new file mode 100644 index 0000000..eab563a --- /dev/null +++ b/src/interact/ripper.cr @@ -0,0 +1,37 @@ +module Ripper + + extend self + + BIN_LOC = Path["~/.irs/bin".sub("~", Path.home)] + + # Downloads the video from the given *video_url* using the youtube-dl binary + # Will create any directories that don't exist specified in *output_filename* + # + # ``` + # Ripper.download_mp3("https://youtube.com/watch?v=0xnciFWAqa0", + # "Queen/A Night At The Opera/Bohemian Rhapsody.mp3") + # ``` + def download_mp3(video_url : String, output_filename : String) + ydl_loc = BIN_LOC.join("youtube-dl") + + # remove the extension that will be added on by ydl + output_filename = output_filename.split(".")[..-2].join(".") + + options = { + "--output" => %("#{output_filename}.%(ext)s"), # auto-add correct ext + # "--quiet" => "", + "--ffmpeg-location" => BIN_LOC, + "--extract-audio" => "", + "--audio-format" => "mp3", + "--audio-quality" => "0", + } + + command = ydl_loc.to_s + " " + video_url + options.keys.each do |option| + command += " #{option} #{options[option]}" + end + + system(command) + end + +end \ No newline at end of file From f82affb589e716c31f248bfdc12e67b8432680e2 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 14 Jun 2019 08:22:38 -0700 Subject: [PATCH 05/26] fixed youtube search ranking algo --- src/interact/ripper.cr | 2 ++ src/search/youtube.cr | 70 +++++++++++++++++++++++++++++++++++++----- 2 files changed, 64 insertions(+), 8 deletions(-) diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index eab563a..747a8e4 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -17,6 +17,8 @@ module Ripper # remove the extension that will be added on by ydl output_filename = output_filename.split(".")[..-2].join(".") + # TODO: update the logger for this. Explore overwriting stdout and + # injecting/removing text options = { "--output" => %("#{output_filename}.%(ext)s"), # auto-add correct ext # "--quiet" => "", diff --git a/src/search/youtube.cr b/src/search/youtube.cr index c6f98d3..d2691ef 100644 --- a/src/search/youtube.cr +++ b/src/search/youtube.cr @@ -11,6 +11,16 @@ module Youtube "yt-uix-tile-link yt-ui-ellipsis yt-ui-ellipsis-2 yt-uix-sessionlink spf-link " ] + GARBAGE_PHRASES = [ + "cover", "album", "live", "clean", "version", "full", "full album", "row", + "at", "@", "session", "how to", "npr music", "reimagined", "hr version", + "trailer" + ] + + GOLDEN_PHRASES = [ + "official video", "official music video" + ] + # Finds a youtube url based off of the given information. # The query to youtube is constructed like this: # " " @@ -38,16 +48,16 @@ module Youtube return root + valid_nodes[0]["href"] if download_first - ranked = __rank_videos(song_name, artist_name, valid_nodes) + ranked = __rank_videos(song_name, artist_name, query, valid_nodes) - return root + valid_nodes[ranked[0][1]]["href"] + return root + valid_nodes[ranked[0]["index"]]["href"] end # Will rank videos according to their title and the user input # Returns an `Array` of Arrays each layed out like # [, ]. - private def __rank_videos(song_name, artist_name, nodes : Array(XML::Node)) - points = [] of Array(Int32) + private def __rank_videos(song_name : String, artist_name : String, query : String, nodes : Array(XML::Node)) + points = [] of Hash(String, Int32) index = 0 nodes.each do |node| @@ -55,12 +65,24 @@ module Youtube pts += __points_compare(song_name, node["title"]) pts += __points_compare(artist_name, node["title"]) + pts += __count_buzzphrases(query, node["title"]) - points.push([pts, index]) + points.push({ + "points" => pts, + "index" => index + }) index += 1 + end - points.sort!{ |a, b| b[0] <=> a[0] } + # Sort first by points and then by original index of the song + points.sort!{ |a, b| + if b["points"] == a["points"] + a["index"] <=> b["index"] + else + b["points"] <=> a["points"] + end + } return points end @@ -73,20 +95,52 @@ module Youtube # return 1 pts. # Else, return 0 pts. private def __points_compare(item1 : String, item2 : String) - if item1.includes?(item2) + if item2.includes?(item1) return 3 end item1 = item1.downcase.gsub(/[^a-z0-9]/, "") item2 = item2.downcase.gsub(/[^a-z0-9]/, "") - if item1.includes?(item2) + if item2.includes?(item1) return 1 else return 0 end end + # Checks if there are any phrases in the title of the video that would + # indicate audio having what we want. + # *video_name* is the title of the video, and *query* is what the user the + # program searched for. *query* is needed in order to make sure we're not + # subtracting points from something that's naturally in the title + private def __count_buzzphrases(query : String, video_name : String) + good_phrases = 0 + bad_phrases = 0 + + GOLDEN_PHRASES.each do |gold_phrase| + gold_phrase = gold_phrase.downcase.gsub(/[^a-z0-9]/, "") + + if query.downcase.gsub(/[^a-z0-9]/, "").includes?(gold_phrase) + next + elsif video_name.downcase.gsub(/[^a-z0-9]/, "").includes?(gold_phrase) + bad_phrases += 1 + end + end + + GARBAGE_PHRASES.each do |garbage_phrase| + garbage_phrase = garbage_phrase.downcase.gsub(/[^a-z0-9]/, "") + + if query.downcase.gsub(/[^a-z0-9]/, "").includes?(garbage_phrase) + next + elsif video_name.downcase.gsub(/[^a-z0-9]/, "").includes?(garbage_phrase) + bad_phrases += 1 + end + end + + return good_phrases - bad_phrases + end + # Finds valid video links from a `HTTP::Client.get` request # Returns an `Array` of `XML::Node` private def __get_video_link_nodes(doc : String) From 219cc4bc5320b95ac27c76663762a2b42c6be530 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 14 Jun 2019 11:39:51 -0700 Subject: [PATCH 06/26] tagger based off of ffmpeg created --- shard.lock | 10 ++++++--- shard.yml | 4 ++-- src/interact/tagger.cr | 46 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 5 deletions(-) create mode 100644 src/interact/tagger.cr diff --git a/shard.lock b/shard.lock index de2e9e8..8226e24 100644 --- a/shard.lock +++ b/shard.lock @@ -1,6 +1,10 @@ version: 1.0 shards: - spotify: - github: marceloboeira/spotify.cr - commit: 347727a4ebe4f3f4e55f6032de17cdd554a676bd + cr-taglib: + github: teknomunk/cr-taglib + commit: 5bfca75aaac31c0e4eee4c6e0d72c624af773c09 + + ydl_binaries: + github: cooperhammond/ydl-binaries + commit: 8a622bf9d2c0b848db8d8db2f46f09334a1f03f8 diff --git a/shard.yml b/shard.yml index 2862560..2064a6d 100644 --- a/shard.yml +++ b/shard.yml @@ -13,5 +13,5 @@ crystal: 0.28.0 license: MIT dependencies: - ydl_binaries: - github: cooperhammond/ydl-binaries \ No newline at end of file + ydl_binaries: + github: cooperhammond/ydl-binaries \ No newline at end of file diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr new file mode 100644 index 0000000..ae4adfa --- /dev/null +++ b/src/interact/tagger.cr @@ -0,0 +1,46 @@ +# TODO: write comments/documentation + +class Tags + + @BIN_LOC = Path["~/.irs/bin".sub("~", Path.home)] + @query_args = [] of String + + + def initialize(@filename : String) + if !File.exists?(@filename) + raise "MP3 not found at location: #{@filename}" + end + + @query_args.push(%(-i "#{@filename}")) + + end + + def add_text_tag(key : String, value : String) + @query_args.push(%(-metadata #{key}="#{value}")) + end + + def add_album_art(image_location : String) + if !File.exists?(image_location) + raise "Image file not found at location: #{image_location}" + end + + @query_args.push(%(-i "#{image_location}")) + @query_args.push("-map 0:0 -map 1:0") + @query_args.push("-c copy") + @query_args.push("-id3v2_version 3") + @query_args.push(%(-metadata:s:v title="Album cover")) + @query_args.push(%(-metadata:s:v comment="Cover (front)")) + @query_args.push(%(-metadata:s:v title="Album cover")) + end + + def save + @query_args.push(%("#{@filename}")) + command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") + puts command + end +end + +# a = Tags.new("test.mp3") +# a.add_text_tag("title", "Warwick Avenue") +# a.add_album_art("file.png") +# a.save() \ No newline at end of file From cce8e2aeafef204d8adae0d21a0c769fd826ab0a Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 14 Jun 2019 18:01:22 -0700 Subject: [PATCH 07/26] tagger edits --- shard.lock | 4 ---- src/interact/ripper.cr | 2 +- src/interact/tagger.cr | 7 +++++-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/shard.lock b/shard.lock index 8226e24..d04a714 100644 --- a/shard.lock +++ b/shard.lock @@ -1,9 +1,5 @@ version: 1.0 shards: - cr-taglib: - github: teknomunk/cr-taglib - commit: 5bfca75aaac31c0e4eee4c6e0d72c624af773c09 - ydl_binaries: github: cooperhammond/ydl-binaries commit: 8a622bf9d2c0b848db8d8db2f46f09334a1f03f8 diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 747a8e4..5ccfedf 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -32,7 +32,7 @@ module Ripper options.keys.each do |option| command += " #{option} #{options[option]}" end - + system(command) end diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index ae4adfa..dbf944c 100644 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -34,9 +34,12 @@ class Tags end def save - @query_args.push(%("#{@filename}")) + @query_args.push(%("_#{@filename}")) command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") - puts command + system command + + File.delete(@filename) + File.rename("_" + @filename, @filename) end end From 6c32571ccc2422b8ba647e5b8cf1f09d7c3781b2 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 14 Jun 2019 18:01:22 -0700 Subject: [PATCH 08/26] tagger edits --- shard.lock | 4 ---- src/interact/ripper.cr | 4 ++-- src/interact/tagger.cr | 13 ++++++++----- src/search/spotify.cr | 21 +++++++++++++-------- src/search/youtube.cr | 16 +++++++++------- 5 files changed, 32 insertions(+), 26 deletions(-) diff --git a/shard.lock b/shard.lock index 8226e24..d04a714 100644 --- a/shard.lock +++ b/shard.lock @@ -1,9 +1,5 @@ version: 1.0 shards: - cr-taglib: - github: teknomunk/cr-taglib - commit: 5bfca75aaac31c0e4eee4c6e0d72c624af773c09 - ydl_binaries: github: cooperhammond/ydl-binaries commit: 8a622bf9d2c0b848db8d8db2f46f09334a1f03f8 diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 747a8e4..376199e 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -11,7 +11,7 @@ module Ripper # Ripper.download_mp3("https://youtube.com/watch?v=0xnciFWAqa0", # "Queen/A Night At The Opera/Bohemian Rhapsody.mp3") # ``` - def download_mp3(video_url : String, output_filename : String) + def download_mp3(video_url : String, output_filename : String) : Nil ydl_loc = BIN_LOC.join("youtube-dl") # remove the extension that will be added on by ydl @@ -32,7 +32,7 @@ module Ripper options.keys.each do |option| command += " #{option} #{options[option]}" end - + system(command) end diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index ae4adfa..fb1d58c 100644 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -15,11 +15,11 @@ class Tags end - def add_text_tag(key : String, value : String) + def add_text_tag(key : String, value : String) : Nil @query_args.push(%(-metadata #{key}="#{value}")) end - def add_album_art(image_location : String) + def add_album_art(image_location : String) : Nil if !File.exists?(image_location) raise "Image file not found at location: #{image_location}" end @@ -33,10 +33,13 @@ class Tags @query_args.push(%(-metadata:s:v title="Album cover")) end - def save - @query_args.push(%("#{@filename}")) + def save : Nil + @query_args.push(%("_#{@filename}")) command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") - puts command + system command + + File.delete(@filename) + File.rename("_" + @filename, @filename) end end diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 4130f86..3fdfad5 100644 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -16,7 +16,7 @@ class SpotifySearcher # ``` # SpotifySearcher.new().authorize("XXXXXXXXXX", "XXXXXXXXXX") # ``` - def authorize(client_id : String, client_secret : String) + def authorize(client_id : String, client_secret : String) : self auth_url = "https://accounts.spotify.com/api/token" headers = HTTP::Headers{ @@ -51,7 +51,8 @@ class SpotifySearcher # }) # => {track metadata} # ``` - def find_item(item_type : String, item_parameters : Hash, offset=0, limit=20) + def find_item(item_type : String, item_parameters : Hash, offset=0, + limit=20) : JSON::Any? query = __generate_query(item_type, item_parameters, offset, limit) @@ -70,14 +71,17 @@ class SpotifySearcher points = __rank_items(items, item_parameters) - return items[points[0][1]] - + begin + return items[points[0][1]] + rescue IndexException + return nil + end end # Generates url to run a GET request against to the Spotify open API # Returns a `String.` private def __generate_query(item_type : String, item_parameters : Hash, - offset : Int32, limit : Int32) + offset : Int32, limit : Int32) : String query = "" # parameter keys to exclude in the api request. These values will be put @@ -108,7 +112,8 @@ class SpotifySearcher # Ranks the given items based off of the info from parameters. # Meant to find the item that the user desires. # Returns an `Array` of `Array(Int32)` or [[3, 1], [...], ...] - private def __rank_items(items : Array, parameters : Hash) + private def __rank_items(items : Array, + parameters : Hash) : Array(Array(Int32)) points = [] of Array(Int32) index = 0 @@ -152,7 +157,7 @@ class SpotifySearcher # If the strings are the exact same, return 3 pts. # If *item1* includes *item2*, return 1 pt. # Else, return 0 pts. - private def __points_compare(item1 : String, item2 : String) + private def __points_compare(item1 : String, item2 : String) : Int32 item1 = item1.downcase.gsub(/[^a-z0-9]/, "") item2 = item2.downcase.gsub(/[^a-z0-9]/, "") @@ -171,7 +176,7 @@ class SpotifySearcher # __query_encode("album", "A Night At The Opera") # => "album:A+Night+At+The+Opera" # ``` - private def __param_encode(key : String, value : String) + private def __param_encode(key : String, value : String) : String return key.gsub(" ", "+") + ":" + value.gsub(" ", "+") + "+" end diff --git a/src/search/youtube.cr b/src/search/youtube.cr index d2691ef..4c82655 100644 --- a/src/search/youtube.cr +++ b/src/search/youtube.cr @@ -30,7 +30,8 @@ module Youtube # Youtube.find_url("Bohemian Rhapsody", "Queen") # => "https://www.youtube.com/watch?v=dQw4w9WgXcQ" # ``` - def find_url(song_name : String, artist_name : String, search_terms = "", download_first = false) + def find_url(song_name : String, artist_name : String, search_terms = "", + download_first = false) : Nil query = (song_name + " " + artist_name + " " + search_terms).strip.gsub(" ", "+") url = "https://www.youtube.com/results?search_query=" + query @@ -56,7 +57,8 @@ module Youtube # Will rank videos according to their title and the user input # Returns an `Array` of Arrays each layed out like # [, ]. - private def __rank_videos(song_name : String, artist_name : String, query : String, nodes : Array(XML::Node)) + private def __rank_videos(song_name : String, artist_name : String, + query : String, nodes : Array(XML::Node)) : Array(Array(Int32)) points = [] of Hash(String, Int32) index = 0 @@ -94,7 +96,7 @@ module Youtube # If after the items have been blanked, *item1* includes *item2*, # return 1 pts. # Else, return 0 pts. - private def __points_compare(item1 : String, item2 : String) + private def __points_compare(item1 : String, item2 : String) : Int32 if item2.includes?(item1) return 3 end @@ -114,7 +116,7 @@ module Youtube # *video_name* is the title of the video, and *query* is what the user the # program searched for. *query* is needed in order to make sure we're not # subtracting points from something that's naturally in the title - private def __count_buzzphrases(query : String, video_name : String) + private def __count_buzzphrases(query : String, video_name : String) : Int32 good_phrases = 0 bad_phrases = 0 @@ -124,7 +126,7 @@ module Youtube if query.downcase.gsub(/[^a-z0-9]/, "").includes?(gold_phrase) next elsif video_name.downcase.gsub(/[^a-z0-9]/, "").includes?(gold_phrase) - bad_phrases += 1 + good_phrases += 1 end end @@ -143,7 +145,7 @@ module Youtube # Finds valid video links from a `HTTP::Client.get` request # Returns an `Array` of `XML::Node` - private def __get_video_link_nodes(doc : String) + private def __get_video_link_nodes(doc : String) : Array(XML::Node) nodes = XML.parse(doc).xpath_nodes("//a") valid_nodes = [] of XML::Node @@ -158,7 +160,7 @@ module Youtube # Tests if the provided `XML::Node` has a valid link to a video # Returns a `Bool` - private def __video_link_node?(node : XML::Node) + private def __video_link_node?(node : XML::Node) : Bool # If this passes, then the node links to a playlist, not a video if node["href"]? return false if node["href"].includes?("&list=") From acd2abb1d0e9059c5941c7642d2f33d14966ba22 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Wed, 19 Jun 2019 19:06:09 -0700 Subject: [PATCH 09/26] song glue done! --- .gitignore | 2 + src/glue/song.cr | 122 +++++++++++++++++++++++++++++++++++++++++ src/interact/ripper.cr | 8 ++- src/interact/tagger.cr | 2 +- src/search/spotify.cr | 57 +++++++++++++------ src/search/youtube.cr | 18 ++++-- 6 files changed, 184 insertions(+), 25 deletions(-) create mode 100644 src/glue/song.cr diff --git a/.gitignore b/.gitignore index 0bb75ea..b48c7f5 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,5 @@ /bin/ /.shards/ *.dwarf + +*.mp3 \ No newline at end of file diff --git a/src/glue/song.cr b/src/glue/song.cr new file mode 100644 index 0000000..5497aea --- /dev/null +++ b/src/glue/song.cr @@ -0,0 +1,122 @@ +require "../search/spotify" +require "../search/youtube" + +require "../interact/ripper" +require "../interact/tagger" + + +class Song + @spotify_searcher = SpotifySearcher.new() + @client_id = "" + @client_secret = "" + + @metadata : JSON::Any? + @filename : String? + + def initialize(@song_name : String, @artist_name : String) + end + + # Find, downloads, and tags the mp3 song that this class represents. + # Will return true on complete success and false on failure. + # + # ``` + # Song.new("Bohemian Rhapsody", "Queen").grab_it() + # ``` + def grab_it : Nil + if !@spotify_searcher.authorized? && !@metadata + if @client_id != "" && @client_secret != "" + @spotify_searcher.authorize(@client_id, @client_secret) + else + raise("Need to call either `provide_metadata`, `provide_spotify`, " + + "or `provide_client_keys` so that Spotify can be interfaced with.") + end + end + + if !@metadata + @metadata = @spotify_searcher.find_item("track", { + "name" => @song_name, + "artist" => @artist_name + }) + + if !@metadata + raise("There was no metadata found on Spotify for\n" + + %("#{@song_name}" by "#{@artist_name}\n) + + "Check your input and try again.") + end + end + + data = @metadata.as(JSON::Any) + filename = data["track_number"].to_s + " - #{data["name"].to_s}.mp3" + + url = Youtube.find_url(@song_name, @artist_name, search_terms: "lyrics") + + if !url + raise("There was no link found on youtube for\n" + + %("#{@song_name}" by "#{@artist_name}\n) + + "Check your input and try again.") + end + + + Ripper.download_mp3(url.as(String), filename) + + temp_albumart_filename = ".tempalbumart.jpg" + HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| + File.write(temp_albumart_filename, response.body_io) + end + + tagger = Tags.new(filename) + tagger.add_album_art(temp_albumart_filename) + tagger.add_text_tag("title", data["name"].to_s) + tagger.add_text_tag("artist", data["artists"][0]["name"].to_s) + tagger.add_text_tag("album", data["album"]["name"].to_s) + tagger.add_text_tag("genre", + @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) + tagger.add_text_tag("track", data["track_number"].to_s) + tagger.add_text_tag("disc", data["disc_number"].to_s) + + tagger.save() + File.delete(temp_albumart_filename) + + end + + # Provide metadata so that it doesn't have to find it. Useful for overwriting + # metadata. Must be called if provide_client_keys and provide_spotify are not + # called. + # + # ``` + # Song.new(...).provide_metadata(...).grab_it() + # ``` + def provide_metadata(metadata : JSON::Any) : self + @metadata = metadata + return self + end + + # Provide an already authenticated `SpotifySearcher` class. Useful to avoid + # authenticating over and over again. Must be called if provide_metadata and + # provide_client_keys are not called. + # + # ``` + # Song.new(...).provide_spotify(SpotifySearcher.new() + # .authenticate("XXXXXXXXXX", "XXXXXXXXXXX")).grab_it() + # ``` + def provide_spotify(spotify : SpotifySearcher) : self + @spotify = spotify + return self + end + + # Provide spotify client keys. Must be called if provide_metadata and + # provide_spotify are not called. + # + # ``` + # Song.new(...).provide_client_keys("XXXXXXXXXX", "XXXXXXXXX").grab_it() + # ``` + def provide_client_keys(client_id : String, client_secret : String) : self + @client_id = client_id + @client_secret = client_secret + return self + end +end + +# s = Song.new("Bohemian Rhapsody", "Queen") +# s.provide_client_keys("e4198f6a3f7b48029366f22528b5dc66", "ba057d0621a5496bbb64edccf758bde5") +# s.grab_it() \ No newline at end of file diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 376199e..779480f 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -11,7 +11,7 @@ module Ripper # Ripper.download_mp3("https://youtube.com/watch?v=0xnciFWAqa0", # "Queen/A Night At The Opera/Bohemian Rhapsody.mp3") # ``` - def download_mp3(video_url : String, output_filename : String) : Nil + def download_mp3(video_url : String, output_filename : String) : Bool ydl_loc = BIN_LOC.join("youtube-dl") # remove the extension that will be added on by ydl @@ -33,7 +33,11 @@ module Ripper command += " #{option} #{options[option]}" end - system(command) + if system(command) + return true + else + return false + end end end \ No newline at end of file diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index fb1d58c..50208d1 100644 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -36,7 +36,7 @@ class Tags def save : Nil @query_args.push(%("_#{@filename}")) command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") - system command + system(command) File.delete(@filename) File.rename("_" + @filename, @filename) diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 3fdfad5..ab70007 100644 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -27,21 +27,24 @@ class SpotifySearcher payload = "grant_type=client_credentials" response = HTTP::Client.post(auth_url, headers: headers, form: payload) + __error_check(response) - if response.status_code == 200 - access_token = JSON.parse(response.body)["access_token"] - - @access_header = HTTP::Headers{ - "Authorization" => "Bearer #{access_token}" - } + access_token = JSON.parse(response.body)["access_token"] + + @access_header = HTTP::Headers{ + "Authorization" => "Bearer #{access_token}" + } - @authorized = true - - end + @authorized = true return self end + # Check if the class is authorized or not + def authorized? : Bool + return @authorized + end + # Searches spotify with the specified parameters for the specified items # # ``` @@ -59,13 +62,7 @@ class SpotifySearcher url = @root_url.join("search?q=#{query}").to_s() response = HTTP::Client.get(url, headers: @access_header) - - if response.status_code != 200 - puts "There was an error with your request." - puts "Status code: #{response.status_code}" - puts "Reponse: \n#{response.body}" - return nil - end + __error_check(response) items = JSON.parse(response.body)[item_type + "s"]["items"].as_a @@ -73,10 +70,36 @@ class SpotifySearcher begin return items[points[0][1]] - rescue IndexException + rescue IndexError return nil end end + + # Find the genre of an artist based off of their id + # + # ``` + # SpotifySearcher.new().authorize(...).find_genre("1dfeR4HaWDbWqFHLkxsg1d") + # ``` + def find_genre(id : String) : String + url = @root_url.join("artists/#{id}").to_s() + + response = HTTP::Client.get(url, headers: @access_header) + __error_check(response) + + genre = JSON.parse(response.body)["genres"][0].to_s + genre = genre.split(" ").map { |x| x.capitalize }.join(" ") + + return genre + end + + # Checks for errors in HTTP requests and raises one if found + private def __error_check(response : HTTP::Client::Response) : Nil + if response.status_code != 200 + raise("There was an error with your request.\n" + + "Status code: #{response.status_code}\n" + + "Response: \n#{response.body}") + end + end # Generates url to run a GET request against to the Spotify open API # Returns a `String.` diff --git a/src/search/youtube.cr b/src/search/youtube.cr index 4c82655..442d9b7 100644 --- a/src/search/youtube.cr +++ b/src/search/youtube.cr @@ -31,7 +31,7 @@ module Youtube # => "https://www.youtube.com/watch?v=dQw4w9WgXcQ" # ``` def find_url(song_name : String, artist_name : String, search_terms = "", - download_first = false) : Nil + download_first = false) : String? query = (song_name + " " + artist_name + " " + search_terms).strip.gsub(" ", "+") url = "https://www.youtube.com/results?search_query=" + query @@ -51,14 +51,21 @@ module Youtube ranked = __rank_videos(song_name, artist_name, query, valid_nodes) - return root + valid_nodes[ranked[0]["index"]]["href"] + begin + return root + valid_nodes[ranked[0]["index"]]["href"] + rescue IndexError + return nil + end end # Will rank videos according to their title and the user input - # Returns an `Array` of Arrays each layed out like - # [, ]. + # Return: + # [ + # {"points" => x, "index" => x}, + # ... + # ] private def __rank_videos(song_name : String, artist_name : String, - query : String, nodes : Array(XML::Node)) : Array(Array(Int32)) + query : String, nodes : Array(XML::Node)) : Array(Hash(String, Int32)) points = [] of Hash(String, Int32) index = 0 @@ -171,5 +178,6 @@ module Youtube return true if node["class"].includes?(valid_class) end end + return false end end \ No newline at end of file From 76a624d32f6fa5749689741a0d2ee2470adc20b7 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Thu, 20 Jun 2019 09:43:31 -0700 Subject: [PATCH 10/26] Initial CLI done! --- src/bottle/cli.cr | 138 ++++++++++++++++++++++++++++++++++++++++++ src/bottle/config.cr | 0 src/bottle/styles.cr | 23 +++++++ src/bottle/version.cr | 3 + src/irs.cr | 10 +-- src/search/spotify.cr | 32 +++++----- src/search/youtube.cr | 22 +++---- 7 files changed, 197 insertions(+), 31 deletions(-) create mode 100644 src/bottle/cli.cr create mode 100644 src/bottle/config.cr create mode 100644 src/bottle/styles.cr create mode 100644 src/bottle/version.cr diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr new file mode 100644 index 0000000..059a467 --- /dev/null +++ b/src/bottle/cli.cr @@ -0,0 +1,138 @@ +require "./version" +require "./styles" + +require "../glue/song" + + +class CLI + + # layout: + # [[shortflag, longflag], key, type] + @options = [ + [["-h", "--help"], "help", "bool"], + [["-v", "--version"], "version", "bool"], + [["-s", "--song"], "song", "string"], + [["-a", "--artist"], "artist", "string"] + ] + + + @args : Hash(String, String) + + def initialize(argv : Array(String)) + @args = parse_args(argv) + end + + def version + puts "irs v#{IRS::VERSION}" + end + + def help + msg = <<-EOP + #{Style.bold "Usage: irs [-h] [-v] [-s -a ]"} + + Arguments: + #{Style.blue "-h, --help"} Show this help message and exit + #{Style.blue "-v, --version"} Show the program version and exit + #{Style.blue "-s, --song "} Specify song name for downloading + #{Style.blue "-a, --artist "} Specify artist name for downloading + + Examples: + $ #{Style.green %(irs --song "Bohemian Rhapsody" --artist "Queen")} + #{Style.dim %(# => downloads the song "Bohemian Rhapsody" by "Queen")} + $ #{Style.green %(irs --album "Demon Days" --artist "Gorillaz")} + #{Style.dim %(# => downloads the album "Demon Days" by "Gorillaz")} + + This project is licensed under the GNU GPL. + Project page: + EOP + + puts msg + end + + def act_on_args + if @args["help"]? + help + exit + elsif @args["version"]? + version + exit + elsif @args["song"]? && @args["artist"]? + s = Song.new(@args["song"], @args["artist"]) + s.provide_client_keys("e4198f6a3f7b48029366f22528b5dc66", "ba057d0621a5496bbb64edccf758bde5") + s.grab_it() + end + end + + private def parse_args(argv : Array(String)) : Hash(String, String) + arguments = {} of String => String + + i = 0 + current_key = "" + pass_next_arg = false + argv.each do |arg| + + # If the previous arg was an arg flag, this is an arg, so pass it + if pass_next_arg + pass_next_arg = false + i += 1 + next + end + + flag = [] of Array(String) | String + valid_flag = false + + @options.each do |option| + if option[0].includes?(arg) + flag = option + valid_flag = true + break + end + end + + # ensure the flag is actually defined + if !valid_flag + arg_error argv, i, %("#{arg}" is an invalid flag or argument.) + end + + # ensure there's an argument if the program needs one + if flag[2] == "string" && i + 1 > argv.size + arg_error argv, i, %("#{arg}" needs an argument.) + end + + + key = flag[1].as(String) + if flag[2] == "string" + arguments[key] = argv[i + 1] + pass_next_arg = true + elsif flag[2] == "bool" + arguments[key] = "true" + end + + i += 1 + end + + return arguments + end + + private def arg_error(argv : Array(String), arg : Int32, msg : String) : Nil + precursor = "irs " + + start = argv[..arg - 1] + last = argv[arg + 1..] + + distance = (precursor + start.join(" ")).size + + print Style.dim(precursor + start.join(" ")) + print Style.bold(Style.red(" " + argv[arg]).to_s) + puts Style.dim (" " + last.join(" ")) + + (0..distance).each do |i| + print " " + end + puts "^" + + puts Style.red(Style.bold(msg).to_s) + puts "Type `irs -h` to see usage." + exit 1 + end +end \ No newline at end of file diff --git a/src/bottle/config.cr b/src/bottle/config.cr new file mode 100644 index 0000000..e69de29 diff --git a/src/bottle/styles.cr b/src/bottle/styles.cr new file mode 100644 index 0000000..a474f37 --- /dev/null +++ b/src/bottle/styles.cr @@ -0,0 +1,23 @@ +require "colorize" + +class Style + def self.bold(txt) + txt.colorize.mode(:bold) + end + + def self.dim(txt) + txt.colorize.mode(:dim) + end + + def self.blue(txt) + txt.colorize(:light_blue) + end + + def self.green(txt) + txt.colorize(:light_green) + end + + def self.red(txt) + txt.colorize(:light_red) + end +end \ No newline at end of file diff --git a/src/bottle/version.cr b/src/bottle/version.cr new file mode 100644 index 0000000..7d6cb37 --- /dev/null +++ b/src/bottle/version.cr @@ -0,0 +1,3 @@ +module IRS + VERSION = "0.1.0" +end \ No newline at end of file diff --git a/src/irs.cr b/src/irs.cr index e493a31..790e351 100644 --- a/src/irs.cr +++ b/src/irs.cr @@ -1,6 +1,8 @@ -# TODO: Write documentation for `IRS` -module IRS - VERSION = "0.1.0" +require "./bottle/cli" - # TODO: Put your code here +def main + cli = CLI.new(ARGV) + cli.act_on_args() end + +main() \ No newline at end of file diff --git a/src/search/spotify.cr b/src/search/spotify.cr index ab70007..7d486fb 100644 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -27,7 +27,7 @@ class SpotifySearcher payload = "grant_type=client_credentials" response = HTTP::Client.post(auth_url, headers: headers, form: payload) - __error_check(response) + error_check(response) access_token = JSON.parse(response.body)["access_token"] @@ -57,16 +57,16 @@ class SpotifySearcher def find_item(item_type : String, item_parameters : Hash, offset=0, limit=20) : JSON::Any? - query = __generate_query(item_type, item_parameters, offset, limit) + query = generate_query(item_type, item_parameters, offset, limit) url = @root_url.join("search?q=#{query}").to_s() response = HTTP::Client.get(url, headers: @access_header) - __error_check(response) + error_check(response) items = JSON.parse(response.body)[item_type + "s"]["items"].as_a - points = __rank_items(items, item_parameters) + points = rank_items(items, item_parameters) begin return items[points[0][1]] @@ -84,7 +84,7 @@ class SpotifySearcher url = @root_url.join("artists/#{id}").to_s() response = HTTP::Client.get(url, headers: @access_header) - __error_check(response) + error_check(response) genre = JSON.parse(response.body)["genres"][0].to_s genre = genre.split(" ").map { |x| x.capitalize }.join(" ") @@ -93,7 +93,7 @@ class SpotifySearcher end # Checks for errors in HTTP requests and raises one if found - private def __error_check(response : HTTP::Client::Response) : Nil + private def error_check(response : HTTP::Client::Response) : Nil if response.status_code != 200 raise("There was an error with your request.\n" + "Status code: #{response.status_code}\n" + @@ -103,7 +103,7 @@ class SpotifySearcher # Generates url to run a GET request against to the Spotify open API # Returns a `String.` - private def __generate_query(item_type : String, item_parameters : Hash, + private def generate_query(item_type : String, item_parameters : Hash, offset : Int32, limit : Int32) : String query = "" @@ -114,7 +114,7 @@ class SpotifySearcher item_parameters.keys.each do |k| # This will map album, playlist, and track from the name key to the query if k == "name" - query += __param_encode(item_type, item_parameters[k]) + query += param_encode(item_type, item_parameters[k]) # check if the key is to be excluded elsif !query_exclude.includes?(k) @@ -122,7 +122,7 @@ class SpotifySearcher # if it's none of the above, treat it normally else - query += __param_encode(k, item_parameters[k]) + query += param_encode(k, item_parameters[k]) end end @@ -135,7 +135,7 @@ class SpotifySearcher # Ranks the given items based off of the info from parameters. # Meant to find the item that the user desires. # Returns an `Array` of `Array(Int32)` or [[3, 1], [...], ...] - private def __rank_items(items : Array, + private def rank_items(items : Array, parameters : Hash) : Array(Array(Int32)) points = [] of Array(Int32) index = 0 @@ -151,17 +151,17 @@ class SpotifySearcher # The key to compare to for artist if k == "artist" - pts += __points_compare(item["artists"][0]["name"].to_s, val) + pts += points_compare(item["artists"][0]["name"].to_s, val) end # The key to compare to for playlists if k == "username" - pts += __points_compare(item["owner"]["display_name"].to_s, val) + pts += points_compare(item["owner"]["display_name"].to_s, val) end # The key regardless of whether item is track, album,or playlist if k == "name" - pts += __points_compare(item["name"].to_s, val) + pts += points_compare(item["name"].to_s, val) end end @@ -180,7 +180,7 @@ class SpotifySearcher # If the strings are the exact same, return 3 pts. # If *item1* includes *item2*, return 1 pt. # Else, return 0 pts. - private def __points_compare(item1 : String, item2 : String) : Int32 + private def points_compare(item1 : String, item2 : String) : Int32 item1 = item1.downcase.gsub(/[^a-z0-9]/, "") item2 = item2.downcase.gsub(/[^a-z0-9]/, "") @@ -196,10 +196,10 @@ class SpotifySearcher # Returns a `String` encoded for the spotify api # # ``` - # __query_encode("album", "A Night At The Opera") + # query_encode("album", "A Night At The Opera") # => "album:A+Night+At+The+Opera" # ``` - private def __param_encode(key : String, value : String) : String + private def param_encode(key : String, value : String) : String return key.gsub(" ", "+") + ":" + value.gsub(" ", "+") + "+" end diff --git a/src/search/youtube.cr b/src/search/youtube.cr index 442d9b7..ee41312 100644 --- a/src/search/youtube.cr +++ b/src/search/youtube.cr @@ -38,7 +38,7 @@ module Youtube response = HTTP::Client.get(url) - valid_nodes = __get_video_link_nodes(response.body) + valid_nodes = get_video_link_nodes(response.body) if valid_nodes.size == 0 puts "There were no results for that query." @@ -49,7 +49,7 @@ module Youtube return root + valid_nodes[0]["href"] if download_first - ranked = __rank_videos(song_name, artist_name, query, valid_nodes) + ranked = rank_videos(song_name, artist_name, query, valid_nodes) begin return root + valid_nodes[ranked[0]["index"]]["href"] @@ -64,7 +64,7 @@ module Youtube # {"points" => x, "index" => x}, # ... # ] - private def __rank_videos(song_name : String, artist_name : String, + private def rank_videos(song_name : String, artist_name : String, query : String, nodes : Array(XML::Node)) : Array(Hash(String, Int32)) points = [] of Hash(String, Int32) index = 0 @@ -72,9 +72,9 @@ module Youtube nodes.each do |node| pts = 0 - pts += __points_compare(song_name, node["title"]) - pts += __points_compare(artist_name, node["title"]) - pts += __count_buzzphrases(query, node["title"]) + pts += points_compare(song_name, node["title"]) + pts += points_compare(artist_name, node["title"]) + pts += count_buzzphrases(query, node["title"]) points.push({ "points" => pts, @@ -103,7 +103,7 @@ module Youtube # If after the items have been blanked, *item1* includes *item2*, # return 1 pts. # Else, return 0 pts. - private def __points_compare(item1 : String, item2 : String) : Int32 + private def points_compare(item1 : String, item2 : String) : Int32 if item2.includes?(item1) return 3 end @@ -123,7 +123,7 @@ module Youtube # *video_name* is the title of the video, and *query* is what the user the # program searched for. *query* is needed in order to make sure we're not # subtracting points from something that's naturally in the title - private def __count_buzzphrases(query : String, video_name : String) : Int32 + private def count_buzzphrases(query : String, video_name : String) : Int32 good_phrases = 0 bad_phrases = 0 @@ -152,12 +152,12 @@ module Youtube # Finds valid video links from a `HTTP::Client.get` request # Returns an `Array` of `XML::Node` - private def __get_video_link_nodes(doc : String) : Array(XML::Node) + private def get_video_link_nodes(doc : String) : Array(XML::Node) nodes = XML.parse(doc).xpath_nodes("//a") valid_nodes = [] of XML::Node nodes.each do |node| - if __video_link_node?(node) + if video_link_node?(node) valid_nodes.push(node) end end @@ -167,7 +167,7 @@ module Youtube # Tests if the provided `XML::Node` has a valid link to a video # Returns a `Bool` - private def __video_link_node?(node : XML::Node) : Bool + private def video_link_node?(node : XML::Node) : Bool # If this passes, then the node links to a playlist, not a video if node["href"]? return false if node["href"].includes?("&list=") From 80cb034ce144dd1be52118c872b85586bd8f3403 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 21 Jun 2019 09:45:55 -0700 Subject: [PATCH 11/26] Preliminary interception logging done! --- src/bottle/cli.cr | 2 +- src/glue/song.cr | 36 +++++++++--------- src/interact/logger.cr | 85 ++++++++++++++++++++++++++++++++++++++++++ src/interact/ripper.cr | 31 ++++++++++++--- 4 files changed, 131 insertions(+), 23 deletions(-) create mode 100644 src/interact/logger.cr diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr index 059a467..fcff393 100644 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -50,7 +50,7 @@ class CLI end def act_on_args - if @args["help"]? + if @args["help"]? || @args.keys.size == 0 help exit elsif @args["version"]? diff --git a/src/glue/song.cr b/src/glue/song.cr index 5497aea..33be62c 100644 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -33,6 +33,7 @@ class Song end if !@metadata + puts "Searching for metadata ..." @metadata = @spotify_searcher.find_item("track", { "name" => @song_name, "artist" => @artist_name @@ -48,34 +49,35 @@ class Song data = @metadata.as(JSON::Any) filename = data["track_number"].to_s + " - #{data["name"].to_s}.mp3" + puts "Searching for url ..." url = Youtube.find_url(@song_name, @artist_name, search_terms: "lyrics") if !url - raise("There was no link found on youtube for\n" + + raise("There was no url found on youtube for\n" + %("#{@song_name}" by "#{@artist_name}\n) + "Check your input and try again.") end - + puts "Downloading video ..." Ripper.download_mp3(url.as(String), filename) - temp_albumart_filename = ".tempalbumart.jpg" - HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| - File.write(temp_albumart_filename, response.body_io) - end + # temp_albumart_filename = ".tempalbumart.jpg" + # HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| + # File.write(temp_albumart_filename, response.body_io) + # end - tagger = Tags.new(filename) - tagger.add_album_art(temp_albumart_filename) - tagger.add_text_tag("title", data["name"].to_s) - tagger.add_text_tag("artist", data["artists"][0]["name"].to_s) - tagger.add_text_tag("album", data["album"]["name"].to_s) - tagger.add_text_tag("genre", - @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) - tagger.add_text_tag("track", data["track_number"].to_s) - tagger.add_text_tag("disc", data["disc_number"].to_s) + # tagger = Tags.new(filename) + # tagger.add_album_art(temp_albumart_filename) + # tagger.add_text_tag("title", data["name"].to_s) + # tagger.add_text_tag("artist", data["artists"][0]["name"].to_s) + # tagger.add_text_tag("album", data["album"]["name"].to_s) + # tagger.add_text_tag("genre", + # @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) + # tagger.add_text_tag("track", data["track_number"].to_s) + # tagger.add_text_tag("disc", data["disc_number"].to_s) - tagger.save() - File.delete(temp_albumart_filename) + # tagger.save() + # File.delete(temp_albumart_filename) end diff --git a/src/interact/logger.cr b/src/interact/logger.cr new file mode 100644 index 0000000..5eae799 --- /dev/null +++ b/src/interact/logger.cr @@ -0,0 +1,85 @@ +class Logger + + @done_signal = "---DONE---" + + @command : String + + def initialize(command : String, @log_name : String, @sleept = 0.01) + # Have the command output its information to a log and after the command is + # finished, append an end signal to the document + @command = "#{command} > #{@log_name} " # standard output to log + @command += "2> #{@log_name} && " # errors to log + @command += "echo #{@done_signal} >> #{@log_name}" # + end + + # Run @command in the background and pipe its output to the log file, with + # something constantly monitoring the log file and yielding each new line to + # the block call. Useful for changing the output of binaries you don't have + # much control over. + # Note that the created temp log will be deleted unless the command fails + # its exit or .start is called with delete_file: false + # + # ``` + # l = Logger.new(".temp.log", %(echo "CIA spying" && sleep 2 && echo "new veggie tales season")) + # l.start do |output, index| + # case output + # when "CIA spying" + # puts "i sleep" + # when .includes?("veggie tales") + # puts "real shit" + # end + # end + # ``` + def start(delete_file=true, &block) : Bool + # Delete the log if it already exists + File.delete(@log_name) if File.exists?(@log_name) + + # Run the command in the background + called = future { + system(@command) + } + + # Wait for the log file to be written to + while !File.exists?(@log_name) + sleep @sleept + end + + log = File.open(@log_name) + log_content = read_file(log) + index = 0 + + while true + temp_content = read_file(log) + + # make sure that there is new data + if temp_content.size > 0 && log_content != temp_content + log_content = temp_content + + # break the loop if the command has completed + break if log_content[0] == @done_signal + + # give the line and index to the block + yield log_content[0], index + index += 1 + end + end + + status = called.get() + if status == true && delete_file == true + log.delete() + end + + return called.get() + end + + # Reads each line of the file into an Array of Strings + private def read_file(file : IO) : Array(String) + content = [] of String + + file.each_line do |line| + content.push(line) + end + + return content + end +end \ No newline at end of file diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 779480f..7c760ac 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -1,3 +1,5 @@ +require "./logger" + module Ripper extend self @@ -11,7 +13,7 @@ module Ripper # Ripper.download_mp3("https://youtube.com/watch?v=0xnciFWAqa0", # "Queen/A Night At The Opera/Bohemian Rhapsody.mp3") # ``` - def download_mp3(video_url : String, output_filename : String) : Bool + def download_mp3(video_url : String, output_filename : String) ydl_loc = BIN_LOC.join("youtube-dl") # remove the extension that will be added on by ydl @@ -22,6 +24,7 @@ module Ripper options = { "--output" => %("#{output_filename}.%(ext)s"), # auto-add correct ext # "--quiet" => "", + "--verbose" => "", "--ffmpeg-location" => BIN_LOC, "--extract-audio" => "", "--audio-format" => "mp3", @@ -33,11 +36,29 @@ module Ripper command += " #{option} #{options[option]}" end - if system(command) - return true - else - return false + + l = Logger.new(command, ".ripper.log") + o = RipperOutputCensor.new + + return l.start do |line, index| + o.censor_output(line, index) end end + private class RipperOutputCensor + @dl_status_index = 0 + + def censor_output(line : String, index : Int32) + case line + when .includes? "[download]" + if @dl_status_index != 0 + print "\e[1A" + print "\e[0K\r" + end + puts line + @dl_status_index += 1 + end + end + + end end \ No newline at end of file From 8cfb59a36835527bd4a5dd450f8a372f127a07bb Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 21 Jun 2019 16:30:14 -0700 Subject: [PATCH 12/26] logging for individual song done! --- src/glue/song.cr | 35 +++++++++++++++++++---------------- src/interact/ripper.cr | 6 +++++- src/interact/tagger.cr | 4 +++- 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/src/glue/song.cr b/src/glue/song.cr index 33be62c..848e33d 100644 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -58,26 +58,29 @@ class Song "Check your input and try again.") end - puts "Downloading video ..." + puts "Downloading video:" Ripper.download_mp3(url.as(String), filename) - # temp_albumart_filename = ".tempalbumart.jpg" - # HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| - # File.write(temp_albumart_filename, response.body_io) - # end + temp_albumart_filename = ".tempalbumart.jpg" + HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| + File.write(temp_albumart_filename, response.body_io) + end - # tagger = Tags.new(filename) - # tagger.add_album_art(temp_albumart_filename) - # tagger.add_text_tag("title", data["name"].to_s) - # tagger.add_text_tag("artist", data["artists"][0]["name"].to_s) - # tagger.add_text_tag("album", data["album"]["name"].to_s) - # tagger.add_text_tag("genre", - # @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) - # tagger.add_text_tag("track", data["track_number"].to_s) - # tagger.add_text_tag("disc", data["disc_number"].to_s) + tagger = Tags.new(filename) + tagger.add_album_art(temp_albumart_filename) + tagger.add_text_tag("title", data["name"].to_s) + tagger.add_text_tag("artist", data["artists"][0]["name"].to_s) + tagger.add_text_tag("album", data["album"]["name"].to_s) + tagger.add_text_tag("genre", + @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) + tagger.add_text_tag("track", data["track_number"].to_s) + tagger.add_text_tag("disc", data["disc_number"].to_s) - # tagger.save() - # File.delete(temp_albumart_filename) + puts "Tagging metadata ..." + tagger.save() + File.delete(temp_albumart_filename) + + puts %("#{data["name"].to_s}" by "#{data["artists"][0]["name"].to_s}" downloaded.) end diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 7c760ac..2296e2f 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -55,8 +55,12 @@ module Ripper print "\e[1A" print "\e[0K\r" end - puts line + puts line.sub("[download]", " ") @dl_status_index += 1 + + if line.includes? "100%" + puts "Converting to mp3 ..." + end end end diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index 50208d1..c441e1d 100644 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -36,8 +36,10 @@ class Tags def save : Nil @query_args.push(%("_#{@filename}")) command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") - system(command) + l = Logger.new(command, ".tagger.log") + l.start { |line, start| } + File.delete(@filename) File.rename("_" + @filename, @filename) end From f849e6104532c8e35f04204d41914840dbb64fda Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Sun, 23 Jun 2019 13:39:00 -0700 Subject: [PATCH 13/26] need to add 'next' feature for spotify searches --- src/glue/album.cr | 25 +++++++++++++++++++++++ src/glue/list.cr | 45 ++++++++++++++++++++++++++++++++++++++++++ src/interact/logger.cr | 4 ++++ src/interact/ripper.cr | 2 -- src/interact/tagger.cr | 25 ++++++++++++++++------- src/search/spotify.cr | 45 ++++++++++++++++++++++++++++-------------- 6 files changed, 122 insertions(+), 24 deletions(-) create mode 100644 src/glue/album.cr create mode 100644 src/glue/list.cr diff --git a/src/glue/album.cr b/src/glue/album.cr new file mode 100644 index 0000000..2298bd1 --- /dev/null +++ b/src/glue/album.cr @@ -0,0 +1,25 @@ +require "./song" +require "./list" + + +class Album < SpotifyList + + def find_it + album = @spotify_searcher.find_item("album", { + "name" => @list_name.as(String), + "artist" => @list_author.as(String) + }) + if album + return album.as(JSON::Any) + else + puts "No album was found by that name and artist." + exit 1 + end + end + + private def set_organization(index : Int32, song : Song) + # pass + end +end + +puts Album.new("A Night At The Opera", "Queen").find_it() \ No newline at end of file diff --git a/src/glue/list.cr b/src/glue/list.cr new file mode 100644 index 0000000..cc39082 --- /dev/null +++ b/src/glue/list.cr @@ -0,0 +1,45 @@ +require "../search/spotify" +require "../search/youtube" + +require "../interact/ripper" +require "../interact/tagger" + +require "./song" + + +# A parent class for downloading albums and playlists from spotify +abstract class SpotifyList + @spotify_searcher = SpotifySearcher.new() + @file_names = [] of String + + def initialize(@list_name : String, @list_author : String?) + @spotify_searcher.authorize( + "e4198f6a3f7b48029366f22528b5dc66", + "ba057d0621a5496bbb64edccf758bde5") + end + + # Finds the list, and downloads all of the songs using the `Song` class + def grab_it + list = find_it() + contents = list["tracks"][0]["items"] + + i = 0 + contents.each do |data| + if song["track"]? + data = data["track"] + end + + song = Song.new(data["name"].to_s, data["artists"][0]["name"].to_s) + song.provide_spotify(@spotify_searcher) + set_organization(i , song) + song.grab_it() + + i += 1 + end + end + + abstract def find_it : JSON::Any + + private abstract def set_organization(song_index : Int32, song : Song) + +end \ No newline at end of file diff --git a/src/interact/logger.cr b/src/interact/logger.cr index 5eae799..a2cfc4f 100644 --- a/src/interact/logger.cr +++ b/src/interact/logger.cr @@ -4,6 +4,10 @@ class Logger @command : String + # *command* is the bash command that you want to run and capture the output + # of. *@log_name* is the name of the log file you want to temporarily create. + # *@sleept* is the time you want to wait before rechecking if the command has + # started yet, probably something you don't want to worry about def initialize(command : String, @log_name : String, @sleept = 0.01) # Have the command output its information to a log and after the command is # finished, append an end signal to the document diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 2296e2f..e4c2d17 100644 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -19,8 +19,6 @@ module Ripper # remove the extension that will be added on by ydl output_filename = output_filename.split(".")[..-2].join(".") - # TODO: update the logger for this. Explore overwriting stdout and - # injecting/removing text options = { "--output" => %("#{output_filename}.%(ext)s"), # auto-add correct ext # "--quiet" => "", diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index c441e1d..95de3a7 100644 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -1,11 +1,17 @@ -# TODO: write comments/documentation - +# Uses FFMPEG binary to add metadata to mp3 files +# ``` +# t = Tags.new("bohem rap.mp3") +# t.add_album_art("a night at the opera album cover.jpg") +# t.add_text_tag("title", "Bohemian Rhapsody") +# t.save() +# ``` class Tags + # TODO: export this path to a config file @BIN_LOC = Path["~/.irs/bin".sub("~", Path.home)] @query_args = [] of String - + # initialize the class with an already created MP3 def initialize(@filename : String) if !File.exists?(@filename) raise "MP3 not found at location: #{@filename}" @@ -15,10 +21,8 @@ class Tags end - def add_text_tag(key : String, value : String) : Nil - @query_args.push(%(-metadata #{key}="#{value}")) - end - + # Add album art to the mp3. Album art must be added BEFORE text tags are. + # Check the usage above to see a working example. def add_album_art(image_location : String) : Nil if !File.exists?(image_location) raise "Image file not found at location: #{image_location}" @@ -33,6 +37,13 @@ class Tags @query_args.push(%(-metadata:s:v title="Album cover")) end + # Add a text tag to the mp3. If you want to see what text tags are supported, + # check out: https://wiki.multimedia.cx/index.php?title=FFmpeg_Metadata + def add_text_tag(key : String, value : String) : Nil + @query_args.push(%(-metadata #{key}="#{value}")) + end + + # Run the necessary commands to attach album art to the mp3 def save : Nil @query_args.push(%("_#{@filename}")) command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 7d486fb..1a67342 100644 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -69,24 +69,34 @@ class SpotifySearcher points = rank_items(items, item_parameters) begin - return items[points[0][1]] + return get_item(item_type, items[points[0][1]]["id"].to_s) rescue IndexError return nil end end + # Get the complete metadata of an item based off of its id + # + # ``` + # SpotifySearcher.new().authorize(...).get_item("artist", "1dfeR4HaWDbWqFHLkxsg1d") + # ``` + def get_item(item_type : String, id : String) : JSON::Any? + url = @root_url.join("#{item_type}s/#{id}").to_s() + + response = HTTP::Client.get(url, headers: @access_header) + error_check(response) + + return JSON.parse(response.body) + end + # Find the genre of an artist based off of their id # # ``` # SpotifySearcher.new().authorize(...).find_genre("1dfeR4HaWDbWqFHLkxsg1d") # ``` def find_genre(id : String) : String - url = @root_url.join("artists/#{id}").to_s() - response = HTTP::Client.get(url, headers: @access_header) - error_check(response) - - genre = JSON.parse(response.body)["genres"][0].to_s + genre = get_item("artist", id)["genres"][0].to_s genre = genre.split(" ").map { |x| x.capitalize }.join(" ") return genre @@ -117,8 +127,9 @@ class SpotifySearcher query += param_encode(item_type, item_parameters[k]) # check if the key is to be excluded - elsif !query_exclude.includes?(k) - query += item_parameters[k].gsub(" ", "+") + "+" + elsif query_exclude.includes?(k) + next + # query += item_parameters[k].gsub(" ", "+") + "+" # if it's none of the above, treat it normally else @@ -206,10 +217,14 @@ class SpotifySearcher end -# puts SpotifySearcher.new() -# .authorize("e4198f6a3f7b48029366f22528b5dc66", -# "ba057d0621a5496bbb64edccf758bde5") -# .find_item("album", { -# "name" => "A Night At The Opera", -# "artist" => "Queen" -# }) \ No newline at end of file +puts SpotifySearcher.new() + .authorize("e4198f6a3f7b48029366f22528b5dc66", + "ba057d0621a5496bbb64edccf758bde5") + .find_item("playlist", { + "name" => "Brain Food", + "username" => "spotify" + # "name " => "A Night At The Opera", + # "artist" => "Queen" + # "track" => "Bohemian Rhapsody", + # "artist" => "Queen" + }) \ No newline at end of file From ff1b30b845726891b8e6ae133a08131af7eb6248 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Fri, 21 Feb 2020 12:00:27 -0700 Subject: [PATCH 14/26] Updated to v1.0.0 Added -i flag to install youtube-dl, ffmpeg, and ffprobe --- .editorconfig | 0 .gitignore | 6 +++++- .travis.yml | 0 LICENSE | 0 README.md | 10 ++++++++-- shard.lock | 2 +- shard.yml | 4 +--- spec/irs_spec.cr | 0 spec/spec_helper.cr | 0 src/bottle/cli.cr | 21 +++++++++++++++------ src/bottle/config.cr | 9 +++++++++ src/bottle/styles.cr | 0 src/bottle/version.cr | 0 src/glue/album.cr | 2 -- src/glue/list.cr | 0 src/glue/song.cr | 0 src/interact/logger.cr | 0 src/interact/ripper.cr | 3 ++- src/interact/tagger.cr | 0 src/irs.cr | 0 src/search/spotify.cr | 22 +++++++++++----------- src/search/youtube.cr | 0 22 files changed, 52 insertions(+), 27 deletions(-) mode change 100644 => 100755 .editorconfig mode change 100644 => 100755 .gitignore mode change 100644 => 100755 .travis.yml mode change 100644 => 100755 LICENSE mode change 100644 => 100755 README.md mode change 100644 => 100755 shard.lock mode change 100644 => 100755 shard.yml mode change 100644 => 100755 spec/irs_spec.cr mode change 100644 => 100755 spec/spec_helper.cr mode change 100644 => 100755 src/bottle/cli.cr mode change 100644 => 100755 src/bottle/config.cr mode change 100644 => 100755 src/bottle/styles.cr mode change 100644 => 100755 src/bottle/version.cr mode change 100644 => 100755 src/glue/album.cr mode change 100644 => 100755 src/glue/list.cr mode change 100644 => 100755 src/glue/song.cr mode change 100644 => 100755 src/interact/logger.cr mode change 100644 => 100755 src/interact/ripper.cr mode change 100644 => 100755 src/interact/tagger.cr mode change 100644 => 100755 src/irs.cr mode change 100644 => 100755 src/search/spotify.cr mode change 100644 => 100755 src/search/youtube.cr diff --git a/.editorconfig b/.editorconfig old mode 100644 new mode 100755 diff --git a/.gitignore b/.gitignore old mode 100644 new mode 100755 index b48c7f5..2da7df7 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,8 @@ /.shards/ *.dwarf -*.mp3 \ No newline at end of file +*.mp3 +.ripper.log +ffmpeg +ffprobe +youtube-dl \ No newline at end of file diff --git a/.travis.yml b/.travis.yml old mode 100644 new mode 100755 diff --git a/LICENSE b/LICENSE old mode 100644 new mode 100755 diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 38f9dfa..f2fd4e9 --- a/README.md +++ b/README.md @@ -2,13 +2,19 @@ TODO: Write a description here +## Usage + +

+ +

+ +TODO: Write usage instructions here + ## Installation TODO: Write installation instructions here -## Usage -TODO: Write usage instructions here ## Development diff --git a/shard.lock b/shard.lock old mode 100644 new mode 100755 index d04a714..33cbfa9 --- a/shard.lock +++ b/shard.lock @@ -2,5 +2,5 @@ version: 1.0 shards: ydl_binaries: github: cooperhammond/ydl-binaries - commit: 8a622bf9d2c0b848db8d8db2f46f09334a1f03f8 + commit: 3108c8ce9456bbde24baba64b2372b431a010558 diff --git a/shard.yml b/shard.yml old mode 100644 new mode 100755 index 2064a6d..9782be4 --- a/shard.yml +++ b/shard.yml @@ -1,5 +1,5 @@ name: irs -version: 0.1.0 +version: 1.0.0 authors: - Cooper Hammond @@ -8,8 +8,6 @@ targets: irs: main: src/irs.cr -crystal: 0.28.0 - license: MIT dependencies: diff --git a/spec/irs_spec.cr b/spec/irs_spec.cr old mode 100644 new mode 100755 diff --git a/spec/spec_helper.cr b/spec/spec_helper.cr old mode 100644 new mode 100755 diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr old mode 100644 new mode 100755 index fcff393..13bb5a6 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -1,5 +1,8 @@ -require "./version" +require "ydl_binaries" + +require "./config" require "./styles" +require "./version" require "../glue/song" @@ -11,6 +14,7 @@ class CLI @options = [ [["-h", "--help"], "help", "bool"], [["-v", "--version"], "version", "bool"], + [["-i", "--install"], "install", "bool"], [["-s", "--song"], "song", "string"], [["-a", "--artist"], "artist", "string"] ] @@ -28,22 +32,23 @@ class CLI def help msg = <<-EOP - #{Style.bold "Usage: irs [-h] [-v] [-s -a ]"} + #{Style.bold "Usage: irs [-h] [-v] [-i] [-s -a ]"} - Arguments: + #{Style.bold "Arguments:"} #{Style.blue "-h, --help"} Show this help message and exit #{Style.blue "-v, --version"} Show the program version and exit + #{Style.blue "-i, --install"} Download ffmpeg and youtube_dl binaries to #{Style.green Config.binary_location} #{Style.blue "-s, --song "} Specify song name for downloading #{Style.blue "-a, --artist "} Specify artist name for downloading - Examples: + #{Style.bold "Examples:"} $ #{Style.green %(irs --song "Bohemian Rhapsody" --artist "Queen")} #{Style.dim %(# => downloads the song "Bohemian Rhapsody" by "Queen")} $ #{Style.green %(irs --album "Demon Days" --artist "Gorillaz")} #{Style.dim %(# => downloads the album "Demon Days" by "Gorillaz")} - This project is licensed under the GNU GPL. - Project page: + #{Style.bold "This project is licensed under the MIT license."} + #{Style.bold "Project page: "} EOP puts msg @@ -56,10 +61,14 @@ class CLI elsif @args["version"]? version exit + elsif @args["install"]? + YdlBinaries.get_both(Config.binary_location) + exit elsif @args["song"]? && @args["artist"]? s = Song.new(@args["song"], @args["artist"]) s.provide_client_keys("e4198f6a3f7b48029366f22528b5dc66", "ba057d0621a5496bbb64edccf758bde5") s.grab_it() + exit end end diff --git a/src/bottle/config.cr b/src/bottle/config.cr old mode 100644 new mode 100755 index e69de29..a13bb2c --- a/src/bottle/config.cr +++ b/src/bottle/config.cr @@ -0,0 +1,9 @@ +module Config + + extend self + + def binary_location : String + path = "~/.irs/bin" + return Path[path].expand(home: true).to_s + end +end \ No newline at end of file diff --git a/src/bottle/styles.cr b/src/bottle/styles.cr old mode 100644 new mode 100755 diff --git a/src/bottle/version.cr b/src/bottle/version.cr old mode 100644 new mode 100755 diff --git a/src/glue/album.cr b/src/glue/album.cr old mode 100644 new mode 100755 index 2298bd1..6608c86 --- a/src/glue/album.cr +++ b/src/glue/album.cr @@ -21,5 +21,3 @@ class Album < SpotifyList # pass end end - -puts Album.new("A Night At The Opera", "Queen").find_it() \ No newline at end of file diff --git a/src/glue/list.cr b/src/glue/list.cr old mode 100644 new mode 100755 diff --git a/src/glue/song.cr b/src/glue/song.cr old mode 100644 new mode 100755 diff --git a/src/interact/logger.cr b/src/interact/logger.cr old mode 100644 new mode 100755 diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr old mode 100644 new mode 100755 index e4c2d17..5486cf9 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -1,10 +1,11 @@ require "./logger" +require "../bottle/config" module Ripper extend self - BIN_LOC = Path["~/.irs/bin".sub("~", Path.home)] + BIN_LOC = Path[Config.binary_location] # Downloads the video from the given *video_url* using the youtube-dl binary # Will create any directories that don't exist specified in *output_filename* diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr old mode 100644 new mode 100755 diff --git a/src/irs.cr b/src/irs.cr old mode 100644 new mode 100755 diff --git a/src/search/spotify.cr b/src/search/spotify.cr old mode 100644 new mode 100755 index 1a67342..2c6e537 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -217,14 +217,14 @@ class SpotifySearcher end -puts SpotifySearcher.new() - .authorize("e4198f6a3f7b48029366f22528b5dc66", - "ba057d0621a5496bbb64edccf758bde5") - .find_item("playlist", { - "name" => "Brain Food", - "username" => "spotify" - # "name " => "A Night At The Opera", - # "artist" => "Queen" - # "track" => "Bohemian Rhapsody", - # "artist" => "Queen" - }) \ No newline at end of file +# puts SpotifySearcher.new() +# .authorize("e4198f6a3f7b48029366f22528b5dc66", +# "ba057d0621a5496bbb64edccf758bde5") +# .find_item("playlist", { +# "name" => "Brain Food", +# "username" => "spotify" +# # "name " => "A Night At The Opera", +# # "artist" => "Queen" +# # "track" => "Bohemian Rhapsody", +# # "artist" => "Queen" +# }) \ No newline at end of file diff --git a/src/search/youtube.cr b/src/search/youtube.cr old mode 100644 new mode 100755 From 5881d21f48739b909f9e4678133d6a0446ead84d Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Tue, 10 Mar 2020 14:12:12 -0600 Subject: [PATCH 15/26] Cleaned up list inheritance, songs are automatically organized Moved more permanent variables to the config. I need to start thinking about custom configs rather than a hard-coded one. --- .gitignore | 1 + src/bottle/cli.cr | 24 +++++++++++++++----- src/bottle/config.cr | 13 +++++++++++ src/glue/album.cr | 46 +++++++++++++++++++++++++++++++++++-- src/glue/list.cr | 41 +++++++++++++++++++++++++-------- src/glue/song.cr | 51 ++++++++++++++++++++++++++++++------------ src/interact/ripper.cr | 2 ++ src/search/spotify.cr | 4 ++-- 8 files changed, 150 insertions(+), 32 deletions(-) diff --git a/.gitignore b/.gitignore index 2da7df7..fa277ac 100755 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ /lib/ /bin/ /.shards/ +/Music/ *.dwarf *.mp3 diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr index 13bb5a6..8e91b16 100755 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -5,6 +5,7 @@ require "./styles" require "./version" require "../glue/song" +require "../glue/album" class CLI @@ -15,8 +16,9 @@ class CLI [["-h", "--help"], "help", "bool"], [["-v", "--version"], "version", "bool"], [["-i", "--install"], "install", "bool"], + [["-a", "--artist"], "artist", "string"], [["-s", "--song"], "song", "string"], - [["-a", "--artist"], "artist", "string"] + [["-A", "--album"], "album", "string"] ] @@ -38,8 +40,9 @@ class CLI #{Style.blue "-h, --help"} Show this help message and exit #{Style.blue "-v, --version"} Show the program version and exit #{Style.blue "-i, --install"} Download ffmpeg and youtube_dl binaries to #{Style.green Config.binary_location} - #{Style.blue "-s, --song "} Specify song name for downloading #{Style.blue "-a, --artist "} Specify artist name for downloading + #{Style.blue "-s, --song "} Specify song name to download + #{Style.blue "-A, --album @list_name.as(String), @@ -17,7 +23,43 @@ class Album < SpotifyList end end - private def set_organization(index : Int32, song : Song) - # pass + # Will define specific metadata that may not be included in the raw return + # of spotify's album json. Moves the title of the album and the album art + # to the json of the single song + def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any + json_string = %( + { + "album": { + "name": "#{list["name"]}", + "images": [{"url": "#{list["images"][0]["url"]}"}] + }, + ) + datum.as_h.keys.each_with_index do |key, index| + value = datum[key] + if value.as_s? + json_string += %("#{key}": "#{datum[key]}") + else + json_string += %("#{key}": #{datum[key].to_s.gsub(" => ", ": ")}) + end + + if index != datum.as_h.keys.size - 1 + json_string += ",\n" + end + end + json_string += %( + } + ) + + json_string = json_string.gsub(" ", "") + json_string = json_string.gsub("\n", " ") + json_string = json_string.gsub("\t", "") + + data = JSON.parse(json_string) + + return data + end + + private def organize(song : Song) + song.organize_it(@music_directory) end end diff --git a/src/glue/list.cr b/src/glue/list.cr index cc39082..44664bf 100755 --- a/src/glue/list.cr +++ b/src/glue/list.cr @@ -1,3 +1,5 @@ +require "json" + require "../search/spotify" require "../search/youtube" @@ -13,33 +15,54 @@ abstract class SpotifyList @file_names = [] of String def initialize(@list_name : String, @list_author : String?) - @spotify_searcher.authorize( - "e4198f6a3f7b48029366f22528b5dc66", - "ba057d0621a5496bbb64edccf758bde5") end # Finds the list, and downloads all of the songs using the `Song` class def grab_it + + if !@spotify_searcher.authorized? + raise("Need to call provide_client_keys on Album or Playlist class.") + end + list = find_it() - contents = list["tracks"][0]["items"] + contents = list["tracks"]["items"].as_a i = 0 - contents.each do |data| - if song["track"]? - data = data["track"] + contents.each do |datum| + if datum["track"]? + datum = datum["track"] end + data = organize_song_metadata(list, datum) + song = Song.new(data["name"].to_s, data["artists"][0]["name"].to_s) song.provide_spotify(@spotify_searcher) - set_organization(i , song) + song.provide_metadata(data) song.grab_it() + organize(song) + i += 1 end end + # Will authorize the class associated `SpotifySearcher` + def provide_client_keys(client_key : String, client_secret : String) + @spotify_searcher.authorize(client_key, client_secret) + end + + # Defined in subclasses, will return the appropriate information or call an + # error if the info is not found and exit abstract def find_it : JSON::Any - private abstract def set_organization(song_index : Int32, song : Song) + # If there's a need to organize the individual song data so that the `Song` + # class can better handle it, this function will be defined in the subclass + private abstract def organize_song_metadata(list : JSON::Any, + datum : JSON::Any) : JSON::Any + + # Will define the specific type of organization for a list of songs. + # Needed because most people want albums sorted by artist, but playlists all + # in one folder + private abstract def organize(song : Song) end \ No newline at end of file diff --git a/src/glue/song.cr b/src/glue/song.cr index 848e33d..0e59155 100755 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -11,18 +11,19 @@ class Song @client_secret = "" @metadata : JSON::Any? - @filename : String? + @filename = "" + @artist = "" + @album = "" def initialize(@song_name : String, @artist_name : String) end # Find, downloads, and tags the mp3 song that this class represents. - # Will return true on complete success and false on failure. # # ``` # Song.new("Bohemian Rhapsody", "Queen").grab_it() # ``` - def grab_it : Nil + def grab_it if !@spotify_searcher.authorized? && !@metadata if @client_id != "" && @client_secret != "" @spotify_searcher.authorize(@client_id, @client_secret) @@ -47,9 +48,10 @@ class Song end data = @metadata.as(JSON::Any) - filename = data["track_number"].to_s + " - #{data["name"].to_s}.mp3" + @filename = data["track_number"].to_s + " - #{data["name"].to_s}.mp3" puts "Searching for url ..." + # TODO: should this search_term be here? url = Youtube.find_url(@song_name, @artist_name, search_terms: "lyrics") if !url @@ -59,18 +61,21 @@ class Song end puts "Downloading video:" - Ripper.download_mp3(url.as(String), filename) + Ripper.download_mp3(url.as(String), @filename) temp_albumart_filename = ".tempalbumart.jpg" HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| File.write(temp_albumart_filename, response.body_io) end - tagger = Tags.new(filename) + @artist = data["artists"][0]["name"].to_s + @album = data["album"]["name"].to_s + + tagger = Tags.new(@filename) tagger.add_album_art(temp_albumart_filename) tagger.add_text_tag("title", data["name"].to_s) - tagger.add_text_tag("artist", data["artists"][0]["name"].to_s) - tagger.add_text_tag("album", data["album"]["name"].to_s) + tagger.add_text_tag("artist", @artist) + tagger.add_text_tag("album", @album) tagger.add_text_tag("genre", @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) tagger.add_text_tag("track", data["track_number"].to_s) @@ -84,6 +89,28 @@ class Song end + # Will organize the song into the user's provided music directory as + # music_directory > artist_name > album_name > song + # Must be called AFTER the song has been downloaded. + # + # ``` + # s = Song.new("Bohemian Rhapsody", "Queen").grab_it() + # s.organize_it("/home/cooper/Music") + # # Will move the mp3 file to + # # /home/cooper/Music/Queen/A Night At The Opera/1 - Bohemian Rhapsody.mp3 + # ``` + def organize_it(music_directory : String) + path = Path[music_directory].expand(home: true) + path = path / @artist_name.gsub(/[\/]/, "").gsub(" ", " ") + path = path / @album.gsub(/[\/]/, "").gsub(" ", " ") + strpath = path.to_s + if !File.directory?(strpath) + FileUtils.mkdir_p(strpath) + end + safe_filename = @filename.gsub(/[\/]/, "").gsub(" ", " ") + File.rename("./" + @filename, (path / safe_filename).to_s) + end + # Provide metadata so that it doesn't have to find it. Useful for overwriting # metadata. Must be called if provide_client_keys and provide_spotify are not # called. @@ -105,7 +132,7 @@ class Song # .authenticate("XXXXXXXXXX", "XXXXXXXXXXX")).grab_it() # ``` def provide_spotify(spotify : SpotifySearcher) : self - @spotify = spotify + @spotify_searcher = spotify return self end @@ -120,8 +147,4 @@ class Song @client_secret = client_secret return self end -end - -# s = Song.new("Bohemian Rhapsody", "Queen") -# s.provide_client_keys("e4198f6a3f7b48029366f22528b5dc66", "ba057d0621a5496bbb64edccf758bde5") -# s.grab_it() \ No newline at end of file +end \ No newline at end of file diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 5486cf9..24e3607 100755 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -44,6 +44,8 @@ module Ripper end end + # An internal class that will keep track of what to output to the user or + # what should be hidden. private class RipperOutputCensor @dl_status_index = 0 diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 2c6e537..36f209e 100755 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -218,8 +218,8 @@ end # puts SpotifySearcher.new() -# .authorize("e4198f6a3f7b48029366f22528b5dc66", -# "ba057d0621a5496bbb64edccf758bde5") +# .authorize("XXXXXXXXXXXXXXX", +# "XXXXXXXXXXXXXXX") # .find_item("playlist", { # "name" => "Brain Food", # "username" => "spotify" From abe769bfcd985bc49d688059893c643a8c1250a0 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Thu, 26 Mar 2020 20:55:14 -0700 Subject: [PATCH 16/26] Added playlist to the --help screen --- src/bottle/cli.cr | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr index 8e91b16..532c88a 100755 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -34,21 +34,27 @@ class CLI def help msg = <<-EOP - #{Style.bold "Usage: irs [-h] [-v] [-i] [-s -a ]"} + #{Style.bold "Usage: irs [--help] [--version] [--install]"} + #{Style.bold " [-s -a ]"} + #{Style.bold " [-A -a ]"} + #{Style.bold " [-p -a ]"} #{Style.bold "Arguments:"} - #{Style.blue "-h, --help"} Show this help message and exit - #{Style.blue "-v, --version"} Show the program version and exit - #{Style.blue "-i, --install"} Download ffmpeg and youtube_dl binaries to #{Style.green Config.binary_location} - #{Style.blue "-a, --artist "} Specify artist name for downloading - #{Style.blue "-s, --song "} Specify song name to download - #{Style.blue "-A, --album "} Specify artist name for downloading + #{Style.blue "-s, --song "} Specify song name to download + #{Style.blue "-A, --album "} Specify the album name to download + #{Style.blue "-p, --playlist "} Specify the playlist name to download #{Style.bold "Examples:"} $ #{Style.green %(irs --song "Bohemian Rhapsody" --artist "Queen")} #{Style.dim %(# => downloads the song "Bohemian Rhapsody" by "Queen")} $ #{Style.green %(irs --album "Demon Days" --artist "Gorillaz")} #{Style.dim %(# => downloads the album "Demon Days" by "Gorillaz")} + $ #{Style.green %(irs --playlist "a different drummer" --artist "prakkillian")} + #{Style.dim %(# => downloads the playlist "a different drummer" by the user prakkillian)} #{Style.bold "This project is licensed under the MIT license."} #{Style.bold "Project page: "} From eb3f33252196bdfea627b5945700750be2d83146 Mon Sep 17 00:00:00 2001 From: Cooper Hammond Date: Sat, 28 Mar 2020 01:17:07 -0700 Subject: [PATCH 17/26] Improved ability of spotify.cr to find playlists If the general search doesn't return a playlist, it will bootstrap your terms into a specific call for the user's playlists and search through them --- src/search/spotify.cr | 75 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 68 insertions(+), 7 deletions(-) diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 36f209e..9d54128 100755 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -2,7 +2,6 @@ require "http" require "json" require "base64" - class SpotifySearcher @root_url = Path["https://api.spotify.com/v1/"] @@ -68,8 +67,61 @@ class SpotifySearcher points = rank_items(items, item_parameters) + to_return = nil + begin - return get_item(item_type, items[points[0][1]]["id"].to_s) + # this means no points were assigned so don't return the "best guess" + if points[0][0] <= 0 + to_return = nil + else + to_return = get_item(item_type, items[points[0][1]]["id"].to_s) + end + rescue IndexError + to_return = nil + end + + # if this triggers, it means that a playlist has failed to be found, so + # the search will be bootstrapped into find_user_playlist + if to_return == nil && item_type == "playlist" + return self.find_user_playlist( + item_parameters["username"], + item_parameters["name"] + ) + end + + return to_return + end + + # Grabs a users playlists and searches through it for the specified playlist + # + # ``` + # spotify_searcher.find_user_playlist("prakkillian", "the little man") + # => {playlist metadata} + # ``` + def find_user_playlist(username : String, name : String, offset=0, + limit=20) : JSON::Any? + + url = "users/#{username}/playlists?offset=#{offset}&limit=#{limit}" + url = @root_url.join(url).to_s + + response = HTTP::Client.get(url, headers: @access_header) + error_check(response) + body = JSON.parse(response.body) + + items = body["items"] + points = [] of Array(Int32) + + items.as_a.each_index do |i| + points.push([points_compare(items[i]["name"].to_s, name), i]) + end + points.sort!{ |a, b| b[0] <=> a[0] } + + begin + if points[0][0] < 3 + return self.find_user_playlist(username, name, offset + limit, limit) + else + return items[points[0][1]] + end rescue IndexError return nil end @@ -122,16 +174,23 @@ class SpotifySearcher query_exclude = ["username"] item_parameters.keys.each do |k| - # This will map album, playlist, and track from the name key to the query + # This will map album and track names from the name key to the query if k == "name" - query += param_encode(item_type, item_parameters[k]) + + # will remove the "name:" param from the query + if item_type == "playlist" + query += item_parameters[k].gsub(" ", "+") + "+" + else + query += param_encode(item_type, item_parameters[k]) + end # check if the key is to be excluded elsif query_exclude.includes?(k) next - # query += item_parameters[k].gsub(" ", "+") + "+" - + # if it's none of the above, treat it normally + # NOTE: playlist names will be inserted into the query normally, without + # a parameter. else query += param_encode(k, item_parameters[k]) end @@ -167,7 +226,9 @@ class SpotifySearcher # The key to compare to for playlists if k == "username" - pts += points_compare(item["owner"]["display_name"].to_s, val) + pts_to_add = points_compare(item["owner"]["display_name"].to_s, val) + pts += pts_to_add + pts += -10 if pts_to_add == 0 end # The key regardless of whether item is track, album,or playlist From 4e0ba7ec7932bb8582282db6bc672d13216fe632 Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Sat, 28 Mar 2020 01:23:41 -0700 Subject: [PATCH 18/26] fixed indentation --- src/glue/album.cr | 56 +++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/src/glue/album.cr b/src/glue/album.cr index b9df693..98a080a 100755 --- a/src/glue/album.cr +++ b/src/glue/album.cr @@ -6,7 +6,7 @@ require "./list" class Album < SpotifyList - @music_directory = Config.music_directory + @home_music_directory = Config.music_directory # Uses the `spotify_searcher` defined in parent `SpotifyList` to find the # correct metadata of the list @@ -27,39 +27,39 @@ class Album < SpotifyList # of spotify's album json. Moves the title of the album and the album art # to the json of the single song def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any - json_string = %( - { - "album": { - "name": "#{list["name"]}", - "images": [{"url": "#{list["images"][0]["url"]}"}] - }, - ) - datum.as_h.keys.each_with_index do |key, index| - value = datum[key] - if value.as_s? - json_string += %("#{key}": "#{datum[key]}") - else - json_string += %("#{key}": #{datum[key].to_s.gsub(" => ", ": ")}) - end - - if index != datum.as_h.keys.size - 1 - json_string += ",\n" - end + json_string = %( + { + "album": { + "name": "#{list["name"]}", + "images": [{"url": "#{list["images"][0]["url"]}"}] + }, + ) + datum.as_h.keys.each_with_index do |key, index| + value = datum[key] + if value.as_s? + json_string += %("#{key}": "#{datum[key]}") + else + json_string += %("#{key}": #{datum[key].to_s.gsub(" => ", ": ")}) end - json_string += %( - } - ) - json_string = json_string.gsub(" ", "") - json_string = json_string.gsub("\n", " ") - json_string = json_string.gsub("\t", "") + if index != datum.as_h.keys.size - 1 + json_string += ",\n" + end + end + json_string += %( + } + ) - data = JSON.parse(json_string) + json_string = json_string.gsub(" ", "") + json_string = json_string.gsub("\n", " ") + json_string = json_string.gsub("\t", "") - return data + data = JSON.parse(json_string) + + return data end private def organize(song : Song) - song.organize_it(@music_directory) + song.organize_it(@home_music_directory) end end From 5c611c9af52e3d92e60b04784a0aa2298a80b132 Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Sat, 28 Mar 2020 15:00:29 -0700 Subject: [PATCH 19/26] removed a hardcoded path --- src/interact/tagger.cr | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index 95de3a7..3dde48e 100755 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -1,3 +1,5 @@ +require "../bottle/config" + # Uses FFMPEG binary to add metadata to mp3 files # ``` # t = Tags.new("bohem rap.mp3") @@ -8,7 +10,7 @@ class Tags # TODO: export this path to a config file - @BIN_LOC = Path["~/.irs/bin".sub("~", Path.home)] + @BIN_LOC = Config.binary_location @query_args = [] of String # initialize the class with an already created MP3 @@ -46,7 +48,7 @@ class Tags # Run the necessary commands to attach album art to the mp3 def save : Nil @query_args.push(%("_#{@filename}")) - command = @BIN_LOC.to_s + "/ffmpeg " + @query_args.join(" ") + command = @BIN_LOC + "/ffmpeg " + @query_args.join(" ") l = Logger.new(command, ".tagger.log") l.start { |line, start| } From 4c20735abd851dbf0116b0d9e4835d5f929ce558 Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Sat, 9 May 2020 16:13:50 -0700 Subject: [PATCH 20/26] spotify searcher can now find and compile playlists >100 songs --- .gitignore | 1 + shard.lock | 2 +- src/bottle/cli.cr | 8 ++++- src/bottle/config.cr | 4 +-- src/glue/album.cr | 34 ++++++-------------- src/glue/mapper.cr | 47 +++++++++++++++++++++++++++ src/glue/playlist.cr | 41 ++++++++++++++++++++++++ src/search/spotify.cr | 74 ++++++++++++++++++++++++++++++++++++++----- 8 files changed, 175 insertions(+), 36 deletions(-) create mode 100755 src/glue/mapper.cr create mode 100755 src/glue/playlist.cr diff --git a/.gitignore b/.gitignore index fa277ac..f22fb15 100755 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,7 @@ /docs/ /lib/ /bin/ +/logs/ /.shards/ /Music/ *.dwarf diff --git a/shard.lock b/shard.lock index 33cbfa9..fefdfa4 100755 --- a/shard.lock +++ b/shard.lock @@ -2,5 +2,5 @@ version: 1.0 shards: ydl_binaries: github: cooperhammond/ydl-binaries - commit: 3108c8ce9456bbde24baba64b2372b431a010558 + commit: c82e3937fee20fd076b1c73e24b2d0205e2cf0da diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr index 532c88a..13affa8 100755 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -6,6 +6,7 @@ require "./version" require "../glue/song" require "../glue/album" +require "../glue/playlist" class CLI @@ -18,7 +19,8 @@ class CLI [["-i", "--install"], "install", "bool"], [["-a", "--artist"], "artist", "string"], [["-s", "--song"], "song", "string"], - [["-A", "--album"], "album", "string"] + [["-A", "--album"], "album", "string"], + [["-p", "--playlist"], "playlist", "string"] ] @@ -83,6 +85,10 @@ class CLI a = Album.new(@args["album"], @args["artist"]) a.provide_client_keys(Config.client_key, Config.client_secret) a.grab_it() + elsif @args["playlist"]? && @args["artist"]? + p = Playlist.new(@args["playlist"], @args["artist"]) + p.provide_client_keys(Config.client_key, Config.client_secret) + p.grab_it() end end diff --git a/src/bottle/config.cr b/src/bottle/config.cr index 819a2d7..c288b5d 100755 --- a/src/bottle/config.cr +++ b/src/bottle/config.cr @@ -13,10 +13,10 @@ module Config end def client_key : String - return "e4198f6a3f7b48029366f22528b5dc66" + return "362f75b91aeb471bb392945f93eba842" end def client_secret : String - return "ba057d0621a5496bbb64edccf758bde5" + return "013556dd71e14e1da9443dee73e23a91" end end \ No newline at end of file diff --git a/src/glue/album.cr b/src/glue/album.cr index 98a080a..e6f0781 100755 --- a/src/glue/album.cr +++ b/src/glue/album.cr @@ -1,9 +1,12 @@ require "../bottle/config" +require "./mapper" require "./song" require "./list" + + class Album < SpotifyList @home_music_directory = Config.music_directory @@ -27,34 +30,17 @@ class Album < SpotifyList # of spotify's album json. Moves the title of the album and the album art # to the json of the single song def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any - json_string = %( + album_metadata = parse_to_json(%( { - "album": { - "name": "#{list["name"]}", - "images": [{"url": "#{list["images"][0]["url"]}"}] - }, - ) - datum.as_h.keys.each_with_index do |key, index| - value = datum[key] - if value.as_s? - json_string += %("#{key}": "#{datum[key]}") - else - json_string += %("#{key}": #{datum[key].to_s.gsub(" => ", ": ")}) - end - - if index != datum.as_h.keys.size - 1 - json_string += ",\n" - end - end - json_string += %( + "name": "#{list["name"]}", + "images": [{"url": "#{list["images"][0]["url"]}"}] } - ) + )) - json_string = json_string.gsub(" ", "") - json_string = json_string.gsub("\n", " ") - json_string = json_string.gsub("\t", "") + prepped_data = AlbumTrackMetadataMapper.from_json(datum.to_json) + prepped_data.album = album_metadata - data = JSON.parse(json_string) + data = parse_to_json(prepped_data.to_json) return data end diff --git a/src/glue/mapper.cr b/src/glue/mapper.cr new file mode 100755 index 0000000..c423662 --- /dev/null +++ b/src/glue/mapper.cr @@ -0,0 +1,47 @@ +require "json" + +class PlaylistExtensionMapper + JSON.mapping( + tracks: { + type: PlaylistTracksMapper, + setter: true + }, + id: String, + images: JSON::Any, + name: String, + owner: JSON::Any, + type: String + ) +end + +class PlaylistTracksMapper + JSON.mapping( + items: { + type: Array(JSON::Any), + setter: true + }, + total: Int32 + ) +end + +class AlbumTrackMetadataMapper + JSON.mapping( + album: { + type: JSON::Any, + nilable: true, + setter: true + }, + artists: JSON::Any, + disc_number: Int32, + id: String, + name: String, + track_number: Int32, + type: String, + uri: String + ) +end + + +def parse_to_json(string_json : String) : JSON::Any + return JSON.parse(string_json) +end \ No newline at end of file diff --git a/src/glue/playlist.cr b/src/glue/playlist.cr new file mode 100755 index 0000000..0600b3e --- /dev/null +++ b/src/glue/playlist.cr @@ -0,0 +1,41 @@ +require "../bottle/config" + +require "./song" +require "./list" + +class Playlist < SpotifyList + + @home_music_directory = Config.music_directory + + # Uses the `spotify_searcher` defined in parent `SpotifyList` to find the + # correct metadata of the list + def find_it + @playlist = @spotify_searcher.find_item("playlist", { + "name" => @list_name.as(String), + "username" => @list_author.as(String) + }) + if playlist + return playlist.as(JSON::Any) + else + puts "No playlists were found by that name and user." + exit 1 + end + end + + # Will define specific metadata that may not be included in the raw return + # of spotify's album json. Moves the title of the album and the album art + # to the json of the single song + def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any + puts datum + puts "THIS" + + exit 0 + data = datum + + return data + end + + private def organize(song : Song) + song.organize_it(@home_music_directory) + end +end diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 9d54128..1d2d4c7 100755 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -2,6 +2,8 @@ require "http" require "json" require "base64" +require "../glue/mapper" + class SpotifySearcher @root_url = Path["https://api.spotify.com/v1/"] @@ -83,7 +85,7 @@ class SpotifySearcher # if this triggers, it means that a playlist has failed to be found, so # the search will be bootstrapped into find_user_playlist if to_return == nil && item_type == "playlist" - return self.find_user_playlist( + return find_user_playlist( item_parameters["username"], item_parameters["name"] ) @@ -101,7 +103,7 @@ class SpotifySearcher def find_user_playlist(username : String, name : String, offset=0, limit=20) : JSON::Any? - url = "users/#{username}/playlists?offset=#{offset}&limit=#{limit}" + url = "users/#{username}/playlists?limit=#{limit}&offset=#{offset}" url = @root_url.join(url).to_s response = HTTP::Client.get(url, headers: @access_header) @@ -118,9 +120,9 @@ class SpotifySearcher begin if points[0][0] < 3 - return self.find_user_playlist(username, name, offset + limit, limit) + return find_user_playlist(username, name, offset + limit, limit) else - return items[points[0][1]] + return get_item("playlist", items[points[0][1]]["id"].to_s) end rescue IndexError return nil @@ -132,13 +134,69 @@ class SpotifySearcher # ``` # SpotifySearcher.new().authorize(...).get_item("artist", "1dfeR4HaWDbWqFHLkxsg1d") # ``` - def get_item(item_type : String, id : String) : JSON::Any? - url = @root_url.join("#{item_type}s/#{id}").to_s() + def get_item(item_type : String, id : String, offset=0, + limit=100) : JSON::Any + if item_type == "playlist" + return get_playlist(id, offset, limit) + end + + url = "#{item_type}s/#{id}?limit=#{limit}&offset=#{offset}" + url = @root_url.join(url).to_s() + response = HTTP::Client.get(url, headers: @access_header) error_check(response) - return JSON.parse(response.body) + body = JSON.parse(response.body) + + return body + end + + # The only way this method differs from `get_item` is that it makes sure to + # insert ALL tracks from the playlist into the `JSON::Any` + # + # ``` + # SpotifySearcher.new().authorize(...).get_playlist("122Fc9gVuSZoksEjKEx7L0") + # ``` + def get_playlist(id, offset=0, limit=100) : JSON::Any + url = "playlists/#{id}?limit=#{limit}&offset=#{offset}" + url = @root_url.join(url).to_s() + + response = HTTP::Client.get(url, headers: @access_header) + error_check(response) + body = JSON.parse(response.body) + parent = PlaylistExtensionMapper.from_json(response.body) + + more_tracks = body["tracks"]["total"].as_i > offset + limit + if more_tracks + return playlist_extension(parent, id, offset=offset + limit) + end + + return body + end + + # This method exists to loop through spotify API requests and combine all + # tracks that may not be captured by the limit of 100. + private def playlist_extension(parent : PlaylistExtensionMapper, + id : String, offset=0, limit=100) : JSON::Any + url = "playlists/#{id}/tracks?limit=#{limit}&offset=#{offset}" + url = @root_url.join(url).to_s() + + response = HTTP::Client.get(url, headers: @access_header) + error_check(response) + body = JSON.parse(response.body) + new_tracks = PlaylistTracksMapper.from_json(response.body) + + new_tracks.items.each do |track| + parent.tracks.items.push(track) + end + + more_tracks = body["total"].as_i > offset + limit + if more_tracks + return playlist_extension(parent, id, offset=offset + limit) + end + + return JSON.parse(parent.to_json) end # Find the genre of an artist based off of their id @@ -197,7 +255,7 @@ class SpotifySearcher end # extra api info - query += "&type=#{item_type}&offset=#{offset}&limit=#{limit}" + query += "&type=#{item_type}&limit=#{limit}&offset=#{offset}" return query end From d1657ba86da9c492096ae71c40984a7258c7d55f Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Tue, 12 May 2020 22:28:03 -0700 Subject: [PATCH 21/26] Changed a bunch of stuff. Almost ready for release. - updated cli for config viewing and changes - updated config method. an environment variable `IRS_CONFIG_LOCATION` will be set pointing to a yaml file with a config - moved album metadata changing from a janky homebrew json modifier to the core json lib - mapper.cr is the collection of classes for messing around with json metadata - playlists are almost done, they still need the ability to (optionally) change the metadata of the songs downloaded in the playlist, but they (optionally) will place all downloaded playlist songs in a single folder - added a getter to the filename in song.cr --- src/bottle/cli.cr | 18 +++++++-- src/bottle/config.cr | 91 ++++++++++++++++++++++++++++++++++++++++++-- src/glue/album.cr | 4 +- src/glue/mapper.cr | 2 +- src/glue/playlist.cr | 24 ++++++++---- src/glue/song.cr | 2 +- 6 files changed, 122 insertions(+), 19 deletions(-) diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr index 13affa8..d95b7c0 100755 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -17,6 +17,7 @@ class CLI [["-h", "--help"], "help", "bool"], [["-v", "--version"], "version", "bool"], [["-i", "--install"], "install", "bool"], + [["-c", "--config"], "config", "bool"], [["-a", "--artist"], "artist", "string"], [["-s", "--song"], "song", "string"], [["-A", "--album"], "album", "string"], @@ -44,7 +45,8 @@ class CLI #{Style.bold "Arguments:"} #{Style.blue "-h, --help"} Show this help message and exit #{Style.blue "-v, --version"} Show the program version and exit - #{Style.blue "-i, --install"} Download necessary binaries to #{Style.green "~/.irs/bin"} + #{Style.blue "-i, --install"} Download binaries to config location + #{Style.blue "-c, --config"} Show config file location #{Style.blue "-a, --artist <artist>"} Specify artist name for downloading #{Style.blue "-s, --song <song>"} Specify song name to download #{Style.blue "-A, --album <album>"} Specify the album name to download @@ -59,13 +61,16 @@ class CLI #{Style.dim %(# => downloads the playlist "a different drummer" by the user prakkillian)} #{Style.bold "This project is licensed under the MIT license."} - #{Style.bold "Project page: <github.com/cooperhammond/irs>"} + #{Style.bold "Project page: <https://github.com/cooperhammond/irs>"} EOP puts msg end def act_on_args + + Config.check_necessities() + if @args["help"]? || @args.keys.size == 0 help exit @@ -75,6 +80,9 @@ class CLI elsif @args["install"]? YdlBinaries.get_both(Config.binary_location) exit + elsif @args["config"]? + puts ENV["IRS_CONFIG_LOCATION"]? + exit elsif @args["song"]? && @args["artist"]? s = Song.new(@args["song"], @args["artist"]) s.provide_client_keys(Config.client_key, Config.client_secret) @@ -89,6 +97,10 @@ class CLI p = Playlist.new(@args["playlist"], @args["artist"]) p.provide_client_keys(Config.client_key, Config.client_secret) p.grab_it() + else + puts Style.red("Those arguments don't do anything when used that way.") + puts "Type `irs -h` to see usage." + exit 1 end end @@ -124,7 +136,7 @@ class CLI end # ensure there's an argument if the program needs one - if flag[2] == "string" && i + 1 > argv.size + if flag[2] == "string" && i + 1 >= argv.size arg_error argv, i, %("#{arg}" needs an argument.) end diff --git a/src/bottle/config.cr b/src/bottle/config.cr index c288b5d..866f46f 100755 --- a/src/bottle/config.cr +++ b/src/bottle/config.cr @@ -1,22 +1,105 @@ +require "yaml" + +require "./styles" + + +EXAMPLE_CONFIG = <<-EOP +#{Style.dim "exampleconfig.yml"} +#{Style.dim "===="} +binary_directory: ~/.irs/bin +music_directory: ~/Music +client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +client_secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +single_folder_playlist: + enabled: true + retain_playlist_order: true + overwrite_album: false +#{Style.dim "===="} +EOP + module Config extend self + @@arguments = [ + "binary_directory", + "music_directory", + "client_key", + "client_secret", + "single_folder_playlist: enabled", + "single_folder_playlist: retain_playlist_order", + "single_folder_playlist: overwrite_album" + ] + + @@conf = YAML.parse("") + begin + @@conf = YAML.parse(File.read(ENV["IRS_CONFIG_LOCATION"])) + rescue + puts Style.red "Before anything else, define the environment variable IRS_CONFIG_LOCATION pointing to a .yml file like this one." + puts EXAMPLE_CONFIG + puts Style.bold "See https://github.com/cooperhammond/irs for more information on the config file" + exit 1 + end + def binary_location : String - path = "~/.irs/bin" + path = @@conf["binary_directory"].to_s return Path[path].expand(home: true).to_s end def music_directory : String - path = "./Music/" + path = @@conf["music_directory"].to_s return Path[path].expand(home: true).to_s end def client_key : String - return "362f75b91aeb471bb392945f93eba842" + return @@conf["client_key"].to_s end def client_secret : String - return "013556dd71e14e1da9443dee73e23a91" + return @@conf["client_secret"].to_s + end + + def single_folder_playlist? : Bool + return @@conf["single_folder_playlist"]["enabled"].as_bool + end + + def retain_playlist_order? : Bool + return @@conf["single_folder_playlist"]["retain_playlist_order"].as_bool + end + + def overwrite_album? : Bool + return @@conf["single_folder_playlist"]["overwrite_album"].as_bool + end + + def check_necessities + missing_configs = [] of String + @@arguments.each do |argument| + if !check_conf(argument) + missing_configs.push(argument) + end + end + if missing_configs.size > 0 + puts Style.red("You are missing the following key(s) in your YAML config file:") + missing_configs.each do |config| + puts " " + config + end + puts "\nHere's an example of what your config should look like:" + puts EXAMPLE_CONFIG + puts Style.bold "See https://github.com/cooperhammond/irs for more information on the config file" + exit 1 + end + end + + private def check_conf(key : String) : YAML::Any? + if key.includes?(": ") + args = key.split(": ") + if @@conf[args[0]]? + return @@conf[args[0]][args[1]]? + else + return @@conf[args[0]]? + end + else + return @@conf[key]? + end end end \ No newline at end of file diff --git a/src/glue/album.cr b/src/glue/album.cr index e6f0781..e7281b0 100755 --- a/src/glue/album.cr +++ b/src/glue/album.cr @@ -5,8 +5,6 @@ require "./song" require "./list" - - class Album < SpotifyList @home_music_directory = Config.music_directory @@ -37,7 +35,7 @@ class Album < SpotifyList } )) - prepped_data = AlbumTrackMetadataMapper.from_json(datum.to_json) + prepped_data = AlbumTracksMapper.from_json(datum.to_json) prepped_data.album = album_metadata data = parse_to_json(prepped_data.to_json) diff --git a/src/glue/mapper.cr b/src/glue/mapper.cr index c423662..ab4cc71 100755 --- a/src/glue/mapper.cr +++ b/src/glue/mapper.cr @@ -24,7 +24,7 @@ class PlaylistTracksMapper ) end -class AlbumTrackMetadataMapper +class AlbumTracksMapper JSON.mapping( album: { type: JSON::Any, diff --git a/src/glue/playlist.cr b/src/glue/playlist.cr index 0600b3e..2ec048d 100755 --- a/src/glue/playlist.cr +++ b/src/glue/playlist.cr @@ -3,9 +3,11 @@ require "../bottle/config" require "./song" require "./list" + class Playlist < SpotifyList @home_music_directory = Config.music_directory + @playlist : JSON::Any? # Uses the `spotify_searcher` defined in parent `SpotifyList` to find the # correct metadata of the list @@ -14,8 +16,8 @@ class Playlist < SpotifyList "name" => @list_name.as(String), "username" => @list_author.as(String) }) - if playlist - return playlist.as(JSON::Any) + if @playlist + return @playlist.as(JSON::Any) else puts "No playlists were found by that name and user." exit 1 @@ -26,16 +28,24 @@ class Playlist < SpotifyList # of spotify's album json. Moves the title of the album and the album art # to the json of the single song def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any - puts datum - puts "THIS" - - exit 0 data = datum return data end private def organize(song : Song) - song.organize_it(@home_music_directory) + if Config.single_folder_playlist? + path = Path[@home_music_directory].expand(home: true) + path = path / @playlist.as(JSON::Any)["name"].to_s + .gsub(/[\/]/, "").gsub(" ", " ") + strpath = path.to_s + if !File.directory?(strpath) + FileUtils.mkdir_p(strpath) + end + safe_filename = song.filename.gsub(/[\/]/, "").gsub(" ", " ") + File.rename("./" + song.filename, (path / safe_filename).to_s) + else + song.organize_it(@home_music_directory) + end end end diff --git a/src/glue/song.cr b/src/glue/song.cr index 0e59155..23f9f98 100755 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -11,7 +11,7 @@ class Song @client_secret = "" @metadata : JSON::Any? - @filename = "" + getter filename = "" @artist = "" @album = "" From de219cbe6653030bb0c03264453f76b9e8575d9e Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Tue, 12 May 2020 22:38:03 -0700 Subject: [PATCH 22/26] crystal tool format respec --- src/bottle/cli.cr | 22 +++------ src/bottle/config.cr | 20 ++++---- src/bottle/styles.cr | 2 +- src/bottle/version.cr | 2 +- src/glue/album.cr | 10 ++-- src/glue/list.cr | 13 ++--- src/glue/mapper.cr | 17 +++---- src/glue/playlist.cr | 10 ++-- src/glue/song.cr | 52 ++++++++++---------- src/interact/logger.cr | 25 +++++----- src/interact/ripper.cr | 17 +++---- src/interact/tagger.cr | 8 ++- src/irs.cr | 4 +- src/search/spotify.cr | 107 +++++++++++++++++++---------------------- src/search/youtube.cr | 39 +++++++-------- 15 files changed, 157 insertions(+), 191 deletions(-) diff --git a/src/bottle/cli.cr b/src/bottle/cli.cr index d95b7c0..2cbf378 100755 --- a/src/bottle/cli.cr +++ b/src/bottle/cli.cr @@ -8,9 +8,7 @@ require "../glue/song" require "../glue/album" require "../glue/playlist" - class CLI - # layout: # [[shortflag, longflag], key, type] @options = [ @@ -21,10 +19,9 @@ class CLI [["-a", "--artist"], "artist", "string"], [["-s", "--song"], "song", "string"], [["-A", "--album"], "album", "string"], - [["-p", "--playlist"], "playlist", "string"] + [["-p", "--playlist"], "playlist", "string"], ] - @args : Hash(String, String) def initialize(argv : Array(String)) @@ -68,8 +65,7 @@ class CLI end def act_on_args - - Config.check_necessities() + Config.check_necessities if @args["help"]? || @args.keys.size == 0 help @@ -86,17 +82,17 @@ class CLI elsif @args["song"]? && @args["artist"]? s = Song.new(@args["song"], @args["artist"]) s.provide_client_keys(Config.client_key, Config.client_secret) - s.grab_it() + s.grab_it s.organize_it(Config.music_directory) exit elsif @args["album"]? && @args["artist"]? a = Album.new(@args["album"], @args["artist"]) a.provide_client_keys(Config.client_key, Config.client_secret) - a.grab_it() + a.grab_it elsif @args["playlist"]? && @args["artist"]? p = Playlist.new(@args["playlist"], @args["artist"]) p.provide_client_keys(Config.client_key, Config.client_secret) - p.grab_it() + p.grab_it else puts Style.red("Those arguments don't do anything when used that way.") puts "Type `irs -h` to see usage." @@ -111,12 +107,11 @@ class CLI current_key = "" pass_next_arg = false argv.each do |arg| - # If the previous arg was an arg flag, this is an arg, so pass it - if pass_next_arg + if pass_next_arg pass_next_arg = false i += 1 - next + next end flag = [] of Array(String) | String @@ -140,7 +135,6 @@ class CLI arg_error argv, i, %("#{arg}" needs an argument.) end - key = flag[1].as(String) if flag[2] == "string" arguments[key] = argv[i + 1] @@ -182,4 +176,4 @@ class CLI puts "Type `irs -h` to see usage." exit 1 end -end \ No newline at end of file +end diff --git a/src/bottle/config.cr b/src/bottle/config.cr index 866f46f..ddf3a07 100755 --- a/src/bottle/config.cr +++ b/src/bottle/config.cr @@ -2,7 +2,6 @@ require "yaml" require "./styles" - EXAMPLE_CONFIG = <<-EOP #{Style.dim "exampleconfig.yml"} #{Style.dim "===="} @@ -18,17 +17,16 @@ single_folder_playlist: EOP module Config - extend self @@arguments = [ - "binary_directory", - "music_directory", - "client_key", + "binary_directory", + "music_directory", + "client_key", "client_secret", - "single_folder_playlist: enabled", - "single_folder_playlist: retain_playlist_order", - "single_folder_playlist: overwrite_album" + "single_folder_playlist: enabled", + "single_folder_playlist: retain_playlist_order", + "single_folder_playlist: overwrite_album", ] @@conf = YAML.parse("") @@ -69,14 +67,14 @@ module Config def overwrite_album? : Bool return @@conf["single_folder_playlist"]["overwrite_album"].as_bool - end + end def check_necessities missing_configs = [] of String @@arguments.each do |argument| if !check_conf(argument) missing_configs.push(argument) - end + end end if missing_configs.size > 0 puts Style.red("You are missing the following key(s) in your YAML config file:") @@ -102,4 +100,4 @@ module Config return @@conf[key]? end end -end \ No newline at end of file +end diff --git a/src/bottle/styles.cr b/src/bottle/styles.cr index a474f37..a79928d 100755 --- a/src/bottle/styles.cr +++ b/src/bottle/styles.cr @@ -20,4 +20,4 @@ class Style def self.red(txt) txt.colorize(:light_red) end -end \ No newline at end of file +end diff --git a/src/bottle/version.cr b/src/bottle/version.cr index 7d6cb37..d9b75dc 100755 --- a/src/bottle/version.cr +++ b/src/bottle/version.cr @@ -1,3 +1,3 @@ module IRS VERSION = "0.1.0" -end \ No newline at end of file +end diff --git a/src/glue/album.cr b/src/glue/album.cr index e7281b0..94a140c 100755 --- a/src/glue/album.cr +++ b/src/glue/album.cr @@ -4,17 +4,15 @@ require "./mapper" require "./song" require "./list" - class Album < SpotifyList - @home_music_directory = Config.music_directory # Uses the `spotify_searcher` defined in parent `SpotifyList` to find the - # correct metadata of the list + # correct metadata of the list def find_it album = @spotify_searcher.find_item("album", { - "name" => @list_name.as(String), - "artist" => @list_author.as(String) + "name" => @list_name.as(String), + "artist" => @list_author.as(String), }) if album return album.as(JSON::Any) @@ -24,7 +22,7 @@ class Album < SpotifyList end end - # Will define specific metadata that may not be included in the raw return + # Will define specific metadata that may not be included in the raw return # of spotify's album json. Moves the title of the album and the album art # to the json of the single song def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any diff --git a/src/glue/list.cr b/src/glue/list.cr index 44664bf..7a233f5 100755 --- a/src/glue/list.cr +++ b/src/glue/list.cr @@ -8,10 +8,9 @@ require "../interact/tagger" require "./song" - # A parent class for downloading albums and playlists from spotify abstract class SpotifyList - @spotify_searcher = SpotifySearcher.new() + @spotify_searcher = SpotifySearcher.new @file_names = [] of String def initialize(@list_name : String, @list_author : String?) @@ -19,7 +18,6 @@ abstract class SpotifyList # Finds the list, and downloads all of the songs using the `Song` class def grab_it - if !@spotify_searcher.authorized? raise("Need to call provide_client_keys on Album or Playlist class.") end @@ -38,7 +36,7 @@ abstract class SpotifyList song = Song.new(data["name"].to_s, data["artists"][0]["name"].to_s) song.provide_spotify(@spotify_searcher) song.provide_metadata(data) - song.grab_it() + song.grab_it organize(song) @@ -57,12 +55,11 @@ abstract class SpotifyList # If there's a need to organize the individual song data so that the `Song` # class can better handle it, this function will be defined in the subclass - private abstract def organize_song_metadata(list : JSON::Any, - datum : JSON::Any) : JSON::Any + private abstract def organize_song_metadata(list : JSON::Any, + datum : JSON::Any) : JSON::Any # Will define the specific type of organization for a list of songs. # Needed because most people want albums sorted by artist, but playlists all # in one folder private abstract def organize(song : Song) - -end \ No newline at end of file +end diff --git a/src/glue/mapper.cr b/src/glue/mapper.cr index ab4cc71..9a658ad 100755 --- a/src/glue/mapper.cr +++ b/src/glue/mapper.cr @@ -3,8 +3,8 @@ require "json" class PlaylistExtensionMapper JSON.mapping( tracks: { - type: PlaylistTracksMapper, - setter: true + type: PlaylistTracksMapper, + setter: true, }, id: String, images: JSON::Any, @@ -17,8 +17,8 @@ end class PlaylistTracksMapper JSON.mapping( items: { - type: Array(JSON::Any), - setter: true + type: Array(JSON::Any), + setter: true, }, total: Int32 ) @@ -26,10 +26,10 @@ end class AlbumTracksMapper JSON.mapping( - album: { - type: JSON::Any, + album: { + type: JSON::Any, nilable: true, - setter: true + setter: true, }, artists: JSON::Any, disc_number: Int32, @@ -41,7 +41,6 @@ class AlbumTracksMapper ) end - def parse_to_json(string_json : String) : JSON::Any return JSON.parse(string_json) -end \ No newline at end of file +end diff --git a/src/glue/playlist.cr b/src/glue/playlist.cr index 2ec048d..cb3ead1 100755 --- a/src/glue/playlist.cr +++ b/src/glue/playlist.cr @@ -3,18 +3,16 @@ require "../bottle/config" require "./song" require "./list" - class Playlist < SpotifyList - @home_music_directory = Config.music_directory @playlist : JSON::Any? # Uses the `spotify_searcher` defined in parent `SpotifyList` to find the - # correct metadata of the list + # correct metadata of the list def find_it @playlist = @spotify_searcher.find_item("playlist", { - "name" => @list_name.as(String), - "username" => @list_author.as(String) + "name" => @list_name.as(String), + "username" => @list_author.as(String), }) if @playlist return @playlist.as(JSON::Any) @@ -24,7 +22,7 @@ class Playlist < SpotifyList end end - # Will define specific metadata that may not be included in the raw return + # Will define specific metadata that may not be included in the raw return # of spotify's album json. Moves the title of the album and the album art # to the json of the single song def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any diff --git a/src/glue/song.cr b/src/glue/song.cr index 23f9f98..9d7ea06 100755 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -4,9 +4,8 @@ require "../search/youtube" require "../interact/ripper" require "../interact/tagger" - class Song - @spotify_searcher = SpotifySearcher.new() + @spotify_searcher = SpotifySearcher.new @client_id = "" @client_secret = "" @@ -21,29 +20,29 @@ class Song # Find, downloads, and tags the mp3 song that this class represents. # # ``` - # Song.new("Bohemian Rhapsody", "Queen").grab_it() - # ``` + # Song.new("Bohemian Rhapsody", "Queen").grab_it + # ``` def grab_it if !@spotify_searcher.authorized? && !@metadata if @client_id != "" && @client_secret != "" @spotify_searcher.authorize(@client_id, @client_secret) else raise("Need to call either `provide_metadata`, `provide_spotify`, " + - "or `provide_client_keys` so that Spotify can be interfaced with.") + "or `provide_client_keys` so that Spotify can be interfaced with.") end end if !@metadata puts "Searching for metadata ..." @metadata = @spotify_searcher.find_item("track", { - "name" => @song_name, - "artist" => @artist_name + "name" => @song_name, + "artist" => @artist_name, }) if !@metadata - raise("There was no metadata found on Spotify for\n" + - %("#{@song_name}" by "#{@artist_name}\n) + - "Check your input and try again.") + raise("There was no metadata found on Spotify for\n" + + %("#{@song_name}" by "#{@artist_name}\n) + + "Check your input and try again.") end end @@ -54,12 +53,12 @@ class Song # TODO: should this search_term be here? url = Youtube.find_url(@song_name, @artist_name, search_terms: "lyrics") - if !url - raise("There was no url found on youtube for\n" + - %("#{@song_name}" by "#{@artist_name}\n) + - "Check your input and try again.") + if !url + raise("There was no url found on youtube for\n" + + %("#{@song_name}" by "#{@artist_name}\n) + + "Check your input and try again.") end - + puts "Downloading video:" Ripper.download_mp3(url.as(String), @filename) @@ -76,27 +75,26 @@ class Song tagger.add_text_tag("title", data["name"].to_s) tagger.add_text_tag("artist", @artist) tagger.add_text_tag("album", @album) - tagger.add_text_tag("genre", + tagger.add_text_tag("genre", @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) tagger.add_text_tag("track", data["track_number"].to_s) tagger.add_text_tag("disc", data["disc_number"].to_s) puts "Tagging metadata ..." - tagger.save() + tagger.save File.delete(temp_albumart_filename) puts %("#{data["name"].to_s}" by "#{data["artists"][0]["name"].to_s}" downloaded.) - end - # Will organize the song into the user's provided music directory as + # Will organize the song into the user's provided music directory as # music_directory > artist_name > album_name > song # Must be called AFTER the song has been downloaded. # # ``` - # s = Song.new("Bohemian Rhapsody", "Queen").grab_it() + # s = Song.new("Bohemian Rhapsody", "Queen").grab_it # s.organize_it("/home/cooper/Music") - # # Will move the mp3 file to + # # Will move the mp3 file to # # /home/cooper/Music/Queen/A Night At The Opera/1 - Bohemian Rhapsody.mp3 # ``` def organize_it(music_directory : String) @@ -116,20 +114,20 @@ class Song # called. # # ``` - # Song.new(...).provide_metadata(...).grab_it() + # Song.new(...).provide_metadata(...).grab_it # ``` def provide_metadata(metadata : JSON::Any) : self @metadata = metadata return self end - # Provide an already authenticated `SpotifySearcher` class. Useful to avoid + # Provide an already authenticated `SpotifySearcher` class. Useful to avoid # authenticating over and over again. Must be called if provide_metadata and # provide_client_keys are not called. # # ``` - # Song.new(...).provide_spotify(SpotifySearcher.new() - # .authenticate("XXXXXXXXXX", "XXXXXXXXXXX")).grab_it() + # Song.new(...).provide_spotify(SpotifySearcher.new + # .authenticate("XXXXXXXXXX", "XXXXXXXXXXX")).grab_it # ``` def provide_spotify(spotify : SpotifySearcher) : self @spotify_searcher = spotify @@ -140,11 +138,11 @@ class Song # provide_spotify are not called. # # ``` - # Song.new(...).provide_client_keys("XXXXXXXXXX", "XXXXXXXXX").grab_it() + # Song.new(...).provide_client_keys("XXXXXXXXXX", "XXXXXXXXX").grab_it # ``` def provide_client_keys(client_id : String, client_secret : String) : self @client_id = client_id @client_secret = client_secret return self end -end \ No newline at end of file +end diff --git a/src/interact/logger.cr b/src/interact/logger.cr index a2cfc4f..3f21acd 100755 --- a/src/interact/logger.cr +++ b/src/interact/logger.cr @@ -1,5 +1,4 @@ class Logger - @done_signal = "---DONE---" @command : String @@ -11,16 +10,16 @@ class Logger def initialize(command : String, @log_name : String, @sleept = 0.01) # Have the command output its information to a log and after the command is # finished, append an end signal to the document - @command = "#{command} > #{@log_name} " # standard output to log - @command += "2> #{@log_name} && " # errors to log - @command += "echo #{@done_signal} >> #{@log_name}" # + @command = "#{command} > #{@log_name} " # standard output to log + @command += "2> #{@log_name} && " # errors to log + @command += "echo #{@done_signal} >> #{@log_name}" # end # Run @command in the background and pipe its output to the log file, with # something constantly monitoring the log file and yielding each new line to - # the block call. Useful for changing the output of binaries you don't have + # the block call. Useful for changing the output of binaries you don't have # much control over. - # Note that the created temp log will be deleted unless the command fails + # Note that the created temp log will be deleted unless the command fails # its exit or .start is called with delete_file: false # # ``` @@ -34,7 +33,7 @@ class Logger # end # end # ``` - def start(delete_file=true, &block) : Bool + def start(delete_file = true, &block) : Bool # Delete the log if it already exists File.delete(@log_name) if File.exists?(@log_name) @@ -44,7 +43,7 @@ class Logger } # Wait for the log file to be written to - while !File.exists?(@log_name) + while !File.exists?(@log_name) sleep @sleept end @@ -68,12 +67,12 @@ class Logger end end - status = called.get() - if status == true && delete_file == true - log.delete() + status = called.get + if status == true && delete_file == true + log.delete end - return called.get() + return called.get end # Reads each line of the file into an Array of Strings @@ -86,4 +85,4 @@ class Logger return content end -end \ No newline at end of file +end diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 24e3607..35e84e0 100755 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -2,7 +2,6 @@ require "./logger" require "../bottle/config" module Ripper - extend self BIN_LOC = Path[Config.binary_location] @@ -11,23 +10,23 @@ module Ripper # Will create any directories that don't exist specified in *output_filename* # # ``` - # Ripper.download_mp3("https://youtube.com/watch?v=0xnciFWAqa0", + # Ripper.download_mp3("https://youtube.com/watch?v=0xnciFWAqa0", # "Queen/A Night At The Opera/Bohemian Rhapsody.mp3") # ``` def download_mp3(video_url : String, output_filename : String) ydl_loc = BIN_LOC.join("youtube-dl") - + # remove the extension that will be added on by ydl output_filename = output_filename.split(".")[..-2].join(".") options = { "--output" => %("#{output_filename}.%(ext)s"), # auto-add correct ext # "--quiet" => "", - "--verbose" => "", + "--verbose" => "", "--ffmpeg-location" => BIN_LOC, - "--extract-audio" => "", - "--audio-format" => "mp3", - "--audio-quality" => "0", + "--extract-audio" => "", + "--audio-format" => "mp3", + "--audio-quality" => "0", } command = ydl_loc.to_s + " " + video_url @@ -35,7 +34,6 @@ module Ripper command += " #{option} #{options[option]}" end - l = Logger.new(command, ".ripper.log") o = RipperOutputCensor.new @@ -64,6 +62,5 @@ module Ripper end end end - end -end \ No newline at end of file +end diff --git a/src/interact/tagger.cr b/src/interact/tagger.cr index 3dde48e..3f4ab7e 100755 --- a/src/interact/tagger.cr +++ b/src/interact/tagger.cr @@ -5,10 +5,9 @@ require "../bottle/config" # t = Tags.new("bohem rap.mp3") # t.add_album_art("a night at the opera album cover.jpg") # t.add_text_tag("title", "Bohemian Rhapsody") -# t.save() +# t.save # ``` class Tags - # TODO: export this path to a config file @BIN_LOC = Config.binary_location @query_args = [] of String @@ -20,7 +19,6 @@ class Tags end @query_args.push(%(-i "#{@filename}")) - end # Add album art to the mp3. Album art must be added BEFORE text tags are. @@ -52,7 +50,7 @@ class Tags l = Logger.new(command, ".tagger.log") l.start { |line, start| } - + File.delete(@filename) File.rename("_" + @filename, @filename) end @@ -61,4 +59,4 @@ end # a = Tags.new("test.mp3") # a.add_text_tag("title", "Warwick Avenue") # a.add_album_art("file.png") -# a.save() \ No newline at end of file +# a.save() diff --git a/src/irs.cr b/src/irs.cr index 790e351..f57fb4b 100755 --- a/src/irs.cr +++ b/src/irs.cr @@ -2,7 +2,7 @@ require "./bottle/cli" def main cli = CLI.new(ARGV) - cli.act_on_args() + cli.act_on_args end -main() \ No newline at end of file +main() diff --git a/src/search/spotify.cr b/src/search/spotify.cr index 1d2d4c7..c1ea10e 100755 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -11,18 +11,18 @@ class SpotifySearcher @authorized = false # Saves an access token for future program use with spotify using client IDs. - # Specs defined on spotify's developer api: + # Specs defined on spotify's developer api: # https://developer.spotify.com/documentation/general/guides/authorization-guide/#client-credentials-flow # # ``` - # SpotifySearcher.new().authorize("XXXXXXXXXX", "XXXXXXXXXX") + # SpotifySearcher.new.authorize("XXXXXXXXXX", "XXXXXXXXXX") # ``` def authorize(client_id : String, client_secret : String) : self auth_url = "https://accounts.spotify.com/api/token" headers = HTTP::Headers{ - "Authorization" => "Basic " + - Base64.strict_encode "#{client_id}:#{client_secret}" + "Authorization" => "Basic " + + Base64.strict_encode "#{client_id}:#{client_secret}", } payload = "grant_type=client_credentials" @@ -31,9 +31,9 @@ class SpotifySearcher error_check(response) access_token = JSON.parse(response.body)["access_token"] - + @access_header = HTTP::Headers{ - "Authorization" => "Bearer #{access_token}" + "Authorization" => "Bearer #{access_token}", } @authorized = true @@ -55,12 +55,11 @@ class SpotifySearcher # }) # => {track metadata} # ``` - def find_item(item_type : String, item_parameters : Hash, offset=0, - limit=20) : JSON::Any? - + def find_item(item_type : String, item_parameters : Hash, offset = 0, + limit = 20) : JSON::Any? query = generate_query(item_type, item_parameters, offset, limit) - url = @root_url.join("search?q=#{query}").to_s() + url = @root_url.join("search?q=#{query}").to_s response = HTTP::Client.get(url, headers: @access_header) error_check(response) @@ -74,7 +73,7 @@ class SpotifySearcher begin # this means no points were assigned so don't return the "best guess" if points[0][0] <= 0 - to_return = nil + to_return = nil else to_return = get_item(item_type, items[points[0][1]]["id"].to_s) end @@ -82,15 +81,15 @@ class SpotifySearcher to_return = nil end - # if this triggers, it means that a playlist has failed to be found, so + # if this triggers, it means that a playlist has failed to be found, so # the search will be bootstrapped into find_user_playlist if to_return == nil && item_type == "playlist" return find_user_playlist( - item_parameters["username"], + item_parameters["username"], item_parameters["name"] ) end - + return to_return end @@ -100,9 +99,8 @@ class SpotifySearcher # spotify_searcher.find_user_playlist("prakkillian", "the little man") # => {playlist metadata} # ``` - def find_user_playlist(username : String, name : String, offset=0, - limit=20) : JSON::Any? - + def find_user_playlist(username : String, name : String, offset = 0, + limit = 20) : JSON::Any? url = "users/#{username}/playlists?limit=#{limit}&offset=#{offset}" url = @root_url.join(url).to_s @@ -116,14 +114,14 @@ class SpotifySearcher items.as_a.each_index do |i| points.push([points_compare(items[i]["name"].to_s, name), i]) end - points.sort!{ |a, b| b[0] <=> a[0] } + points.sort! { |a, b| b[0] <=> a[0] } begin if points[0][0] < 3 return find_user_playlist(username, name, offset + limit, limit) else return get_item("playlist", items[points[0][1]]["id"].to_s) - end + end rescue IndexError return nil end @@ -132,18 +130,17 @@ class SpotifySearcher # Get the complete metadata of an item based off of its id # # ``` - # SpotifySearcher.new().authorize(...).get_item("artist", "1dfeR4HaWDbWqFHLkxsg1d") + # SpotifySearcher.new.authorize(...).get_item("artist", "1dfeR4HaWDbWqFHLkxsg1d") # ``` - def get_item(item_type : String, id : String, offset=0, - limit=100) : JSON::Any - + def get_item(item_type : String, id : String, offset = 0, + limit = 100) : JSON::Any if item_type == "playlist" return get_playlist(id, offset, limit) end url = "#{item_type}s/#{id}?limit=#{limit}&offset=#{offset}" - url = @root_url.join(url).to_s() - + url = @root_url.join(url).to_s + response = HTTP::Client.get(url, headers: @access_header) error_check(response) @@ -156,12 +153,12 @@ class SpotifySearcher # insert ALL tracks from the playlist into the `JSON::Any` # # ``` - # SpotifySearcher.new().authorize(...).get_playlist("122Fc9gVuSZoksEjKEx7L0") + # SpotifySearcher.new.authorize(...).get_playlist("122Fc9gVuSZoksEjKEx7L0") # ``` - def get_playlist(id, offset=0, limit=100) : JSON::Any + def get_playlist(id, offset = 0, limit = 100) : JSON::Any url = "playlists/#{id}?limit=#{limit}&offset=#{offset}" - url = @root_url.join(url).to_s() - + url = @root_url.join(url).to_s + response = HTTP::Client.get(url, headers: @access_header) error_check(response) body = JSON.parse(response.body) @@ -169,7 +166,7 @@ class SpotifySearcher more_tracks = body["tracks"]["total"].as_i > offset + limit if more_tracks - return playlist_extension(parent, id, offset=offset + limit) + return playlist_extension(parent, id, offset = offset + limit) end return body @@ -177,10 +174,10 @@ class SpotifySearcher # This method exists to loop through spotify API requests and combine all # tracks that may not be captured by the limit of 100. - private def playlist_extension(parent : PlaylistExtensionMapper, - id : String, offset=0, limit=100) : JSON::Any + private def playlist_extension(parent : PlaylistExtensionMapper, + id : String, offset = 0, limit = 100) : JSON::Any url = "playlists/#{id}/tracks?limit=#{limit}&offset=#{offset}" - url = @root_url.join(url).to_s() + url = @root_url.join(url).to_s response = HTTP::Client.get(url, headers: @access_header) error_check(response) @@ -193,7 +190,7 @@ class SpotifySearcher more_tracks = body["total"].as_i > offset + limit if more_tracks - return playlist_extension(parent, id, offset=offset + limit) + return playlist_extension(parent, id, offset = offset + limit) end return JSON.parse(parent.to_json) @@ -202,10 +199,9 @@ class SpotifySearcher # Find the genre of an artist based off of their id # # ``` - # SpotifySearcher.new().authorize(...).find_genre("1dfeR4HaWDbWqFHLkxsg1d") + # SpotifySearcher.new.authorize(...).find_genre("1dfeR4HaWDbWqFHLkxsg1d") # ``` def find_genre(id : String) : String - genre = get_item("artist", id)["genres"][0].to_s genre = genre.split(" ").map { |x| x.capitalize }.join(" ") @@ -216,15 +212,15 @@ class SpotifySearcher private def error_check(response : HTTP::Client::Response) : Nil if response.status_code != 200 raise("There was an error with your request.\n" + - "Status code: #{response.status_code}\n" + + "Status code: #{response.status_code}\n" + "Response: \n#{response.body}") end end - + # Generates url to run a GET request against to the Spotify open API # Returns a `String.` private def generate_query(item_type : String, item_parameters : Hash, - offset : Int32, limit : Int32) : String + offset : Int32, limit : Int32) : String query = "" # parameter keys to exclude in the api request. These values will be put @@ -234,21 +230,20 @@ class SpotifySearcher item_parameters.keys.each do |k| # This will map album and track names from the name key to the query if k == "name" - # will remove the "name:<title>" param from the query - if item_type == "playlist" + if item_type == "playlist" query += item_parameters[k].gsub(" ", "+") + "+" else query += param_encode(item_type, item_parameters[k]) end - # check if the key is to be excluded + # check if the key is to be excluded elsif query_exclude.includes?(k) next - - # if it's none of the above, treat it normally - # NOTE: playlist names will be inserted into the query normally, without - # a parameter. + + # if it's none of the above, treat it normally + # NOTE: playlist names will be inserted into the query normally, without + # a parameter. else query += param_encode(k, item_parameters[k]) end @@ -264,7 +259,7 @@ class SpotifySearcher # Meant to find the item that the user desires. # Returns an `Array` of `Array(Int32)` or [[3, 1], [...], ...] private def rank_items(items : Array, - parameters : Hash) : Array(Array(Int32)) + parameters : Hash) : Array(Array(Int32)) points = [] of Array(Int32) index = 0 @@ -274,7 +269,7 @@ class SpotifySearcher # Think about whether this following logic is worth having in one method. # Is it nice to have a single method that handles it all or having a few # methods for each of the item types? (track, album, playlist) - parameters.keys.each do |k| + parameters.keys.each do |k| val = parameters[k] # The key to compare to for artist @@ -286,7 +281,7 @@ class SpotifySearcher if k == "username" pts_to_add = points_compare(item["owner"]["display_name"].to_s, val) pts += pts_to_add - pts += -10 if pts_to_add == 0 + pts += -10 if pts_to_add == 0 end # The key regardless of whether item is track, album,or playlist @@ -299,12 +294,12 @@ class SpotifySearcher index += 1 end - points.sort!{ |a, b| b[0] <=> a[0] } + points.sort! { |a, b| b[0] <=> a[0] } return points end - # Returns an `Int` based off the number of points worth assigning to the + # Returns an `Int` based off the number of points worth assigning to the # matchiness of the string. First the strings are downcased and then all # nonalphanumeric characters are stripped. # If the strings are the exact same, return 3 pts. @@ -332,18 +327,16 @@ class SpotifySearcher private def param_encode(key : String, value : String) : String return key.gsub(" ", "+") + ":" + value.gsub(" ", "+") + "+" end - end - # puts SpotifySearcher.new() -# .authorize("XXXXXXXXXXXXXXX", +# .authorize("XXXXXXXXXXXXXXX", # "XXXXXXXXXXXXXXX") # .find_item("playlist", { -# "name" => "Brain Food", -# "username" => "spotify" +# "name" => "Brain Food", +# "username" => "spotify" # # "name " => "A Night At The Opera", # # "artist" => "Queen" # # "track" => "Bohemian Rhapsody", # # "artist" => "Queen" -# }) \ No newline at end of file +# }) diff --git a/src/search/youtube.cr b/src/search/youtube.cr index ee41312..5742852 100755 --- a/src/search/youtube.cr +++ b/src/search/youtube.cr @@ -1,24 +1,22 @@ require "http" require "xml" - module Youtube - extend self VALID_LINK_CLASSES = [ "yt-simple-endpoint style-scope ytd-video-renderer", - "yt-uix-tile-link yt-ui-ellipsis yt-ui-ellipsis-2 yt-uix-sessionlink spf-link " + "yt-uix-tile-link yt-ui-ellipsis yt-ui-ellipsis-2 yt-uix-sessionlink spf-link ", ] GARBAGE_PHRASES = [ "cover", "album", "live", "clean", "version", "full", "full album", "row", "at", "@", "session", "how to", "npr music", "reimagined", "hr version", - "trailer" + "trailer", ] GOLDEN_PHRASES = [ - "official video", "official music video" + "official video", "official music video", ] # Finds a youtube url based off of the given information. @@ -30,11 +28,11 @@ module Youtube # Youtube.find_url("Bohemian Rhapsody", "Queen") # => "https://www.youtube.com/watch?v=dQw4w9WgXcQ" # ``` - def find_url(song_name : String, artist_name : String, search_terms = "", - download_first = false) : String? + def find_url(song_name : String, artist_name : String, search_terms = "", + download_first = false) : String? query = (song_name + " " + artist_name + " " + search_terms).strip.gsub(" ", "+") - url = "https://www.youtube.com/results?search_query=" + query + url = "https://www.youtube.com/results?search_query=" + query response = HTTP::Client.get(url) @@ -61,11 +59,11 @@ module Youtube # Will rank videos according to their title and the user input # Return: # [ - # {"points" => x, "index" => x}, - # ... + # {"points" => x, "index" => x}, + # ... # ] - private def rank_videos(song_name : String, artist_name : String, - query : String, nodes : Array(XML::Node)) : Array(Hash(String, Int32)) + private def rank_videos(song_name : String, artist_name : String, + query : String, nodes : Array(XML::Node)) : Array(Hash(String, Int32)) points = [] of Hash(String, Int32) index = 0 @@ -78,14 +76,13 @@ module Youtube points.push({ "points" => pts, - "index" => index + "index" => index, }) index += 1 - end # Sort first by points and then by original index of the song - points.sort!{ |a, b| + points.sort! { |a, b| if b["points"] == a["points"] a["index"] <=> b["index"] else @@ -96,11 +93,11 @@ module Youtube return points end - # Returns an `Int` based off the number of points worth assigning to the + # Returns an `Int` based off the number of points worth assigning to the # matchiness of the string. First the strings are downcased and then all # nonalphanumeric characters are stripped. # If *item1* includes *item2*, return 3 pts. - # If after the items have been blanked, *item1* includes *item2*, + # If after the items have been blanked, *item1* includes *item2*, # return 1 pts. # Else, return 0 pts. private def points_compare(item1 : String, item2 : String) : Int32 @@ -118,10 +115,10 @@ module Youtube end end - # Checks if there are any phrases in the title of the video that would + # Checks if there are any phrases in the title of the video that would # indicate audio having what we want. # *video_name* is the title of the video, and *query* is what the user the - # program searched for. *query* is needed in order to make sure we're not + # program searched for. *query* is needed in order to make sure we're not # subtracting points from something that's naturally in the title private def count_buzzphrases(query : String, video_name : String) : Int32 good_phrases = 0 @@ -129,7 +126,7 @@ module Youtube GOLDEN_PHRASES.each do |gold_phrase| gold_phrase = gold_phrase.downcase.gsub(/[^a-z0-9]/, "") - + if query.downcase.gsub(/[^a-z0-9]/, "").includes?(gold_phrase) next elsif video_name.downcase.gsub(/[^a-z0-9]/, "").includes?(gold_phrase) @@ -180,4 +177,4 @@ module Youtube end return false end -end \ No newline at end of file +end From ce6f77d68ddfc29eb7f45884900e0d7533afa5a7 Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Fri, 15 May 2020 09:16:50 -0700 Subject: [PATCH 23/26] nothing affecting functionality, all meta changes - changed license to MIT - wrote out actual README - spotify client keys are checked for on run in config.cr - spotify-searcher class doesn't crash now when there's a problem with the keys or authentication, rather it just sets @authenticated to false --- LICENSE | 2 +- README.md | 67 +++++++++++++++++++++++++++++++++---------- src/bottle/config.cr | 28 ++++++++++++------ src/search/spotify.cr | 5 +++- 4 files changed, 77 insertions(+), 25 deletions(-) diff --git a/LICENSE b/LICENSE index 191c7f4..cd00ded 100755 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2019 Cooper Hammond +Copyright (c) 2020 Cooper Hammond Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f2fd4e9..f292c96 100755 --- a/README.md +++ b/README.md @@ -1,33 +1,70 @@ -# irs +# `irs` +###### AKA `Ironic Repositioning System` -TODO: Write a description here +[![made-with-crystal](https://img.shields.io/badge/Made%20with-Crystal-1f425f.svg?style=flat-square)](https://crystal-lang.org/) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](https://github.com/cooperhammond/irs/blob/master/LICENSE) +[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg?style=flat-square)](https://saythanks.io/to/kepoorhampond) + +> A music scraper that understands your metadata needs. + +## Installation + +1. Download the latest release for your platform [here](https://github.com/cooperhammond/irs/releases) +1. Create a `.yaml` config file somewhere on your system +1. Copy the following into it + ```yaml + binary_directory: ~/.irs/bin + music_directory: ~/Music + client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + client_secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + single_folder_playlist: + enabled: true + retain_playlist_order: true + overwrite_album: false + ``` +1. Set the environment variable `IRS_CONFIG_LOCATION` pointing to that file +1. Go to [`https://developer.spotify.com/dashboard/`](https://developer.spotify.com/dashboard/) +1. Log in or create an account +1. Click `CREATE A CLIENT ID` +1. Enter all necessary info, true or false, continue +1. Find your client key and client secret +2. Copy them into where all the X's are in your config file from above + +You should be good to go! Run the file from your command line to get help on usage or keep reading! + +##### Optionally From Source + +Or if you're one of those cool people who compiles from source + +1. Install crystal-lang ([`https://crystal-lang.org/install/`](https://crystal-lang.org/install/)) +1. Clone it (`git clone https://github.com/cooperhammond/irs`) +1. CD it (`cd irs`) +1. Build it (`shards build`) ## Usage <p align="center"> - <img src="https://i.imgur.com/G783tKA.png" height="450" /> + <img src="https://i.imgur.com/uYKh101.png" height="600" /> </p> -TODO: Write usage instructions here +## How it works -## Installation +**At it's core** `irs` downloads individual songs. It does this by interfacing with the Spotify API, grabbing metadata, and then searching Youtube for a video containing the song's audio. It will download the video using [`youtube-dl`](https://github.com/ytdl-org/youtube-dl), extract the audio using [`ffmpeg`](https://ffmpeg.org/), and then pack the audio and metadata together into an MP3. -TODO: Write installation instructions here +From the core, it has been extended to download the index of albums and playlists through the spotify API, and then iteratively use the method above for downloading each song. +It used to be in `python`, but +1. I wasn't a fan of python's limited ability to distribute standalone binaries +1. It was a clusterfuck of code that I made when I was little and I wanted to refine it +2. `crystal-lang` made some promises and I was interested in seeing how well it did (verdict: if you're building high-level tools you want to run quickly and distribute, it's a joy to work in) -## Development - -TODO: Write development instructions here - ## Contributing +Any and all contributions are welcome. If you think of a cool feature, send a PR or shoot me an [email](mailto:kepoorh@gmail.com). If you think something could be implemented better, _please_ shoot me an email. If you like what I'm doing here, _pretty please_ shoot me an email. + 1. Fork it (<https://github.com/your-github-user/irs/fork>) 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) -5. Create a new Pull Request - -## Contributors - -- [Cooper Hammond](https://github.com/your-github-user) - creator and maintainer +5. Create a new Pull Request \ No newline at end of file diff --git a/src/bottle/config.cr b/src/bottle/config.cr index ddf3a07..ab1c81f 100755 --- a/src/bottle/config.cr +++ b/src/bottle/config.cr @@ -2,17 +2,19 @@ require "yaml" require "./styles" +require "../search/spotify" + EXAMPLE_CONFIG = <<-EOP #{Style.dim "exampleconfig.yml"} #{Style.dim "===="} -binary_directory: ~/.irs/bin -music_directory: ~/Music -client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -client_secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -single_folder_playlist: - enabled: true - retain_playlist_order: true - overwrite_album: false +#{Style.blue "binary_directory"}: #{Style.green "~/.irs/bin"} +#{Style.blue "music_directory"}: #{Style.green "~/Music"} +#{Style.blue "client_key"}: #{Style.green "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"} +#{Style.blue "client_secret"}: #{Style.green "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"} +#{Style.blue "single_folder_playlist"}: + #{Style.blue "enabled"}: #{Style.green "true"} + #{Style.blue "retain_playlist_order"}: #{Style.green "true"} + #{Style.blue "overwrite_album"}: #{Style.green "false"} #{Style.dim "===="} EOP @@ -86,6 +88,16 @@ module Config puts Style.bold "See https://github.com/cooperhammond/irs for more information on the config file" exit 1 end + spotify = SpotifySearcher.new + spotify.authorize(self.client_key, self.client_secret) + if !spotify.authorized? + puts Style.red("There's something wrong with your client key and/or client secret") + puts "Get your keys from https://developer.spotify.com/dashboard, and enter them in your config file" + puts "Your config file is at #{ENV["IRS_CONFIG_LOCATION"]}" + puts EXAMPLE_CONFIG + puts Style.bold "See https://github.com/cooperhammond/irs for more information on the config file" + exit 1 + end end private def check_conf(key : String) : YAML::Any? diff --git a/src/search/spotify.cr b/src/search/spotify.cr index c1ea10e..33501e1 100755 --- a/src/search/spotify.cr +++ b/src/search/spotify.cr @@ -28,7 +28,10 @@ class SpotifySearcher payload = "grant_type=client_credentials" response = HTTP::Client.post(auth_url, headers: headers, form: payload) - error_check(response) + if response.status_code != 200 + @authorized = false + return self + end access_token = JSON.parse(response.body)["access_token"] From 451ef33cca15a4a416e3d21a6bba1ac2edd086d4 Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Thu, 21 May 2020 16:23:30 -0700 Subject: [PATCH 24/26] feature: unify into album option in config works now --- src/bottle/config.cr | 8 ++++---- src/glue/album.cr | 2 +- src/glue/mapper.cr | 17 +++++++++++++---- src/glue/playlist.cr | 26 ++++++++++++++++++++++++++ src/glue/song.cr | 17 +++++++++++------ 5 files changed, 55 insertions(+), 15 deletions(-) diff --git a/src/bottle/config.cr b/src/bottle/config.cr index ab1c81f..027086f 100755 --- a/src/bottle/config.cr +++ b/src/bottle/config.cr @@ -14,7 +14,7 @@ EXAMPLE_CONFIG = <<-EOP #{Style.blue "single_folder_playlist"}: #{Style.blue "enabled"}: #{Style.green "true"} #{Style.blue "retain_playlist_order"}: #{Style.green "true"} - #{Style.blue "overwrite_album"}: #{Style.green "false"} + #{Style.blue "unify_into_album"}: #{Style.green "false"} #{Style.dim "===="} EOP @@ -28,7 +28,7 @@ module Config "client_secret", "single_folder_playlist: enabled", "single_folder_playlist: retain_playlist_order", - "single_folder_playlist: overwrite_album", + "single_folder_playlist: unify_into_album", ] @@conf = YAML.parse("") @@ -67,8 +67,8 @@ module Config return @@conf["single_folder_playlist"]["retain_playlist_order"].as_bool end - def overwrite_album? : Bool - return @@conf["single_folder_playlist"]["overwrite_album"].as_bool + def unify_into_album? : Bool + return @@conf["single_folder_playlist"]["unify_into_album"].as_bool end def check_necessities diff --git a/src/glue/album.cr b/src/glue/album.cr index 94a140c..1f5e3ee 100755 --- a/src/glue/album.cr +++ b/src/glue/album.cr @@ -33,7 +33,7 @@ class Album < SpotifyList } )) - prepped_data = AlbumTracksMapper.from_json(datum.to_json) + prepped_data = TrackMapper.from_json(datum.to_json) prepped_data.album = album_metadata data = parse_to_json(prepped_data.to_json) diff --git a/src/glue/mapper.cr b/src/glue/mapper.cr index 9a658ad..5083a37 100755 --- a/src/glue/mapper.cr +++ b/src/glue/mapper.cr @@ -24,18 +24,27 @@ class PlaylistTracksMapper ) end -class AlbumTracksMapper +class TrackMapper JSON.mapping( album: { type: JSON::Any, nilable: true, setter: true, }, - artists: JSON::Any, - disc_number: Int32, + artists: { + type: Array(JSON::Any), + setter: true + }, + disc_number: { + type: Int32, + setter: true + }, id: String, name: String, - track_number: Int32, + track_number: { + type: Int32, + setter: true + }, type: String, uri: String ) diff --git a/src/glue/playlist.cr b/src/glue/playlist.cr index cb3ead1..0a8dd68 100755 --- a/src/glue/playlist.cr +++ b/src/glue/playlist.cr @@ -1,9 +1,13 @@ +require "json" + require "../bottle/config" require "./song" require "./list" +require "./mapper" class Playlist < SpotifyList + @song_index = 1 @home_music_directory = Config.music_directory @playlist : JSON::Any? @@ -28,6 +32,28 @@ class Playlist < SpotifyList def organize_song_metadata(list : JSON::Any, datum : JSON::Any) : JSON::Any data = datum + if Config.retain_playlist_order? + track = TrackMapper.from_json(data.to_json) + track.track_number = @song_index + track.disc_number = 1 + data = JSON.parse(track.to_json) + end + + if Config.unify_into_album? + track = TrackMapper.from_json(data.to_json) + track.album = JSON.parse(%({ + "name": "#{list["name"]}", + "images": [{"url": "#{list["images"][0]["url"]}"}] + })) + track.artists.push(JSON.parse(%({ + "name": "#{list["owner"]["display_name"]}", + "owner": true + }))) + data = JSON.parse(track.to_json) + end + + @song_index += 1 + return data end diff --git a/src/glue/song.cr b/src/glue/song.cr index 9d7ea06..964e370 100755 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -40,8 +40,8 @@ class Song }) if !@metadata - raise("There was no metadata found on Spotify for\n" + - %("#{@song_name}" by "#{@artist_name}\n) + + raise("There was no metadata found on Spotify for " + + %("#{@song_name}" by "#{@artist_name}". ) + "Check your input and try again.") end end @@ -54,8 +54,8 @@ class Song url = Youtube.find_url(@song_name, @artist_name, search_terms: "lyrics") if !url - raise("There was no url found on youtube for\n" + - %("#{@song_name}" by "#{@artist_name}\n) + + raise("There was no url found on youtube for " + + %("#{@song_name}" by "#{@artist_name}. ) + "Check your input and try again.") end @@ -67,7 +67,12 @@ class Song File.write(temp_albumart_filename, response.body_io) end - @artist = data["artists"][0]["name"].to_s + # check if song's metadata has been modded in playlist, update artist accordingly + if data["artists"][-1]["owner"]? + @artist = data["artists"][-1]["name"].to_s + else + @artist = data["artists"][0]["name"].to_s + end @album = data["album"]["name"].to_s tagger = Tags.new(@filename) @@ -75,7 +80,7 @@ class Song tagger.add_text_tag("title", data["name"].to_s) tagger.add_text_tag("artist", @artist) tagger.add_text_tag("album", @album) - tagger.add_text_tag("genre", + tagger.add_text_tag("genre", @spotify_searcher.find_genre(data["artists"][0]["id"].to_s)) tagger.add_text_tag("track", data["track_number"].to_s) tagger.add_text_tag("disc", data["disc_number"].to_s) From 5f8acac053cac13ae4928e6ae7596b0fdb24ecba Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Thu, 21 May 2020 19:23:44 -0700 Subject: [PATCH 25/26] feature: CLI download messages have been updated to be prettier --- src/bottle/styles.cr | 10 ++++---- src/glue/list.cr | 18 ++++++++++++++ src/glue/song.cr | 56 ++++++++++++++++++++++++++++++++++++------ src/interact/ripper.cr | 5 ++-- 4 files changed, 75 insertions(+), 14 deletions(-) diff --git a/src/bottle/styles.cr b/src/bottle/styles.cr index a79928d..f965378 100755 --- a/src/bottle/styles.cr +++ b/src/bottle/styles.cr @@ -2,22 +2,22 @@ require "colorize" class Style def self.bold(txt) - txt.colorize.mode(:bold) + txt.colorize.mode(:bold).to_s end def self.dim(txt) - txt.colorize.mode(:dim) + txt.colorize.mode(:dim).to_s end def self.blue(txt) - txt.colorize(:light_blue) + txt.colorize(:light_blue).to_s end def self.green(txt) - txt.colorize(:light_green) + txt.colorize(:light_green).to_s end def self.red(txt) - txt.colorize(:light_red) + txt.colorize(:light_red).to_s end end diff --git a/src/glue/list.cr b/src/glue/list.cr index 7a233f5..4d4d583 100755 --- a/src/glue/list.cr +++ b/src/glue/list.cr @@ -13,6 +13,13 @@ abstract class SpotifyList @spotify_searcher = SpotifySearcher.new @file_names = [] of String + @outputs : Hash(String, Array(String)) = { + "searching" => [ + Style.bold("Searching for %l by %a ... \r"), + Style.green("+ ") + Style.bold("%l by %a \n") + ] + } + def initialize(@list_name : String, @list_author : String?) end @@ -22,7 +29,9 @@ abstract class SpotifyList raise("Need to call provide_client_keys on Album or Playlist class.") end + outputter("searching", 0) list = find_it() + outputter("searching", 1) contents = list["tracks"]["items"].as_a i = 0 @@ -36,6 +45,8 @@ abstract class SpotifyList song = Song.new(data["name"].to_s, data["artists"][0]["name"].to_s) song.provide_spotify(@spotify_searcher) song.provide_metadata(data) + + puts Style.bold("[#{data["track_number"]}/#{contents.size}]") song.grab_it organize(song) @@ -49,6 +60,13 @@ abstract class SpotifyList @spotify_searcher.authorize(client_key, client_secret) end + private def outputter(key : String, index : Int32) + text = @outputs[key][index] + .gsub("%l", @list_name) + .gsub("%a", @list_author) + print text + end + # Defined in subclasses, will return the appropriate information or call an # error if the info is not found and exit abstract def find_it : JSON::Any diff --git a/src/glue/song.cr b/src/glue/song.cr index 964e370..e512ba9 100755 --- a/src/glue/song.cr +++ b/src/glue/song.cr @@ -4,6 +4,8 @@ require "../search/youtube" require "../interact/ripper" require "../interact/tagger" +require "../bottle/styles" + class Song @spotify_searcher = SpotifySearcher.new @client_id = "" @@ -14,6 +16,33 @@ class Song @artist = "" @album = "" + @outputs : Hash(String, Array(String)) = { + "intro" => [Style.bold("[%s by %a]\n")], + "metadata" => [ + " Searching for metadata ...\r", + Style.green(" + ") + Style.dim("Metadata found \n") + ], + "url" => [ + " Searching for URL ...\r", + Style.green(" + ") + Style.dim("URL found \n") + ], + "download" => [ + " Downloading video:\n", + Style.green("\r + ") + Style.dim("Converted to mp3 \n") + ], + "albumart" => [ + " Downloading album art ...\r", + Style.green(" + ") + Style.dim("Album art downloaded \n") + ], + "tagging" => [ + " Attaching metadata ...\r", + Style.green(" + ") + Style.dim("Metadata attached \n") + ], + "finished" => [ + Style.green(" + ") + "Finished!\n" + ] + } + def initialize(@song_name : String, @artist_name : String) end @@ -23,6 +52,8 @@ class Song # Song.new("Bohemian Rhapsody", "Queen").grab_it # ``` def grab_it + outputter("intro", 0) + if !@spotify_searcher.authorized? && !@metadata if @client_id != "" && @client_secret != "" @spotify_searcher.authorize(@client_id, @client_secret) @@ -33,7 +64,7 @@ class Song end if !@metadata - puts "Searching for metadata ..." + outputter("metadata", 0) @metadata = @spotify_searcher.find_item("track", { "name" => @song_name, "artist" => @artist_name, @@ -44,28 +75,31 @@ class Song %("#{@song_name}" by "#{@artist_name}". ) + "Check your input and try again.") end + outputter("metadata", 1) end data = @metadata.as(JSON::Any) @filename = data["track_number"].to_s + " - #{data["name"].to_s}.mp3" - puts "Searching for url ..." - # TODO: should this search_term be here? + outputter("url", 0) url = Youtube.find_url(@song_name, @artist_name, search_terms: "lyrics") - if !url raise("There was no url found on youtube for " + %("#{@song_name}" by "#{@artist_name}. ) + "Check your input and try again.") end + outputter("url", 1) - puts "Downloading video:" + outputter("download", 0) Ripper.download_mp3(url.as(String), @filename) + outputter("download", 1) + outputter("albumart", 0) temp_albumart_filename = ".tempalbumart.jpg" HTTP::Client.get(data["album"]["images"][0]["url"].to_s) do |response| File.write(temp_albumart_filename, response.body_io) end + outputter("albumart", 0) # check if song's metadata has been modded in playlist, update artist accordingly if data["artists"][-1]["owner"]? @@ -85,11 +119,12 @@ class Song tagger.add_text_tag("track", data["track_number"].to_s) tagger.add_text_tag("disc", data["disc_number"].to_s) - puts "Tagging metadata ..." + outputter("tagging", 0) tagger.save File.delete(temp_albumart_filename) + outputter("tagging", 1) - puts %("#{data["name"].to_s}" by "#{data["artists"][0]["name"].to_s}" downloaded.) + outputter("finished", 0) end # Will organize the song into the user's provided music directory as @@ -150,4 +185,11 @@ class Song @client_secret = client_secret return self end + + private def outputter(key : String, index : Int32) + text = @outputs[key][index] + .gsub("%s", @song_name) + .gsub("%a", @artist_name) + print text + end end diff --git a/src/interact/ripper.cr b/src/interact/ripper.cr index 35e84e0..5a5aa38 100755 --- a/src/interact/ripper.cr +++ b/src/interact/ripper.cr @@ -1,5 +1,6 @@ require "./logger" require "../bottle/config" +require "../bottle/styles" module Ripper extend self @@ -54,11 +55,11 @@ module Ripper print "\e[1A" print "\e[0K\r" end - puts line.sub("[download]", " ") + puts line.sub("[download]", " ") @dl_status_index += 1 if line.includes? "100%" - puts "Converting to mp3 ..." + print " Converting to mp3 ..." end end end From dd23fb552744e1c334ebcf76c8c5c1d2460065bf Mon Sep 17 00:00:00 2001 From: Cooper Hammond <kepoorh@gmail.com> Date: Thu, 21 May 2020 19:27:39 -0700 Subject: [PATCH 26/26] README updata, it's pretty AND useful now --- .gitignore | 1 + README.md | 161 ++++++++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 135 insertions(+), 27 deletions(-) diff --git a/.gitignore b/.gitignore index f22fb15..463117c 100755 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ *.dwarf *.mp3 +*.webm* .ripper.log ffmpeg ffprobe diff --git a/README.md b/README.md index f292c96..8945327 100755 --- a/README.md +++ b/README.md @@ -1,16 +1,93 @@ -# `irs` -###### AKA `Ironic Repositioning System` +# irs: The Ironic Repositioning System [![made-with-crystal](https://img.shields.io/badge/Made%20with-Crystal-1f425f.svg?style=flat-square)](https://crystal-lang.org/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)](https://github.com/cooperhammond/irs/blob/master/LICENSE) -[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg?style=flat-square)](https://saythanks.io/to/kepoorhampond) +[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg?style=flat-square)](https://saythanks.io/to/kepoorh%40gmail.com) > A music scraper that understands your metadata needs. +`irs` is a command-line application that downloads audio and metadata in order +to package an mp3 with both. Extensible, the user can download individual +songs, entire albums, or playlists from Spotify. + +<p align="center"> + <img src="https://i.imgur.com/7QTM6rD.png" height="400" title="#1F816D" /> +</p> +<p align="center" + +[![forthebadge](https://forthebadge.com/images/badges/compatibility-betamax.svg)](https://forthebadge.com) +[![forthebadge](https://forthebadge.com/images/badges/ages-18.svg)](https://forthebadge.com) +[![forthebadge](https://forthebadge.com/images/badges/built-by-codebabes.svg)](https://forthebadge.com) +</p> + +--- + +## Table of Contents + +- [Usage](#usage) + - [Demo](#demo) +- [Installation](#installation) + - [Pre-built](#pre-built) + - [From source](#from-source) + - [Set up](#setup) +- [Config](#config) +- [How it works](#how-it-works) +- [Contributing](#contributing) + + +## Usage + +``` +~ $ irs -h + +Usage: irs [--help] [--version] [--install] + [-s <song> -a <artist>] + [-A <album> -a <artist>] + [-p <playlist> -a <username>] + +Arguments: + -h, --help Show this help message and exit + -v, --version Show the program version and exit + -i, --install Download binaries to config location + -c, --config Show config file location + -a, --artist <artist> Specify artist name for downloading + -s, --song <song> Specify song name to download + -A, --album <album> Specify the album name to download + -p, --playlist <playlist> Specify the playlist name to download + +Examples: + $ irs --song "Bohemian Rhapsody" --artist "Queen" + # => downloads the song "Bohemian Rhapsody" by "Queen" + $ irs --album "Demon Days" --artist "Gorillaz" + # => downloads the album "Demon Days" by "Gorillaz" + $ irs --playlist "a different drummer" --artist "prakkillian" + # => downloads the playlist "a different drummer" by the user prakkillian +``` + +### Demo + +[![asciicast](https://asciinema.org/a/332793.svg)](https://asciinema.org/a/332793) + ## Installation -1. Download the latest release for your platform [here](https://github.com/cooperhammond/irs/releases) -1. Create a `.yaml` config file somewhere on your system +### Pre-built + +Just download the latest release for your platform +[here](https://github.com/cooperhammond/irs/releases). + +### From Source + +If you're one of those cool people who compiles from source + +1. Install crystal-lang + ([`https://crystal-lang.org/install/`](https://crystal-lang.org/install/)) +1. Clone it (`git clone https://github.com/cooperhammond/irs`) +1. CD it (`cd irs`) +1. Build it (`shards build`) + +### Setup + +1. Create a `.yaml` config file somewhere on your system (usually `~/.irs/`) 1. Copy the following into it ```yaml binary_directory: ~/.irs/bin @@ -20,7 +97,7 @@ single_folder_playlist: enabled: true retain_playlist_order: true - overwrite_album: false + unify_into_album: false ``` 1. Set the environment variable `IRS_CONFIG_LOCATION` pointing to that file 1. Go to [`https://developer.spotify.com/dashboard/`](https://developer.spotify.com/dashboard/) @@ -28,40 +105,70 @@ 1. Click `CREATE A CLIENT ID` 1. Enter all necessary info, true or false, continue 1. Find your client key and client secret -2. Copy them into where all the X's are in your config file from above +1. Copy each respectively into the X's in your config file +1. Run `irs --install` and answer the prompts! -You should be good to go! Run the file from your command line to get help on usage or keep reading! +You should be good to go! Run the file from your command line to get more help on +usage or keep reading! -##### Optionally From Source +# Config -Or if you're one of those cool people who compiles from source - -1. Install crystal-lang ([`https://crystal-lang.org/install/`](https://crystal-lang.org/install/)) -1. Clone it (`git clone https://github.com/cooperhammond/irs`) -1. CD it (`cd irs`) -1. Build it (`shards build`) - -## Usage - -<p align="center"> - <img src="https://i.imgur.com/uYKh101.png" height="600" /> -</p> +You may have noticed that there's a config file with more than a few options. +Here's what they do: +```yaml +binary_directory: ~/.irs/bin +music_directory: ~/Music +client_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +client_secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX +single_folder_playlist: + enabled: true + retain_playlist_order: true + unify_into_album: false +``` + - `binary_directory`: a path specifying where the downloaded binaries should + be placed + - `music_directory`: a path specifying where downloaded mp3s should be placed. + Note that there will be more structure created inside that folder, usually + in the format of `music-dir>artist-name>album-name>track` + - `client_key`: a client key from your spotify API application + - `client_secret`: a client secret key from your spotify API application + - `single_folder_playlist/enabled`: if set to true, all mp3s from a downloaded + playlist will be placed in the same folder. + - `single_folder_playlist/retain_playlist_order`: if set to true, the track + numbers of the mp3s of the playlist will be overwritten to correspond to + their place in the playlist + - `single_folder_playlist/unify_into_album`: if set to true, will overwrite + the album name and album image of the mp3 with the title of your playlist + and the image for your playlist respectively ## How it works -**At it's core** `irs` downloads individual songs. It does this by interfacing with the Spotify API, grabbing metadata, and then searching Youtube for a video containing the song's audio. It will download the video using [`youtube-dl`](https://github.com/ytdl-org/youtube-dl), extract the audio using [`ffmpeg`](https://ffmpeg.org/), and then pack the audio and metadata together into an MP3. +**At it's core** `irs` downloads individual songs. It does this by interfacing +with the Spotify API, grabbing metadata, and then searching Youtube for a video +containing the song's audio. It will download the video using +[`youtube-dl`](https://github.com/ytdl-org/youtube-dl), extract the audio using +[`ffmpeg`](https://ffmpeg.org/), and then pack the audio and metadata together +into an MP3. -From the core, it has been extended to download the index of albums and playlists through the spotify API, and then iteratively use the method above for downloading each song. +From the core, it has been extended to download the index of albums and +playlists through the spotify API, and then iteratively use the method above +for downloading each song. -It used to be in `python`, but +It used to be in python, but 1. I wasn't a fan of python's limited ability to distribute standalone binaries -1. It was a clusterfuck of code that I made when I was little and I wanted to refine it -2. `crystal-lang` made some promises and I was interested in seeing how well it did (verdict: if you're building high-level tools you want to run quickly and distribute, it's a joy to work in) +1. It was a charlie foxtrot of code that I made when I was little and I wanted + to refine it +1. `crystal-lang` made some promises and I was interested in seeing how well it + did (verdict: if you're building high-level tools you want to run quickly + and distribute, it's perfect) ## Contributing -Any and all contributions are welcome. If you think of a cool feature, send a PR or shoot me an [email](mailto:kepoorh@gmail.com). If you think something could be implemented better, _please_ shoot me an email. If you like what I'm doing here, _pretty please_ shoot me an email. +Any and all contributions are welcome. If you think of a cool feature, send a +PR or shoot me an [email](mailto:kepoorh@gmail.com). If you think something +could be implemented better, _please_ shoot me an email. If you like what I'm +doing here, _pretty please_ shoot me an email. 1. Fork it (<https://github.com/your-github-user/irs/fork>) 2. Create your feature branch (`git checkout -b my-new-feature`)