itrigga-net_helper 0.0.1

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "hpricot"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'rspec'
+  gem 'json_pure'
+  gem 'itrigga-core_ext', ">= 0"
+  gem "fastercsv", ">= 1.5.4"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fastercsv (1.5.4)
+    git (1.2.5)
+    hpricot (0.8.4)
+    itrigga-core_ext (0.1.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json_pure (1.5.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fastercsv (>= 1.5.4)
+  hpricot
+  itrigga-core_ext
+  jeweler (~> 1.6.4)
+  json_pure
+  rcov
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Al Davidson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= net_helper
+
+Description goes here.
+
+== Contributing to net_helper
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Al Davidson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "itrigga-net_helper"
+  gem.homepage = "http://gems.itrigga.com/trigga-net_helper"
+  gem.license = "MIT"
+  gem.summary = %Q{Wrapper around Net::HTTP to provide retries, redirects, etc}
+  gem.description = %Q{Provides various more convenient wrappers around Net::HTTP methods}
+  gem.email = "aldavidson@trigga.com"
+  gem.authors = ["Al Davidson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "net_helper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/itrigga/net_helper.rb

@@ -0,0 +1,217 @@
+require 'uri'
+require 'hpricot'
+require 'json'
+require 'cgi'
+require 'timeout'
+require 'net/http'
+
+module Itrigga
+  module NetHelper
+  
+    module_function
+  
+    def do_get(url, time_out=5, retries_on_timeout=5, max_redirects = 3)
+      retrycount = 0
+      resp = nil
+      begin
+        resp = get_with_timeout( url, time_out )
+      
+        handle_response( url, resp, retries_on_timeout,  max_redirects )
+    
+      rescue Timeout::Error      
+        if(retrycount.to_i < retries_on_timeout.to_i)
+          retrycount+=1
+          retry
+        else
+          raise IOError.new( "HTTP request timed out #{retrycount} times" )
+        end
+      end
+    
+    end
+  
+    def get_with_timeout( url, time_out)
+      resp = timeout(time_out) do
+        Net::HTTP.get_response(URI.parse(url))    
+      end
+      resp
+    end
+  
+  
+    def handle_response( url, resp, retries_on_timeout=5, max_redirects = 3 )
+      if resp.is_a? Net::HTTPSuccess then resp.body
+      elsif resp.is_a? Net::HTTPRedirection
+          if max_redirects > 0
+            do_get( URI.parse(url).merge(resp['location']).to_s, retries_on_timeout, max_redirects - 1 )
+          else
+            raise IOError.new("too many redirects!")
+          end
+      else
+        resp.error!
+      end
+    end
+  
+ 
+    def get( options = {} )
+      opts = {:timeout=>5, :retries_on_timeout=>5, :max_redirects => 3, :headers=>{} }.merge(options)
+      raise ArgumentError.new(":url is required" ) unless opts[:url]
+    
+      if (opts[:username] || opts[:headers]).to_s.empty?
+        do_get(opts[:url], opts[:timeout], opts[:retries_on_timeout], opts[:max_redirects])
+      else
+      
+        retrycount = 0
+        resp = begin
+          timeout( opts[:timeout] ) do
+            raw_get(opts)
+          end
+        rescue TimeoutError
+          if(retrycount < opts[:retries_on_timeout])
+            retrycount+=1
+            retry
+          else
+            raise IOError.new( "HTTP request timed out #{retrycount} times" )
+          end
+        end
+        resp
+      end
+    end
+  
+    def raw_get(opts) 
+      resp = nil
+      establish_session_if_needed(opts)
+    
+      if opts[:username]
+        resp = get_with_auth(opts)
+        retries = 0
+        while resp.is_a? Net::HTTPRedirection do
+          retries += 1
+          raise IOError.new( "HTTP request timed out #{retries} times" ) if retries > (opts[:max_redirects] || 3)
+        
+          resp = get_with_auth(opts.merge(:parsed_url=>URI.parse(resp['location'])))
+        end
+        
+        resp.body
+        
+      else
+        response = opts[:http_session].request_get(opts[:parsed_url].path, opts[:headers])
+        response.body
+      end
+    end
+  
+    def get_with_auth( opts )
+      establish_session_if_needed(opts)
+    
+      req = Net::HTTP::Get.new(opts[:parsed_url].path)
+      req.basic_auth( opts[:username], opts[:password] ) if opts[:username]
+      resp = opts[:http_session].request(req, opts[:headers])
+    end
+  
+    def establish_session_if_needed(opts)
+      opts[:parsed_url] ||= URI.parse(opts[:url])
+      opts[:http_session] ||= Net::HTTP.new(opts[:parsed_url].host, opts[:parsed_url].port)
+      opts[:http_session].use_ssl = true if opts[:parsed_url].scheme == 'https'
+    end
+  
+    def query_string( h, opts={:encode_values=>false, :skip_empty=>false} )
+      params = []
+      h.each{ |k,v| 
+        params << "#{k.to_s}=#{ opts[:encode_values] ? url_encode(v) : v }" unless v.to_s.empty? && opts[:skip_empty]
+      }
+      params.sort.join('&')
+    end
+  
+    def url_encode( s )
+      URI.escape( s.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]") )
+    end
+  
+    def discover_favicon_url(root_url, time_out = 5)
+      favicon_urls = ['favicon.ico'] + discover_icon_hrefs(root_url)
+      favicon_urls.compact.each do |url|
+        abs_url = URI.join(root_url, url).to_s
+        return abs_url if get_with_timeout( abs_url, time_out ).is_a?(Net::HTTPSuccess)
+      end
+      nil
+    end
+  
+    def discover_icon_hrefs(url)
+      pd = open(url) { |f| parse_with_hpricot(f) }
+      links = pd.search("//link[@rel='shortcut icon']") + pd.search("//link[@rel='icon']") 
+      links.map{ |link| link.attributes['href'] }.compact.to_a
+    end
+
+    # Have difficulty mocking/stubbing the top-level Hpricot call
+    # This wrapper makes it testable
+    def parse_with_hpricot(html)
+      Hpricot.parse(html)
+    end
+  
+    def ip_of(server)
+      IPSocket::getaddress(server)
+    end
+  
+    # uses the url shortener service defined for this site
+    # by default will use bit.ly
+    def shorten_url(raw_url,attempts = 0)
+    
+      return raw_url if attempts > 3
+    
+      url = self.format_url_shortener_api_url(raw_url)
+    
+      begin
+        response = NetHelper.get :url => url
+      rescue Exception => e
+        sleep 10 unless defined?(RAILS_ENV) && RAILS_ENV == "test"
+        return shorten_url(raw_url,attempts+1)
+      end
+    
+      data =  JSON.parse(response).recursive_symbolize_keys!
+    
+    
+      if data[:status_code] == 200
+        return data[:data][:url]
+      else # theres been a problem, try again if we have tries left
+      
+        sleep 10 unless defined?(RAILS_ENV) && RAILS_ENV == "test"
+        return shorten_url(raw_url,attempts+1)
+      
+      end
+    
+    end
+  
+    # parses the :url template for the url shortener service
+    def format_url_shortener_api_url(raw_url, config_hash)
+      escaped_url = CGI::escape(raw_url)
+      config_hash[:url].gsub("{{username}}",config_hash[:username] || "").gsub("{{api_key}}",config_hash[:api_key] || "").gsub("{{raw_url}}",escaped_url)
+    end
+  
+    #
+    # Transfer a file using scp between servers
+    #
+    # Options:
+    # :host - the target server name. Hash. Must have keys:
+    # => :port - the port on which to connect
+    # => :ssh_key_path - the absolute path to the ssh key file which it will use to connect
+    # => :user - the user to connect as
+    # => :host - the hostname to connect to
+    # :target_path - the absolute path on the target server to put the file
+    # :file - the file to transfer. Must be an absolute path to the file
+    #
+    def transfer_file_scp(opts = {})
+    
+      raise ArgumentError.new("File '#{opts[:file]}' does not exist!") unless opts[:file] && File.exist?(opts[:file])
+      raise ArgumentError.new("host is required") unless opts[:host]
+      raise ArgumentError.new("No target_path defined") unless opts[:target_path]
+    
+      #host = TRIGGA_CONFIG.hosts.detect{|host| host[:display_name].to_s == opts[:target].to_s}
+      
+      # now that everything checks out make sure the destination dir path exists. If not then create it
+      command = "ssh -p#{opts[:host][:port]} -i #{opts[:host][:ssh_key_path]} #{opts[:host][:user]}@#{opts[:host][:host]} 'mkdir -p #{File.dirname(opts[:target_path])}'"
+      `#{command}`
+  
+      # now transfer the file across
+      command = "scp -P#{opts[:host][:port]} -i #{opts[:host][:ssh_key_path]} #{opts[:file]} #{opts[:host][:user]}@#{opts[:host][:host]}:#{opts[:target_path]}"
+      `#{command}`
+    
+    end
+  end  
+end

data/spec/net_helper_spec.rb

@@ -0,0 +1,454 @@
+require 'spec_helper'
+require 'trigga/core_ext'
+
+describe "Itrigga::NetHelper" do
+  before(:each) do
+    @mock_response = mock("response")
+    @mock_response.stub!(:body).and_return("body")
+  end
+
+  describe "do_get" do
+    it "should get the HTTP response" do
+      Itrigga::NetHelper.stub!(:handle_response).and_return("")
+      Net::HTTP.should_receive( :get_response ).with( URI.parse("http://some.com") ).and_return(@mock_response)
+      Itrigga::NetHelper.do_get( "http://some.com" )
+    end
+    
+    it "should call handle_response with the response" do
+      Net::HTTP.stub!( :get_response ).with( URI.parse("http://some.com") ).and_return(@mock_response)
+      Itrigga::NetHelper.should_receive(:handle_response).and_return("")
+      Itrigga::NetHelper.do_get( "http://some.com" )
+    end
+  
+    
+    describe "when the GET takes longer than time_out seconds" do
+      before(:each) do
+        Itrigga::NetHelper.stub!(:get_with_timeout).and_raise( TimeoutError.new("expected timeout") ) 
+      end
+      
+      describe "when it has retried < retries_on_timeout times" do
+        it "should retry" do
+          Itrigga::NetHelper.should_receive(:get_with_timeout).exactly(3).times
+          # NOTE: the important expectation is the above one!
+          lambda {
+            Itrigga::NetHelper.do_get( "http://some.com", 1, 2 )
+          }.should raise_error( IOError )
+        end
+      end
+      
+      describe "when it has retried retries_on_timeout times" do
+        it "should raise an IOError" do
+          lambda {
+            Itrigga::NetHelper.do_get( "http://some.com", 0, 2 )
+          }.should raise_error( IOError )
+        end
+      end
+      
+    end
+  end
+  
+  describe "handle_response" do
+    
+    describe "when the response is OK" do
+      before(:each) do
+        @mock_response.stub!(:is_a?).with(Net::HTTPSuccess).and_return true
+      end
+      
+      it "should return the response body" do
+        Itrigga::NetHelper.handle_response("http://some.com", @mock_response).should == "body"
+      end
+    end
+    
+    describe "when the response is a redirect" do
+      before(:each) do
+        @mock_response.stub!(:is_a?).with(Net::HTTPSuccess).and_return false
+        @mock_response.stub!(:is_a?).with(Net::HTTPRedirection).and_return true
+        @mock_response.stub!(:[]).with('location').and_return("http://some.redirect")
+      end
+      
+      describe "when redirects > 0" do
+        it "should recurse" do
+          Itrigga::NetHelper.should_receive(:do_get)
+          Itrigga::NetHelper.handle_response("http://some.com", @mock_response)          
+        end
+        
+        it "should pass the location field from the response as the url, and the same timeout" do
+          Itrigga::NetHelper.should_receive(:do_get).with( "http://some.redirect", 23, anything )
+          Itrigga::NetHelper.handle_response( "http://some.com", @mock_response, 23)     
+        end
+        
+        it "should pass redirects - 1 as the redirects param" do
+          Itrigga::NetHelper.should_receive(:do_get).with( anything, anything, 15 )
+          Itrigga::NetHelper.handle_response( "http://some.com", @mock_response, 23, 16)     
+        end
+        
+        describe "when the response location is relative" do
+          before(:each) do
+            @mock_response.stub!(:[]).with('location').and_return("/some/relative/path?param=567")
+          end
+          
+          it "should pass on the absolute url" do
+            Itrigga::NetHelper.should_receive(:do_get).with( "http://some.com/some/relative/path?param=567", anything, anything )
+            Itrigga::NetHelper.handle_response( "http://some.com/some_other/path.xml?id=123", @mock_response, 23, 16)
+          end
+        end
+      end
+      
+      describe "when redirects = 0" do
+        it "should raise an IOError" do
+          lambda {
+            Itrigga::NetHelper.handle_response( "http://some.com", @mock_response, 23, 0)     
+          }.should raise_error( IOError )
+        end
+      end
+    end
+    
+  end
+  
+  describe "query_string" do
+    it "should return a string" do
+      Itrigga::NetHelper.query_string( 'blart' => 'flange' ).should be_a(String)
+    end
+    
+    it "should map the given hash to query string format" do
+      Itrigga::NetHelper.query_string( 'blart'=>'flange').should == "blart=flange"
+    end
+    
+    it "should sort the keys" do
+      Itrigga::NetHelper.query_string( :c=>1, :b=>2, :a=>3 ).should == "a=3&b=2&c=1"
+    end
+    
+    it "should join each key/value pair with an ampersand" do
+      Itrigga::NetHelper.query_string( 'blart'=>'flange', 'donkey' => 'monkey').should == "blart=flange&donkey=monkey"
+    end
+    
+    it "should transform sym keys to strings" do
+      Itrigga::NetHelper.query_string( :blart=>'flange').should == "blart=flange"
+    end
+    
+    it "should render nils as empty values" do
+      Itrigga::NetHelper.query_string( 'blart'=>nil).should == "blart="
+    end
+    
+    describe "when :encode_values is true" do
+      it "should url encode each value" do
+        Itrigga::NetHelper.query_string( {'blart'=>'flange & more flange'}, :encode_values=>true ).should == "blart=flange%20%26%20more%20flange"
+      end
+    end
+    
+    describe "when :skip_empty is true" do
+      it "should not include empty-valued fields" do
+        Itrigga::NetHelper.query_string( {:c=>1, :b=>nil, :a=>''}, :skip_empty=>true ).should == "c=1"
+      end
+    end
+  end
+  
+  describe "discover_favicon_url" do
+    before(:each) do
+      @url = "http://blart.com"
+      Itrigga::NetHelper.stub!(:discover_icon_hrefs).with(@url).and_return([])
+      Itrigga::NetHelper.stub!(:get_with_timeout).and_return("")
+    end
+    
+    it "should get the given url joined with favicon.ico" do
+      Itrigga::NetHelper.should_receive(:get_with_timeout).with("http://blart.com/favicon.ico", anything).and_return("")
+      Itrigga::NetHelper.discover_favicon_url("http://blart.com")
+    end
+    
+    it "should call discover_icon_hrefs" do
+      Itrigga::NetHelper.should_receive(:discover_icon_hrefs).with(@url).and_return([])
+      Itrigga::NetHelper.discover_favicon_url(@url)
+    end
+      
+      
+
+    
+    context "each discovered href" do
+      context "when the get is a success" do
+        before(:each) do
+          Itrigga::NetHelper.stub!(:discover_icon_hrefs).with(@url).and_return(["/some/bad/path.ico", "/some/good/path.ico"])
+          @mock_404 = mock("404"); @mock_200 = mock("200")
+          @mock_404.stub!(:is_a?).with(Net::HTTPSuccess).and_return(false)
+          @mock_200.stub!(:is_a?).with(Net::HTTPSuccess).and_return(true)
+          Itrigga::NetHelper.stub!(:get_with_timeout).and_return( @mock_404, @mock_404, @mock_200 )
+        end
+        
+        it "should return the href joined onto the root url" do
+          Itrigga::NetHelper.discover_favicon_url(@url).should == "http://blart.com/some/good/path.ico"
+        end
+      end
+    end
+      
+  end
+  describe "discover_icon_hrefs" do
+    before(:each) do
+      @html = <<-HTML
+        <html>
+          <head>
+            <link rel="icon" href="http://an.absolute/url" />
+            <link rel="icon" href="relative/url" />
+          </head>
+        </html>
+      HTML
+      @url = "http://blart.com"
+      @mock_doc =  mock("hpricot doc")
+      @mock_doc.stub!(:search).and_return([])
+      Itrigga::NetHelper.stub!(:open).with("http://blart.com").and_yield(@html)
+    end
+    
+    it "should open the given url" do
+      Itrigga::NetHelper.should_receive(:open).with("http://blart.com").and_yield(@html)
+      Itrigga::NetHelper.discover_icon_hrefs(@url)
+    end
+    it "should parse the given url with hpricot" do
+      Itrigga::NetHelper.should_receive(:parse_with_hpricot).with(@html).and_return(@mock_doc)
+      Itrigga::NetHelper.discover_icon_hrefs(@url)
+    end
+    
+    it "should search for links with a rel='shortcut icon'" do
+      Itrigga::NetHelper.stub!(:parse_with_hpricot).with(@html).and_return(@mock_doc)
+      @mock_doc.should_receive(:search).with("//link[@rel='shortcut icon']").and_return([])
+      Itrigga::NetHelper.discover_icon_hrefs(@url)
+    end
+    
+    it "should search for links with a rel='icon'" do
+      Itrigga::NetHelper.stub!(:parse_with_hpricot).with(@html).and_return(@mock_doc)
+      @mock_doc.should_receive(:search).with("//link[@rel='shortcut icon']").and_return([])
+      Itrigga::NetHelper.discover_icon_hrefs(@url)
+    end
+    
+    it "should return the collected href attributes" do
+      Itrigga::NetHelper.discover_icon_hrefs(@url).should == ["http://an.absolute/url", "relative/url"]
+    end
+
+  end
+  
+  describe "raw_get" do
+    before(:each) do
+      Itrigga::NetHelper.stub!(:get_with_auth).and_return( 'body' )
+      Itrigga::NetHelper.stub!(:establish_session_if_needed)
+      @mock_session = mock("http session")
+      @mock_session.stub!(:request_get).and_return( @mock_response = mock('request_get response') )
+      @mock_response.stub!(:body).and_return('response body')
+      @mock_parsed_url = mock("parsed url")
+      @mock_parsed_url.stub!(:host).and_return("host")
+      @mock_parsed_url.stub!(:path).and_return("path")
+      @mock_parsed_url.stub!(:port).and_return("port")
+      
+      @mock_response = mock('response')
+      @mock_response.stub!(:is_a?).with(Net::HTTPRedirection).and_return(false)
+      @mock_response.stub!(:body).and_return('cheese')
+    end
+    
+    it "should call establish_session_if_needed with the given opts" do
+      Itrigga::NetHelper.should_receive(:establish_session_if_needed).with(hash_including(:blart=>'flange'))
+      Itrigga::NetHelper.raw_get(:blart=>'flange', :http_session=>@mock_session, :parsed_url=>@mock_parsed_url)
+    end
+    
+    context "when given a :username" do
+      it "should call get_with_auth with the given options" do
+        Itrigga::NetHelper.should_receive(:get_with_auth).with(hash_including(:username=>'dave')).and_return(@mock_response)
+        Itrigga::NetHelper.raw_get(:username=>'dave')
+      end
+      
+      it "should return the result of get_with_auth" do
+        Itrigga::NetHelper.stub!(:get_with_auth).with(hash_including(:username=>'dave')).and_return(@mock_response)
+        Itrigga::NetHelper.raw_get(:username=>'dave').should == 'cheese'
+      end
+      
+      context "when response is a redirection" do
+        before(:each) do
+          @mock_response.stub!(:is_a?).with(Net::HTTPRedirection).and_return(true, false)
+          @mock_response.stub!(:[]).with('location').and_return("http://cheesefish.com")
+          URI.stub!(:parse).with("http://cheesefish.com").and_return(@mock_parsed_url = mock('parsed url'))
+        end
+        
+        it "should follow the redirect" do
+          URI.should_receive(:parse).with("http://cheesefish.com").and_return(@mock_parsed_url = mock('parsed url'))
+          Itrigga::NetHelper.should_receive(:get_with_auth).twice.and_return(@mock_response)
+          Itrigga::NetHelper.raw_get(:username=>'dave')
+        end
+      end
+    end
+    
+    context "when not given a :username" do
+      it "should call request_get on the http session with the :parsed_url's path and :headers" do
+        @mock_session.should_receive(:request_get).with( 'path', {:donkey=>'dipstick'}).and_return(@mock_response)
+        Itrigga::NetHelper.raw_get( :parsed_url=>@mock_parsed_url, :http_session=>@mock_session, :headers=>{:donkey=>'dipstick'} )
+      end
+      
+      it "should return the result of calling body on the request_get's response" do
+        Itrigga::NetHelper.raw_get(:parsed_url=>@mock_parsed_url, :http_session=>@mock_session).should == 'response body'
+      end
+    end
+    
+  end
+  
+  describe "get_with_auth" do
+    before(:each) do
+      Itrigga::NetHelper.stub!(:establish_session_if_needed)
+      @mock_get = mock('get')
+      @mock_get.stub!(:basic_auth)
+      Net::HTTP::Get.stub!(:new).and_return(@mock_get)
+      @mock_parsed_url = mock("parsed url")
+      @mock_parsed_url.stub!(:host).and_return("host")
+      @mock_parsed_url.stub!(:path).and_return("path")
+      @mock_parsed_url.stub!(:port).and_return("port")
+      @mock_session = mock("http session")
+      @mock_session.stub!(:request).and_return("request response")
+    end
+    
+    it "should call establish_session_if_needed with the given opts" do
+      Itrigga::NetHelper.should_receive(:establish_session_if_needed).with(hash_including(:blart=>'flange'))
+      Itrigga::NetHelper.get_with_auth(:blart=>'flange', :parsed_url=>@mock_parsed_url, :http_session=>@mock_session)
+    end
+    
+    it "should create a new Net::HTTP::Get with the path of the :parsed_url" do
+      Net::HTTP::Get.should_receive(:new).with('path').and_return(@mock_get)
+      Itrigga::NetHelper.get_with_auth(:blart=>'flange', :parsed_url=>@mock_parsed_url, :http_session=>@mock_session)
+    end
+    
+    it "should call basic_auth on the get, passing :username and :password from the given params" do
+      @mock_get.should_receive(:basic_auth).with( 'username', 'password' )
+      Itrigga::NetHelper.get_with_auth(:username=>'username', :password=>'password', :parsed_url=>@mock_parsed_url, :http_session=>@mock_session)
+    end
+    
+    it "should call request on the http_session with the get, and any given :headers" do
+      @mock_session.should_receive(:request).with(@mock_get, {:header1=>'value1'})
+      Itrigga::NetHelper.get_with_auth(:http_session=>@mock_session, :headers=>{:header1=>'value1'}, :parsed_url=>@mock_parsed_url, :http_session=>@mock_session )
+    end
+    
+    it "should return the result of the request" do
+      @mock_session.should_receive(:request).with(@mock_get, {:header1=>'value1'}).and_return("cheese")
+      Itrigga::NetHelper.get_with_auth(:http_session=>@mock_session, :headers=>{:header1=>'value1'}, :parsed_url=>@mock_parsed_url, :http_session=>@mock_session ).should == "cheese"
+    end
+  end
+  
+  describe "establish_session_if_needed" do
+    before(:each) do
+      @mock_parsed_url = mock("parsed url")
+      @mock_parsed_url.stub!(:host).and_return("host")
+      @mock_parsed_url.stub!(:port).and_return("port")
+      @mock_parsed_url.stub!(:scheme).and_return("scheme")
+      @mock_session = mock('http session')
+      @mock_session.stub!(:use_ssl=)
+      Net::HTTP.stub!(:new).and_return(@mock_session)
+    end
+    
+    context "When not given a :parsed_url" do
+      it "should set :parsed_url to URI.parse(:url)" do
+        URI.should_receive(:parse).with("URL").and_return(@mock_parsed_url)
+        Itrigga::NetHelper.establish_session_if_needed(:url=>"URL")
+      end
+    end 
+    
+    context "When not given a :http_session" do
+      it "should set :http_session to a new Net::HTTP with the parsed_url's host and port" do
+       Net::HTTP.should_receive(:new).with("host", "port").and_return(@mock_session)
+       Itrigga::NetHelper.establish_session_if_needed(:parsed_url=>@mock_parsed_url)
+      end
+    end
+    
+    context "when the :parsed_url's scheme is https" do
+      before(:each) do
+        @mock_parsed_url.stub!(:scheme).and_return("https")
+      end
+      
+      it "should set use_ssl=true on the http session" do
+        @mock_session.should_receive(:use_ssl=).with(true)
+        Itrigga::NetHelper.establish_session_if_needed(:parsed_url=>@mock_parsed_url)
+      end
+    end
+  end
+  
+  describe "shorten_url" do
+    before do
+      @raw_url = "http://very_long_url_goes_here.com"  
+      @shortened_url = "http://url_goes_here.com"
+      Itrigga::NetHelper.stub!(:format_url_shortener_api_url).and_return("http://myshorturl.com")
+      Itrigga::NetHelper.stub!(:get).and_return("{\"status_code\":200,\"data\":{\"url\":\"#{@shortened_url}\"}}")  
+    end
+    
+    describe "with valid input" do
+      it "should call format_url_shortener_api_url" do
+        Itrigga::NetHelper.should_receive(:format_url_shortener_api_url).with(@raw_url)
+        Itrigga::NetHelper.shorten_url(@raw_url)
+      end
+      
+      it "should return a short url" do
+        Itrigga::NetHelper.shorten_url(@raw_url).should == @shortened_url
+      end
+      
+      it "should return raw_url on web request timesout" do        
+        Itrigga::NetHelper.stub!(:get).and_raise(Exception)
+        Itrigga::NetHelper.shorten_url(@raw_url).should == @raw_url
+      end
+      
+      it "should return raw url for anything other than a status 200" do
+        Itrigga::NetHelper.stub!(:get).and_return("{\"status_code\":500,\"data\":{\"url\":\"#{@shortened_url}\"}}")
+        Itrigga::NetHelper.shorten_url(@raw_url).should == @raw_url
+      end
+      
+    end
+  end
+  
+  describe "format_url_shortener_api_url" do
+    before do
+      @raw_url = "http://very_long_url_goes_here.com"  
+      @config_hash = ( {:url => "{{raw_url}}", :username => "a", :api_key => "123"} )
+    end
+    
+    it "should return the api url" do
+      Itrigga::NetHelper.format_url_shortener_api_url(@raw_url, @config_hash).should == "http%3A%2F%2Fvery_long_url_goes_here.com"
+    end
+    
+    it "should url encode the raw_url" do
+      CGI.should_receive(:escape).with(@raw_url).and_return("http%3A%2F%2Fvery_long_url_goes_here.com")
+      Itrigga::NetHelper.format_url_shortener_api_url(@raw_url, @config_hash)
+    end
+  end
+  
+  
+  describe "transfer_file_scp" do
+    before(:each) do
+      @host = { :display_name => "display_name", :port => 123, :user => "user", :host => "hostname", :ssh_key_path => "key_file_path" }
+      Itrigga::NetHelper.stub!(:'`').and_return(true)
+      File.stub!(:exist?).and_return(true)
+    end
+    
+    it "should raise error if no file in opts" do
+      lambda { Itrigga::NetHelper.transfer_file_scp(:host=>@host) }.should raise_error(ArgumentError)   
+    end
+    
+    it "should raise error if file in opts does not exist" do
+      File.stub!(:exist?).and_return(false)
+      lambda { Itrigga::NetHelper.transfer_file_scp(:file => "mycrazyfile", :host=>@host) }.should raise_error(ArgumentError)   
+    end
+    
+    it "should raise error if no host in opts" do
+      lambda { Itrigga::NetHelper.transfer_file_scp(:file => "mycrazyfile") }.should raise_error(ArgumentError)   
+    end
+    
+    it "should raise error if no target_path in opts" do
+      lambda { Itrigga::NetHelper.transfer_file_scp(:file => "mycrazyfile", :host=>@host) }.should raise_error(ArgumentError)   
+    end
+
+    it "should not raise an error if the host exists" do
+      lambda { Itrigga::NetHelper.transfer_file_scp(:file => "mycrazyfile", :host=>@host, :target_path => "/path/goes/here/to/file.xml")}.should_not raise_error  
+    end
+    
+    it "should call ssh to create dir path with the correct string" do
+      opts = {:target => "display_name", :file => "a_file_name", :target_path => "/path/goes/here/to/file.xml", :host=>@host}
+      Itrigga::NetHelper.should_receive(:'`').with("ssh -p123 -i key_file_path user@hostname 'mkdir -p /path/goes/here/to'")
+      Itrigga::NetHelper.transfer_file_scp(opts)
+    end
+    
+    it "should call scp with the correct string" do
+      opts = {:target => "display_name", :file => "a_file_name", :target_path => "/path/goes/here/to/file.xml", :host=>@host}
+      Itrigga::NetHelper.should_receive(:'`').with("scp -P123 -i key_file_path a_file_name user@hostname:/path/goes/here/to/file.xml")
+      Itrigga::NetHelper.transfer_file_scp(opts)
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'itrigga/net_helper'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'net_helper'
+
+class Test::Unit::TestCase
+end

data/test/test_net_helper.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestNetHelper < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification 
+name: itrigga-net_helper
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Al Davidson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: hpricot
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: json_pure
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: itrigga-core_ext
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: fastercsv
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 5
+        - 4
+        version: 1.5.4
+  requirement: *id008
+description: Provides various more convenient wrappers around Net::HTTP methods
+email: aldavidson@trigga.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/itrigga/net_helper.rb
+- spec/net_helper_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+- test/test_net_helper.rb
+has_rdoc: true
+homepage: http://gems.itrigga.com/trigga-net_helper
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Wrapper around Net::HTTP to provide retries, redirects, etc
+test_files: []
+