dyno_scp 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e895339fe6d23121966317413683ba033776d04eec9235d9f343000e015e2eda
-  data.tar.gz: 30c713446f4e6940ed2092f3353c510dbce05e650786b46acffe26634648f28a
+  metadata.gz: e36a1fef7a2a5b75abab84888c57ac803b1d79443b98d256189d0d8411336b61
+  data.tar.gz: b9025e32e5c858a089582dfce98c913cd69bedd206f6a538745a5e9abecc1675
 SHA512:
-  metadata.gz: 8256707dee813881b2fc4e151dc504f4d8233ecf5736da18a284672c1c2e20abc907da8b770f2fb292fe7156fe32a8eabd40f1299b2c931718dd7fd0dde6b2b0
-  data.tar.gz: 17ae90081832aa23598b5e01782c035dbfbb0cf6a00853db8a0a0901a47aaa4449514723900d8be859c380ae68dea6a56b8b2aca92821e6eba844d98223abed0
+  metadata.gz: 7afebe8560732ad22932e41bd4f0cd0a12a60706f2bb3f83753cfeb466b9cabc86547110c975fd2eb8bf7f1fc63e71d80601238117673802535a975633d0b53f
+  data.tar.gz: df969cc70c84689f27dd54b4c7bcc92941ea327b81a9887856e50d4526dd992e969afea7e3fc0ba409b8468504919871daec2ce9e76dcd03ae59ba49695876a1

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Andrew Merritt
+
+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,77 @@
+# Dyno Scp
+
+Heroku doesnt allow you to scp a file up to their server. This gem creates a
+barebones file upload mechanism that dumps a file uploaded into the public
+directory. Heroku automatically cleans that directory regularly so we dont have
+to worry about files lingering around.
+
+## Contents
+
+- [Getting Started](#getting-started)
+- [Tips](#tips)
+- [Uploading A File](#uploading-a-file)
+- [Accessing Uploaded Files](#accessing-uploaded-files)
+
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "dyno_scp", "~> <version>"
+```
+
+And then execute:
+
+    $ bundle
+
+Mount the engine in your routes file:
+
+```ruby
+mount DynoScp::Engine, at: "/dyno_scp"
+```
+
+### Tips
+
+Heroku runs processes in their own separate dynos. If you add a file in your
+console session and then exit and re-enter your file will be gone. This becomes
+and issue when using this tool because when you upload a file it is placed in
+the web dyno which you can't directly access.
+
+See [Accessing Uploaded Files](#accessing-uploaded-files) for retrieval steps.
+
+## Uploading A File
+
+##### Note: The upload page requires the user to have an office:sys_admin role
+After mounting the engine, you can navigate to `#{host}/dyno_scp` to see the upload page.
+
+Simply choose the file you wish to upload, then press the "upload" button. You
+will see a confirmation message once the file has been uploaded.
+
+Files are placed in the `/public` folder, so use this with caution. They will
+be publicly accessible to anyone who finds out they exist.
+
+In Heroku, these files are cleared out every 24 hours automatically. In other
+hosting schemes, there may not be automated cleanup of the public folder.
+
+## Accessing Uploaded Files
+
+The main use case for this tool is to upload a file to a heroku hosted site
+for usage in some type of data load or backfill task.
+
+After setting up open a bash console on the heroku app.
+```bash
+heroku run bash --app my-heroku-app
+```
+
+To use files after they've been uploaded with this tool, you need to retreive
+the file inside the bash terminal from the web dyno where it was uploaded.
+
+Using `curl`
+```bash
+curl https://my-heroku-app.herokuapp.com/my_uploaded_file.csv -o my_uploaded_file.csv
+```
+
+Using `wget`
+```bash
+wget https://my-heroku-app.herokuapp.com/my_uploaded_file.csv my_uploaded_file.csv
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+  t.warning = false
+end
+
+task default: :test

data/app/controllers/dyno_scp/files_controller.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module DynoScp
+  class FilesController < ::ActionController::Base
+    skip_after_action :verify_authorized, raise: false
+    before_action :ensure_public_folder_exists
+
+    layout false if respond_to?(:layout)
+
+    def index
+      @files = fetch_public_files
+    end
+
+    def new; end
+
+    def create
+      file = params[:file]
+
+      if file.nil?
+        redirect_to new_file_path, alert: "No file selected"
+        return
+      end
+
+      filename = resolve_name_collision(file.original_filename)
+
+      File.open(Rails.root.join("#{::DynoScp.folder_path}/#{filename}"), "wb") do |f|
+        f.write file.read
+      end
+
+      redirect_to new_file_path, notice: "#{filename} uploaded"
+    end
+
+    def destroy
+      file_path = Rails.root.join("#{::DynoScp.folder_path}/#{params[:file_name]}")
+      if File.exist?(file_path)
+        File.delete(file_path)
+        redirect_to files_path, notice: "#{params[:file_name]} deleted"
+      else
+        redirect_to files_path, notice: "File not found"
+      end
+    end
+
+    private
+
+    def ensure_public_folder_exists
+      FileUtils.mkdir_p("#{::DynoScp.folder_path}") unless Dir.exist?(::DynoScp.folder_path)
+    end
+
+    def fetch_public_files
+      files = Dir.glob("#{::DynoScp.folder_path}/**/*").select { |file| File.file?(file) }
+
+      files.map do |file|
+        {
+          name: File.basename(file),
+          relative_path: "/#{::DynoScp.folder}/#{File.basename(file)}",
+          path: Rails.root.join(file).to_s,
+          size: File.size(file),
+          created_at: File.ctime(file).to_fs(:long)
+        }
+      end
+    end
+
+    def resolve_name_collision(filename)
+      return filename unless File.exist?("#{save_path}/#{filename}")
+
+      basename = File.basename(filename, ".*")
+      extension = File.extname(filename)
+      counter = 1
+
+      # Loop until we find a file name that doesn't exist
+      while File.exist?("#{save_path}/#{basename}(#{counter})#{extension}")
+        counter += 1
+      end
+
+      "#{basename}(#{counter})#{extension}"
+    end
+
+    def save_path
+      Rails.root.join("#{::DynoScp.folder_path}")
+    end
+  end
+end

data/app/views/dyno_scp/files/_styles.html.erb

@@ -0,0 +1,122 @@
+<style>
+  .alert {
+    color: #690906;
+    padding: 10px 5px;
+    border: 2px solid #EB918F;
+    background-color: #FFE3E2;
+    border-radius: 4px;
+    display: flex;
+    justify-content: center;
+  }
+  .btn-primary {
+    background-color: #ffffff;
+    color: #2B2B2B;
+  }
+  .btn-primary:hover {
+    background-color: #E5E7EB;
+  }
+  .btn-danger {
+    background-color: #FFE3E2;
+    color: #690906;
+    border-color: #EB918F;
+  }
+  .btn-danger:hover {
+    color: #FFE3E2;
+    background-color: #D26663;
+  }
+  .btn {
+    margin: 4px;
+    text-decoration: none;
+    border: 2px solid #A5A7AB;
+    border-radius: 5px;
+    display: inline-block;
+    padding: 10px 20px;
+    font-size: 16px;
+    cursor: default;
+    box-shadow: 0 1px 2px 0 rgba(0,0,0,0.2);
+    transition: background-color 0.3s ease; /* Smooth transition */
+  }
+  .btn:hover {
+    cursor: pointer;
+    box-shadow: 0 2px 4px 0 rgba(0,0,0,0.2);
+  }
+  .card {
+    background: #fff;
+    padding: 20px;
+    max-width: 500px;
+    max-height: 400px;
+    text-align: left;
+    font-family: Arial;
+    box-shadow: 0 4px 8px 0 rgba(0,0,0,0.2);
+    transition: 0.3s;
+    border-radius: 2px;
+  }
+  .card:hover {
+    box-shadow: 0 8px 16px 0 rgba(0,0,0,0.2);
+  }
+  .container {
+    padding-left: 20px;
+    padding-right: 20px;
+    width: 100%;
+    height: 100%;
+    max-width: 540px;
+    padding-top: 80px;
+    display: flex;
+    flex-direction: column;
+    justify-content: start;
+    margin-left: auto;
+    margin-right: auto;
+  }
+  .flex {
+    display: flex;
+  }
+  .flex-column {
+    flex-direction: column;
+  }
+  .flex-row {
+    flex-direction: row;
+  }
+  .items-base {
+    align-items: baseline;
+  }
+  .items-end {
+    align-items: flex-end;
+  }
+  .justify-center {
+    justify-content: center;
+  }
+  .justify-end {
+    justify-content: flex-end;
+  }
+  .font-danger {
+    color: #8B0000;
+  }
+  .mb-4 {
+    margin-bottom: 4px;
+  }
+  .mb-20 {
+    margin-bottom: 20px;
+  }
+  .ml-20 {
+    margin-left: 20px;
+  }
+  .notice {
+    color: #055405;
+    padding: 10px 5px;
+    border: 2px solid #72BC72;
+    background-color: #CCE7CC;
+    border-radius: 4px;
+    display: flex;
+    justify-content: center;
+  }
+  .right-align {
+    margin-left: auto;
+  }
+  .row {
+    display: flex;
+    justify-content: space-between;
+  }
+  .text-center {
+    text-align: center;
+  }
+</style>

data/app/views/dyno_scp/files/index.html.erb

@@ -0,0 +1,36 @@
+<%= render "styles" %>
+
+
+<div class="container">
+  <div class="mb-20">
+    <%- if notice %>
+      <div class="notice"><%= notice %></div>
+    <% elsif alert %>
+      <div class="alert font-danger"><%= alert %></div>
+    <% end %>
+  </div>
+
+  <%= button_to "Upload File", new_file_path, method: :get, class: "btn btn-primary right-align"%>
+
+  <%- if @files.count.zero? %>
+    <div class="card-holder">
+      <div class="card text-center">
+        <h3 class="font-danger">No files uploaded yet</h3>
+      </div>
+    </div>
+  <%- else %>
+    <div class="card-holder">
+      <% @files.each do |file| %>
+        <div class="card mb-20">
+          <h3><%= file[:name] %></h3>
+          <p><%= "Size: #{file[:size]} B" %></p>
+          <p><%= "Uploaded: #{file[:created_at]}" %></p>
+          <div class="flex flex-row justify-end items-base">
+            <%= link_to "Download", file[:relative_path], target: "_blank", download: file[:name], class: "mb-4" %>
+            <%= button_to "Delete", file_path(file_name: file[:name]), method: :delete, class: "btn btn-danger ml-20" %>
+          </div>
+        </div>
+      <% end %>
+    </div>
+  <%- end %>
+</div>

data/app/views/dyno_scp/files/new.html.erb

@@ -0,0 +1,26 @@
+<%= render "styles" %>
+
+<div class="container">
+  <div class="mb-20">
+    <%- if notice %>
+      <div class="notice"><%= notice %></div>
+    <%- elsif alert %>
+      <div class="alert font-danger"><%= alert %></div>
+    <% end %>
+  </div>
+
+
+  <%= button_to "View Files", files_path, method: :get, class: "btn btn-primary right-align"%>
+
+  <div class="card-holder">
+    <div class="card">
+      <h3>File Upload</h3>
+      <%= form_with url: files_path, method: :post do |f| %>
+        <div class="row">
+          <%= f.file_field :file, class: "btn btn-primary" %>
+          <%= f.submit "Upload", class: "btn btn-primary" %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+DynoScp::Engine.routes.draw do
+  # Only allow access if the engine was mounted in the /dyno_scp namespace
+  constraints(->(req) { req.fullpath.split("/").reject(&:blank?).first == "dyno_scp" }) do
+    resources :files, only: %i(index new create destroy), param: :file_name, constraints: { file_name: /.*/ }
+    root "files#index"
+  end
+end

data/dyno_scp.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require_relative "./lib/dyno_scp/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "dyno_scp"
+  spec.version     = DynoScp::VERSION
+  spec.authors     = ["Andrew Merritt"]
+  spec.email       = ["andrew.w.merritt@gmail.com"]
+
+  spec.summary     = "Dyno SCP"
+  spec.description = "Allows devs to scp files to server for Heroku apps"
+  spec.homepage    = "https://github.com/amerritt14/dyno_scp"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "minitest", ">= 5.11"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rubocop"
+end

data/lib/dyno_scp/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DynoScp
+  class Engine < ::Rails::Engine
+    isolate_namespace DynoScp
+  end
+end

data/lib/dyno_scp/version.rb

@@ -0,0 +1,3 @@
+module DynoScp
+  VERSION = "0.3.2"
+end

data/lib/dyno_scp.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "dyno_scp/version"
+require "dyno_scp/engine"
+
+module DynoScp
+  FOLDER = "dyno_scp"
+
+  class << self
+    def folder
+      FOLDER
+    end
+
+    def folder_path
+      "public/#{FOLDER}"
+    end
+  end
+
+  private
+
+  def dyno_scp_config
+    Rails.application.config_for("dyno_scp")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dyno_scp
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Merritt
@@ -100,7 +100,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/dyno_scp/files_controller.rb
+- app/views/dyno_scp/files/_styles.html.erb
+- app/views/dyno_scp/files/index.html.erb
+- app/views/dyno_scp/files/new.html.erb
+- config/routes.rb
+- dyno_scp.gemspec
+- lib/dyno_scp.rb
+- lib/dyno_scp/engine.rb
+- lib/dyno_scp/version.rb
 homepage: https://github.com/amerritt14/dyno_scp
 licenses: []
 metadata: {}