netrc 0.1

data/Readme.md

@@ -0,0 +1,40 @@
+# Netrc
+
+This library reads and writes `.netrc` files.
+
+## API
+
+Read a netrc file:
+
+    n = Netrc.read("sample.netrc")
+
+If the file doesn't exist, Netrc.read will return an empty object.
+
+Read the user's default netrc file (`$HOME/.netrc` on Unix;
+`%HOME%\_netrc` on Windows):
+
+    n = Netrc.read
+
+Look up a username and password:
+
+    user, pass = n["example.com"]
+
+Write a username and password:
+
+    n["example.com"] = user, newpass
+    n.save
+
+If you make an entry that wasn't there before, it will be appended
+to the end of the file. Sometimes people want to include a comment
+explaining that the entry was added automatically. You can do it
+like this:
+
+    n.new_item_prefix = "# This entry was added automatically\n"
+    n["example.com"] = user, newpass
+    n.save
+
+Have fun!
+
+## Running Tests
+
+    $ turn test

data/data/permissive.netrc

@@ -0,0 +1,4 @@
+# this is my netrc
+machine m
+  login l # this is my username
+  password p

data/data/sample.netrc

@@ -0,0 +1,4 @@
+# this is my netrc
+machine m
+  login l # this is my username
+  password p

data/lib/netrc.rb

@@ -0,0 +1,134 @@
+class Netrc
+  VERSION = "0.1"
+
+  Windows = false
+  def self.default_path
+    File.join(ENV["HOME"], default_name)
+  end
+
+  def self.default_name
+    if Windows
+      return "_netrc"
+    end
+    ".netrc"
+  end
+
+  # Reads path and parses it as a .netrc file. If path doesn't
+  # exist, returns an empty object.
+  def self.read(path=default_path)
+    perm = File.stat(path).mode & 0777
+    if perm != 0600
+      raise Error, "Permission bits should be 0600, but are "+perm.to_s(8)
+    end
+    new(path, parse(lex(IO.readlines(path))))
+  rescue Errno::ENOENT
+    new(path, parse(lex([])))
+  end
+
+  def self.lex(lines)
+    tokens = []
+    for line in lines
+      content, comment = line.split(/(\s*#.*)/m)
+      tokens += content.split(/(?<=\s)(?=\S)|(?<=\S)(?=\s)/)
+      if comment
+        tokens << comment
+      end
+    end
+    tokens
+  end
+
+  def self.skip?(s)
+    s =~ /^\s/
+  end
+
+  # Returns two values, a header and a list of items.
+  # Each item is a 7-tuple, containing:
+  # - machine keyword (including trailing whitespace+comments)
+  # - machine name
+  # - login keyword (including surrounding whitespace+comments)
+  # - login
+  # - password keyword (including surrounding whitespace+comments)
+  # - password
+  # - trailing chars
+  # This lets us change individual fields, then write out the file
+  # with all its original formatting.
+  def self.parse(ts)
+    cur, item = [], []
+
+    def ts.take
+      if count < 1
+        raise Error, "unexpected EOF"
+      end
+      shift
+    end
+
+    def ts.readto
+      l = []
+      while count > 0 && ! yield(self[0])
+        l << shift
+      end
+      return l.join
+    end
+
+    pre = ts.readto{|t| t == "machine"}
+    while ts.count > 0
+      cur << ts.take + ts.readto{|t| ! skip?(t)}
+      cur << ts.take
+      cur << ts.readto{|t| t == "login"} + ts.take + ts.readto{|t| ! skip?(t)}
+      cur << ts.take
+      cur << ts.readto{|t| t == "password"} + ts.take + ts.readto{|t| ! skip?(t)}
+      cur << ts.take
+      cur << ts.readto{|t| t == "machine"}
+      item << cur
+      cur = []
+    end
+
+    [pre, item]
+  end
+
+  def initialize(path, data)
+    @path = path
+    @pre, @data = data
+  end
+
+  attr_accessor :new_item_prefix
+
+  def [](k)
+    for v in @data
+      if v[1] == k
+        return v[3], v[5]
+      end
+    end
+    nil
+  end
+
+  def []=(k, info)
+    for v in @data
+      if v[1] == k
+        v[3], v[5] = info
+        return
+      end
+    end
+    @data << new_item(k, info[0], info[1])
+  end
+
+  def count
+    @data.count
+  end
+
+  def new_item(m, l, p)
+    [new_item_prefix+"machine ", m, "\n  login ", l, "\n  password ", p, "\n"]
+  end
+
+  def save
+    File.write(path, unparse)
+  end
+
+  def unparse
+    @pre + @data.map(&:join).join
+  end
+
+end
+
+class Netrc::Error < ::StandardError
+end

data/test/test_lex.rb

@@ -0,0 +1,52 @@
+$VERBOSE = true
+require 'minitest/autorun'
+
+require 'netrc'
+
+class TestLex < MiniTest::Unit::TestCase
+  def test_lex_empty
+    t = Netrc.lex([])
+    assert_equal([], t)
+  end
+
+  def test_lex_comment
+    t = Netrc.lex(["# foo\n"])
+    assert_equal(["# foo\n"], t)
+  end
+
+  def test_lex_comment_after_space
+    t = Netrc.lex([" # foo\n"])
+    assert_equal([" # foo\n"], t)
+  end
+
+  def test_lex_comment_after_word
+    t = Netrc.lex(["x # foo\n"])
+    assert_equal(["x", " # foo\n"], t)
+  end
+
+  def test_lex_comment_with_hash
+    t = Netrc.lex(["x # foo # bar\n"])
+    assert_equal(["x", " # foo # bar\n"], t)
+  end
+
+  def test_lex_word
+    t = Netrc.lex(["x"])
+    assert_equal(["x"], t)
+  end
+
+  def test_lex_two_lines
+    t = Netrc.lex(["x\ny\n"])
+    assert_equal(["x", "\n", "y", "\n"], t)
+  end
+
+  def test_lex_word_and_comment
+    t = Netrc.lex(["x\n", "# foo\n"])
+    assert_equal(["x", "\n", "# foo\n"], t)
+  end
+
+  def test_lex_six_words
+    t = Netrc.lex(["machine m login l password p\n"])
+    e = ["machine", " ", "m", " ", "login", " ", "l", " ", "password", " ", "p", "\n"]
+    assert_equal(e, t)
+  end
+end

data/test/test_netrc.rb

@@ -0,0 +1,90 @@
+$VERBOSE = true
+require 'minitest/autorun'
+
+require 'netrc'
+
+class TestNetrc < MiniTest::Unit::TestCase
+  def setup
+    File.chmod(0600, "data/sample.netrc")
+    File.chmod(0644, "data/permissive.netrc")
+  end
+
+  def test_parse_empty
+    pre, items = Netrc.parse(Netrc.lex([]))
+    assert_equal("", pre)
+    assert_equal([], items)
+  end
+
+  def test_parse_file
+    pre, items = Netrc.parse(Netrc.lex(IO.readlines("data/sample.netrc")))
+    assert_equal("# this is my netrc\n", pre)
+    exp = [["machine ",
+            "m",
+            "\n  login ",
+            "l",
+            " # this is my username\n  password ",
+            "p",
+            "\n"]]
+    assert_equal(exp, items)
+  end
+
+  def test_missing_file
+    n = Netrc.read("data/nonexistent.netrc")
+    assert_equal(0, n.count)
+  end
+
+  def test_permission_error
+    Netrc.read("data/permissive.netrc")
+    assert false, "Should raise an error if permissions are wrong."
+  rescue Netrc::Error
+  end
+
+  def test_round_trip
+    n = Netrc.read("data/sample.netrc")
+    assert_equal(IO.read("data/sample.netrc"), n.unparse)
+  end
+
+  def test_set
+    n = Netrc.read("data/sample.netrc")
+    n["m"] = "a", "b"
+    exp = "# this is my netrc\n"+
+          "machine m\n"+
+          "  login a # this is my username\n"+
+          "  password b\n"
+    assert_equal(exp, n.unparse)
+  end
+
+  def test_set_get
+    n = Netrc.read("data/sample.netrc")
+    n["m"] = "a", "b"
+    l, p = n["m"]
+    assert_equal(["a", "b"], n["m"])
+  end
+
+  def test_add
+    n = Netrc.read("data/sample.netrc")
+    n.new_item_prefix = "# added\n"
+    n["x"] = "a", "b"
+    exp = "# this is my netrc\n"+
+          "machine m\n"+
+          "  login l # this is my username\n"+
+          "  password p\n"+
+          "# added\n"+
+          "machine x\n"+
+          "  login a\n"+
+          "  password b\n"
+    assert_equal(exp, n.unparse)
+  end
+
+  def test_add_get
+    n = Netrc.read("data/sample.netrc")
+    n.new_item_prefix = "# added\n"
+    n["x"] = "a", "b"
+    assert_equal(["a", "b"], n["x"])
+  end
+
+  def test_get_missing
+    n = Netrc.read("data/sample.netrc")
+    assert_equal(nil, n["x"])
+  end
+end

data/test/test_parse.rb

@@ -0,0 +1,34 @@
+$VERBOSE = true
+require 'minitest/autorun'
+
+require 'netrc'
+
+class TestParse < MiniTest::Unit::TestCase
+  def test_parse_empty
+    pre, items = Netrc.parse([])
+    assert_equal("", pre)
+    assert_equal([], items)
+  end
+
+  def test_parse_comment
+    pre, items = Netrc.parse(["# foo\n"])
+    assert_equal("# foo\n", pre)
+    assert_equal([], items)
+  end
+
+  def test_parse_item
+    t = ["machine", " ", "m", " ", "login", " ", "l", " ", "password", " ", "p", "\n"]
+    pre, items = Netrc.parse(t)
+    assert_equal("", pre)
+    e = [["machine ", "m", " login ", "l", " password ", "p", "\n"]]
+    assert_equal(e, items)
+  end
+
+  def test_parse_two_items
+    t = ["machine", " ", "m", " ", "login", " ", "l", " ", "password", " ", "p", "\n"] * 2
+    pre, items = Netrc.parse(t)
+    assert_equal("", pre)
+    e = [["machine ", "m", " login ", "l", " password ", "p", "\n"]] * 2
+    assert_equal(e, items)
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: netrc
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Keith Rarick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-15 00:00:00.000000000Z
+dependencies: []
+description: This library can read and update netrc files, preserving formatting including
+  comments and whitespace.
+email: kr@xph.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- data/permissive.netrc
+- data/sample.netrc
+- lib/netrc.rb
+- test/test_lex.rb
+- test/test_netrc.rb
+- test/test_parse.rb
+homepage: https://github.com/kr/netrc
+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.10
+signing_key: 
+specification_version: 3
+summary: Library to read and write netrc files.
+test_files: []