lita-youtube-me 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b452c59b9836a8899cbf89e470dd184f5782658
-  data.tar.gz: c2b7a1c05505d331542fdc0f3fbbde9886232b74
+  metadata.gz: 84e50b2bf564204b460ec3da6d9b267aab005701
+  data.tar.gz: 816c091089bbf1ad1eb6c816003b6f28894cde66
 SHA512:
-  metadata.gz: 26e367d1fe3800f44cf5b43def7b1ce396ad52ddbad3ca2b4de514790cd16557c5ae6736889959f3db9ec69e76b17e4458ab4509da8d1a94c32c4a152ef001b7
-  data.tar.gz: 3690cbfb65f64948e4b35f9b164cbe6dfb97f471ce8cc8c8e2302e5f9e52afbcb4f8e9b248fd7f6d7c60787136475c898f710c42b216826126871dfa0b8bd4f2
+  metadata.gz: 9c5b96f5cc3a162f7a02fdeb76260ca56d98f4ed44ebbdb5d1f64a9c687a2cd58599ece5c8d05fe3558826fc24a86bfca6852ff6e22f8b5328c175183ffbba6b
+  data.tar.gz: c9d9a3686daafd6057a7c6eba8adda27e5b3fc6bec140838ea8ac1aaf24835d0495071d94dfe4c2e17e74eee518373c8d966a9f5d9425078aa04f62a07aee5ec

data/README.md

@@ -12,11 +12,18 @@ gem "lita-youtube-me"
 
 ## Configuration
 
