lita-urban-dictionary 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 323a8f255dee327849a89352508f56af535d2d3a
-  data.tar.gz: f2f7fbe6591cc4f1707e3ab5e0179386111178ac
+  metadata.gz: 7167246d1e220c391d201369c8e7b2d26cc18d9a
+  data.tar.gz: b555175ce6e7de9e78fa7c3dcf92e477542a4f23
 SHA512:
-  metadata.gz: 044c6ae27ec921c9719b4a68da759647eec10d1b0a92883d24b99d7ae371bbfbfafff14e8e8a0270cad5092a476f1c3f434764af60b5c8aa9b33e1741fbdc185
-  data.tar.gz: d0da7847d0c7248669c9b6afa1e9921c05325342969ad911e020e0627e1fff66b6d4551b7cd958ac7e620c33aeeb1ba7d07663ed727f2ed2636c34207bc7d91a
+  metadata.gz: 58d9c92c22ae343ffec0c33ca987a3cf888f758dbc3000a45d2b203b437b127fdf486bf71906afb5f1273b350e71b4bfeb24b2197911ec2a10120af7b3c89b6f
+  data.tar.gz: efd09970015c2b943c07066fa084d221bb0341ea688a179416d3961957044a56ed8078913b47ea19cdd8ea9878af2b4eb68d3b21e7a681909100cc02561c5749

data/README.md

@@ -14,6 +14,23 @@ Add lita-urban-dictionary to your Lita instance's Gemfile:
 gem "lita-urban-dictionary"
 ```
 
+## Configuration
+
+### Optional attributes
+
+* **max_response_size** (`Integer` || `nil`) - Sets a ceiling on the response size of the queried defintion. Default: `20` (20 lines of text).  `nil` will set no ceiling on responses.
+
+### Example
+
+This example configuration sets a max response size of 5 lines.
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.urban_dictionary.max_response_size = 5
+end
+```
+
+>>>>>>> d050f60... Add max_response_size to config, add corresponding tests, handle case of nil values, document chages in README.
 ## Usage
 
 To get the definition of a word:

data/lib/lita/handlers/urban_dictionary.rb

@@ -4,6 +4,8 @@ module Lita
   module Handlers
     # Looks up words on Urban Dictionary.
     class UrbanDictionary < Handler
+      config :max_response_size, types: [Integer, nil], default: 20
+
       route(
         /^(?:ud|urban\s*dictionary)(?:\s+me)? (.+)/,
         :define,
@@ -17,8 +19,12 @@ module Lita
         term = response.matches[0][0]
         word, definition, example = fetch_definition(term)
         if word
-          lines = "#{word}: #{definition}".split("\n")
-          lines << "Example: #{example}" if example
+          lines = "#{word}: #{definition}".split(/\r?\n/)
+          if example
+            example_lines = example.split(/\r?\n/)
+            example_lines[0] = "Example: #{example_lines.first}"
+            lines.concat(example_lines)
+          end
           message = message_from_lines(lines, term)
           response.reply(message)
         else
@@ -43,9 +49,19 @@ module Lita
         end
       end
 
+      def determine_max_size(lines)
+        if config.max_response_size.nil?
+          max_size = lines.size
+        else
+          max_size = config.max_response_size - 1
+        end
+        max_size
+      end
+
       def message_from_lines(lines, term)
-        if lines.size > 20
-          lines = lines[0..19]
+        max_size = determine_max_size(lines)
+        if lines.size > max_size
+          lines = lines[0..max_size]
           lines << <<-TRUNCATION_MESSAGE.chomp
 Read the entire definition at: http://www.urbandictionary.com/define.php?term=#{URI.encode(term)}
           TRUNCATION_MESSAGE

data/lita-urban-dictionary.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-urban-dictionary"
-  spec.version       = "1.0.0"
+  spec.version       = "1.1.0"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{A Lita handler for fetching definitions from Urban Dictionary.}

data/spec/lita/handlers/urban_dictionary_spec.rb

@@ -24,12 +24,18 @@ earth.","thumbs_up":565,"thumbs_down":141,"current_vote":""}]}}
 
     let(:json_large) do
       %Q{{"list":[{"defid":1369633,"word":"robot","author":"Ralius","permalink"\
-:"http://robot.urbanup.com/1369633","definition":"#{large_string}","thumbs_up":565,\
-"thumbs_down":141,"current_vote":""}]}}
+:"http://robot.urbanup.com/1369633","definition":"#{large_string}","example":\
+"#{large_string}","thumbs_up":565,"thumbs_down":141,"current_vote":""}]}}
+    end
+
+    let(:json_large_example) do
+      %Q{{"list":[{"defid":1369633,"word":"robot","author":"Ralius","permalink"\
+:"http://robot.urbanup.com/1369633","definition":"scariest fucking thing on earth.","example":\
+"#{large_string}","thumbs_up":565,"thumbs_down":141,"current_vote":""}]}}
     end
 
     let(:large_string) do
-      30.times.map { |n| "#{n}" }.join("\\n")
+      30.times.map { |n| "#{n}" }.join("\\r\\n")
     end
 
     before do
@@ -57,7 +63,7 @@ DEF
       expect(replies.last).to eq("robot: scariest fucking thing on earth.")
     end
 
-    it "truncates responses at 20 lines" do
+    it "truncates responses at 20 lines when the definition is very long" do
       response = double("Faraday::Response", status: 200, body: json_large)
       allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(response)
       send_command("ud lita bot")
@@ -65,6 +71,14 @@ DEF
       expect(replies.last).to include("http://www.urbandictionary.com/define.php?term=lita%20bot")
     end
 
+    it "truncates responses at 20 lines when the example is very long" do
+      response = double("Faraday::Response", status: 200, body: json_large_example)
+      allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(response)
+      send_command("ud lita bot")
+      expect(replies.last.split("\n").size).to eq(21)
+      expect(replies.last).to include("http://www.urbandictionary.com/define.php?term=lita%20bot")
+    end
+
     it "responds with a warning if no definition was found" do
       response = double("Faraday::Response", status: 200, body: "{}")
       allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(
@@ -82,5 +96,23 @@ DEF
       send_command("ud bar")
       expect(replies.last).to eq("No definition found for bar.")
     end
+
+    it "truncates responses according to the user-defined max_repsonse_size in the handler config" do
+      registry.config.handlers.urban_dictionary.max_response_size = 10
+      response = double("Faraday::Response", status: 200, body: json_large)
+      allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(response)
+      send_command("ud lita bot")
+      expect(replies.last.split("\n").size).to eq(11)
+      expect(replies.last).to include("http://www.urbandictionary.com/define.php?term=lita%20bot")
+    end
+
+    it "does not truncate responses if the user-defined max_repsonse_size is set to nil" do
+      registry.config.handlers.urban_dictionary.max_response_size = nil
+      response = double("Faraday::Response", status: 200, body: json_large)
+      allow_any_instance_of(Faraday::Connection).to receive(:get).and_return(response)
+      send_command("ud lita bot")
+      expect(replies.last.split("\n").size).to eq(60)
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-urban-dictionary
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -107,6 +107,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- dump.rdb
 - lib/lita-urban-dictionary.rb
 - lib/lita/handlers/urban_dictionary.rb
 - lita-urban-dictionary.gemspec
@@ -133,10 +134,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Lita handler for fetching definitions from Urban Dictionary.
 test_files:
 - spec/lita/handlers/urban_dictionary_spec.rb
 - spec/spec_helper.rb
+has_rdoc: