rippersnapper 0.0.6 → 0.0.7

data/lib/rippersnapper/suffix_file_reader.rb

@@ -1,18 +1,23 @@
 module Rippersnapper
-
-  ###
-  # Single Responsibility:
-  #   Finds a suffix match in a list of suffixes
-
   class SuffixFileReader
     attr_reader :file
 
+    # Reads in the public_suffix and populates public_suffixes for use in
+    # #contains
+    #
+    # @params file [File] file object containing public suffixes
+    # @return [self]
     def initialize file = nil
       @file = file || File.open(File.dirname(__FILE__) + "/public_suffix.dat", 'r')
       @public_suffixes = Hash.new { false }
       parse_file
     end
 
+    # Used to determin if a given suffix is present in the public_suffix data
+    # file
+    # @param suffix [String] the suffix which will be checked against the
+    # public_suffix file @return [Boolean] true or false depending on inclusion
+    # in suffix file
     def contains? suffix
       @public_suffixes[suffix] || begin
         suffix_parts = suffix.split('.')
@@ -24,8 +29,9 @@ module Rippersnapper
 
     private
 
-    # NOTE: This could be extracted into an object if something more robust is
-    # needed in the future
+    # Populates the @public_suffixes instance var.  Each line is set to a key
+    # within the variable unless it starts with a // (slash slash)
+    # @return [void]
     def parse_file
       file.each_line do |line|
         line = line.strip

data/lib/rippersnapper/url.rb

@@ -3,44 +3,80 @@ require 'uri'
 module Rippersnapper
   class Url
 
+    # @params url [String] The URL to be parsed
     def initialize url
       @url = url.to_s
     end
 
+    # URI object from url passed to initialize
+    # @return [URI] the URI object
+    # @example
+    #  uri = Rippersnapper::Url.new("www.google.com?q=blah")
+    #  uri.scheme #=> "https"
+    #  uri.host #=> "www.google.com"
+    #  uri.path #=> "/"
+    #  uri.query #=> "q=blah"
     def uri
       @uri ||= URI.parse url
     end
 
+    # If url has a scheme use it if not assume http
+    # @return [String] The url to be processed
     def url
       return @url if @url =~ /:\/\// || @url.empty?
+
+      # sensible default
       "http://#{@url}"
     end
 
+    # Pass through to DomainParser object
+    # {Rippersnapper::DomainParser#suffix} see here for more details
     def suffix
       parsed_domain.suffix
     end
 
+    # Pass through to DomainParser object
+    # {Rippersnapper::DomainParser#domain} see here for more details
     def domain
       parsed_domain.domain
     end
 
+    # Pass through to DomainParser object
+    # {Rippersnapper::DomainParser#subdomain} see here for more details
     def subdomain
       parsed_domain.subdomain
     end
 
+    # convenience method to access URI scheme
+    # @example
+    #   Rippersnapper::Url.new("https://www.google.com").scheme #=> "https"
+    # See {Rippersnapper::Url#uri} for more information
+    # @return [String]
     def scheme
       uri.scheme || ""
     end
 
+    # convenience method to access URI host
+    # @example
+    #   Rippersnapper::Url.new("https://www.google.com").host #=> "google"
+    # See {Rippersnapper::Url#uri} for more information
+    # @return [String]
     def host
       uri.host || ""
     end
 
+    # construct path from uri query and uri path
+    # @return [String]
     def path
       return "#{uri.path}?#{uri.query}" if uri.query
       uri.path
     end
 
+    # convenience method to access URI port
+    # @example
+    #   Rippersnapper::Url.new("https://www.google.com").port #=> 443
+    # See {Rippersnapper::Url#uri} for more information
+    # @return [String]
     def port
       uri.port
     end

data/lib/rippersnapper/version.rb

@@ -1,3 +1,3 @@
 module Rippersnapper
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/rippersnapper/suffix_file_validator_spec.rb

@@ -45,7 +45,7 @@ module Rippersnapper
 
       context "rejecting invalid data" do
         it "doesn't match suffix that is not in file" do
-          expect(subject.contains?("foo")).to be_false
+          expect(subject.contains?("baz")).to be_false
         end
 
         it "doesn't match complex suffix that are not in file" do

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: rippersnapper
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Micah Woods
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
 description: Rip and snap domains using Rippersnappers jaws of steele!
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -88,17 +88,17 @@ 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.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Named after the worst decepticon ever, a shark with T-Rex arms...