simple_hot_folder 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcfa0a67470d30f249c6eedf515d3582077c5b3e
-  data.tar.gz: 855eb7b864d54eb42e6a4ced1caff1186b4cc384
+  metadata.gz: c5d628ab6d1c8b9f73a849e877a72e0524bf5560
+  data.tar.gz: 461a54314b24ab407e58fc931e506fb92a24ae55
 SHA512:
-  metadata.gz: e4eca846f6d50b17d6eddac04d03d7e5e2d260dbbf132078fac2b6889d2dfa9eb7fd279583635a1332e704b0e7b845422fd2226027f98e652ab9542da337f828
-  data.tar.gz: fd97b930f3647eacc456924db7e3a3cc1dc8642f1c7409deb689cc1da7332b73cc34444c7824750d4fd0e65280ff6c41b4b140311e7fcb360bd37a5a48e14596
+  metadata.gz: d8390e89d2d03a0fea0b116d8baf8922c50292263b68669c1d6c96dc14cb9e36b38f243296a154ae395ce756ce7be2796e498add73b825fbca1a4221fb10f9f8
+  data.tar.gz: 5d844e412483647632b54aa63bc3ea460dfe89d6cbb0513edb17eca499885e3bc1e30520c71cbd3ed32328138e86f37a16daa62af61bba4b7c57eb4cb3cbc2b3

data/README.md

@@ -1,2 +1,63 @@
 # Simple Hot Folder
 
+### NOTE
+
+This gem is at an early stage of development. Please do not use it already.}
+
+
+## Install
+
+```bash
+gem install simple_hot_folder
+```
+
+## Usage
+
+```ruby
+require 'simple_hot_folder'
+
+hot_folder = SimpleHotFolder.for_files(
+  '/path/to/input_folder',
+  '/path/to/error_folder',
+  '/path/to/output_folder'
+)
+
+# Successful
+hot_folder.process_input! do |entry|
+  puts "Processing file #{entry.name}..."
+  puts "File path: #{entry.path}"
+  puts "Now, the file is automatically moved to the output folder"
+end
+
+# On error
+hot_folder.process_input! do |entry|
+  puts "Processing file #{entry.name}..."
+  puts "File path: #{entry.path}"
+  puts "The file will be automatically moved to the error folder"
+  puts "A text file will be created with the error message ('Trigger error')"
+  puts "The process will continue with the next file"
+  raise 'Trigger error'
+end
+```
+
+## License
+
+The MIT License
+
+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/lib/simple_hot_folder/version.rb

@@ -1,4 +1,4 @@
 module SimpleHotFolder
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
   NAME = 'simple_hot_folder'.freeze
 end

data/simple_hot_folder.gemspec

@@ -11,59 +11,16 @@ Gem::Specification.new do |s|
   s.email = ["galfus@gmail.com"]
   s.date = Time.now.strftime('%Y-%m-%d')
   s.summary = %q{A simple hot folder.}
-  s.description = %q{This library is at an early stage of development. Please do not use it already.}
+  s.description = %q{This gem is at an early stage of development. Please do not use it already.}
   s.licenses = ['MIT']
   s.homepage = "https://gitlab.com/galfuslab/simple-hot-folder"
-
-  # s.required_ruby_version = '>= 2.1.0'
-
-  # 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'] = "TODO: Set to 'http://mygemserver.com'"
-  # else
-  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  # end
-
-  # Jekyll
-  # s.files         = all_files.grep(%r!^(exe|lib)/|^.rubocop.yml$!)
-  # s.executables   = all_files.grep(%r!^exe/!) { |f| File.basename(f)  }
-  
-  # Colorize
-  # s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  # s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-
-  # Custom
   all_files = `git ls-files -z`.split("\x0")
   s.files = all_files
     .reject { |f| f.match(%r{^(test|spec|features|doc|tmp|pkg)/}) }
   s.executables = all_files.grep(%r{^exe/}) { |f| File.basename(f) }
-
-  # spec.test_files = [
-  #   'test/bla-bla.rb'
-  # ]
-
   s.bindir        = "exe"
   s.require_paths = ["lib"]
-
-  # s.add_runtime_dependency("addressable", "~> 2.4")
-  # s.add_runtime_dependency("dry-struct")
-
   s.add_development_dependency "bundler", "~> 1.12"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency 'minitest', '~> 5.0'
-
-  # puts ''
-  # puts '------------ Configurando gem'
-  # puts ''
-  # puts 'All:'
-  # p all_files
-  # puts ''
-  # puts 'Files:'
-  # p s.files
-  # puts ''
-  # puts 'Execuables:'
-  # p s.executables
-  # puts '------------'
-  # puts ''
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_hot_folder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Manu
@@ -52,8 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: This library is at an early stage of development. Please do not use it
-  already.
+description: This gem is at an early stage of development. Please do not use it already.
 email:
 - galfus@gmail.com
 executables: []