picfisher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da4504372d6b3cceb6deda036fda5f51f8d46c44726ebed76636aa02c49fa4b9
+  data.tar.gz: 446d39d4044826782748ca34c5a346560d6ae5490290afeb371323976ace6b06
+SHA512:
+  metadata.gz: 5d2921671fd3e415c4f354ec1f0e67c62d95d3e2a470f4c1dd4db5de44169984d4ad42ee9657e246c6555f1ac18b312d05e8c9e12e37290bda3ae776b582d727
+  data.tar.gz: 7be9a0990f49777ddd3d911801d1a3ef61b69c966df20dc483b6c870c9731bf6812109bfe6af22dab5e40f000e2d3b4a523fcef2a4c9673de561787300a9e563

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-05-30
+
+### Added
+
+- Main features implemented
+- README.md updated

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Fernando Guillen
+
+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,47 @@
+# PicFisher
+
+Send the fisher to fish your images for you. Give it a list of image urls in a flexible
+formatted text file and it will go fishing to the internet for you
+
+## Installation
+
+```
+gem install picfisher
+```
+
+## Usage
+
+```
+picfisher [images_file_path] [output_directory_path]
+```
+
+For example:
+
+```
+mkdir ~/Downloads/fished_images
+picfisher images.txt ~/Downloads/fished_images
+```
+
+With log
+
+```
+DEBUG_LEVEL=debug picfisher images.txt ~/Downloads/fished_images
+```
+
+Accepted values for `DEBUG_LEVEL`: `debug`, `info`, `error`.
+
+## 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.
+
+Use `exe/picfisher` to try your development version of the command line command.
+
+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 the created tag, 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/fguillen/PicFisher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/TODO.md

@@ -0,0 +1,7 @@
+# TODO
+
+- Create the output directory if it doesn't exist. Or add a parameter to allow the user to decide this.
+- Check if the Downloader is going to overwrite a file that already exists. Add an option to `force` if not stop with an error.
+- Add a progress bar for the downloading phase.
+- Allow multiple concurrent downloads. Add an extra param to decide the number, default `5`
+- Add error handling to the Downloader. Many things can be wrong when connecting to the internet.

data/exe/picfisher

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "picfisher"
+
+PicFisher.fish(ARGV[0], ARGV[1])

data/lib/picfisher/downloader.rb

@@ -0,0 +1,16 @@
+require "open-uri"
+
+module PicFisher
+  module Downloader
+    # TODO: We need to add error handling here
+    def self.download(url, output_path)
+      PicFisher::Log.debug("Downloading #{url} to #{output_path}")
+
+      io_stream = OpenURI::open_uri(url)
+
+      File.open(output_path, "wb") do |f|
+        f.write(io_stream.read)
+      end
+    end
+  end
+end

data/lib/picfisher/fishing_boat.rb

@@ -0,0 +1,15 @@
+module PicFisher
+  module FishingBoat
+    # REVIEW: we could use keyword params if we see it adds readability
+    def self.fish(images_file_path, output_directory_path)
+      PicFisher::Log.info("Fishing from #{images_file_path} to #{output_directory_path}")
+
+      file_to_string = File.read(images_file_path)
+      urls = PicFisher::URLExtractor.extract(file_to_string)
+      urls.each do |url|
+        sanitized_url = PicFisher::Sanitizer.sanitize_image_url(url)
+        PicFisher::Downloader.download(url, "#{output_directory_path}/#{sanitized_url}")
+      end
+    end
+  end
+end

data/lib/picfisher/log.rb

@@ -0,0 +1,28 @@
+module PicFisher
+  module Log
+    def self.debug(message)
+      if ["debug"].include? ENV["DEBUG_LEVEL"]
+        output(:debug, message)
+      end
+    end
+
+    def self.info(message)
+      if ["debug", "info"].include? ENV["DEBUG_LEVEL"]
+        output(:info, message)
+      end
+    end
+
+    def self.error(message)
+      if ["debug", "info", "error"].include? ENV["DEBUG_LEVEL"]
+        output(:error, message)
+      end
+    end
+
+    private
+
+    def self.output(level, message)
+      final_message = "PicFisher [#{level.upcase}] #{message}"
+      Kernel.puts(final_message)
+    end
+  end
+end

data/lib/picfisher/sanitizer.rb

@@ -0,0 +1,20 @@
+module PicFisher
+  module Sanitizer
+    def self.sanitize_image_url(url)
+      filename_extension = File.extname(url)
+      filename_extension_escaped = Regexp.escape(filename_extension) # to escape the dot "."
+      result =
+        url
+          .sub(/#{filename_extension_escaped}$/, "")
+          .gsub(/[^\w\s_-]+/, "_")
+          .gsub(/(^|\b\s)\s+($|\s?\b)/, "\\1\\2")
+          .gsub(/\s+/, "_")
+
+      result = "#{result}#{filename_extension}"
+
+      PicFisher::Log.debug("Sanitizing url '#{url}': #{result}")
+
+      result
+    end
+  end
+end

data/lib/picfisher/url_extractor.rb

@@ -0,0 +1,21 @@
+require "uri"
+
+module PicFisher
+  module URLExtractor
+    # NOTE: using URI.regexp(["http", "https"]) didn't work for me
+    URL_REGEX = /https?:\/\/[^\s,]+/
+    IMAGE_EXTENSITONS = %w(.jpg .jpeg .png .gif .webp .bmp .ico .svg .tiff or .tif .psd .raw .cr2 .nrw .arw .dng .nef .orf .sr2 .raf .tif .tiff .djvu)
+
+    def self.extract(string)
+      result =
+        string
+          .scan(URL_REGEX)
+          .select { |url| url.end_with?(*IMAGE_EXTENSITONS) }
+          .uniq
+
+      PicFisher::Log.debug("Extracted urls: #{result.join("|")}")
+
+      result
+    end
+  end
+end

data/lib/picfisher/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PicFisher
+  VERSION = "0.1.0"
+end

data/lib/picfisher.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "picfisher/version"
+require_relative "picfisher/sanitizer"
+require_relative "picfisher/url_extractor"
+require_relative "picfisher/downloader"
+require_relative "picfisher/fishing_boat"
+require_relative "picfisher/log"
+
+module PicFisher
+  class Error < StandardError; end
+
+  # REVIEW: we could use keyword params if we see it adds readability
+  def self.fish(images_file_path, output_directory_path)
+    PicFisher::Log.info "PicFisher is running..."
+
+    if images_file_path.nil? || output_directory_path.nil?
+      message = "Use: picfisher [images_file_path] [output_directory_path]"
+      PicFisher::Log.error(message)
+      raise PicFisher::Error.new(message)
+    end
+
+    if !File.exist?(images_file_path)
+      message = "File not found: #{images_file_path}"
+      PicFisher::Log.error(message)
+      raise PicFisher::Error.new(message)
+    end
+
+    if !Dir.exist?(output_directory_path)
+      message = "Directory not found: #{images_file_path}"
+      PicFisher::Log.error(message)
+      raise PicFisher::Error.new(message)
+    end
+
+    PicFisher::FishingBoat.fish(images_file_path, output_directory_path)
+    PicFisher::Log.info "PicFisher is finished!"
+  end
+end

data/sig/picfisher.rbs

@@ -0,0 +1,4 @@
+module PicFisher
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: picfisher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fernando Guillen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open-uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Reading all the image URLs from a given text file and download them to
+  a given directory.
+email:
+- fguillen.mail@gmail.com
+executables:
+- picfisher
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- exe/picfisher
+- lib/picfisher.rb
+- lib/picfisher/downloader.rb
+- lib/picfisher/fishing_boat.rb
+- lib/picfisher/log.rb
+- lib/picfisher/sanitizer.rb
+- lib/picfisher/url_extractor.rb
+- lib/picfisher/version.rb
+- sig/picfisher.rbs
+homepage: https://github.com/fguillen/PicFisher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fguillen/PicFisher
+  source_code_uri: https://github.com/fguillen/PicFisher
+  changelog_uri: https://github.com/fguillen/PicFisher/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key:
+specification_version: 4
+summary: Command line tool to download images from a text file.
+test_files: []