simple-images-downloader 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d6712c3ea229e3cb09526ef0f0144f79fa9dcf1d7af6f20b23a83502ea34be1
-  data.tar.gz: b1147429efdf91682067decf309aec22050f2ed835b0b0261560f93fd6a63aa6
+  metadata.gz: 902c3b0e5fe1566296ac139123707162e33ded87accc9ff5705231fb3fa96f4f
+  data.tar.gz: c2812c8d700ca81d1f29b6a29d0063aef74b9dfd3162c652453733870b8073fe
 SHA512:
-  metadata.gz: b3cf6db2633b3ebf0e094482079193fa2dbcb75e169c70ea3778e9c46b00abbdae4089378c36d8570630aa0698ca5343ee1a97e67f6e8e193c1d234c240bb35f
-  data.tar.gz: cd9645e49d0a1658c74a6acde0a5608bd5a79fea67acda6235057c018066aaee7b5352ca150a5bf77d926189cd41dfb43950e62f0257edab98f31fc25f7a3f1b
+  metadata.gz: 5501d04aa338c0f992d391d94a5b29e8b63a410938c7a8f31941ed3178b2efa63a6ef84b9bb419f87278880197498367eeb235dea017509c57c708f758f7b4ab
+  data.tar.gz: 26ba7c6dbd4cfdf1e34750ce6b3f7e99650511ba56597a7c8ab1ee7950c210f7919f0a1104053fcc6195bec822b215678e9c8bc5015fee9d6fc8ae6eb27612e7

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+## 1.1.0 - 2023-09-30
+- Add validation of downloaded content over path validation
+- Add ability to extend mime types from configuration
+- Removed zeitwerk
+- Refactored main interface
+
 ## 1.0.3 - 2023-09-27
 - Corrected destination validation in SimpleImagesDownloader::Dispenser
