furi 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 208063d16947ce85a4d80a12bd3834cb26c0f6ab
-  data.tar.gz: ab3eff6b787f0df3e04781908477bb69d3924333
+  metadata.gz: 62a4088dd18cb4ac9857d1512d78497ea28edd82
+  data.tar.gz: 3603fa3688b41b7b2ba700676db29f930bb11bf3
 SHA512:
-  metadata.gz: 500c3e4bb3ed0866c0cef1ca68794d9d82e9d2b679bb1590f69e14428bb1020a64d5c357c166e25b0c522902b670e5138269e649f395455f48acc4bca50785eb
-  data.tar.gz: bae87908fe1a04c26d1073d569199adda1645bc25f561ec0aa9b2e05943e55d0993223c3d329335c07afcac8c814e87c2a738573a2837be2996cb38339e3078f
+  metadata.gz: 762e38c65d27a36323bf0ed410b25633e95788ce10a8a97163195918a47e038610defe4fe8f7f5b635d554c42b09cc3c5d4fbc1974dee9ec5d4e645d646923c1
+  data.tar.gz: 59f5e066fb0f09bcac768b99b11589d4257f391352e27d4d6874c2ae1d2d783f8bc56fde491906669b5aed5d22f16c17a8f424cbab486bd2b3123243c7b38873

data/Rakefile

@@ -1,2 +1,13 @@
 require "bundler/gem_tasks"
 
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec do
+
+end
+

data/lib/furi.rb

@@ -4,32 +4,44 @@ require "uri"
 module Furi
 
   PARTS =  [
-    :anchor, :protocol, :query_string,
-    :path, :hostname, :port, :username, :password
+    :anchor, :protocol, :query_tokens,
+    :path, :host, :port, :username, :password
   ]
   ALIASES = {
-    protocol: [:schema],
+    protocol: [:schema, :scheme],
     anchor: [:fragment],
+    host: [:hostname],
+    username: [:user],
   }
 
-  DELEGATES = [:port!]
-
-  PORT_MAPPING = {
-    "http" => 80,
-    "https" => 443,
-    "ftp" => 21,
-    "tftp" => 69,
-    "sftp" => 22,
-    "ssh" => 22,
-    "svn+ssh" => 22,
-    "telnet" => 23,
-    "nntp" => 119,
-    "gopher" => 70,
-    "wais" => 210,
-    "ldap" => 389,
-    "prospero" => 1525
+  DELEGATES = [:port!, :host!]
+
+  PROTOCOLS = {
+    "http" => {port: 80, ssl: false},
+    "https" => {port: 443, ssl: true},
+    "ftp" => {port: 21},
+    "tftp" => {port: 69},
+    "sftp" => {port: 22},
+    "ssh" => {port: 22, ssl: true},
+    "svn+ssh" => {port: 22, ssl: true},
+    "telnet" => {port: 23},
+    "nntp" => {port: 119},
+    "gopher" => {port: 70},
+    "wais" => {port: 210},
+    "ldap" => {port: 389},
+    "prospero" => {port: 1525},
   }
 
+  SSL_MAPPING = {
+    'http' => 'https',
+    'ftp' => 'sftp',
+    'svn' => 'svn+ssh',
+  }
+
+  WEB_PROTOCOL = ['http', 'https']
+
+  ROOT = '/'
+
   class Expressions
     attr_accessor :protocol
 
@@ -62,6 +74,10 @@ module Furi
     parse(string).update(parts).to_s
   end
 
+  def self.merge(string, parts)
+    parse(string).merge(parts).to_s
+  end
+
   def self.serialize_tokens(query, namespace = nil)
     case query
     when Hash
@@ -107,7 +123,8 @@ module Furi
   end
 
   def self.query_tokens(query)
-    if query.is_a?(Array)
+    case query
+    when Enumerable, Enumerator
       query.map do |token|
         case token
         when QueryToken
@@ -120,10 +137,14 @@ module Furi
           raise ArgumentError, "Can not parse query token #{token.inspect}"
         end
       end
-    else
-      (query || '').split(/[&;] */n).map do |p|
+    when nil, ''
+      []
+    when String
+      query.gsub(/\A\?/, '').split(/[&;] */n).map do |p|
         QueryToken.parse(p)
       end
+    else
+      raise ArgumentError, "Can not parse #{query.inspect} query tokens"
     end
   end
 
@@ -166,8 +187,8 @@ module Furi
     return params
   end
 
-  def self.serialize(string, namespace = nil)
-    serialize_tokens(string, namespace).join("&")
+  def self.serialize(query, namespace = nil)
+    serialize_tokens(query, namespace).join("&")
   end
 
   class QueryToken
@@ -187,6 +208,10 @@ module Furi
       [name, value]
     end
 
+    def ==(other)
+      to_s == other.to_s
+    end
+
     def to_s
       "#{::URI.encode_www_form_component(name.to_s)}=#{::URI.encode_www_form_component(value.to_s)}"
     end
@@ -213,6 +238,7 @@ module Furi
     end
 
     def initialize(argument)
+      @query_tokens = []
       case argument
       when String
         parse_uri_string(argument)
@@ -230,7 +256,25 @@ module Furi
 
     def merge(parts)
       parts.each do |part, value|
-        
+        case part.to_sym
+        when :query
+          merge_query(value)
+        else
+          send(:"#{part}=", value)
+        end
+      end
+      self
+    end
+
+    def merge_query(query)
+      case query
+      when Hash
+        self.query = self.query.merge(Furi::Utils.stringify_keys(query))
+      when String, Array
+        self.query_tokens += Furi.query_tokens(query)
+      when nil
+      else
+        raise ArgumentError, "#{query.inspect} can not be merged"
       end
     end
 
@@ -243,24 +287,9 @@ module Furi
         nil
       end
     end
-
-    def host
-      if hostname
-        [hostname, explicit_port].compact.join(":")
-      elsif port
-        raise FormattingError, "can not build URI with port but without hostname"
-      else
-        nil
-      end
-    end
-
-    def host=(string)
-      @port = nil
-      if string.include?(":")
-        string, @port = string.split(":", 2)
-        @port = @port.to_i
-      end
-      @hostname = string.empty? ? nil : string
+    
+    def host=(host)
+      @host = host
     end
 
     def to_s
@@ -272,8 +301,9 @@ module Furi
         result << userinfo
       end
       result << host if host
-      result << path
-      if query_string
+      result << ":" << port if explicit_port
+      result << (host ? path : path!)
+      if query_tokens.any?
         result << "?" << query_string
       end
       if anchor
@@ -282,45 +312,66 @@ module Furi
       result.join
     end
 
+    
+    def request
+      result = []
+      result << path!
+      result << "?" << query_string if query_tokens.any?
+      result.join
+    end
+
+    def request_uri
+      request
+    end
+
     def query
       return @query if query_level?
-      @query = Furi.parse_nested_query(@query_string)
+      @query = Furi.parse_nested_query(query_tokens)
     end
 
 
     def query=(value)
       @query = nil
+      @query_tokens = []
       case value
-      when String
-        @query_string = value
-      when Array
-        @query = Furi.query_tokens(value)
+      when String, Array
+        @query_tokens = Furi.query_tokens(value)
       when Hash
         @query = value
+        @query_tokens = Furi.serialize_tokens(value)
       when nil
       else
         raise ArgumentError, 'Query can only be Hash or String'
       end
     end
 
-    def hostname=(hostname)
-      @hostname = hostname
-    end
-
     def port=(port)
-      @port = port.to_i
-      if @port == 0
-        raise ArgumentError, "port should be an Integer > 0"
+      if port != nil
+        @port = port.to_i
+        if @port == 0
+          raise ArgumentError, "port should be an Integer > 0"
+        end
+      else
+        @port = nil
       end
       @port
     end
 
+    def query_tokens=(tokens)
+      @query = nil
+      @query_tokens = tokens
+    end
+
     def username=(username)
-      @username = username
+      @username = username.nil? ? nil : username.to_s
     end
 
     def password=(password)
-      @password = password
+      @password = password.nil? ? nil : password.to_s
+    end
+
+    def path=(path)
+      @path = path.to_s
     end
 
     def protocol=(protocol)
@@ -328,8 +379,11 @@ module Furi
     end
 
     def query_string
-      return @query_string unless query_level?
-      Furi.serialize(@query)
+      if query_level?
+        Furi.serialize(@query)
+      else
+        query_tokens.join("&")
+      end
     end
 
     def expressions
@@ -341,7 +395,49 @@ module Furi
     end
 
     def default_port
-      protocol ? PORT_MAPPING[protocol] : nil
+      protocol && PROTOCOLS[protocol] ? PROTOCOLS[protocol][:port] : nil
+    end
+
+    def ssl?
+      !!(protocol && PROTOCOLS[protocol][:ssl])
+    end
+
+    def ssl
+      ssl?
+    end
+
+    def ssl=(ssl)
+      self.protocol = find_protocol_for_ssl(ssl)
+    end
+
+    def filename
+      path.split("/").last
+    end
+
+    def default_web_port?
+      WEB_PROTOCOL.any? do |web_protocol|
+        PROTOCOLS[web_protocol][:port] == port!
+      end
+    end
+
+    def web_protocol?
+      WEB_PROTOCOL.include?(protocol)
+    end
+    
+    def resource
+      [request, anchor].compact.join("#")
+    end
+
+    def path!
+      path || ROOT
+    end
+
+    def host!
+      host || ""
+    end
+
+    def ==(other)
+      to_s == other.to_s
     end
     
     protected
@@ -359,7 +455,7 @@ module Furi
       @anchor = @anchor.empty? ? nil : @anchor.join("#")
       if string.include?("?")
         string, query_string = string.split("?", 2)
-        @query_string = query_string
+        self.query_tokens = Furi.query_tokens(query_string)
       end
 
       if string.include?("://")
@@ -383,11 +479,35 @@ module Furi
         userinfo, string = string.split("@", 2)
         @username, @password = userinfo.split(":", 2)
       end
-      self.host = string
+      host, port = string.split(":", 2)
+      self.host = host if host
+      self.port = port if port
+    end
+
+    def find_protocol_for_ssl(ssl)
+      if SSL_MAPPING.key?(protocol)
+        ssl ? SSL_MAPPING[protocol] : protocol
+      elsif SSL_MAPPING.values.include?(protocol)
+        ssl ? protocol : SSL_MAPPING.invert[protocol]
+      else
+        raise ArgumentError, "Can not specify ssl for #{protocol.inspect} protocol"
+      end
     end
 
   end
 
   class FormattingError < StandardError
   end
+
+  class Utils
+    class << self
+      def stringify_keys(hash)
+        result = {}
+        hash.each_key do |key|
+          result[key.to_s] = hash[key]
+        end
+        result
+      end
+    end
+  end
 end

data/lib/furi/version.rb

@@ -1,3 +1,3 @@
 module Furi
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/furi_spec.rb

@@ -69,10 +69,13 @@ describe Furi do
       expect("http://gusiev.com").to have_parts(
         protocol: 'http',
         hostname: 'gusiev.com',
-        query_string: nil,
+        query_string: "",
         query: {},
         path: nil,
+        path!: '/',
         port: nil,
+        request: '/',
+        resource: '/',
       )
     end
 
@@ -83,6 +86,8 @@ describe Furi do
         path: '/posts/index.html',
         port: nil,
         protocol: 'http',
+        resource: '/posts/index.html?a=b#zz',
+        request: '/posts/index.html?a=b',
       )
     end
 
