класс Bundler::URI::FTP

Родитель:: Generic

FTP Bundler::URI синтаксис определяется разделом 3.2 RFC1738.

Этот класс будет переработан из-за различий в реализации; структура пути. черновик draft-hoffman-ftp-uri-04 является черновиком, но он является хорошим обзором фактического спецификации. tools.ietf.org/html/draft-hoffman-ftp-uri-04

Константы

COMPONENT

Массив доступных компонентов для Bundler::URI::FTP.

DEFAULT_PORT

Порт по умолчанию 21 для Bundler::URI::FTP.

TYPECODE

Код типа — “a”, “i” или “d”.

“a” указывает текстовый файл (команда FTP была ASCII)
“i” указывает двоичный файл (команда FTP IMAGE)
“d” указывает, что содержимое каталога должно быть отображено

TYPECODE_PREFIX

Префикс кода типа “;type=”.

Атрибуты

typecode[R]

Доступ к коду типа.

См. Bundler::URI::FTP::COMPONENT.

Публичные методы класса

build(args) Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 97
def self.build(args)

  # Fix the incoming path to be generic URL syntax
  # FTP path  ->  URL path
  # foo/bar       /foo/bar
  # /foo/bar      /%2Ffoo/bar
  #
  if args.kind_of?(Array)
    args[3] = '/' + args[3].sub(/^\//, '%2F')
  else
    args[:path] = '/' + args[:path].sub(/^\//, '%2F')
  end

  tmp = Util::make_components_hash(self, args)

  if tmp[:typecode]
    if tmp[:typecode].size == 1
      tmp[:typecode] = TYPECODE_PREFIX + tmp[:typecode]
    end
    tmp[:path] << tmp[:typecode]
  end

  return super(tmp)
end

Описание

Создает новый объект Bundler::URI::FTP из компонентов с проверкой синтаксиса.

Принимаемые компоненты — userinfo, host, port, path, и typecode.

Компоненты должны быть предоставлены либо как массив, либо как хэш с ключами, образованными путем добавления префикса имени компонента двоеточием.

Если используется массив, компоненты должны быть переданы в порядке [userinfo, host, port, path, typecode].

Если указанный путь является абсолютным, он будет закодирован для того, чтобы сделать его абсолютным в Bundler::URI.

Примеры:

require 'bundler/vendor/uri/lib/uri'

uri1 = Bundler::URI::FTP.build(['user:password', 'ftp.example.com', nil,
  '/path/file.zip', 'i'])
uri1.to_s  # => "ftp://user:password@ftp.example.com/%2Fpath/file.zip;type=i"

uri2 = Bundler::URI::FTP.build({:host => 'ftp.example.com',
  :path => 'ruby/src'})
uri2.to_s  # => "ftp://ftp.example.com/ruby/src"

Вызывает метод родительского класса

new(scheme, userinfo, host, port, registry, path, opaque, query, fragment, parser = nil, arg_check = false) Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 134
def initialize(scheme,
               userinfo, host, port, registry,
               path, opaque,
               query,
               fragment,
               parser = nil,
               arg_check = false)
  raise InvalidURIError unless path
  path = path.sub(/^\//,'')
  path.sub!(/^%2F/,'/')
  super(scheme, userinfo, host, port, registry, path, opaque,
        query, fragment, parser, arg_check)
  @typecode = nil
  if tmp = @path.index(TYPECODE_PREFIX)
    typecode = @path[tmp + TYPECODE_PREFIX.size..-1]
    @path = @path[0..tmp - 1]

    if arg_check
      self.typecode = typecode
    else
      self.set_typecode(typecode)
    end
  end
end

Описание

Создает новый объект Bundler::URI::FTP из компонентов универсального URL-адреса без проверки синтаксиса.

В отличие от build(), этот метод не кодирует компонент пути, как требуется RFC1738; вместо этого он обрабатывается в соответствии с RFC2396.

Аргументы — scheme, userinfo, host, port, registry, path, opaque, query, и fragment, в указанном порядке.

Вызывает метод родительского класса

Публичные методы экземпляра

path() Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 241
def path
  return @path.sub(/^\//,'').sub(/^%2F/,'/')
end

Возвращает путь из FTP Bundler::URI.

RFC 1738 четко указывает, что путь для FTP Bundler::URI не включает /, который разделяет путь Bundler::URI от хоста Bundler::URI. Пример:

ftp://ftp.example.com/pub/ruby

Указанный выше Bundler::URI означает, что клиент должен подключиться к ftp.example.com, а затем перейти в папку pub/ruby из начального каталога входа.

Если необходимо перейти в абсолютный каталог, необходимо включить закодированную / (%2F) в пути. Пример:

ftp://ftp.example.com/%2Fpub/ruby

В этом случае метод вернет “/pub/ruby”.

to_s() Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 252
def to_s
  save_path = nil
  if @typecode
    save_path = @path
    @path = @path + TYPECODE_PREFIX + @typecode
  end
  str = super
  if @typecode
    @path = save_path
  end

  return str
end

Возвращает строковое представление объекта Bundler::URI::FTP.

Вызывает метод родительского класса

typecode=(typecode) Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 209
def typecode=(typecode)
  check_typecode(typecode)
  set_typecode(typecode)
  typecode
end

Аргументы

v: String

Описание

Публичный метод установки кода типа v (с валидацией).

См. также Bundler::URI::FTP.check_typecode.

Использование

require 'bundler/vendor/uri/lib/uri'

uri = Bundler::URI.parse("ftp://john@ftp.example.com/my_file.img")
#=> #<Bundler::URI::FTP ftp://john@ftp.example.com/my_file.img>
uri.typecode = "i"
uri
#=> #<Bundler::URI::FTP ftp://john@ftp.example.com/my_file.img;type=i>

Защищенные методы экземпляра

set_path(v) Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 246
def set_path(v)
  super("/" + v.sub(/^\//, "%2F"))
end

Закрытый метод установки пути объекта Bundler::URI::FTP.

Вызывает метод родительского класса

set_typecode(v) Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 181
def set_typecode(v)
  @typecode = v
end

Закрытый метод установки кода типа v.

См. также Bundler::URI::FTP.typecode=.

Приватные методы экземпляра

check_typecode(v) Показать исходный код

# File lib/bundler/vendor/uri/lib/uri/ftp.rb, line 167
def check_typecode(v)
  if TYPECODE.include?(v)
    return true
  else
    raise InvalidComponentError,
      "bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
  end
end

Проверяет код типа v, возвращает true или false.

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.