net-netrc 0.1.0

data/lib/net/netrc.rb

@@ -0,0 +1,166 @@
+# = net/netrc.rb - ftp(1) .netrc parsing
+#
+# Copyright (c) 2005 Robert J. Showalter
+#
+# This library is distributed under the terms of the Ruby license.
+# You may freely distribute or modify this library.
+#
+# See Net::Netrc for usage.
+#
+# $Id: netrc.rb,v 1.1 2005/12/15 15:09:01 bshow Exp $
+
+require 'etc'
+
+module Net
+
+  class Netrc
+
+    VERSION_MAJOR = 0
+    VERSION_MINOR = 1
+    VERSION_PATCH = 0
+    VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
+
+    # detect whether running on MS Windows platform
+    # use Matt Mower's Platform module if available
+    # (//http://rubyforge.org/projects/platform/)
+    begin
+      require 'platform'
+      IS_WIN32 = Platform::OS == :win32
+    rescue LoadError
+      IS_WIN32 = RUBY_PLATFORM =~ /mswin|mingw|bccwin|wince/i
+    end
+
+    # machine name, or nil if default entry
+    attr_accessor :machine
+
+    # login name (nil if none)
+    attr_accessor :login
+
+    # password (nil if none)
+    attr_accessor :password
+
+    # account name (nil if none)
+    attr_accessor :account
+
+    # Returns name of .netrc file
+    #
+    # If the environment variable <tt>NETRC</tt> is set, it is used
+    # as the name of the .netrc file. Otherwise, a search
+    # is made for <tt>.netrc</tt> (and <tt>_netrc</tt> on Windows) in the
+    # following locations. The first existing file found
+    # will be returned.
+    #
+    # - User's home directory as returned by <tt>Etc.getpwuid</tt>
+    # - <tt>ENV['HOME']</tt> directory
+    #
+    # On Windows platforms, the following additional locations
+    # are checked:
+    # - <tt>ENV['USERPROFILE']</tt>
+    # - <tt>ENV['HOMEPATH']</tt>
+    # - <tt>ENV['HOMEDRIVE'] + ENV['HOMEDIR']</tt>
+    def Netrc.rcname
+
+      # use file indicated by NETRC environment variable if defined
+      return ENV['NETRC'] if ENV['NETRC']
+
+      dirs = []
+      files = ['.netrc']
+
+      # build candidate list of directories to check
+      pw = Etc.getpwuid
+      dirs << pw.dir if pw
+      dirs << ENV['HOME']
+      if IS_WIN32
+        dirs << ENV['USERPROFILE']
+        dirs << ENV['HOMESHARE']
+        dirs << ENV['HOMEDRIVE'] + ENV['HOMEPATH'] || '' if ENV['HOMEDRIVE']
+        files << '_netrc'
+      end
+
+      # return first found file
+      dirs.flatten.each do |dir|
+        files.each do |file|
+          name = File.join(dir, file)
+          return name if File.exist?(name)
+        end
+      end
+
+      # nothing found
+      nil
+    end
+
+    # opens .netrc file, returning File object if successful.
+    # +name+ is the name of the .netrc file to open. If omitted,
+    # #rcname is used to locate the file.
+    #
+    # returns nil if the file does not exist.
+    #
+    # On non-Windows platforms, raises SecurityError if the file
+    # is not owned by the current user or if it is readable or 
+    # writable by other than the current user.
+    def Netrc.rcopen(name = nil)
+      name ||= rcname or return nil
+      return nil unless File.exist?(name)
+      unless IS_WIN32
+        s = File.stat(name)
+        raise SecurityError, "Not owner: #{name}" unless s.owned?
+        raise SecurityError, "Bad permissions: #{name}" if s.mode & 077 != 0
+      end
+      File.open(name, 'r')
+    end
+
+    # given a machine name, returns a Net::Netrc object containing
+    # the matching entry for that name, or the default entry. If
+    # no match is found and no default entry exists, nil is returned.
+    #
+    # +io+ is a previously-opened IO object. If not supplied,
+    # #rcopen is called to locate and open the .netrc file. +io+
+    # will be closed when this method returns.
+    def Netrc.locate(mach, io = nil)
+      need_close = false
+      if io.nil?
+        io = rcopen or return nil
+        need_close = true
+      end
+      entry = nil
+      key = nil
+      inmacdef = false
+      begin
+        while line = io.gets
+          if inmacdef
+            inmacdef = false if line.strip.empty?
+            next
+          end
+          toks = line.scan(/"((?:\\.|[^"])*)"|((?:\\.|\S)+)/).flatten.compact
+          toks.each { |t| t.gsub!(/\\(.)/, '\1') }
+          while toks.length > 0
+            tok = toks.shift
+            if key
+              entry = new if key == 'machine' && tok == mach
+              entry.send "#{key}=", tok if entry
+              key = nil
+            end
+            case tok
+            when 'default'
+              return entry if entry
+              entry = new
+            when 'machine'
+              return entry if entry
+              key = 'machine'
+            when 'login', 'password', 'account'
+              key = tok
+            when 'macdef'
+              inmacdef = true
+              break
+            end
+          end
+        end
+      ensure
+        io.close if need_close
+      end
+      entry
+    end
+
+  end
+
+end

