basefile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c2b83e69dd9593be72bb021d3c4e9a9f2e750d20f2fb285451931991b68002e
+  data.tar.gz: 105e1a964735e59fb32e533971cb36340480dfaef624b82fbad7faa1593d41c3
+SHA512:
+  metadata.gz: a56a8f945076249251b7a531479ac273ced7fb39dea9a422e6cad2806049e964df3860dde223550eaff6872f1f4313e72b120c115ab3a0c1f8cdf0ad21503d17
+  data.tar.gz: 1f8573ff664942de375b29fcec4c3007a8f45b05c6c12312c471d964acfb595e1d1bad92126b07848946ce87076159d71809d7cd285f4b534501bb6ea3e1f42a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in basefile.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    basefile (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  basefile!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Josh Burns <josh@tripwyre.me>
+
+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,54 @@
+# Basefile
+
+Basefile provides a flexible API to store files as raw base64 text and then retreieve them.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'basefile'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install basefile
+
+## Usage
+
+``` ruby
+require 'basefile'
+
+input_file = "./user_upload.png"
+
+# Encode file
+handler = Basefile::FileHandler.new
+handler.filein = input_file
+base64_str = handler.encode_file
+
+puts base64_str
+
+# Decode / File
+
+handler.fileout = "./new_file.png"
+handler.decode_file(base64_str)
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/tripwyre/basefile.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/basefile.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/basefile/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "basefile"
+  spec.version       = Basefile::VERSION
+  spec.authors       = ["Josh Burns"]
+  spec.email         = ["josh@tripwyre.me"]
+
+  spec.summary       = "Store files as basew64 Text"
+  spec.description   = "Store files as basew64 Text"
+  spec.homepage      = "https://github.com/tripwyre/basefile"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "basefile"
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

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/lib/basefile.rb

@@ -0,0 +1,8 @@
+require "basefile/version"
+require "basefile/base64_shim"
+require "basefile/file_handler"
+
+module Basefile
+  class Error < StandardError; end
+
+end

data/lib/basefile/base64_shim.rb

@@ -0,0 +1,15 @@
+require "base64"
+
+module Basefile
+  class Base64Shim
+
+    def self.encode(str)
+      Base64.encode64(str)
+    end
+
+    def self.decode(encoded_string)
+      Base64.decode64(encoded_string)
+    end
+
+  end
+end

data/lib/basefile/file_handler.rb

@@ -0,0 +1,29 @@
+module Basefile
+  class FileHandler
+    attr_accessor :filein, :fileout
+
+    def initalize(filein, fileout)
+      @filein = filein || nil
+      @fileout = fileout || nil
+    end
+
+    def encode_file
+      if @filein == nil
+        return false
+      else
+        f = File.open(@filein)
+        return ::Basefile::Base64Shim.encode(f.read)
+      end
+    end
+
+    def decode_file(encoded_str)
+      if @fileout == nil
+        return false
+      else
+        File.open(@fileout, "wb") do |file|
+          file.write(::Basefile::Base64Shim.decode(encoded_str))
+        end
+      end
+    end
+  end
+end

data/lib/basefile/version.rb

@@ -0,0 +1,3 @@
+module Basefile
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: basefile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Burns
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-24 00:00:00.000000000 Z
+dependencies: []
+description: Store files as basew64 Text
+email:
+- josh@tripwyre.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- basefile.gemspec
+- bin/console
+- bin/rake
+- bin/setup
+- lib/basefile.rb
+- lib/basefile/base64_shim.rb
+- lib/basefile/file_handler.rb
+- lib/basefile/version.rb
+homepage: https://github.com/tripwyre/basefile
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tripwyre/basefile
+  source_code_uri: https://github.com/tripwyre/basefile
+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.1.2
+signing_key:
+specification_version: 4
+summary: Store files as basew64 Text
+test_files: []