paperclip-ipfs-storage 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dbe356be64a25e89e0886b2f94337928f51875b
+  data.tar.gz: 99e779dcac60b7204bfed934f2ea8ff3b4a51564
+SHA512:
+  metadata.gz: 7a1c2a0d3e41ac544bc5a62a4f8e94d01426f0779f98e8913e425ab9328332cd56676a389c9f8e01cc66cb8aaa7b594d833bba21073cabd7684bb530ca41c166
+  data.tar.gz: 1e955ac0e7699c1ca33abc4cb8e8ce4a1b395cdd49d83749ff15f1025a9cabd05bb00b2cbc2d9cc09173777c99930559e76d7d2d7167a0dab91b0d20698349d8

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'ipfs-api', '~> 0.3.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+group :development do
+  gem 'shoulda', '>= 0'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.3.5'
+  gem 'simplecov', '>= 0'
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (3.5.5)
+    highline (1.7.8)
+    i18n (0.8.1)
+    ipfs-api (0.3.0)
+    jeweler (2.3.5)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api (~> 0.11.0)
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      psych (~> 2.2)
+      rake
+      rdoc
+      semver2
+    json (1.8.6)
+    jwt (1.5.6)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    psych (2.2.2)
+    public_suffix (2.0.5)
+    rack (2.0.1)
+    rake (12.0.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    semver2 (3.4.2)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  ipfs-api (~> 0.3.0)
+  jeweler (~> 2.3.5)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017 mecab <mecab@misosi.ru>
+
+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,46 @@
+Paperclip IPFS Storage
+======================
+
+This gem extends the [Paperclip](https://github.com/thoughtbot/paperclip) so that you can save file on [IPFS](https://ipfs.io/) network.
+
+Installation
+============
+
+```bash
+gem "paperclip-ipfs-storage"
+```
+
+or put it on the Gemfile.
+
+Usage
+=====
+
+Add `attachment` type field into the schema as usual, then add `string` type field as `[field_name]_ipfs_hash`. For example:
+
+```ruby
+class CreateMediaAttachments < ActiveRecord::Migration[5.0]
+  def change
+    create_table :media_attachments do |t|
+      t.attachment :file
+      t.string :file_ipfs_hash, :file_ipfs_hash, null: true, default: nil
+    end
+  end
+end
+```
+
+Then specify `:ipfs` for the `:storage` option and `':gateway_url'` for the `:url` in the model. For example:
+
+```ruby
+class MediaAttachment < ActiveRecord::Base
+  has_attached_file :file,
+    :storage => :ipfs,
+    :url => ':gateway_url'
+end
+```
+
+Limitation
+==========
+
+You cannot remove the file uploaded. This is due to the design of IPFS [^1].
+
+[^1]: https://github.com/ipfs/faq/issues/9

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "paperclip-ipfs-storage"
+  gem.homepage = "http://github.com/mecab/paperclip-ipfs-storage"
+  gem.license = "MIT"
+  gem.summary = %Q{The paperclip storage library to save files on IPFS network.}
+  gem.description = %Q{The paperclip storage library to save files on IPFS network.}
+  gem.email = "mecab@misosi.ru"
+  gem.authors = ["mecab"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "paperclip-ipfs-storage #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/paperclip-ipfs-storage.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'paperclip', 'storage', 'ipfs')

data/lib/paperclip/storage/ipfs.rb

@@ -0,0 +1,92 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'tempfile'
+
+module Paperclip
+  module Storage
+    module Ipfs
+      def self.extended(base)
+        begin
+          require 'ipfs-api'
+        rescue LoadError => e
+          e.message << '(You may need to install the ipfs-api gem)'
+          raise e
+        end
+
+        base.instance_eval do
+          @api_url = @options[:ipfs_api_url] || 'http://127.0.0.1:5001'
+          @ipfs = IPFS::Connection.new(@api_url)
+        end
+
+        Paperclip.interpolates(:item_hash) do |attachment, _|
+          attachment.hash
+        end
+        Paperclip.interpolates(:directory) do |attachment, style_name|
+          attachment.directory style_name
+        end
+        Paperclip.interpolates(:gateway_url) do |attachment, style_name|
+          attachment.gateway_url style_name
+        end
+      end
+
+      def hash
+        instance_read('ipfs_hash'.to_sym)
+      end
+
+      def directory(style_name = default_style)
+        "#{hash}/#{style_name}"
+      end
+
+      def gateway_url(style_name = default_style)
+        filename = Paperclip::Interpolations.filename(self, style_name.to_sym)
+        "https://gateway.ipfs.io/ipfs/#{directory style_name}/#{filename}"
+      end
+
+      def exists?(style_name = default_style)
+        hash(style_name).present?
+      end
+
+      def copy_to_local_file(style_name = default_style, destination_path)
+        File.open(destination_path, 'wb') do |fd|
+          if @queued_for_write[style_name]
+            IO.copy_stream(@queued_for_write[style_name], fd)
+          else
+            directory = directory(style_name)
+            filename = Paperclip::Interpolations.filename(self, style_name.to_sym)
+            fd.write(@ipfs.cat("#{directory}/#{filename}"))
+          end
+        end
+      end
+
+      def flush_writes #:nodoc:
+        return if @queued_for_write.empty?
+
+        Dir.mktmpdir do |tempdir|
+          Dir.chdir(tempdir) do
+            @attr = queued_for_write.each do |style_name, file|
+              Dir.mkdir(style_name.to_s)
+              File.open(Pathname.new(style_name.to_s).join(original_filename), 'wb') do |fd|
+                IO.copy_stream(file, fd)
+              end
+            end
+          end
+          @ipfs.add Dir.new(tempdir) do |node|
+            if node.name == File.basename(tempdir)
+              instance_write('ipfs_hash'.to_sym, node.hash)
+            end
+          end
+        end
+
+        after_flush_writes
+        @queued_for_write.clear
+        instance.save
+      end
+
+      def flush_deletes #:nodoc:
+        log('deleting is not supported on IPFS')
+        @queued_for_delete.clear
+      end
+    end
+  end
+end

data/paperclip-ipfs-storage.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: paperclip-ipfs-storage 0.9.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "paperclip-ipfs-storage".freeze
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["mecab".freeze]
+  s.date = "2017-05-07"
+  s.description = "The paperclip storage library to save files on IPFS network.".freeze
+  s.email = "mecab@misosi.ru".freeze
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/paperclip-ipfs-storage.rb",
+    "lib/paperclip/storage/ipfs.rb",
+    "paperclip-ipfs-storage.gemspec",
+    "test/helper.rb",
+    "test/test_paperclip-ipfs-storage.rb"
+  ]
+  s.homepage = "http://github.com/mecab/paperclip-ipfs-storage".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.11".freeze
+  s.summary = "The paperclip storage library to save files on IPFS network.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ipfs-api>.freeze, ["~> 0.3.0"])
+      s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.5"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<ipfs-api>.freeze, ["~> 0.3.0"])
+      s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.5"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ipfs-api>.freeze, ["~> 0.3.0"])
+    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.5"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'paperclip-ipfs-storage'
+
+class Test::Unit::TestCase
+end

data/test/test_paperclip-ipfs-storage.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestPaperclipIpfsStorage < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-ipfs-storage
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- mecab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ipfs-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The paperclip storage library to save files on IPFS network.
+email: mecab@misosi.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/paperclip-ipfs-storage.rb
+- lib/paperclip/storage/ipfs.rb
+- paperclip-ipfs-storage.gemspec
+- test/helper.rb
+- test/test_paperclip-ipfs-storage.rb
+homepage: http://github.com/mecab/paperclip-ipfs-storage
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: The paperclip storage library to save files on IPFS network.
+test_files: []