cinch-toolbox 0.0.5 → 1.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+nguage: ruby
+rvm:
+  - ruby-head
+  - 1.9.2
+  - 1.9.3

data/README.md

@@ -1,5 +1,11 @@
 # Cinch Toolbox
 
+[![Gem Version](https://badge.fury.io/rb/cinch-toolbox.png)](http://badge.fury.io/rb/cinch-dicebag)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-toolbox.png)](https://gemnasium.com/bhaberer/cinch-dicebag)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-toolbox.png?branch=master)](https://travis-ci.org/bhaberer/cinch-dicebag)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-toolbox/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-dicebag?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-toolbox.png)](https://codeclimate.com/github/bhaberer/cinch-dicebag)
+
 This is just a gem required fro many of my plugins, it facilitates a variety of mundane operations.
 
 * URL Shortening / Expansion.
@@ -35,3 +41,12 @@ Or install it yourself as:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Changelog
+
+* 1.0.0
+    * Added tests!
+    * Added docs!
+    * Cleaned up code in `Toolbox.get_html_element` to be more error resistant
+    * Cleaned up code in `Toolbox.time_format` to be more concise.
+

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/cinch-toolbox.gemspec

@@ -17,6 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('nokogiri', '1.5.9')
-  gem.add_dependency('patron', '0.4.18')
+  gem.add_development_dependency  'rake'
+  gem.add_development_dependency  'rspec'
+  gem.add_development_dependency  'coveralls'
+  gem.add_development_dependency  'fakeweb',    '~> 1.3'
+
+  gem.add_dependency              'nokogiri',   '~> 1.5.9'
+  gem.add_dependency              'patron',     '~> 0.4.18'
 end

data/lib/cinch-toolbox.rb

@@ -6,19 +6,29 @@ require 'nokogiri'
 
 module Cinch
   module Toolbox
+
     # Get an element of the supplied website
-    def Toolbox.get_html_element(url, selector, mode = 'css')
+    # @param [String] url The url to access.
+    # @param [String] selector The the selector to try an acquire on the page.
+    # @param [String] mode (:css) Set his to css or xpath based on the type of selector.
+    # @return [String] The content ofg the Element or Nil if the element could not be found.
+    def Toolbox.get_html_element(url, selector, mode = :css)
       # Make sure the URL is legit
       url = URI::extract(url, ["http", "https"]).first
-
-      case mode
-      when 'css'
-        return Nokogiri::HTML(open(url)).css(selector).first.content
-      when 'xpath'
-        return Nokogiri::HTML(open(url)).xpath(selector).first
+      url = Nokogiri::HTML(open(url))
+      if url.send(mode.to_sym, selector).empty?
+        return nil
+      else
+        return url.send(mode.to_sym, selector).first.content
       end
+    rescue SocketError, RuntimeError
+      # Rescue for any kind of network sillyness
+      return nil
     end
 
+    # Get the title of a given web page.
+    # @param [String] url The url of the page you want the title from.
+    # @return [String] Either contents of the title element or a notion for an image.
     def Toolbox.get_page_title(url)
       # Make sure the URL is legit
       url = URI::extract(url, ["http", "https"]).first
@@ -26,63 +36,60 @@ module Cinch
       # If the link is to an image, extract the filename.
       if url.match(/\.jpg|jpeg|gif|png$/)
         # unless it's from reddit, then change the url to the gallery to get the image's caption.
-        if imgur_id = url.match(/https?:\/\/i\.imgur\.com.*\/([A-Za-z0-9]+)\.(jpg|jpeg|png|gif)/)[1]
+        if imgur_id = url[/https?:\/\/i\.imgur\.com.*\/([A-Za-z0-9]+)\.(jpg|jpeg|png|gif)/, 1]
           url = "http://imgur.com/#{imgur_id}"
         else
-          site = url.match(/\.([^\.]+\.[^\/]+)/)
+          site = url.match(/([^\.]+\.[^\/]+)/)
           return site.nil? ? "Image [#{url}]!!!" : "Image from #{site[1]}"
         end
       end
 
       # Grab the element, return nothing if  the site doesn't have a title.
-      page = Nokogiri::HTML(open(url)).css('title')
-      return page.first.content.strip.gsub(/\s+/, ' ') unless page.empty?
-    end
-
-    # Expand a previously shortened URL via the configured shortener
-    def Toolbox.expand(url)
-      shortener.get("forward.php?format=simple&shorturl=#{url}").body
+      title = Toolbox.get_html_element(url, 'title')
+      return title.strip.gsub(/\s+/, ' ') unless title.nil?
     end
 
     # Shorten a URL via the configured shortener
+    # @param [String] url The url of the page you want to shorten.
+    # @return [String] The shortened url.
     def Toolbox.shorten(url)
       return url if url.length < 45
       return shortener.get("create.php?format=simple&url=#{url}").body
     end
 
+    # Expand a previously shortened URL via the configured shortener
+    # @param [String] url A previously shortened url.
+    # @return [String] The expanded url.
+    def Toolbox.expand(url)
+      shortener.get("forward.php?format=simple&shorturl=#{url}").body
+    end
+
     # Truncate a given block of text, used for making sure the bot doesn't flood.
+    # @param [String] text The block of text to check.
+    # @param [Fixnum] length (250) length to which to constrain the block of text.
     def Toolbox.truncate(text, length = 250)
-      text = text.gsub(/\n/, ' · ')
+      text = text.gsub(/\n/, '  ')
       if text.length > length
-        text = text[0,length - 1] + '...'
+        text = text[0, (length - 3)] + '...'
       end
       return text
     end
 
     # Used to render a period of time in a uniform string.
     # There is probably a much better way to do this, so FIXME
+    # @param [Fixnum] secs Number of seconds to render into a string.
     def Toolbox.time_format(secs)
-      data = time_parse(secs)
-      string = ''
-
-      string << "#{data[:days]}d "  unless data[:days].zero?  && string == ''
-      string << "#{data[:hours]}h " unless data[:hours].zero? && string == ''
-      string << "#{data[:mins]}m "  unless data[:mins].zero?  && string == ''
-      string << "#{data[:secs]}s"
-
-      return string
-    end
-
-    def Toolbox.time_parse(secs)
-      days = secs / 86400
-      hours = (secs % 86400) / 3600
-      mins = (secs % 3600) / 60
-      secs = secs % 60
-
-      return { :days => days.floor,
-               :hours => hours.floor,
-               :mins => mins.floor,
-               :secs => secs.floor }
+      data = { :days  => (secs / 86400).floor,
+               :hours => ((secs % 86400) / 3600).floor,
+               :mins  => ((secs % 3600) / 60).floor,
+               :secs  => (secs % 60).floor }
+      string = []
+      data.keys.map do |period|
+        if period == :secs || !(data[period].zero? && string.empty?)
+          string << "#{data[period]}#{period.slice(0)}"
+        end
+      end
+      return string.join(' ')
     end
 
     private

data/lib/cinch-toolbox/version.rb

@@ -1,5 +1,5 @@
 module Cinch
   module Toolbox
-    VERSION = "0.0.5"
+    VERSION = "1.0.0"
   end
 end

data/spec/cinch-toolbox_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+require 'fakeweb'
+
+describe Cinch::Toolbox do
+
+  describe 'the get_html_element method' do
+    before(:all) do
+      FakeWeb.register_uri( :get, "http://example.com/",
+                            :body => "<div id='a1' class='top'>
+                                        <div class='foo'>Bar</div>
+                                        <div id='foo1'>Baz</div>
+                                      </div>")
+    end
+
+    it 'should return a string with contents of a css selector of a web page' do
+      Cinch::Toolbox.get_html_element('http://example.com/', '.foo', :css).
+        should == 'Bar'
+    end
+
+    it 'should return a string with contents of a xpath selector of a web page' do
+      Cinch::Toolbox.get_html_element('http://example.com/', "//div/div[1]", :xpath).
+        should == 'Bar'
+    end
+
+    it 'should return nil if the css element does not exist' do
+      Cinch::Toolbox.get_html_element('http://example.com/', '.foo2', :css).
+        should be_nil
+    end
+
+    it 'should return nil if the xpath element does not exist' do
+      Cinch::Toolbox.get_html_element('http://example.com/', "//div/div[3]", :xpath).
+        should be_nil
+    end
+
+    it 'should return nil if there is a problem finding the site' do
+      Cinch::Toolbox.get_html_element('http://baddurl.com/', '.foo2', :css).
+        should be_nil
+    end
+
+    it 'should return the page title if there is a http => https trasition' do
+      Cinch::Toolbox.get_html_element('http://github.com/bhaberer/', 'title', :css).
+        should include 'bhaberer (Brian Haberer)'
+    end
+
+    it 'should return nil if there is a https => http trasition' do
+      Cinch::Toolbox.get_html_element('https://www.amazon.com/', 'title', :css).
+        should be_nil
+    end
+  end
+
+  describe 'the get_page_title method' do
+    before(:all) do
+    end
+
+    it 'should return a page title for a given url' do
+      FakeWeb.register_uri( :get, "http://example.com/", :body => "<title>Page Title</table>")
+      Cinch::Toolbox.get_page_title("http://example.com/").
+        should == 'Page Title'
+    end
+
+    it 'should return Nil if a page is lacking a title' do
+      FakeWeb.register_uri( :get, "http://example.com/", :body => "<body>Page Title</body>")
+      Cinch::Toolbox.get_page_title("http://example.com/").
+        should be_nil
+    end
+
+    it 'should return an image title if a page is a supported image type' do
+      [:jpg, :jpeg, :gif, :png].each do |image|
+        Cinch::Toolbox.get_page_title("http://example.com/image.#{image}").
+          should == "Image from http://example.com"
+      end
+    end
+
+    it 'should return Nil if a page is lacking a title' do
+      Cinch::Toolbox.get_page_title("http://i.imgur.com/oMndYK7.jpg").
+        should == "Anybody with a cat will relate. - Imgur"
+    end
+  end
+
+  describe 'url shortening and expanding' do
+    it 'should shorten long urls' do
+      Cinch::Toolbox.shorten('http://en.wikipedia.org/wiki/Llanfairpwllgwyngyllgogerychwyrndrobwllllan').
+        should == "http://is.gd/PaUTII"
+    end
+
+    it 'should not shorten urls that are already short enough (< 45 cha)' do
+      Cinch::Toolbox.shorten('http://en.wikipedia.org/').
+        should == 'http://en.wikipedia.org/'
+    end
+
+    it 'should be able to expand shortened links' do
+      url = 'http://en.wikipedia.org/wiki/Llanfairpwllgwyngyll'
+      Cinch::Toolbox.expand(Cinch::Toolbox.shorten(url)).should == url
+    end
+  end
+
+  describe 'truncate method' do
+    it 'should truncate text past the limit' do
+      foo = String.new
+      1000.times { foo << 'a' }
+      Cinch::Toolbox.truncate(foo).length.should == 250
+    end
+
+    it 'should not truncate text within limit' do
+      foo = String.new
+      1000.times { foo << 'a' }
+      Cinch::Toolbox.truncate(foo, 100).length.should == 100
+    end
+  end
+
+  describe 'time parseing' do
+    it 'should parse seconds into a user friendly string' do
+      Cinch::Toolbox.time_format(126).
+        should == '2m 6s'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+require 'cinch-toolbox'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-toolbox
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,78 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.9
   type: :runtime
@@ -24,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.9
 - !ruby/object:Gem::Dependency
@@ -32,7 +96,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.18
   type: :runtime
@@ -40,7 +104,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.4.18
 description: A gem of various methods used in many of my plugins. If you need the
@@ -52,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -59,6 +124,8 @@ files:
 - cinch-toolbox.gemspec
 - lib/cinch-toolbox.rb
 - lib/cinch-toolbox/version.rb
+- spec/cinch-toolbox_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-toolbox
 licenses: []
 post_install_message: 
@@ -83,4 +150,7 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Common methods used in Cinch Plugins.
-test_files: []
+test_files:
+- spec/cinch-toolbox_spec.rb
+- spec/spec_helper.rb
+has_rdoc: