hibot 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da04f8159bb4a38fcec07a4b097f3686b07a79ad
-  data.tar.gz: ce6402a54c877a8eeeacd580b37cdd033123b246
+  metadata.gz: 20c6d76c9963fa2fac68bf484003d065d071fb78
+  data.tar.gz: c5ad3bf5f78f41aaa8333833aec2b0f8841496a2
 SHA512:
-  metadata.gz: 35d390f87724f6090b3924ad00d99180f4143abe9089623b95a23ed0473c3eeded19ae400ca4a9b3573a02aff250793d0018d97df0b350f6da6919a2a5f621c1
-  data.tar.gz: 5375e81f645cfb8f2e3330c2007e7f59f6d52e8e8e6983c35e59c94c49a20a7d1095c3476069f949169f732813d615089645d35b948a6af313b7397c76c2692e
+  metadata.gz: b1f9ea06d13f11ee04c7378910206fe42d2024ff0058d5c71b649757b599c6f77867a2063aae2704d4037ac6e68630ff2752f06a5ed06fa36205d03d037bbc43
+  data.tar.gz: fbaf53d4166bffd1c900a811753d74bfc758cbc13d8bb6617a0851d0705614f5bffb1ea1215f4727178eed4e69cfee24de1332a90868f3e0cef218424e2685ad

data/README.md

@@ -28,8 +28,6 @@ Then, just run the hibot binary to launch the bot. If you changed to default hib
 
 ## 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.
