nftmaker_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ed4a8b49bcb2bacacbc032d1fa3ab8dfde2d350f4e1a98196b88e776ef1492f
+  data.tar.gz: a0b785bef14d2a0305fd8b161fa5d69f38460604b540a7939c9d800d32c394eb
+SHA512:
+  metadata.gz: 8052ddbee95d2133f94d2ac6983cac268debd2303c726a581ae5baaf5eceb2e058208cf0741f2adbd85c7afce390907c56ef2a64dffcb34012064e9f331ecc94
+  data.tar.gz: 341940e422281d82d7f64a5ede43b8711acf5ea11b99ac7a1e51e4601907a0b8f3264a3a40e458993c653c281c8bf35a3dc6f95c9bbe8e9e748cca759c954afd

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 lacepool
+
+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,160 @@
+# NftmakerApi
+
+A Ruby client for the https://nft-maker.io/pro API.
+
+It aims to support all API methods. The intuitive query methods allow to easily call the API endpoints.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nftmaker_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nftmaker_api
+
+## Configuration
+
+The configuration options can be set by using the `configure` block
+
+```ruby
+NftmakerApi.configure do |config|
+  config.api_key = ENV.fetch('NFT_MAKER_PRO_API_KEY')
+end
+```
+
+Alternatively, you can configure the settings by passing a hash of options to an instance like so
+
+```ruby
+client = NftmakerApi.new api_key: "xyz",
+                         http_adapter: :typheous
+```
+
+The following is the list of available configuration options
+
+```ruby
+api_key      # The API key provided by nft-maker.io
+http_adapter # The http client used for performing requests. Default :net_http
+host         # The API endpoint. Default: https://api.nft-maker.io
+```
+
+## 1 Usage
+
+To start using the gem, you first create a new client instance
+
+```ruby
+client = NftmakerApi.new
+```
+
+and then you call the methods for the API endpoints.
+
+### 1.1 Endpoints
+
+List all projects
+
+```ruby
+client.projects.list
+```
+
+Show metrics for a project
+
+```ruby
+client.project(1634).metrics
+```
+
+List all NFTs for a project
+
+```ruby
+client.project(1634).nfts.list     # all
+client.project(1634).nfts.sold     # only sold
+client.project(1634).nfts.free     # only free
+client.project(1634).nfts.reserved # only reserved
+```
+
+Create a new project
+
+```ruby
+client.projects.create(name: "Foo", policy_expires: true, policy_locks_at: Time.now.advance(months: 6), address_expires_in: 10)
+```
+
+Reserve NFT(s) from a project
+
+```ruby
+client.project(1634).reservations.create(nft_count: 1, lovelace: 10_000000)              # Reserve a random NFT
+client.project(1634).reservations.create(nft_id: 123, nft_count: 1, lovelace: 10_000000) # Reserve a specific NFT
+```
+
+Check / Cancel a reservation
+
+```ruby
+client.project(1634).reservation("addr1...").check
+client.project(1634).reservation("addr1...").cancel
+```
+
+## 2 Response Handling
+
+Responses are wrapped into a `NftmakerApi::Response` object. The main reason is to allow direct access to the parsed JSON response body.
+
+Sidenote: The JSON body is parsed using [Oj](https://github.com/ohler55/oj) which is a C implementation, hence much faster than [JSON from Ruby's Standard Library](https://ruby-doc.org/stdlib-3.0.2/libdoc/json/rdoc/JSON.html).
+
+
+
+```ruby
+client.projects.list.to_h
+# => [{"id"=>123, "projectname" => "Foo", ...}, ...]
+```
+
+Access the original faraday response object
+
+```ruby
+client.projects.list.original_response
+```
+
+### 2.1 Errors
+
+Check if the request was successful or returned an error
+
+```ruby
+client.projects.list.success?
+client.projects.list.error?
+```
+
+Response errors are always `NftmakerApi::Error` objects.
+
+```ruby
+client.projects.list.error
+```
+
+Show error message including status code, status phrase and the actual error message from the API
+
+```ruby
+client.projects.list.error.full_message
+```
+
+Show status code
+
+```ruby
+client.projects.list.error.status
+```
+
+Show error message returned from the API
+
+```ruby
+client.projects.list.error.reason
+```
+
+## 3 Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lacepool/nftmaker_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
+
+
+## 4 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/nftmaker_api/client/nfts.rb

@@ -0,0 +1,25 @@
+module NftmakerApi
+  class Client::Nfts
+    def initialize(client, project_id: nil)
+      @client = client
+      @project_id = project_id
+    end
+
+    def list(state: :all)
+      @client.get "GetNfts/#{@client.api_key}/#{@project_id}/#{state}"
+    end
+    alias_method :all, :list
+
+    def free
+      list(state: :free)
+    end
+
+    def reserved
+      list(state: :reserved)
+    end
+
+    def sold
+      list(state: :sold)
+    end
+  end
+end

data/lib/nftmaker_api/client/project.rb

@@ -0,0 +1,24 @@
+module NftmakerApi
+  class Client::Project
+    def initialize(client, id)
+      @client = client
+      @id = id
+    end
+
+    def metrics
+      @client.get "GetCounts/#{@client.api_key}/#{@id}"
+    end
+
+    def nfts
+      NftmakerApi::Client::Nfts.new(@client, project_id: @id)
+    end
+
+    def reservations
+      NftmakerApi::Client::Reservations.new(@client, project_id: @id)
+    end
+
+    def reservation(address)
+      NftmakerApi::Client::Reservation.new(@client, project_id: @id, address: address)
+    end
+  end
+end

data/lib/nftmaker_api/client/projects.rb

@@ -0,0 +1,18 @@
+module NftmakerApi
+  class Client::Projects
+    def initialize(client)
+      @client = client
+    end
+
+    def create(name:, policy_expires: true, policy_locks_at: Time.now.advance(months: 6), address_expires_in: 10)
+      body = {projectname: name, maxNftSupply: 1, policyExpires: policy_expires, addressExpiretime: address_expires_in}
+      body.merge!({ policyLocksDateTime: policy_locks_at.iso8601 }) if policy_expires
+
+      @client.post "/CreateProject/#{@client.api_key}", body.to_json
+    end
+
+    def list
+      @client.get "ListProjects/#{@client.api_key}"
+    end
+  end
+end

data/lib/nftmaker_api/client/reservation.rb

@@ -0,0 +1,17 @@
+module NftmakerApi
+  class Client::Reservation
+    def initialize(client, project_id:, address:)
+      @client = client
+      @project_id = project_id
+      @address = address
+    end
+
+    def check
+      @client.get "CheckAddress/#{@client.api_key}/#{@project_id}/#{@address}"
+    end
+
+    def cancel
+      @client.get "CancelAddressReservation/#{@client.api_key}/#{@project_id}/#{@address}"
+    end
+  end
+end

data/lib/nftmaker_api/client/reservations.rb

@@ -0,0 +1,18 @@
+module NftmakerApi
+  class Client::Reservations
+    def initialize(client, project_id:)
+      @client = client
+      @project_id = project_id
+    end
+
+    def create(nft_id: nil, nft_count:, lovelace:)
+      if nft_id.blank?
+        endpoint = "GetAddressForRandomNftSale/#{@client.api_key}/#{@project_id}/#{nft_count}/#{lovelace}"
+      else
+        endpoint = "GetAddressForSpecificNftSale/#{@client.api_key}/#{@project_id}/#{nft_id}/#{nft_count}/#{lovelace}"
+      end
+
+      @client.get endpoint
+    end
+  end
+end

data/lib/nftmaker_api/client.rb

@@ -0,0 +1,54 @@
+require_relative "response"
+
+module NftmakerApi
+  class Client
+    attr_reader :configuration, :api_key, :host, :last_response
+
+    def initialize(options = {})
+      @configuration = OpenStruct.new(
+        NftmakerApi.configuration.to_h.merge(options)
+      )
+
+      @api_key = @configuration.api_key
+      @host = @configuration.host
+    end
+
+    def projects
+      Projects.new(self)
+    end
+
+    def project(id)
+      Project.new(self, id)
+    end
+
+    def nfts
+      Nfts.new(self)
+    end
+
+    def reservations(project_id:)
+      Reservations.new(self, project_id: project_id)
+    end
+
+    def reservation(project_id:, address:)
+      Reservation.new(self, project_id: project_id, address: address)
+    end
+
+    def get(endpoint)
+      @last_response = Response.new(http_client.get endpoint)
+    end
+
+    def post(endpoint, body)
+      response = http_client.post(endpoint) do |req|
+        req.body = Oj.dump(body)
+      end
+
+      @last_response = Response.new(response)
+    end
+
+    def http_client
+      @http_client ||= Faraday.new(url: host, headers: {'Content-Type' => 'application/json'}) do |f|
+        f.adapter configuration.http_adapter
+      end
+    end
+  end
+end

data/lib/nftmaker_api/configuration.rb

@@ -0,0 +1,24 @@
+module NftmakerApi
+  class << self
+    def configuration
+      @configuration ||= OpenStruct.new(configuration_defaults)
+    end
+
+    def configuration_defaults
+      {
+        api_key: nil,
+        host: "https://api.nft-maker.io",
+        http_adapter: Faraday.default_adapter
+      }
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def new(options = {})
+      Client.new(options)
+    end
+  end
+end
+

data/lib/nftmaker_api/error.rb

@@ -0,0 +1,24 @@
+module NftmakerApi
+  class Error
+    def initialize(response)
+      @response = response
+    end
+
+    def to_s
+      ["#{status} #{status_phrase}", reason].compact.join(", ")
+    end
+    alias_method :full_message, :to_s
+
+    def status
+      @response.original.status
+    end
+
+    def status_phrase
+      @response.original.reason_phrase
+    end
+
+    def reason
+      @response.to_h.fetch("errorMessage") { nil }
+    end
+  end
+end

data/lib/nftmaker_api/response.rb

@@ -0,0 +1,29 @@
+require_relative "error"
+
+module NftmakerApi
+  class Response
+    attr_reader :original_response
+    alias_method :original, :original_response
+
+    def initialize(response)
+      @original_response = response
+    end
+
+    def parsed
+      @parsed = Oj.load(@original_response.body) || {}
+    end
+    alias_method :to_h, :parsed
+
+    def success?
+      @original_response.status == 200
+    end
+
+    def error?
+      !success?
+    end
+
+    def error
+      @error ||= success? ? nil : Error.new(self)
+    end
+  end
+end

data/lib/nftmaker_api/version.rb

@@ -0,0 +1,3 @@
+module NftmakerApi
+  VERSION = "0.1.0"
+end

data/lib/nftmaker_api.rb

@@ -0,0 +1,12 @@
+require "faraday"
+require "oj"
+
+require_relative "nftmaker_api/version"
+require_relative "nftmaker_api/configuration"
+
+require_relative "nftmaker_api/client"
+require_relative "nftmaker_api/client/project"
+require_relative "nftmaker_api/client/projects"
+require_relative "nftmaker_api/client/nfts"
+require_relative "nftmaker_api/client/reservations"
+require_relative "nftmaker_api/client/reservation"

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: nftmaker_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lacepool
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Ruby client that supports all of the nft-maker.io PRO API methods.
+email:
+- hello@lacepool.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/nftmaker_api.rb
+- lib/nftmaker_api/client.rb
+- lib/nftmaker_api/client/nfts.rb
+- lib/nftmaker_api/client/project.rb
+- lib/nftmaker_api/client/projects.rb
+- lib/nftmaker_api/client/reservation.rb
+- lib/nftmaker_api/client/reservations.rb
+- lib/nftmaker_api/configuration.rb
+- lib/nftmaker_api/error.rb
+- lib/nftmaker_api/response.rb
+- lib/nftmaker_api/version.rb
+homepage: https://github.com/lacepool
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lacepool
+  source_code_uri: https://github.com/lacepool/nftmaker_api
+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.28
+signing_key:
+specification_version: 4
+summary: Ruby client for the nft-maker.io PRO API
+test_files: []