lita-danish-image-search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a38389213d86d449c77ea4b59dc3ed8b22214b693a1a040fa34f45f0557cb8fb
+  data.tar.gz: 153b377ac54536e86c4b9a37db12158d2290715486b3e98628ccd110029a965e
+SHA512:
+  metadata.gz: 708acb2623456515ae77a98968b24cb66937c6eb6e5feddda18683f326e34688034d37ccec0eac101031e3e2ed9e665238acd796a8acf211f719982d597d11dc
+  data.tar.gz: 3b36e2e0a27fd3d279ead973aeec13dd5f16e92f9f12abdc41fe136318ff4018eba89d1b77efa8a8d0de58cd5a17aba696d7cb90cf1e7d7b52bee626546445b1

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,22 @@
+# lita-danish-image-search
+
+[![Build Status](https://travis-ci.org/danishsarwr/lita-danish-image-search.png?branch=master)](https://travis-ci.org/danishsarwr/lita-danish-image-search)
+[![Coverage Status](https://coveralls.io/repos/danishsarwr/lita-danish-image-search/badge.png)](https://coveralls.io/r/danishsarwr/lita-danish-image-search)
+
+TODO: Add a description of the plugin.
+
+## Installation
+
+Add lita-danish-image-search to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-danish-image-search"
+```
+
+## Configuration
+
+TODO: Describe any configuration attributes the plugin exposes.
+
+## Usage
+
+TODO: Describe the plugin's features and how to use them.

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/danish_image_search.rb

@@ -0,0 +1,87 @@
+module Lita
+  module Handlers
+    class DanishImageSearch < Handler
+      # insert handler code here
+ 	URL = "https://www.googleapis.com/customsearch/v1"
+      	VALID_SAFE_VALUES = %w(high medium off)
+
+      config :safe_search, types: [String, Symbol], default: :high do
+       validate do |value|
+        unless VALID_SAFE_VALUES.include?(value.to_s.strip)
+      "valid values are :high, :medium, or :off"
+       end
+        end
+         end
+
+      route(/(?:image|img)(?:\s+me)? (.+)/i, :fetch, command: true, help: {
+        "image QUERY" => "Displays a random image from Google Images matching the query."
+      })
+
+      route(/(?:animate|gif)(?:\s+me)? (.+)/i, :fetch_anim, command: true, help: {
+        "animate QUERY" => "Displays a random animation from Google Images matching the query."
+      })
+
+      def fetch_anim(response)
+        fetch(response, true)
+      end
+
+      def fetch(response, animated = false)
+        query = response.matches[0][0]
+
+  query_params = {
+          v: "1.0",
+          searchType: 'image',
+          q: query,
+          safe: config.safe_search,
+          fields: 'items(link)',
+          rsz: 8,
+          cx: 'a0ee38aab0d0f7bcc',
+          key: 'AIzaSyDyY2ijQCoSf9z5rqaE2aeKX9Ul-pEUnWQ'
+        }
+
+        if animated
+          animated_params = {
+            fileType: "gif",
+            hq: "animated",
+            tbs: "itp:animated"
+          }
+          query_params.merge!(animated_params)
+        end
+
+        http_response = http.get(
+          URL,
+          query_params
+        )
+
+        data = MultiJson.load(http_response.body)
+
+        if http_response.status == 200
+  choice = data["items"].sample if data["items"]
+          if choice
+            response.reply ensure_extension(choice["link"])
+          else
+            response.reply %{No images found for "#{query}".}
+          end
+        else
+          reason = data["error"]["message"] || "unknown error"
+          Lita.logger.warn(
+            "Couldn't get image from Google: #{reason}"
+          )
+        end
+      end
+
+      private
+
+      def ensure_extension(url)
+        if [".gif", ".jpg", ".jpeg", ".png"].any? { |ext| url.end_with?(ext) }
+          url
+        else
+          "#{url}#.png"
+        end
+      end
+    end
+
+      Lita.register_handler(DanishImageSearch)
+
+  end
+end

data/lib/lita-danish-image-search.rb

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

data/lita-danish-image-search.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-danish-image-search"
+  spec.version       = "0.1.0"
+  spec.authors       = ["danishsarwr"]
+  spec.email         = ["danishsarwr@gmail.com"]
+  spec.description   = "A lita Image Search bot that returns the Image search results "
+  spec.summary       = "Final Project for UCAS SIAT for the course Intelligent Software Engineering"
+  spec.homepage      = "https://github.com/danishsarwr/danish-imagesearch.git"
+  spec.license       = "Any"
+  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.0"
+
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      danish_image_search:

data/spec/lita/handlers/danish_image_search_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe Lita::Handlers::DanishImageSearch, lita_handler: true do
+it { is_expected.to route_command("image me foo").to(:fetch) }
+  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", status: 200,) }
+    let(:fail_response) { double("Faraday::Response", status: 500) }
+
+    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
+{
+  "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
+
+      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
+{
+  "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
+
+      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".})
+      end
+
+
+
+
+      end
+    end
+
+    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
+{
+  "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
+      end
+    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-danish-image-search"
+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,170 @@
+--- !ruby/object:Gem::Specification
+name: lita-danish-image-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- danishsarwr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: pry-byebug
+  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: 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: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
+  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: 'A lita Image Search bot that returns the Image search results '
+email:
+- danishsarwr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/lita-danish-image-search.rb
+- lib/lita/handlers/danish_image_search.rb
+- lita-danish-image-search.gemspec
+- locales/en.yml
+- spec/lita/handlers/danish_image_search_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/danishsarwr/danish-imagesearch.git
+licenses:
+- Any
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Final Project for UCAS SIAT for the course Intelligent Software Engineering
+test_files:
+- spec/lita/handlers/danish_image_search_spec.rb
+- spec/spec_helper.rb