activestorage-nft 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7dda2bcfde58be6c1c02fb5f86399ff9d511e450a425627aeafc3c55365e3916
+  data.tar.gz: 46ef8a1d47ab0d6fcc960ef949fc126fd5b1cc620029d1815ef98ceda973e0fe
+SHA512:
+  metadata.gz: 3aab4924b91d8e53c5abb59babf7d477b799eb75ae074b4d10ed1f883a45a616be7dc898888335c298101be8a72288b3266cc4ec643fa4ad21cd5deadc5a6654
+  data.tar.gz: 27f4f2744a24b2b63d89617e5bd9d872b9a8f38c587ca4c7b05c1925c5d1e155efaf650a851f1a31f6fd4a9dba5ceaea31379407453f62ed0204cff656fc6bc5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.5

data/.travis.yml

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

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 mulengabowa53@gmail.com. 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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activestorage-nft.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    activestorage-nft (0.0.2)
+      http (~> 4.3)
+      nft_storage (~> 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.4)
+    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.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    nft_storage (1.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+    public_suffix (4.0.6)
+    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.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.3)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activestorage-nft!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Stefan Buhrmester
+
+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,63 @@
+# Activestorage::Nft
+
+This gem extends the ActiveStorage::Service with an implementation for
+[NFT.storage](https://nft.storage).
+
+We use [gateway.pinata.cloud](https://pinata.cloud) as IPFS gateway, because NFT.storage automatically pins all uploads to the pinata.cloud pinning service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-nft'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+In your Rails 5.2+ app, run:
+
+```
+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 nft service. Declare a Nft service in `config/storage.yml`. Each service requires a `api_key` and a `gateway_endpoint`.
+
+```yml
+nft:
+  service: nft
+  gateway_endpoint: https://gateway.pinata.cloud
+  api_key: <%= ENV["NFT_STORAGE_API_KEY"] %>
+```
+
+## Direct Upload
+
+    # TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/buhrmi/activestorage-nft. 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/buhrmi/activestorage-nft/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Activestorage::Nft project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/buhrmi/activestorage-nft/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activestorage-nft.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/active_storage/service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activestorage-nft"
+  spec.version       = ActiveStorage::NftService::VERSION
+  spec.authors       = ["Stefan Buhrmester"]
+  spec.email         = ["stefan@moogical.dev"]
+
+  spec.summary       = ""
+  spec.description   = "A ActiveStorage Service"
+  spec.homepage      = "http://github.com/buhrmi/activestorage-nft"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://github.com/buhrmi/activestorage-nft"
+  spec.metadata["changelog_uri"] = "http://github.com/buhrmi/activestorage-nft"
+
+  # 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"]
+
+  spec.add_dependency 'http', '~> 4.3'
+  spec.add_dependency 'nft_storage', '~> 1.0.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activestorage/nft"
+
+# 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/active_storage/service/nft_service.rb

@@ -0,0 +1,59 @@
+require 'nft/client'
+
+module ActiveStorage
+  class Service::NftService < Service
+    attr_accessor :client
+
+    def initialize(api_key:, gateway_endpoint:)
+      @client = Nft::Client.new api_key, gateway_endpoint
+    end
+
+    # File is uploaded to NFT.storage and a hash
+    # is returned which is used to retrieve the file
+    # Change the key of the blob to that of the hash
+    def upload(key, io, checksum: nil, **)
+      instrument :upload, key: key, checksum: checksum do
+        cid_key = @client.add io.path
+
+        Blob.find_by_key(key).update key: cid_key
+      end
+    end
+
+    def download(key, &block)
+      if block_given?
+        instrument :streaming_download, key: key do
+          @client.download key, &block
+        end
+      else
+        instrument :download, key: key do
+          @client.download key
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        @client.cat key, range.begin, range.size
+      end
+    end
+
+    def url(key, content_type: nil, filename: nil, expires_in: nil, disposition: nil)
+      instrument :url, key: key do
+        @client.build_file_url key, filename.to_s
+      end
+    end
+
+    def exists?(key)
+      instrument :exist, key: key do
+        @client.file_exists?(key)
+      end
+    end
+
+    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
+    end
+
+  end
+end

data/lib/active_storage/service/version.rb

@@ -0,0 +1,5 @@
+module ActiveStorage
+  module NftService
+    VERSION = '0.0.2'.freeze
+  end
+end

data/lib/nft/client.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'http'
+require 'json'
+
+module Nft
+  class Error < StandardError; end
+  class NotFoundError < Error; end
+
+  class Client
+    attr_reader :api_key, :gateway_endpoint, :http_client
+
+    def initialize(api_key, gateway_endpoint)
+      @api_key = api_key
+      @gateway_endpoint = gateway_endpoint
+      @http_client = HTTP
+    end
+
+    # Uploads a file to NFT.storage and returns the IPFS CID
+    def add(path)
+      res = @http_client.auth("Bearer #{@api_key}").post(
+        "https://api.nft.storage/upload", body: File.open(path)
+      )
+
+      if res.code >= 200 && res.code <= 299
+        JSON.parse(res.body)['value']['cid']
+      else
+        raise Error, res.body
+      end
+    end
+
+    def download(hash, &block)
+      url = build_file_url(hash)
+      res = @http_client.get(url)
+
+      if block_given?
+        res.body.each(&block)
+      else
+        res.body
+      end
+    end
+
+    def file_exists?(cid)
+      res = @http_client.auth("Bearer #{@api_key}").get(
+        "https://api.nft.storage/check/#{cid}"
+      )
+      if res.code >= 200 && res.code <= 299
+        true
+      else
+        false
+      end
+    end
+
+    def build_file_url(hash, filename = '')
+      query = filename.empty? ? '' : "?filename=#{filename}"
+      "#{@gateway_endpoint}/ipfs/#{hash}#{query}"
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-nft
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stefan Buhrmester
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: nft_storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A ActiveStorage Service
+email:
+- stefan@moogical.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activestorage-nft.gemspec
+- bin/console
+- bin/setup
+- lib/active_storage/service/nft_service.rb
+- lib/active_storage/service/version.rb
+- lib/nft/client.rb
+homepage: http://github.com/buhrmi/activestorage-nft
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://github.com/buhrmi/activestorage-nft
+  source_code_uri: http://github.com/buhrmi/activestorage-nft
+  changelog_uri: http://github.com/buhrmi/activestorage-nft
+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.2.22
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []