envato_optimiser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b98db63d51545e95d458fc4be5a835969cf9749
+  data.tar.gz: d6e8428c2ba4928f0792139bd1ecd98d2bae006b
+SHA512:
+  metadata.gz: 3803fe936c19dafb457839fd41ece441516f4b99ef4dafb5b2d56e45e79b526a1ccfc40f7688cc3fb7fe036277fb3de5533d3a21645facc2895aa92027c8678e
+  data.tar.gz: a39ddc008d4262fb7cd1d5424d7d73aa0c8203b4ae90a4401d42c61e54878742adf2310caec97f419fea581fafa18ef8ce2aa4aa79cda95a352c7aa8f29765a5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in envato_optimiser.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Jacob Bednarz
+
+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,45 @@
+# Envato Optimiser
+
+A gem to make it easier to identify potential issues on your Envato item pages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'envato_optimiser'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install envato_optimiser
+```
+
+## Usage
+
+To use this you need to first instantiate a new instance of
+`EnvatoOptimiser::Item` and pass in the full URI of the item page. For
+example:
+
+```rb
+item = EnvatoOptimiser::Item.new('https://themeforest.net/item/avada-responsive-multipurpose-theme/2833226')
+```
+
+Once you have this setup, you can run the `check!` method to perform
+the tests.
+
+```rb
+item.check!
+#=> {:image_count=>73, :image_403_count=>0, :image_404_count=>0, :image_redirect_count=>2, :total_image_weight=>3895262}
+```
+
+This will return a hash with the results of the check. Depending on the
+number of images found in the item page (and the speed the origin server
+can process requests) this can take a minute or so to complete.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/envato_optimiser.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'envato_optimiser/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'envato_optimiser'
+  spec.version  = EnvatoOptimiser::VERSION
+  spec.authors  = ['Jacob Bednarz']
+  spec.email    = ['jacob.bednarz@gmail.com']
+  spec.licenses = ['MIT']
+  spec.summary  = %q{A gem to make it easier to identify potential issues on your Envato item pages.}
+  spec.homepage = 'https://github.com/jacobbednarz/envato_optimiser'
+
+  spec.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '>= 1.6.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/envato_optimiser.rb

@@ -0,0 +1,8 @@
+require 'envato_optimiser/version'
+require 'envato_optimiser/item'
+require 'envato_optimiser/checks'
+require 'envato_optimiser/checks/image_response_status_code_check'
+require 'envato_optimiser/checks/total_image_weight_check'
+
+module EnvatoOptimiser
+end

data/lib/envato_optimiser/checks.rb

@@ -0,0 +1,5 @@
+# Parent class to extend the check definitions from.
+module EnvatoOptimiser
+  class Checks
+  end
+end

data/lib/envato_optimiser/checks/image_response_status_code_check.rb

@@ -0,0 +1,65 @@
+module EnvatoOptimiser
+  class ImageResponseStatusCodeCheck < Checks
+    # Initialize an image response status code check.
+    #
+    # @param image_urls [Array] Image URLs that you would like to check the HTTP
+    #   response status codes for.
+    #
+    # @return [Nothing].
+    def initialize(image_urls)
+      @redirects    = []
+      @not_found    = []
+      @forbidden    = []
+      @server_error = []
+
+      fetch_image_responses(image_urls)
+    end
+
+    # Format the image response status code results into a usable Hash.
+    #
+    # @return [Hash]
+    def to_h
+      {
+        :image_redirect_count     => redirect_count,
+        :image_not_found_count    => not_found_count,
+        :image_forbidden_count    => forbidden_count,
+        :image_server_error_count => server_error_count,
+      }
+    end
+
+    private
+
+    def redirect_count
+      @redirects.size
+    end
+
+    def not_found_count
+      @not_found.size
+    end
+
+    def forbidden_count
+      @forbidden.size
+    end
+
+    def server_error_count
+      @server_error.size
+    end
+
+    def fetch_image_responses(image_urls)
+      image_urls.each do |image|
+        response = Net::HTTP.get_response(URI.parse(image))
+
+        case response.code.to_i
+        when 300..399
+          @redirects << image
+        when 404
+          @not_found << image
+        when 403
+          @forbidden << image
+        when 500..599
+          @server_error << image
+        end
+      end
+    end
+  end
+end

data/lib/envato_optimiser/checks/total_image_weight_check.rb

@@ -0,0 +1,32 @@
+module EnvatoOptimiser
+  class TotalImageWeightCheck < Checks
+    # Initialize a total image weight check.
+    #
+    # @param image_urls [Array] Image URLs that you would like to fetch the
+    #   total image weight for.
+    #
+    # @return [Nothing].
+    def initialize(image_urls)
+      @total_image_weight = 0
+      get_total_image_weight(image_urls)
+    end
+
+    # Format the results into a usable Hash.
+    #
+    # @return [Hash] `:total_image_weight` is the total image size in bytes.
+    def to_h
+      {
+        :total_image_weight => @total_image_weight
+      }
+    end
+
+    private
+
+    def get_total_image_weight(image_urls)
+      image_urls.each do |image|
+        response = Net::HTTP.get_response(URI.parse(image))
+        @total_image_weight += response.content_length
+      end
+    end
+  end
+end

data/lib/envato_optimiser/item.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require 'uri'
+require 'nokogiri'
+
+module EnvatoOptimiser
+  class Item
+    # Initialize a new item page.
+    #
+    # @return [Nothing]
+    def initialize(item_url)
+      uri         = URI.parse(item_url)
+      response    = Net::HTTP.get_response(uri)
+      @document   = Nokogiri::HTML(response.body)
+      @image_urls = image_urls
+    end
+
+    # Run checks against a specific item page.
+    #
+    # @param skip_image_status_check [Boolean] Used for determining whether or
+    #   not the image HTTP response status checks should be run.
+    # @param skip_total_image_weight_check [Boolean] Determine whether or not
+    #   you would like to calculate the total image weight generated by the item
+    #   page.
+    #
+    # @return [Hash] Consolidated list of the checks output.
+    def check!(skip_image_status_check: false, skip_total_image_weight_check: false)
+      reports = []
+
+      reports << EnvatoOptimiser::ImageResponseStatusCodeCheck.new(@image_urls).to_h unless skip_image_status_check
+      reports << EnvatoOptimiser::TotalImageWeightCheck.new(@image_urls).to_h        unless skip_total_image_weight_check
+
+      reports.inject(&:merge)
+    end
+
+    private
+
+    # Gather all the image URLs.
+    #
+    # Loops over the document output and collects all of the image source values
+    #   within the defined CSS div where user input is declared.
+    #
+    # @return [Array] All the images found in the requested document.
+    def image_urls
+      images = []
+
+      @document.css('.user-html img').map do |image|
+        images << image.attributes['src'].value
+      end
+
+      # Don't choke on protocol relative URL's.
+      images.collect { |image| image.gsub(%r{^//}, 'https://') }
+    end
+  end
+end

data/lib/envato_optimiser/version.rb

@@ -0,0 +1,6 @@
+module EnvatoOptimiser
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: envato_optimiser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Bednarz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 
+email:
+- jacob.bednarz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- envato_optimiser.gemspec
+- lib/envato_optimiser.rb
+- lib/envato_optimiser/checks.rb
+- lib/envato_optimiser/checks/image_response_status_code_check.rb
+- lib/envato_optimiser/checks/total_image_weight_check.rb
+- lib/envato_optimiser/item.rb
+- lib/envato_optimiser/version.rb
+homepage: https://github.com/jacobbednarz/envato_optimiser
+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: A gem to make it easier to identify potential issues on your Envato item
+  pages.
+test_files: []