fetch_and_process 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74b59bb98bb4d1ad5dda0d79d8b0ab67a4a98bd0c6c0b3ac9c66042123da9aa6
+  data.tar.gz: 9143293c05d66205090197635d534fb9fbb19b7623bddb5fbbe803aea2ad102b
+SHA512:
+  metadata.gz: 6eac29c2a5526953dcb5168a9346e73b8780a8f98fe2217e82912468153bd0f86c51049b16aada1c56a44d7c992c7216168c1c0dcce381730038c46585890c0c
+  data.tar.gz: 72f39565517ea8ab949c18b3c2599bc5f83e971a8d964206809a39b38ddd7565e2613760721952d8c85457f6abdef56f189cfb6bf7d653b328ce47a7b39afd74

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+vendor

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-thread_safety
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Layout/LineLength:
+  Max: 120
+Style/Documentation:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 3.0.0
+  - 2.7
+  - 2.6
+before_install:
+  - gem update --remote bundler
+script:
+  # - bundle exec rake
+  - bundle exec rubocop --format simple --display-only-fail-level-offenses --fail-level W lib
+deploy:
+  provider: rubygems
+  api_key:
+    secure: i0GPUrE9cU31oOXoEiyAJEUU2EjGB8RAJ11veipq1x29F9sX3aDPWS2s9mk+uQsoUHC7IhziN8rD2Aw9bjNss+YywRvxA0M6bfP3w+C5v2rGV5j7p9R1pnUfKVgOIXTpOjocafgcUr6LslDhpdJileG29Z9dtQWi5wuqARXE54EhBPk1vvCh86l4t07vY4AbguNj73nbF2Rz0Z/+aZ9MrhS+rUhJ85ynIhH913ckl1jCjVycOTazyWdX6GBiEUYiToZBtQK/4XCsUuE4UQAcWXgNdwscV6WD1n53M2JBu6neqZzosLxyJ2aOZ65U643AtfrZd0qVqt1V9Od2083gwRmCXl58VltCDraXUbkWbqb/tfgdy4STeZilKNh5IPEmoySjjWiYmmN2vN+32D8ekyGRr2iciOSsMsy4pQW6r0MX16HfVct283guwIp4dFacVxQLuTZcjjkaRXILVOGuml/mcKxe48u82kHtlxveBKm0K9avDXupLWhXQ2Fy8B6q1z8ekSL4eNk1bcAyonXdQCgyHqlZQMEONd584XFVq1/L4yxvplxYoe4lOfTuDnwwTboHHZz8wLh27xAMguRhGUIa8oYTj8SgRZBpkVfUqQp14z/oH/qQ67MIY/kLWbjDY9cSA9MbhrOGCA/VczlLRkhmn4WJrYZHDyDMQkZwAOU=
+  gem: fetch_and_process
+  on:
+    tags: true
+    repo: EagerELK/fetch_and_process

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fetch_and_process.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 0.80'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jade IT cc
+
+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,43 @@
+# FetchAndProcess
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fetch_and_process'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fetch_and_process
+
+## Usage
+
+FetchAndProcess supports local files and files fetched over HTTP / HTTPS out of the box.
+
+This will work for a lot of use cases, but it's easy to extend FetchAndProcess to support other protocols too.
+
+As an example, adding S3 support will look like this:
+
+```ruby
+# TODO
+```
+
+## 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.
+
+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/EagerELK/fetch_and_process.
+
+## 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 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fetch_and_process'
+
+# 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(__FILE__)

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# - Automatically index files dropped in a S3 bucket
+# - Use the filename / bucket to determine index and pipeline
+
+require_relative 'lib/fetch_and_process/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fetch_and_process'
+  spec.version       = FetchAndProcess::VERSION
+  spec.authors       = ['Jurgens du Toit']
+  spec.email         = ['jrgns@eagerelk.com']
+
+  spec.summary       = 'Simple framework to fetch and process files.'
+  spec.description   = 'Systems need to process files. Sometimes those files reside remotely. This simple gem allows you to easily fetch and process remote files.'
+  spec.homepage      = 'https://github.com/EagerELK/fetch_and_process'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/EagerELK/fetch_and_process'
+  spec.metadata['changelog_uri'] = 'https://github.com/EagerELK/fetch_and_process/blob/master/Changelog.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'zeitwerk', '>= 2.3'
+
+  spec.add_development_dependency 'bundler', '>= 2.2'
+  spec.add_development_dependency 'rake', '>= 13.0'
+  spec.add_development_dependency 'rspec', '>= 3.10'
+  spec.add_development_dependency 'rubocop', '>= 0.93'
+  spec.add_development_dependency 'rubocop-performance', '>= 1.10'
+  spec.add_development_dependency 'rubocop-rspec', '>= 1.44'
+  spec.add_development_dependency 'rubocop-thread_safety', '>= 0.4'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/fetch_and_process/base.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'net/https'
+
+module FetchAndProcess
+  class Base
+    attr_reader :file_path
+
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def uri
+      @uri ||= URI.parse(file_path)
+    end
+
+    def process
+      # No action defined by default
+      raise FetchAndProcess::UnimplementedFileError
+    end
+
+    # After handle is executed, the fetched file should exist on the path specified by `target`
+    def download
+      raise FetchAndProcess::UnsupportedFileError unless uri.scheme && handle?
+
+      send(handler)
+    end
+
+    def handle?
+      self.class.handle?(uri)
+    end
+
+    def handler
+      self.class.handler(uri)
+    end
+
+    def cache_location
+      @cache_location ||= begin
+        hash = Digest::MD5.hexdigest uri.to_s
+        path = "#{Dir.tmpdir}/fetch_and_process"
+        Dir.mkdir(path, 0o700) unless File.exist?(path)
+        "#{path}/#{hash}"
+      end
+    end
+
+    class << self
+      def handle?(uri)
+        handlers.key? uri.scheme.to_sym
+      end
+
+      def handler(uri)
+        handlers[uri.scheme.to_sym]
+      end
+
+      def add_handler(scheme, method)
+        handlers[scheme.to_sym] = method.to_sym
+      end
+    end
+
+    def self.handlers
+      @handlers ||= {}
+    end
+  end
+end

