activestorage-ipfs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6761f8c2f4fa18e89e3fda8f197c77db370569c47854df1c40900cc1b96d58ce
-  data.tar.gz: cf84436a46cd3769f3c8457d9a7c4ad06c02ab96164b06fac5ef6d7b2e7b37af
+  metadata.gz: f7447b6d72f0ded377e6c047d37706939ebab0ee056222d9a2483a74a272757a
+  data.tar.gz: f8073646a0845875686ffb33c38f3c1d168bd8b8717a4fe93a2519b5e3c5f855
 SHA512:
-  metadata.gz: 5b81a67d258e459a5f45550f3c10ceda64cf8675c7b1d519598dc5e81a48791be62b84bbfe969d728cba5c61be2399954394a603a2b850b0ea707d20ff1e0e9f
-  data.tar.gz: '08bf8641b83c558906f35ef9bf7a2b75aa661a2ddc16994da4eaa554e32168d96c46abae5a6f20dd30b096aedfa1ef89da43c682d18870162cc9239bc113aac8'
+  metadata.gz: c47771e35cb1ad5c605c3b1c01244157cc199bb09bbba0ab2c7883c9e638ef6c681ced55dc04a5c5be2f5e735866dbcb813535f166cd1ef28a565255c4cf62f2
+  data.tar.gz: 30f1ab2978507691be6eb660fc9dfd9b88eb631e622142e386b19d810590e6e55d60bb8638d1f94b617f085d75bdd8a734e24f3f8f72e2c31911060d42d77cb6

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    activestorage-ipfs (0.0.1)
-      http (~> 3.0)
+    activestorage-ipfs (0.0.2)
+      http (~> 4.3)
 
 GEM
   remote: https://rubygems.org/
@@ -12,30 +12,35 @@ GEM
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    http (3.3.0)
+    ffi (1.13.0)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http_parser.rb (0.6.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
     public_suffix (4.0.5)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)

data/README.md

@@ -1,8 +1,7 @@
 # Activestorage::Ipfs
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activestorage/ipfs`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem extends the ActiveStorage::Service with an implementation for
+[IPFS](https://ipfs.io)
 
 ## Installation
 
@@ -16,13 +15,61 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install activestorage-ipfs
+In your Rails 5.2+ app, run:
 
-## Usage
+```
+rails active_storage:install
+```
+
+This will copy over active_storage migration for creating the tables and then run:
+
+```
+rails db:migrate
+```
+We now need to tell activestorage to use the ipfs service. Declare a Ipfs service in `config/storage.yml`. Each service requires a `api_endpoint` and a `gateway_endpoint`
+
+```yml
+ipfs:
+  service: Ipfs
+  api_endpoint: http://localhost:5001
+  gateway_endpoint: http://localhost:8080
+```
+
+## Direct Upload
+
+Direct uploads can be used by installing `activestorage-ipfs-js` run:
+
+```
+yarn install activestorage-ipfs-js
+```
+
+After installing the js package replace this line in `app/javascript/packs/application.js`
+
+```js
+require("@rails/activestorage").start()
+```
+
+With this line:
+
+```js
+require("activestorage-ipfs-js").start()
+```
+
+We annotate the file inputs with the direct upload url, and the ipfs api url
+
+```
+<%= form.file_field :file, direct_upload: true, data: { ipfs_url: 'http://localhost:5001' }  =%>
+```
+If Ipfs is running at localhost run the following cmds:
+
+```
+ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["*"]'
+ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]
+```
 
-TODO: Write usage instructions here
+That's it! Upon submission the file upload begins
 
 ## Development
 
@@ -32,7 +79,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activestorage-ipfs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/activestorage-ipfs/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/mul53/activestorage-ipfs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/activestorage-ipfs/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License

data/activestorage-ipfs.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'http', '~> 3.0'
+  spec.add_dependency 'http', '~> 4.3'
 end

data/lib/active_storage/service/ipfs_service.rb

@@ -10,14 +10,14 @@ end
 class ActiveStorage::Blob
   class << self
     def create_before_direct_upload!(key: nil, filename:, byte_size:, checksum:, content_type: nil, metadata: nil)
-      create! key: key, filename: filename, byte_size: byte_size, checksum: checksum, content_type: content_type, metadata: metadata
+      find_or_create_by! key: key, filename: filename, byte_size: byte_size, checksum: checksum, content_type: content_type
     end
   end
 end
 
 module ActiveStorage
   class Service::IpfsService < Service
-    attr_reader :client
+    attr_accessor :client
 
     def initialize(api_endpoint:, gateway_endpoint:)
       @client = Ipfs::Client.new api_endpoint, gateway_endpoint
@@ -29,13 +29,22 @@ module ActiveStorage
     def upload(key, io, checksum: nil, **)
       instrument :upload, key: key, checksum: checksum do
         data = @client.add io.path
-        find_blob(key).update(key: data['Hash'])
-        # TODO: Ensure integrity of checksum
+        cid_key = data['Hash']
+
+        if blob_exists?(cid_key)
+          existing_blob = find_blob(cid_key)
+          new_blob = find_blob(key)
+          attachment = Attachment.last
+          
+          attachment.update blob_id: existing_blob.id
+          new_blob.destroy!
+        else
+          find_blob(key).update key: cid_key
+        end
       end
     end
 
     def download(key, &block)
-      puts key
       if block_given?
         instrument :streaming_download, key: key do
           @client.download key, &block
@@ -54,18 +63,18 @@ module ActiveStorage
     end
 
     def url(key, content_type: nil, filename: nil, expires_in: nil, disposition: nil)
-      @client.build_file_url key, filename.to_s
+      instrument :url, key: key do
+        @client.build_file_url key, filename.to_s
+      end
     end
 
     def exists?(key)
-      instrument :exist, key: key do |payload|
-        answer = @client.file_exists?(key)
-        payload[:exist] = answer
-        answer
+      instrument :exist, key: key do
+        @client.file_exists?(key)
       end
     end
 
-    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+    def url_for_direct_upload(key, expires_in: nil, content_type: nil, content_length: nil, checksum: nil)
       instrument :url_for_direct_upload, key: key do
         "#{@client.api_endpoint}/api/v0/add"
       end
@@ -76,5 +85,9 @@ module ActiveStorage
     def find_blob(key)
       Blob.find_by_key key
     end
+
+    def blob_exists?(key)
+      Blob.exists?(key: key)
+    end
   end
 end

data/lib/active_storage/service/version.rb

@@ -1,5 +1,5 @@
 module ActiveStorage
   module IpfsService
-    VERSION = '0.0.1'.freeze
+    VERSION = '0.0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-ipfs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mulenga Bowa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.3'
 description: A ActiveStorage Service
 email:
 - mulengabowa53@gmail.com