nft_storage 1.0.0

data/lib/nft_storage.rb

@@ -0,0 +1,56 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+# Common files
+require 'nft_storage/api_client'
+require 'nft_storage/api_error'
+require 'nft_storage/version'
+require 'nft_storage/configuration'
+
+# Models
+require 'nft_storage/models/deal'
+require 'nft_storage/models/delete_response'
+require 'nft_storage/models/error_response'
+require 'nft_storage/models/error_response_error'
+require 'nft_storage/models/forbidden_error_response'
+require 'nft_storage/models/forbidden_error_response_error'
+require 'nft_storage/models/get_response'
+require 'nft_storage/models/links'
+require 'nft_storage/models/links_file'
+require 'nft_storage/models/list_response'
+require 'nft_storage/models/nft'
+require 'nft_storage/models/pin'
+require 'nft_storage/models/pin_status'
+require 'nft_storage/models/unauthorized_error_response'
+require 'nft_storage/models/unauthorized_error_response_error'
+require 'nft_storage/models/upload_response'
+
+# APIs
+require 'nft_storage/api/nft_storage_api'
+
+module NFTStorage
+  class << self
+    # Customize default settings for the SDK using block.
+    #   NFTStorage.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/nft_storage.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "nft_storage/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nft_storage"
+  s.version     = NFTStorage::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["OpenAPI-Generator"]
+  s.email       = [""]
+  s.homepage    = "https://openapi-generator.tech"
+  s.summary     = "A client library for the https://nft.storage/ service."
+  s.description = "A client library for the https://nft.storage/ service."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/nft_storage_api_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for NFTStorage::NFTStorageAPI
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'NFTStorageAPI' do
+  before do
+    # run before each test
+    @api_instance = NFTStorage::NFTStorageAPI.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of NFTStorageAPI' do
+    it 'should create an instance of NFTStorageAPI' do
+      expect(@api_instance).to be_instance_of(NFTStorage::NFTStorageAPI)
+    end
+  end
+
+  # unit tests for delete
+  # Stop storing the content with the passed CID
+  # Stop storing the content with the passed CID on nft.storage. - Unpin the item from the underlying IPFS pinning service. - Cease renewals for expired Filecoin deals involving the CID.    ⚠️ This does not remove the content from the network.  - Does not terminate any established Filecoin deal. - Does not remove the content from other IPFS nodes in the network that already cached or pinned the CID.    Note: the content will remain available if another user has stored the CID with nft.storage. 
+  # @param cid CID for the NFT
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteResponse]
+  describe 'delete test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list
+  # List all stored files
+  # @param [Hash] opts the optional parameters
+  # @option opts [Time] :before Return results created before provided timestamp
+  # @option opts [Integer] :limit Max records to return
+  # @return [ListResponse]
+  describe 'list test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for status
+  # Get information for the stored file CID
+  # Includes the IPFS pinning state and the Filecoin deal state.
+  # @param cid CID for the NFT
+  # @param [Hash] opts the optional parameters
+  # @return [GetResponse]
+  describe 'status test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for store
+  # Store a file
+  # Store a file with nft.storage.  - Submit a HTTP `POST` request passing the file data in the request body. - To store multiple files in a directory, submit a `multipart/form-data` HTTP `POST` request.  Use the `Content-Disposition` header for each part to specify a filename. 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [UploadResponse]
+  describe 'store test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe NFTStorage::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          NFTStorage.configure { |c| c.host = 'http://example.com' }
+          expect(NFTStorage::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          NFTStorage.configure { |c| c.host = 'https://wookiee.com' }
+          expect(NFTStorage::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          NFTStorage.configure { |c| c.host = 'hobo.com/v4' }
+          expect(NFTStorage::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          NFTStorage.configure { |c| c.base_path = 'v4/dog' }
+          expect(NFTStorage::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          NFTStorage.configure { |c| c.base_path = '/v4/dog' }
+          expect(NFTStorage::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          NFTStorage.configure { |c| c.base_path = nil }
+          expect(NFTStorage::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { NFTStorage::Configuration.new }
+    let(:api_client) { NFTStorage::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(NFTStorage::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { NFTStorage::Configuration.new }
+    let(:api_client) { NFTStorage::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(NFTStorage::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = NFTStorage::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = NFTStorage::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = NFTStorage::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = NFTStorage::ApiClient.new
+      # _model = NFTStorage::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { NFTStorage::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { NFTStorage::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { NFTStorage::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { NFTStorage::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { NFTStorage::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe NFTStorage::Configuration do
+  let(:config) { NFTStorage::Configuration.default }
+
+  before(:each) do
+    # uncomment below to setup host and base_path
+    # require 'URI'
+    # uri = URI.parse("https://api.nft.storage")
+    # NFTStorage.configure do |c|
+    #   c.host = uri.host
+    #   c.base_path = uri.path
+    # end
+  end
+
+  describe '#base_url' do
+    it 'should have the default value' do
+      # uncomment below to test default value of the base path
+      # expect(config.base_url).to eq("https://api.nft.storage")
+    end
+
+    it 'should remove trailing slashes' do
+      [nil, '', '/', '//'].each do |base_path|
+        config.base_path = base_path
+        # uncomment below to test trailing slashes
+        # expect(config.base_url).to eq("https://api.nft.storage")
+      end
+    end
+  end
+end

data/spec/models/deal_spec.rb

@@ -0,0 +1,96 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for NFTStorage::Deal
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe NFTStorage::Deal do
+  let(:instance) { NFTStorage::Deal.new }
+
+  describe 'test an instance of Deal' do
+    it 'should create an instance of Deal' do
+      expect(instance).to be_instance_of(NFTStorage::Deal)
+    end
+  end
+  describe 'test attribute "batch_root_cid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "last_change"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "miner"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "network"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["nerpanet", "mainnet"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.network = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "piece_cid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["queued", "proposing", "accepted", "failed", "active", "published", "terminated"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "status_text"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "chain_deal_id"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "deal_activation"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "deal_expiration"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/delete_response_spec.rb

@@ -0,0 +1,34 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for NFTStorage::DeleteResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe NFTStorage::DeleteResponse do
+  let(:instance) { NFTStorage::DeleteResponse.new }
+
+  describe 'test an instance of DeleteResponse' do
+    it 'should create an instance of DeleteResponse' do
+      expect(instance).to be_instance_of(NFTStorage::DeleteResponse)
+    end
+  end
+  describe 'test attribute "ok"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/error_response_error_spec.rb

@@ -0,0 +1,40 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for NFTStorage::ErrorResponseError
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe NFTStorage::ErrorResponseError do
+  let(:instance) { NFTStorage::ErrorResponseError.new }
+
+  describe 'test an instance of ErrorResponseError' do
+    it 'should create an instance of ErrorResponseError' do
+      expect(instance).to be_instance_of(NFTStorage::ErrorResponseError)
+    end
+  end
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/error_response_spec.rb

@@ -0,0 +1,40 @@
+=begin
+#NFT Storage API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for NFTStorage::ErrorResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe NFTStorage::ErrorResponse do
+  let(:instance) { NFTStorage::ErrorResponse.new }
+
+  describe 'test an instance of ErrorResponse' do
+    it 'should create an instance of ErrorResponse' do
+      expect(instance).to be_instance_of(NFTStorage::ErrorResponse)
+    end
+  end
+  describe 'test attribute "ok"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "error"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end