tiny_png_checker 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 304e6a5733b8d3b668fa5aaabbcb82a9715c4385b6e0bac579d83d7cfa93bec3
+  data.tar.gz: 1312e4a35a32bd0e618b5d5dd5ad42c3f0dabccf16e2ada2a7d25829aabd70fa
+SHA512:
+  metadata.gz: a8a9f08853da21ec98e0c7065598fb74e7cfa3f8cbc3dc347f1ca345ad21fdae758d61450972554ce75be0b9a71d0e18b03b2cb45b0d0d23448dfe16d75f4124
+  data.tar.gz: e533a8ed0ea8c2bc20b0c0c6e2a8d7a8818bcd1127fec8e9cb693b6812ef732f0a4d5142e479738b185bed21a4e12d29b4f834b1547257bbeca5ade7c428c44b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Ignore application configuration
+/config/application.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at damian.arrillaga@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tiny_png_checker.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    tiny_png_checker (0.1.1)
+      chunky_png (~> 1.3, >= 1.3.10)
+      commander (~> 4.4, >= 4.4.6)
+      figaro (~> 1.1, >= 1.1.1)
+      tinify (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chunky_png (1.3.10)
+    commander (4.4.6)
+      highline (~> 1.7.2)
+    figaro (1.1.1)
+      thor (~> 0.14)
+    highline (1.7.10)
+    httpclient (2.8.3)
+    minitest (5.11.3)
+    rake (10.5.0)
+    thor (0.20.0)
+    tinify (1.5.0)
+      httpclient (~> 2.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  tiny_png_checker!
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Damián Arrillaga
+
+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,43 @@
+# TinyPngChecker
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tiny_png_checker`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tiny_png_checker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny_png_checker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tiny_png_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TinyPngChecker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tiny_png_checker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tiny_png_checker'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/tiny_png_checker

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'tiny_png_checker'
+require 'tiny_png_checker/version'
+
+program :version, TinyPngChecker::VERSION
+program :description, 'Utils around TinyPNG platform'
+
+command :check do |c|
+  c.syntax = 'tiny_png_checker check [folders]'
+  c.description = 'Checks recursively into specified folders for PNG files marked by TinyPngProcessor'
+  c.option '--folders FOLDERS' , Array, 'List of folders to check'
+  c.action do |args, options|
+    checker = TinyPngChecker::Checker.new
+    say "Running under folders: #{options.folders}"
+    checker.check_tiny_png_on_folders(options.folders)
+    say "Done!"
+  end
+end
+
+command :compress do |c|
+  c.syntax = 'tiny_png_checker convert [folders]'
+  c.description = 'Compress recursively PNGs inside specified folders using TinyPNG and mark files with TinyPngProcessor flag'
+  c.option '--folders FOLDERS' , Array, 'List of folders to check'
+  c.action do |args, options|
+    say "Running under folders: #{options.folders}"
+    compressor = TinyPngChecker::Compressor.new
+    compressor.compress_pngs_on_folders(options.folders)
+    say "Done!"
+  end
+end

data/lib/config/application.yml

@@ -0,0 +1,3 @@
+# Add configuration values here, as shown below.
+
+tinify_api_key: "e3axBwb1wgc7egz6q5IX2wOIxrW9HP6H"

data/lib/tiny_png_checker.rb

@@ -0,0 +1,11 @@
+require 'tiny_png_checker/version'
+require 'tiny_png_checker/checker'
+require 'tiny_png_checker/compressor'
+
+require 'figaro'
+Figaro.application = Figaro::Application.new(environment: 'production', path: File.expand_path('../config/application.yml', __FILE__))
+Figaro.load
+
+module TinyPngChecker
+
+end

data/lib/tiny_png_checker/checker.rb

@@ -0,0 +1,22 @@
+require 'tiny_png_checker/utils/image_files_retriever'
+require 'tiny_png_checker/utils/tiny_png'
+
+module TinyPngChecker
+  class Checker
+
+    def check_tiny_png_on_folders(folders = [])
+      png_files = Utils::ImageFilesRetriever.get_png_files_from_folders(folders)
+
+      not_processed_files = Utils::TinyPng.not_processed_files(png_files)
+
+      if not_processed_files.any?
+        $stderr.puts("Files not processed by TinyPNG:")
+        $stderr.puts(not_processed_files)
+        abort
+      else
+        $stdout.puts("No files to process")
+      end
+    end
+
+  end
+end

data/lib/tiny_png_checker/compressor.rb

@@ -0,0 +1,64 @@
+require 'tinify'
+require 'figaro'
+require 'tiny_png_checker/utils/tiny_png'
+require 'tiny_png_checker/utils/image_files_retriever'
+
+module TinyPngChecker
+  class Compressor
+
+    def initialize
+      @errors = []
+      @processed = []
+    end
+
+    def compress_pngs_on_folders(folders = [])
+      begin
+        Tinify.key = Figaro.env.tinify_api_key
+        Tinify.validate!
+      rescue Tinify::Error => e
+        abort("Error: Tinify invalid api key #{e}")
+      end
+
+      @errors.clear
+      @processed.clear
+
+      png_files = Utils::ImageFilesRetriever.get_png_files_from_folders(folders)
+
+      not_processed_files = Utils::TinyPng.not_processed_files(png_files)
+
+      not_processed_files.each { |not_processed_file| process_file(not_processed_file) }
+
+      $stdout.puts("Compressed files:")
+      $stdout.puts(@processed)
+
+      if @errors.any?
+        $stderr.puts(@errors)
+        abort
+      end
+    end
+
+    def process_file(file)
+      begin
+        Tinify.from_file(file).to_file(file)
+        Utils::TinyPng.mark_files(file)
+        @processed << file
+      rescue Tinify::AccountError => e
+        @errors << "The error message is: #{e.message} with file #{file}, monthly conversion limit #{Tinify.compression_count}"
+          # Verify your API key and account limit.
+      rescue Tinify::ClientError => e
+        @errors << "Check your source image and request options, the error message is: #{e.message} with file #{file}"
+          # Check your source image and request options.
+      rescue Tinify::ServerError => e
+        @errors << "Temporary issue with the Tinify API, the error message is: #{e.message} with file #{file}"
+          # Temporary issue with the Tinify API.
+      rescue Tinify::ConnectionError => e
+        @errors << "A network connection error occurred, the error message is: #{e.message} with file #{file}"
+          # A network connection error occurred.
+      rescue => e
+        @errors << "An error occurred, the error message is: #{e.message} with file #{file}"
+        # Something else went wrong, unrelated to the Tinify API.
+      end
+    end
+
+  end
+end

data/lib/tiny_png_checker/utils/image_files_retriever.rb

@@ -0,0 +1,9 @@
+module Utils
+  module ImageFilesRetriever
+
+    def self.get_png_files_from_folders(folders)
+      folders.flat_map { |base_dir| Dir.glob("#{File.expand_path(base_dir)}/**/*.png") } || []
+    end
+
+  end
+end

data/lib/tiny_png_checker/utils/tiny_png.rb

@@ -0,0 +1,31 @@
+require 'chunky_png'
+
+module Utils
+  module TinyPng
+
+    PNG_PROCESSED_FLAG = 'TinyPNGProcessedFlag'
+    PNG_PROCESSED_FLAG_VALUE = 'P'
+
+    def self.not_processed_files(png_files = [])
+
+      png_files.select do |file|
+        image = ChunkyPNG::Image.from_file(file)
+        image.metadata[PNG_PROCESSED_FLAG].nil?
+      end
+
+    end
+
+    def self.mark_files(*png_files)
+
+      png_files.compact!
+
+      png_files.each do |file|
+        image = ChunkyPNG::Image.from_file(file)
+        image.metadata[PNG_PROCESSED_FLAG] = PNG_PROCESSED_FLAG_VALUE
+        image.save(file)
+      end
+
+    end
+
+  end
+end

data/lib/tiny_png_checker/version.rb

@@ -0,0 +1,3 @@
+module TinyPngChecker
+  VERSION = "0.1.1"
+end

data/tiny_png_checker.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tiny_png_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny_png_checker"
+  spec.version       = TinyPngChecker::VERSION
+  spec.authors       = ["Damian Arrillaga"]
+  spec.email         = ["damian.arrillaga@gmail.com"]
+
+  spec.summary       = %q{This library check for PNG metadata that indicates TinyPNG is applied on files}
+  spec.description   = %q{This library check for PNG metadata that
+indicates TinyPNG is applied on files, the idea is to avoid doing double compression and make for example the
+CI know that the file has been compressed, so a check can be done per build}
+  spec.homepage      = "https://github.com/darrillaga/TinyPngChecker"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "http://rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chunky_png", "~> 1.3", ">= 1.3.10"
+  spec.add_dependency "tinify", "~> 1.5"
+  spec.add_dependency "figaro", "~> 1.1", ">= 1.1.1"
+  spec.add_dependency "commander", "~> 4.4", ">= 4.4.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: tiny_png_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Damian Arrillaga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: tinify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: figaro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  This library check for PNG metadata that
+  indicates TinyPNG is applied on files, the idea is to avoid doing double compression and make for example the
+  CI know that the file has been compressed, so a check can be done per build
+email:
+- damian.arrillaga@gmail.com
+executables:
+- tiny_png_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tiny_png_checker
+- lib/config/application.yml
+- lib/tiny_png_checker.rb
+- lib/tiny_png_checker/checker.rb
+- lib/tiny_png_checker/compressor.rb
+- lib/tiny_png_checker/utils/image_files_retriever.rb
+- lib/tiny_png_checker/utils/tiny_png.rb
+- lib/tiny_png_checker/version.rb
+- tiny_png_checker.gemspec
+homepage: https://github.com/darrillaga/TinyPngChecker
+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.7.6
+signing_key: 
+specification_version: 4
+summary: This library check for PNG metadata that indicates TinyPNG is applied on
+  files
+test_files: []