borrower 0.0.1

data/lib/borrower.rb

@@ -0,0 +1,31 @@
+# utils
+require 'fileutils'
+require 'net/http'
+require "net/https"
+require "uri"
+
+# borrower
+require 'borrower/version'
+require 'borrower/path'
+require 'borrower/transport'
+
+module Borrower::DSL
+
+  # borrow a file and put it somewhere
+  # call syntax:
+  #
+  #    Borrower.borrow "path/to/file", to: "place/to/put/file"
+  #
+  # @param path [String]
+  # @param args [Hash] only to: is looked at
+  #
+  def borrow path, args
+    unless args.has_key? :to
+      raise ArgumentError, "missing 'to:' argument"
+    end
+
+    Borrower::Transport.move path, args[:to]
+  end
+
+end
+include Borrower::DSL

data/lib/borrower/path.rb

@@ -0,0 +1,79 @@
+module Borrower
+  module Path
+    class << self
+
+      # take the contents of the file at the path
+      # @param path [String]
+      # @return [String] the contents
+      def contents path
+        if exists? path
+          if remote? path
+            fetch_from_remote(path).body
+          else
+            return IO.read(path)
+          end
+        else
+          raise "nothing exists at the provided path '#{path}'"
+        end
+      end
+
+      # check if the file exists for borrowing
+      # @param path [String]
+      # @return [Boolean]
+      def exists? path
+        if remote? path
+          return ( fetch_from_remote(path).msg == "OK" )
+        else
+          return File.exists? path
+        end
+      end
+
+      # check if the path is remote or local
+      # @param path [String]
+      # @return [Boolean]
+      def remote? path
+        pattern = /http[s]?:\/\//
+        if path.match(pattern)
+          return true
+        end
+
+        return false
+      end
+
+      # get the contents of a remote file, handling redirection
+      # and ssh protocols
+      # @param path [String]
+      # @param limit [Integer] (optional)
+      # @return [String]
+      def fetch_from_remote path, limit=10
+        raise Error, 'HTTP redirect too deep' if limit == 0
+        response = get_response(path)
+
+        case response
+        when Net::HTTPSuccess then response
+        when Net::HTTPRedirection then fetch_from_remote(response['location'], limit-1 )
+        else
+          response
+        end
+      end
+
+      # build a Net::HTTP request object and
+      # returns the response
+      # @param path[String]
+      # @return [Net::HTTPResponse]
+      def get_response path
+        uri = URI.parse(path)
+        request = Net::HTTP.new(uri.host, uri.port)
+
+        if uri.scheme == "https"
+          request.use_ssl = true
+          request.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          request.ssl_version = :SSLv3
+        end
+
+        return request.get(uri.request_uri)
+      end
+
+    end
+  end
+end

data/lib/borrower/transport.rb

@@ -0,0 +1,31 @@
+module Borrower
+  module Transport
+
+    # routes a file from -> to
+    # @param from [String]
+    def move from, to
+      put( take(from), to )
+    end
+
+    # handles taking a file
+    # @param from [String]
+    # @return [String]
+    def take from
+      Path.contents(from)
+    end
+
+    # puts a file somewhere
+    # @param content [String]
+    # @param to [String]
+    def put content, to
+      FileUtils.mkdir_p( File.dirname(to) )
+      File.open( to, 'w' ) do |file|
+        file.write content
+      end
+    end
+
+    module_function :move
+    module_function :take
+    module_function :put
+  end
+end

data/lib/borrower/version.rb

@@ -0,0 +1,3 @@
+module Borrower
+	VERSION = "0.0.1"
+end

data/spec/borrower_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Borrower do
+
+  describe "#borrow" do
+    path = File.join( Dir.pwd, 'tmp', 'file.txt' )
+
+    after(:each) do
+      `rm -rf #{File.dirname(path)}`
+    end
+
+    it "borrows local files" do
+      borrow File.join( Dir.pwd, 'spec/fixture', 'file.txt'), to: path
+      Borrower::Transport.take( path ).should == "Hi I'm a file"
+    end
+
+    it "borrows remote files" do
+      borrow "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt", to: path
+      Borrower::Transport.take( path ).should == "Hello I'm a file"
+    end
+
+    it "raises an error if missing to:" do
+      expect{ borrow( "foo", away: "bar" )}.to raise_error(ArgumentError)
+    end
+  end
+
+end

