ethscribe 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 188cf1ce52483f1154cb3ecf9bc7bbb4fcd60afa3d74543a0e1523c29e866e59
-  data.tar.gz: c9c60dbdc3ffb69b23447a3e44e33c28788b156aed6c4f40571a9a91a3f2d1b0
+  metadata.gz: e4217cdc814f3b713841774ed4eec4abe0f024d598e365a5b7b34e142f555d77
+  data.tar.gz: a28f4ca71df40a9da404ccc817e2e4ae13b247da8a44ea4878d5fee9e0f54a6b
 SHA512:
-  metadata.gz: d98ebfe511ec43d963697e487a3202641d16c1a1ab51b0d8239f3cd0d4a8cd2c7f939bb2b98046dcb615f475fe8f3caabbbdecfbd18b46471bb3d3b53ded6eaa
-  data.tar.gz: 84139161c630e77dc0f20cbf0e538394179b265af5ba4b739cbc5b8efa72f857ebd36dbdd09976262d8cbfebbfb09b1f3ec55b7f859141a99df38b15777d44b1
+  metadata.gz: e3d408e310e9df8cd9ef4df9376d854f3d243eabd321920071d27d6a94131e03114865427ee36c5dbf97693a1893ba4329d0cd1e56278611519f2f05f4b57185
+  data.tar.gz: 9cb5cb71409a5e8280ea5be41c1c2c07b1ea0602766caee4168decb8a530a3f99931d950f4d28074905505fc76225530a13517126bd57da2f9039a23e93ac050

data/CHANGELOG.md

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

data/Manifest.txt

@@ -3,3 +3,5 @@ Manifest.txt
 README.md
 Rakefile
 lib/ethscribe.rb
+lib/ethscribe/api.rb
+lib/ethscribe/version.rb

data/Rakefile

@@ -1,11 +1,11 @@
 require 'hoe'
-# require './lib/ethscribe/version.rb'
+require './lib/ethscribe/version.rb'
 
 
 Hoe.spec 'ethscribe' do
-  self.version = '0.0.1'   
+  self.version = Ethscribe::VERSION
 
-  self.summary = 'ethscribe  -  inscription (ethscription calldata) api wrapper & helpers for Ethereum & co.'
+  self.summary = 'ethscribe - inscription (ethscription calldata) api wrapper & helpers for Ethereum & co.'
   self.description = summary
 
   self.urls    = { home: 'https://github.com/s6ruby/rubidity' }
@@ -18,6 +18,7 @@ Hoe.spec 'ethscribe' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
+    ['cocos'],   
   ]
 
   self.licenses = ['Public Domain']

data/lib/ethscribe/api.rb

@@ -0,0 +1,72 @@
+
+
+module Ethscribe
+
+
+class Api   ## change/rename Api to Client - why? why not?
+  def self.goerli
+    @goerli ||= new( 'https://goerli-api.ethscriptions.com/api' )
+    @goerli
+  end
+  ## todo: add test alias - why? why not? 
+
+  def self.mainnet
+    @mainnet ||= new( 'https://api.ethscriptions.com/api' )
+    @mainnet
+  end
+  ## todo:  add eth, main or production alias - why? why not?
+
+
+  def config() Ethscribe.config; end  ## convenience shortcut helper
+
+
+  def initialize( base )
+    @base          = base
+    @requests      = 0  ## count requests (for delay_in_s sleeping/throttling)
+  end
+
+#########
+# page       - integer  (starting at 1)
+# per_page   - integer    (default: 25)
+# sort_order - string "asc" or "desc"   (default: desc - latest first)
+
+
+  def ethscriptions( page: nil, per_page: nil, sort_order: nil )  
+    src = "#{@base}/ethscriptions"
+    params = []
+    params << ['page',       page.to_s]                    if page 
+    params << ['per_page',   per_page.to_s]                if per_page 
+    params << ['sort_order', sort_order.to_s.downcase ]    if sort_order
+    
+    if params.size > 0
+         src += "?" + params.map { |key,value| "#{key}=#{value}" }.join('&')
+    end
+
+    res = get( src )
+    res.json   ## return parsed json data - why? why not?
+  end
+
+
+  def get( src )
+    @requests += 1
+
+    if @requests > 1 && config.delay_in_s
+      puts "request no. #{@requests}@#{@base}; sleeping #{config.delay_in_s} sec(s)..."
+      sleep( config.delay_in_s )
+    end
+
+    res = Webclient.get( src )
+ 
+    if res.status.ok?
+      res
+    else
+      ## todo/fix: raise exception here!!!!
+      puts "!! ERROR - HTTP #{res.status.code} #{res.status.message} - failed web request >#{src}<; sorry"
+      exit 1
+    end
+  end
+end  # class Api
+
+
+end   ## module Ethscibe
+

