kittyverse-graphql 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1172c42ad70884aad3a464f3cb142e7b5033996f477efcca5100b707dd2fbaed
+  data.tar.gz: f346ce7804f251265117be4cb0fcfa800410bd50062ac07d4c259dde58a607a7
+SHA512:
+  metadata.gz: d56e85fc96a07ca7aaa1fb0aedc51c7724418c312a18b5c8312c008e115215c749ed7c3120c07c6c420aca07aafa89660da69aaa0076583abafade6506fd8750
+  data.tar.gz: 662cd4e936a1eb80a26ead6a91ecfbbe84b8330738352c9a46cbfb598a4382fcbae0a2474228ff603c76e070d08df2b2e7ae97ca3b084d2e56e079cada1aa284

data/CHANGELOG.md

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

data/Manifest.txt

@@ -0,0 +1,8 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/kittyverse-graphql.rb
+lib/kittyverse/graphql.rb
+lib/kittyverse/graphql/query.rb
+lib/kittyverse/graphql/version.rb

data/README.md

@@ -0,0 +1,244 @@
+# Kittyverse GraphQL  (incl. CryptoKitties Sales GraphQL)
+
+
+kittyverse-graphql - web client (helpers) for using CryptoKitties (HTTP JSON) GraphQL APIs
+
+
+
+* home  :: [github.com/cryptocopycats/kittyverse](https://github.com/cryptocopycats/kittyverse)
+* bugs  :: [github.com/cryptocopycats/kittyverse/issues](https://github.com/cryptocopycats/kittyverse/issues)
+* gem   :: [rubygems.org/gems/kittyverse-graphql](https://rubygems.org/gems/kittyverse-graphql)
+* rdoc  :: [rubydoc.info/gems/kittyverse-graphql](http://rubydoc.info/gems/kittyverse-graphql)
+
+
+
+
+## Usage
+
+A lite web client wrapper for the CryptoKitties Sales open graph api
+powered by the Graph.
+See [**thegraph.com/explorer/subgraph/nieldlr/cryptokitties-sales »**](https://thegraph.com/explorer/subgraph/nieldlr/cryptokitties-sales).
+
+
+
+Example - Get the latest kitties sold in auctions:
+
+``` ruby
+require 'kittyverse/graphql'
+
+c = Kittyverse::GraphQL::Client.new
+
+data = c.query( <<GRAPHQL )
+{
+  auctions(first: 10,
+           orderBy: endedAt,
+           orderDirection: desc,
+           where: {state: "sold"})
+  {
+    state
+    soldPrice
+    startedAt
+    endedAt
+    winner
+    cryptoKitty {
+      id
+    }
+  }
+}
+GRAPHQL
+```
+
+
+resulting in:
+
+``` ruby
+{"data"=>
+  {"auctions"=>
+    [{"cryptoKitty"=>{"id"=>"411361"},
+      "endedAt"=>"1617784066",
+      "soldPrice"=>"5000000000000000",
+      "startedAt"=>"1559543782",
+      "state"=>"sold",
+      "winner"=>"0x201e269455d823b558ba11a2873779a7ea44b599"},
+     {"cryptoKitty"=>{"id"=>"537620"},
+      "endedAt"=>"1617783764",
+      "soldPrice"=>"6000000000000000",
+      "startedAt"=>"1519347485",
+      "state"=>"sold",
+      "winner"=>"0x776d795de3b4726422fea94f0529a570e05998c2"},
+     #...
+    ]
+  }
+}
+```
+
+Let's pretty print the auction data:
+
+``` ruby
+def wei_to_eth( wei )
+  wei_per_eth = 1_000_000_000_000_000_000   ## wei (10^18)
+  Float(wei) / Float(wei_per_eth)
+end
+
+def print_sales( recs )
+  puts "  price (in eth), price (in wei),  date,  kitty id,  winner\n"
+  recs.each do |rec|
+      print '%f eth  ' % wei_to_eth( rec['soldPrice'].to_i )
+      print '(%d wei)  ' % rec['soldPrice'].to_i
+      print  Time.at( rec['endedAt'].to_i ).utc
+      print "   "
+      print "##{rec['cryptoKitty']['id']}  "
+      print rec['winner']
+      print "\n"
+  end
+end
+
+print_sales( data['data']['auctions'] )
+```
+
+resulting in:
+
+```
+price (in eth), price (in wei),        date,                 kitty id,  winner
+0.005000 eth  (5000000000000000 wei)   2021-04-07 08:27:46   #411361    0x201e2694...
+0.006000 eth  (6000000000000000 wei)   2021-04-07 08:22:44   #537620    0x776d795d...
+0.005000 eth  (5000000000000000 wei)   2021-04-07 07:42:39   #1641139   0x776d795d...
+0.012539 eth  (12538972095383055 wei)  2021-04-07 07:19:45   #799099    0x48f3d916...
+0.012580 eth  (12579516235413496 wei)  2021-04-07 07:17:52   #1302761   0x48f3d916...
+0.005000 eth  (5000000000000000 wei)   2021-04-07 06:56:57   #405308    0x131b3957...
+0.009900 eth  (9900000000000000 wei)   2021-04-07 03:55:36   #1244187   0xfdf8f7e6...
+0.005000 eth  (5000000000000000 wei)   2021-04-07 03:55:25   #1470744   0xde0515ec...
+0.005000 eth  (5000000000000000 wei)   2021-04-07 03:36:25   #1815178   0xde0515ec...
+0.012586 eth  (12586110096397768 wei)  2021-04-07 03:08:55   #1348108   0x833b59ac...
+```
+
+
+Or let's query for the all-time high.
+Example - Get the most expensive kitties sold in auctions:
+
+
+``` ruby
+data = c.query( <<GRAPHQL )
+{
+  auctions(first: 10,
+           orderBy: soldPrice,
+           orderDirection: desc,
+           where: {state: "sold"})
+  {
+    state
+    soldPrice
+    endedAt
+    winner
+    cryptoKitty {
+      id
+    }
+  }
+}
+GRAPHQL
+```
+
+resulting in:
+
+``` ruby
+{"data"=>
+  {"auctions"=>
+    [{"cryptoKitty"=>{"id"=>"896775"},
+      "endedAt"=>"1536034886",
+      "soldPrice"=>"600000000000000000000",
+      "state"=>"sold",
+      "winner"=>"0x0e7afeee3a623decb71cf367e86191865ede6c5f"},
+     {"cryptoKitty"=>{"id"=>"18"},
+      "endedAt"=>"1512617298",
+      "soldPrice"=>"253336776620370370370",
+      "state"=>"sold",
+      "winner"=>"0xa6d3fdf423bbc578dd4d41220078475371626b22"},
+     #...
+     ]
+  }
+}
+```
+
+Let's pretty print the auction data (again):
+
+``` ruby
+print_sales( data['data']['auctions'] )
+```
+
+resulting in:
+
+```
+price (in eth), price (in wei),              date,                 kitty id,  winner
+600.000000 eth  (600000000000000000000 wei)  2018-09-04 04:21:26   #896775    0x0e7afeee...
+253.336777 eth  (253336776620370370370 wei)  2017-12-07 03:28:18   #18        0xa6d3fdf4...
+247.000000 eth  (247000000000000000000 wei)  2017-12-06 19:41:57   #4         0x61a4575d...
+246.925530 eth  (246925530478395061729 wei)  2017-12-02 20:32:36   #1         0x79bd5924...
+237.522840 eth  (237522839506172839507 wei)  2017-12-08 09:31:03   #21        0x58323a0b...
+225.000000 eth  (225000000000000000000 wei)  2017-12-08 09:34:36   #22        0x58323a0b...
+222.000000 eth  (222000000000000000000 wei)  2017-12-05 16:45:01   #5         0x69c94767...
+190.046825 eth  (190046825396825396825 wei)  2017-12-04 19:45:47   #7         0x2ff1e192...
+188.889654 eth  (188889654097222222223 wei)  2017-12-06 07:18:02   #35        0x7ca91be7...
+179.073438 eth  (179073437500000000000 wei)  2017-12-06 18:11:42   #87        0xc3003be6...
+```
+
+
+Or let's query for the aggregated totals.
+Example - Get the aggregated all-time auction totals:
+
+``` ruby
+data = c.query( <<GRAPHQL )
+{
+  aggregation(id: "1") {
+    totalAuctions
+    totalAuctionsSold
+    totalAuctionsCancelled
+    totalUniqueCryptoKittiesAuctioned
+    totalUniqueCryptoKittiesSold
+    totalEtherRevenue
+  }
+}
+GRAPHQL
+```
+
+resulting in:
+
+``` ruby
+{"data"=>
+  {"aggregation"=>
+    {"totalAuctions"=>"1162357",
+     "totalAuctionsCancelled"=>"251887",
+     "totalAuctionsSold"=>"724983",
+     "totalEtherRevenue"=>"63705844622899779521107",
+     "totalUniqueCryptoKittiesAuctioned"=>"807028",
+     "totalUniqueCryptoKittiesSold"=>"595308"}}}
+```
+
+And so on and so forth.
+
+
+
+
+## New to CryptoKitties?
+
+See the
+[**Programming CryptoKitties & Copycats Step-by-Step Booklet / Guide »**](https://github.com/cryptocopycats/programming-cryptokitties)
+
+
+
+
+## Install
+
+Just install the gem:
+
+    $ gem install kittyverse-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 [cryptokitties reddit](https://www.reddit.com/r/cryptokitties). Thanks.

data/Rakefile

@@ -0,0 +1,30 @@
+require 'hoe'
+require './lib/kittyverse/graphql/version.rb'
+
+Hoe.spec 'kittyverse-graphql' do
+
+  self.version = KittyverseGraphqlClient::VERSION
+
+  self.summary = "kittyverse-graphql - (lite) web client (helpers) for using CryptoKitties (HTTP JSON) GraphQL APIs"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/cryptocopycats/kittyverse' }
+
+  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'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end

data/lib/kittyverse-graphql.rb

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

data/lib/kittyverse/graphql.rb

@@ -0,0 +1,15 @@
+require 'webclient'
+
+
+
+## our own code
+require 'kittyverse/graphql/version'    # note: let version always go first
+require 'kittyverse/graphql/query'
+
+
+
+
+# say hello
+puts KittyverseGraphqlClient.banner
+
+

data/lib/kittyverse/graphql/query.rb

@@ -0,0 +1,34 @@
+
+module Kittyverse
+module GraphQL
+
+  class Client
+
+
+    #####
+    #  generic query via HTTP POST
+    BASE_URL = 'https://api.thegraph.com/subgraphs/name/nieldlr/cryptokitties-sales'
+
+    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
+
+      res = Webclient.post( BASE_URL, json: {
+                                        query: query } )
+
+      if res.status.nok?   ## e.g. != 200
+        puts "!! ERROR: HTTP #{res.status.code} #{res.status.message}:"
+        pp res.raw ## note: dump inner (raw) response (NOT the wrapped)
+        exit 1
+      end
+
+      res.json  ## return body (utf-8 enconded text) parsed as json
+    end
+  end # class Client
+end # module GraphQL
+end # module Kittyverse
+
+

data/lib/kittyverse/graphql/version.rb

@@ -0,0 +1,22 @@
+
+module KittyverseGraphqlClient
+
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "kittyverse-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 KittyverseGraphqlClient
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: kittyverse-graphql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webclient
+  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
+    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: kittyverse-graphql - (lite) web client (helpers) for using CryptoKitties
+  (HTTP JSON) GraphQL APIs
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/kittyverse-graphql.rb
+- lib/kittyverse/graphql.rb
+- lib/kittyverse/graphql/query.rb
+- lib/kittyverse/graphql/version.rb
+homepage: https://github.com/cryptocopycats/kittyverse
+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: kittyverse-graphql - (lite) web client (helpers) for using CryptoKitties
+  (HTTP JSON) GraphQL APIs
+test_files: []