simple-images-downloader 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 902c3b0e5fe1566296ac139123707162e33ded87accc9ff5705231fb3fa96f4f
-  data.tar.gz: c2812c8d700ca81d1f29b6a29d0063aef74b9dfd3162c652453733870b8073fe
+  metadata.gz: 0e7adf857ef1d9f8490a079e5828b6025d0b44a21ec098bfc0012124c61223a9
+  data.tar.gz: 50175489068f5c9c7587b940d0690d335f8787f4e78c3f7ede9b26982b13b1c5
 SHA512:
-  metadata.gz: 5501d04aa338c0f992d391d94a5b29e8b63a410938c7a8f31941ed3178b2efa63a6ef84b9bb419f87278880197498367eeb235dea017509c57c708f758f7b4ab
-  data.tar.gz: 26ba7c6dbd4cfdf1e34750ce6b3f7e99650511ba56597a7c8ab1ee7950c210f7919f0a1104053fcc6195bec822b215678e9c8bc5015fee9d6fc8ae6eb27612e7
+  metadata.gz: e205d6d7feb52617f2d526765dd3b3f82509d5cfc2343ca90dbf966966784fa8099cae222904b245ff338d46f5f38883a648d50914c39ec7d3b285af0c6e61a6
+  data.tar.gz: 2660f410b9d48c4876e48fd387c69ad12707b29fef9e02ccb453331fc557c42249d0311da6f0df9eafe50e894ce23fa50c7260d2a6b4f091664ab3247b8dbcbe

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.1 - 2023-09-30
+- Fixed setting of mime types from configuration. It was using default values instead of the ones set in the configuration
+- Added documentation to classes and methods
+
 ## 1.1.0 - 2023-09-30
 - Add validation of downloaded content over path validation
 - Add ability to extend mime types from configuration

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple-images-downloader (1.1.0)
+    simple-images-downloader (1.1.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/simple_images_downloader/client.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # add documentation to this class using YARD
+
+  # Client class
+  # Responsible for opening the URI and handling errors
+  #
+  # @example
+  #   SimpleImagesDownloader::Client.new.open(uri)
+  #
   class Client
     def initialize(options = Configuration::REQUEST_OPTIONS)
       @options = options
     end
 
+    # @param uri [URI] URI object
+    # @return [StringIO] StringIO object
     def open(uri)
       uri.open(@options)
     rescue OpenURI::HTTPRedirect

data/lib/simple_images_downloader/configuration.rb

@@ -1,6 +1,19 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Configuration class
+  # @example
+  #   SimpleImagesDownloader::Configuration.configure do |config|
+  #     config.destination = './images'
+  #     config.valid_mime_types = ['image/jpeg', 'image/png']
+  #   end
+  #
+  #   SimpleImagesDownloader::Configuration.destination
+  #   # => './images'
+  #
+  #   SimpleImagesDownloader::Configuration.valid_mime_types
+  #   # => ['image/jpeg', 'image/png']
+  #
   class Configuration
     include Singleton
 
@@ -17,16 +30,16 @@ module SimpleImagesDownloader
     }.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_VALID_MIME_TYPES = [
+      'image/avif',
+      'image/gif',
+      'image/apng',
+      'image/jpg',
+      'image/jpeg',
+      'image/png',
+      'image/svg+xml',
+      'image/webp'
+    ].freeze
 
     DEFAULT_DESTINATION = './'
 
@@ -34,15 +47,32 @@ module SimpleImagesDownloader
 
     def initialize
       @destination = DEFAULT_DESTINATION
-      @valid_mime_types = DEFAULT_VALID_MIME_TYPES_MAP.keys
+      @valid_mime_types = DEFAULT_VALID_MIME_TYPES
     end
 
+    # Allows to set valid_mime_types to check against allowed mime types
+    #
+    # @param value [Array] Array of valid mime types followed by
+    # RFC 1341 - MIME (Multipurpose Internet Mail Extensions) format
+    # @raise [BaseError] if value is not an Array
+    #
     def valid_mime_types=(value)
-      raise BaseError, 'valid_mime_types must be an array' unless value.is_a?(Array)
+      raise Errors::BaseError, 'valid_mime_types must be an array' unless value.is_a?(Array)
 
       @valid_mime_types = value
     end
 
+    #### Configurable options
+    #
+    # destination: String, default: './', description: 'Destination folder to put downloaded images'
+    # valid_mime_types: Array,
+    # default: [
+    #  'image/avif', 'image/gif', 'image/apng', 'image/jpg',
+    #  'image/jpeg', 'image/png', 'image/svg+xml', 'image/webp'
+    # ], description: 'Valid mime types to download'
+    #
+    # @yield [config] Yields the Configuration object to the block
+    #
     def self.configure
       yield instance
     end

data/lib/simple_images_downloader/dispenser.rb

@@ -1,18 +1,32 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Dispenser class
+  # Responsible for moving tempfile to destination directory
+  #
+  # @example
+  #   SimpleImagesDownloader::Dispenser.new(tempfile, 'https://example.com/image.jpg').place
+  #
   class Dispenser
     extend Forwardable
     include Validatable
 
     def_delegator 'SimpleImagesDownloader::Configuration', :destination, :destination_dir
 