+This plugin requires an API key for the [YouTube Data API (v3)](https://developers.google.com/youtube/v3/).
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.youtube_me.api_key = "FooBarBazLuhrmann"
+end
+```
+
 ### Optional attributes
 * `video_info` (boolean) - When set to `true`, Lita will return additional information (title, duration, etc.) about the video. Default: `false`
 * `detect_urls` (boolean) - When set to `true`, Lita will return additional information about any YouTube URLs it detects. Default: `false`
 
-### Example
 ``` ruby
 Lita.configure do |config|
   config.handlers.youtube_me.video_info = true

data/lib/lita/handlers/youtube_me.rb

@@ -1,15 +1,17 @@
 require "date"
+require "iso8601"
 
 module Lita
   module Handlers
     class YoutubeMe < Handler
-      API_URL = "https://gdata.youtube.com/feeds/api/videos"
+      API_URL = "https://www.googleapis.com/youtube/v3"
 
+      config :api_key, type: String, required: true
       config :video_info, types: [TrueClass, FalseClass], default: false
       config :detect_urls, types: [TrueClass, FalseClass], default: false
 
       route(/^(?:youtube|yt)(?: me)?\s+(.*)/i, :find_video, command: true, help: {
-        "youtube (me) QUERY" => "Gets a youtube video."
+        "youtube (me) QUERY" => "Gets a YouTube video."
       })
       # Detect YouTube links in non-commands and display video info
       route(/\byoutube\.com\/watch\?v=([^?&#\s]+)/i, :display_info, command: false)
@@ -17,40 +19,52 @@ module Lita
 
       def find_video(response)
         query = response.matches[0][0]
-        http_response = http.get(API_URL,
+        http_response = http.get(
+          "#{API_URL}/search",
           q: query,
-          orderBy: "relevance",
-          "max-results" => 15,
-          alt: "json"
+          order: "relevance",
+          maxResults: 15,
+          part: "snippet",
+          key: config.api_key
         )
-        videos = MultiJson.load(http_response.body)["feed"]["entry"]
+        return if http_response.status != 200
+        videos = MultiJson.load(http_response.body)["items"]
         video = videos.sample
-        video["link"].each do |link|
-          if link["rel"] == "alternate" && link["type"] == "text/html"
-            response.reply link["href"].split("&").first
-          end
-        end
+        id = video["id"]["videoId"]
+        response.reply "https://www.youtube.com/watch?v=#{id}"
         if config.video_info
-          response.reply info(video)
+          response.reply info(id)
         end
       end
 
       def display_info(response)
         if config.detect_urls
           id = response.matches[0][0]
-          http_response = http.get("#{API_URL}/#{id}", alt: "json")
-          video = MultiJson.load(http_response.body)["entry"]
-          response.reply info(video)
+          info_string = info(id)
+          unless info_string.nil?
+            response.reply info_string
+          end
         end
       end
 
-      def info(video)
-        title = video["title"]["$t"]
-        uploader = video["author"][0]["name"]["$t"]
-        date = DateTime.iso8601(video["published"]["$t"]).strftime("%F")
+      def info(id)
+        http_response = http.get(
+          "#{API_URL}/videos",
+          id: id,
+          part: "contentDetails,snippet,statistics",
+          key: config.api_key
+        )
+        return nil if http_response.status != 200
+        videos = MultiJson.load(http_response.body)["items"]
+        return nil if videos.empty?
+        video = videos[0]
+        title = video["snippet"]["title"]
+        uploader = video["snippet"]["channelTitle"]
+        date = DateTime.iso8601(video["snippet"]["publishedAt"]).strftime("%F")
 
         # Format time, only show hours if necessary
-        sec = video["media$group"]["yt$duration"]["seconds"].to_i
+        duration = ISO8601::Duration.new(video["contentDetails"]["duration"])
+        sec = duration.to_seconds.to_i
         min = sec / 60
         hr = min / 60
         time = "%d:%02d" % [min, sec%60]
@@ -59,7 +73,7 @@ module Lita
         end
 
         # Abbreviate view count, based on http://stackoverflow.com/a/2693484
-        n = video["yt$statistics"]["viewCount"].to_i
+        n = video["statistics"]["viewCount"].to_i
         i = 0
         while n >= 1e3 do
           n /= 1e3
@@ -67,8 +81,10 @@ module Lita
         end
         views = "%.#{n.to_s.length>3?1:0}f%s" % [n.round(1), " kMBT"[i]]
 
-        # Calculate rating, accounting for YouTube's 1-5 score range
-        rating = "%.f" % [(video.fetch("gd$rating", {}).fetch("average", 1) - 1) / 4 * 100]
+        # Calculate rating percentage
+        likes = video["statistics"]["likeCount"].to_f
+        dislikes = video["statistics"]["dislikeCount"].to_f
+        rating = "%.f" % (likes / (likes + dislikes) * 100)
 
         "#{title} [#{time}] by #{uploader} on #{date} (#{views.strip} views, #{rating}% liked)"
       end

data/lita-youtube-me.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-youtube-me"
-  spec.version       = "0.0.3"
+  spec.version       = "0.0.4"
   spec.authors       = ["Taylor Lapeyre"]
   spec.email         = ["taylorlapeyre@gmail.com"]
   spec.description   = %q{A Lita handler that replies with a youtube URL when given a query.}
@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "lita", ">= 4.0"
+  spec.add_runtime_dependency "iso8601", ">= 0.8.6"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/lita/handlers/youtube_me_spec.rb

@@ -1,6 +1,10 @@
 require "spec_helper"
 
 describe Lita::Handlers::YoutubeMe, lita_handler: true do
+  before do
+    registry.config.handlers.youtube_me.api_key = ENV["YOUTUBE_KEY"]
+  end
+
   it { is_expected.to route_command("youtube me something") }
   it { is_expected.to route_command("youtube me something").to(:find_video) }
 
@@ -57,4 +61,23 @@ describe Lita::Handlers::YoutubeMe, lita_handler: true do
     send_message("https://www.youtube.com/watch?v=nG7RiygTwR4")
     expect(replies.count).to eq 0
   end
+
+  it "does not send a message when the detected YouTube URL does not lead to a valid video" do
+    registry.config.handlers.youtube_me.detect_urls = true
+    send_message("https://www.youtube.com/watch?v=foo")
+    expect(replies.count).to eq 0
+  end
+
+  it "does not return a video in response to a query when the API key is invalid" do
+    registry.config.handlers.youtube_me.api_key = "this key doesn't work"
+    send_command("youtube me soccer")
+    expect(replies.count).to eq 0
+  end
+
+  it "does not display video info for detected YouTube URLs when the API key is invalid" do
+    registry.config.handlers.youtube_me.detect_urls = true
+    registry.config.handlers.youtube_me.api_key = "this key doesn't work"
+    send_message("https://www.youtube.com/watch?v=nG7RiygTwR4")
+    expect(replies.count).to eq 0
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-youtube-me
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Taylor Lapeyre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: iso8601
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement