mooncats-graphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da57d2e625ff09695d4678abe4b42267b31a951f538bccba41f692973b932585
+  data.tar.gz: f829e8e7042bfa6269eb844c69f8dffc9c0da8d8c8be0b282a939f3096ae49a2
+SHA512:
+  metadata.gz: ba9445031e9252911b3b16d9f28a3bf7b566deeab239602ed467b74ad2d4e798f686116a7ef0153d9d1bad5da3fe7863e412f44e62143e74a3beaaa073d5cea0
+  data.tar.gz: 264bafe762848cdf7627735bfe44735b3b8384003da0a2aa43668e25db1163714ddd6e230c2f83dd98c351ffea1e2a39f8945f629211de34578334251f8700aa

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2021-03-31
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/mooncats-graphql.rb
+lib/mooncats/graphql.rb
+lib/mooncats/graphql/client.rb
+lib/mooncats/graphql/query.rb
+lib/mooncats/graphql/version.rb

data/README.md

@@ -0,0 +1,184 @@
+# Mooncats GraphQL
+
+
+mooncats-graphql - web client (helpers) for using MoonCats (HTTP JSON) GraphQL APIs
+
+
+* home  :: [github.com/cryptocopycats/mooncats](https://github.com/cryptocopycats/mooncats)
+* bugs  :: [github.com/cryptocopycats/mooncats/issues](https://github.com/cryptocopycats/mooncats/issues)
+* gem   :: [rubygems.org/gems/mooncats-graphql](https://rubygems.org/gems/mooncats-graphql)
+* rdoc  :: [rubydoc.info/gems/mooncats-graphql](http://rubydoc.info/gems/mooncats-graphql)
+
+
+
+
+## Usage
+
+A lite web client wrapper for the Moon Cats Rescue open graph api
+powered by the Graph.
+See [**thegraph.com/explorer/subgraph/merklejerk/moon-cats-rescue »**](https://thegraph.com/explorer/subgraph/merklejerk/moon-cats-rescue).
+
+
+``` ruby
+require 'mooncats/graphql'
+
+c = Mooncats::GraphQL::Client.new
+
+data = c.query_bestsellers( first: 12 )
+```
+
+resulting in:
+
+``` ruby
+[{"id"               => "0xff52000ca7",
+  "isGenesis"        => true,
+  "maxAdoptionPrice" => "55500000000000000000",
+  "name"             => nil,
+  "rescueBlock"      => 4363303,
+  "rescueIndex"      => 2878,
+  "rescueTime"       => 1507932258},
+ {"id"               => "0xff50000ca7",
+  "isGenesis"        => true,
+  "maxAdoptionPrice" => "55500000000000000000",
+  "name"             => nil,
+  "rescueBlock"      => 4363303,
+  "rescueIndex"      => 2876,
+  "rescueTime"       => 1507932258},
+  #...
+]
+```
+
+Note: Depending on the query either a data array (zero, one or more records)
+e.g. `query_bestsellers`
+or a hash table or nil  (one or no record) e.g. `query_cat_by_id`
+gets returned. Use like:
+
+
+``` ruby
+data.each_with_index do |rec,i|
+  print '%2d.  ' % (i+1)
+  print '%3d ETH' % (rec['maxAdoptionPrice'].to_i / 1000000000000000000)
+  print ' - '
+  print rec['id']
+  print "\n"
+end
+```
+
+printing:
+
+```
+ 1.   55 ETH - 0xff52000ca7
+ 2.   55 ETH - 0xff50000ca7
+ 3.   49 ETH - 0x00816eb855
+ 4.   32 ETH - 0x00ac2b3f23
+ 5.   13 ETH - 0x00f28bec4f
+ 6.   12 ETH - 0x00304c8e29
+ 7.   12 ETH - 0x002179a08d
+ 8.   10 ETH - 0xff0b000ca7
+ 9.   10 ETH - 0x0080ea1503
+10.    8 ETH - 0x00e38e784c
+11.    8 ETH - 0x00c1832514
+12.    8 ETH - 0x0002b77279
+```
+
+
+More pre-configured / built-in queries include:
+
+
+``` ruby
+query_cats
+query_mint_2017( first: 10 )
+query_cat_by_id( id: '0xff52000ca7' )
+query_cat_by_wrapper_id( id: 0 )
+query_cheap_mints_2017
+query_latest_adoptions
+query_latest_donations
+query_top_collectors
+query_wrapped
+```
+
+See the [query source](lib/mooncats/graphql/query.rb) for more.
+
+
+
+### Pagination - 1000 Records Max. Limit / Request
+
+Note:  The open graph api has a 1000 records limit per request.
+The recommended way for pagination is to use
+a greater than last record id in the where clause in the query
+to get the next page / batch.
+Example - `query_cats`:
+
+```  graphql
+{
+  cats(first: 1000,
+       where: { id_gt: $last_id }) {
+    id
+    # ...
+  }
+}
+```
+
+Get all 25 440 MoonCat blockchain data
+in 26 batches / requests of a thousand each:
+
+``` ruby
+# ~26 000 mooncats - download in 26 batches of 1000 each
+last_id = '0x0000000000'
+26.times do |i|
+  puts "downloading batch #{i}..."
+  data = c.query_cats( last_id: last_id )
+  puts "  #{data.size} records(s)"
+
+  ## process data here
+
+  last_id = data[-1]['id']    ## get id from last record using index -1
+  puts "  last_id: #{last_id}"
+  sleep( 1 )
+end
+```
+
+resulting in:
+
+```
+downloading batch 0...
+  1000 record(s)
+  last_id: 0x000a05b9ac
+downloading batch 1...
+  1000 record(s)
+  last_id: 0x0013b68a2f
+...
+```
+
+That's it.
+
+
+
+## New to MoonCats?
+
+See the
+[**Programming MoonCats & MarsCats Step-by-Step Booklet / Guide »**](https://github.com/cryptocopycats/programming-mooncats)
+
+
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install mooncats-graphql
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Post them on the [mooncatrescue reddit](https://www.reddit.com/r/mooncatrescue). Thanks.
+
+
+
+

data/Rakefile

@@ -0,0 +1,29 @@
+require 'hoe'
+require './lib/mooncats/graphql/version.rb'
+
+Hoe.spec 'mooncats-graphql' do
+
+  self.version = MooncatsClient::VERSION
+
+  self.summary = "mooncats-graphql - (lite) mooncats (http json) graphql api / client"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/cryptocopycats/mooncats' }
+
+  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.3'
+  }
+
+end

data/lib/mooncats-graphql.rb

@@ -0,0 +1,7 @@
+###
+## convenience helper enables / allows alternate require path
+#   require 'mooncats-graphql'
+
+require_relative 'mooncats/graphql'
+
+

data/lib/mooncats/graphql.rb

@@ -0,0 +1,22 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+require 'yaml'
+require 'date'
+require 'time'
+require 'fileutils'
+require 'pp'
+
+
+
+## our own code
+require 'mooncats/graphql/version'    # note: let version always go first
+require 'mooncats/graphql/client'
+require 'mooncats/graphql/query'
+
+
+
+
+# say hello
+puts MooncatsClient.banner

data/lib/mooncats/graphql/client.rb

@@ -0,0 +1,43 @@
+
+module Mooncats
+  class Client
+
+
+    def initialize( base_uri: )
+      @base_uri = base_uri
+    end
+
+    def post( **params )
+
+      uri = URI.parse( @base_uri )
+      res = Net::HTTP.start( uri.host, uri.port,
+                             use_ssl: true) do |http|
+              req = Net::HTTP::Post.new( uri )
+              req['Content-Type'] = 'application/json'
+
+              # note: the body needs to be a JSON string
+              req.body = JSON.generate( params )
+
+              # puts
+              # puts "graphql post:"
+              # puts req.body
+              # puts "---"
+
+              http.request( req )
+           end
+
+        if res.code.to_i != 200
+            puts "!! ERROR: HTTP #{res.code} #{res.message}:"
+            pp res
+            exit 1
+        end
+
+      body = res.body.to_s
+      ## note: assumes ascii-8bit/binary encoding (by default)
+      ##   change to utf-8  (as always required by json )
+      body = body.force_encoding( Encoding::UTF_8 )
+
+      data = JSON.parse( body )
+  end
+end # class Client
+end # module Mooncats

data/lib/mooncats/graphql/query.rb

@@ -0,0 +1,293 @@
+
+module Mooncats
+module GraphQL
+
+  class Client < ::Mooncats::Client
+    def initialize
+      super( base_uri: 'https://api.thegraph.com/subgraphs/name/merklejerk/moon-cats-rescue' )
+    end
+
+
+    def query_bestsellers( first: 100,
+                           includes: [] )
+      query = <<GRAPHQL
+      {
+        cats(first: $first, orderBy: maxAdoptionPrice, orderDirection: desc) {
+          id
+          rescueIndex
+          rescueBlock
+          rescueTime
+          name
+          isGenesis
+          maxAdoptionPrice
+          #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice etc.
+        }
+      }
+GRAPHQL
+      query = query.gsub( '$first',   first.to_s )
+
+      data = query( query, includes: includes )
+      data['data']['cats']   ## return nested data
+    end
+
+    def query_cheap_mints_2017( first: 100,
+                                includes: [] )
+      query = <<GRAPHQL
+      {
+  cats(first: $first, orderBy: askPrice,
+       where: {rescueTime_lt: 1514764800, askPrice_gt: 0}) {
+    id
+    name
+    rescueIndex
+    rescueTime
+    askPrice
+    #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice etc.
+  }
+}
+GRAPHQL
+      query = query.gsub( '$first',   first.to_s )
+
+      data = query( query, includes: includes )
+      data['data']['cats']   ## return nested data
+    end
+
+
+    def query_mint_2017( first: 100,
+                         last_rescue_index: -1,
+                         includes: [] )
+      query = <<GRAPHQL
+      {
+        cats(first: $first,     ## note: max is 1000
+              orderBy: rescueIndex,
+              where:
+              { rescueTime_lt: 1514764800,
+                rescueIndex_gt: $last_rescue_index   ## for paging in batches of 1000
+              }) {
+          id
+          rescueIndex
+          rescueBlock
+          rescueTime
+          name
+          #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice,  etc.
+        }
+      }
+GRAPHQL
+      query = query.gsub( '$first',              first.to_s )
+      query = query.gsub( '$last_rescue_index',  last_rescue_index.to_s )
+
+      data = query( query, includes: includes )
+      data['data']['cats']
+    end
+
+
+    def query_cats( first: 1000,
+                     last_id: '0x00',
+                     includes: [] )
+      query = <<GRAPHQL
+      {
+        cats(first: $first,   ## note: max is 1000
+              where: { id_gt: $last_id }) {
+          id
+          rescueIndex
+          rescueBlock
+          rescueTime
+          name
+          #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice, etc.
+        }
+      }
+GRAPHQL
+      query = query.gsub( '$first',   first.to_s )
+      query = query.gsub( '$last_id',  %Q<"#{last_id}"> )
+
+      data = query( query, includes: includes )
+      data['data']['cats']
+    end
+
+
+    def query_cat_by_id( id:,
+                         includes: [] )
+      query = <<GRAPHQL
+      {
+        cat(id: $id) {
+          id
+          rescueIndex
+          rescueTime
+          name
+          isGenesis
+          maxAdoptionPrice
+          wrapperTokenId
+          owner {
+            id
+          }
+          bid {
+            price
+          }
+          ask {
+            price
+          }
+          #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice,  etc.
+        }
+      }
+GRAPHQL
+      query = query.gsub( '$id',  %Q<"#{id}"> )
+
+      data = query( query, includes: includes )
+      data['data']['cat']   ## note: returns single (one-only) cat record
+    end
+
+
+    def query_cat_by_wrapper_id( id:,
+                                 includes: [] )
+    query = <<GRAPHQL
+    {
+      cats(where: {wrapperTokenId: $wrapper_token_id}) {
+        id
+        rescueIndex
+        rescueTime
+        name
+        isGenesis
+        maxAdoptionPrice
+        wrapperTokenId
+        owner {
+          id
+        }
+        bid {
+          price
+        }
+        ask {
+          price
+        }
+        #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice,  etc.
+      }
+    }
+GRAPHQL
+    query = query.gsub( '$wrapper_token_id',  id.to_s )
+
+    data = query( query, includes: includes )
+    data['data']['cats'][0]   # note: try to get first record only (by default) - why? why not?
+  end
+
+   def query_latest_adoptions( first: 100,
+                               includes: [] )
+     query = <<GRAPHQL
+    {
+      adoptions(first: $first, orderBy: time, orderDirection: desc,
+                where: {price_gt: 0}) {
+        cat {
+          id
+          rescueIndex
+          isGenesis
+        }
+        time
+        price
+        to {
+          id
+        }
+        #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice,  etc.
+      }
+    }
+GRAPHQL
+    query = query.gsub( '$first',  first.to_s )
+
+    data = query( query, includes: includes )
+    data['data']['adoptions']
+  end
+  alias_method :query_recent_adoptions, :query_latest_adoptions
+
+
+  def query_latest_donations( first: 100,
+                              includes: [] )
+    query = <<GRAPHQL
+    {
+      adoptions(first: $first, orderBy: time, orderDirection: desc,
+         where: {price: 0, isWrapping: false}) {
+        cat {
+          id
+          rescueIndex
+          isGenesis
+        }
+        time
+        to {
+          id
+        }
+        #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice,  etc.
+      }
+    }
+GRAPHQL
+    query = query.gsub( '$first',  first.to_s )
+
+    data = query( query, includes: includes )
+    data['data']['adoptions']
+  end
+  alias_method :query_recent_donations, :query_latest_donations
+
+
+  def query_top_collectors( first: 10,
+                            includes: [] )
+     query = <<GRAPHQL
+  {
+  owners(first: $first, orderBy: catCount, orderDirection: desc,
+    where: {isWrapper: false}) {
+    id
+    catCount
+  }
+}
+GRAPHQL
+    query = query.gsub( '$first',  first.to_s )
+
+    data = query( query, includes: includes )
+    data['data']['owners']
+  end
+
+
+  def query_wrapped( first: 100,
+                     last_rescue_index: -1,
+                     includes: [] )
+  query = <<GRAPHQL
+{
+  cats(first: $first, orderBy: rescueIndex,
+        where:
+        { wrapperTokenId_not: null,
+          rescueIndex_gt: $last_rescue_index   ## for paging in batches of 1000
+         }) {
+    id
+    rescueIndex
+    isGenesis
+    name
+    wrapperTokenId
+    wrapperOwner {
+      id
+    }
+    #  @INCLUDES - lets you add more fields e.g. maxAdoptionPrice, askPrice,  etc.
+  }
+}
+GRAPHQL
+    query = query.gsub( '$first',              first.to_s )
+    query = query.gsub( '$last_rescue_index',  last_rescue_index.to_s )
+
+    data = query( query, includes: includes )
+    data['data']['cats']
+  end
+
+
+
+
+
+    #####
+    #  generic query via HTTP POST
+    def query( query, includes: [] )
+      if includes.size > 0
+        ## check for end-of-line comments with @INCLUDES marker
+         query = query.gsub( /[#]+[ ]+@INCLUDES[^\n\r]+/,
+                               includes.join( ' ' ) )
+      end
+
+      post( query: query )
+    end
+
+
+  end # class Client
+end # module GraphQL
+end # module Mooncats
+
+

data/lib/mooncats/graphql/version.rb

@@ -0,0 +1,22 @@
+
+module MooncatsClient
+
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "mooncats-graphql/#{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.dirname(__FILE__)))) )
+  end
+
+end # module MooncatsClient
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: mooncats-graphql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+description: mooncats-graphql - (lite) mooncats (http json) graphql api / client
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/mooncats-graphql.rb
+- lib/mooncats/graphql.rb
+- lib/mooncats/graphql/client.rb
+- lib/mooncats/graphql/query.rb
+- lib/mooncats/graphql/version.rb
+homepage: https://github.com/cryptocopycats/mooncats
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: mooncats-graphql - (lite) mooncats (http json) graphql api / client
+test_files: []