+    # @param source [Tempfile] Tempfile object
+    # @param remote_path [String] original path of the image from input of SimpleImagesDownloader module
+    # @param validators [Array] array of validators for validating the destination directory.
+    # Default: [DestinationValidator.new]
     def initialize(source, remote_path, validators = [DestinationValidator.new])
       @source      = source
       @remote_path = remote_path
       @validators  = validators
     end
 
+    # Moves tempfile to destination directory
+    #
+    # @raise [Errors::BadDestination] if destination directory is not valid
+    # @see DestinationValidator
     def place
       validate!({ path: destination_dir })
 

data/lib/simple_images_downloader/downloader.rb

@@ -1,15 +1,31 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Downloader class
+  # Responsible for downloading images from URI and placing them to the destination folder
+  # allows to use custom client and validators for downloading
+  #
+  # @example
+  #   SimpleImagesDownloader::Downloader.new(uri).download
+  #
   class Downloader
     include Validatable
 
+    # @param uri [URI] URI object from which image will be downloaded
+    # @param client [Client] Client object for opening the URI. Default: Client.new
+    # @param validators [Array] array of validators for validating the response. Default: [MimeTypeValidator.new]
     def initialize(uri, client = Client.new, validators = [MimeTypeValidator.new])
       @uri        = uri
       @client     = client
       @validators = validators
     end
 
+    # Downloads image from URI and places it to the destination folder
+    #
+    # @raise [Errors::EmptyResponse] if response is empty
+    # @raise [Errors::BadMimeType] if response is not an image
+    # @see Errors module
+    # @see MimeTypeValidator
     def download
       puts "Downloading #{@uri}"
 

data/lib/simple_images_downloader/errors.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Errors module
+  # Responsible for storing all errors
+  #
   module Errors
     class BaseError < StandardError; end
 

data/lib/simple_images_downloader/line.rb

@@ -1,11 +1,22 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Line class
+  # Responsible for parsing the string into URI object
+  #
+  # @example
+  #   SimpleImagesDownloader::Line.new('https://example.com/image.jpg').uri
+  #   # => #<URI::HTTPS https://example.com/image.jpg>
+  #
   class Line
     def initialize(string)
       @string = string
     end
 
+    # @return [URI] URI object
+    # @raise [Errors::BadUrl] if string is not a valid URI
+    # @see Errors::BadUrl
+    #
     def uri
       URI.parse(@string)
     rescue URI::Error

data/lib/simple_images_downloader/runner.rb

@@ -1,7 +1,14 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Runner class
+  # Responsible for invoking interface to download images from file
+  #
+  # @example
+  #   SimpleImagesDownloader::Runner.invoke('./urls.txt')
+  #
   class Runner
+    # Allows to invoke interface to download images from file
     def self.invoke
       raise SimpleImagesDownloader::Errors::MissingFileArgumentError if ARGV.size.zero?
 

data/lib/simple_images_downloader/source_file.rb

@@ -1,14 +1,26 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # SourceFile class
+  # Responsible for opening the file of URLs and validating it
+  #
+  # @example
+  #   SimpleImagesDownloader::SourceFile.new('./urls.txt').each_line do |line|
+  #     puts line
+  #   end
+  #
   class SourceFile
     include Validatable
 
+    # @param path [String] path to file
+    # @param validators [Array] array of validators
     def initialize(path, validators = [FilePersistanceValidator.new, FileAccessibilityValidator.new])
       @path       = path
       @validators = validators
     end
 
+    # @yield [line] passes each line of file to block
+    # @yieldparam line [String] line of file
     def each_line(&block)
       validate!({ path: @path })
 

data/lib/simple_images_downloader/stringio_to_tempfile.rb

@@ -1,9 +1,18 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # StringIOToTempfile module
+  # Responsible for converting StringIO to Tempfile
+  #
+  # @example
+  #   SimpleImagesDownloader::StringioToTempfile.convert(stringio)
+  #  # => #<Tempfile:0x00007f9b9c0b3a38>
+  #
   module StringioToTempfile
     module_function
 
+    # @param stringio [StringIO] StringIO object
+    # @return [Tempfile] Tempfile object
     def convert(stringio)
       tempfile = Tempfile.new(binmode: true)
 

data/lib/simple_images_downloader/validatable/destination_validator.rb

@@ -2,7 +2,16 @@
 
 module SimpleImagesDownloader
   module Validatable
+    # DestinationValidator class
+    # Responsible for validating destination path
+    #
+    # @example
+    #   SimpleImagesDownloader::DestinationValidator.new.validate({ path: './images' })
+    #
     class DestinationValidator < Validator
+      # @param options [Hash] hash with path to destination directory
+      # @raise [Errors::DestinationIsNotDirectory] if destination is not directory
+      # @raise [Errors::DestinationIsNotWritable] if destination is not writable
       def validate(options)
         path = options[:path]
 

data/lib/simple_images_downloader/validatable/file_accessibility_validator.rb

@@ -2,7 +2,15 @@
 
 module SimpleImagesDownloader
   module Validatable