data/spec/path_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Borrower::Path do
+
+  describe "#remote?" do
+    it "realizes a remote vs. local paths" do
+      Borrower::Path.remote?("http://google.com").should be_true
+      Borrower::Path.remote?("/path/to/file.rb").should be_false
+    end
+  end
+
+  describe "#exists?" do
+
+    it "recognizes missing files" do
+      Borrower::Path.exists?("this/file/is/missing.rb").should be_false
+      Borrower::Path.exists?("http://www.google.com/this/is/missing").should be_false
+    end
+
+    it "recognizes existing files" do
+      Borrower::Path.exists?( "http://www.google.com" ).should be_true
+      Borrower::Path.exists?( File.join( Dir.pwd, 'spec/fixture', "file.txt" ) ).should be_true
+    end
+
+  end
+
+  describe "#contents" do
+
+    it "returns the content of the files" do
+      Borrower::Path.contents( File.join( Dir.pwd, 'spec/fixture', "file.txt" ) ).should == "Hi I'm a file"
+    end
+
+    it "returns the content of a remote file" do
+      Borrower::Path.contents( "https://gist.github.com/stevenosloan/5578606/raw/97ab1305184bdeac33472f9f1fcc1c9e278a1bb3/dummy.txt" ).should == "Hello I'm a file"
+    end
+
+    it "raises an error for a missing file" do
+      expect{ Borrower::Path.contents( "this/file/is/missing.rb" ) }.to raise_error(RuntimeError)
+      expect{ Borrower::Path.contents("http://www.google.com/this/is/missing") }.to raise_error(RuntimeError)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'borrower'

data/spec/transport_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'borrower/transport'
+
+describe Borrower::Transport do
+  include Borrower::Transport
+
+  describe "#take" do
+    it "returns the correct contents" do
+      take( File.join( Dir.pwd, 'spec/fixture', "file.txt" ) ).should == "Hi I'm a file"
+    end
+  end
+
+  describe "#put" do
+    path = File.join( Dir.pwd, 'tmp', 'file.txt' )
+
+    after(:each) do
+      `rm -rf #{File.dirname(path)}`
+    end
+
+    it "puts a string to a file" do
+      put "hello", path
+      take( path ).should == "hello"
+    end
+  end
+
+  describe "#move" do
+    path = File.join( Dir.pwd, 'tmp', 'file.txt' )
+
+    after(:each) do
+      `rm -rf #{File.dirname(path)}`
+    end
+
+    it "moves the file" do
+      move( File.join( Dir.pwd, 'spec/fixture', 'file.txt'), path )
+      take( path ).should == "Hi I'm a file"
+    end
+
+    it "overwrites an existing file" do
+      put "hello", path
+      take( path ).should == "hello" # just to make sure it was written to begin with
+      move( File.join( Dir.pwd, 'spec/fixture', 'file.txt'), path )
+      take( path ).should == "Hi I'm a file"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: borrower
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Steven Sloan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.5
+description: ! ' For borrowing little snippets of the web, or files, or really any
+  snippet of string. '
+email:
+- stevenosloan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/borrower/path.rb
+- lib/borrower/transport.rb
+- lib/borrower/version.rb
+- lib/borrower.rb
+- spec/borrower_spec.rb
+- spec/path_spec.rb
+- spec/spec_helper.rb
+- spec/transport_spec.rb
+homepage: http://github.com/stevenosloan/borrower
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: For borrowing little snippets of the web, or files, or really any snippet
+  of string.
+test_files:
+- spec/borrower_spec.rb
+- spec/path_spec.rb
+- spec/spec_helper.rb
+- spec/transport_spec.rb