data/lib/ethscribe/version.rb

@@ -0,0 +1,19 @@
+
+module Ethscribe
+  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
+    "ethscribe/#{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/ethscribe.rb

@@ -1,3 +1,93 @@
+require 'cocos'
 
-puts "Hello, Ethscribe!"
+
+
+module Ethscribe
+  class Configuration
+
+    #######################
+    ## accessors
+    def chain=(value)
+        if value.is_a?( String ) || value.is_a?( Symbol )
+            case value.downcase.to_s
+            when 'mainnet'  #  'main', 'eth', 'prod', 'production'
+               @chain  = 'mainnet'
+               @client = Ethscribe::Api.mainnet
+            when 'goerli'   #  'testnet', 'test'
+               @chain = 'goerli'
+               @client = Ethscribe::Api.goerli
+            else
+              raise ArgumentError, "unknown chain - expected mainnet | goerli; got #{value}"
+            end
+        else
+            raise ArgumentError, "only string or symbol supported for now; sorry - got: #{value.inspect} : #{value.class.name}"
+        end
+    end
+
+    def chain
+      ## note - default to mainnet if not set
+      self.chain = 'mainnet'   unless defined?( @chain )
+      @chain
+    end
+
+    ## note: read-only for now - why? why not?
+    def client
+      ## note - default to btc/ if not set
+      self.chain = 'mainnet'   unless defined?( @client )
+      @client
+    end
+
+    def delay_in_s 
+      ## note - default to 1 (sec) if not set
+      self.delay_in_s = 1   unless defined?( @delay_in_s )
+      @delay_in_s
+    end  
+    def delay_in_s=(value) @delay_in_s = value; end
+    alias_method :sleep,  :delay_in_s   ## add sleep alias (or wait) - why? why not?
+    alias_method :sleep=, :delay_in_s=
+  end # class Configuration
+
+
+  ## lets you use
+  ##   Ordinals.configure do |config|
+  ##      config.chain = :btc
+  ##   end
+  def self.configure() yield( config ); end
+  def self.config()    @config ||= Configuration.new;  end
+
+  ##  add some convenience shortcut helpers (no config. required) - why? why not?
+  def self.client()      config.client; end
+  def self.chain()       config.chain; end
+  def self.chain=(value) config.chain = value; end
+
+
+  def self.mainnet?()     config.chain == 'mainnet'; end
+  def self.goerli?()      config.chain == 'goerli'; end
+ 
+
+  ###################
+  ### more convenience shortcuts
+
+  def self.inscribes( **kwargs )  client.ethscriptions( **kwargs ); end
+end  # module Ethscribe
+
+
+
+
+## our own code
+require_relative 'ethscribe/version'
+require_relative 'ethscribe/api'
+
+
+
+module Ethscribe
+  #############
+  ##  add more convenience alias - why? why not?
+  API = Api
+end  # module Ethscribe
+
+
+
+# say hello
+puts Ethscribe.banner     ## if defined?($RUBYCOCOS_DEBUG) && $RUBCOCOS_DEBUG
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ethscribe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocos
+  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
@@ -44,7 +58,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: ethscribe  -  inscription (ethscription calldata) api wrapper & helpers
+description: ethscribe - inscription (ethscription calldata) api wrapper & helpers
   for Ethereum & co.
 email: gerald.bauer@gmail.com
 executables: []
@@ -59,6 +73,8 @@ files:
 - README.md
 - Rakefile
 - lib/ethscribe.rb
+- lib/ethscribe/api.rb
+- lib/ethscribe/version.rb
 homepage: https://github.com/s6ruby/rubidity
 licenses:
 - Public Domain
@@ -83,6 +99,6 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: ethscribe  -  inscription (ethscription calldata) api wrapper & helpers for
+summary: ethscribe - inscription (ethscription calldata) api wrapper & helpers for
   Ethereum & co.
 test_files: []