You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Blaine Motsinger 933639431c added new catalog 8 hours ago
.gitignore added scratch to gitignore 9 months ago
LICENSE.txt added license and readme 3 years ago
README.md updated 3 years ago
catalog.bash Update mirror link 4 months ago
catalog.txt added new catalog 8 hours ago
on_deck_tweets added 2 years ago
quote.pl added download limit threshhold 2 years ago

README.md

daily_book

get quotes from free ebooks for your friends.

description

quote.pl finds quotes in free ebooks at project gutenberg then tweets them.

setup

to run quote.pl, you’ll first need to install a few perl modules.

I personally like local::lib and cpanminus. quote.pl is wired to use local::lib so it doesn’t require root installation of the modules.

to build the modules with cpanminus you’ll need the following system packages installed

# apt-get install make gcc

you’ll also need to install libssl-dev for Twitter.

# apt-get install libssl-dev

then, through cpanm (running as your unpriv’d user, if local::lib)

$ cpanm LWP::Simple
$ cpanm Net::Twitter::Lite::WithAPIv1_1
$ cpanm Net::OAuth

quote.pl has optional functonality to post to twitter you’ll need to create oauth credentials for quote.pl if you want to post. you can do so at https://apps.twitter.com

quote.pl will look for the credentials in a file named .quote.rc, inside the pwd

# quote.pl twitter oauth settings
account:_daily_book
consumer_key:QWERTY1234
consumer_secret:FEEDBEEF
access_token:12345-SOMETHING
access_token_secret:anotherlongstringnotreallyanaccesstoken

warning: ^ not really oauth credentials ^

usage

$ perl quote.pl -h
usage: ./quote.pl -s -t

options:
	-t|--twitter		post the quote to twitter

	-s|--silent		    dont display any output (requires -t)

	-m|--manual 1234	manually specify the book number

	-h|--help		    displays this dialogue

quote.pl can be run without any options. it’ll simply go out and get a quote, then show it to you.

$ perl quote.pl
quote.pl

finding a quote, just a moment
for more information, please see quote.log

title: Girl Scouts at Dandelion Camp 
author: Lillian Elizabeth Roy 

"Scouts, don't give up," called Mrs. Vernon, laughingly. "Betty is doing fine, so you must not stop such treatment." gutenberg.org/ebooks/37800

you can also manually specify an ebook number from gutenberg’s catalog. quote.pl will tell you if it couldn’t find a book with that number.

if you want to run the script via cron, there is also a silent mode, which won’t output anything but the log file.

quote.log contains issues found during the run, as well as why it skips over a book.

$ cat quote.log 
[05052016.103329] [info] no quote found - 7718.txt
[05052016.104014] [info] no quote found - 36304.txt
[05052016.104027] [info] posting to twitter
[05052016.104048] [info] ebook isn't in English - 12637.txt
[05052016.104048] [info] posting to twitter
[05052016.104219] [info] posting to twitter
[05052016.205719] [fatal] cannot open index: Permission denied
[05052016.210324] [info] no quote found - 29493.txt
[05052016.210324] [info] posting to twitter

the catalog

quote.pl utilizes an index of book numbers to download from the mirror. This repo contains an older version, but also contains a script to create a new up-to-date index.

catalog.bash checks the timestamp of the archive of rdf files (the catalog of all books) on gutenberg’s mirror, compares it to the local index, and if need, downloads, extracts, and creates a new index file of the book numbers. catalog.bash then removes the old index and cleans up after itself.

the script can be run manually, in this case, showing the local index is newer than the archive on the mirror. it then exits without download anything new.

$ bash catalog.bash 
checking timestamp on server - done
checking timestamp on stored catalog - done
comparing timestamps - up to date

catalog.bash sees it needs to get the new catalog, then proceeds to go through with its work.

$ bash catalog.bash 
checking timestamp on server - done
checking timestamp on stored catalog - done
comparing timestamps - done
downloading new archive - done
unpacking the archive - done
untar'ing - done
removing tar - done
building the catalog - done
renaming new and removing the old catalog - done
removing the old cache - done
all done

the original intention of the catalog.bash script (as well as quote.pl) was to run through cron. this can be done with a simple crontab entry.

$ crontab -l
0 3 * * * cd /home/blaine/dev/projects/daily_book/; bash catalog.bash
30 12 * * * cd /home/blaine/dev/projects/daily_book/; perl quote.pl -t

see it in action

All parts working together can be seen at https://twitter.com/_daily_book. Feel free to follow for some quality free ebook quotes, delivered right to your Twitter feed :)

unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

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 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.

For more information, please refer to http://unlicense.org