img_overlay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e52861bbf7dde7b7255a0dd54644b10f9c6e455
+  data.tar.gz: 7a49a8193399491524c551bc80401dea944c7588
+SHA512:
+  metadata.gz: 53de81a4d242adecc74ada64d86d1a52a05f22ff7ff932592fa81629ef0c6e8fb112a80cdfa8a15babd2225d1e59679a28ba7b3f887097dd9608a5acfecc129c
+  data.tar.gz: 6f439f2e743d5e427ab4b32264bf6c83f842b079591ca3a46f3e6964c80cb4c52dc88966e0648964b965a6ba44efe564334b75de6405d43fc0679be117e4557f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at khoj.badami@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Khoj Badami
+
+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,75 @@
+# ImgOverlay
+
+This is a simple gem that gives you your image back overlay-ed with some color.
+
+## What is the point of this gem?
+
+Well, I originally created it because I wanted a fast way to turn image URLs into hero images to use on web-pages. Hero images, have some text on them usually. So that they text is readable, they need to be overlay-ed.
+
+![](https://static.wixstatic.com/media/09e926b98b2149c7ba461062b8a64f47.jpg)
+
+See how the title "The smartest way to manage your data" is on some image that is overlay-ed with a purple color that goes with the sites branding? Thats what this gem does.
+
+## Dependencies
+
+The gem depends on ImageMagic to be installed on your computer. It just shells out and runs ImageMagic commands.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'img_overlay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install img_overlay
+
+## Usage
+
+Add the gem to your gem file or install it via the command line as shown in the installation section.
+
+To use this, you just have to specify all the info in the form of a hash. There are 3 hashes that are needed:
+
+1. **Input Hash**: This can have the URL of the image / file path of the image
+2. **Color Hash**: The RGB values of the color for the overlay & the opacity of the overlay layer
+3. **Output Hash**: A location where the final output image needs to be stored
+
+### Example
+
+```ruby
+require 'img_overlay'
+
+include ImgOverlay
+
+success = make_image_with_overlay(
+    input: {
+      url: "http://craftypioneer.com/wp-content/uploads/2016/01/businessMeeting.jpg" 
+    },
+    color: {
+        r: 0,
+        g: 0,
+        b: 0,
+        opacity: 0.6
+    },
+    output: {
+       path: '/Users/khojbadami/test.jpg'
+    }
+)
+```
+
+That's it. It all works, you will get a true or a false.
+
+## Testing
+
+This gem needs more tests and development around validating user input and giving helpful error messages. Just now, it will simply fail. It needs better feedback for users when the inputs are not right. It also needs better error messages when the inputs are funny.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "img_overlay"
+
+# 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

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/img_overlay.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'img_overlay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "img_overlay"
+  spec.version       = ImgOverlay::VERSION
+  spec.authors       = ["Khoj Badami"]
+  spec.email         = ["khoj.badami@gmail.com"]
+
+  spec.summary       = "Simple gem to add an overlay on your image. Input: Image & Color. Output: Image with overlay!"
+  spec.description   = "Given an image path/URL and a color in RGB, you get back an image with an overlay on it (with the given color)."
+  spec.homepage      = "https://github.com/scotch-bright/img_overlay"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/img_overlay/final_image.rb

@@ -0,0 +1,22 @@
+module ImgOverlay
+  
+  class FinalImage
+
+    def initialize(orignal_image_path:, overlay_image_path:, final_image_path:)
+      @orignal_image_path = orignal_image_path
+      @overlay_image_path = overlay_image_path
+      @final_image_path = final_image_path
+    end
+
+    def command
+      "composite -gravity Center #{@overlay_image_path} #{@orignal_image_path} #{@final_image_path}"
+    end
+
+    def generate!
+      #puts "about to run command:: #{command}"
+      `#{command}`
+    end
+
+  end
+
+end

data/lib/img_overlay/helper.rb

@@ -0,0 +1,46 @@
+require 'tempfile'
+
+module ImgOverlay
+
+  class Helper
+
+    class << self
+
+      def get_input_image input_hash
+        if is_image_url_given?(input_hash)
+          get_image_path_from_url(input_hash[:url])
+        else
+          input_hash[:path]
+        end
+      end
+
+      private
+
+      def get_image_path_from_url(url)
+        otuput = get_temp_file_path
+        id = ImgOverlay::ImageDownloader.new(
+          url: url,
+          path: otuput  
+        )
+        if id.download!.nil?
+          return nil
+        else
+          return otuput
+        end
+      end
+
+      def get_temp_file_path
+        temp_file = Tempfile.new('image')
+        temp_file.path
+      end
+
+      def is_image_url_given? input_hash
+        return false if input_hash[:url].nil?
+        return true
+      end
+
+    end
+
+  end
+
+end

data/lib/img_overlay/image_downloader.rb

@@ -0,0 +1,56 @@
+require "open-uri"
+
+module ImgOverlay
+  
+  class ImageDownloader
+
+    def initialize(url:, path:)
+      @image_url = url
+      @full_file_path = path
+    end
+
+    def download!
+      open_uri_file_object = get_file_object
+      if open_uri_file_object.nil?
+        return false
+      else
+        if file_acceptable?(open_uri_file_object)
+          save_file open_uri_file_object
+          return true
+        else
+          return false
+        end
+      end
+    end
+
+    private
+
+    def save_file open_uri_file_object
+      File.open(@full_file_path, 'wb') do |fo|
+        fo.write open_uri_file_object.read 
+      end
+    end
+
+    def get_file_object
+      begin
+        return open(@image_url)
+      rescue
+        return nil
+      end
+    end
+
+    def file_acceptable?(open_uri_file_object)
+      if open_uri_file_object.status[0] == "200" && accepted_mime_types.include?(open_uri_file_object.content_type)
+        return true
+      else
+        return false
+      end
+    end
+
+    def accepted_mime_types
+      ['image/gif', 'image/jpeg', 'image/png']
+    end
+
+  end
+
+end

data/lib/img_overlay/image_size.rb

@@ -0,0 +1,62 @@
+require 'open3'
+
+module ImgOverlay
+  
+  class ImageSize
+
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def width
+      @width ||= get_image_size_hash[:width]
+    end
+
+    def height
+      @height ||= get_image_size_hash[:height]
+    end
+
+    private
+
+    def get_image_size_hash
+      @result ||= execute_command
+      if @result[:success]
+        convert_command_line_result_into_hash
+      else
+        invalid_image_path_hash
+      end
+    end
+
+    def convert_command_line_result_into_hash
+      output = @result[:output]
+      width_str = output.split("x")[0]
+      height_str = output.split("x")[1]
+      {
+        width: width_str.to_i,
+        height: height_str.to_i
+      }
+    end
+
+    def invalid_image_path_hash
+      {
+        width: nil,
+        height: nil
+      }
+    end
+
+    def execute_command
+      stdout, stderr, status = Open3.capture3(commmand)
+      return {
+        success: status.success?,
+        output: stdout,
+        error: stderr
+      }
+    end
+
+    def commmand
+      "convert #{@file_path} -format \"%wx%h\" info:"
+    end
+
+  end
+
+end

data/lib/img_overlay/overylay_image.rb

@@ -0,0 +1,26 @@
+module ImgOverlay
+  
+  class OverylayImage
+
+    def initialize(width:, height:, color_r:, color_g:, color_b:, opacity:, output_path:)
+      @width = width
+      @height = height
+      @color_r = color_r
+      @color_g = color_g
+      @color_b = color_b
+      @opacity = opacity
+      @output_path = output_path
+    end
+
+    def command
+      "convert -size #{@width}x#{@height} canvas:rgba\\(#{@color_r},#{@color_g},#{@color_b},#{@opacity}\\) #{@output_path}"
+    end
+
+    def generate!
+      #puts "about to run command:: #{command}"
+      `#{command}`
+    end
+
+  end
+
+end

data/lib/img_overlay/version.rb

@@ -0,0 +1,3 @@
+module ImgOverlay
+  VERSION = "0.1.0"
+end

data/lib/img_overlay.rb

@@ -0,0 +1,50 @@
+require "img_overlay/version"
+require "img_overlay/image_size"
+require "img_overlay/image_downloader"
+require "img_overlay/overylay_image"
+require "img_overlay/final_image"
+require "img_overlay/helper"
+
+module ImgOverlay
+  
+  def make_image_with_overlay(input:, color:, output:)
+
+    image_path = ImgOverlay::Helper.get_input_image(input)
+    
+    if image_path.nil?
+
+      return nil
+    
+    else
+      
+      # Get image size
+      image_size = ImgOverlay::ImageSize.new(image_path)
+
+      temp_overlay_image_path = File.join(Dir.pwd, 'overlay.png')
+
+      # Generate overlay Image
+      ImgOverlay::OverylayImage.new(
+        width: image_size.width, 
+        height: image_size.height, 
+        color_r: color[:r],
+        color_g: color[:g], 
+        color_b: color[:b],
+        opacity: color[:opacity],
+        output_path: temp_overlay_image_path
+      ).generate!
+
+      # Make Final Image
+      ImgOverlay::FinalImage.new(
+        orignal_image_path: image_path, 
+        overlay_image_path: temp_overlay_image_path,
+        final_image_path: output[:path]
+      ).generate!
+
+      FileUtils.rm(temp_overlay_image_path)
+
+      return true
+
+    end
+  end
+
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: img_overlay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Khoj Badami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: Given an image path/URL and a color in RGB, you get back an image with
+  an overlay on it (with the given color).
+email:
+- khoj.badami@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- img_overlay.gemspec
+- lib/img_overlay.rb
+- lib/img_overlay/final_image.rb
+- lib/img_overlay/helper.rb
+- lib/img_overlay/image_downloader.rb
+- lib/img_overlay/image_size.rb
+- lib/img_overlay/overylay_image.rb
+- lib/img_overlay/version.rb
+homepage: https://github.com/scotch-bright/img_overlay
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: 'Simple gem to add an overlay on your image. Input: Image & Color. Output:
+  Image with overlay!'
+test_files: []