lita-onewheel-xkcd 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c35d89afb36af4bc8f816521dc5efc28dd017308
+  data.tar.gz: 6b4d2430623972cebad8afb4474a97d8c7908534
+SHA512:
+  metadata.gz: 5d55c341e5dc44673d53c9fefad480017890f535a6eb94216ab3c642393c2b6df14a0c068f4afa952e543100291c90d33ada38638dcc2ef0b03768b8003a1dc7
+  data.tar.gz: d5a2e0ed7a4eed78e0b3bff00424940ccd149618f6a763226d71ba7a698dc6de6fdf6f619121ea7b54deed0bba113d5a714d40f3aefd0a23450ec994e89e5185

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+lita_config.rb

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.3
+script: bundle exec rake
+before_install:
+  - gem update --system
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Rakefile

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

data/lib/lita/handlers/onewheel_xkcd.rb

@@ -0,0 +1,171 @@
+require 'sequel'
+require 'json'
+require_relative '../models/comic'
+
+module Lita
+  module Handlers
+    class OnewheelXkcd < Handler
+      config :db_host, required: true, default: 'localhost'
+      config :db_name, required: true, default: 'lita_xkcd'
+      config :db_user, required: true, default: 'root'
+      config :db_pass, required: true, default: ''
+      config :db_port, required: true, default: 5432
+      config :alt_delay, default: 9
+
+      route /^xkcd$/i,
+            :random,
+            command: true,
+            help: {'xkcd' => 'return a random XKCD comic.'}
+
+      route /^xkcd ([a-zA-Z ]+)/i,
+            :find_by_keyword,
+            command: true,
+            help: {'xkcd (keyword)' => 'return an XKCD comic with the keyword(s) specified.'}
+
+      route /^xkcd (\d+)/i,
+            :find_by_number,
+            command: true,
+            help: {'xkcd (number)' => 'return an XKCD comic by it\'s number (somewhere between 1 and 1600).'}
+
+      route /^xkcd prev/i,
+            :find_prev,
+            command: true,
+            help: {'xkcd prev' => 'return the previous XKCD comic by date.'}
+
+      route /^xkcd next/i,
+            :find_next,
+            command: true,
+            help: {'xkcd prev' => 'return the next XKCD comic by date.'}
+
+      ##
+      # Search the title for a string, and return the comic.
+      #
+      def find_by_keyword(response)
+        db = init_db
+        keywords = response.matches[0][0]
+        result = db["
+          select id, data->'img' as img, data->'title' as title, data->'alt' as alt
+          from comics
+          where data->>'title' ilike ? order by RANDOM() limit 1", "%#{keywords}%"]
+        if row = result[:data]
+          comic = Comic.new(row[:id], row[:img], row[:title], row[:alt])
+          reply_with_comic response, comic
+        end
+      end
+
+      ##
+      # Find by xkcd id.
+      #
+      def find_by_number(response)
+        db = init_db
+        number = response.matches[0][0]
+        result = db["
+          select id, data->'img' as img, data->'title' as title, data->'alt' as alt
+          from comics
+          where id = ?", number]
+        if row = result[:data]
+          comic = Comic.new(row[:id], row[:img], row[:title], row[:alt])
+          reply_with_comic response, comic
+        end
+      end
+
+      ##
+      # Get a random comic
+      #
+      def random(response)
+        db = init_db
+        row = db["
+          select id, data->'img' as img, data->'title' as title, data->'alt' as alt
+          from comics
+          order by RANDOM()
+          limit 1"
+        ][:data]
+        comic = Comic.new(row[:id], row[:img], row[:title], row[:alt])
+        reply_with_comic response, comic
+      end
+
+      ##
+      # Find the next comic based on user state
+      #
+      def find_next(response)
+        db = init_db
+        if last_comic = get_last_comic(response.user)
+          last_comic += 1
+          comic = get_comic_by_id(db, last_comic)
+          reply_with_comic response, comic
+        end
+      end
+
+      ##
+      # Find the previous comic based on user state
+      #
+      def find_prev(response)
+        db = init_db
+        if last_comic = get_last_comic(response.user)
+          last_comic -= 1
+          comic = get_comic_by_id(db, last_comic)
+          reply_with_comic response, comic
+        end
+      end
+
+      ##
+      # Grab the comic object by xkcd id (which is also db id)
+      #
+      def get_comic_by_id(db, last_comic)
+        row = db["
+          select id, data->'img' as img, data->'title' as title, data->'alt' as alt
+          from comics
+          where id = ?", last_comic][:data]
+
+        Comic.new(row[:id], row[:img], row[:title], row[:alt])
+      end
+
+      ##
+      # Helper function to display comic and set timer for alt tag.
+      #
+      def reply_with_comic(response, comic)
+        set_state comic, response.user
+        response.reply "XKCD #{comic.id} \"#{comic.title}\" #{comic.image}"
+        after(config.alt_delay) do |timer|
+          response.reply comic.alt
+        end
+      end
+
+      ##
+      # Save the state oh the recently displayed comic by user.
+      #
+      def set_state(comic, user)
+        db = init_db
+        state = db[:state]
+        user_state = state.where(:user => user.name)
+        puts user_state.count
+        if user_state.count > 0
+          log.debug 'Updating state!'
+          user_state.update(:last_comic => comic.id)
+        else
+          log.debug 'Creating state!'
+          state.insert(user: user.name, last_comic: comic.id)
+        end
+      end
+
+      ##
+      # Grab the user's last_comic for informational purposes.
+      #
+      def get_last_comic(user)
+        db = init_db
+        dataset = db[:state].where(:user => user.name)
+        if dataset.count > 0
+          dataset.first[:last_comic]
+        else
+          log.debug("get_last_comic called with no user state for #{user.name}")
+        end
+
+      end
+
+      def init_db
+        Sequel.connect("postgres://#{config.db_user}:#{config.db_pass}@#{config.db_host}:#{config.db_port}/#{config.db_name}")
+      end
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita/models/comic.rb

@@ -0,0 +1,10 @@
+class Comic
+  attr_accessor :id, :image, :title, :alt
+
+  def initialize(id, image, title, alt)
+    self.id = id
+    self.image = image.gsub('"', '').gsub('\\', '')
+    self.title = title.gsub('"', '')
+    self.alt = alt
+  end
+end

data/lib/lita-onewheel-xkcd.rb

@@ -0,0 +1,12 @@
+require 'lita'
+
+Lita.load_locales Dir[File.expand_path(
+  File.join('..', '..', 'locales', '*.yml'), __FILE__
+)]
+
+require 'lita/handlers/onewheel_xkcd'
+
+Lita::Handlers::OnewheelXkcd.template_root File.expand_path(
+  File.join('..', '..', 'templates'),
+ __FILE__
+)

data/lita-onewheel-xkcd.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'lita-onewheel-xkcd'
+  spec.version       = '0.0.0'
+  spec.authors       = ['Andrew Kreps']
+  spec.email         = ['andrew.kreps@gmail.com']
+  spec.description   = 'XKCD searchable archive for comics by keyword, id and date*.  * date coming soon to a minor update near you'
+  spec.summary       = 'Ever wanted a way to display XKCD comics in your chat client of choice?  Look no further!'
+  spec.homepage      = 'https://github.com/onewheelskyward/lita-onewheel-xkcd'
+  spec.license       = 'MIT'
+  spec.metadata      = { 'lita_plugin_type' => 'handler' }
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'lita', '~> 4.6'
+  spec.add_runtime_dependency 'lita-irc', '~> 2.0'
+  spec.add_runtime_dependency 'sequel', '~> 4.27'
+  spec.add_runtime_dependency 'sequel_pg', '~> 1.6'
+  spec.add_runtime_dependency 'pg', '~> 0.18'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+end

data/lita_config.rb.sample

@@ -0,0 +1,7 @@
+Lita.configure do |config|
+  config.handlers.onewheel_xkcd.db_host = 'localhost'
+  config.handlers.onewheel_xkcd.db_name = 'lita_xkcd'
+  config.handlers.onewheel_xkcd.db_user = 'root'
+  config.handlers.onewheel_xkcd.db_pass = ''
+  config.handlers.onewheel_xkcd.db_port = 5432
+end

data/readme.rst

@@ -0,0 +1,56 @@
+lita-onewheel-xkcd
+==================
+
+.. image:: https://travis-ci.org/onewheelskyward/lita-onewheel-xkcd.png?branch=master :target: https://travis-ci.org/onewheelskyward/lita-onewheel-xkcd
+.. image:: https://coveralls.io/repos/onewheelskyward/lita-onewheel-xkcd/badge.svg?branch=master&service=github :target: https://coveralls.io/github/onewheelskyward/lita-onewheel-xkcd?branch=master
+
+A Lita_ handler to display XKCD comics in your chat handler of choice.  
+
+
+Installation
+------------
+Add lita-onewheel-xkcd to your Lita instance's Gemfile:
+::
+  gem "lita-onewheel-xkcd"
+
+
+Configuration
+-------------
+Unless you're running the defaults, you'll want to specify your database connection values like so:
+::
+  Lita.configure do |config|
+    config.handlers.onewheel_xkcd.db_host = 'localhost'
+    config.handlers.onewheel_xkcd.db_name = 'lita_xkcd'
+    config.handlers.onewheel_xkcd.db_user = 'root'
+    config.handlers.onewheel_xkcd.db_pass = ''
+    config.handlers.onewheel_xkcd.db_port = 5432
+    config.handlers.onewheel-xkcd.alt_delay = 15   # Optional; 9 is the default.
+  end
+
+Usage
+-----
+All commands return the comic, and then display the alt text alt_delay seconds later.
+
+:xkcd: Returns a random XKCD comic.
+:xkcd 411: Returns xkcd.com/411's comic.
+:xkcd ballmer: returns my favorite Steve Ballmer comic.
+:xkcd next: returns the next comic by index.
+:xkcd prev: returns the previous comic by index.
+
+
+Engineering Notes
+-----------------
+
+Current comic(including top number): http://xkcd.com/info.0.json 
+
+Comic by number: http://xkcd.com/1/info.0.json
+
+How to map # to date?  - it's in the meta
+
+Parser script, import into postgres?  Best way to handle json
+
+Keyword tokenizer, it's substring searching at the moment.
+
+Add postgres setup and details on how to update the database with new comics.
+
+.. _Lita: http://lita.io/

data/scripts/pop.rb

@@ -0,0 +1,25 @@
+require 'sequel'
+require 'rest-client'
+
+db = Sequel.connect('postgres://root@localhost:5432/lita_xkcd')
+
+max_id = db[:comics].max(:id) || 1
+
+puts "max_id: #{max_id}"
+db_comics = db[:comics]
+
+top_response = RestClient.get 'http://xkcd.com/info.0.json'
+top_json = JSON.parse top_response
+puts top_json['num']
+
+for num in max_id..top_json['num'] do
+  if num == 404
+    puts '404!'
+    db_comics.insert(data: '{"status":"not found"}')
+    next
+  end
+  response = RestClient.get "http://xkcd.com/#{num}/info.0.json"
+  db_comics.insert(data: response)
+  puts "#{num}/#{top_json['num']}"
+end
+

data/scripts/schema.rb

@@ -0,0 +1,13 @@
+require 'sequel'
+
+db = Sequel.connect('postgres://root@localhost:5432/lita_xkcd')
+
+db.create_table :comics do
+  primary_key :id
+  Json :data
+end
+
+db.create_table :state do
+  String :user
+  int :last_comic
+end

data/spec/lita/handlers/onewheel_xkcd_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Lita::Handlers::OnewheelXkcd, lita_handler: true do
+  it { is_expected.to route_command('xkcd') }
+  it { is_expected.to route_command('xkcd random') }
+  it { is_expected.to route_command('xkcd first') }
+  it { is_expected.to route_command('xkcd last') }
+  it { is_expected.to route_command('xkcd today') }
+  it { is_expected.to route_command('xkcd 5/5/1998') }
+  it { is_expected.to route_command('xkcd 5-5-1998') }
+  it { is_expected.to route_command('xkcd 1998-5-5') }
+  it { is_expected.to route_command('xkcd prev') }
+  it { is_expected.to route_command('xkcd next') }
+
+  @img_url = 'http://imgs.xkcd.com/comics/'
+
+  it 'will return a random xkcd comic' do
+    send_command 'xkcd random'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return a today\'s then a random xkcd comic' do
+    send_command 'xkcd'
+    expect(replies.last).to include(@img_url)
+    send_command 'xkcd'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return today\'s xkcd comic' do
+    send_command 'xkcd today'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return today\'s xkcd comic' do
+    send_command 'xkcd last'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return the first xkcd comic' do
+    send_command 'xkcd first'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return a xkcd comic for a specific y-m-d date' do
+    send_command 'xkcd 1998-5-5'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return a xkcd comic for a specific m-d-y date' do
+    send_command 'xkcd 5-5-1998'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will return a xkcd comic for a specific / date' do
+    send_command 'xkcd 5/5/1998'
+    expect(replies.last).to include(@img_url)
+  end
+
+  # Test the saved state of the last comic you requested.
+  it 'will return the first and then the next and then the previous xkcd comic' do
+    send_command 'xkcd first'
+    expect(replies.last).to include(@img_url)
+    send_command 'xkcd next'
+    expect(replies.last).to include(@img_url)
+    send_command 'xkcd prev'
+    expect(replies.last).to include(@img_url)
+  end
+
+  it 'will edge case prev and next' do
+    today = Date.today
+
+    first = @img_url
+    last = "#{@img_url}#{today.year}-#{zero_prefix today.month}-#{zero_prefix today.day}.jpg"
+
+    send_command 'xkcd first'
+    expect(replies.last).to include(first)
+    send_command 'xkcd prev'
+    expect(replies.last).to include(first)
+    send_command 'xkcd last'
+    expect(replies.last).to include(last)
+    send_command 'xkcd next'
+    expect(replies.last).to include(last)
+  end
+
+  def zero_prefix(dat)
+    if dat.to_i < 10
+      "0#{dat}"
+    else
+      dat
+    end
+  end
+
+  def get_todays_image_filename
+    date = Date.today
+    "#{date.year}-#{zero_prefix date.month}-#{zero_prefix date.day}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start { add_filter '/spec/' }
+
+require 'lita-onewheel-xkcd'
+require 'lita/rspec'
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: lita-onewheel-xkcd
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Andrew Kreps
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: lita-irc
+  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: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.27'
+- !ruby/object:Gem::Dependency
+  name: sequel_pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: XKCD searchable archive for comics by keyword, id and date*.  * date
+  coming soon to a minor update near you
+email:
+- andrew.kreps@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Rakefile
+- lib/lita-onewheel-xkcd.rb
+- lib/lita/handlers/onewheel_xkcd.rb
+- lib/lita/models/comic.rb
+- lita-onewheel-xkcd.gemspec
+- lita_config.rb.sample
+- readme.rst
+- scripts/pop.rb
+- scripts/schema.rb
+- spec/lita/handlers/onewheel_xkcd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/onewheelskyward/lita-onewheel-xkcd
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+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.1
+signing_key: 
+specification_version: 4
+summary: Ever wanted a way to display XKCD comics in your chat client of choice?  Look
+  no further!
+test_files:
+- spec/lita/handlers/onewheel_xkcd_spec.rb
+- spec/spec_helper.rb