artbase 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa2c17e20eba3ef7a381f5643f4f2fde0d7bed07bf1ea613fe4da8a324f5c500
-  data.tar.gz: 7f124deeb894095131e7e472286deebc0703fd2ffbfa9bb1167e58a59745c4c5
+  metadata.gz: 1d2702ba1ca72c303474ee868074e5fc244d1a510d240cb7b533813b85f07bdd
+  data.tar.gz: 46591b009738fc8c45bd777b56b74dab8195f2fee6f967efa3a05b1c5efbe92b
 SHA512:
-  metadata.gz: 74533360be3826d67c3b3b286fdeaabbe5623df8efa4dba377a3b2d6cadf8299c858202274ac4be69be581b722ee2c81e6edd5d3193b1dd80dbe5d98264e01f1
-  data.tar.gz: b80f2676cf847d875ac321a9ee6ffb30357fe306c88173d08bc9cddbe0928e2c722a66fe5b8b9786dede41f3b12647ff99db5b4da2138ac937d7f332f6ebe53c
+  metadata.gz: 7a1a11ce316e7de3ec11b001262eb614b34cb0b53f9237357c60026fabddafd8b38839ba1ab77221f5062044aced9df44d082fe7146e68dc9dca4ee40dc5d1d0
+  data.tar.gz: 12dacbd59d727be09dbb626156a79e54dbc10a52ed13ed9b3963ee731dffcad45c08d23b812494780ff86bba51ea34fb3205258663759835ce94384229229b76

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-### 0.0.1 / 2018-10-18
-
-* Everything is new. First release
+### 0.0.1 / 2018-10-18
+
+* Everything is new. First release

data/Manifest.txt

@@ -1,5 +1,4 @@
 CHANGELOG.md
-LICENSE.md
 Manifest.txt
 README.md
 Rakefile
@@ -7,15 +6,13 @@ bin/artbase
 lib/artbase.rb
 lib/artbase/attributes.rb
 lib/artbase/collection.rb
+lib/artbase/collection/base.rb
 lib/artbase/collection/image.rb
 lib/artbase/collection/opensea.rb
 lib/artbase/collection/token.rb
 lib/artbase/helper.rb
 lib/artbase/image.rb
-lib/artbase/image/24x24.rb
-lib/artbase/image/32x32.rb
-lib/artbase/image/60x60.rb
-lib/artbase/image/80x80.rb
-lib/artbase/opensea.rb
+lib/artbase/image/sample.rb
+lib/artbase/retry.rb
 lib/artbase/tool.rb
 lib/artbase/version.rb

data/README.md