data/lib/fetch_and_process/http.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'net/https'
+
+module FetchAndProcess
+  module HTTP
+    def self.included(base)
+      base.add_handler('http', :http_handler)
+      base.add_handler('https', :http_handler)
+    end
+
+    def user_agent
+      "Ruby/FetchAndProcess-#{FetchAndProcess::VERSION} (Net::HTTP)"
+    end
+
+    def http_handler
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.port == 443) do |http|
+        req = Net::HTTP::Get.new(uri)
+        req['If-Modified-Since'] = File.mtime(cache_location).rfc2822 if File.exist?(cache_location)
+        req['User-Agent'] = user_agent
+        http.request(req) do |response|
+          case response
+          when Net::HTTPSuccess
+            File.open(cache_location, 'w') do |file|
+              response.read_body do |chunk|
+                file.write(chunk)
+              end
+            end
+          when Net::HTTPNotModified
+            logger.debug 'Using cached file'
+          else
+            raise response.message
+          end
+        end
+        cache_location
+      end
+    rescue StandardError => e
+      # Ensure there's no empty / partial file to foul up the cache
+      FileUtils.rm cache_location if File.exist?(cache_location)
+      raise e
+    end
+  end
+end

data/lib/fetch_and_process/local_file.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+require 'net/https'
+
+module FetchAndProcess
+  module LocalFile
+    def self.included(base)
+      base.add_handler('file', :file_handler)
+    end
+
+    def file_handler
+      from = uri.to_s.sub(%r{^file://}, '')
+      from = "./#{from}" if from[0] != '/'
+      FileUtils.cp from, cache_location
+      cache_location
+    end
+  end
+end

data/lib/fetch_and_process/s3.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module FetchAndProcess
+  module S3
+    def self.included(base)
+      base.add_handler('s3', :s3_handler)
+    end
+
+    def s3_handler
+      # TODO: Get the bucket and key from the URI
+      options = {
+        bucket: uri.host,
+        key: uri.path[1..],
+      }
+      options[:if_modified_since] = File.mtime(cache_location) if File.exist?(cache_location)
+      s3.get_object(options, target: cache_location)
+    rescue Aws::S3::Errors::NotModified
+      options.delete(:if_modified_since)
+      s3.head_object(options)
+    rescue Aws::S3::Errors::AccessDenied => e
+      raise FetchAndProcess::AccessControlError, "Could not fetch file from S3: #{e.message}"
+    rescue Aws::S3::Errors::NoSuchKey => e
+      raise FetchAndProcess::FileNotFoundError, "Could not find file on S3: #{e.message}"
+    end
+
+    private
+
+    def s3
+      @s3 ||= Aws::S3::Client.new
+    end
+  end
+end

data/lib/fetch_and_process/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FetchAndProcess
+  VERSION = '0.1.3'
+end

data/lib/fetch_and_process.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'fetch_and_process/version'
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect 'http' => 'HTTP'
+loader.setup
+
+module FetchAndProcess
+  class Error < StandardError; end
+
+  class UnsupportedFileError < Error; end
+
+  class UnimplementedFileError < Error; end
+
+  class AccessControlError < Error; end
+
+  class FileNotFoundError < Error; end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fetch_and_process
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Jurgens du Toit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.93'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.93'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.44'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.44'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Systems need to process files. Sometimes those files reside remotely.
+  This simple gem allows you to easily fetch and process remote files.
+email:
+- jrgns@eagerelk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fetch_and_process.gemspec
+- lib/fetch_and_process.rb
+- lib/fetch_and_process/base.rb
+- lib/fetch_and_process/http.rb
+- lib/fetch_and_process/local_file.rb
+- lib/fetch_and_process/s3.rb
+- lib/fetch_and_process/version.rb
+homepage: https://github.com/EagerELK/fetch_and_process
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/EagerELK/fetch_and_process
+  source_code_uri: https://github.com/EagerELK/fetch_and_process
+  changelog_uri: https://github.com/EagerELK/fetch_and_process/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Simple framework to fetch and process files.
+test_files: []