data/test/test_netrc.rb

@@ -0,0 +1,96 @@
+# $Id: test_netrc.rb,v 1.1 2005/12/15 15:09:01 bshow Exp $
+
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+
+require 'net/netrc'
+require 'test/unit'
+
+class TestNetrc < Test::Unit::TestCase
+
+  SAMPLE_NETRC = 'dot.netrc.test'
+
+  def setup
+    @path = File.join(File.dirname(__FILE__), SAMPLE_NETRC)
+    File.open(@path, 'w') do |f|
+      f << <<EOT
+machine example.com
+  login example_login
+  password example_password
+  account example_account
+
+machine twowords.com
+  login "twowords login"
+  password "twowords password"
+  account "twowords account"
+
+macdef foo
+  this is a macro definition.
+  it starts with the line following 'macdef',
+  and ends with a null line (consecutive newline characters)
+
+default
+  login default_login
+  password default_password
+
+machine unreached.com
+  login unreached_login
+  password unreached_password
+
+EOT
+    end
+    File.chmod(0600, @path)
+    ENV['NETRC'] = @path
+  end
+
+  def teardown
+    File.unlink @path
+  end
+
+  def test_path
+    assert_not_nil(ENV['NETRC'])
+    assert(File.exists?(ENV['NETRC']), '#{SAMPLE_NETRC} not found')
+    assert_equal(Net::Netrc.rcname, @path)
+  end
+
+  unless Net::Netrc::IS_WIN32
+    def test_security
+      File.chmod(0666, @path)
+      assert_raise(SecurityError) { Net::Netrc.rcopen }
+      File.chmod(0600, @path)
+      assert_nothing_raised { Net::Netrc.rcopen }
+    end
+  end
+
+  def test_entries
+
+    entry = Net::Netrc.locate('example.com')
+    assert_not_nil(entry)
+    assert_equal('example.com', entry.machine)
+    assert_equal('example_login', entry.login)
+    assert_equal('example_password', entry.password)
+    assert_equal('example_account', entry.account)
+
+    entry = Net::Netrc.locate('twowords.com')
+    assert_not_nil(entry)
+    assert_equal('twowords.com', entry.machine)
+    assert_equal('twowords login', entry.login)
+    assert_equal('twowords password', entry.password)
+    assert_equal('twowords account', entry.account)
+
+    default = Net::Netrc.locate('')
+    assert_not_nil(default)
+    assert_nil(default.machine)
+    assert_equal('default_login', default.login)
+    assert_equal('default_password', default.password)
+    assert_nil(default.account)
+
+    entry = Net::Netrc.locate('unreached.com')
+    assert_not_nil(entry)
+    assert_equal(default.machine, entry.machine)
+    assert_equal(default.login, entry.login)
+    assert_equal(default.password, entry.password)
+    assert_equal(default.account, entry.account)
+
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: net-netrc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2005-12-15 00:00:00 -05:00
+summary: Net::Netrc provides ftp(1)-style .netrc parsing
+require_paths: 
+  - lib
+email: bshow@rubyforge.org
+homepage: http://net-netrc.rubyforge.org
+rubyforge_project: 
+description: 
+autorequire: net/netrc
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Bob Showalter
+files: 
+  - lib/net
+  - lib/net/netrc.rb
+  - test/test_netrc.rb
+test_files: 
+  - test/test_netrc.rb
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: Platform
+    version_requirement: 
+    version_requirements: !ruby/object:Gem::Version::Requirement 
+      requirements: 
+        - 
+          - ">="
+          - !ruby/object:Gem::Version 
+            version: 0.3.0
+      version: