uri-smb 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in stringglob.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new
+

data/lib/uri/smb/version.rb

@@ -0,0 +1,5 @@
+module URI
+  module SMB
+    VERSION = "0.0.1"
+  end
+end

data/lib/uri/smb.rb

@@ -0,0 +1,333 @@
+## Ruby: URI::SMB class
+##
+## Author:: SATOH Fumiyasu
+## Copyright:: (c) 2007-2011 SATOH Fumiyasu @ OSS Technology, Corp.
+## License:: You can redistribute it and/or modify it under the same term as Ruby.
+## Date:: 2011-10-28, since 2007-07-06
+
+require 'uri'
+require 'cgi'
+
+module URI
+
+  ## SMB URI class. See also: Implementing CIFS - Appendix D: The SMB URL:
+  ## http://ubiqx.org/cifs/Appendix-D.html
+  class SMB < Generic
+    ## A default port of 445 for URI::SMB
+    DEFAULT_PORT = 445
+    ## An Array of the available components for URI::SMB
+    COMPONENT = [
+      :scheme,
+      :userinfo, :host, :port,
+      :share, :path,
+      :nbns, :workgroup, :calling, :called,
+      :broadcast, :nodetype, :scopeid,
+    ].freeze
+
+    NODETYPE = [
+      NODETYPE_BROADCAST =      'b',
+      NODETYPE_P2P =            'p',
+      NODETYPE_MIXED =          'm',
+      NODETYPE_HYBRID =         'h',
+    ].freeze
+
+    URI::REGEXP::PATTERN.const_set(
+      :NETBIOSHOSTNAME,
+      '[a-zA-Z\d_][a-zA-Z\d_\-]{1,14}'
+    )
+    URI.const_set(
+      :NETBIOSHOSTNAME,
+      Regexp.new("^#{URI::REGEXP::PATTERN::NETBIOSHOSTNAME}$")
+    )
+    URI::REGEXP::PATTERN.const_set(
+      :SMBHOSTNAME,
+      "#{URI::REGEXP::PATTERN::HOSTNAME}|#{URI::REGEXP::PATTERN::NETBIOSHOSTNAME}"
+    )
+    URI.const_set(
+      :SMBHOSTNAME,
+      Regexp.new("^#{URI::REGEXP::PATTERN::SMBHOSTNAME}$")
+    )
+
+    DEFAULT_PARSER = URI::Parser.new(:HOSTNAME=>URI::REGEXP::PATTERN::SMBHOSTNAME)
+
+    def self.parse(uri)
+      DEFAULT_PARSER.parse(uri)
+    end
+
+    def initialize(scheme,
+                   userinfo, host, port, registry,
+                   path, opaque,
+                   query,
+                   fragment,
+		   parser = DEFAULT_PARSER,
+                   arg_check = false)
+      super(scheme,
+        userinfo, host, port, registry,
+        path, opaque,
+        query,
+        fragment,
+        parser,
+        arg_check)
+
+      if @fragment
+        raise InvalidURIError, 'bad SMB URI'
+      end
+
+      parse_path
+      parse_query
+    end
+
+    def parse_path
+      @share = @path ? @path.match(%r#/([^/]+)#) ? $1 : nil : nil;
+    end
+    private :parse_path
+
+    def build_path
+      if @share
+        @path = '/' + @share + @path.sub(%r#^/[^/]*#, '')
+      else
+        @path = ''
+      end
+    end
+    private :build_path
+
+    def parse_query
+      params = {}
+      if @query
+        @query.split(/[&;]/).each do |param|
+          next if param.empty?
+          name, value = param.split('=', 2)
+          params[name] = value ? value : nil
+        end
+      end
+
+      @nbns = params.delete('nbns') || params.delete('wins')
+      @workgroup = params.delete('workgroup') || params.delete('ntdomain')
+      @calling = params.delete('calling')
+      @called = params.delete('called')
+      @broadcast = params.delete('broadcast')
+      @nodetype = params.delete('nodetype')
+      @scopeid = params.delete('scopeid')
+
+      unless params.empty?
+        raise InvalidURIError,
+              "bad query parameter(s) in SMB URI: #{params.keys.join(',')}"
+      end
+      build_query
+    end
+    private :parse_query
+
+    def build_query
+      params = []
+      params << 'nbns=' + @nbns if @nbns && @nbns.size > 0
+      params << 'workgroup=' + @workgroup if @workgroup && @workgroup.size > 0
+      params << 'calling=' + @calling if @calling && @calling.size > 0
+      params << 'called=' + @called if @called && @called.size > 0
+      params << 'broadcast=' + @broadcast if @broadcast && @broadcast.size > 0
+      params << 'nodetype=' + @nodetype if @nodetype && @nodetype.size > 0
+      params << 'scopeid=' + @scopeid if @scopeid && @scopeid.size > 0
+
+      @query = !params.empty? ? params.join('&') : nil
+    end
+    private :build_query
+
+    def share
+      return @share ? @share : ''
+    end
+
+    def check_share(v)
+      check_path('/' + v)
+      if v && v.include?('/')
+        raise InvalidURIError,
+              "bad share conponent ('/' not allowed): #{v}"
+      end
+    end
+    private :check_share
+
+    def set_share(v)
+      @share = v
+      build_path
+      return @share
+    end
+    protected :set_share
+
+    def share=(v)
+      check_share(v)
+      set_share(v)
+    end
+
+    ## returns the NetBIOS name server (WINS) address.
+    def nbns
+      return @nbns
+    end
+    alias :wins :nbns
+
+    def check_nbns(v)
+      if v && v!='' && self.parser.regexp[:HOST] !~ v
+        raise InvalidURIError,
+              "bad NetBIOS name server (WINS) address: #{v}"
+      end
+    end
+    private :check_nbns
+
+    def set_nbns(v)
+      @nbns = v
+      build_query
+      return @nbns
+    end
+    protected :set_nbns
+
+    def nbns=(v)
+      check_nbns(v)
+      set_nbns(v)
+    end
+
+    ## returns the workgroup (or NT domain) name.
+    def workgroup
+      return @workgroup
+    end
+    alias :ntdomain :workgroup
+
+    def check_workgroup(v)
+      if v && v!='' && self.parser.regexp[:HOST] !~ v
+        raise InvalidURIError,
+              "bad NetBIOS workgroup (or NT domain) name: #{v}"
+      end
+    end
+    private :check_workgroup
+
+    def set_workgroup(v)
+      @workgroup = v
+      build_query
+      return @workgroup
+    end
+    protected :set_workgroup
+
+    def workgroup=(v)
+      check_workgroup(v)
+      set_workgroup(v)
+    end
+
+    ## returns the NetBIOS source name or address.
+    def calling
+      return @calling
+    end
+
+    def check_calling(v)
+      if v && v!='' && self.parser.regexp[:HOST] !~ v
+        raise InvalidURIError,
+              "bad NetBIOS calling (source) name: #{v}"
+      end
+    end
+    private :check_calling
+
+    def set_calling(v)
+      @calling = v
+      build_query
+      return @calling
+    end
+    protected :set_calling
+
+    def calling=(v)
+      check_calling(v)
+      set_calling(v)
+    end
+
+    ## returns the NetBIOS destination name or address.
+    def called
+      return @called
+    end
+
+    def check_called(v)
+      if v && v!='' && self.parser.regexp[:HOST] !~ v
+        raise InvalidURIError,
+              "bad NetBIOS called (destination) name: #{v}"
+      end
+    end
+    private :check_called
+
+    def set_called(v)
+      @called = v
+      build_query
+      return @called
+    end
+    protected :set_called
+
+    def called=(v)
+      check_called(v)
+      set_called(v)
+    end
+
+    ## returns the broadcast address.
+    def broadcast
+      return @broadcast
+    end
+
+    def check_broadcast(v)
+      ## FIXME
+    end
+    private :check_broadcast
+
+    def set_broadcast(v)
+      @broadcast = v
+      build_query
+      return @broadcast
+    end
+    protected :set_broadcast
+
+    def broadcast=(v)
+      check_broadcast(v)
+      set_broadcast(v)
+    end
+
+    ## returns the NetBIOS node type.
+    def nodetype
+      return @nodetype
+    end
+
+    def check_nodetype(v)
+      if v && v!='' && !NODETYPE.include?(v.downcase)
+        raise InvalidURIError,
+              "bad nodetype in SMB URI: #{v}"
+      end
+    end
+    private :check_nodetype
+
+    def set_nodetype(v)
+      @nodetype = v
+      build_query
+      return @nodetype
+    end
+    protected :set_nodetype
+
+    def nodetype=(v)
+      check_nodetype(v)
+      set_nodetype(v)
+    end
+
+    ## returns the NetBIOS scope ID.
+    def scopeid
+      return @scopeid
+    end
+
+    def check_scopeid(v)
+      ## FIXME
+    end
+    private :check_scopeid
+
+    def set_scopeid(v)
+      @scopeid = v
+      build_query
+      return @scopeid
+    end
+    protected :set_scopeid
+
+    def scopeid=(v)
+      check_scopeid(v)
+      set_scopeid(v)
+    end
+  end
+
+  @@schemes['SMB'] = SMB
+end
+

data/test/test_smb.rb

@@ -0,0 +1,169 @@
+require 'test/unit'
+require 'uri/smb'
+
+module URI
+
+class TestSMB < Test::Unit::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+
+  def uri_to_ary(uri)
+    uri.class.component.collect {|c| uri.send(c)}
+  end
+
+  def test_parse
+    uri = 'smb://example.jp/share/path'
+    u = URI.parse(uri)
+    assert_kind_of(URI::SMB, u)
+    assert_equal(uri, u.to_s)
+    assert_equal('smb', u.scheme)
+    assert_equal('example.jp', u.host)
+    assert_equal('/share/path', u.path)
+
+    uri = 'smb://domain;user:pass@example.jp/share/path'
+    u = URI.parse(uri)
+    assert_equal('domain;user:pass', u.userinfo)
+
+    uris = {
+      'smb://server' =>
+      ['smb', nil, 'server', URI::SMB::DEFAULT_PORT,
+       '', '',
+       nil, nil, nil, nil,
+       nil, nil, nil],
+      'smb://server/share/path' =>
+      ['smb', nil, 'server', URI::SMB::DEFAULT_PORT,
+       'share', '/share/path',
+       nil, nil, nil, nil,
+       nil, nil, nil],
+      'smb://server/share?nbns=10.0.0.1&workgroup=DOMAIN' =>
+      ['smb', nil, 'server', URI::SMB::DEFAULT_PORT,
+       'share', '/share',
+       '10.0.0.1', 'DOMAIN', nil, nil,
+       nil, nil, nil],
+      'smb://server/share?wins=10.0.0.1&ntdomain=DOMAIN' =>
+      ['smb', nil, 'server', URI::SMB::DEFAULT_PORT,
+       'share', '/share',
+       '10.0.0.1', 'DOMAIN', nil, nil,
+       nil, nil, nil],
+      'smb://server/share/path?calling=src&called=dst' =>
+      ['smb', nil, 'server', URI::SMB::DEFAULT_PORT,
+       'share', '/share/path',
+       nil, nil, 'src', 'dst',
+       nil, nil, nil],
+      'smb://server/share/path?broadcast=10.255.255.255&nodetype=P&scopeid=foo' =>
+      ['smb', nil, 'server', URI::SMB::DEFAULT_PORT,
+       'share', '/share/path',
+       nil, nil, nil, nil,
+       '10.255.255.255', 'P', 'foo'],
+    }.each do |uri, ary|
+      u = URI.parse(uri)
+      assert_equal(ary, uri_to_ary(u))
+    end
+
+    assert_raise(URI::InvalidURIError) do
+      URI.parse('smb://foo_bar/share/path')
+    end
+  end
+
+  def test_parse_netbioshostname
+    uri = 'smb://foo_bar/share/path'
+    u = URI::SMB.parse(uri)
+    assert_kind_of(URI::SMB, u)
+    assert_equal(uri, u.to_s)
+    assert_equal('smb', u.scheme)
+    assert_equal('foo_bar', u.host)
+    assert_equal('/share/path', u.path)
+
+    assert_nothing_raised(URI::InvalidURIError) do
+      URI::SMB.parse('smb://foo_barxxxxxxxx/share/path')
+    end
+    assert_raise(URI::InvalidURIError) do
+      URI::SMB.parse('smb://foo_barxxxxxxxxx/share/path')
+    end
+  end
+
+  def test_modify
+    uri = 'smb://example.jp/share/path'
+    u = URI.parse(uri)
+
+    share = 'foo'
+    uri.sub!(/share/, share)
+    u.share = share
+    assert_equal(uri, u.to_s)
+    assert_equal(share, u.share)
+    assert_raise(URI::InvalidURIError) do
+      u.share = 'invalid/name'
+    end
+
+    nbns = '10.0.0.1'
+    uri += "?nbns=#{nbns}"
+    u.nbns = nbns
+    assert_equal(uri, u.to_s)
+    assert_equal(nbns, u.nbns)
+    assert_raise(URI::InvalidURIError) do
+      u.nbns = 'invalid value'
+    end
+
+    workgroup = 'domain'
+    uri += "&workgroup=#{workgroup}"
+    u.workgroup = workgroup
+    assert_equal(uri, u.to_s)
+    assert_equal(workgroup, u.workgroup)
+    assert_raise(URI::InvalidURIError) do
+      u.workgroup = 'invalid value'
+    end
+
+    calling = 'source'
+    uri += "&calling=#{calling}"
+    u.calling = calling
+    assert_equal(uri, u.to_s)
+    assert_equal(calling, u.calling)
+    assert_raise(URI::InvalidURIError) do
+      u.called = 'invalid value'
+    end
+
+    called = 'source'
+    uri += "&called=#{called}"
+    u.called = called
+    assert_equal(uri, u.to_s)
+    assert_equal(called, u.called)
+    assert_raise(URI::InvalidURIError) do
+      u.called = 'invalid value'
+    end
+
+    broadcast = '10.255.255.255'
+    uri += "&broadcast=#{broadcast}"
+    u.broadcast = broadcast
+    assert_equal(uri, u.to_s)
+    assert_equal(broadcast, u.broadcast)
+    ## FIXME
+    #assert_raise(URI::InvalidURIError) do
+    #  u.broadcast = 'invalid value'
+    #end
+
+    nodetype = 'p'
+    uri += "&nodetype=#{nodetype}"
+    u.nodetype = nodetype
+    assert_equal(uri, u.to_s)
+    assert_equal(nodetype, u.nodetype)
+    assert_raise(URI::InvalidURIError) do
+      u.nodetype = 'invalid value'
+    end
+
+    scopeid = 'scope'
+    uri += "&scopeid=#{scopeid}"
+    u.scopeid = scopeid
+    assert_equal(uri, u.to_s)
+    assert_equal(scopeid, u.scopeid)
+    ## FIXME
+    #assert_raise(URI::InvalidURIError) do
+    #  u.scopeid = 'invalid value'
+    #end
+  end
+end
+
+end
+

data/uri-smb.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "uri/smb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "uri-smb"
+  s.version     = URI::SMB::VERSION
+  s.authors     = ["SATOH Fumiyasu"]
+  s.email       = ["fumiyas@osstech.co.jp"]
+  s.homepage    = ""
+  s.summary     = %q{SMB URI class}
+  s.description = %q{SMB URI class}
+
+  s.rubyforge_project = "uri-smb"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: uri-smb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- SATOH Fumiyasu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000 Z
+dependencies: []
+description: SMB URI class
+email:
+- fumiyas@osstech.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Rakefile
+- lib/uri/smb.rb
+- lib/uri/smb/version.rb
+- test/test_smb.rb
+- uri-smb.gemspec
+homepage: ''
+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: uri-smb
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: SMB URI class
+test_files:
+- test/test_smb.rb