artq 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77ed6ab0733f84e19ecd4e1329f8edeea8c083dc773b0dd756182996fc81355
-  data.tar.gz: dc91009707f3e4b70e5682a5c62cd310b8e20ffc47d730ecf3ce29fda65d4e17
+  metadata.gz: 173bf8cbe3bc0e9db811e19b585bd04bc23956b28b1b4cb055c1697288472d7e
+  data.tar.gz: 90c2751c1028ca2986e12825f83d8afbb9055ce864228f5a611a9110481f1439
 SHA512:
-  metadata.gz: de74d73e5080ce66ca49444e857478b20b9f2705eb918375302a38b0a04f0bb56eab98d0b211ced60263fb4415699efa244770a3b0dc7c336bf9046258d3c9e1
-  data.tar.gz: 6703ec538be7d9215b7b62a0b23d75297386e5065b2232982043a59d87346021073fae6f3f966fde77dd678b5ce267e80b7113086f7619afab1439d9660abb3b
+  metadata.gz: 339f0a49d30a544ce53892ec7f3c1a04a3ddb47d279ddc938d995ae8efc7c25356db9920a44f06d61a5d3482efe9975a965ba791ca6c6603cc427a6353914ab1
+  data.tar.gz: db571cdfcd4e29e3486199ac775a5494e1f4a42256d7d7449c8adbc3fdf7d4259356863dd3f440b60b94bcc30cf104c365c727965226eefe6a9e1ee849aa23da

data/README.md

@@ -184,7 +184,7 @@ and inline svg images in the base64 format get "cut" from the metadata and "past
 ```
 
 
-####  Bonus - Case No. 3 - "On-Blockchain" Layers (Incl. Metadata & Images)
+#### Case No. 3 - "On-Blockchain" Layers (Incl. Metadata & Images)
 
 
 Note:  Some "on-blockchain" pixel art collections
@@ -339,7 +339,43 @@ such as
 and many more.
 
 
-Tip: For more art collections with "on-blockchain" layers see the [**Art Factory Sandbox »**](https://github.com/pixelartexchange/artfactory.sandbox) 
+Tip: For more art collections with "on-blockchain" layers see the [**Art Factory Sandbox »**](https://github.com/pixelartexchange/artfactory.sandbox)
+
+
+
+
+
+###  Using the ArtQ Machinery in Your Own Scripts
+
+
+Yes, you can. Let's try the (crypto) marcs:
+
+
+``` ruby
+require 'artq'
+
+marcs_eth  = "0xe9b91d537c3aa5a3fa87275fbd2e4feaaed69bd0"
+
+marcs = ArtQ::Contract.new( marcs_eth )
+
+n = 0
+m = 0
+res = marcs.traitData( n, m )    ## note: return binary blob (for n,m-index)
+pp res
+#=> ["\x89PNG..."]
+
+res = marcs.traitDetails( n, m )  ## note: returns tuple (name, mimetype, hide?)
+pp res
+#=> ["Zombie", "image/png", false]
+
+
+
+## or with convenience download_layers helper
+ArtQ.download_layers( marcs_eth, outdir: './marcs' )
+```
+
+
+
 
 
 

data/lib/artq/layers.rb

@@ -58,7 +58,7 @@ module ArtQ
        buf << "\n"
     end
 
-    write_text( "#{outdir}/layers.csv", buf )
+    write_text( "#{outdir}/cache/layers.csv", buf )
 
     #####
     #  try to download all images
@@ -71,13 +71,17 @@ module ArtQ
       basename = "#{n}_#{m}"
       if data.start_with?( PNGSIG )
         puts "BINGO!! it's a png blob - #{data.size} byte(s)"
-        write_blob( "#{outdir}/#{basename}.png", data )
+        write_blob( "#{outdir}/cache/#{basename}.png", data )
       elsif data.start_with?( GIF87SIG ) || data.start_with?( GIF89SIG )
         puts "BINGO!! it's a gif blob - #{data.size} byte(s)"
-        write_blob( "#{outdir}/#{basename}.gif", data )
+        write_blob( "#{outdir}/cache/#{basename}.gif", data )
       elsif data.start_with?( JPGSIG )
         puts "BINGO!! it's a jpg blob - #{data.size} byte(s)"
-        write_blob( "#{outdir}/#{basename}.jpg", data )
+        write_blob( "#{outdir}/cache/#{basename}.jpg", data )
+      elsif data.index( /<svg[^>]*?>/i )    ## add more markers to find - why? why not?
+        puts "BINGO!! it's a svg (text) blob - #{data.size} byte(s)"
+        ## todo/check - save text as binary blob 1:1 - why? why not?
+        write_blob( "#{outdir}/cache/#{basename}.svg", data )
       else
         puts "!! ERROR - unknown image format; sorry"
         exit 1

data/lib/artq/version.rb

@@ -1,7 +1,7 @@
 
 
 module ArtQ
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end #  module ArtQ
 
 

data/lib/artq.rb

@@ -14,6 +14,17 @@ module ArtQ
 
 class Tool
 
+
+  def self.is_addr?( str )
+    ## e.g.
+    ##  must for now start with 0x (or 0X)
+    ##  and than 40 hexdigits (20 bytes)
+    ##  e.g. 0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1
+    str.match( /\A0x[0-9a-f]{40}\z/i )
+  end
+
+
+
   def self.main( args=ARGV )
     puts "==> welcome to artq tool with args:"
     pp args
@@ -47,16 +58,38 @@ class Tool
       exit
     end
 
-    contract_address = args[0]   ## todo/check - use collection_name/slug or such?
+
+    ## todo/check - use collection_name/slug or such?
+    contract_address = nil
+    outdir           = nil
+
+    if is_addr?( args[0] ) ## do nothing; it's an address
+       contract_address = args[0]
+       outdir           = "./tmp/#{contract_address}"
+    else  ## try reading  collection.yml config
+      config_path = "./#{args[0]}/collection.yml"
+      if File.exist?( config_path )
+         config = read_yaml( config_path )
+         contract_address = config['token']['contract']
+         outdir           = "./#{args[0]}"
+      else
+        puts "!! ERROR - no config found for collection >#{contract_address}<; sorry"
+        exit 1
+      end
+    end
+
+
     command          = args[1] || 'info'
 
 
     if ['i','inf','info'].include?( command )
         do_info( contract_address )
     elsif ['l', 'layer', 'layers'].include?( command )
-        do_layers( contract_address )
+        ## note: outdir - save into cache for now
+        do_layers( contract_address, outdir: outdir )
     elsif ['t', 'token', 'tokens'].include?( command )
-        do_tokens( contract_address )
+        ## note: outdir - saves into token (metadata) & token-i (images)
+        do_tokens( contract_address, outdir: outdir )
     else
       puts "!! ERROR - unknown command >#{command}<, sorry"
     end
@@ -105,17 +138,17 @@ class Tool
 
 
 
-  def self.do_layers( contract_address )
+  def self.do_layers( contract_address, outdir: )
     puts "==> query layers for art collection contract @ >#{contract_address}<:"
 
     ArtQ.download_layers( contract_address,
-                          outdir: "./tmp/#{contract_address}" )
+                          outdir: outdir )
   end
 
-  def self.do_tokens( contract_address )
+  def self.do_tokens( contract_address, outdir: )
     puts "==> query inline 'on-blockchain' token metadata & images for art collection contract @ >#{contract_address}<:"
     ArtQ.download_tokens( contract_address,
-                          outdir: "./tmp/#{contract_address}" )
+                          outdir: outdir )
   end
 
 end  # class Tool

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethlite