cinch-toolbox 1.0.1 → 1.0.2

data/.travis.yml

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

data/README.md

@@ -24,7 +24,7 @@ Note that this *only* honors redirection requests from HTTP => HTTPS and *not* H
 
 Add this line to your application's Gemfile:
 
-    gem 'cinch-toolbox'
+    gem 'cinch/toolbox'
 
 And then execute:
 
@@ -44,7 +44,14 @@ Or install it yourself as:
 
 ## Changelog
 
-* 1.0.0
+* 1.0.2
+    * [Enhancement] Reorged the file layout a bit to be more canonical (`require cinch/toolbox`
+        now instead of `require cinch-toolbox`.
+    * [Enhancement] Added support for retrieving the full contents of a html element by passing
+        `:css_full` or `:xpath_full` to the `Cinch::Toolbox.get_html_element` method.
+* 1.0.1
+    * [Refactor] Updated how `time_format` functions.
+* 1.0.0 (
     * Added tests!
     * Added docs!
     * Cleaned up code in `Toolbox.get_html_element` to be more error resistant

data/cinch-toolbox.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cinch-toolbox/version'
+require 'cinch/toolbox/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "cinch-toolbox"

data/lib/{cinch-toolbox → cinch/toolbox}/version.rb

@@ -1,5 +1,5 @@
 module Cinch
   module Toolbox
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/{cinch-toolbox.rb → cinch/toolbox.rb}

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-require 'cinch-toolbox/version'
+require 'cinch/toolbox/version'
 require 'open-uri'
 require 'patron'
 require 'nokogiri'
@@ -10,17 +10,25 @@ module Cinch
     # 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 his to css or xpath based on the type of selector.
+    # @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)
       # Make sure the URL is legit
       url = URI::extract(url, ["http", "https"]).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
+
+      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
@@ -78,16 +86,16 @@ module Cinch
     # 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, units = nil)
-      data = { :days  => (secs / 86400).floor,
-               :hours => ((secs % 86400) / 3600).floor,
-               :mins  => ((secs % 3600) / 60).floor,
-               :secs  => (secs % 60).floor }
+    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 == :secs || !(data[period].zero? && string.empty?)
+        if period == :seconds || !(data[period].zero? && string.empty?)
           if units.nil? || units.include?(period)
-            string << "#{data[period]} #{period}"
+            string << "#{data[period]}#{format == :long ? " #{period}" : period.slice(0)}"
           end
         end
       end

data/spec/cinch-toolbox_spec.rb

@@ -5,11 +5,9 @@ describe Cinch::Toolbox do
 
   describe 'the get_html_element method' do
     before(:all) do
+      @fake_web_html = "<div id=\"a1\" class=\"top\">\n<div class=\"foo\">Bar</div>\n<div id=\"foo1\">Baz</div>\n</div>"
       FakeWeb.register_uri( :get, "http://example.com/",
-                            :body => "<div id='a1' class='top'>
-                                        <div class='foo'>Bar</div>
-                                        <div id='foo1'>Baz</div>
-                                      </div>")
+                            :body => @fake_web_html)
     end
 
     it 'should return a string with contents of a css selector of a web page' do
@@ -17,11 +15,21 @@ describe Cinch::Toolbox do
         should == 'Bar'
     end
 
+    it 'should return a string with full markup of a css selector of a web page' do
+      Cinch::Toolbox.get_html_element('http://example.com/', '.top', :css_full).
+        should == @fake_web_html
+    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 a string with contents of a xpath selector of a web page' do
+      Cinch::Toolbox.get_html_element('http://example.com/', "//div[@id='a1']", :xpath_full).
+        should == @fake_web_html
+    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
@@ -111,7 +119,17 @@ describe Cinch::Toolbox do
   describe 'time parseing' do
     it 'should parse seconds into a user friendly string' do
       Cinch::Toolbox.time_format(126).
-        should == '2m 6s'
+        should == '2 mins, 6 seconds'
+    end
+
+    it 'should allow users to limit the kinds of units returned' do
+      Cinch::Toolbox.time_format(126020, [:days, :seconds]).
+        should == '1 days, 20 seconds'
+    end
+
+    it 'should allow users to specify short form' do
+      Cinch::Toolbox.time_format(126000, [:days], :short).
+        should == '1d'
     end
   end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-toolbox
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,8 +122,8 @@ files:
 - README.md
 - Rakefile
 - cinch-toolbox.gemspec
-- lib/cinch-toolbox.rb
-- lib/cinch-toolbox/version.rb
+- 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