+    # FileAccessibilityValidator class
+    # Responsible for validating file accessibility
+    #
+    # @example
+    #   SimpleImagesDownloader::FileAccessibilityValidator.new.validate({ path: './urls.txt' })
+    #
     class FileAccessibilityValidator < Validator
+      # @param options [Hash] hash with path to file
+      # @raise [Errors::PermissionsError] if file is not readable
       def validate(options)
         return if File.readable?(options[:path])
 

data/lib/simple_images_downloader/validatable/file_persistance_validator.rb

@@ -2,7 +2,15 @@
 
 module SimpleImagesDownloader
   module Validatable
+    # FilePersistanceValidator class
+    # Responsible for validating file persistance
+    #
+    # @example
+    #   SimpleImagesDownloader::FilePersistanceValidator.new.validate({ path: './urls.txt' })
+    #
     class FilePersistanceValidator < Validator
+      # @param options [Hash] hash with path to file
+      # @raise [Errors::MissingFileError] if file does not exist
       def validate(options)
         return if File.exist?(options[:path])
 

data/lib/simple_images_downloader/validatable/mime_type_validator.rb

@@ -2,25 +2,40 @@
 
 module SimpleImagesDownloader
   module Validatable
+    # MimeTypeValidator class
+    # Responsible for validating mime type of file
+    #
+    # @example
+    #   SimpleImagesDownloader::MimeTypeValidator.new.validate({ path: './image.jpg', io: StringIO.new })
+    #
     class MimeTypeValidator < Validator
       extend Forwardable
 
       def_delegator 'SimpleImagesDownloader::Configuration', :valid_mime_types, :valid_mime_types
 
+      # Validates mime type of file. The mime types are taken from file Configuration
+      #
+      # @param options [Hash] hash with path to file and io object. Example: { path: './image.jpg', io: StringIO }
+      # @raise [Errors::BadMimeType] if mime type is not valid
+      # @see Configuration::DEFAULT_VALID_MIME_TYPES to see default valid mime types or add your own
       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]
+        return if SimpleImagesDownloader::Configuration.valid_mime_types.include?(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
+      # Returns mime type of file. Uses UNIX file command
+      #
+      # @see https://github.com/shrinerb/shrine/blob/master/lib/shrine/plugins/determine_mime_type.rb#L94
+      # @param io [IO] io object
+      # @return [String] mime type of file
       def mime_type_of(io)
         Open3.popen3('file --mime-type --brief -') do |stdin, stdout, stderr, thread|
           copy_stream(from: io, to: stdin.binmode)

data/lib/simple_images_downloader/validatable/validator.rb

@@ -2,6 +2,8 @@
 
 module SimpleImagesDownloader
   module Validatable
+    # Validator class
+    # Responsible for defining interface for validators
     class Validator
       def validate(_value)
         raise NotImplementedError, 'must be implemented in subclass'

data/lib/simple_images_downloader/validatable.rb

@@ -1,7 +1,26 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
+  # Validatable module
+  # Responsible for validating the object using array of validators
+  #
+  # @example
+  #   class SourceFile
+  #     include Validatable
+  #
+  #     def initialize(path, validators = [FilePersistanceValidator.new, FileAccessibilityValidator.new])
+  #       @path       = path
+  #       @validators = validators
+  #     end
+  #
+  #     def each_line(&block)
+  #       validate!({ path: @path })
+  #       # ...
+  #     end
+  #   end
   module Validatable
+    # @param value [Object] value to validate
+    # @raise [Errors::<Particular>Error] if value is not valid
     def validate!(value)
       (@validators ||= []).each { |validator| validator.validate(value) }
     end

data/lib/simple_images_downloader/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module SimpleImagesDownloader
-  VERSION = '1.1.0'
+  # gem version
+  VERSION = '1.1.1'
 end

data/lib/simple_images_downloader.rb

@@ -25,15 +25,31 @@ require_relative 'simple_images_downloader/downloader'
 require_relative 'simple_images_downloader/strategies/from_file_strategy'
 require_relative 'simple_images_downloader/strategies/from_url_strategy'
 
+# SimpleImagesDownloader module
+# It is a main module of the gem
+# It is responsible for providing interface to download images from file or url
+#
+# @example
+#   SimpleImagesDownloader.from_file('./urls.txt')
+#   SimpleImagesDownloader.from_url('https://example.com/image.jpg')
+#
 module SimpleImagesDownloader
+  # Downloads images from file by taking urls from it. Places images to the destination folder set in configuration
+  #
+  # @param path [String] path to file with urls
   def self.from_file(path)
     SimpleImagesDownloader::Strategies::FromFileStrategy.new(path).process
   end
 
+  # Downloads image from url. Places image to the destination folder set in configuration
+  #
+  # @param url [String] url of image
   def self.from_url(url)
     SimpleImagesDownloader::Strategies::FromUrlStrategy.new(url).process
   end
 
+  # Returns root path of the gem. It is used for testing purposes
+  # @return [String] root path of the gem
   def self.root
     File.dirname __dir__
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-images-downloader
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - IlkhamGaysin