api-fileupload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 27f010347cb9c6cab9371ded56a1cc6c160219aabf74e90fddbe77acfedd1917
+  data.tar.gz: 005fa06161d394dca3d7359c612960c372449fc4d1612647bc714718616aa460
+SHA512:
+  metadata.gz: 9678c447046ee3d7e46c7e75955d8a485f25a5d9d184d2c17a54098a71043c99678ea1299638efd056ee85e6de45373b307ee8bb6d9da501b98c5c33cb12270d
+  data.tar.gz: a1ecc38e78530caf72c7cc69fc6a9549ac51a1ad68af71df30cb718eaa43bfe49b6abe629ec870052307b9307cc09fd6d005a178e357cab247477fb778672b6f

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at balakirevs@i.ua. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aleksandr Balakiriev
+
+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,32 @@
+# Api::Fileupload
+
+Library for handling file uploads with json only apis.
+
+## Installation
+
+```ruby
+gem 'api-fileupload'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-fileupload
+
+## Usage
+
+Create a controller that includes Api::Fileupload::Controller module and add
+create and destroy routes for the controller.
+
+In controllers that need those uploaded files, add
+```ruby
+include Api::Fileupload::UploadedFiles
+```
+
+and retrieve uploaded files by using
+```ruby
+uploaded_file({id: <uploaded_file_id>})
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/api-fileupload.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/api/fileupload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api-fileupload"
+  spec.version       = Api::Fileupload::VERSION
+  spec.authors       = ["Aleksandr Balakiriev"]
+  spec.email         = ["info@Balakiriev.com"]
+
+  spec.summary       = %q{Simple library for handling file uploads for json only apis.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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"]
+
+  spec.add_dependency "railties", "~> 5"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.9"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api/fileupload"
+
+# 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/lib/api/fileupload.rb

@@ -0,0 +1,7 @@
+require 'api/fileupload/controller'
+require 'api/fileupload/version'
+
+module Api
+  module Fileupload
+  end
+end

data/lib/api/fileupload/controller.rb

@@ -0,0 +1,26 @@
+require 'api/fileupload/store'
+
+module Api
+  module Fileupload
+    module Controller
+      def create
+        stored_file = Store.add(current_user.id, permitted_params[:file])
+        render json: stored_file, status: :created
+      end
+
+      def destroy
+        if Store.fetch(current_user.id, permitted_params[:id])
+          Store.remove(current_user.id, permitted_params[:id])
+          render nothing: true, status: :no_content
+        else
+          render nothing: true, status: :not_found
+        end
+      end
+
+      private
+      def permitted_params
+        params.permit(:file, :id)
+      end
+    end
+  end
+end

data/lib/api/fileupload/store.rb

@@ -0,0 +1,62 @@
+require 'action_dispatch'
+
+module Api
+  module Fileupload
+    class Store
+      class << self
+        def add(key, file)
+          copy = copy_file(file)
+          id = file_id(copy)
+
+          files(key)[id] = copy
+          {id: id}
+        end
+
+        def fetch(key, id)
+          if id.is_a?(Hash)
+            files(key)[id[:id]]
+          else
+            files(key)[id]
+          end
+        end
+
+        def clear(key)
+          files(key).keys.each{|id| remove(key, id)}
+        end
+
+        def remove(key, id)
+          file = fetch(key, id)
+          files(key).delete(id)
+          file.tempfile.unlink
+        end
+
+        private
+        def files(key)
+          @files ||= {}
+          @files[key] ||= {}
+        end
+
+        def file_id(file)
+          file.hash.to_s
+        end
+
+        def copy_file(file)
+          unless file.is_a?(ActionDispatch::Http::UploadedFile)
+            throw "file #{file} has to be a ActionDispatch::Http::UploadedFile"
+          end
+
+          tmpfile = Tempfile.new(file.original_filename)
+          tmpfile.set_encoding(Encoding::BINARY) if tmpfile.respond_to?(:set_encoding)
+          tmpfile.binmode
+          FileUtils.copy(file.path, tmpfile.path)
+          ActionDispatch::Http::UploadedFile.new(
+            tempfile: tmpfile,
+            filename: file.original_filename,
+            type: file.content_type,
+            head: file.headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/api/fileupload/uploaded_files.rb

@@ -0,0 +1,35 @@
+require 'api/fileupload/store'
+
+module Api
+  module Fileupload
+    module UploadedFiles
+      extend ActiveSupport::Concern
+
+      included do
+        after_filter :clear_uploaded_files, only: [:create, :update], if: :response_ok?
+      end
+
+      protected
+      def uploaded_file(file)
+        if file.is_a?(Hash)
+          Store.fetch(current_user.id, file)
+        else
+          file
+        end
+      end
+
+      def uploaded_file_param(param_name = :file)
+        { param_name => [:id] }
+      end
+
+      private
+      def clear_uploaded_files
+        Store.clear(current_user.id)
+      end
+
+      def response_ok?
+        "#{response.status}" =~ /\A2/
+      end
+    end
+  end
+end

data/lib/api/fileupload/version.rb

@@ -0,0 +1,5 @@
+module Api
+  module Fileupload
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: api-fileupload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aleksandr Balakiriev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: ''
+email:
+- info@Balakiriev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-fileupload.gemspec
+- bin/console
+- bin/setup
+- lib/api/fileupload.rb
+- lib/api/fileupload/controller.rb
+- lib/api/fileupload/store.rb
+- lib/api/fileupload/uploaded_files.rb
+- lib/api/fileupload/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Simple library for handling file uploads for json only apis.
+test_files: []