Centralizing configuration and genericizing showbot + random cleanup

[rikai]

I'm thinking of taking this bit of restructuring upon myself sometime here soon to make my life easier. Figured i'd post here first to get some thoughts on the matter.

Brief Explanation:

Basically, Now that .env is in use by ShowBot, i think that most of the stuff showbot uses can be moved into either cinchize.yml or .env (or possibly another non-cinchize.yml config like config.yml if preferred), to help make showbot more generically usable without having to comb the code to make manual edits, and instead only have to modify a few files in the base directory, namely cinchize.yml, .env and/or config.yml. In that spirit, what follows is what i have in mind.

Things that wont be touched

• fivebyfun.rb - since it's completely devoted to 5by5 and would need signifigant editing to be repurposed for someone else anyway.

  Mostly moving things to config variables ala cinch-identify rather than having them hardcoded into files

• Move from admin.rb to cinchize.yml
  • SHOWBOT_ADMIN_PASSWORD
• Add to schedule.rb and pull from cinchize.yml
  • ICAL_URL
• Move from shoutcast.rb to cinchize.yml
  • SHOUTCAST_URI
• Move from twitter.rb to cinchize.yml
  • CHANNEL
  • TWITTER_USER
• Move from .env to cinchize.yml
  • TWITTER_CONSUMER_KEY
  • TWITTER_CONSUMER_SECRET
  • TWITTER_OAUTH_TOKEN
  • TWITTER_OAUTH_TOKEN_SECRET

    New additions to cinchize:

• Add BOT_NICK to cinchize.yml for universal use
  • suggestion.rb#L19
  • admin.rb#L27
  • admin.rb#L39
  • admin.rb#L43
  • showbot.rb#L28
  • showbot.rb#L44
• Add BACKUP_BOT_NICK to cinchize.yml for universal use
  • admin.rb#L39
• Add SITE_URL to cinchize.yml for URL references
  • links.rb#L56
  • shoutcast.rb#L38
  • shoutcast.rb#L42

    Additions to .env - to remove the need for more file digging

• Enviroment.rb to .env
  • LIVE_URL
  • SHOWBOT_DATABASE_URL
• backup.rb to .env - Mix of existing and added
  • SHOWBOT_DATABASE_NAME
  • SHOWBOT_DATABASE_USER
  • SHOWBOT_DATABASE_PASSWORD
  • DB_HOST
  • DB_PORT
  • DB_ADDITIONAL_PROPERTIES
  • S3_ACCESS_KEY_ID
  • S3_SECRET_ACCESS_KEY
  • S3_REIGON
  • S3_BUCKET
  • S3_PATH
  • S3_KEEP

Note: Could be added to cinchize.yml instead and loaded manually instead perhaps, to keep things in one place?

Misc/Undecided

• Change freenode_live and freenode_test to network_live and network_test, as well as the same plus freenode_base in chinchize.yml.
• Not sure what to do with Some other showbot/5by5 corner-case references that i' dont know how to handle since they're single-use

  Other things to consider

• I ignored the reference to Showbot here because that provides information pertinent to the origin and source of the bot, and can be modified to give additional info on the availability of author modifications if so desired.
• Moving showbot.rb to commands.rb to better reflect its contents in a more generic way?
• Also perhaps moving the port number for sinatra out of procfile.local?
• I favored the use of .env/config.yml over cinchize.yml for plugins in some cases to be able to only have to define some things once, such as commonly referenced URLs and references to the bot name, especially since some of these are also used outside of the scope of plugins.

  Things i don't have much experience with but had thoughts on

• I haven't looked into /public/ and /views/ much, as I dont know much about haml, but if possible, abstract out references to the bot name, 5by5 chat and 5by5 urls to variables to make rebranding for another use or url updates in general even for 5by5 simple. Can the variables from a .env or config.yml be used inside haml easily?

  Random cleanup i also ran across

• Is hypercritical.json missing from the repo? I see a direct reference to it here, but it's not in the repo. What is this for?
• The javascript here seems to be tracking specific to the 5by5 version of showbot, is this intentionally in the public code? Won't that skew analytics results?
• Lastly, is broadcasting to channel in twitter.rb broken? At least in development mode, it doesn't seem to be working at all, though it does respond correctly to last_status.

[rikai]

Updated the post now that i've learned a little bit about sharing settings between plugins.

[rikai]

Did the vast majority of the changes in the merge request listed above, what follows are the things that still remain from the list:

Things left:

• suggestion.rb#L19 - honestly not sure how to handle this, it seems a shame to make an enviroment variable for a single reference, will have to think on it unless you've got any suggestions.
• Also perhaps moving the port number for sinatra out of procfile.local?

Things i don't have much experience with but had thoughts on

The MR does not cover any of this at all, i didn't touch the web interface as i haven't looked into how to do in-place substitution or if its even easily possible:

• I haven't looked into /public/ and /views/ much, as I dont know much about haml, but if possible, abstract out references to the bot name, 5by5 chat and 5by5 urls to variables to make rebranding for another use or url updates in general even for 5by5 simple. Can the variables from a .env or config.yml be used inside haml easily?

Random cleanup i also ran across

I seem to have fixed the twitter announcing as a side effect of my changes, somehow. Also of these questions still need answers:

• Is hypercritical.json missing from the repo? I see a direct reference to it here, but it's not in the repo. What is this for?
• The javascript here seems to be tracking specific to the 5by5 version of showbot, is this intentionally in the public code? Won't that skew analytics results?

[mutewinter]

suggestion.rb#L19 - honestly not sure how to handle this, it seems a shame to make an enviroment variable for a single reference, will have to think on it unless you've got any suggestions.

If there were more than one thing like this, I'd say we centralize it all using a en.yml file and I18n.

Also perhaps moving the port number for sinatra out of procfile.local?

Agreed. The port number should not be hardcoded.

Is hypercritical.json missing from the repo? I see a direct reference to it here, but it's not in the repo. What is this for?

Yes. It must have been test data that I use using a long time ago. Ah the days when I used to junk of repositories with dead code :).

The javascript here seems to be tracking specific to the 5by5 version of showbot, is this intentionally in the public code? Won't that skew analytics results?

Yea, that should be moved into a config or partial that I don't commit. It won't skew data because the analytics tools I'm using should only allow specific domains.

I haven't looked into /public/ and /views/ much, as I dont know much about haml, but if possible, abstract out references to the bot name, 5by5 chat and 5by5 urls to variables to make rebranding for another use or url updates in general even for 5by5 simple. Can the variables from a .env or config.yml be used inside haml easily?

Yes, I'd consider the same approach as fixing the code for suggestion.rb#L19.

[rikai]

Alright, that simplifies things quite a bit. I got i18n and an en.yml going. Even if it's only for a single reference atm, it gives us a place to easily expand things later.

I'm glad you don't mind all this reworking, i know it'll probably be a pain to sort through. ;)

[rikai]

Working on adding i18n to the haml... Having some issues though. I cant get it to parse inline ruby that it passes to the haml renderer. Not sure how to solve that.

[rikai]

Right then. I18n complete, unless there are things i missed of course, but the vast majority is done anyway, so this and #55 should be all good now.

I'll leave taking care of the dead hypercritical code and moving your analytics code to you. I've completed everything else i've set out to do in this issue, i believe.

[rikai]

Done.