Should add documentation for App, Service, and Server

[mwiley]

I'm not using this gem quite how it's described in the readme.

I have a React app that starts the OAuth flow with Slack, and then sends the code to its backend, a Rails app. I'm creating or finding a User and returning a JWT for the React app for the user to sign in, but I also want to ensure a bot is created if it doesn't exist for their Team. The Rails app exchanges the code with the OAuth2 gem. From there, I just copied what happens in the create teams API endpoint into my own code, and I create the Team and start an instance of the bot manually.

I'm not using the included API at all. I'm just using this gem to abstract running a slack-bot-ruby instance for each Slack Team that uses the app. I would already need a Team model for how the app works so it's just adding a Slack bot on top of it.

It would be helpful to have most methods documented so it's easier to integrate this gem into existing projects.

[dblock]

I think that what you want is just slack-ruby-bot, this gem is one kind of opinionated server that includes all the parts. Does that make sense?

Maybe one question to you: what are you using from this gem specifically that is not in https://github.com/slack-ruby/slack-ruby-bot?

[mwiley]

slack-ruby-bot isn't enough for what I want, but part of this library is. Slack-ruby-bot just runs once instance of the bot, and I'd have to write code myself to manage starting an instance for each Team. I'm just using the part of this library that runs multiple bot instances in a new thread. All I have to do this way is create a new Team and call a single method to get the bot instance running.

I want to do it this way, start the bot with my own code and not the provided endpoint, because the user is also signing into the app, and I don't want to make them go through another OAuth flow to add the bot just to use this gem. I'm just not using the provided endpoints or web page, but using the rest.

It seems this issue sort of addresses what I'm talking about: #12. I'd be willing to help document things but I'm not sure if I should, if there are plans to break this up anyway.

[dblock]

There're no plans to break this up, unless you want to try and extract some code from here and into slack-ruby-bot or another gem.

[dblock]

I'll close this.