nft_storage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa47b6a9a892c8afabb228926d4c802527acbcb1de01e761baf08453ab1491d3
+  data.tar.gz: 0e12911ab256ef5b532c21c9ed7fb818e1f7f7de5057c67ae485159b155b25a9
+SHA512:
+  metadata.gz: 2b38d7626b3a3e704bc75d5b59a243df40469ae67689515c06bbfa903e619fe8870635786cfd5345a850538f721c45d3539f37771eed65c085c9f6ba71011f12
+  data.tar.gz: 24565d5ed9676aab002f2de277344bd06d675aee68fae44a266accee3bb55ec25c48e0e038bb4f9d3d84b317efead126fcfdd643e01610553b603ac4fc678170

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    nft_storage (1.0.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.4)
+    jaro_winkler (1.5.4)
+    method_source (1.0.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (4.0.2)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.11.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  nft_storage!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -0,0 +1,118 @@
+# nft_storage
+
+_This client was generated via the OpenAPI schema and is experimental, unsupported, and may not work at all!_
+
+NFTStorage - the Ruby gem for the NFT Storage API
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build nft_storage.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./nft_storage-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./nft_storage-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'nft_storage', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/nftstorage/ruby-client, then add the following in the Gemfile:
+
+    gem 'nft_storage', :git => 'https://github.com/nftstorage/ruby-client.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'nft_storage'
+
+# Setup authorization
+NFTStorage.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = NFTStorage::NFTStorageAPI.new
+cid = 'cid_example' # String | CID for the NFT
+
+begin
+  #Stop storing the content with the passed CID
+  result = api_instance.delete(cid)
+  p result
+rescue NFTStorage::ApiError => e
+  puts "Exception when calling NFTStorageAPI->delete: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.nft.storage*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*NFTStorage::NFTStorageAPI* | [**delete**](docs/NFTStorageAPI.md#delete) | **DELETE** /{cid} | Stop storing the content with the passed CID
+*NFTStorage::NFTStorageAPI* | [**list**](docs/NFTStorageAPI.md#list) | **GET** / | List all stored files
+*NFTStorage::NFTStorageAPI* | [**status**](docs/NFTStorageAPI.md#status) | **GET** /{cid} | Get information for the stored file CID
+*NFTStorage::NFTStorageAPI* | [**store**](docs/NFTStorageAPI.md#store) | **POST** /upload | Store a file
+
+
+## Documentation for Models
+
+ - [NFTStorage::Deal](docs/Deal.md)
+ - [NFTStorage::DeleteResponse](docs/DeleteResponse.md)
+ - [NFTStorage::ErrorResponse](docs/ErrorResponse.md)
+ - [NFTStorage::ErrorResponseError](docs/ErrorResponseError.md)
+ - [NFTStorage::ForbiddenErrorResponse](docs/ForbiddenErrorResponse.md)
+ - [NFTStorage::ForbiddenErrorResponseError](docs/ForbiddenErrorResponseError.md)
+ - [NFTStorage::GetResponse](docs/GetResponse.md)
+ - [NFTStorage::Links](docs/Links.md)
+ - [NFTStorage::LinksFile](docs/LinksFile.md)
+ - [NFTStorage::ListResponse](docs/ListResponse.md)
+ - [NFTStorage::NFT](docs/NFT.md)
+ - [NFTStorage::Pin](docs/Pin.md)
+ - [NFTStorage::PinStatus](docs/PinStatus.md)
+ - [NFTStorage::UnauthorizedErrorResponse](docs/UnauthorizedErrorResponse.md)
+ - [NFTStorage::UnauthorizedErrorResponseError](docs/UnauthorizedErrorResponseError.md)
+ - [NFTStorage::UploadResponse](docs/UploadResponse.md)
+
+
+## Documentation for Authorization
+
+
+### bearerAuth
+
+- **Type**: Bearer authentication (JWT)
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Deal.md

@@ -0,0 +1,36 @@
+# NFTStorage::Deal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **batch_root_cid** | **String** |  | [optional] |
+| **last_change** | **String** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. |  |
+| **miner** | **String** | Miner ID | [optional] |
+| **network** | **String** | Filecoin network for this Deal | [optional] |
+| **piece_cid** | **String** | Piece CID string | [optional] |
+| **status** | **String** | Deal status |  |
+| **status_text** | **String** | Deal status description. | [optional] |
+| **chain_deal_id** | **Float** | Identifier for the deal stored on chain. | [optional] |
+| **deal_activation** | **String** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional] |
+| **deal_expiration** | **String** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::Deal.new(
+  batch_root_cid: bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u,
+  last_change: 2021-03-18T11:46:50.000Z,
+  miner: f05678,
+  network: null,
+  piece_cid: bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u,
+  status: null,
+  status_text: miner rejected my data,
+  chain_deal_id: 138,
+  deal_activation: 2021-03-18T11:46:50.000Z,
+  deal_expiration: 2021-03-18T11:46:50.000Z
+)
+```
+

data/docs/DeleteResponse.md

@@ -0,0 +1,18 @@
+# NFTStorage::DeleteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::DeleteResponse.new(
+  ok: null
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,20 @@
+# NFTStorage::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional][default to false] |
+| **error** | [**ErrorResponseError**](ErrorResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::ErrorResponse.new(
+  ok: null,
+  error: null
+)
+```
+

data/docs/ErrorResponseError.md

@@ -0,0 +1,20 @@
+# NFTStorage::ErrorResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::ErrorResponseError.new(
+  name: null,
+  message: null
+)
+```
+

data/docs/ForbiddenErrorResponse.md

@@ -0,0 +1,20 @@
+# NFTStorage::ForbiddenErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional][default to false] |
+| **error** | [**ForbiddenErrorResponseError**](ForbiddenErrorResponseError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::ForbiddenErrorResponse.new(
+  ok: null,
+  error: null
+)
+```
+

data/docs/ForbiddenErrorResponseError.md

@@ -0,0 +1,20 @@
+# NFTStorage::ForbiddenErrorResponseError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional][default to 'HTTP Error'] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::ForbiddenErrorResponseError.new(
+  name: null,
+  message: null
+)
+```
+

data/docs/GetResponse.md

@@ -0,0 +1,20 @@
+# NFTStorage::GetResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional][default to true] |
+| **value** | [**NFT**](.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::GetResponse.new(
+  ok: null,
+  value: null
+)
+```
+

data/docs/Links.md

@@ -0,0 +1,22 @@
+# NFTStorage::Links
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ipfs** | **String** |  | [optional] |
+| **http** | **String** |  | [optional] |
+| **file** | [**Array<LinksFile>**](LinksFile.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::Links.new(
+  ipfs: ipfs://bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u,
+  http: http://bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u.ipfs.dweb.link,
+  file: null
+)
+```
+

data/docs/LinksFile.md

@@ -0,0 +1,20 @@
+# NFTStorage::LinksFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ipfs** | **String** |  | [optional] |
+| **http** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::LinksFile.new(
+  ipfs: ipfs://bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u/image.jpg,
+  http: http://bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u.ipfs.dweb.link/image.jpg
+)
+```
+

data/docs/ListResponse.md

@@ -0,0 +1,20 @@
+# NFTStorage::ListResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ok** | **Boolean** |  | [optional][default to true] |
+| **value** | [**Array<NFT>**](NFT.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::ListResponse.new(
+  ok: null,
+  value: null
+)
+```
+

data/docs/NFT.md

@@ -0,0 +1,32 @@
+# NFTStorage::NFT
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cid** | **String** | Self-describing content-addressed identifiers for distributed systems. Check [spec](https://github.com/multiformats/cid) for more info. | [optional] |
+| **size** | **Float** | Size in bytes of the NFT data. | [optional][default to 132614] |
+| **created** | **Time** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional] |
+| **type** | **String** | MIME type of the upload file or 'directory' when uploading multiple files. | [optional] |
+| **scope** | **String** | Name of the JWT token used to create this NFT. | [optional][default to 'default'] |
+| **pin** | [**Pin**](Pin.md) |  | [optional] |
+| **files** | **Array<Object>** | Files in the directory (only if this NFT is a directory). | [optional] |
+| **deals** | [**Array<Deal>**](Deal.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nft_storage'
+
+instance = NFTStorage::NFT.new(
+  cid: bafkreidivzimqfqtoqxkrpge6bjyhlvxqs3rhe73owtmdulaxr5do5in7u,
+  size: null,
+  created: 2021-03-12T17:03:07.787Z,
+  type: image/jpeg,
+  scope: null,
+  pin: null,
+  files: null,
+  deals: null
+)
+```
+