cinch-toolbox 1.0.3 → 1.1.0

data/README.md

@@ -1,10 +1,10 @@
-# Cinch Toolbox
+# 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)
+[![Gem Version](https://badge.fury.io/rb/cinch-toolbox.png)](http://badge.fury.io/rb/cinch-toolbox)
+[![Dependency Status](https://gemnasium.com/bhaberer/cinch-toolbox.png)](https://gemnasium.com/bhaberer/cinch-toolbox)
+[![Build Status](https://travis-ci.org/bhaberer/cinch-toolbox.png?branch=master)](https://travis-ci.org/bhaberer/cinch-toolbox)
+[![Coverage Status](https://coveralls.io/repos/bhaberer/cinch-toolbox/badge.png?branch=master)](https://coveralls.io/r/bhaberer/cinch-toolbox?branch=master)
+[![Code Climate](https://codeclimate.com/github/bhaberer/cinch-toolbox.png)](https://codeclimate.com/github/bhaberer/cinch-toolbox)
 
 This is just a gem required fro many of my plugins, it facilitates a variety of mundane operations.
 

data/cinch-toolbox.gemspec

@@ -4,18 +4,19 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cinch/toolbox/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "cinch-toolbox"
+  gem.name          = 'cinch-toolbox'
   gem.version       = Cinch::Toolbox::VERSION
-  gem.authors       = ["Brian Haberer"]
-  gem.email         = ["bhaberer@gmail.com"]
+  gem.authors       = ['Brian Haberer']
+  gem.email         = ['bhaberer@gmail.com']
   gem.description   = %q{A gem of various methods used in many of my plugins. If you need the namespace, let me know.}
   gem.summary       = %q{Common methods used in Cinch Plugins.}
-  gem.homepage      = "https://github.com/bhaberer/cinch-toolbox"
+  gem.homepage      = 'https://github.com/bhaberer/cinch-toolbox'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
   gem.add_development_dependency  'rake'
   gem.add_development_dependency  'rspec'

data/lib/cinch/toolbox.rb

@@ -5,125 +5,162 @@ require 'patron'
 require 'nokogiri'
 
 module Cinch
+  # Module for conveniance methods used in multiple Cinch plugins.
   module Toolbox
-
     # Get an element of the supplied website
     # @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 this to the kind of selection you want to do.
-    # @option [String] :mode :css Fetch just the text content at the css selector.
-    # @option [String] :mode :css_full Fetch the markup and text content at the css selector.
-    # @option [String] :mode :xpath Fetch just the text content at the xpath selector.
-    # @option [String] :mode :xpath_full Fetch the markup and text at the xpath 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)
+    # @param [String] mode (:css) Set this to the kind of selection you want to
+    #   do.
+    # @option [String] :mode :css Fetch just the text content at the css
+    #   selector.
+    # @option [String] :mode :css_full Fetch the markup and text content at
+    #   the css selector.
+    # @option [String] :mode :xpath Fetch just the text content at the
+    #   xpath selector.
+    # @option [String] :mode :xpath_full Fetch the markup and text at the
+    #   xpath selector.
+    # @return [String] The content ofg the Element or Nil if the element
+    #   could not be found.
+    def self.get_html_element(url, selector, mode = :css)
       # Make sure the URL is legit
-      url = URI::extract(url, ["http", "https"]).first
-      url = Nokogiri::HTML(open(url))
-
-      content = case mode
-                when :css, :xpath
-                  page = url.send(mode.to_sym, selector)
-                  page.first.content unless page.first.nil?
-                when :css_full, :xpath_full
-                  url.send("at_#{mode.to_s.gsub(/_full/, '')}", selector).to_html
-                end
-      return content
-    rescue SocketError, RuntimeError
-      # Rescue for any kind of network sillyness
-      return nil
+      url = Nokogiri.HTML(open(extract_url(url)))
+
+      case mode
+      when :css, :xpath
+        page = url.send(mode.to_sym, selector)
+        page.first.content unless page.first.nil?
+      when :css_full, :xpath_full
+        url.send("at_#{mode.to_s.gsub(/_full/, '')}", selector).to_html
+      end
+    # Rescue for any kind of network sillyness
+    rescue SocketError, RuntimeError, HTTPError
+      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)
+    # @return [String] Either contents of the title element or a notion
+    #   for an image.
+    def self.get_page_title(url)
       # Make sure the URL is legit
-      url = URI::extract(url, ["http", "https"]).first
-
-      # 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[/https?:\/\/i\.imgur\.com.*\/([A-Za-z0-9]+)\.(jpg|jpeg|png|gif)/, 1]
-          url = "http://imgur.com/#{imgur_id}"
-        else
-          site = url.match(/([^\.]+\.[^\/]+)/)
-          return site.nil? ? "Image [#{url}]!!!" : "Image from #{site[1]}"
-        end
-      end
+      url = extract_url(url)
 
-      # Grab the element, return nothing if  the site doesn't have a title.
-      title = Toolbox.get_html_element(url, 'title')
-      return title.strip.gsub(/\s+/, ' ') unless title.nil?
+      if url.match(/([^\s]+(\.(?i)(jpe?g|png|gif|bmp))$)/)
+        # If the link is to an image, extract the filename.
+        title = get_image_title(url)
+      else
+        # Grab the element, return nothing if  the site doesn't have a title.
+        title = Toolbox.get_html_element(url, 'title')
+      end
+      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)
+    def self.shorten(url)
       return url if url.length < 45
-      return shortener.get("create.php?format=simple&url=#{url}").body
+      uri = URI.parse("http://is.gd/create.php?format=simple&url=#{url}")
+      shortened = Net::HTTP.get(uri)
+      shortened if shortened.match(%r(https?://is.gd/))
     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
+    def self.expand(url)
+      uri = URI.parse("http://is.gd/forward.php?format=simple&shorturl=#{url}")
+      unshortened = Net::HTTP.get(uri)
+      unshortened unless unshortened.match(%r(https?://is.gd/))
     end
 
-    # Truncate a given block of text, used for making sure the bot doesn't flood.
+    # 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)
+    # @param [Fixnum] length (250) length to which to constrain the
+    #   block of text.
+    def self.truncate(text, length = 250)
       text = text.gsub(/\n/, '  ')
-      if text.length > length
-        text = text[0, (length - 3)] + '...'
-      end
-      return text
+      text = text[0, (length - 3)] + '...' if text.length > length
+      text
     end
 
-    # Simple check to make sure people are using a command via the main channel for plugins that 
-    #   require a channel for context.
-    def Toolbox.sent_via_private_message?(m, error = "You must use that command in the main channel.")
+    # Simple check to make sure people are using a command via the main channel
+    #   for plugins that require a channel for context.
+    def self.sent_via_private_message?(m, error = nil)
       return false unless m.channel.nil?
+      error = 'You must use that command in the main channel.' if error.nil?
       m.user.msg error
-      return true
+      true
     end
 
     # Used to render a period of time in a uniform string.
-    # There is probably a much better way to do this, so FIXME
+    # There is probably a much better way to do this
     # @param [Fixnum] secs Number of seconds to render into a string.
-    def Toolbox.time_format(secs, units = nil, format = :long)
-      data = { :days    => (secs / 86400).floor,
-               :hours   => ((secs % 86400) / 3600).floor,
-               :mins    => ((secs % 3600) / 60).floor,
-               :seconds => (secs % 60).floor }
-      string = []
-      data.keys.map do |period|
-        if period == :seconds || !(data[period].zero? && string.empty?)
-          if units.nil? || units.include?(period)
-            string << "#{data[period]}#{format == :long ? " #{period}" : period.slice(0)}"
-          end
-        end
-      end
-      return string.join(', ')
+    def self.time_format(secs, units = nil, format = :long)
+      time = build_time_hash(secs, units)
+      parse_time_hash(time, format)
+    end
+
+    # Extract the first url from a string
+    # @param [String] url String to parse URIs from.
+    # @return [URI] URI created from the url.
+    def self.extract_url(url)
+      extract_urls(url).first
+    end
+
+    # Extract the urls from a string
+    # @param [String] url String to parse URIs from.
+    # @return [Array] List of URIs created from the string.
+    def self.extract_urls(url)
+      URI.extract(url, %w(http https))
     end
 
     private
 
-    def Toolbox.shortener
-      short = Patron::Session.new
-      short.base_url = 'http://is.gd/'
-      return short
+    def self.get_image_title(url)
+      if url.match(/imgur/)
+        # Get the page title if it's imgur
+        imgur_image_title(url)
+      else
+        site = url[/([^\.]+\.[^\/]+)/, 1]
+        site.nil? ? "Image [#{url}]" : "Image from #{site}"
+      end
+    end
+
+    def self.imgur_image_title(url)
+      imgur_id = url[%r(https?://i\.imgur\.com.*/(\w+)\.(\D{3,4})), 1]
+      url = "http://imgur.com/#{imgur_id}"
+      Toolbox.get_html_element(url, 'title')
     end
 
+    def self.build_time_hash(secs, units)
+      { days:     (secs / 86_400).floor,
+        hours:   ((secs % 86_400) / 3600).floor,
+        mins:    ((secs % 3_600)  / 60).floor,
+        seconds:  (secs % 60).floor }
+        .delete_if { |period, _time| units && !units.include?(period) }
+    end
+
+    def self.parse_time_hash(times, format)
+      string = []
+      times.each_pair do |period, time|
+        if period == :seconds || !(time.zero? && string.empty?)
+          string << [time, format == :long ? " #{period}" : period.slice(0)]
+                      .join
+        end
+      end
+      string.join(', ')
+    end
   end
 end
 
+# Patch OpenURI to allow for redirection from http => https
 module OpenURI
-  def OpenURI.redirectable?(uri1, uri2) # :nodoc:
+  def self.redirectable?(uri1, uri2) # :nodoc:
     uri1.scheme.downcase == uri2.scheme.downcase ||
-    (/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:http|ftp|https)\z/i =~ uri2.scheme)
+    /\A(?:http|ftp)\z/i =~ uri1.scheme &&
+    /\A(?:http|ftp|https)\z/i =~ uri2.scheme
   end
 end

data/lib/cinch/toolbox/version.rb

@@ -1,5 +1,7 @@
+# -*- encoding: utf-8 -*-
 module Cinch
+  # Version Info
   module Toolbox
-    VERSION = "1.0.3"
+    VERSION = '1.1.0'
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,11 @@
 require 'coveralls'
-Coveralls.wear!
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
 require 'cinch/toolbox'
 require 'cinch/test'
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -143,7 +143,8 @@ files:
 - spec/cinch-toolbox_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-toolbox
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -169,3 +170,4 @@ summary: Common methods used in Cinch Plugins.
 test_files:
 - spec/cinch-toolbox_spec.rb
 - spec/spec_helper.rb
+has_rdoc: