lita-freesound 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b23e876b8910271c12e9b70615822f84678ae0d8
+  data.tar.gz: 493f9331dce4fac957e5c8c368ecda793f5d75ac
+SHA512:
+  metadata.gz: f6278ce7043172532883a0a977f3eaa9de2829e0b7f099251cef6073e758dec29870beb00651c45e657ea4fbf85f718b58122c42a9e529107c8567265df2c8a5
+  data.tar.gz: 2db6dc05cb4957ff6bcb55d14c907fa45493340ea7ab56ce97c6df06bd38298dd5e81de441206ff2ac034490a5ec7b096de60415f4e57d30f9645997ef96793d

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Chadwick
+
+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,32 @@
+# lita-freesound
+
+`lita-freesound` is a [Lita](http://lita.io) handler that searches Freesound.org's multitudes of sounds and returns the top hit.
+
+## Installation
+
+Add lita-freesound to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-freesound"
+```
+
+## Configuration
+
+### Required attributes
+
+* `api_key` (String) - The bot's Freesound API key. Get one [here](http://www.freesound.org/apiv2/apply).
+
+### Testing
+
+To run rspec's tests, please add your Freesound API key to an environment variable called `FREESOUND_KEY`.
+
+## Usage
+
+```
+You: Lita, freesound cowbell
+Lita: Cowbell - http://www.freesound.org/data/previews/75/75338_708954-hq.mp3
+```
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

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-freesound.rb

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

data/lib/lita/handlers/freesound.rb

@@ -0,0 +1,56 @@
+require 'net/http'
+require 'json'
+
+module Lita
+  module Handlers
+    class Freesound < Handler
+      BASE_SEARCH_URL = "https://freesound.org/apiv2/search/text"
+      BASE_SOUND_URL = "https://freesound.org/apiv2/sounds"
+
+      config :api_key, type: String, required: true
+
+      route(/(freesound|fs)(\s)/i, :get_sound, command: true, help: {
+        "freesound SEARCH_TERM" => "Return the first Freesound search result for SEARCH_TERM"
+      })
+
+      def get_sound(response)
+        query = response.args.join("+")
+
+        api_token = Lita.config.handlers.freesound.api_key
+
+        query_string = "#{BASE_SEARCH_URL}/?query=#{query}&token=#{api_token}&format=json"
+        fs_search_response = Net::HTTP.get(
+          URI(query_string)
+        )
+
+        data = JSON.parse(fs_search_response)
+
+        if data['count']
+          if data['count'] > 0
+            results = data['results']
+
+            sound_id = results[0]['id']
+            sound_name = results[0]['name'].split('.')[0]
+
+            fs_sound_response = Net::HTTP.get(
+              URI("#{BASE_SOUND_URL}/#{sound_id}/?token=#{api_token}&format=json")
+            )
+
+            data = JSON.parse(fs_sound_response)
+
+            preview_url = data['previews']['preview-hq-mp3']
+
+            response.reply "#{sound_name} - #{preview_url}"
+          else
+            response.reply "No sounds match '#{query}'"
+          end
+        else
+          response.reply "Freesound request failed."
+          Lita.logger.error("Freesound request failed: #{response.inspect}.")
+        end
+      end
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lita-freesound.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-freesound"
+  spec.version       = "0.1.1"
+  spec.authors       = ["Michael Chadwick"]
+  spec.email         = ["michael.chadwick@gmail.com"]
+  spec.description   = %q{A Lita handler for interfacing with Freesound.org.}
+  spec.summary       = %q{A Lita handler for interfacing with Freesound.org.}
+  spec.homepage      = "https://github.com/michaelchadwick/lita-freesound"
+  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.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"
+end

data/locales/en.yml

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

data/spec/lita/handlers/freesound_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Lita::Handlers::Freesound, lita_handler: true do
+  before do
+    Lita.config.handlers.freesound.api_key = ENV['FREESOUND_KEY']
+  end
+
+  it { is_expected.to route_command("freesound rimshot").to(:get_sound) }
+  it { is_expected.to route_command("fs monkey").to(:get_sound) }
+  it { is_expected.to route_command("fs big old explosion").to(:get_sound) }
+
+  describe "#get_sound" do
+    it "responds with a link to the first query hit" do
+      send_command("freesound gear clink")
+      expect(replies.last).to match(/https:\/\/www.freesound.org\/data\/previews\/318\/318067_584239-hq.mp3/)
+    end
+
+    it "reports no results if search doesn't match anything" do
+      send_command("freesound -$3")
+      expect(replies.last).to match(/No sounds match/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-freesound"
+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,143 @@
+--- !ruby/object:Gem::Specification
+name: lita-freesound
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael Chadwick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-15 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
+description: A Lita handler for interfacing with Freesound.org.
+email:
+- michael.chadwick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/lita-freesound.rb
+- lib/lita/handlers/freesound.rb
+- lita-freesound.gemspec
+- locales/en.yml
+- spec/lita/handlers/freesound_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/michaelchadwick/lita-freesound
+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.6.1
+signing_key: 
+specification_version: 4
+summary: A Lita handler for interfacing with Freesound.org.
+test_files:
+- spec/lita/handlers/freesound_spec.rb
+- spec/spec_helper.rb