@@ -1,39 +1,274 @@
-# artbase ("right-clicker") command line tool & scripts - download complete pixel art collections - yes, you can! - automate "right-click 'n' download" and much more
-
-* home  :: [github.com/pixelartexchange/artbase](https://github.com/pixelartexchange/artbase)
-* bugs  :: [github.com/pixelartexchange/artbase/issues](https://github.com/pixelartexchange/artbase/issues)
-* gem   :: [rubygems.org/gems/artbase](https://rubygems.org/gems/artbase)
-* rdoc  :: [rubydoc.info/gems/artbase](http://rubydoc.info/gems/artbase)
-
-
-
-## Usage
-
-
-Note:  The artbase is alpha - it's still the early days - it's a work-in-progress.
-
-
-
-
-
-
-
-
-
-
-## Install
-
-Just install the gem:
-
-    $ gem install artbase
-
-
-## License
-
-The `artbase` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
-
-
-## Questions? Comments?
-
-Post them on the [CryptoPunksDev reddit](https://old.reddit.com/r/CryptoPunksDev). Thanks.
+# artbase ("right-clicker") command line tool & scripts - download complete pixel art collections - yes, you can! - automate "right-click 'n' download" and much more
+
+* home  :: [github.com/pixelartexchange/artbase](https://github.com/pixelartexchange/artbase)
+* bugs  :: [github.com/pixelartexchange/artbase/issues](https://github.com/pixelartexchange/artbase/issues)
+* gem   :: [rubygems.org/gems/artbase](https://rubygems.org/gems/artbase)
+* rdoc  :: [rubydoc.info/gems/artbase](http://rubydoc.info/gems/artbase)
+
+
+
+## Usage
+
+
+Note:  The artbase is alpha - it's still the early days - it's a work-in-progress.
+
+
+
+
+Let's try the 100 Blocky Doge (60x60) collection.
+
+
+### Step 0  - Collection Configuration Script
+
+Create a directory with the collection slug (e.g. `blockydoge`)
+matching the OpenSea collection slug
+and add a config script - `blockydoge/config.rb`:
+
+``` ruby
+COLLECTION = Collection.new( 
+
+'blockydoge',          # opensea collection slug
+100,                   # number of items
+
+format: '60x60',       # original pixel format
+source: '512x512',     # "big" source pixel format for 
+                       #   downloaded image referenced in meta data  
+
+#####
+#   "automagically" get the id from the meta data name field 
+#     via a "one-off / custom / hand-written" regex
+#   e.g. Blocky Doge #1  => 1
+meta_slugify: /^Blocky Doge #(?<num>[0-9]+)$/,
+)
+```
+
+Sorry for the "magic" config format for now  -
+see the [**opensea.sandbox**](https://github.com/pixelartexchange/opensea.sandbox) for many more "real-world" examples.
+
+
+
+
+
+That's it now you can:
+
+- Download all meta data files via the OpenSea API
+- Download all referenced images in the meta data file
+- Pixelate all downloaded images from the source format (e.g. 512x512) to the original format (e.g. 60x60)
+- Generate an all-in-one composite with the pixelated images
+- Export all meta data attributes / traits to an all-in-one datafile in the comma-separated-values (.csv) format
+
+
+### Download all meta data files via the OpenSea API
+
+Let's try:
+
+```
+$ artbase blockydoge meta
+```
+
+Note: All meta data files get stored by convention in `blockydoge/meta`.
+Resulting in a file tree like:
+
+```
+blockydoge/meta/
+  0.json
+  1.json
+  2.json
+  3.json
+  4.json
+  5.json
+  6.json
+  7.json
+  8.json
+  9.json
+  10.json
+  11.json
+  12.json
+  ...
+```
+
+Example - `blockydoge/meta/0.json`:
+
+``` json
+{
+  "id":                  52224520,
+  "token_id":            "154226446513437...7290852067901441",
+  "num_sales":           1,
+  "image_url":           "https://lh3.googleusercontent.com/fIQQ0A7...gTlbgMTQ",
+  "image_preview_url":   "https://lh3.googleusercontent.com/fIQQ0A7...gTlbgMTQ=s250",
+  "image_thumbnail_url": "https://lh3.googleusercontent.com/fIQQ0A7...gTlbgMTQ=s128",
+  "image_original_url":  null,
+  "name":                "Blocky Doge #1",
+  "description":         "Blocky Doge ... 100 unique pixelated Doge avatars...",
+  "external_link":       null,
+
+  ...
+
+   "traits": [
+       { "trait_type": "Fur",        "value": "Red Fur",        ... },
+       { "trait_type": "Hat",        "value": "Pink Party Hat", ... },
+       { "trait_type": "Expression", "value": "Smiley",         ... },
+  ],
+
+  ...
+}
+```
+
+
+
+### Download all referenced images in the meta data file
+
+Let's try:
+
+```
+$ artbase blockydoge img
+```
+
+Note: All referenced images (in the source format e.g. 512x512)
+get stored by convention in `blockydoge/i`.
+Resulting in a file tree like:
+
+```
+blockydoge/i/
+  0.png
+  1.png
+  2.png
+  3.png
+  4.png
+  5.png
+  6.png
+  7.png
+  8.png
+  9.png
+  10.png
+  11.png
+  12.png
+  ...
+```
+
+Example - `blockydoge/i/0.png` (512x512):
+
+![](i/blockydoge0-512x512.png)
+
+
+
+
+
+### Pixelate all downloaded images from the source format (e.g. 512x512) to the original format (e.g. 60x60)
+
+Let's try:
+
+```
+$ artbase blockydoge px
+```
+
+Note: All referenced images pixelated down to the orginal format (e.g. 60x60)
+get stored by convention in `blockydoge/ii`.
+Resulting in a tree like:
+
+```
+blockydoge/ii/
+  000001.png
+  000002.png
+  000003.png
+  000004.png
+  000005.png
+  000006.png
+  000007.png
+  000008.png
+  000009.png
+  000010.png
+  000011.png
+  000012.png
+  000013.png
+  ...
+```
+
+
+Example - `blockydoge/ii/000001.png` to `000013.png` (60x60):
+
+![](i/blockydoge000001.png)
+![](i/blockydoge000002.png)
+![](i/blockydoge000003.png)
+![](i/blockydoge000004.png)
+![](i/blockydoge000005.png)
+![](i/blockydoge000006.png)
+![](i/blockydoge000007.png)
+![](i/blockydoge000008.png)
+![](i/blockydoge000009.png)
+![](i/blockydoge000010.png)
+![](i/blockydoge000011.png)
+![](i/blockydoge000012.png)
+![](i/blockydoge000013.png)
+
+
+
+
+### Generate an all-in-one composite with the pixelated images
+
+Let's try:
+
+```
+$ artbase blockydoge composite
+```
+
+Note: The all-in-one composite image gets saved by convention to `blockydoge/tmp/blockydoge-60x60.png`.  Example:
+
+![](i/blockydoge-60x60.png)
+
+
+
+### Export all meta data attributes / traits to an all-in-one datafile in the comma-separated-values (.csv) format
+
+
+Let's try:
+
+```
+$ artbase blockydoge export
+```
+
+Note: The all-in-one datafile gets saved by convention to `blockydoge/tmp/blockydoge.csv`.
+Example:
+
+
+```
+ID, Name, Fur, Hat, Expression, Glasses, Accessories, Mask, Collar
+0, Blocky Doge #1, Red Fur, Pink Party Hat, Smiley, , , ,
+1, Blocky Doge #2, Black and Tan Fur, Orange Cap, Tongue Out, , , ,
+2, Blocky Doge #3, , , Cream Fur, Teal Glasses, , ,
+3, Blocky Doge #4, Meme Fur, , , Maroon Glasses, , ,
+4, Blocky Doge #5, Black and Tan Fur, Blue Party Hat, , , , ,
+5, Blocky Doge #6, Red Fur, Pink Cap, , , , ,
+6, Blocky Doge #7, Red Fur, , , , None, ,
+7, Blocky Doge #8, Meme Fur, White Cap, , , , ,
+8, Blocky Doge #9, Cream Fur, , , Sunglasses, , ,
+9, Blocky Doge #10, Meme Fur, , , , , Lavender Mask,
+10, Blocky Doge #11, Black and Tan Fur, , , Black Glasses, , ,
+11, Blocky Doge #12, Black and Tan Fur, , , , , Salmon Mask,
+12, Blocky Doge #13, Cream Fur, Green Party Hat, , , , ,
+...
+```
+
+
+
+
+That's it for now.
+
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install artbase
+
+
+## License
+
+The `artbase` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Post them on the [CryptoPunksDev reddit](https://old.reddit.com/r/CryptoPunksDev). Thanks.

data/Rakefile

@@ -1,29 +1,38 @@
-require 'hoe'
-require './lib/artbase/version.rb'
-
-Hoe.spec 'artbase' do
-
-  self.version = Artbase::VERSION
-
-  self.summary = "artbase"
-  self.description = summary
-
-  self.urls    = { home: 'https://github.com/pixelartexchange/artbase'}
-
-  self.author  = 'Gerald Bauer'
-  self.email   = 'wwwmake@googlegroups.com'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.md'
-  self.history_file = 'CHANGELOG.md'
-
-  self.extra_deps = [
-  ]
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-    required_ruby_version: '>= 2.2.2'
-  }
-
-end
+require 'hoe'
+require './lib/artbase/version.rb'
+
+
+###
+# hack/ quick fix for broken intuit_values - overwrite with dummy
+class Hoe
+  def intuit_values( input ); end
+end
+
+
+Hoe.spec 'artbase' do
+
+  self.version = Artbase::VERSION
+
+  self.summary = "artbase"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/pixelartexchange/artbase'}
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['webclient', '>= 0.2.2'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/bin/artbase

@@ -1,17 +1,17 @@
-#!/usr/bin/env ruby
-
-###################
-# == DEV TIPS:
-#
-# For local testing run like:
-#
-#    ruby -Ilib bin/artbase
-#
-# Set the executable bit in Linux. Example:
-#
-#    % chmod a+x bin/artbase
-#
-
-require 'artbase'
-
-Artbase::Tool.main
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/artbase
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/artbase
+#
+
+require 'artbase'
+
+Artbase::Tool.main

data/lib/artbase/attributes.rb

@@ -1,83 +1,83 @@
-
-
-def counter_to_text( counter )
-
-  counter = counter.to_a
-
-  attribute_counter = counter[0]
-  more_counter      = counter[1..-1]
-
-
-  puts "Attribute Counts\n"
-  trait_type, h = attribute_counter
-
-  total = h[:by_type].values.reduce(0) { |sum,count| sum+count }
-
-
-  types = h[:by_type]
-  types = types.sort { |l,r| l[0]<=>r[0] }  ## sort by name
-
-  puts "\n"
-  puts "|Name|Total (%)|"
-  puts "|--------|----------:|"
-
-  types.each do |rec|
-      name     = rec[0]
-      count    = rec[1]
-      percent =  Float(count*100)/Float(total)
-
-      puts "| **#{name} Attributes** | #{count} (#{'%.2f' % percent}) |"
-  end
-  puts "\n"
-
-  more_counter.each_with_index do |(trait_type, h),i|
-    print " · "  if i > 0   ## add separator
-    print "#{trait_type } (#{h[:by_type].size})"
-  end
-  puts "\n\n"
-
-
-
-  more_counter.each do |trait_type, h|
-    print "### #{trait_type } (#{h[:by_type].size}) - "
-    print "∑Total #{h[:count]}/#{total}\n"
-
-    puts "\n"
-    puts "|Name|Total (%)|"
-    puts "|--------|----------:|"
-
-      types = h[:by_type]
-      types = types.sort do |l,r|
-                            # sort by 1) by count
-                            #         2) by name a-z
-                                  res = r[1] <=> l[1]
-                                  res = l[0] <=> r[0]  if res == 0
-                                  res
-                         end  ## sort by count
-      types.each do |rec|
-         name     = rec[0]
-         count    = rec[1]
-         percent =  Float(count*100)/Float(total)
-
-         puts "| **#{name}** | #{count} (#{'%.2f' % percent}) |"
-      end
-      puts "\n\n"
-    end
-end
-
-
-
-
-def counter_to_csv( counter )
-
-  puts "type, name, count"
-  counter.each do |trait_type, h|
-    puts "#{trait_type}, ∑ Total, #{h[:count]}"
-    h[:by_type].each do |trait_value, count|
-       puts "#{trait_type}, #{trait_value}, #{count}"
-    end
-  end
-end
-
-
-
+
+
+def counter_to_text( counter )
+
+  counter = counter.to_a
+
+  attribute_counter = counter[0]
+  more_counter      = counter[1..-1]
+
+
+  puts "Attribute Counts\n"
+  trait_type, h = attribute_counter
+
+  total = h[:by_type].values.reduce(0) { |sum,count| sum+count }
+
+
+  types = h[:by_type]
+  types = types.sort { |l,r| l[0]<=>r[0] }  ## sort by name
+
+  puts "\n"
+  puts "|Name|Total (%)|"
+  puts "|--------|----------:|"
+
+  types.each do |rec|
+      name     = rec[0]
+      count    = rec[1]
+      percent =  Float(count*100)/Float(total)
+
+      puts "| **#{name} Attributes** | #{count} (#{'%.2f' % percent}) |"
+  end
+  puts "\n"
+
+  more_counter.each_with_index do |(trait_type, h),i|
+    print " · "  if i > 0   ## add separator
+    print "#{trait_type } (#{h[:by_type].size})"
+  end
+  puts "\n\n"
+
+
+
+  more_counter.each do |trait_type, h|
+    print "### #{trait_type } (#{h[:by_type].size}) - "
+    print "∑Total #{h[:count]}/#{total}\n"
+
+    puts "\n"
+    puts "|Name|Total (%)|"
+    puts "|--------|----------:|"
+
+      types = h[:by_type]
+      types = types.sort do |l,r|
+                            # sort by 1) by count
+                            #         2) by name a-z
+                                  res = r[1] <=> l[1]
+                                  res = l[0] <=> r[0]  if res == 0
+                                  res
+                         end  ## sort by count
+      types.each do |rec|
+         name     = rec[0]
+         count    = rec[1]
+         percent =  Float(count*100)/Float(total)
+
+         puts "| **#{name}** | #{count} (#{'%.2f' % percent}) |"
+      end
+      puts "\n\n"
+    end
+end
+
+
+
+
+def counter_to_csv( counter )
+
+  puts "type, name, count"
+  counter.each do |trait_type, h|
+    puts "#{trait_type}, ∑ Total, #{h[:count]}"
+    h[:by_type].each do |trait_value, count|
+       puts "#{trait_type}, #{trait_value}, #{count}"
+    end
+  end
+end
+
+
+