ordlite 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349d70aaa528cdced0835181ca83ad5bb8815982bc60bc7f9d5535095131b322
-  data.tar.gz: 505f8f222ea148ca87f84080696cc0ec8d369a1a285aa50270ce8db6632ace96
+  metadata.gz: 6051393488775c98fdee4716e6c49b5cd89c6cd404a45f48024a47dea633acfb
+  data.tar.gz: d43e1d73f1b49b27ae35e745eaa8e13be394635d2367233bc6c341fd1aa54933
 SHA512:
-  metadata.gz: 4a1ecae2ec91d531ae6ff660dea7861243569f7c2009cbf48315e88a406ddbc0b9cdf91a8b29291b8e64e2f99d5051188662356a3bbf70efd394d4f7e7f13cfa
-  data.tar.gz: 50cc3f57b2cade5086a12a9c459469a991a667fe9b30431f2b2f6c957c1462430a41bbd6e2e50b635631668d4f6f3ef70aa54a6f6ec7a9d812a17c920b1031f2
+  metadata.gz: 05e95871ce3a85dd31557e38a4247d5cd38e25406e2ac535a1254e6952e68b8054e8c1a06378b4620ce8168c67d1e4cb7eac50305da9e7e59e2f10152a4aa971
+  data.tar.gz: 3fe7780c583d525dd60170f4ec0e996f430722d53899e3edb321d9af67425024c262a253e1cf718ab0b7316f9fbb3ae0a6903b3a82debf3860511a167872a1ab

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 0.1.1 / 2023-07-01
+### 0.2.0 / 2023-07-28
 ### 0.0.1 / 2023-07-01
 
 * Everything is new. First release

data/Manifest.txt

@@ -5,8 +5,12 @@ Rakefile
 lib/ordlite.rb
 lib/ordlite/base.rb
 lib/ordlite/cache.rb
+lib/ordlite/importer.rb
 lib/ordlite/models/blob.rb
+lib/ordlite/models/collection.rb
+lib/ordlite/models/factory.rb
 lib/ordlite/models/forward.rb
+lib/ordlite/models/generative.rb
 lib/ordlite/models/inscribe.rb
 lib/ordlite/schema.rb
 lib/ordlite/version.rb

data/README.md

@@ -4,21 +4,170 @@
 ordlite - ordinals inscription (on bitcoin & co) database let's you query via sql and more
 
 
-* home  :: [github.com/ordbase/generative-orc-721](https://github.com/ordbase/generative-orc-721)
-* bugs  :: [github.com/ordbase/generative-orc-721/issues](https://github.com/ordbase/generative-orc-721/issues)
+* home  :: [github.com/ordbase/ordbase](https://github.com/ordbase/ordbase)
+* bugs  :: [github.com/ordbase/ordbase/issues](https://github.com/ordbase/ordbase/issues)
 * gem   :: [rubygems.org/gems/ordlite](https://rubygems.org/gems/ordlite)
 * rdoc  :: [rubydoc.info/gems/ordlite](http://rubydoc.info/gems/ordlite)
 
 
 
+##  SQL Database Model
+
+Inscribes •  Blobs • Collections • Generatives
+
+
+Table Inscribes
+
+``` sql
+CREATE TABLE "inscribes" (
+    "id" varchar NOT NULL PRIMARY KEY, 
+    "num" integer NOT NULL,
+    "bytes" integer NOT NULL,
+    "content_type" varchar NOT NULL,
+    "date" datetime(6) NOT NULL,
+    "sat" integer NOT NULL,
+    "block" integer NOT NULL,
+    "fee" integer NOT NULL,
+    "tx" varchar NOT NULL,
+    "offset" integer NOT NULL,
+    "address" varchar NOT NULL,
+    "output" varchar NOT NULL,
+    "value" integer NOT NULL,
+)
+```
+
+Table Blobs
+
+``` sql
+CREATE TABLE "blobs" (
+    "id" varchar NOT NULL PRIMARY KEY, 
+    "content" blob NOT NULL, 
+)
+```
+
+
 ##  Usage
 
-To be done
+
+### Step 0:  Setup Databae
+
+``` ruby
+require 'ordlite'
+
+OrdDb.connect( adapter:  'sqlite3',
+               database: './ord.db' )
+
+OrdDb.create_all     # build table schema
+
+puts
+puts "  #{Inscribe.count} inscribe(s)"
+puts "  #{Blob.count} blob(s)"
+puts "  #{Collection.count} collection(s)"
+puts "  #{Generative.count} generative(s)"
+
+#=>  0 inscribe(s)
+#=>  0 blob(s)
+#=>  0 collection(s)
+#=>  0 generative(s)
+```
+
+
+
+
+### Example No 1 - Query Ordgen Deploy / Mint Inscriptions
+
+``` ruby
+require 'ordlite'
+
+
+OrdDb.connect( adapter:  'sqlite3',
+               database: './ord.db' )
+
+
+####################
+## query for deploy candidates
+##
+##  e.g. sql where clause like
+##     content LIKE '%deploy%' 
+##       AND (   content LIKE '%orc-721%' 
+##            OR content LIKE '%og%')
+## 
+
+deploys = Inscribe.deploys
+puts "   #{deploys.size} deploy candidate(s)"
+
+deploys.each_with_index do |rec,i|
+    puts "==> deploy #{i} - num #{rec.num} - #{rec.bytes} bytes - #{rec.date}"
+    puts rec.content 
+end
 
 
+punks_deploys = Inscribe.deploys_by( slug: 'diypunks')
+puts "   #{punks_deploys.size} deploy candidate(s)"
 
 
 
+#######################
+## query for mint candidates
+##
+##  e.g. sql where clause like
+##     content LIKE '%mint%' 
+##       AND (   content LIKE '%orc-721%' 
+##            OR content LIKE '%og%')
+
+mints = Inscribe.mints
+puts "   #{mints.size} mint candidate(s)"
+
+## print last hundred mint candidates
+mints[-100,100].each_with_index do |rec,i|
+    puts "==> mint #{i} - num #{rec.num} - #{rec.bytes} bytes - #{rec.date}"
+    puts rec.content 
+end
+
+
+phunks_mints = Inscribe.mints_by( slug: 'diyphunks')
+puts "   #{phunks_mints.size} mint candidate(s)"
+
+
+puts "   #{deploys.size} deploy candidate(s)"
+puts "   #{mints.size} mint candidate(s)"
+
+#=> 123 deploy candidate(s)
+#=> 7453 mint candidate(s)
+```
+
+
+
+
+### Bonus:  Import (Cached) Inscription Meta Datafiles (& Content Blobs)
+
+Let's import all cached 
+inscriptions metadata datafiles (& content blobs)
+from  [/ordinals.cache](https://github.com/ordbase/ordinals.cache)
+into an (sql) database e.g. `ord.db`: 
+
+
+``` ruby
+require 'ordlite'
+
+OrdDb.connect( adapter:  'sqlite3',
+               database: './ord.db' )
+
+OrdDb.create_all     # build table schema
+
+cache_dir = './ordinals.cache/inscription'
+cache =  OrdDb::Cache.new( cache_dir )
+cache.import_all
+
+
+puts
+puts "  #{Inscribe.count} inscribe(s)"
+puts "  #{Blob.count} blob(s)"
+
+#=>  8505 inscribe(s)
+#=>  7611 blob(s)
+```
+
 
 ## License
 
@@ -26,9 +175,12 @@ The scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
 
 
+## Questions? Comments?
+
+Join us in the [Ordgen / ORC-721 discord (chat server)](https://discord.gg/dDhvHKjm2t). Yes you can.
+Your questions and commetary welcome.
+
+
+Or post them over at the [Help & Support](https://github.com/geraldb/help) page. Thanks.
 
-Please post in the #generative-orc-721 channel
-in the ordinal punks discord.
-For an invite
-see <https://twitter.com/OrdinalPunks/status/1620230583711576068>.
 

data/Rakefile

@@ -9,7 +9,7 @@ Hoe.spec 'ordlite' do
   self.summary = "ordlite - ordinals inscription (on bitcoin & co) database let's you query via sql and more"
   self.description = summary
 
-  self.urls    = { home: 'https://github.com/ordbase/generative-orc-721' }
+  self.urls    = { home: 'https://github.com/ordbase/ordbase' }
 
   self.author  = 'Gerald Bauer'
   self.email   = 'gerald.bauer@gmail.com'
@@ -19,6 +19,7 @@ Hoe.spec 'ordlite' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
+    ['ordinals'],
     ['activerecord'],
     ['activerecord-utils'],
     ['logutils'],

data/lib/ordlite/base.rb

@@ -1,10 +1,6 @@
 # core and stlibs
+require 'ordinals'  ## will pull-in cocos & friends
 
-require 'pp'
-require 'fileutils'
-require 'uri'
-require 'json'
-require 'yaml'
 
 require 'logger'    # Note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
 
@@ -31,6 +27,9 @@ require_relative 'models/forward'
 
 require_relative 'models/inscribe'
 require_relative 'models/blob'
+require_relative 'models/collection'
+require_relative 'models/factory'
+require_relative 'models/generative'
 
 
 require_relative 'schema'      
@@ -38,6 +37,10 @@ require_relative 'schema'
 require_relative 'cache'
 
 
+require_relative 'importer'  ## note: require (soft dep) ordinals gems!!!
+
+
+
 
 module OrdDb
 
@@ -53,6 +56,35 @@ module OrdDb
     OrdDb.create
   end
 
+  def self.auto_migrate!
+    ### todo/fix:
+    ##    check props table and versions!!!!!
+
+    # first time? - auto-run db migratation, that is, create db tables
+    unless LogDb::Model::Log.table_exists?
+      LogDb.create     # add logs table
+    end
+
+    unless ConfDb::Model::Prop.table_exists?
+      ConfDb.create    # add props table
+    end
+
+    unless OrdDb::Model::Inscribe.table_exists?
+      OrdDb.create
+    end
+  end # method auto_migrate!
+
+
+  def self.open( database='./ord.db' )   ## convenience helper for sqlite only
+      connect( adapter:  'sqlite3',
+               database: database )
+
+      ## build schema if database new/empty
+      auto_migrate!
+  end
+
+
+
   def self.connect( config={} )
 
     if config.empty?

data/lib/ordlite/cache.rb

@@ -1,123 +1,64 @@
+###
+## add (database) import machinery to cache
 
-module OrdDb
-
-
-class  Cache   
-
-   Inscribe = Model::Inscribe
-   Blob     = Model::Blob
-
-def initialize( dir='.' )
-    @dir = dir
-end
-
-
-
-def import_all   
-   paths = Dir.glob( "#{@dir}/**.json" )
-   puts "  #{paths.size} inscribe datafile(s) found"
+module Ordinals
+class Cache
+   Inscribe = OrdDb::Model::Inscribe
+   Blob     = OrdDb::Model::Blob
 
+def import_all  
+   paths = _find_meta
+   puts "  #{paths.size} inscribe metaddatafile(s) found"
    paths.each_with_index do |path, i|
-     puts "==> inscribe #{i+1}/#{paths.size}..."
+     ## puts "==> inscribe #{i+1}/#{paths.size}..."
      data = _read_inscribe( path )
-     
-     Inscribe.create( _parse_inscribe( data ))
+     id = data['id']
+
+     ## skip if exists (use update later - why? why not?)
+     rec = Inscribe.find_by( id: id )
+     if rec 
+      ## skip - already in db
+        print '.'
+     else
+        print " #{id}"  #  NEW - add / insert into db"
+        rec = Inscribe.create_from_cache( data )
+     end
    end
+   puts
 
 
-   paths = Dir.glob( "#{@dir}/content/**.txt" )
-   puts "  #{paths.size} content datafile(s) found"
-
+   paths = _find_blobs
+   puts "  #{paths.size} inscribe blob(s) found"
    paths.each_with_index do |path, i|
-      puts "==> blob #{i+1}/#{paths.size}..."
-      content = _read_blob( path )
-      id      = File.basename( path, File.extname( path ))
-      
-      Blob.create( id: id,
-                   content: content )
+     ## puts "==> blob #{i+1}/#{paths.size}..."
+     content = read_blob( path )
+     id      = File.basename( File.dirname(path)) + 
+               File.basename( path, File.extname( path ))
+ 
+      rec = Blob.find_by( id: id )
+      if rec
+        ## skip - already in db
+        print '.'
+      else
+         print " #{id}"   # NEW - add / insert into db"
+         rec = Blob.create( id: id,
+                           content: content )
+      end
     end
+    puts
 end
 
-
 def import( id )
-   data = read( id )  
-   rec = Inscribe.create( _parse_inscribe( data ))
-   rec
-end
-
-def read( id )
-   _read_inscribe( "#{@dir}/#{id}.json" ) 
-end
-
-def _read_inscribe( path )
-   JSON.parse( _read_text( path )) 
-end
-
-def _read_blob( path )
-   blob = File.open( path, 'rb' ) { |f| f.read } 
-   ## auto force to ASCII-7BIT if not already - why? why not?
-   blob
-end
-
-
-def _read_text( path )
-   File.open( path, 'r:utf-8' ){ |f| f.read } 
-end
-
-def _parse_inscribe( data )
-   ## num via title
-   attributes = {
-    id:  data['id'],
-    num: _title_to_num( data['title'] ),
-    bytes: _content_length_to_bytes( data['content length'] ), 
-    sat:  data['sat'].to_i(10),
-    content_type:  data['content type'],
-    block: data['genesis height'].to_i(10),
-    fee: data['genesis fee'].to_i(10),
-    tx: data['genesis transaction'],
-    address: data['address'],
-    output: data['output'],
-    value: data['output value'].to_i(10),
-    offset: data['offset'].to_i(10),
-    # "2023-06-01 05:00:57 UTC"
-    date:  DateTime.strptime( data['timestamp'], 
-                              '%Y-%m-%d %H:%M:%S %z')
-  }
-
-  attributes
-end
-
-
-
-    ##  "title": "Inscription 9992615",
-TITLE_RX = /^Inscription (?<num>[0-9]+)$/i
-
-def _title_to_num( str )
-   if m=TITLE_RX.match( str )
-      m[:num].to_i(10)    ## use base 10
+   data = read( id )
+   rec = Inscribe.find_by( id: id )
+   if rec 
+      # skip - already in db
    else
-     puts "!! ERROR - no inscribe num found in title >#{str}<"
-     exit 1   ## not found - raise exception - why? why not?
+      rec = Inscribe.create_from_cache( data )
    end
 end
 
-CONTENT_LENGTH_RX = /^(?<num>[0-9]+) bytes$/i
-
-def _content_length_to_bytes( str )
-    if m=CONTENT_LENGTH_RX.match( str )
-       m[:num].to_i(10)    ## use base 10
-    else
-       puts "!! ERROR - bytes found in content lenght >#{str}<"
-       exit 1   ## not found - raise exception - why? why not?
-    end
-end
- 
-
-
-
-end # class Cache
-end # module OrdDb
-
-
 
+end  # class Cache
+end  # module Ordinals 
 

data/lib/ordlite/importer.rb

@@ -0,0 +1,99 @@
+
+
+module OrdDb
+
+def self.import_collection( path, content: true )
+   data = read_json( path )
+
+   meta =  data['collection']
+   pp meta
+
+   name = meta['name']
+
+   col = Model::Collection.find_by( name: name )
+   if col
+     puts "!! WARN - collection already in db; delete first to reimport"
+     return     
+   end
+   
+   col = Model::Collection.create(
+      name:  name,
+      desc:  meta['description'],
+      max:   meta['max_supply']
+   )
+
+   items = data['items']
+   puts "  #{items.size} inscribe id(s)"
+   items.each_with_index do |rec,i|
+      id   = rec['inscription_id']
+      name = rec['name']
+      puts "==> #{i+1}/#{items.size} @ #{id}..."
+ 
+      col.items.create( pos: i,
+                        inscribe_id: id,
+                        name: name )
+
+     ## check if inscription / inscribe is already in db?
+     inscribe = Model::Inscribe.find_by( id: id )
+     if inscribe  ## already in db; dump record
+       ## pp inscribe
+     else         ## fetch via ordinals.com api and update db
+        data = Ordinals.inscription( id )
+        pp data
+        Model::Inscribe.create_from_api( data )
+        sleep( 1 )   ## delay in seconds (before next request) 
+     end
+
+     if content
+       ## check if (content) blob is already in db?
+       blob = Model::Blob.find_by( id: id )
+       if blob    ## already in db; do nothing
+       else       ## fetch via ordinals.com api and update db
+          content = Ordinals.content( id )
+          puts "  content-type: #{content.type}"
+          puts "  content-length: #{content.length}"
+       
+          Model::Blob.create( id: id, content: content.data )
+          sleep( 1 )   ## delay in seconds (before next request) 
+       end
+     end              
+   end
+end
+
+
+def self.import_csv( path, content: true )
+    recs = read_csv( path )
+    puts "  #{recs.size} inscribe id(s)"
+    #=>  1000 inscribe id(s) 
+     
+    recs.each_with_index do |rec,i|
+      id = rec['id']
+      puts "==> #{i+1}/#{rec.size} @ #{id}..."
+    
+      ## check if inscription / inscribe is already in db?
+      inscribe = Model::Inscribe.find_by( id: id )
+      if inscribe  ## already in db; dump record
+        ## pp inscribe
+      else         ## fetch via ordinals.com api and update db
+         data = Ordinals.inscription( id )
+         pp data
+         Model::Inscribe.create_from_api( data )
+         sleep( 1 )   ## delay in seconds (before next request) 
+      end
+
+      if content
+        ## check if (content) blob is already in db?
+        blob = Model::Blob.find_by( id: id )
+        if blob    ## already in db; do nothing
+        else       ## fetch via ordinals.com api and update db
+           content = Ordinals.content( id )
+           puts "  content-type: #{content.type}"
+           puts "  content-length: #{content.length}"
+        
+           Model::Blob.create( id: id, content: content.data )
+           sleep( 1 )   ## delay in seconds (before next request) 
+        end
+      end
+    end  
+end # method self.import_csv
+end  # module OrdDb

data/lib/ordlite/models/blob.rb

@@ -4,6 +4,10 @@ module OrdDb
   
   class Blob < ActiveRecord::Base
     belongs_to :inscribe, foreign_key: 'id'
+
+    def text
+       content.force_encoding(Encoding::UTF_8)
+    end
   end  # class Blob
   
     end # module Model

data/lib/ordlite/models/collection.rb

@@ -0,0 +1,10 @@
+module OrdDb
+    module Model
+  
+  class Collection < ActiveRecord::Base    
+    has_many :items, -> { order('pos') }
+    has_many :inscribes, :through => :items                    
+  end  # class Collection
+  
+    end # module Model
+end # module OrdDb

data/lib/ordlite/models/factory.rb

@@ -0,0 +1,20 @@
+
+module OrdDb
+    module Model
+  
+  class Factory < ActiveRecord::Base
+    self.table_name = 'factories' ## non-standard plural (factory/factories)
+
+    belongs_to :inscribe
+    
+    has_many :inscriberefs, -> { order('pos') }  ## join table (use habtm - why? why not?)
+    has_many :layers, :through => :inscriberefs,  
+                      :source => :inscribe  
+
+    has_many :generatives
+    has_many :inscribes, :through => :generatives                    
+  end  # class Factory
+  
+    end # module Model
+end # module OrdDb
+  

data/lib/ordlite/models/forward.rb

@@ -12,12 +12,31 @@ Prop      = ConfDb::Model::Prop
 
 class Inscribe    < ActiveRecord::Base ; end
 class Blob        < ActiveRecord::Base ; end
-
-  end
+class Collection  < ActiveRecord::Base ; end
+class Item        < ActiveRecord::Base    ## change to CollectionItem - why? why not? 
+   belongs_to :collection
+   belongs_to :inscribe
+end  
+
+class Factory     < ActiveRecord::Base ; end
+class Generative  < ActiveRecord::Base ; end
+
+### join tables - add inline here - why? why not?
+##   rename to CollectionLayer? or
+##             CollectionInscribeRef? or
+##             Layerref? or
+##             InscribeRef?
+##             FactoryItem ????
+class Inscriberef < ActiveRecord::Base
+  belongs_to :factory
+  belongs_to :inscribe
+end
+
+  end # module Model
 
   # note: convenience alias for Model
   # lets you use include OrdDb::Models
   Models = Model   
-end # module # OrdDb
+end # module OrdDb
 
 

data/lib/ordlite/models/generative.rb

@@ -0,0 +1,12 @@
+
+module OrdDb
+    module Model
+  
+  class Generative < ActiveRecord::Base
+    belongs_to :inscribe, foreign_key: 'id'
+    belongs_to :factory
+  end  # class Generative
+  
+    end # module Model
+end # module OrdDb
+  

data/lib/ordlite/models/inscribe.rb

@@ -4,6 +4,271 @@ module OrdDb
   
   class Inscribe < ActiveRecord::Base
     has_one :blob, foreign_key: 'id'
+ 
+    has_one :factory     ## optional (auto-added via og/orc-721 deploy)
+    has_one :generative, foreign_key: 'id'   ## optional (auto-added via og/orc-721 deploy)
+
+    ## convernience helper
+    ##  forward to blob.content
+    ##    blob.content - encoding is BINARY (ASCII-7BIT)
+    ##    blob.text    - force_encoding is UTF-8 (return a copy)
+    def content() blob.content; end
+    def text() blob.text; end
+
+
+    ################################
+    ### scope like helpers
+    def self.deploys 
+      where_clause =<<SQL 
+content LIKE '%deploy%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+SQL
+
+       joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+    def self.deploys_by( slug: )
+             where_clause =<<SQL 
+content LIKE '%deploy%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+AND content LIKE '%#{slug}%'     
+SQL
+
+      joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+    def self.mints 
+      where_clause =<<SQL 
+content LIKE '%mint%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+SQL
+
+       joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+    def self.mints_by( slug: ) 
+      where_clause =<<SQL 
+content LIKE '%mint%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+AND content LIKE '%#{slug}%'     
+SQL
+
+       joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+   def self.sub1k()  where( 'num < 1000' ); end
+   def self.sub2k()  where( 'num < 2000' ); end
+   def self.sub10k()  where( 'num < 10000' ); end
+   def self.sub20k()  where( 'num < 20000' ); end
+   def self.sub100k()  where( 'num < 100000' ); end
+   def self.sub1m()  where( 'num < 1000000' ); end
+ 
+
+   def self.largest
+      order( 'bytes DESC' )
+   end
+
+   def self.block_counts
+      group( 'block' ).count
+   end 
+   
+   def self.block_with_timestamp_counts
+      group( Arel.sql( "block || ' @ ' || date" )).count
+   end
+
+   def self.content_type_counts
+      group( 'content_type' )
+       .order( Arel.sql( 'COUNT(*) DESC, content_type')).count
+   end
+
+
+   def self.date_counts
+       ## note: strftime is SQLite specific/only!!!
+       group( Arel.sql("strftime('%Y-%m-%d', date)"))
+        .order( Arel.sql("strftime('%Y-%m-%d', date)")).count
+   end
+
+   def self.month_counts
+      ## note: strftime is SQLite specific/only!!!
+      group( Arel.sql("strftime('%Y-%m', date)"))
+       .order( Arel.sql("strftime('%Y-%m', date)")).count
+   end
+
+   def self.hour_counts
+      ## note: strftime is SQLite specific/only!!!
+      group( Arel.sql("strftime('%Y-%m-%d %Hh', date)"))
+       .order( Arel.sql("strftime('%Y-%m-%d %Hh', date)")).count
+   end
+
+
+   class << self
+      alias_method :biggest, :largest
+      alias_method :counts_by_content_type, :content_type_counts
+      alias_method :counts_by_date,         :date_counts
+      alias_method :counts_by_day,          :date_counts
+      alias_method :counts_by_month,        :month_counts
+      alias_method :counts_by_hour,        :hour_counts
+      alias_method :counts_by_block,        :block_counts
+      alias_method :counts_by_block_with_timestamp,  :block_with_timestamp_counts
+   end
+
+
+   def self.text
+      ## note: for now include:
+      ##   - text/plain (all variants)
+      ##   - text/json (all variants)
+      ##   - text/markdown
+      where( content_type: 
+               ['text/plain',
+                'text/plain;charset=utf-8',
+                'text/markdown',
+                'application/json',
+               ]
+           )
+   end
+   def self.png() where( content_type: 'image/png' ); end
+
+###
+## add support for ordinals.com api txt (headers format) 
+
+
+   def self.create_from_api( data ) create( _parse_api( data )); end
+   class << self
+     alias_method :create_from_cache, :create_from_api   ## add alias - why? why not?
+   end
+
+   
+   def self._parse_api( data )   ## parse api json data
+    ## num via title
+    attributes = {
+     id:  data['id'],
+     num: _title_to_num( data['title'] ),
+     bytes: _content_length_to_bytes( data['content-length'] ), 
+     sat:  data['sat'].to_i(10),
+     content_type:  data['content-type'],
+     block: data['genesis-height'].to_i(10),
+     fee: data['genesis-fee'].to_i(10),
+     tx: data['genesis-transaction'],
+     address: data['address'],
+     output: data['output'],
+     value: data['output-value'].to_i(10),
+     offset: data['offset'].to_i(10),
+     # "2023-06-01 05:00:57 UTC"
+     date:  DateTime.strptime( data['timestamp'], 
+                               '%Y-%m-%d %H:%M:%S %z')
+   }
+ 
+   attributes
+ end
+ 
+ 
+     ##  "title": "Inscription 9992615",
+ TITLE_RX = /^Inscription (?<num>[0-9]+)$/i
+ 
+ def self._title_to_num( str )
+    if m=TITLE_RX.match( str )
+       m[:num].to_i(10)    ## use base 10
+    else
+      puts "!! ERROR - no inscribe num found in title >#{str}<"
+      exit 1   ## not found - raise exception - why? why not?
+    end
+ end
+ 
+ CONTENT_LENGTH_RX = /^(?<num>[0-9]+) bytes$/i
+ 
+ def self._content_length_to_bytes( str )
+     if m=CONTENT_LENGTH_RX.match( str )
+        m[:num].to_i(10)    ## use base 10
+     else
+        puts "!! ERROR - bytes found in content lenght >#{str}<"
+        exit 1   ## not found - raise exception - why? why not?
+     end
+ end
+  
+
+
+ ###
+ # instance methods
+def extname
+  ## map mime type to file extname
+  ## see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types
+  ##  for real-world usage, see https://dune.com/dgtl_assets/bitcoin-ordinals-analysis
+  ##  https://github.com/casey/ord/blob/master/src/media.rs
+
+   if content_type.start_with?( 'text/plain' )
+      '.txt'
+   elsif content_type.start_with?( 'text/markdown' )
+      '.md'
+   elsif content_type.start_with?( 'text/html' )
+      '.html'
+   elsif content_type.start_with?( 'text/javascript' ) ||
+         content_type.start_with?( 'application/javascript' )
+      ## note: application/javascript is considered bad practice/legacy
+      '.js'
+   elsif content_type.start_with?( 'image/png' )
+       ## Portable Network Graphics (PNG)
+      '.png'
+   elsif content_type.start_with?( 'image/jpeg' )
+        ##  Joint Photographic Expert Group image (JPEG) 
+       '.jpg'   ## use jpeg - why? why not?
+   elsif content_type.start_with?( 'image/webp' )
+        ## Web Picture format (WEBP)
+       '.webp'   ## note: no three-letter extension available
+   elsif content_type.start_with?( 'image/svg' )
+        ## Scalable Vector Graphics (SVG) 
+       '.svg'
+   elsif content_type.start_with?( 'image/gif' ) 
+       ##  Graphics Interchange Format (GIF)
+       '.gif'
+   elsif content_type.start_with?( 'image/avif' )  
+       ## AV1 Image File Format (AVIF)
+       '.avif'
+   elsif content_type.start_with?( 'application/epub' )
+       '.epub'
+   elsif content_type.start_with?( 'application/pdf' )
+       '.pdf'
+   elsif content_type.start_with?( 'application/json' )
+       '.json'
+   elsif content_type.start_with?( 'application/pgp-signature' )
+       '.sig'
+   elsif content_type.start_with?( 'audio/mpeg' )
+       '.mp3'
+   elsif content_type.start_with?( 'audio/midi' )
+       '.midi'
+   elsif content_type.start_with?( 'video/mp4' )
+       '.mp4'
+   elsif content_type.start_with?( 'video/webm' )
+       '.wepm'
+   elsif content_type.start_with?( 'audio/mod' )  
+      ## is typo? possible? only one inscription in 20m?
+       '.mod'   ## check/todo/fix if is .wav?? 
+   else
+      puts "!! ERROR - no file extension configured for content type >#{content_type}<; sorry:"
+      pp self
+      exit 1
+   end
+end
+
+def export_path  ## default export path
+   numstr = "%08d" % num   ###  e.g. 00000001  
+   "./tmp/#{numstr}#{extname}" 
+end
+def export( path=export_path )
+   if blob
+     write_blob( path, blob.content )
+   else
+      ## todo/fix: raise exception - no content
+      puts "!! ERROR - inscribe has no content (blob); sorry:"
+      pp self
+      exit 1
+   end
+end
+
+
   end  # class Inscribe
   
     end # module Model

data/lib/ordlite/schema.rb

@@ -87,7 +87,7 @@ create_table :inscribes, :id => :string do |t|
     ##   what is location  ???
     ## "location": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c:0:0",
 
-  ## timestamp at last
+  ## timestamp last
   t.timestamps
 end
 
@@ -99,14 +99,117 @@ create_table :blobs, :id => :string do |t|
     ## t.string   :id,  null: false, index: { unique: true, name: 'blob_uuids' }
  
     t.binary     :content,   null: false
+    t.string     :sha256   ## sha256 hash
+    t.string     :md5      ## md5 hash - add why? why not?  
 
-  ## timestamp at last
+  ## timestamp last
   t.timestamps
 end
 
 
+=begin
+ "name": "Planetary Ordinals",
+  "inscription_icon": "98da33abe2045ec1421fcf1bc376dea5beb17ded15aa70ca5da490f50d95a6d9i0",
+  "supply": "69",
+  "slug": "planetary-ordinals",
+  "description": "",
+  "twitter_link": "https://twitter.com/ordinalswallet",
+  "discord_link": "https://discord.com/invite/ordinalswallet",
+  "website_link": ""
+=end
+
+create_table :collections do |t|
+  t.string   :name, null: false
+  t.string   :slug   
+  t.text     :desc    # description
+  t.integer  :max     # supply
+  t.string   :icon_id    ## rename to inscribe_icon_id or such - why? why not?
+  ## add twitter_link, discord_link, website_link - why? why not?
+
+  ## if on-chain and metadata inscribed - add why? why not??
+  ## t.string   :source_id,  null: false   ## foreign key reference
+
+  ## timestamp last
+  t.timestamps
+end
+
+create_table :items do |t|
+  t.integer   :collection_id, null: false
+  t.string    :inscribe_id,   null: false
+  t.integer   :pos,           null: false
+  t.string    :name
+
+  ## timestamp last
+  t.timestamps
+
+  ## todo/fix: add unique index for :pos+:collection_id !!!
+end
+
+
+
+###
+#  generative (collection) factory
+create_table :factories, :id => :string do |t|
+  t.string   :name
+  t.integer  :max        # max limit
+  t.integer  :maxblock   # max block limit
+  t.string   :dim        # dimension e.g. 24x24 (in px)
+
+  t.string   :inscribe_id,  null: false   ## foreign key reference
+
+  ## timestamp last
+  t.timestamps
+end
+
+#####
+## join table (factory has_many modules)
+##   rename to layer / sprites / blocks / tiles / modules / submodules / subs / mods / ...etc - why? why not?
+##             layerlists or inscribelists or ???
+##  change/rename to factory_items or layer_items or such?
+create_table :inscriberefs, :id => false do |t|
+  t.string  :factory_id,    null: false
+  t.string  :inscribe_id,   null: false
+  t.integer :pos,           null: false    ## position (index) in list (starting at 0)
+  ## todo/fix: make factory_id + inscribe_id + pos unique index - why? why not?
+
+  ## timestamp last
+  t.timestamps
+end
+
+
+create_table :generatives, :id => :string do |t|
+  t.string  :factory_id,    null: false
+  t.string  :g,             null: false  ##  use space separated numbers - why? why not?    
+  t.binary  :content    ### optional for now - why? why not?
+ 
+  ## timestamp last
+  t.timestamps
+end
+
+
+
+
 end # block Schema.define
 
 end # method up
 end # class CreateDb
+
+###
+#  migrations helpers
+class AddGeneratives
+
+def up  
+  ActiveRecord::Schema.define do
+    create_table :generatives, :id => :string do |t|
+      t.string  :factory_id, null: false
+      t.string  :g,          null: false  ##  use space separated numbers - why? why not?    
+      t.binary  :content    ### optional for now - why? why not?
+     
+      ## timestamp last
+      t.timestamps
+    end
+  end # block Schema.define
+end # method up
+end # class AddGeneratives
+  
 end # module OrdDb

data/lib/ordlite/version.rb

@@ -3,8 +3,8 @@ module Ordlite
 
   # sync version w/ sport.db n friends - why? why not?
   MAJOR = 0 ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
-  PATCH = 1
+  MINOR = 2
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/ordlite.rb

@@ -2,11 +2,21 @@
 require_relative 'ordlite/base'
 
 
+
+
+
 ## add convenience helpers
 ##  use require 'ordlite/base' if you do NOT want automagic aliases
 
 
-Inscribe = OrdDb::Model::Inscribe
-Blob     = OrdDb::Model::Blob
+Inscribe   = OrdDb::Model::Inscribe
+Blob       = OrdDb::Model::Blob
+Collection = OrdDb::Model::Collection
+Factory    = OrdDb::Model::Factory
+Generative = OrdDb::Model::Generative
+
+
+require 'active_support/number_helper'
+include ActiveSupport::NumberHelper   ## e.g. number_to_human_size
 
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ordlite
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-01 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ordinals
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -159,12 +173,16 @@ files:
 - lib/ordlite.rb
 - lib/ordlite/base.rb
 - lib/ordlite/cache.rb
+- lib/ordlite/importer.rb
 - lib/ordlite/models/blob.rb
+- lib/ordlite/models/collection.rb
+- lib/ordlite/models/factory.rb
 - lib/ordlite/models/forward.rb
+- lib/ordlite/models/generative.rb
 - lib/ordlite/models/inscribe.rb
 - lib/ordlite/schema.rb
 - lib/ordlite/version.rb
-homepage: https://github.com/ordbase/generative-orc-721
+homepage: https://github.com/ordbase/ordbase
 licenses:
 - Public Domain
 metadata: {}