{"id":18877582,"url":"https://github.com/nftstorage/ruby-client","last_synced_at":"2025-04-14T18:31:49.888Z","repository":{"id":48347284,"uuid":"353384430","full_name":"nftstorage/ruby-client","owner":"nftstorage","description":"A client library for the NFT.Storage Classic service.","archived":false,"fork":false,"pushed_at":"2024-07-03T04:48:13.000Z","size":53,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-28T07:02:22.959Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nftstorage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-31T14:27:34.000Z","updated_at":"2024-07-03T04:48:17.000Z","dependencies_parsed_at":"2022-08-31T09:31:37.166Z","dependency_job_id":null,"html_url":"https://github.com/nftstorage/ruby-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fruby-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fruby-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fruby-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fruby-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nftstorage","download_url":"https://codeload.github.com/nftstorage/ruby-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248936752,"owners_count":21186097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T06:20:04.799Z","updated_at":"2025-04-14T18:31:49.622Z","avatar_url":"https://github.com/nftstorage.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nft_storage\n\n_This client was generated via the OpenAPI schema and is experimental, unsupported, and may not work at all!_\n\nNFTStorage - the Ruby gem for the NFT Storage API\n\nNo description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 1.0.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\n\n## Product Decommission Notice\n\n### Important Update\n\nHello from NFT.Storage!\n\nAs of June 30, 2024, we have officially decommissioned NFT.Storage Classic uploads. This means that NFT.Storage Classic, including NFTUp, the Classic web app, Classic APIs, Classic SDK, and Pinning API, will no longer accept new uploads/pins.\n\n### What This Means for You\n\n**Service Termination:** NFT.Storage Classic will no longer accept new uploads. However, retrieval of existing data remains operational.\n\n**Data Access:** Don't forget, we're still keeping a copy of your NFT.Storage Classic data available in the NFT.Storage Gateway and in the decentralized Filecoin Network. However, over time, latency and availability may degrade.\n\n**Support:** We’ll be working with the newly formed NFT.Storage community to determine what changes, if any, will impact NFT.Storage Classic data latency and availability in the future. Join the community [Join the community](https://nft.storage/join-us) to have your say. We will keep you informed by email and on Twitter/X.\n\n### Transition to the New Version\n\nFor the new version of NFT.Storage, first mint your NFTs, then send us the NFT data—metadata and imagery CIDs, blockchain(s) minted on, contract address, and token IDs. We will preserve these in long-term Filecoin storage. Note that you need to upload the data to IPFS separately. Your NFTs will also be included in the NFT Token Checker, a tool for block explorers, marketplaces, and wallets to show verification that NFT collections, tokens, and CIDs are preserved by NFT.Storage.\n\n### Recommended Hot Storage Alternatives\n\nWe’re excited to announce our partnerships with Pinata and Lighthouse for hot storage solutions. As an NFT.Storage user, you support our platform when you choose Pinata and Lighthouse and use our referral links, helping to sustain our valuable public goods. [Learn more here](https://nft.storage/blog/announcing-our-new-partnerships-with-pinata-and-lighthouse).\n\n**Pinata:** Offers flexible plans and powerful, easy-to-use tools for managing your data on IPFS. Use code NFTSTORAGE50 at checkout to enjoy 50% off your first month. [Sign up today](https://pinata.cloud).\n\n**Lighthouse:** An IPFS provider with unique payment options for NFT longevity. They offer affordability and flexibility for all your IPFS needs, including a pay-once and store-forever option. [Sign up today](https://lighthouse.storage).\n\n### Contact Us\n\nFor any questions or assistance, contact us [contact us](https://nft.storage/contact-us). Together, we look forward to a promising future for NFT.Storage and the broader NFT ecosystem.\n\nBest regards,  \nThe NFT.Storage Team\n\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build nft_storage.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./nft_storage-1.0.0.gem\n```\n\n(for development, run `gem install --dev ./nft_storage-1.0.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'nft_storage', '~\u003e 1.0.0'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/nftstorage/ruby-client, then add the following in the Gemfile:\n\n    gem 'nft_storage', :git =\u003e 'https://github.com/nftstorage/ruby-client.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n\n```ruby\n# Load the gem\nrequire 'nft_storage'\n\n# Setup authorization\nNFTStorage.configure do |config|\n  # Configure Bearer authorization (JWT): bearerAuth\n  config.access_token = 'YOUR_BEARER_TOKEN'\nend\n\napi_instance = NFTStorage::NFTStorageAPI.new\ncid = 'cid_example' # String | CID for the NFT\n\nbegin\n  #Stop storing the content with the passed CID\n  result = api_instance.delete(cid)\n  p result\nrescue NFTStorage::ApiError =\u003e e\n  puts \"Exception when calling NFTStorageAPI-\u003edelete: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.nft.storage*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*NFTStorage::NFTStorageAPI* | [**delete**](docs/NFTStorageAPI.md#delete) | **DELETE** /{cid} | Stop storing the content with the passed CID\n*NFTStorage::NFTStorageAPI* | [**list**](docs/NFTStorageAPI.md#list) | **GET** / | List all stored files\n*NFTStorage::NFTStorageAPI* | [**status**](docs/NFTStorageAPI.md#status) | **GET** /{cid} | Get information for the stored file CID\n*NFTStorage::NFTStorageAPI* | [**store**](docs/NFTStorageAPI.md#store) | **POST** /upload | Store a file\n\n\n## Documentation for Models\n\n - [NFTStorage::Deal](docs/Deal.md)\n - [NFTStorage::DeleteResponse](docs/DeleteResponse.md)\n - [NFTStorage::ErrorResponse](docs/ErrorResponse.md)\n - [NFTStorage::ErrorResponseError](docs/ErrorResponseError.md)\n - [NFTStorage::ForbiddenErrorResponse](docs/ForbiddenErrorResponse.md)\n - [NFTStorage::ForbiddenErrorResponseError](docs/ForbiddenErrorResponseError.md)\n - [NFTStorage::GetResponse](docs/GetResponse.md)\n - [NFTStorage::Links](docs/Links.md)\n - [NFTStorage::LinksFile](docs/LinksFile.md)\n - [NFTStorage::ListResponse](docs/ListResponse.md)\n - [NFTStorage::NFT](docs/NFT.md)\n - [NFTStorage::Pin](docs/Pin.md)\n - [NFTStorage::PinStatus](docs/PinStatus.md)\n - [NFTStorage::UnauthorizedErrorResponse](docs/UnauthorizedErrorResponse.md)\n - [NFTStorage::UnauthorizedErrorResponseError](docs/UnauthorizedErrorResponseError.md)\n - [NFTStorage::UploadResponse](docs/UploadResponse.md)\n\n\n## Documentation for Authorization\n\n\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fruby-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnftstorage%2Fruby-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fruby-client/lists"}