scribelite 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6690bac30dba4368195511bcf9e5f80b00a611ab1b741a2faaec7b1e7bb31823
-  data.tar.gz: e5eb0fa135f73c92f211039e9a097c92534ab9f8669089527543da21ceeaa72d
+  metadata.gz: 8f774ffec5b1c7a02d7ff82d92e7dea2ca83aa918f498fb2d24969870e26d819
+  data.tar.gz: cf9faa2257cb17c595a01685f2dc1b97d4d6fb315f7e65a8e2b6b9663d59872d
 SHA512:
-  metadata.gz: 85cc9101a8b0c5b21413ab0df3d9b4b69bf815eb9f29bcc2d6af6e1ee80d14fd69e20c119f8314f8adb9227004e5fb5fb45d45a7854ee5d43827474c3b11e657
-  data.tar.gz: a2dff1d4aa19b699540cb49b94023718684a06b4939c785cd112049ae76411b18d279ade78943d86a0d47d92a3bcc30625b832694f4a079c360b06bd06f07f81
+  metadata.gz: 272471a546baa300468d4dbc0558297930c12f20fd6447366dbd5b02bb6d34ff2aec04090731abcf7259447a389a1a0a20350c2c26659b95e2b9752808479f3d
+  data.tar.gz: 517b655428b5a043851c3bc0df41689648a9ca51839593d2f3a0284845a207e8570da852d36a165ef65fb6a6892ef1a0a5004490f4816823dd93d13cd977c6bb

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+### 0.1.0
 ### 0.0.1 / 2023-11-21
 
 * Everything is new. First release

data/Manifest.txt

@@ -3,3 +3,8 @@ Manifest.txt
 README.md
 Rakefile
 lib/scribelite.rb
+lib/scribelite/models/calldata.rb
+lib/scribelite/models/forward.rb
+lib/scribelite/models/inscribe.rb
+lib/scribelite/schema.rb
+lib/scribelite/version.rb

data/README.md

@@ -1,4 +1,4 @@
-# Inscription / Inscribe (Ethscription Calldata) SQL Database
+# Scribelite - Inscription / Inscribe (Ethscription Calldata) SQL Database
 
 scribelite - inscription / inscribe (ethscription calldata) database for ethereum & co; let's you query via sql and more
 

data/Rakefile

@@ -1,11 +1,11 @@
 require 'hoe'
-# require './lib/scribelite/version.rb'
+require './lib/scribelite/version.rb'
 
 
 Hoe.spec 'scribelite' do
-  self.version =  '0.0.1' # Scribelite::VERSION
+  self.version =  Scribelite::VERSION
 
-  self.summary = "scribelite - inscription / inscribe (ethscription calldata) database for ethereum & co; let's you query via sql and more"
+  self.summary = "scribelite gem - inscription / inscribe (ethscription calldata) database for ethereum & co; let's you query via sql and more"
   self.description = summary
 
   self.urls    = { home: 'https://github.com/s6ruby/rubidity' }
@@ -19,6 +19,13 @@ Hoe.spec 'scribelite' do
 
   self.extra_deps = [
     ['ethscribe'],   
+    ['activerecord'],
+    ['activerecord-utils'],
+    ['logutils'],
+    ['logutils-activerecord'],
+    ['props'],
+    ['props-activerecord'],
+    ['sqlite3'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/scribelite/models/calldata.rb

@@ -0,0 +1,19 @@
+
+module ScribeDb
+    module Model
+  
+  class Calldata < ActiveRecord::Base
+    self.table_name = 'calldatas'   ## check if infers data? why? why not?
+
+    belongs_to :inscribe, foreign_key: 'id'
+
+=begin    
+    def text
+       content.force_encoding(Encoding::UTF_8)
+    end
+=end
+  end  # class Calldata
+  
+    end # module Model
+end # module ScribeDb
+  

data/lib/scribelite/models/forward.rb

@@ -0,0 +1,24 @@
+
+### forward references
+##   require first to resolve circular references
+
+module ScribeDb
+module Model
+
+#############
+# ConfDb
+Prop      = ConfDb::Model::Prop
+
+
+class Inscribe    < ActiveRecord::Base ; end
+class Calldata    < ActiveRecord::Base ; end
+
+
+end # module Model
+
+# note: convenience alias for Model
+# lets you use include ScribeDb::Models
+Models = Model   
+end # module ScribeDb
+
+

data/lib/scribelite/models/inscribe.rb

@@ -0,0 +1,189 @@
+
+module ScribeDb
+    module Model
+  
+  class Inscribe < ActiveRecord::Base
+    has_one :calldata, foreign_key: 'id'
+ 
+    ## 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.png() where( content_type: 'image/png' ); end
+    def self.gif() where( content_type: 'image/gif' ); end
+    def self.jpg() where( content_type: 'image/jpeg' ); end
+    def self.webp() where( content_type: 'image/webp' ); end
+    def self.svg()  where( content_type: 'image/svg+xml' ); end
+    def self.avif() where( content_type: 'image/avif' ); end
+
+    class << self
+       alias_method :jpeg, :jpg
+    end     
+
+    def self.image  
+         ## change to/or add alias e.g. image/images - why? why not
+        where( content_type: [
+            'image/png',
+            'image/jpeg',
+            'image/gif',
+            'image/webp',
+            'image/svg+xml',
+            'image/avif',
+            ])
+    end
+
+    def self.html
+        where( content_type: [
+           'text/html;charset=utf-8',
+           'text/html',
+          ])
+    end
+
+    def self.js
+        where( content_type: [
+           'text/javascript',
+           'application/javascript',
+          ])
+    end
+
+     class << self
+        alias_method :javascript, :js
+     end     
+ 
+    def self.text
+        ## change to/or add alias e.g. text/texts - why? why not
+        ## include html or svg in text-only inscription - why? why not?
+        ##  include markdown in text-only inscription - why? why not?
+        ##   make content_type lower case with lower() - why? why not?
+        where( content_type: [
+                  'text/plain',
+                  'text/plain;charset=utf-8',
+                  'text/plain;charset=us-ascii',
+                  'application/json',
+             ])
+    end
+ 
+=begin    
+    def self.search( q )   ## "full-text" search helper
+        ##  rename to text_search - why? why not?        
+        ## auto-sort by num - why? why not?
+        joins(:blob).text.where( "content LIKE '%#{q}%'" ).order('num')
+    end
+=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.sub2m()  where( 'num < 2000000' ); end
+   def self.sub10m()  where( 'num < 10000000' ); end
+   def self.sub20m()  where( 'num < 20000000' ); end
+   def self.sub21m()  where( 'num < 21000000' ); end
+ 
+
+   def self.largest
+      order( 'bytes DESC' )
+   end
+
+   def self.content_type_counts
+       group( 'content_type' )
+       .order( Arel.sql( 'COUNT(*) DESC, content_type')).count
+   end
+
+   class << self
+      alias_method :biggest, :largest
+      alias_method :counts_by_content_type, :content_type_counts
+   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
+
+=begin
+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
+
+  end  # class Inscribe
+  
+    end # module Model
+end # module ScribeDb
+  

data/lib/scribelite/schema.rb

@@ -0,0 +1,76 @@
+
+
+module ScribeDb
+
+class CreateDb
+
+def up
+
+ActiveRecord::Schema.define do
+
+create_table :inscribes, :id => :string do |t|    
+    ## "id": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5ci0",
+    ## note: change to uuid (universally unique id) - why? why not?
+    ##        id gets used by row_id (internal orm db machinery) and is int
+   ## t.string   :uuid,  null: false, index: { unique: true, name: 'inscribe_uuids' }
+
+   ## "title": "Inscription 10371414",
+   ##   note: use num/no. from title only - why? why not?
+    t.integer  :num, null: false, index: { unique: true, name: 'inscribe_nums' }
+   
+    ##  "content length": "85 bytes",
+    ## note:  extract bytes as integer!!!
+    ##    change to bytes - why? why not?
+    t.integer  :bytes
+    ## "content type": "text/plain;charset=utf-8",
+    ## note: make sure always lower/down case!!!
+    t.string   :content_type
+    
+ 
+    ## add allow duplicate opt-in protocol flag e.g. esip6
+    ## t.boolean    :duplicate   -
+ 
+  ## timestamp last
+  t.timestamps
+end
+
+
+## change to tx/txs or txn/txns - why? why not?
+
+create_table :calldatas, :id => :string do |t|
+    ## "id": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5ci0",
+    ## note: change to uuid (universally unique id) - why? why not?
+    ##        id gets used by row_id (internal orm db machinery) and is int
+    ## t.string   :id,  null: false, index: { unique: true, name: 'blob_uuids' }
+ 
+    t.binary     :data   # ,  null: false
+    t.string     :sha    # ,  null: false    ## sha hash as hexstring
+ 
+    ## "timestamp": "2023-06-01 05:00:57 UTC"
+    ##   or use date_utc ???
+    ##   or change to t.integer AND timestamp  or time or epoch(time) - why? why not?
+    t.datetime    :date, null: false
+
+    t.integer    :block, null: false
+    t.integer    :fee
+    t.integer    :value
+
+    ###
+    ## "address": "bc1p3h4eecuxjj2g72sq38gyva732866u5w29lhxgeqfe6c0sg8xmagsuau63k",
+    ##    is this minter/inscriber addr???
+    ##  change to minter?? or such - why? why not?
+    ##             creator 
+    t.string     :from, null: false
+
+    ## add to address too - why? why not?
+    t.string     :to   
+  ## timestamp last
+  t.timestamps
+end
+
+end # block Schema.define
+
+end # method up
+end # class CreateDb
+  
+end # module ScribeDb

data/lib/scribelite/version.rb

@@ -0,0 +1,19 @@
+
+module Scribelite
+  MAJOR = 0 ## todo: namespace inside version or something - why? why not??
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "scribelite/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in >#{root}<"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+end

data/lib/scribelite.rb

@@ -1,4 +1,145 @@
 
+# core and stlibs
+require 'ethscribe'  ## will pull-in cocos & friends
 
-puts "Hello, Scribelite!"
+
+
+require 'logger'    # Note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
+
+
+# 3rd party gems / libs
+require 'props'           # see github.com/rubylibs/props
+require 'logutils'        # see github.com/rubylibs/logutils
+
+
+require 'active_record'   ## todo: add sqlite3? etc.
+
+## add more activerecords addons/utils
+# require 'tagutils'
+require 'activerecord/utils'
+require 'props/activerecord'      # includes ConfDb (ConfDb::Model::Prop, etc.)
+require 'logutils/activerecord'   # includes LogDb (LogDb::Model::Log, etc.)
+
+
+
+# our own code
+require_relative 'scribelite/version'   # always goes first
+
+require_relative 'scribelite/models/forward'
+
+require_relative 'scribelite/models/inscribe'
+require_relative 'scribelite/models/calldata'
+
+
+require_relative 'scribelite/schema'      
+
+# require_relative 'cache'
+# require_relative 'importer'  ## note: require (soft dep) ordinals gems!!!
+
+
+
+
+module ScribeDb
+
+  def self.create
+    CreateDb.new.up
+    ConfDb::Model::Prop.create!( key: 'db.schema.scribe.version', 
+                                 value: Scribelite::VERSION )
+  end
+
+  def self.create_all
+    LogDb.create    # add logs table
+    ConfDb.create   # add props table
+    ScribeDb.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 ScribeDb::Model::Inscribe.table_exists?
+      ScribeDb.create
+    end
+  end # method auto_migrate!
+
+
+  def self.open( database='./scribe.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?
+      puts "ENV['DATBASE_URL'] - >#{ENV['DATABASE_URL']}<"
+
+      ### change default to ./scribe.db ?? why? why not?
+      db = URI.parse( ENV['DATABASE_URL'] || 'sqlite3:///scribe.db' )
+
+      if db.scheme == 'postgres'
+        config = {
+          adapter: 'postgresql',
+          host: db.host,
+          port: db.port,
+          username: db.user,
+          password: db.password,
+          database: db.path[1..-1],
+          encoding: 'utf8'
+        }
+      else # assume sqlite3
+       config = {
+         adapter: db.scheme, # sqlite3
+         database: db.path[1..-1] # scribe.db (NB: cut off leading /, thus 1..-1)
+      }
+      end
+    end
+
+    puts "Connecting to db using settings: "
+    pp config
+    ActiveRecord::Base.establish_connection( config )
+    # ActiveRecord::Base.logger = Logger.new( STDOUT )
+  end
+
+
+  def self.setup_in_memory_db
+
+    # Database Setup & Config
+    ActiveRecord::Base.logger = Logger.new( STDOUT )
+    ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+    self.connect( adapter:  'sqlite3',
+                  database: ':memory:' )
+
+    ## build schema
+    ScribeDb.create_all
+  end # setup_in_memory_db (using SQLite :memory:)
+
+end  # module ScribeDb
+
+
+
+
+
+
+## add convenience helpers
+Inscribe  = ScribeDb::Model::Inscribe
+Calldata  = ScribeDb::Model::Calldata
+
+
+# say hello
+puts Scribelite.banner     ## if defined?($RUBYCOCOS_DEBUG) && $RUBCOCOS_DEBUG
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scribelite
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -24,6 +24,104 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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-utils
+  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: logutils
+  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: logutils-activerecord
+  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: props
+  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: props-activerecord
+  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: sqlite3
+  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: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +156,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: scribelite - inscription / inscribe (ethscription calldata) database
+description: scribelite gem - inscription / inscribe (ethscription calldata) database
   for ethereum & co; let's you query via sql and more
 email: gerald.bauer@gmail.com
 executables: []
@@ -73,6 +171,11 @@ files:
 - README.md
 - Rakefile
 - lib/scribelite.rb
+- lib/scribelite/models/calldata.rb
+- lib/scribelite/models/forward.rb
+- lib/scribelite/models/inscribe.rb
+- lib/scribelite/schema.rb
+- lib/scribelite/version.rb
 homepage: https://github.com/s6ruby/rubidity
 licenses:
 - Public Domain
@@ -97,6 +200,6 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: scribelite - inscription / inscribe (ethscription calldata) database for
-  ethereum & co; let's you query via sql and more
+summary: scribelite gem - inscription / inscribe (ethscription calldata) database
+  for ethereum & co; let's you query via sql and more
 test_files: []