robut-giphy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37302fd340a01863e7976c8dffb596f14efb6cce
+  data.tar.gz: 63d32e310acbcd7f9b9b2b246d9c509d06297c11
+SHA512:
+  metadata.gz: 79bc307f3440d6befea0320cbdb625a926bcab93f8ccf33c0f523bb6fc35be13d4adc9004cb111033605966dc06079e4cf622d7ee4c4bf0930e2e51ff5cf7879
+  data.tar.gz: 3dfad789ba2b149abd1fbd0a7ba1995e8dceda5a89221ee4d7183d4c8d141797fd5f79bdd00627427861ee8fc120f0f4b62cf2fc28d4acdcf237a67ee6c75b02

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    robut-giphy (0.1.0)
+      robut
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    power_assert (0.2.2)
+    rack (1.6.1)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    robut (0.5.2)
+      sinatra (~> 1.3)
+      xmpp4r (~> 0.5.0)
+    safe_yaml (1.0.4)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    test-unit (3.0.8)
+      power_assert
+    tilt (2.0.1)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    xmpp4r (0.5.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  robut-giphy!
+  test-unit
+  webmock

data/LICENSE

@@ -0,0 +1,23 @@
+
+Copyright (c) 2015 Simon Detheridge
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Robut-giphy
+
+A giphy plugin and meme generator for the robut hipchat bot.
+
+## Installation
+
+Install the gem
+
+    gem install 'robut-giphy'
+
+Add these lines to your Chatfile:
+
+    require 'robut/plugin/giphy'
+
+    Robut::Plugin.plugins << Robot::Plugin::Giphy
+
+For meme-generation support, also add the following:
+
+    require 'robut/plugin/giphy/memes'
+
+    Robut::Plugin.plugins << Robut::Plugin::Giphy::Memes
+
+By default, robut-giphy uses the Giphy beta API key. You may wish to replace
+this with your own API key:
+
+    Robut::Plugin::Giphy.configure do |c|
+      c.api_key = 'your_api_key'
+    end
+
+robut-giphy filters results to those set to PG by default. If you want to
+change this:
+
+    Robut::Plugin::Giphy.configure do |c|
+      c.rating = 'pg-13' # pg, pg-13 or r
+    end
+
+## Usage
+
+This plugin searches giphy for a random gif matching a search phrase, and
+displays it in chat. For example:
+
+    @robut giphy funny kitten
+
+If the meme plugin is also loaded, the gif will be run through memecaption to
+add up to two lines of text
+
+    @robut giphy funny kitten; a top caption goes here
+
+    @robut giphy cat wig; a top caption; a bottom caption
+
+
+## Contributing
+
+You probably know the drill already...
+
+1. Fork it
+2. Create a feature branch
+3. Write some tests
+4. Commit your changes
+5. Push to the branch
+6. Create a new Pull Request
+
+## License
+
+(c) Simon Detheridge, 2015
+Released under the MIT License
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+

data/lib/robut/plugin/giphy.rb

@@ -0,0 +1,2 @@
+require 'robut/plugin/giphy/giphy'
+

data/lib/robut/plugin/giphy/base.rb

@@ -0,0 +1,22 @@
+require 'robut/plugin'
+require 'net/http'
+require 'json'
+
+class Robut::Plugin::Giphy
+  module Base
+    def giphy_uri(gif)
+      uri = "http://api.giphy.com/v1/gifs/random?api_key=#{CGI::escape(Robut::Plugin::Giphy.api_key)}&tag=#{CGI::escape(gif)}&rating=#{CGI::escape(Robut::Plugin::Giphy.rating)}"
+
+      response = Net::HTTP.get_response(URI.parse(uri))
+      raise "Giphy didn't like it" unless response.code.to_i == 200
+
+      result = JSON.parse(response.body)
+      if result['data'] && result['data'].include?('image_url')
+        result['data']['image_url']
+      else
+        nil
+      end
+    end
+  end
+end
+

data/lib/robut/plugin/giphy/giphy.rb

@@ -0,0 +1,38 @@
+require 'robut/plugin'
+require 'net/http'
+require 'json'
+require 'ostruct'
+require 'robut/plugin/giphy/base'
+
+class Robut::Plugin::Giphy
+  include Robut::Plugin
+  include Robut::Plugin::Giphy::Base
+
+  def self.configuration
+    @config ||=  OpenStruct.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  desc "giphy <subject> - searches for and displays a gif matching <subject> from giphy"
+  match /^giphy ([^;]+)$/, :sent_to_me => true do |gif|
+    begin
+      uri = giphy_uri(gif)
+      reply(uri ? "#{uri}\nPowered by Giphy" : "Sorry, I couldn't find a gif for that.")
+    rescue
+      reply('Giphy returned an error')
+    end
+  end
+
+  private
+  def self.api_key
+    Robut::Plugin::Giphy.configuration.api_key || 'dc6zaTOxFJmzC'
+  end
+
+  def self.rating
+    Robut::Plugin::Giphy.configuration.rating || 'pg'
+  end
+end
+

data/lib/robut/plugin/giphy/meme.rb

@@ -0,0 +1,32 @@
+require 'robut/plugin'
+require 'robut/plugin/giphy/base'
+require 'net/http'
+require 'json'
+
+class Robut::Plugin::Giphy::Meme
+  include Robut::Plugin
+  include Robut::Plugin::Giphy::Base
+
+  desc "giphy <subject>; <line_1> [; <line_2>] - searches for and displays a gif matching <subject> from giphy, with meme text line_1 and line_2 overlaid"
+  match /^giphy ([^;]+);(.*)$/, :sent_to_me => true do |gif, text|
+    begin
+      uri = giphy_uri(gif)
+      if uri
+        lines = text.split(';').map {|t| t.strip}
+        meme = "http://v1.memecaptain.com/i?u=#{uri}&tt=#{CGI.escape(lines[0])}"
+        meme += "&tb=#{CGI.escape(lines[1])}" if lines.count == 2
+
+        if lines.count < 3
+          reply("#{meme}\nPowered by Giphy and MemeCaptain")
+        else
+          reply("That's too much text. Don't be greedy.")
+        end
+      else
+        reply("Sorry, I couldn't find a gif for that.")
+      end
+    rescue
+      reply('Giphy returned an error')
+    end
+  end
+end
+

data/lib/robut/plugin/giphy/version.rb

@@ -0,0 +1,8 @@
+module Robut
+  module Plugin
+    class Giphy
+      VERSION = "0.1.0"
+    end
+  end
+end
+

data/robut-giphy.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'robut/plugin/giphy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "robut-giphy"
+  spec.version       = Robut::Plugin::Giphy::VERSION
+  spec.authors       = ["Simon Detheridge"]
+  spec.email         = ["simon.detheridge@gmail.com"]
+  spec.summary       = %q{Robut giphy plugin and meme generator}
+  spec.description   = %q{Enables robut to search for gipy images, and generate memes from those images using memecaptain}
+  spec.homepage      = "http://github.com/gh2k/robut-giphy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "robut"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "webmock"
+end

data/test/giphy_test_base.rb

@@ -0,0 +1,60 @@
+require 'robut/plugin/giphy'
+require 'webmock/test_unit'
+
+module GiphyTestBase
+
+  def setup
+    @connection = Robut::ConnectionMock.new
+    @presence = Robut::PresenceMock.new(@connection)
+    @plugin = new_plugin(@presence)
+
+    Robut::Plugin::Giphy.configure do |config|
+      config.api_key = 'dc6zaTOxFJmzC'
+      config.rating = 'pg'
+    end
+
+    stub_request(:any, "http://api.giphy.com/v1/gifs/random?api_key=dc6zaTOxFJmzC&tag=hjklxxxx&rating=pg")
+      .to_return(status: 200, body: <<EOT)
+{"data":[],"meta":{"status":200,"msg":"OK"}}
+EOT
+
+    stub_request(:any, "http://api.giphy.com/v1/gifs/random?api_key=your-mom&tag=american+psycho&rating=pg")
+      .to_return(status: 500)
+    
+    stub_request(:any, "http://api.giphy.com/v1/gifs/random?api_key=dc6zaTOxFJmzC&tag=american+psycho&rating=pg")
+      .to_return(status: 200, body: <<EOT)
+{
+    "data": {
+        "type": "gif",
+        "id": "Ggjwvmqktuvf2",
+        "url": "http://giphy.com/gifs/american-psycho-christian-bale-Ggjwvmqktuvf2",
+        "image_original_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif",
+        "image_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif",
+        "image_mp4_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.mp4",
+        "image_frames": "11",
+        "image_width": "500",
+        "image_height": "256",
+        "fixed_height_downsampled_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/200_d.gif",
+        "fixed_height_downsampled_width": "391",
+        "fixed_height_downsampled_height": "200",
+        "fixed_width_downsampled_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/200w_d.gif",
+        "fixed_width_downsampled_width": "200",
+        "fixed_width_downsampled_height": "102",
+        "fixed_height_small_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100.gif",
+        "fixed_height_small_still_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100_s.gif",
+        "fixed_height_small_width": "195",
+        "fixed_height_small_height": "100",
+        "fixed_width_small_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100w.gif",
+        "fixed_width_small_still_url": "http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/100w_s.gif",
+        "fixed_width_small_width": "100",
+        "fixed_width_small_height": "51"                 
+    },
+    "meta": {
+        "status": 200,
+        "msg": "OK"
+    }
+}
+EOT
+  end
+
+end

data/test/mocks/connection_mock.rb

@@ -0,0 +1,22 @@
+require 'robut/storage/hash_store'
+
+class Robut::ConnectionMock < Robut::Connection
+
+  attr_accessor :messages
+
+  def initialize(config = nil)
+    self.messages = []
+    self.config = config || self.class.config
+    self.store  = Robut::Storage::HashStore
+    self.client = Jabber::Client.new ''
+  end
+
+  def connect
+    self.rooms = []
+    self
+  end
+
+  def reply(message, to)
+    self.messages << [message, to]
+  end
+end

data/test/mocks/presence_mock.rb

@@ -0,0 +1,25 @@
+require 'robut/storage/hash_store'
+
+class Robut::PresenceMock < Robut::Room
+
+  def initialize(connection)
+    self.connection = connection
+  end
+
+  def replies
+    @replies ||= []
+  end
+  
+  def reply(msg, to = nil)
+    replies << msg
+  end
+  
+  def handle_message(plugins, time, nick, message)
+    messages << [time, nick, message]
+  end
+  
+  def messages
+    @messages ||= []
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'robut'
+require 'test/unit'
+require 'mocks/presence_mock'
+require 'mocks/connection_mock'
+require 'giphy_test_base'
+
+Robut::ConnectionMock.configure do |config|
+  config.nick = "Robut t. Robot"
+  config.mention_name = "robut"
+end

data/test/unit/plugin/giphy_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'robut/plugin/giphy'
+
+class Robut::Plugin::GiphyTest < Test::Unit::TestCase
+  include GiphyTestBase
+
+  def test_replies_with_gif
+    @plugin.handle(Time.now, "@john", "@robut giphy american psycho")
+    assert_equal ["http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif\nPowered by Giphy"], @plugin.reply_to.replies
+  end
+
+  def test_replies_without_gif
+    @plugin.handle(Time.now, "@john", "@robut giphy hjklxxxx")
+    assert_equal ["Sorry, I couldn't find a gif for that."], @plugin.reply_to.replies
+  end
+  
+  def test_doesnt_reply_with_empty
+    @plugin.handle(Time.now, "@john", "@robut giphy")
+    assert_equal [], @plugin.reply_to.replies
+  end
+  
+  def test_doesnt_reply_with_semicolon
+    @plugin.handle(Time.now, "@john", "@robut giphy cat; look at this cat")
+    assert_equal [], @plugin.reply_to.replies
+  end
+
+  def test_fails_with_invalid_api_key
+    Robut::Plugin::Giphy.configure do |config|
+      config.api_key = 'your-mom'
+      @plugin.handle(Time.now, "@john", "@robut giphy american psycho")
+      assert_equal ["Giphy returned an error"], @plugin.reply_to.replies
+    end
+  end
+
+  protected
+  def new_plugin(presence)
+    Robut::Plugin::Giphy.new(presence)
+  end
+end

data/test/unit/plugin/meme_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'robut/plugin/giphy/meme'
+
+class Robut::Plugin::Giphy::MemeTest < Test::Unit::TestCase
+  include GiphyTestBase
+
+  def test_replies_with_one_line
+    @plugin.handle(Time.now, "@john", "@robut giphy american psycho; text on a picture")
+    assert_equal ["http://v1.memecaptain.com/i?u=http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif&tt=text+on+a+picture\nPowered by Giphy and MemeCaptain"], @plugin.reply_to.replies
+  end
+
+  def test_replies_with_two_lines
+    @plugin.handle(Time.now, "@john", "@robut giphy american psycho; text on a picture; isn't it awesome")
+    assert_equal ["http://v1.memecaptain.com/i?u=http://s3.amazonaws.com/giphygifs/media/Ggjwvmqktuvf2/giphy.gif&tt=text+on+a+picture&tb=isn%27t+it+awesome\nPowered by Giphy and MemeCaptain"], @plugin.reply_to.replies
+  end
+
+  def test_replies_without_gif
+    @plugin.handle(Time.now, "@john", "@robut giphy hjklxxxx; blargh")
+    assert_equal ["Sorry, I couldn't find a gif for that."], @plugin.reply_to.replies
+  end
+  
+  def test_replies_with_three_semicolons
+    @plugin.handle(Time.now, "@john", "@robut giphy american psycho; text on a picture; isn't it awesome; so very awesome")
+    assert_equal ["That's too much text. Don't be greedy."], @plugin.reply_to.replies
+  end
+
+  def test_ignores_giphy_without_semicolons
+    @plugin.handle(Time.now, "@john", "@robut giphy cat")
+    assert_equal [], @plugin.reply_to.replies
+  end
+
+  protected
+  def new_plugin(presence)
+    Robut::Plugin::Giphy::Meme.new(presence)
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: robut-giphy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Detheridge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: robut
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enables robut to search for gipy images, and generate memes from those
+  images using memecaptain
+email:
+- simon.detheridge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/robut/plugin/giphy.rb
+- lib/robut/plugin/giphy/base.rb
+- lib/robut/plugin/giphy/giphy.rb
+- lib/robut/plugin/giphy/meme.rb
+- lib/robut/plugin/giphy/version.rb
+- robut-giphy.gemspec
+- test/giphy_test_base.rb
+- test/mocks/connection_mock.rb
+- test/mocks/presence_mock.rb
+- test/test_helper.rb
+- test/unit/plugin/giphy_test.rb
+- test/unit/plugin/meme_test.rb
+homepage: http://github.com/gh2k/robut-giphy
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Robut giphy plugin and meme generator
+test_files:
+- test/giphy_test_base.rb
+- test/mocks/connection_mock.rb
+- test/mocks/presence_mock.rb
+- test/test_helper.rb
+- test/unit/plugin/giphy_test.rb
+- test/unit/plugin/meme_test.rb