linkhum-url 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2499da4f4ea690201eb85d3f2e8942b90655629e
+  data.tar.gz: c4738dc13d7dab8dba1008b89cce1c09d360fe13
+SHA512:
+  metadata.gz: c7dc9f9ec8fa62d742ff51a3cdeac046353f83833341f57c76d57b0e726dd54719bb22c70bf969f4109d3fdb08660fb376d7155c0b7e02ef4f24e3c55dc08bb2
+  data.tar.gz: 1359bf86a29b802371fa7411068adda60fb7db20fd7793e533c27620867aac71de6cdc4450f17a68ca8046b56a10ed58fb80585bf235d4b16addac4b1e37ed88

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Alexey Makhotkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# linkhum-url
+
+URLs which users provide could be both in human-readable form and in
+URL-encoded form. `linkhum-url` gem parses URLs in any representation
+and returns both representations: human-readable and URL-encoded.
+
+`linkhum-url` handles IDNs and Punycode in domain names.  Behind the
+scenes `addressable` gem is used to handle actual URL parsing.
+
+This is a sister gem to
+[`linkhum`](https://github.com/zverok/linkhum).
+
+## Usage
+
+`linkhum-url` has only one method: `Linkhum::URL.parse(url)`.  It
+accepts URL in any representation (usually provided by user) and
+returns `Hash` with two keys: `:human_readable` and `:url_encoded`.
+Human-readable representation should be displayed to the user, while
+URL-encoded representation should be used for HTTP queries, HTML
+embedding etc.
+
+    $ irb
+    2.3.0 :001 > require 'linkhum-url'
+     => true
+    2.3.0 :002 > Linkhum::URL.parse("https://example.org")
+     => {:human_readable=>"https://example.org", :url_encoded=>"https://example.org"}
+    2.3.0 :003 > Linkhum::URL.parse("https://пивбар.рф/поиск.html?q=пивбар")
+     => {:human_readable=>"https://пивбар.рф/поиск.html?q=пивбар", :url_encoded=>"https://xn--80abcx8ak.xn--p1ai/%D0%BF%D0%BE%D0%B8%D1%81%D0%BA.html?q=%D0%BF%D0%B8%D0%B2%D0%B1%D0%B0%D1%80"}
+    2.3.0 :004 > Linkhum::URL.parse("https://xn--80abcx8ak.xn--p1ai/%D0%BF%D0%BE%D0%B8%D1%81%D0%BA.html?q=%D0%BF%D0%B8%D0%B2%D0%B1%D0%B0%D1%80")
+     => {:human_readable=>"https://пивбар.рф/поиск.html?q=пивбар", :url_encoded=>"https://xn--80abcx8ak.xn--p1ai/%D0%BF%D0%BE%D0%B8%D1%81%D0%BA.html?q=%D0%BF%D0%B8%D0%B2%D0%B1%D0%B0%D1%80"}
+
+## Install
+
+    $ sudo apt-get install idn   # Debian/Ubuntu
+    $ brew install libidn        # OS X
+
+    $ gem install linkhum-url
+
+## License
+
+`linkhum-url` released under MIT License.  Copyright (C) Alexey
+Makhotkin, 2016.

data/lib/linkhum/url.rb

@@ -0,0 +1,57 @@
+module Linkhum
+  class URL
+    require 'addressable'
+    require 'idn'
+
+    include IDN
+
+    def self.parse(url)
+      au = Addressable::URI.parse(url)
+      human_readable = { scheme: au.scheme, userinfo: au.userinfo }
+      url_encoded = { scheme: au.scheme, userinfo: au.userinfo }
+
+      if au.host =~ /\Axn--/
+        human_readable[:host] = Idna.toUnicode(au.host)
+      else
+        human_readable[:host] = au.host
+      end
+      url_encoded[:host] = au.normalized_host
+
+      human_readable[:path] = Addressable::URI.unencode_component(au.path)
+      # this code handles bug in Addressable::URI (up to 2.5.0), which
+      # converts paths to Unicode NFKC (it should only do that for
+      # hostnames).  Patch to Addressable::URI pending.
+      au_path = au.path.dup
+      if au_path =~ /\A[\x00-\x7F]*\z/
+        au_path = Addressable::URI.unencode_component(au_path)
+      end
+      au_path.force_encoding(Encoding::ASCII_8BIT)
+      url_encoded[:path] = Addressable::URI.encode_component(au_path)
+
+      human_readable[:query] = Addressable::URI.unencode_component(au.query)
+      if au.query
+        # see above
+        au_query = au.query.dup
+        if au_query =~ /\A[\x00-\x7F]*\z/
+          au_query = Addressable::URI.unencode_component(au_query)
+        end
+        au_query.force_encoding(Encoding::ASCII_8BIT)
+      end
+      url_encoded[:query] = Addressable::URI.encode_component(au_query)
+
+      # fragments do not need to be encoded
+      human_readable[:fragment] = au.fragment
+      url_encoded[:fragment] = au.fragment
+
+      { human_readable: generate_url(human_readable),
+        url_encoded: generate_url(url_encoded) }
+    end
+
+    private
+    def self.generate_url(parts)
+      query_part = parts[:query] ? "?#{parts[:query]}" : ""
+      fragment_part = parts[:fragment] ? "##{parts[:fragment]}" : ""
+      "#{parts[:scheme]}://#{parts[:userinfo]}#{parts[:host]}#{parts[:path]}#{query_part}#{fragment_part}"
+    end
+  end
+end

data/lib/linkhum-url.rb

@@ -0,0 +1 @@
+require 'linkhum/url'

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: linkhum-url
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Makhotkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: idn-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'Input URL could be both human-readable and URL-encoded.  Two URLs are
+  returned as result: human-readable and URL-encoded'
+email: squadette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/linkhum-url.rb
+- lib/linkhum/url.rb
+homepage: http://rubygems.org/gems/linkhum-url
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Linkhum-URL creates both URL-encoded and readable versions of URLs
+test_files: []