favicon_party 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04c20f8f3afd2ba553493eaccc622a53e8475d52
-  data.tar.gz: 9236896799c20478321d54209c26c6bdd88bf9b7
+  metadata.gz: ef9b824cda0cae36de3a07037a15c0d81544b4f8
+  data.tar.gz: 6d3240def0f41df85d8eb49c96719af79d982104
 SHA512:
-  metadata.gz: 675b832b0921b0570a077627428da752f3272d35b500798d72e7539727da2c4153b6e474bdd2307776bcd1842b20252e0cfc3a4062574988dfe883b9fe6192e2
-  data.tar.gz: 764055135af45b2d82ae4cc1f30150942e2ec89c46ea6a65051bf51921370a3dd28b2806a53d6c0bab3716ff492fd1838ba54fe07023dc8861ed317ffa6b31c9
+  metadata.gz: 452738e3e43e306b5dce0975f1bcab0530a6d0a78fe7f112f2d7e1633e2ef492e71056ea5a87d778627ff686a2640991952fbda3ef243da0f6b85eca5f77c660
+  data.tar.gz: 962ffa342e40859c5cde56c50bd3387663c2343a925c8d6064141d3541f7a9393b63d08b971400387bf292fabf7f9b7a72e57d4e578bc5571b8c9dd0ad846b71

data/README.md

@@ -1,52 +1,75 @@
-# Favicon Party
+![Favicon Party](https://cloud.githubusercontent.com/assets/208617/11496590/d4b1f6dc-97c7-11e5-8e09-e61e50274e31.png)
 
-Fetch favicons from websites and convert them into other image formats!
+Fetch favicons from webpages and convert them into various image formats!
+
+
+## Installation
+
+You can install FaviconParty through [RubyGems](https://rubygems.org/)
+
+```
+$ gem install favicon_party
+```
+
+Or add it to your application's Gemfile and install via bundler
+
+```
+gem 'favicon_party'
+```
 
 
 ## Fetching favicon images
 
-Favicon Party parses the html response of the query url to find favicon
-links, and falls back to checking /favicon.ico for valid favicon images.
+FaviconParty parses the html response of the query url to find favicon
+links and falls back to checking /favicon.ico
 
 ```ruby
-image = FaviconParty.fetch! "https://github.com"
+image = FaviconParty.fetch! "github.com"
+#  => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+```
+
+If a valid favicon isn't found:
 
-# => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+```ruby
+FaviconParty.fetch! "http://example.com"    # raises FaviconNotFound
+FaviconParty.fetch  "http://example.com"    # nil
+```
 
-image.valid?        # true
+
+## Converting favicon images
+
+To access the source favicon data and convert it into various image formats:
+
+```ruby
 image.source_data   # binary favicon image data
 image.to_png        # binary 16x16 png data
 image.base64_png    # base64-encoded 16x16 png data
-
-
-FaviconParty.fetch! "http://example.com"    # raises FaviconNotFound
-FaviconParty.fetch  "http://example.com"    # nil
 ```
 
 
 ## Loading favicon images
 
-You can load favicon files directly as well.
+You can load favicon data from image files:
 
 ```ruby
 image = FaviconParty.load "/path/to/favicon.ico"
+#  => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
 
-# => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+image.valid?  # true
 ```
 
-Same for loading favicon URLs.
+And also load them directly from their source URLs:
 
 ```ruby
 image = FaviconParty.load "https://github.com/favicon.ico"
-
-# => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
+#  => #<FaviconParty::Image mime_type: "image/x-icon", size: 6518>
 ```
 
 
 ## Command-line client
 
-Favicon Party also provides a command-line script for fetching favicons. By
-default, it attempts to fetch a favicon from the given URL and prints it out.
+FaviconParty also provides a command-line script for fetching favicons. By
+default, it attempts to fetch a favicon from the given URL and prints it to stdout.
 Run `fetch_favicon --help` to see the list of options.
 
 ```bash
@@ -56,15 +79,6 @@ fetch_favicon example.com                 # prints an error to STDERR
 ```
 
 
-## Installation
-
-The best way to install Favicon Party is through [RubyGems](https://rubygems.org/)
-
-```
-$ gem install favicon_party
-```
-
-
 ## Requirements
 
 * Ruby 2.0.0+

data/favicon_party.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.authors        = ["Linmiao Xu"]
   s.email          = ["linmiao.xu@gmail.com"]
 
-  s.summary        = "Fetch favicons from websites and have a blast!"
-  s.description    = "Fetch favicons from websites and have a blast!"
+  s.summary        = "Fetch favicons from webpages and have a blast!"
+  s.description    = "Fetch favicons from webpages and have a blast!"
   s.homepage       = "https://github.com/linrock/favicon_party"
   s.license        = "MIT"
 

data/lib/favicon_party/http_client.rb

@@ -3,22 +3,18 @@ require 'open3'
 
 module FaviconParty
 
+  # For now, wrap command-line curl rather than using net/http or open-uri
+  # because of easier/more reliable SSL handling
+  #
   module HTTPClient
     include FaviconParty::Utils
 
     TIMEOUT = 5
 
-    # For now, wrap command-line curl rather than using net/http or open-uri
-    # because of easier/more reliable SSL handling
-    #
-    def curl_cmd(url)
-      "curl -sL -k --compressed -m #{TIMEOUT} --ciphers 'RC4,3DES,ALL' --fail --show-error '#{url}'"
-    end
-
     # Encodes output as utf8 - Not for binary http responses
     #
     def get(url)
-      stdin, stdout, stderr, t = Open3.popen3(curl_cmd(url))
+      stdin, stdout, stderr, t = Open3.popen3(curl_get_cmd(url))
       output = encode_utf8(stdout.read).strip
       error = encode_utf8(stderr.read).strip
       if !error.nil? && !error.empty?
@@ -36,12 +32,30 @@ module FaviconParty
     # Get binary data from url and ignore errors
     #
     def bin_get(url)
-      `#{curl_cmd(url)} 2>/dev/null`
+      `#{curl_get_cmd(url)} 2>/dev/null`
     end
 
     def head(url)
-      headers = `curl -sIL -1 --ciphers 'RC4,3DES,ALL' -m #{TIMEOUT} "#{url}"`
-      encode_utf8 headers
+      response_headers = `#{curl_head_cmd(url)}`
+      encode_utf8 response_headers
+    end
+
+    def build_curl_cmd(url, flags = "")
+      "curl #{curl_shared_flags} #{flags} '#{prefix_url(url)}'"
+    end
+
+    def curl_get_cmd(url)
+      build_curl_cmd url, "--compressed --fail --show-error"
+    end
+
+    def curl_head_cmd(url)
+      build_curl_cmd url, "-I -1"
+    end
+
+    private
+
+    def curl_shared_flags
+      "-sL -k -m #{TIMEOUT} --ciphers 'RC4,3DES,ALL'"
     end
 
     extend self

data/lib/favicon_party/version.rb

@@ -1,3 +1,3 @@
 module FaviconParty
-  VERSION = "0.7.2"
+  VERSION = "0.7.3"
 end

data/test/http_client_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+
+class HTTPClientTest < Minitest::Test
+  include FaviconParty::Utils
+
+  def setup
+    @http_client = FaviconParty::HTTPClient
+  end
+
+  def test_curl_get_cmd_prefixes_urls
+    url = "example.com"
+    cmd = @http_client.curl_get_cmd(url)
+    assert cmd.include?(prefix_url(url))
+  end
+
+  def test_curl_get_cmd_allows_prefixed_urls
+    url = "http://example.com"
+    cmd = @http_client.curl_get_cmd(url)
+    assert cmd.include?(prefix_url(url))
+  end
+
+  def test_curl_head_cmd_prefixes_urls
+    url = "example.com"
+    cmd = @http_client.curl_head_cmd(url)
+    assert cmd.include?(prefix_url(url))
+  end
+
+  def test_curl_head_cmd_allows_prefixed_urls
+    url = "http://example.com"
+    cmd = @http_client.curl_head_cmd(url)
+    assert cmd.include?(prefix_url(url))
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: favicon_party
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Linmiao Xu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-description: Fetch favicons from websites and have a blast!
+description: Fetch favicons from webpages and have a blast!
 email:
 - linmiao.xu@gmail.com
 executables:
@@ -97,6 +97,7 @@ files:
 - test/fixtures/favicons/white-16x16.ico
 - test/fixtures/favicons/white-16x16.svg
 - test/fixtures/html/page1.html
+- test/http_client_test.rb
 - test/image_test.rb
 - test/loader_test.rb
 - test/test_helper.rb
@@ -124,5 +125,5 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Fetch favicons from websites and have a blast!
+summary: Fetch favicons from webpages and have a blast!
 test_files: []