hibot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da04f8159bb4a38fcec07a4b097f3686b07a79ad
+  data.tar.gz: ce6402a54c877a8eeeacd580b37cdd033123b246
+SHA512:
+  metadata.gz: 35d390f87724f6090b3924ad00d99180f4143abe9089623b95a23ed0473c3eeded19ae400ca4a9b3573a02aff250793d0018d97df0b350f6da6919a2a5f621c1
+  data.tar.gz: 5375e81f645cfb8f2e3330c2007e7f59f6d52e8e8e6983c35e59c94c49a20a7d1095c3476069f949169f732813d615089645d35b948a6af313b7397c76c2692e

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+/Gemfile.lock
+/coverage
+/vendor/bundle
+/spec/hibotrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--order random
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rspec", "~> 3.1"  
+  gem 'simplecov', :require => false
+end

data/README.md

@@ -0,0 +1,51 @@
+#Hibot
+
+## Presentation
+
+Hibot is a bot written in Ruby and based on the excellent [cinch gem](https://github.com/cinchrb/cinch). The gem is developped using the plugins principle. You can just load the needed plugins and so you don't have to configure and to enable all plugins.
+
+## Installation
+
+Install the gem through rubygems. Use the basic command `gem install hibot`. Then you have to create a hibotrc yaml file that respects the following syntax :
+
+```yaml
+---
+:general:
+  :server: your.server.irc
+  :channels:
+  - '#channel1'
+  - '#channel2'
+  - ...
+  :nick: your-bot-nick
+  :plugins.plugins:
+  - Hibot::Spotify
+  - ... # see the plugin list below to see which plugins are available
+```
+
+**NOTE : ** The default hibotrc location is in your $HOME directory. So if you don't want to override the default behavior, just create a hidden .hibotrc file in your $HOME.
+
+Then, just run the hibot binary to launch the bot. If you changed to default hibotrc location, you can use the -c or --config flag to specify where is your config file.
+
+## Plugins
+
+At the moment, the following plugins are available :
+
+To use a plugin, first you have to add it to the hibotrc file. Then configure the plugin if some extra configuration is needed. Here is the plugin list and the instructions per plugin :
+
+1. Hibot::Spotify : allows you to parse Spotify uri when pasted in a channel or to search through Spotify's API some data.
+
+To use this plugin, you have to create a spotify application. You can do it from [here](https://developer.spotify.com/my-applications). When it's done, copy you client ID and client Secret to the hibotrc file with that structure : 
+
+```yaml
+---
+# here comes the general configuration
+:Hibot::Spotify:
+  :client_id: your_client_id
+  :client_secret: your_client_secret
+```
+
+## Contribute
+1. Fork it
+2. Dev it
+3. Pull request it
+4. Enjoy it

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/hibot

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require 'hibot'
+
+
+opts = {
+  path: File.join(File.expand_path('~'), '.hibotrc')
+}
+
+OptionParser.new do |o|
+  o.banner = "USAGE: #{$0} [options]"
+
+  o.on("-c", "--config [CONFIG PATH]", "Set the location of the .hibotrc file") do |p|
+    opts[:path] = p
+  end
+end.parse!
+
+Hibot.launch(opts)

data/hibot.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = 'hibot'
+  s.version     = '0.0.1'
+  s.date        = '2015-04-16'
+  s.summary     = "IRC bot supporting multiple services."
+  s.description = "IRC bot supporting multiple services like spotify, giphy and so on."
+  s.authors     = ["Nicolas Collard"]
+  s.email       = 'niko@hito.be'
+  s.files       = ["lib/hibot.rb"]
+  s.homepage    = 'https://github.com/Hito01/Hibot'
+  s.license     = 'MIT'
+
+  s.add_dependency "cinch", "~> 2.2"
+  s.add_dependency "httparty", "~> 0.13"
+  s.add_dependency "rainbow", "~> 2.0"
+
+  s.add_development_dependency "bundler", "~> 1.9"
+  s.add_development_dependency "rake", "~> 10.4"
+
+  s.files      = `git ls-files`.split($\)
+  s.test_files = s.files.grep(/^spec/)
+
+  s.executables << "hibot"
+end

data/lib/api/spotify.rb

@@ -0,0 +1,45 @@
+module API
+  module Spotify
+    WS_URL = "https://api.spotify.com/v1"
+    PERMITTED_TYPES = %w{album artist track}
+    URI_REGEX = /spotify:([a-z]+):(\w+)/
+
+    def search(query)
+      # Check that parameters are correct or return the corresponding error
+      type, q = query.split(' ')
+      return "Invalid search request. You have to provide a valid type (artist, album or track) and then your query" if type.nil? || q.nil?
+      return "Bad request. Allowed types are album, artist and track." unless PERMITTED_TYPES.include?(type)
+
+      # Perform the search and return the result
+      result = ""
+      response = HTTParty.get("#{WS_URL}/search?type=#{type}&q=#{URI.encode(q)}")
+      if response["#{type}s"] && response["#{type}s"]['items'].count > 0
+        i = 1
+        response["#{type}s"]['items'].each do |item|
+          result += "#{i}. #{item['name']} --> #{item['uri']} --> #{item['external_urls']['spotify']}\n"
+          i += 1
+          break if i == 5
+        end
+      else
+        result = "Nothing found with that parameter."
+      end
+      result
+    end
+
+    def parse_uri(uri)
+      matcher = uri.match(URI_REGEX)
+      type = matcher[1]
+      spotify_id = matcher[2]
+      parsed_uri = nil
+      response = HTTParty.get("#{WS_URL}/#{type}s/#{spotify_id}?client_id=#{@@client_id}")
+      if response['name']
+        if response['artists']
+          parsed_uri = response['artists'][0]['name'] + " - " + response['name']
+        else
+          parsed_uri = response['name']
+        end
+      end
+      parsed_uri
+    end
+  end
+end

data/lib/hibot.rb

@@ -0,0 +1,41 @@
+# vendor gems
+require 'cinch'
+require 'httparty'
+require 'rainbow'
+
+# custom classes
+require 'hibot/helpers/configuration'
+require 'api/spotify'
+require 'hibot/plugins/spotify'
+
+
+module Hibot
+  extend Configuration
+  def self.launch(opts)
+    # Read the config file and get all the settings in the config hash
+    config = self.configure(opts)
+    bot = Cinch::Bot.new do
+      configure do |c|
+        # General bot settings such server, channels etc
+        config[:general].each {|opt, value|
+          c.send("#{opt}=".to_sym, value)  
+        }
+
+        # Load plugins
+        c.plugins.plugins = []
+        config[:general]['plugins.plugins'.to_sym].each do |plugin|
+          c.plugins.plugins << Object.const_get(plugin)
+        end        
+      end
+    end
+
+    # Loop to configure each activated plugins
+    config[:general]['plugins.plugins'.to_sym].each do |plugin|
+      # Format the plugin name to call the appropriate configure method
+      plugin_name = plugin.split('::').join('_').downcase
+      self.send("configure_#{plugin_name}", config[plugin.to_sym])
+    end
+
+    bot.start
+  end
+end

data/lib/hibot/helpers/configuration.rb

@@ -0,0 +1,26 @@
+require 'yaml'
+
+module Configuration
+  def configure(opts)
+    unless config_file_exists?(opts[:path])
+      STDERR.puts Rainbow("Config file .hibotrc not found. Please ensure that it exists in your home directory or override the default location with the option corresponding.").red
+      exit 1
+    end
+
+    config = read_config_file(opts[:path])
+  end
+
+  def config_file_exists?(path)
+    File.exists?(path)
+  end
+
+  def read_config_file(path)
+    config = YAML.load_file(path)
+  end
+
+  def configure_hibot_spotify(opts)
+    opts.each {|opt, value|
+      API::Spotify.class_variable_set("@@#{opt}", value)
+    }
+  end
+end

data/lib/hibot/plugins/spotify.rb

@@ -0,0 +1,20 @@
+module Hibot
+  class Spotify
+    include Cinch::Plugin
+    include API::Spotify
+
+    match "search", method: :search
+    match API::Spotify::URI_REGEX, {method: :parse, use_prefix: false}
+
+    def search(m)
+      # Search on the message without !search and without any trailing spaces
+      result = search(m.message.gsub('!search', '').split)
+      m.reply result
+    end
+
+    def parse(m)
+      parsed_uri = parse_uri(m.message)
+      m.reply parsed_uri unless parsed_uri.nil?
+    end
+  end
+end

data/spec/api/spotify_spec.rb

@@ -0,0 +1,36 @@
+RSpec.describe API::Spotify do
+  let(:obj) { Object.new.extend(described_class) }
+
+  before(:each) do
+    config = Hibot.configure({path: File.expand_path("../../hibotrc", __FILE__)})
+    Hibot.configure_hibot_spotify(config['Hibot::Spotify'.to_sym])
+  end
+  
+  context "parse_uri method" do
+    it "should return a result if the uri matches with some results" do
+      expect(obj.parse_uri('spotify:track:0YQznyH9mJn6UTwWFHqy4b')).to eq('Nicolas Jaar - El Bandido')
+    end
+
+    it "should return nil if the uri doesn't match with any results" do
+      expect(obj.parse_uri('spotify:track:xxxxxxxxxxxxxxxxxx')).to eq(nil)
+    end
+  end
+
+  context "search method" do
+    it "should return an error message if the number of arguments is not equal to 2" do
+      expect(obj.search('foo')).to eq('Invalid search request. You have to provide a valid type (artist, album or track) and then your query')
+    end
+
+    it "should return an error message if the type is not in the permitted types list" do
+      expect(obj.search('foo query')).to eq('Bad request. Allowed types are album, artist and track.')
+    end
+
+    it "should return a string saying not found if the query doesn't return any results" do
+      expect(obj.search('album foobartest')).to eq('Nothing found with that parameter.')
+    end
+
+    it "should return a string with maximum 5 results if the query matches to something" do
+      expect(obj.search('track eminem')).to eq("1. 'Till I Collapse --> spotify:track:6yr8GiTHWvFfi4o6Q5ebdT --> https://open.spotify.com/track/6yr8GiTHWvFfi4o6Q5ebdT\n2. Lose Yourself - Soundtrack Version --> spotify:track:7w9bgPAmPTtrkt2v16QWvQ --> https://open.spotify.com/track/7w9bgPAmPTtrkt2v16QWvQ\n3. The Monster --> spotify:track:5U8hKxSaDXB8cVeLFQjvwx --> https://open.spotify.com/track/5U8hKxSaDXB8cVeLFQjvwx\n4. Mockingbird --> spotify:track:17baAghWcrewNOcc9dCewx --> https://open.spotify.com/track/17baAghWcrewNOcc9dCewx\n")
+    end
+  end
+end

data/spec/foo

@@ -0,0 +1,3 @@
+---
+:foo: bar
+:hello: world

data/spec/helpers/configuration_spec.rb

@@ -0,0 +1,57 @@
+RSpec.describe Configuration do
+  let(:obj) { Object.new.extend(Configuration) }
+  let(:config_path) { File.expand_path("../../foo", __FILE__) }
+  let(:create_file) { FileUtils.touch(config_path) }
+  let(:delete_file) { FileUtils.remove_entry(config_path) }
+
+  describe "check if the .hibotrc file exists" do
+    it "should return false if it doesn't exist" do
+      begin delete_file; rescue;end
+      expect(obj.config_file_exists?(config_path)).to eq(false)
+    end
+
+    it "should return true if it exists" do
+      create_file
+      expect(obj.config_file_exists?(config_path)).to eq(true)
+      delete_file
+    end
+  end
+
+  describe "parse the config file" do
+    before(:each) do create_file end
+    after(:each) do delete_file end
+
+    it "should return false if the file is empty" do
+      expect(obj.read_config_file(config_path)).to eq(false)
+    end
+
+    it "should return a hash with all the settings if file is not empty" do
+      File.open(config_path, 'w') {|f| f.write({foo: 'bar', hello: 'world'}.to_yaml)} 
+      expect(obj.read_config_file(config_path)).to eq({foo: 'bar', hello: 'world'})
+    end
+  end
+
+  describe "configure the gem" do
+    it "should exit if the path provided is not a valid config file" do
+      opts = {path: "/var/foo/bar"}
+      expect { obj.configure(opts) }.to raise_error(SystemExit)
+    end
+
+    it "should return a hash with the settings contained in the config file" do
+      opts = {path: config_path}
+      File.open(config_path, 'w') {|f| f.write({foo: 'bar', hello: 'world'}.to_yaml)}
+      expect(obj.configure(opts)).to eq({foo: 'bar', hello: 'world'})
+    end
+  end
+
+  describe "configure the spotify plugin" do
+    it "should create class variable for each options" do
+      opts = {foo: "bar", bar: "foo"}
+      obj.configure_hibot_spotify(opts)
+      expect(API::Spotify.class_variable_defined?(:@@foo)).to eq(true)
+      expect(API::Spotify.class_variable_get(:@@foo)).to eq('bar')
+      expect(API::Spotify.class_variable_defined?(:@@bar)).to eq(true)
+      expect(API::Spotify.class_variable_get(:@@bar)).to eq('foo')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/vendor/"
+end
+
+require "bundler"
+Bundler.setup
+
+require 'fileutils'
+require "hibot"
+
+Bundler.require(:test)

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: hibot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicolas Collard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: IRC bot supporting multiple services like spotify, giphy and so on.
+email: niko@hito.be
+executables:
+- hibot
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- bin/hibot
+- hibot.gemspec
+- lib/api/spotify.rb
+- lib/config.rb
+- lib/hibot.rb
+- lib/hibot/helpers/configuration.rb
+- lib/hibot/plugins/spotify.rb
+- spec/api/spotify_spec.rb
+- spec/foo
+- spec/helpers/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Hito01/Hibot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: IRC bot supporting multiple services.
+test_files:
+- spec/api/spotify_spec.rb
+- spec/foo
+- spec/helpers/configuration_spec.rb
+- spec/spec_helper.rb