-- Corrected source file validation in SimpleImagesDownloader::SourceFiles
+- Corrected source file validation in SimpleImagesDownloader::SourceFile
 - Refactored
 - Fixed error message when destination is invalid
 

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    simple-images-downloader (1.0.3)
-      zeitwerk (~> 2.4.0)
+    simple-images-downloader (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -76,7 +75,6 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -33,7 +33,7 @@ Or install it yourself as:
 
 The gem is provided with executable.
 
-You can either run plain commmand with file containing list of url:
+You can either run plain command with file containing list of url:
 
 ```bash
 simple-images-downloader <path_to_file>
@@ -67,6 +67,7 @@ Downloading https://test-for-simple-images-downloader.s3.eu-central-1.amazonaws.
 Downloading is finished
 ```
 
+## Configuration
 **By default the images stored in a directory the script is run.**
 You can also configure the place where the images would be stored to:
 
@@ -78,6 +79,18 @@ You can also configure the place where the images would be stored to:
 [2] pry(main)* end
 ```
 
+**By default the gem downloads only images with mime types: image/avif, image/gif, image/apng, image/jpg, image/jpeg, image/png, image/svg+xml, image/webp.**
+You can also configure the mime types to download images with:
+
+
+```ruby
+[1] pry(main)> require 'simple_images_downloader'
+
+[2] pry(main)> SimpleImagesDownloader::Configuration.configure do  |config|
+[2] pry(main)*   # You must use RFC 1341 - MIME (Multipurpose Internet Mail Extensions) format
+[2] pry(main)*   config.valid_mime_types = %w(image/png image/jpg image/jpeg)
+[2] pry(main)* end
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/simple_images_downloader/configuration.rb

@@ -6,6 +6,7 @@ module SimpleImagesDownloader
 
     ACCESSORS = %i[
       destination
+      valid_mime_types
     ].freeze
 
     REQUEST_OPTIONS = {
@@ -15,10 +16,31 @@ module SimpleImagesDownloader
       read_timeout: 30
     }.freeze
 
+    # https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types#common_image_file_types
+    DEFAULT_VALID_MIME_TYPES_MAP = {
+      'image/avif' => true,
+      'image/gif' => true,
+      'image/apng' => true,
+      'image/jpg' => true,
+      'image/jpeg' => true,
+      'image/png' => true,
+      'image/svg+xml' => true,
+      'image/webp' => true
+    }.freeze
+
+    DEFAULT_DESTINATION = './'
+
     attr_accessor(*ACCESSORS)
 
     def initialize
-      @destination = './'
+      @destination = DEFAULT_DESTINATION
+      @valid_mime_types = DEFAULT_VALID_MIME_TYPES_MAP.keys
+    end
+
+    def valid_mime_types=(value)
+      raise BaseError, 'valid_mime_types must be an array' unless value.is_a?(Array)
+
+      @valid_mime_types = value
     end
 
     def self.configure

data/lib/simple_images_downloader/dispenser.rb

@@ -14,7 +14,7 @@ module SimpleImagesDownloader
     end
 
     def place
-      validate!(destination_dir)
+      validate!({ path: destination_dir })
 
       FileUtils.mv @source, target
     end

data/lib/simple_images_downloader/downloader.rb

@@ -2,22 +2,31 @@
 
 module SimpleImagesDownloader
   class Downloader
-    def initialize(uri)
-      @uri = uri
+    include Validatable
+
+    def initialize(uri, client = Client.new, validators = [MimeTypeValidator.new])
+      @uri        = uri
+      @client     = client
+      @validators = validators
     end
 
     def download
       puts "Downloading #{@uri}"
 
-      io = Client.new.open(@uri)
+      io = @client.open(@uri)
+
+      raise Errors::EmptyResponse, @uri if io.nil?
+
+      validate!({ path: @uri.to_s, io: io })
 
-      downloaded_file = StringioToTempfile.convert(io) unless io.nil?
+      tempfile = StringioToTempfile.convert(io)
 
-      Dispenser.new(downloaded_file, @uri.path).place
+      Dispenser.new(tempfile, @uri.path).place
 
       puts 'Downloading is finished'
     ensure
-      downloaded_file&.close
+      io&.close
+      tempfile&.close
     end
   end
 end

data/lib/simple_images_downloader/errors.rb

@@ -25,9 +25,9 @@ module SimpleImagesDownloader
       end
     end
 
-    class MissingImageInPath < BaseError
-      def initialize(path)
-        message = "The path doesn't contain image #{path}"
+    class BadMimeType < BaseError
+      def initialize(path, mime_type)
+        message = "The image with path: #{path} has wrong mime type #{mime_type}"
         super(message)
       end
     end
@@ -66,5 +66,12 @@ module SimpleImagesDownloader
         super(message)
       end
     end
+
+    class EmptyResponse < BaseError
+      def initialize(uri)
+        message = "Nothing returned from request #{uri}"
+        super(message)
+      end
+    end
   end
 end

data/lib/simple_images_downloader/line.rb

@@ -2,19 +2,12 @@
 
 module SimpleImagesDownloader
   class Line
-    include Validatable
-
-    def initialize(string, validators = [ImagePathValidator.new])
-      @string     = string
-      @validators = validators
+    def initialize(string)
+      @string = string
     end
 
     def uri
-      parsed_uri = URI.parse(@string)
-
-      validate!(@string)
-
-      parsed_uri
+      URI.parse(@string)
     rescue URI::Error
       raise Errors::BadUrl, @string
     end

data/lib/simple_images_downloader/source_file.rb

@@ -10,7 +10,7 @@ module SimpleImagesDownloader
     end
 
     def each_line(&block)
-      validate!(@path)
+      validate!({ path: @path })
 
       begin
         file.each(chomp: true, &block)

data/lib/simple_images_downloader/strategies/from_file_strategy.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SimpleImagesDownloader
+  module Strategies
+    class FromFileStrategy < Strategy
+      def initialize(path)
+        super
+        @path = path
+      end
+
+      def process
+        source_file = SourceFile.new(@path)
+
+        source_file.each_line do |line|
+          uri = Line.new(line).uri
+          Downloader.new(uri).download
+        rescue Errors::BaseError => e
+          puts e.message
+          next
+        end
+      end
+    end
+  end
+end

data/lib/simple_images_downloader/strategies/from_url_strategy.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SimpleImagesDownloader
+  module Strategies
+    class FromUrlStrategy < Strategy
+      def initialize(url)
+        super
+        @url = url
+      end
+
+      def process
+        uri = Line.new(@url).uri
+
+        Downloader.new(uri).download
+      end
+    end
+  end
+end

data/lib/simple_images_downloader/strategies/strategy.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SimpleImagesDownloader
+  module Strategies
+    class Strategy
+      def initialize(_)
+      end
+
+      def process
+        raise NotImplementedError, 'must be implemented in subclass'
+      end
+    end
+  end
+end

data/lib/simple_images_downloader/stringio_to_tempfile.rb

@@ -9,8 +9,6 @@ module SimpleImagesDownloader
 
       IO.copy_stream(stringio, tempfile)
 
-      stringio.close
-
       OpenURI::Meta.init tempfile, stringio
 
       tempfile

data/lib/simple_images_downloader/validatable/destination_validator.rb

@@ -3,9 +3,11 @@
 module SimpleImagesDownloader
   module Validatable
     class DestinationValidator < Validator
-      def validate(destination_dir)
-        raise Errors::DestinationIsNotDirectory, destination_dir unless File.directory?(destination_dir)
-        raise Errors::DestinationIsNotWritable, destination_dir unless File.writable?(destination_dir)
+      def validate(options)
+        path = options[:path]
+
+        raise Errors::DestinationIsNotDirectory, path unless File.directory?(path)
+        raise Errors::DestinationIsNotWritable, path unless File.writable?(path)
       end
     end
   end

data/lib/simple_images_downloader/validatable/file_accessibility_validator.rb

@@ -3,10 +3,10 @@
 module SimpleImagesDownloader
   module Validatable
     class FileAccessibilityValidator < Validator
-      def validate(path)
-        return if File.readable?(path)
+      def validate(options)
+        return if File.readable?(options[:path])
 
-        raise Errors::PermissionsError, path
+        raise Errors::PermissionsError, options[:path]
       end
     end
   end

data/lib/simple_images_downloader/validatable/file_persistance_validator.rb

@@ -3,10 +3,10 @@
 module SimpleImagesDownloader
   module Validatable
     class FilePersistanceValidator < Validator
-      def validate(path)
-        return if File.exist?(path)
+      def validate(options)
+        return if File.exist?(options[:path])
 
-        raise Errors::MissingFileError, path
+        raise Errors::MissingFileError, options[:path]
       end
     end
   end

data/lib/simple_images_downloader/validatable/mime_type_validator.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SimpleImagesDownloader
+  module Validatable
+    class MimeTypeValidator < Validator
+      extend Forwardable
+
+      def_delegator 'SimpleImagesDownloader::Configuration', :valid_mime_types, :valid_mime_types
+
+      def validate(options)
+        path = options[:path]
+        io   = options[:io]
+
+        mime_type = mime_type_of(io)
+
+        return if Configuration::DEFAULT_VALID_MIME_TYPES_MAP[mime_type]
+
+        raise Errors::BadMimeType.new(path, mime_type)
+      end
+
+      private
+
+      # Taken from Shrine https://github.com/shrinerb/shrine/blob/master/lib/shrine/plugins/determine_mime_type.rb#L94
+      def mime_type_of(io)
+        Open3.popen3('file --mime-type --brief -') do |stdin, stdout, stderr, thread|
+          copy_stream(from: io, to: stdin.binmode)
+
+          io.rewind
+          stdin.close
+
+          status = thread.value
+
+          validate_thread_status(status)
+          $stderr.print(stderr.read)
+
+          output = stdout.read.strip
+
+          validate_command_output(output)
+
+          output
+        end
+      end
+
+      def copy_stream(from:, to:)
+        IO.copy_stream(from, to)
+      rescue Errno::EPIPE # rubocop:disable Lint/SuppressedException
+      end
+
+      def validate_thread_status(status)
+        raise Errors::BaseError, "file command failed to spawn: #{stderr.read}" if status.nil?
+        raise Errors::BaseError, "file command failed: #{stderr.read}" unless status.success?
+      end
+
+      def validate_command_output(output)
+        raise Errors::BaseError, "file command failed: #{output}" if output.include?('cannot open')
+      end
+    end
+  end
+end

data/lib/simple_images_downloader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/lib/simple_images_downloader.rb

@@ -4,27 +4,34 @@ require 'open-uri'
 require 'tempfile'
 require 'forwardable'
 require 'singleton'
-require 'zeitwerk'
-
-loader = Zeitwerk::Loader.for_gem
-loader.setup
+require 'open3'
+require_relative 'simple_images_downloader/version'
+require_relative 'simple_images_downloader/errors'
+require_relative 'simple_images_downloader/configuration'
+require_relative 'simple_images_downloader/validatable'
+require_relative 'simple_images_downloader/validatable/validator'
+require_relative 'simple_images_downloader/validatable/destination_validator'
+require_relative 'simple_images_downloader/validatable/file_accessibility_validator'
+require_relative 'simple_images_downloader/validatable/file_persistance_validator'
+require_relative 'simple_images_downloader/validatable/mime_type_validator'
+require_relative 'simple_images_downloader/stringio_to_tempfile'
+require_relative 'simple_images_downloader/client'
+require_relative 'simple_images_downloader/source_file'
+require_relative 'simple_images_downloader/runner'
+require_relative 'simple_images_downloader/line'
+require_relative 'simple_images_downloader/dispenser'
+require_relative 'simple_images_downloader/strategies/strategy'
+require_relative 'simple_images_downloader/downloader'
+require_relative 'simple_images_downloader/strategies/from_file_strategy'
+require_relative 'simple_images_downloader/strategies/from_url_strategy'
 
 module SimpleImagesDownloader
   def self.from_file(path)
-    source_file = SourceFile.new(path)
-
-    source_file.each_line do |line|
-      uri = Line.new(line).uri
-      Downloader.new(uri).download
-    rescue Errors::BaseError => e
-      puts e.message
-      next
-    end
+    SimpleImagesDownloader::Strategies::FromFileStrategy.new(path).process
   end
 
   def self.from_url(url)
-    uri = Line.new(url).uri
-    Downloader.new(uri).download
+    SimpleImagesDownloader::Strategies::FromUrlStrategy.new(url).process
   end
 
   def self.root

data/rubocop.yml

@@ -69,6 +69,9 @@ Layout/LineLength:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/MethodLength:
+ Max: 11
+
 Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
   SupportedStylesAlignWith:

data/simple_images_downloader.gemspec

@@ -30,8 +30,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'zeitwerk', '~> 2.4.0'
-
   spec.add_development_dependency 'faker', '~> 2.14'
   spec.add_development_dependency 'pry', '~> 0.13.1'
   spec.add_development_dependency 'rake', '~> 12.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-images-downloader
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - IlkhamGaysin
@@ -10,20 +10,6 @@ bindir: exe
 cert_chain: []
 date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -214,12 +200,15 @@ files:
 - lib/simple_images_downloader/line.rb
 - lib/simple_images_downloader/runner.rb
 - lib/simple_images_downloader/source_file.rb
+- lib/simple_images_downloader/strategies/from_file_strategy.rb
+- lib/simple_images_downloader/strategies/from_url_strategy.rb
+- lib/simple_images_downloader/strategies/strategy.rb
 - lib/simple_images_downloader/stringio_to_tempfile.rb
 - lib/simple_images_downloader/validatable.rb
 - lib/simple_images_downloader/validatable/destination_validator.rb
 - lib/simple_images_downloader/validatable/file_accessibility_validator.rb
 - lib/simple_images_downloader/validatable/file_persistance_validator.rb
-- lib/simple_images_downloader/validatable/image_path_validator.rb
+- lib/simple_images_downloader/validatable/mime_type_validator.rb
 - lib/simple_images_downloader/validatable/validator.rb
 - lib/simple_images_downloader/version.rb
 - rubocop.yml

data/lib/simple_images_downloader/validatable/image_path_validator.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module SimpleImagesDownloader
-  module Validatable
-    class ImagePathValidator < Validator
-      VALID_EXTENSIONS = %w[.png .jpg .gif .jpeg].freeze
-
-      def validate(path)
-        extension = File.extname(path)
-
-        return if VALID_EXTENSIONS.include?(extension)
-
-        raise Errors::MissingImageInPath, path
-      end
-    end
-  end
-end