lita-freesound 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b23e876b8910271c12e9b70615822f84678ae0d8
4
+ data.tar.gz: 493f9331dce4fac957e5c8c368ecda793f5d75ac
5
+ SHA512:
6
+ metadata.gz: f6278ce7043172532883a0a977f3eaa9de2829e0b7f099251cef6073e758dec29870beb00651c45e657ea4fbf85f718b58122c42a9e529107c8567265df2c8a5
7
+ data.tar.gz: 2db6dc05cb4957ff6bcb55d14c907fa45493340ea7ab56ce97c6df06bd38298dd5e81de441206ff2ac034490a5ec7b096de60415f4e57d30f9645997ef96793d
data/.gitignore ADDED
@@ -0,0 +1,18 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
18
+ dump*
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Michael Chadwick
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,32 @@
1
+ # lita-freesound
2
+
3
+ `lita-freesound` is a [Lita](http://lita.io) handler that searches Freesound.org's multitudes of sounds and returns the top hit.
4
+
5
+ ## Installation
6
+
7
+ Add lita-freesound to your Lita instance's Gemfile:
8
+
9
+ ``` ruby
10
+ gem "lita-freesound"
11
+ ```
12
+
13
+ ## Configuration
14
+
15
+ ### Required attributes
16
+
17
+ * `api_key` (String) - The bot's Freesound API key. Get one [here](http://www.freesound.org/apiv2/apply).
18
+
19
+ ### Testing
20
+
21
+ To run rspec's tests, please add your Freesound API key to an environment variable called `FREESOUND_KEY`.
22
+
23
+ ## Usage
24
+
25
+ ```
26
+ You: Lita, freesound cowbell
27
+ Lita: Cowbell - http://www.freesound.org/data/previews/75/75338_708954-hq.mp3
28
+ ```
29
+
30
+ ## License
31
+
32
+ [MIT](http://opensource.org/licenses/MIT)
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
@@ -0,0 +1,12 @@
1
+ require "lita"
2
+
3
+ Lita.load_locales Dir[File.expand_path(
4
+ File.join("..", "..", "locales", "*.yml"), __FILE__
5
+ )]
6
+
7
+ require "lita/handlers/freesound"
8
+
9
+ Lita::Handlers::Freesound.template_root File.expand_path(
10
+ File.join("..", "..", "templates"),
11
+ __FILE__
12
+ )
@@ -0,0 +1,56 @@
1
+ require 'net/http'
2
+ require 'json'
3
+
4
+ module Lita
5
+ module Handlers
6
+ class Freesound < Handler
7
+ BASE_SEARCH_URL = "https://freesound.org/apiv2/search/text"
8
+ BASE_SOUND_URL = "https://freesound.org/apiv2/sounds"
9
+
10
+ config :api_key, type: String, required: true
11
+
12
+ route(/(freesound|fs)(\s)/i, :get_sound, command: true, help: {
13
+ "freesound SEARCH_TERM" => "Return the first Freesound search result for SEARCH_TERM"
14
+ })
15
+
16
+ def get_sound(response)
17
+ query = response.args.join("+")
18
+
19
+ api_token = Lita.config.handlers.freesound.api_key
20
+
21
+ query_string = "#{BASE_SEARCH_URL}/?query=#{query}&token=#{api_token}&format=json"
22
+ fs_search_response = Net::HTTP.get(
23
+ URI(query_string)
24
+ )
25
+
26
+ data = JSON.parse(fs_search_response)
27
+
28
+ if data['count']
29
+ if data['count'] > 0
30
+ results = data['results']
31
+
32
+ sound_id = results[0]['id']
33
+ sound_name = results[0]['name'].split('.')[0]
34
+
35
+ fs_sound_response = Net::HTTP.get(
36
+ URI("#{BASE_SOUND_URL}/#{sound_id}/?token=#{api_token}&format=json")
37
+ )
38
+
39
+ data = JSON.parse(fs_sound_response)
40
+
41
+ preview_url = data['previews']['preview-hq-mp3']
42
+
43
+ response.reply "#{sound_name} - #{preview_url}"
44
+ else
45
+ response.reply "No sounds match '#{query}'"
46
+ end
47
+ else
48
+ response.reply "Freesound request failed."
49
+ Lita.logger.error("Freesound request failed: #{response.inspect}.")
50
+ end
51
+ end
52
+
53
+ Lita.register_handler(self)
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,24 @@
1
+ Gem::Specification.new do |spec|
2
+ spec.name = "lita-freesound"
3
+ spec.version = "0.1.1"
4
+ spec.authors = ["Michael Chadwick"]
5
+ spec.email = ["michael.chadwick@gmail.com"]
6
+ spec.description = %q{A Lita handler for interfacing with Freesound.org.}
7
+ spec.summary = %q{A Lita handler for interfacing with Freesound.org.}
8
+ spec.homepage = "https://github.com/michaelchadwick/lita-freesound"
9
+ spec.license = "MIT"
10
+ spec.metadata = { "lita_plugin_type" => "handler" }
11
+
12
+ spec.files = `git ls-files`.split($/)
13
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
14
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
15
+ spec.require_paths = ["lib"]
16
+
17
+ spec.add_runtime_dependency "lita", ">= 4.0"
18
+
19
+ spec.add_development_dependency "bundler", "~> 1.3"
20
+ spec.add_development_dependency "pry-byebug"
21
+ spec.add_development_dependency "rake"
22
+ spec.add_development_dependency "rack-test"
23
+ spec.add_development_dependency "rspec", ">= 3.0.0"
24
+ end
data/locales/en.yml ADDED
@@ -0,0 +1,4 @@
1
+ en:
2
+ lita:
3
+ handlers:
4
+ freesound:
@@ -0,0 +1,23 @@
1
+ require "spec_helper"
2
+
3
+ describe Lita::Handlers::Freesound, lita_handler: true do
4
+ before do
5
+ Lita.config.handlers.freesound.api_key = ENV['FREESOUND_KEY']
6
+ end
7
+
8
+ it { is_expected.to route_command("freesound rimshot").to(:get_sound) }
9
+ it { is_expected.to route_command("fs monkey").to(:get_sound) }
10
+ it { is_expected.to route_command("fs big old explosion").to(:get_sound) }
11
+
12
+ describe "#get_sound" do
13
+ it "responds with a link to the first query hit" do
14
+ send_command("freesound gear clink")
15
+ expect(replies.last).to match(/https:\/\/www.freesound.org\/data\/previews\/318\/318067_584239-hq.mp3/)
16
+ end
17
+
18
+ it "reports no results if search doesn't match anything" do
19
+ send_command("freesound -$3")
20
+ expect(replies.last).to match(/No sounds match/)
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,6 @@
1
+ require "lita-freesound"
2
+ require "lita/rspec"
3
+
4
+ # A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
5
+ # was generated with Lita 4, the compatibility mode should be left disabled.
6
+ Lita.version_3_compatibility_mode = false
File without changes
metadata ADDED
@@ -0,0 +1,143 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lita-freesound
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - Michael Chadwick
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-03-15 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: lita
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '4.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '4.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: pry-byebug
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rack-test
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: 3.0.0
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: 3.0.0
97
+ description: A Lita handler for interfacing with Freesound.org.
98
+ email:
99
+ - michael.chadwick@gmail.com
100
+ executables: []
101
+ extensions: []
102
+ extra_rdoc_files: []
103
+ files:
104
+ - ".gitignore"
105
+ - Gemfile
106
+ - LICENSE
107
+ - README.md
108
+ - Rakefile
109
+ - lib/lita-freesound.rb
110
+ - lib/lita/handlers/freesound.rb
111
+ - lita-freesound.gemspec
112
+ - locales/en.yml
113
+ - spec/lita/handlers/freesound_spec.rb
114
+ - spec/spec_helper.rb
115
+ - templates/.gitkeep
116
+ homepage: https://github.com/michaelchadwick/lita-freesound
117
+ licenses:
118
+ - MIT
119
+ metadata:
120
+ lita_plugin_type: handler
121
+ post_install_message:
122
+ rdoc_options: []
123
+ require_paths:
124
+ - lib
125
+ required_ruby_version: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - ">="
128
+ - !ruby/object:Gem::Version
129
+ version: '0'
130
+ required_rubygems_version: !ruby/object:Gem::Requirement
131
+ requirements:
132
+ - - ">="
133
+ - !ruby/object:Gem::Version
134
+ version: '0'
135
+ requirements: []
136
+ rubyforge_project:
137
+ rubygems_version: 2.6.1
138
+ signing_key:
139
+ specification_version: 4
140
+ summary: A Lita handler for interfacing with Freesound.org.
141
+ test_files:
142
+ - spec/lita/handlers/freesound_spec.rb
143
+ - spec/spec_helper.rb