nft_checker 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8153b19d92797310cd260ebdba17a6c11bdae0b9a3a0c86c182ba2e2047d2503
-  data.tar.gz: 1f20e9beb1b63cb0892b5182fbe48d85d5ed241b6aff57289343a5ddb23079d4
+  metadata.gz: ee63a9ddf05b513bb829ce69142bc73b6227350eb1e9619e6ad333ddec0f211d
+  data.tar.gz: 9e3333116358163185d059a8fd08ec4e819a3f6908a17f9ab0bb5e784628d583
 SHA512:
-  metadata.gz: f75b7bea25958aeca21abce0b3f7da30b4b09d03506279a8d50ac759924d7676e5a7ad11a0f666fe1c35aa27524d8015d1a560a5e1e012dcdd28df3c7ff09006
-  data.tar.gz: e9936d133831a60cdcd41d882e3e9abe0514bd72bb6ea4766919e1138aabb593771ab9c6947f47121bc953a7ee39fde8e701dc5c126b61eb92cd2a885cc75369
+  metadata.gz: 742a33fc52f8216b48097e079bdb2cca07d7d1bdd01231db1b56a2b48f5640be15a28f5040ab693ae5c099945ee8dbc77967a1999cdb0902017693fe92b8855d
+  data.tar.gz: b460ab9eae89f5276f218649acf73b1b28c7546cbfdc0308a831e38bbcf8d3e0c431e9a3b4cc98407a898775fd5a8f784ad5885696882e49729d8dc01d9efe0e

data/.rubocop.yml

@@ -12,3 +12,8 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-12-31
+
+Iterate on public API for easier use
+- Add `owner?` and `in_collection?` methods
+- Deprecated `verify_owner` (in favor of `owner?`)
+
 ## [0.1.0] - 2021-12-30
 
 Initial release with support for OpenSea NFTs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nft_checker (0.1.0)
+    nft_checker (0.2.0)
       httparty (~> 0.20)
 
 GEM

data/README.md

@@ -31,14 +31,25 @@ list = checker.list_nfts({slug: naturedivas}, "0x422699b0f5891c8ddd306c08d985603
 p list.map {|nft| nft["image_url"]} # [ "https://...", ... ]
 
 # Verify that naturediva 016 is still owned by Thision
-still_owned = checker.verify_owner(
+still_owned = checker.owner?(
+  "0x3dec7052aa8d55b3b6b6ad2c6bce195a9acca404",
   {
     contract_address: "0x495f947276749Ce646f68AC8c248420045cb7b5e",
     token_id: "29920848932956748486580529385461081269564523998318357035541486687674930561025"
-  },
-  "0x3dec7052aa8d55b3b6b6ad2c6bce195a9acca404"
+  }
 )
 p still_owned # true
+
+# Verify that naturediva 016 is part of the naturediva collection
+verified = checker.in_collection?(
+  {slug: naturedivas},
+  {
+    contract_address: "0x495f947276749Ce646f68AC8c248420045cb7b5e",
+    token_id: "29920848932956748486580529385461081269564523998318357035541486687674930561025"
+  }
+)
+p verified # true
+
 ```
 
 ## Development

data/lib/nft_checker/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module NftChecker
+  class Error < StandardError; end
+  class Throttled < Error; end
+end

data/lib/nft_checker/open_sea.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "httparty"
+require_relative "errors"
+
 module NftChecker
   ###
   # NFT Checker implementation for OpenSea
@@ -11,17 +13,30 @@ module NftChecker
     end
 
     # Verify that the NFT is owned by the given address
+    # @param address - address of presumed NFT owner
     # @param nft_metadata - hash containing :contract_address and :token_id values
-    # @param owner_address - address of presumed NFT owner
-    def verify_owner(nft_metadata, owner_address)
-      contract, token = nft_metadata.slice(:contract_address, :token_id).values
-      rez = HTTParty.get(@url_base + "asset/#{contract}/#{token}/", query: { account_address: owner_address })
-      handle_response_codes(rez, not_found: false) do
-        ownership_data = rez.parsed_response["ownership"]
-        return false if ownership_data.nil?
+    def owner?(address, nft_metadata)
+      !fetch_nft_for_owner(address, nft_metadata).nil?
+    end
 
-        ownership_data["owner"]["address"].casecmp(owner_address).zero? && ownership_data["quantity"].to_i.positive?
+    # Verify that the NFT is part of the referenced collection
+    # @param collection_metadata - hash containing :slug for OpenSea collection
+    # @param nft_metadata - hash containing :contract_address and :token_id values
+    def in_collection?(collection_metadata, nft_metadata)
+      nft = fetch_nft(nft_metadata)
+      return false if nft.nil?
+
+      collection_metadata.each_key do |key|
+        return false unless nft["collection"][key.to_s].casecmp(collection_metadata[key]).zero?
       end
+      true
+    end
+
+    # [Deprecated] Verify that the NFT is owned by the given address
+    # @param nft_metadata - hash containing :contract_address and :token_id values
+    # @param owner_address - address of presumed NFT owner
+    def verify_owner(nft_metadata, owner_address)
+      owner?(owner_address, nft_metadata)
     end
 
     # List all NFTs in the collection owned by the given address
@@ -36,16 +51,35 @@ module NftChecker
 
     private
 
+    def fetch_nft(nft_metadata)
+      contract, token = nft_metadata.slice(:contract_address, :token_id).values
+      rez = HTTParty.get(@url_base + "asset/#{contract}/#{token}/")
+      handle_response_codes(rez, not_found: nil) do
+        rez.parsed_response
+      end
+    end
+
+    def fetch_nft_for_owner(owner_address, nft_metadata)
+      contract, token = nft_metadata.slice(:contract_address, :token_id).values
+      rez = HTTParty.get(@url_base + "asset/#{contract}/#{token}/", query: { account_address: owner_address })
+      handle_response_codes(rez, not_found: nil) do
+        data = rez.parsed_response
+        data if data["ownership"] &&
+                data["ownership"]["owner"]["address"].casecmp(owner_address).zero? &&
+                data["ownership"]["quantity"].to_i.positive?
+      end
+    end
+
     def handle_response_codes(rez, not_found: nil)
       case rez.code
       when 429
         raise Throttled
-      when 400
+      when 404
         not_found
       when 200
         yield
       else
-        raise Error(rez.to_s)
+        raise Error, rez.to_s
       end
     end
   end

data/lib/nft_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NftChecker
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/nft_checker.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "nft_checker/version"
+require_relative "nft_checker/errors"
 require_relative "nft_checker/open_sea"
 
 ###
@@ -15,9 +16,6 @@ require_relative "nft_checker/open_sea"
 # * list_nfts(collection_metadata, owner_address): [<NFT ID>,...]
 #
 module NftChecker
-  class Error < StandardError; end
-  class Throttled < Error; end
-
   def self.init(source, options = {})
     case source.to_s
     when /\Aopen\w?sea(.io)?\z/i

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nft_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David J Parrott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2021-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -126,6 +126,7 @@ files:
 - bin/console
 - bin/setup
 - lib/nft_checker.rb
+- lib/nft_checker/errors.rb
 - lib/nft_checker/open_sea.rb
 - lib/nft_checker/version.rb
 - nft_checker.gemspec