@@ -100,7 +105,7 @@ describe Furi do
         username: 'user',
         password: 'pass',
         hostname: 'gusiev.com',
-        query_string: nil,
+        query_string: "",
         anchor: nil,
       )
     end
@@ -110,7 +115,7 @@ describe Furi do
         username: 'user',
         password: nil,
         hostname: 'gusiev.com',
-        query_string: nil,
+        query_string: "",
         anchor: nil,
       )
     end
@@ -130,14 +135,16 @@ describe Furi do
         userinfo: 'user:pass',
         protocol: 'http',
         port: 80,
-        query_string: nil,
+        query_string: "",
       )
     end
     it "parses url with query" do
       expect("/index.html?a=b&c=d").to have_parts(
         host: nil,
+        host!: '',
         query_string: 'a=b&c=d',
-        query: {'a' => 'b', 'c' => 'd'}
+        query: {'a' => 'b', 'c' => 'd'},
+        request: '/index.html?a=b&c=d',
       )
     end
 
@@ -148,6 +155,23 @@ describe Furi do
         "port!" => 80
       )
     end
+    it "parses nested query" do
+      expect("gusiev.com?a[]=1&a[]=2&b[c]=1&b[d]=2").to have_parts(
+        host: 'gusiev.com',
+        query: {"a" => ["1","2"], "b" => {"c" => "1", "d" => "2"}},
+      )
+    end
+
+    it "find out protocol security" do
+      expect("gusiev.com:443").to have_parts(
+        host: 'gusiev.com',
+        :"ssl" => false
+      )
+      expect("https://gusiev.com:443").to have_parts(
+        host: 'gusiev.com',
+        :"ssl" => true
+      )
+    end
   end
   describe ".update" do
     
@@ -160,6 +184,8 @@ describe Furi do
       expect(Furi.update("/index.html", hostname: 'gusiev.com')).to eq('gusiev.com/index.html')
       expect(Furi.update("http://www.gusiev.com/index.html", hostname: 'gusiev.com')).to eq('http://gusiev.com/index.html')
       expect(Furi.update("/index.html", hostname: 'gusiev.com')).to eq('gusiev.com/index.html')
+      expect(Furi.update("gusiev.com/index.html?a=b", hostname: nil)).to eq('/index.html?a=b')
+      expect(Furi.update("gusiev.com?a=b", hostname: nil)).to eq('/?a=b')
     end
 
     it "updates port" do
@@ -168,6 +194,13 @@ describe Furi do
       expect(Furi.update("gusiev.com:33/index.html", port: 80)).to eq('gusiev.com:80/index.html')
       expect(Furi.update("http://gusiev.com:33/index.html", port: 80)).to eq('http://gusiev.com/index.html')
     end
+
+    it "updates ssl" do
+      expect(Furi.update("http://gusiev.com", ssl: true)).to eq('https://gusiev.com')
+      expect(Furi.update("https://gusiev.com", ssl: true)).to eq('https://gusiev.com')
+      expect(Furi.update("https://gusiev.com", ssl: false)).to eq('http://gusiev.com')
+      expect(Furi.update("http://gusiev.com", ssl: false)).to eq('http://gusiev.com')
+    end
     it "updates protocol" do
       expect(Furi.update("http://gusiev.com", protocol: '')).to eq('//gusiev.com')
       expect(Furi.update("http://gusiev.com", protocol: nil)).to eq('gusiev.com')
@@ -187,9 +220,42 @@ describe Furi do
       expect(Furi.build(hostname: 'hello.com', port: 88)).to eq('hello.com:88')
       expect(Furi.build(schema: 'https', hostname: 'hello.com', port: 88)).to eq('https://hello.com:88')
       expect(Furi.build(schema: 'http', hostname: 'hello.com', port: 80)).to eq('http://hello.com')
+      expect(Furi.build(path: '/index.html', query: {a: 1, b: 2})).to eq('/index.html?a=1&b=2')
     end
   end
 
+  describe ".merge" do
+    it "should work" do
+      expect(Furi.merge("//gusiev.com", query: {a: 1})).to eq('//gusiev.com?a=1')
+      expect(Furi.merge("//gusiev.com?a=1", query: {b: 2})).to eq('//gusiev.com?a=1&b=2')
+      expect(Furi.merge("//gusiev.com?a=1", query: {a: 2})).to eq('//gusiev.com?a=2')
+      expect(Furi.merge("//gusiev.com?a=1", query: [['a', 2], ['b', 3]])).to eq('//gusiev.com?a=1&a=2&b=3')
+      expect(Furi.merge("//gusiev.com?a=1&b=2", query: '?a=3')).to eq('//gusiev.com?a=1&b=2&a=3')
+    end
+  end
+
+  describe "#==" do
+    it "should work" do
+      expect(Furi.parse('http://gusiev.com:80') == Furi.parse('http://gusiev.com')).to be_truthy
+      expect(Furi.parse('http://gusiev.com') == Furi.parse('https://gusiev.com')).to be_falsey
+      expect(Furi.parse('http://gusiev.com') == Furi.parse('http://gusiev.com')).to be_truthy
+      expect(Furi.parse('http://gusiev.com.ua') == Furi.parse('http://gusiev.com')).to be_falsey
+      expect(Furi.parse('http://gusiev.com?a=1&a=1') == Furi.parse('http://gusiev.com?a=1')).to be_falsey
+    end
+  end
+
+  describe "#clone" do
+    it "should work" do
+
+      uri = Furi.parse('http://gusiev.com')
+      expect(uri.clone == uri).to be_truthy
+      expect(uri.clone.merge_query([[:a, 1]]) == uri).to be_falsey
+      expect(Furi.parse('http://gusiev.com') == Furi.parse('https://gusiev.com')).to be_falsey
+      expect(Furi.parse('http://gusiev.com') == Furi.parse('http://gusiev.com')).to be_truthy
+      expect(Furi.parse('http://gusiev.com.ua') == Furi.parse('http://gusiev.com')).to be_falsey
+      expect(Furi.parse('http://gusiev.com?a=1&a=1') == Furi.parse('http://gusiev.com?a=1')).to be_falsey
+    end
+  end
 
   describe "serialize" do
     it "should work" do
@@ -302,7 +368,6 @@ describe Furi do
 
     lambda { Furi.parse_nested_query("x[y]=1&x[y][][w]=2") }.
       should raise_error(TypeError, "expected Array (got String) for param `y'")
-
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: furi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler