lita-googl 0.0.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: f18e162741217c9f74b86a7a59d7a0ccb96fa1cf
4
+ data.tar.gz: d095678501775850b9e80cb20ef71e61424fc566
5
+ SHA512:
6
+ metadata.gz: 762eef3f143eb1316192b94984128694fc4169d7a5408e481c623a715d1ad3a9a82c8e998ef2be2477f47bbd7c7b8b2afc7b586bb697a08d6743f2987a33ca98
7
+ data.tar.gz: c7f04a6e4fc2f7bec5fffeeff0713421e04f9a2b623b59f5cde0b996862e1e044c79be9d9fbcfaf06fa85ad762ea088fa9e8a63a2c13a07b735ef71be2a8191c
data/.gitignore ADDED
@@ -0,0 +1,17 @@
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
data/.travis.yml ADDED
@@ -0,0 +1,8 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.0.0
4
+ script: bundle exec rake
5
+ before_install:
6
+ - gem update --system
7
+ services:
8
+ - redis-server
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
data/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # lita-googl
2
+
3
+ [![Build Status](https://travis-ci.org/myovchev/lita-googl.png?branch=master)](https://travis-ci.org/myovchev/lita-googl)
4
+ [![Coverage Status](https://coveralls.io/repos/myovchev/lita-googl/badge.svg?branch=master)](https://coveralls.io/r/myovchev/lita-googl?branch=master)
5
+
6
+ **lita-googl** is a handler for [Lita][lita] that shortens URLs
7
+ via [URL Shortener API][googl-dev]
8
+
9
+ ## Installation
10
+
11
+ Add lita-googl to your Lita instance's Gemfile:
12
+
13
+ ``` ruby
14
+ gem "lita-googl"
15
+ ```
16
+
17
+ ## Configuration
18
+
19
+ Add the configuration lines (listed below) to your application `lita_config.rb`
20
+
21
+ * `config.handlers.googl.api_key="YOUR_API_KEY"`
22
+ * Get a **Public API access** key from [Google Developer Console][google-console]
23
+ and replace the `YOUR_API_KEY` above.
24
+ * More detailed information about [Google Public API key][google-pauth]
25
+
26
+ ### Secure it
27
+
28
+ You may "hide" your API key from the application config like this
29
+ `config.handlers.googl.api_key=ENV['GOOGL_API_KEY']` and in your terminal
30
+
31
+ ```shell
32
+ $ GOOGL_API_KEY=XXXXXXXX
33
+ $ export GOOGL_API_KEY
34
+ $ # Ensure it's there
35
+ $ echo $GOOGL_API_KEY
36
+ XXXXXXXX
37
+ ```
38
+
39
+ ## Usage
40
+
41
+ ```
42
+ 22:55 <SecretR> ZaraRobo google http://zaralab.org/
43
+ 22:55 <ZaraRobo> SecretR http://goo.gl/x5PsTf
44
+ ```
45
+
46
+
47
+ [lita]: http://lita.io/ "A robot companion for your company's chat room"
48
+ [googl-dev]: https://developers.google.com/url-shortener/ "The Google URL Shortener at goo.gl"
49
+ [google-pauth]: https://developers.google.com/url-shortener/v1/getting_started#APIKey
50
+ [google-console]: https://console.developers.google.com/ "Google Developer Console"
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
data/lib/lita-googl.rb ADDED
@@ -0,0 +1,2 @@
1
+ require "lita"
2
+ require "lita/handlers/googl"
@@ -0,0 +1,31 @@
1
+ require 'googl'
2
+
3
+ module Lita
4
+ module Handlers
5
+
6
+ class GooglError < StandardError; end
7
+ #class RequestError < GooglError; end
8
+ #class UnknownAPIError < GooglError; end
9
+
10
+ class Googl < Handler
11
+ config :api_key, type: String, required: true
12
+
13
+ route %r{^googl\s+(.\S+)$}i, :googl, command: true, help: {
14
+ 'googl' => 'Shorten original or expand shortened URL.'
15
+ }
16
+
17
+ def googl(response)
18
+ url = response.matches[0][0]
19
+ raise GooglError if url.nil?
20
+
21
+ api_key = Lita.config.handlers.googl.api_key
22
+ log.debug("Googl Input URL - #{url}")
23
+
24
+ result = ::Googl.shorten(url, nil, api_key)
25
+ response.reply("#{response.user.mention_name}: #{result.short_url}")
26
+ end
27
+ end
28
+
29
+ Lita.register_handler(Googl)
30
+ end
31
+ end
@@ -0,0 +1,27 @@
1
+ Gem::Specification.new do |spec|
2
+ spec.name = "lita-googl"
3
+ spec.version = "0.0.1"
4
+ spec.authors = ["Miroslav Yovchev"]
5
+ spec.email = ["m.yovchev@corllete.com"]
6
+ spec.description = %q(Lita handler - shorten URL via Google URL Shortener API)
7
+ spec.summary = %q(Lita handler - shorten URL via Google URL Shortener API)
8
+ spec.homepage = "https://github.com/myovchev/lita-googl"
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.3"
18
+ spec.add_runtime_dependency "googl", "< 1.0"
19
+
20
+ spec.add_development_dependency "bundler", "~> 1.3"
21
+ spec.add_development_dependency "pry-byebug"
22
+ spec.add_development_dependency "rake"
23
+ spec.add_development_dependency "rack-test"
24
+ spec.add_development_dependency "rspec", ">= 3.0.0"
25
+ spec.add_development_dependency "simplecov"
26
+ spec.add_development_dependency "coveralls"
27
+ end
@@ -0,0 +1,40 @@
1
+ require "spec_helper"
2
+
3
+ describe Lita::Handlers::Googl, lita_handler: true do
4
+
5
+ it { is_expected.to route_command("googl http://google.com").to(:googl) }
6
+
7
+ it "should do nothing on invalid request" do
8
+ send_command("googl ")
9
+ expect(replies.last).to be_nil
10
+ end
11
+
12
+ let(:shorten) { instance_double("::Googl::Shorten") }
13
+
14
+ before do
15
+ registry.config.handlers.googl do |config|
16
+ config.api_key = "APIKEY"
17
+ end
18
+
19
+ allow(::Googl::Shorten).to receive(:new).and_return(shorten)
20
+ end
21
+
22
+ it "should send shorten request" do
23
+ long_url = 'http://zaralab.org/'
24
+ short_url = 'http://goo.gl/x5PsTf'
25
+
26
+ short = ::Googl::Shorten.new
27
+ allow(short).to receive(:short_url).and_return(short_url)
28
+ allow(short).to receive(:long_url).and_return(long_url)
29
+
30
+ allow(::Googl).to receive(:shorten).with(
31
+ long_url,
32
+ nil,
33
+ registry.config.handlers.googl.api_key,
34
+ ).and_return(shorten)
35
+
36
+ user1 = Lita::User.create(123, name: "user1", mention_name: 'user1')
37
+ send_command("googl #{long_url}", as: user1)
38
+ expect(replies.last).to eq("#{user1.name}: #{short_url}")
39
+ end
40
+ end
@@ -0,0 +1,15 @@
1
+ require "simplecov"
2
+ require "coveralls"
3
+ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
4
+ SimpleCov::Formatter::HTMLFormatter,
5
+ Coveralls::SimpleCov::Formatter
6
+ ]
7
+ SimpleCov.start { add_filter "/spec/" }
8
+
9
+ require "lita-googl"
10
+ require "lita/rspec"
11
+ require "googl"
12
+
13
+ # A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
14
+ # was generated with Lita 4, the compatibility mode should be left disabled.
15
+ Lita.version_3_compatibility_mode = false
metadata ADDED
@@ -0,0 +1,183 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: lita-googl
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Miroslav Yovchev
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-05-16 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.3'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '4.3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: googl
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "<"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "<"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.3'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.3'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry-byebug
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: rake
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: rack-test
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: 3.0.0
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: 3.0.0
111
+ - !ruby/object:Gem::Dependency
112
+ name: simplecov
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: coveralls
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ description: Lita handler - shorten URL via Google URL Shortener API
140
+ email:
141
+ - m.yovchev@corllete.com
142
+ executables: []
143
+ extensions: []
144
+ extra_rdoc_files: []
145
+ files:
146
+ - ".gitignore"
147
+ - ".travis.yml"
148
+ - Gemfile
149
+ - README.md
150
+ - Rakefile
151
+ - lib/lita-googl.rb
152
+ - lib/lita/handlers/googl.rb
153
+ - lita-googl.gemspec
154
+ - spec/lita/handlers/googl_spec.rb
155
+ - spec/spec_helper.rb
156
+ homepage: https://github.com/myovchev/lita-googl
157
+ licenses:
158
+ - MIT
159
+ metadata:
160
+ lita_plugin_type: handler
161
+ post_install_message:
162
+ rdoc_options: []
163
+ require_paths:
164
+ - lib
165
+ required_ruby_version: !ruby/object:Gem::Requirement
166
+ requirements:
167
+ - - ">="
168
+ - !ruby/object:Gem::Version
169
+ version: '0'
170
+ required_rubygems_version: !ruby/object:Gem::Requirement
171
+ requirements:
172
+ - - ">="
173
+ - !ruby/object:Gem::Version
174
+ version: '0'
175
+ requirements: []
176
+ rubyforge_project:
177
+ rubygems_version: 2.4.6
178
+ signing_key:
179
+ specification_version: 4
180
+ summary: Lita handler - shorten URL via Google URL Shortener API
181
+ test_files:
182
+ - spec/lita/handlers/googl_spec.rb
183
+ - spec/spec_helper.rb