@@ -44,6 +42,15 @@ To use this plugin, you have to create a spotify application. You can do it from
   :client_secret: your_client_secret
 ```
 
+2. Hibot::Giphy : allows you to get random gif uri matching your query
+
+To use this plugin, you have to request an API key more information about how to get a key [here](https://github.com/giphy/GiphyAPI#access-and-api-keys). When you have your key, complete the hibotrc file with that structure : 
+
+```yaml
+:Hibot::Giphy:
+  :api_key: your_api_key
+```
+
 ## Contribute
 1. Fork it
 2. Dev it

data/hibot.gemspec

@@ -2,8 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'hibot'
-  s.version     = '0.0.1'
-  s.date        = '2015-04-16'
+  s.version     = '0.0.2'
+  s.date        = '2015-04-21'
   s.summary     = "IRC bot supporting multiple services."
   s.description = "IRC bot supporting multiple services like spotify, giphy and so on."
   s.authors     = ["Nicolas Collard"]

data/lib/api/giphy.rb

@@ -0,0 +1,24 @@
+module API
+  module Giphy
+    WS_URL = "http://api.giphy.com/v1/gifs/search"
+    URI_REGEX = /spotify:([a-z]+):(\w+)/
+
+    def search(query)
+      puts "dans le seeeeaaartch !!!"
+      query = query.gsub('!gsearch', '').strip
+      # Check that parameters are correct or return the corresponding error
+      return "Please provide something to search" if query.nil? || query == ""
+
+      # Perform the search and return the result
+      result = ""
+      response = HTTParty.get("#{WS_URL}?q=#{URI.encode(query)}&api_key=#{@@api_key}")
+      if response['data'] && response['data'].count > 0
+        gif = response['data'].first
+        result = "Check this : #{gif['url']}"
+      else
+        result = 'Nothing found with that parameter.'
+      end
+      result
+    end
+  end
+end

data/lib/api/spotify.rb

@@ -6,6 +6,7 @@ module API
 
     def search(query)
       # Check that parameters are correct or return the corresponding error
+      query = query.gsub('!ssearch', '').strip
       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)

data/lib/hibot.rb

@@ -6,7 +6,9 @@ require 'rainbow'
 # custom classes
 require 'hibot/helpers/configuration'
 require 'api/spotify'
+require 'api/giphy'
 require 'hibot/plugins/spotify'
+require 'hibot/plugins/giphy'
 
 
 module Hibot
@@ -25,7 +27,7 @@ module Hibot
         c.plugins.plugins = []
         config[:general]['plugins.plugins'.to_sym].each do |plugin|
           c.plugins.plugins << Object.const_get(plugin)
-        end        
+        end
       end
     end
 

data/lib/hibot/helpers/configuration.rb

@@ -23,4 +23,10 @@ module Configuration
       API::Spotify.class_variable_set("@@#{opt}", value)
     }
   end
+
+  def configure_hibot_giphy(opts)
+    opts.each {|opt, value|
+      API::Giphy.class_variable_set("@@#{opt}", value)
+    }
+  end
 end

data/lib/hibot/plugins/giphy.rb

@@ -0,0 +1,13 @@
+module Hibot
+  class Giphy
+    include Cinch::Plugin
+    include API::Giphy
+
+    match /gsearch/, method: :query
+
+    def query(m)
+      result = search(m.message)
+      m.reply result
+    end
+  end
+end

data/lib/hibot/plugins/spotify.rb

@@ -3,12 +3,11 @@ module Hibot
     include Cinch::Plugin
     include API::Spotify
 
-    match "search", method: :search
+    match /ssearch/, {method: :query}
     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)
+    def query(m)
+      result = search(m.message)
       m.reply result
     end
 

data/spec/api/giphy_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe API::Giphy do
+  let(:obj) { Object.new.extend(described_class) }
+
+  before(:each) do
+    config = Hibot.configure({path: File.expand_path("../../hibotrc", __FILE__)})
+    Hibot.configure_hibot_giphy(config['Hibot::Giphy'.to_sym])
+  end
+  
+  context "parse_uri method" do
+    it "should return a message with an url if some gifs match the query" do
+      expect(obj.search('funny cat')).to_not eq("Nothing found with that parameter.")
+    end
+
+    it "should return an error message if none gif is found with that query" do
+      expect(obj.search('foobartest')).to eq("Nothing found with that parameter.")
+    end
+  end
+end

data/spec/api/spotify_spec.rb

@@ -11,6 +11,10 @@ RSpec.describe API::Spotify do
       expect(obj.parse_uri('spotify:track:0YQznyH9mJn6UTwWFHqy4b')).to eq('Nicolas Jaar - El Bandido')
     end
 
+    it "should return a result if the uri matches with an artist" do
+      expect(obj.parse_uri('spotify:artist:7dGJo4pcD2V6oG8kP0tJRR')).to eq('Eminem')
+    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

data/spec/helpers/configuration_spec.rb

@@ -54,4 +54,15 @@ RSpec.describe Configuration do
       expect(API::Spotify.class_variable_get(:@@bar)).to eq('foo')
     end
   end
+
+  describe "configure the gihpy plugin" do
+    it "should create class variable for each options" do
+      opts = {foo: "bar", bar: "foo"}
+      obj.configure_hibot_giphy(opts)
+      expect(API::Giphy.class_variable_defined?(:@@foo)).to eq(true)
+      expect(API::Giphy.class_variable_get(:@@foo)).to eq('bar')
+      expect(API::Giphy.class_variable_defined?(:@@bar)).to eq(true)
+      expect(API::Giphy.class_variable_get(:@@bar)).to eq('foo')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hibot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicolas Collard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cinch
@@ -94,11 +94,14 @@ files:
 - Rakefile
 - bin/hibot
 - hibot.gemspec
+- lib/api/giphy.rb
 - lib/api/spotify.rb
 - lib/config.rb
 - lib/hibot.rb
 - lib/hibot/helpers/configuration.rb
+- lib/hibot/plugins/giphy.rb
 - lib/hibot/plugins/spotify.rb
+- spec/api/giphy_spec.rb
 - spec/api/spotify_spec.rb
 - spec/foo
 - spec/helpers/configuration_spec.rb
@@ -128,6 +131,7 @@ signing_key:
 specification_version: 4
 summary: IRC bot supporting multiple services.
 test_files:
+- spec/api/giphy_spec.rb
 - spec/api/spotify_spec.rb
 - spec/foo
 - spec/helpers/configuration_spec.rb