color_parser 0.0.2 → 0.1.0

data/.gitignore

@@ -4,6 +4,7 @@
 .bundle
 .config
 .yardoc
+.rspec
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -16,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/stylesheet/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')         { "spec" }
+end
+

data/README.md

@@ -1,14 +1,32 @@
 ## ColorParser
 
-The ColorParser gem provides a simple way to parse the colors from an html page or CSS file. It works with both local and remote resources. 
+The ColorParser gem provides a simple way to parse the colors from an HTML page. 
+It scans both the HTML and CSS to find all colors and sort them by frequency 
+used. 
 
 ## Example
 
+Get colors on a given webpage
+
 ```ruby
-page = ColorParser::Page.new("http://sportspyder.com/")
+page = ColorParser::Page.new("http://google.com/")
 colors = page.colors
 ```
 
+Get stylesheets on a given webpage
+
+```ruby
+page = ColorParser::Page.new("http://google.com/")
+stylesheets = page.stylesheets
+```
+
+Get images on a given webpage
+
+```ruby
+page = ColorParser::Page.new("http://google.com/")
+images = page.images
+```
+
 ## Installation
 
 ```
@@ -20,24 +38,6 @@ gem "color_parser"
 
 ## LICENSE
 
-(The MIT License)
-
-Copyright © 2012 [Derek DeVries](https://github.com/devrieda/)
-
-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.
+Copyright (c) 2012 Derek DeVries
 
-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.
+Released under the [MIT License](http://www.opensource.org/licenses/MIT)

data/Rakefile

@@ -1,10 +1,22 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'rake/testtask'
 
-Rake::TestTask.new do |t|
-  t.libs << 'lib/color_parser'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+namespace :spec do
+  desc 'Run unit specs only'
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern    = 'spec'
+    task.rspec_opts = '--tag "~live"'
+  end
+
+  desc 'Run acceptance specs only'
+  RSpec::Core::RakeTask.new(:acceptance) do |task|
+    task.pattern    = 'spec'
+    task.rspec_opts = '--tag "live"'
+  end
 end
-task :default => :test
+
+task :default => :spec

data/color_parser.gemspec

@@ -6,7 +6,7 @@ require 'color_parser/version'
 Gem::Specification.new do |gem|
   gem.name          = "color_parser"
   gem.version       = ColorParser::VERSION
-  gem.summary       = %q{Color Parser finds the colors on a given webpage}
+  gem.summary       = %q{Finds colors on a given webpage}
   gem.description   = gem.summary
 
   gem.required_ruby_version = '>= 1.9.3'
@@ -21,6 +21,14 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_runtime_dependency("curb",     "~> 0.8")
   gem.add_runtime_dependency("nokogiri", "~> 1.5")
+
   gem.add_development_dependency("rake")
+  gem.add_development_dependency("rspec", "~> 2.9")
+
+  # guard
+  gem.add_development_dependency("guard", "~> 1.7")
+  gem.add_development_dependency("guard-rspec", "~> 2.5")
+  gem.add_development_dependency("rb-fsevent", "~> 0.9")
 end

data/lib/color_parser/color.rb

@@ -0,0 +1,154 @@
+module ColorParser
+  class Color
+    
+    def self.text_colors
+      { black:                "000000",
+        navy:                 "000080",
+        darkblue:             "00008b",
+        mediumblue:           "0000cd",
+        blue:                 "0000ff",
+        darkgreen:            "006400",
+        green:                "008000",
+        teal:                 "008080",
+        darkcyan:             "008b8b",
+        deepskyblue:          "00bfff",
+        darkturquoise:        "00ced1",
+        mediumspringgreen:    "00fa9a",
+        lime:                 "00ff00",
+        springgreen:          "00ff7f",
+        aqua:                 "00ffff",
+        cyan:                 "00ffff",
+        midnightblue:         "191970",
+        dodgerblue:           "1e90ff",
+        lightseagreen:        "20b2aa",
+        forestgreen:          "228b22",
+        seagreen:             "2e8b57",
+        darkslategray:        "2f4f4f",
+        darkslategrey:        "2f4f4f",
+        limegreen:            "32cd32",
+        mediumseagreen:       "3cb371",
+        turquoise:            "40e0d0",
+        royalblue:            "4169e1",
+        steelblue:            "4682b4",
+        darkslateblue:        "483d8b",
+        mediumturquoise:      "48d1cc",
+        indigo:               "4b0082",
+        darkolivegreen:       "556b2f",
+        cadetblue:            "5f9ea0",
+        cornflowerblue:       "6495ed",
+        mediumaquamarine:     "66cdaa",
+        dimgray:              "696969",
+        dimgrey:              "696969",
+        slateblue:            "6a5acd",
+        olivedrab:            "6b8e23",
+        slategray:            "708090",
+        slategrey:            "708090",
+        lightslategray:       "778899",
+        lightslategrey:       "778899",
+        mediumslateblue:      "7b68ee",
+        lawngreen:            "7cfc00",
+        chartreuse:           "7fff00",
+        aquamarine:           "7fffd4",
+        maroon:               "800000",
+        purple:               "800080",
+        olive:                "808000",
+        gray:                 "808080",
+        grey:                 "808080",
+        skyblue:              "87ceeb",
+        lightskyblue:         "87cefa",
+        blueviolet:           "8a2be2",
+        darkred:              "8b0000",
+        darkmagenta:          "8b008b",
+        saddlebrown:          "8b4513",
+        darkseagreen:         "8fbc8f",
+        lightgreen:           "90ee90",
+        mediumpurple:         "9370db",
+        darkviolet:           "9400d3",
+        palegreen:            "98fb98",
+        darkorchid:           "9932cc",
+        yellowgreen:          "9acd32",
+        sienna:               "a0522d",
+        brown:                "a52a2a",
+        darkgray:             "a9a9a9",
+        darkgrey:             "a9a9a9",
+        lightblue:            "add8e6",
+        greenyellow:          "adff2f",
+        paleturquoise:        "afeeee",
+        lightsteelblue:       "b0c4de",
+        powderblue:           "b0e0e6",
+        firebrick:            "b22222",
+        darkgoldenrod:        "b8860b",
+        mediumorchid:         "ba55d3",
+        rosybrown:            "bc8f8f",
+        darkkhaki:            "bdb76b",
+        silver:               "c0c0c0",
+        mediumvioletred:      "c71585",
+        indianred:            "cd5c5c",
+        peru:                 "cd853f",
+        chocolate:            "d2691e",
+        tan:                  "d2b48c",
+        lightgray:            "d3d3d3",
+        lightgrey:            "d3d3d3",
+        thistle:              "d8bfd8",
+        orchid:               "da70d6",
+        goldenrod:            "daa520",
+        palevioletred:        "db7093",
+        crimson:              "dc143c",
+        gainsboro:            "dcdcdc",
+        plum:                 "dda0dd",
+        burlywood:            "deb887",
+        lightcyan:            "e0ffff",
+        lavender:             "e6e6fa",
+        darksalmon:           "e9967a",
+        violet:               "ee82ee",
+        palegoldenrod:        "eee8aa",
+        lightcoral:           "f08080",
+        khaki:                "f0e68c",
+        aliceblue:            "f0f8ff",
+        honeydew:             "f0fff0",
+        azure:                "f0ffff",
+        sandybrown:           "f4a460",
+        wheat:                "f5deb3",
+        beige:                "f5f5dc",
+        whitesmoke:           "f5f5f5",
+        mintcream:            "f5fffa",
+        ghostwhite:           "f8f8ff",
+        salmon:               "fa8072",
+        antiquewhite:         "faebd7",
+        linen:                "faf0e6",
+        lightgoldenrodyellow: "fafad2",
+        oldlace:              "fdf5e6",
+        red:                  "ff0000",
+        fuchsia:              "ff00ff",
+        magenta:              "ff00ff",
+        deeppink:             "ff1493",
+        orangered:            "ff4500",
+        tomato:               "ff6347",
+        hotpink:              "ff69b4",
+        coral:                "ff7f50",
+        darkorange:           "ff8c00",
+        lightsalmon:          "ffa07a",
+        orange:               "ffa500",
+        lightpink:            "ffb6c1",
+        pink:                 "ffc0cb",
+        gold:                 "ffd700",
+        peachpuff:            "ffdab9",
+        navajowhite:          "ffdead",
+        moccasin:             "ffe4b5",
+        bisque:               "ffe4c4",
+        mistyrose:            "ffe4e1",
+        blanchedalmond:       "ffebcd",
+        papayawhip:           "ffefd5",
+        lavenderblush:        "fff0f5",
+        seashell:             "fff5ee",
+        cornsilk:             "fff8dc",
+        lemonchiffon:         "fffacd",
+        floralwhite:          "fffaf0",
+        snow:                 "fffafa",
+        yellow:               "ffff00",
+        lightyellow:          "ffffe0",
+        ivory:                "fffff0",
+        white:                "ffffff" }
+    end
+  end
+end

data/lib/color_parser/errors.rb

@@ -0,0 +1,3 @@
+module ColorParser
+  class Error < StandardError; end
+end

data/lib/color_parser/request.rb

@@ -0,0 +1,21 @@
+class Request
+  def get(url)
+    curl = Curl::Easy.perform(url) do |curl| 
+      curl.headers["User-Agent"] = user_agent
+      curl.follow_location       = true
+    end
+
+    curl.body_str
+
+  rescue ColorParser::Error
+    raise
+
+  # re-raise external library errors in our namespace
+  rescue => error
+    raise ColorParser::Error.new("#{error.class}: #{error.message}")
+  end
+
+  def user_agent
+    "Ruby/ColorParser Mozilla/5.0 (Windows; U; Windows NT 5.1; de; rv:1.8.0.7) Gecko/20060909 Firefox/1.5.0.7"
+  end
+end

data/lib/color_parser/stylesheet.rb

@@ -1,15 +1,6 @@
 module ColorParser
   # a set of css selectors
   class Stylesheet
-    TEXT_COLORS = {
-      aqua:    "00ffff", black:  "000000", blue:  "0000ff",
-      fuchsia: "ff00ff", gray:   "808080", green: "008000",
-      lime:    "00ff00", maroon: "800000", navy:  "000080",
-      olive:   "808000", purple: "800080", red:   "ff0000",
-      silver:  "c0c0c0", teal:   "008080", white: "ffffff",
-      yellow:  "ffff00"
-    }
-
     attr_reader :url, :type, :host, :path, :query, :text
     
     def initialize(options)
@@ -153,6 +144,8 @@ module ColorParser
 
     def parse_colors(property_list)
       colors = {}
+      
+      text_colors = ColorParser::Color.text_colors.map {|k,v| k }.join("|")
 
       property_list.each do |key, value|
         # hex
@@ -164,7 +157,7 @@ module ColorParser
           rgb_to_hex(matches[1])
 
         # textual
-        elsif matches = value.match(/(#{TEXT_COLORS.map {|k,v| k }.join("|")})/)
+        elsif matches = value.match(/(#{text_colors})/)
           text_to_hex(matches[1])
         end
 
@@ -185,7 +178,7 @@ module ColorParser
 
     # find hex for textual color
     def text_to_hex(color)
-      TEXT_COLORS[color.intern]
+      ColorParser::Color.text_colors[color.intern]
     end
     
     # convert 3 digit hex to 6

data/lib/color_parser/version.rb

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

data/lib/color_parser.rb

@@ -1,14 +1,16 @@
-require 'net/http'
 require 'uri'
+require 'curb'
 require 'nokogiri'
 
+require 'color_parser/errors'
 require 'color_parser/version'
+require 'color_parser/request'
 require 'color_parser/page'
 require 'color_parser/stylesheet'
+require 'color_parser/color'
 require 'color_parser/image'
 
 module ColorParser
-
   # Build url of an asset based on the relative/absolute url
   def self.parse_asset(doc_url, asset_url)
     doc_host,   doc_path,   doc_query   = self.parse_url(doc_url)
@@ -52,91 +54,4 @@ module ColorParser
   def self.request
     @request ||= Request.new
   end
-  
-  # Request an asset
-  #
-  class Request    
-    @@last_request = Time.now
-
-    # default throttle requests 1 per sec
-    def initialize(params={})
-      @throttle = params[:throttle] || 1
-    end
-
-    def get(url)
-      throttle
-
-      begin
-        uri = URI.parse(url.strip)
-      rescue URI::InvalidURIError
-        uri = URI.parse(URI.escape(url.strip))
-      end
-
-      response = get_response(uri)
-
-      # redirect
-      @prev_redirect ||= ""
-      if response.header['location']
-        # make sure we're not in an infinite loop
-        if response.header['location'] == @prev_redirect
-          raise HTTPError, "Recursive redirect: #{@prev_redirect}"
-        end
-        @prev_redirect = response.header['location']
-
-        return get(response.header['location'])
-      end
-      
-      # bad req
-      if response.to_s.index 'Bad Request' || response.nil?
-        raise HTTPError, "invalid HTTP request #{url}" 
-      end
-      
-      response = fix_encoding(response)
-      response.body
-    end
-
-    def user_agent
-      "ColorParser Mozilla/5.0 (Windows; U; Windows NT 5.1; de; rv:1.8.0.7) Gecko/20060909 Firefox/1.5.0.7"
-    end
-
-
-    private
-
-    # Use charset in content-type, default to UTF-8 if absent
-    # 
-    # text/html; charset=UTF-8
-    # - or -
-    # text/html; charset=iso-8859-1
-    # - or - 
-    # text/html    
-    def fix_encoding(response)
-      charset = if response.header["Content-Type"].to_s.include?("charset")
-        response.header["Content-Type"].split(";")[1].split("=")[1]
-      else
-        "UTF-8"
-      end
-
-      response.body.force_encoding(charset.upcase).encode("UTF-8")
-      response
-    end
-
-    # build http request object
-    def get_response(uri)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.open_timeout = 15
-      http.read_timeout = 30
-
-      request = Net::HTTP::Get.new(uri.request_uri)
-      request["User-Agent"] = user_agent
-
-      http.request(request)
-    end
-
-    # throttle requests to 1 per sec
-    def throttle
-      sleep @throttle if @@last_request + @throttle > Time.now
-      @@last_request = Time.now
-    end
-  end
-
 end

data/{test/color_parser_test.rb → spec/color_parser_spec.rb}

@@ -1,14 +1,14 @@
-require_relative "test_helper"
+require 'spec_helper'
 
 describe ColorParser do
-  def setup
-    ColorParser.request = ColorParser::TestRequest.new
+  before(:each) do 
+    ColorParser.request = FakeRequest.new
   end
 
   it "should retrieve fixture" do
     url = "http://example.com/css/absolute.html?foo=bar"
     result = ColorParser.request.get(url)
-    result.wont_be_nil
+    expect(result).to be
   end
 
 
@@ -16,18 +16,23 @@ describe ColorParser do
   
   it "should parse url" do 
     url = "http://example.com/test/something/"
-    assert_equal ["example.com", "/test/something/", nil], ColorParser.parse_url(url)
+    parsed = ColorParser.parse_url(url)
+
+    expect(parsed).to eq ["example.com", "/test/something/", nil]
   end
   
   it "should parse url with no trailing slash" do 
-
     url = "http://example.com"
-    assert_equal ["example.com", "/", nil], ColorParser.parse_url(url)
+    parsed = ColorParser.parse_url(url)
+
+    expect(parsed).to eq ["example.com", "/", nil]
   end
   
   it "should parse url with query params" do 
     url = "http://example.com?foo=bar&baz=bar"
-    assert_equal ["example.com", "/", "foo=bar&baz=bar"], ColorParser.parse_url(url)
+    parsed = ColorParser.parse_url(url)
+
+    expect(parsed).to eq ["example.com", "/", "foo=bar&baz=bar"]
   end
 
 
@@ -38,7 +43,7 @@ describe ColorParser do
     asset = "http://asset.example.com/stylesheets/style.css"
 
     parsed = ColorParser.parse_asset(doc, asset)
-    parsed.must_equal "http://asset.example.com/stylesheets/style.css"
+    expect(parsed).to eq "http://asset.example.com/stylesheets/style.css"
   end
 
   it "should parse asset absolute path with query string" do 
@@ -46,7 +51,7 @@ describe ColorParser do
     asset = "http://asset.example.com/stylesheets/style.css?baz=bar"
   
     parsed = ColorParser.parse_asset(doc, asset)
-    parsed.must_equal "http://asset.example.com/stylesheets/style.css?baz=bar"
+    expect(parsed).to eq "http://asset.example.com/stylesheets/style.css?baz=bar"
   end
   
   it "should parse relative root path" do 
@@ -54,7 +59,7 @@ describe ColorParser do
     asset = "/styles/style.css"
   
     parsed = ColorParser.parse_asset(doc, asset)
-    parsed.must_equal "http://example.com/styles/style.css"
+    expect(parsed).to eq "http://example.com/styles/style.css"
   end
   
   it "should parse relative root path with query string" do 
@@ -62,7 +67,7 @@ describe ColorParser do
     asset = "/styles/style.css?baz=bar"
   
     parsed = ColorParser.parse_asset(doc, asset)
-    parsed.must_equal "http://example.com/styles/style.css?baz=bar"
+    expect(parsed).to eq "http://example.com/styles/style.css?baz=bar"
   end
   
   it "should parse relative path" do 
@@ -70,7 +75,7 @@ describe ColorParser do
     asset = "ie.css"
   
     parsed = ColorParser.parse_asset(doc, asset)
-    parsed.must_equal "http://example.com/stylesheets/ie.css"
+    expect(parsed).to eq "http://example.com/stylesheets/ie.css"
   end
   
   it "should parse relative path with query string" do 
@@ -78,6 +83,6 @@ describe ColorParser do
     asset = "ie.css?baz=bar"
   
     parsed = ColorParser.parse_asset(doc, asset)
-    parsed.must_equal "http://example.com/stylesheets/ie.css?baz=bar"
+    expect(parsed).to eq "http://example.com/stylesheets/ie.css?baz=bar"
   end
 end

data/spec/color_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Color do
+  describe ".text_colors" do 
+    it "must have textual colors" do
+      text_colors = ColorParser::Color.text_colors
+      expect(text_colors[:black]).to eq "000000"
+    end
+  end
+end