cinchrb / cinch-identify

Identify plugin

This plugin allows Cinch to automatically identify with services. Currently, DALnet, QuakeNet, KreyNet and all networks using NickServ are supported.

For QuakeNet, both the normal auth and the more secure challengeauth commands are supported.

Installation

First install the gem by running: [sudo] gem install cinch-identify

Then load it in your bot:

require "cinch"
require "cinch/plugins/identify"

bot = Cinch::Bot.new do
  configure do |c|
    # add all required options here
    c.plugins.plugins = [Cinch::Plugins::Identify] # optionally add more plugins
    c.plugins.options[Cinch::Plugins::Identify] = {
      :username => "my_username",
      :password => "my secret password",
      :type     => :nickserv,
    }
  end
end

bot.start

Commands

None.

Options

:type

The type of authentication. :nickserv for NickServ, :userserv for UserServ, :dalnet for DALnet, :quakenet for the insecure auth command on QuakeNet and :secure_quakenet or :challengeauth for the more secure challengeauth. :kreynet for KreyNet.

:username

The username to use for authentication. Do not set this when using NickServ on a network that only supports identifying as the current nick (e.g. dancer-ircd.)

:password

The password to use for authentication

:service_name

The nick name of the service to send the identification message to. This option is currently only being used for :userserv and defaults to "UserServ".

Example configuration

Check the install instructions for an example configuration.

Warning

Be warned that, when using the :nickserv, :dalnet, :userserv, :quakenet or :kreynet types, the password will show up in the logs.

cinch-identify's Issues

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Doesn't identify at freenode

I simply have no way to make it identify at irc.freenode.net, seems like the identify action is not triggered

:identified event

Cinch documentation says (http://rubydoc.info/github/cinchrb/cinch/file/docs/bot_options.md#delayjoins) that :identified event will happen upon successful authentication. Is it true? I tried and it didn't work.

:identified event doesn't occur on rizon

Event doesn't occur on rizon, since nickserv returns a different string than expected by current code. The following code will resolve the issue

      # fix for Rizon
      match(/^Password accepted - you are now recognized./, use_prefix: false, use_suffix: false, react_on: :private, method: :identified_nickserv_rizon)
      def identified_nickserv_rizon(m)
        if m.user == User("nickserv") && config[:type] == :nickserv
          debug "Identified with NickServ"
          @bot.handlers.dispatch :identified, m
        end
      end

full source located https://github.com/mladoux/cinch-identify/blob/master/lib/cinch/plugins/identify.rb

Nickserv - Password Incorrect

@dominikh

I'm probably missing something basic, but I can't get :nickserv authentication to work. I see in my logs the following:

PRIVMSG nickserv :identify berbot <password>

I've tested it manually (made myself the bot's nick, registered it, and then tried to authenticate as it) and I know the password in the log is the correct one. However, I get this message:

:NickServ!NickServ@services. NOTICE berbot :Password Incorrect

Any ideas?