lita-google-images 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3d9a71b531642fd0dbf1a9e84488fd8474c8e1a
-  data.tar.gz: 8a479aa429d9217b6c32786dfcfa48d0a80899a5
+  metadata.gz: c4bc36412c0c5156ab0ffed74fe5fbcdff1e23d5
+  data.tar.gz: 96e450e761edcdf46b67eac2bd56b8156718cf87
 SHA512:
-  metadata.gz: 31884376917a510d9682a390861a65ed6e950cf640197d6240dc11018708df8e7c844b90577d40efa7dafaf050d355db11d828042d134fa06db594a6bb9467ca
-  data.tar.gz: 34ef2fde97127a128d0f661180b51ad1eb13ae500e398049db911831abc117dabc5bd3748eaa0a4082f4e5b2e5822e5d5ffb9c67c96c754da1cba17626b76b0b
+  metadata.gz: 2fbcff89238256c8e7022f49542956aba93dbed8e23d4a54d453d5832551b3a73e6bc306de89fac4b898704e914fa55510cfe71ea56cb63705b2afef19d63617
+  data.tar.gz: 5839266460ac7db8b237edb1513ec48893f5a4d471d0e13ac6ab56b02586392c544d09ece53b6f42b6e3b22cc4a6acb77e02b38e53e8479a96dfc82d9204c219

data/.travis.yml

@@ -1,13 +1,16 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 2.0.0
 script: bundle exec rspec
 before_install:
   - gem update --system
+  - gem update bundler
 services:
   - redis-server
 notifications:
   email: false
   webhooks:
     urls:
-      - https://lita-freenode.herokuapp.com/travis
+      - http://util.perceptes.com:8080/travis

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Jimmy Cuadra
+Copyright (c) 2013-2015 Jimmy Cuadra
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -16,9 +16,16 @@ gem "lita-google-images"
 
 ## Configuration
 
+### Required attributes
+
+```
+* `google_cse_id` (String) - ID of the Google Custom Search account to use.
+* `google_cse_key` (String) - API key for the Google Custom Search account.
+```
+
 ### Optional attributes
 
-* `safe_search` (String, Symbol) - The safe search setting to use when querying for images. Possible values are `:active`, `:moderate`, and `:off`. Default: `:active`.
+* `safe_search` (String, Symbol) - The safe search setting to use when querying for images. Possible values are `:high`, `:medium`, and `:off`. Default: `:high`.
 
 ### Example
 

data/lib/lita/handlers/google_images.rb

@@ -3,18 +3,21 @@ require "lita"
 module Lita
   module Handlers
     class GoogleImages < Handler
-      URL = "https://ajax.googleapis.com/ajax/services/search/images"
-      VALID_SAFE_VALUES = %w(active moderate off)
+      URL = "https://www.googleapis.com/customsearch/v1"
+      VALID_SAFE_VALUES = %w(high medium off)
 
-      config :safe_search, types: [String, Symbol], default: :active do
+      config :safe_search, types: [String, Symbol], default: :high do
         validate do |value|
           unless VALID_SAFE_VALUES.include?(value.to_s.strip)
-            "valid values are :active, :moderate, or :off"
+            "valid values are :high, :medium, or :off"
           end
         end
       end
 
-      route(/(?:image|img)(?:\s+me)? (.+)/, :fetch, command: true, help: {
+      config :google_cse_id, type: String, required: true
+      config :google_cse_key, type: String, required: true
+
+      route(/(?:image|img)(?:\s+me)? (.+)/i, :fetch, command: true, help: {
         "image QUERY" => "Displays a random image from Google Images matching the query."
       })
 
@@ -24,22 +27,26 @@ module Lita
         http_response = http.get(
           URL,
           v: "1.0",
+          searchType: 'image',
           q: query,
           safe: config.safe_search,
-          rsz: 8
+          fields: 'items(link)',
+          rsz: 8,
+          cx: config.google_cse_id,
+          key: config.google_cse_key
         )
 
         data = MultiJson.load(http_response.body)
 
-        if data["responseStatus"] == 200
-          choice = data["responseData"]["results"].sample
+        if http_response.status == 200
+          choice = data["items"].sample if data["items"]
           if choice
-            response.reply ensure_extension(choice["unescapedUrl"])
+            response.reply ensure_extension(choice["link"])
           else
             response.reply %{No images found for "#{query}".}
           end
         else
-          reason = data["responseDetails"] || "unknown error"
+          reason = data["error"]["message"] || "unknown error"
           Lita.logger.warn(
             "Couldn't get image from Google: #{reason}"
           )

data/lita-google-images.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-google-images"
-  spec.version       = "2.0.0"
+  spec.version       = "3.0.0"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{A Lita handler for fetching images from Google.}

data/spec/lita/handlers/google_images_spec.rb

@@ -5,76 +5,85 @@ describe Lita::Handlers::GoogleImages, lita_handler: true do
   it { is_expected.to route_command("image foo").to(:fetch) }
   it { is_expected.to route_command("img foo").to(:fetch) }
   it { is_expected.to route_command("img me foo").to(:fetch) }
+  it { is_expected.to route_command("IMAGE FOO").to(:fetch) }
 
   describe "#foo" do
-    let(:response) { double("Faraday::Response") }
+    let(:response) { double("Faraday::Response", status: 200,) }
+    let(:fail_response) { double("Faraday::Response", status: 500) }
 
-    before do
-      allow_any_instance_of(
-        Faraday::Connection
-      ).to receive(:get).and_return(response)
-    end
+    context "Success" do
+      before do
+        allow_any_instance_of(
+          Faraday::Connection
+        ).to receive(:get).and_return(response)
+      end
 
-    it "replies with a matching image URL on success" do
-      allow(response).to receive(:body).and_return(<<-JSON.chomp
+      it "replies with a matching image URL on success" do
+        allow(response).to receive(:body).and_return(<<-JSON.chomp
 {
-  "responseStatus": 200,
-  "responseData": {
-    "results": [
-      {
-        "unescapedUrl": "http://www.example.com/path/to/an/image"
-      }
-    ]
-  }
+  "items": [
+    {
+      "link": "http://www.example.com/path/to/an/image"
+    }
+  ]
 }
 JSON
-      )
-      send_command("image carl")
-      expect(replies.last).to eq(
-        "http://www.example.com/path/to/an/image#.png"
-      )
-    end
+        )
+        send_command("image carl")
+        expect(replies.last).to eq(
+          "http://www.example.com/path/to/an/image#.png"
+        )
+      end
 
-    it "doesn't append a fake file extension if the image URL has a common image extension" do
-      allow(response).to receive(:body).and_return(<<-JSON.chomp
+      it "doesn't append a fake file extension if the image URL has a common image extension" do
+        allow(response).to receive(:body).and_return(<<-JSON.chomp
 {
-  "responseStatus": 200,
-  "responseData": {
-    "results": [
-      {
-        "unescapedUrl": "http://www.example.com/path/to/an/image.jpg"
-      }
-    ]
-  }
+  "items": [
+    {
+      "link": "http://www.example.com/path/to/an/image.jpg"
+    }
+  ]
 }
 JSON
-      )
-      send_command("image carl")
-      expect(replies.last).to eq(
-        "http://www.example.com/path/to/an/image.jpg"
-      )
-    end
+        )
+        send_command("image carl")
+        expect(replies.last).to eq(
+          "http://www.example.com/path/to/an/image.jpg"
+        )
+      end
 
-    it "replies that no images were found if the results are empty" do
-      allow(response).to receive(:body).and_return(<<-JSON.chomp
-{"responseStatus": 200, "responseData": { "results": [] } }
+      it "replies that no images were found if the results are empty" do
+        allow(response).to receive(:body).and_return(<<-JSON.chomp
+{"items": [] }
 JSON
-      )
-      send_command("image carl")
-      expect(replies.last).to eq(%{No images found for "carl".})
+        )
+        send_command("image carl")
+        expect(replies.last).to eq(%{No images found for "carl".})
+      end
     end
 
-    it "logs a warning on failure" do
-      allow(response).to receive(:body).and_return(<<-JSON.chomp
+    context "Failure" do
+      before do
+        allow_any_instance_of(
+          Faraday::Connection
+        ).to receive(:get).and_return(fail_response)
+      end
+
+      it "logs a warning on failure" do
+        allow(fail_response).to receive(:body).and_return(<<-JSON.chomp
 {
-  "responseStatus": 500,
-  "responseDetails": "google fail"
+  "error":
+    {
+      "code": 500,
+      "message": "google fail"
+    }
 }
 JSON
-      )
-      expect(Lita.logger).to receive(:warn).with(/google fail/)
-      send_command("image carl")
-      expect(replies).to be_empty
+        )
+        expect(Lita.logger).to receive(:warn).with(/google fail/)
+        send_command("image carl")
+        expect(replies).to be_empty
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-google-images
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A Lita handler for fetching images from Google.