dune 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9a2988f9192b1f80fcecbb1044363e2c62838a9c75a3357ac66f62dc2218556
-  data.tar.gz: 62ca7157be56f75540a6a05cd4abdf69a90efe64e1a04e26d8c69deeccc3c856
+  metadata.gz: 4bbc650dd384fb869326503b247b1d3202eb2c0ac8a92ee6fa10fa967871cd2f
+  data.tar.gz: 1899809b39c3f68ae0cfef7e2b13e285e87a33fd9a66fc82bef2bd178e52a1c0
 SHA512:
-  metadata.gz: 1a718db979627349568b17b37eca835829a63fd2c6d6c44660261b10402c45c99c3a8e15c70e5e85d0c1fbf541a82c32d79ca2eea8831a60a0181589f9a74a5e
-  data.tar.gz: 66b14f9f6eed5bb65d1ceee20d74039c7c108e32a8f6831540e1a31f9d2d278e6ec3a4f9dc87ac16fcc67afb9faf5ee9b00ecc1d8c0930eec2b0ee9b1de04fc8
+  metadata.gz: 1632b6be1611b97e3f43d9e903b08d6676809a5dd33f429c70097e4813c77da1ed0dd6dcb1d53e3004b732d3661e104a322d095ad62cf94f0d015b7101714a0f
+  data.tar.gz: 88277ef5a9718aac522c6324fec4865f31644c0009274b2a83e6088f160ce0149a5dea1eb53834abb259e7b857bf20abed815fbca232ee5d24a794f97690ec76

data/README.md

@@ -2,4 +2,70 @@
 
 Welcome to the Ruby SDK of the [Dune Analytics API](https://dune.com/docs/api/)
 
+## Installation
 
+`dune` is available as a gem on [Rubygems](https://rubygems.org/) To install it, add it to your `Gemfile`
+
+```ruby
+source "https://rubygems.org"
+
+gem "dune"
+```
+
+## Usage
+
+To use the Dune API you'll need to request an API key. The Dune API is currently in private beta.
+
+**[Official API Documentation](https://dune.com/docs/api/)**
+
+#### Setting up the client
+
+The underlying HTTP client is [Faraday](https://lostisland.github.io/faraday/)
+
+Here's the properties that can be provided to the constructor
+
+| property           | required | description                                      |
+|--------------------|----------|--------------------------------------------------|
+| `api_key`          | true     | the API key                                      |
+| `faraday_settings` | false    | a hash provided to `Faraday.new`                 |
+| logger             | false    | an instance of Logger, defaults to a null logger |
+
+```ruby
+require "dune"
+
+dune = Dune::Client.new(api_key: ENV["DUNE_API_KEY"])
+dune.connection #=> returns a Faraday::Connection
+```
+
+#### Available methods
+
+All methods will return the parsed JSON response as a hash.
+
+Should the request fail the call will fail with a `Dune::Error` that contains the faraday `response` as a property
+
+```ruby
+dune = Dune::Client.new(api_key: ENV["DUNE_API_KEY"])
+
+# execute a query
+query_id          = 312527 # https://dune.com/queries/312527
+query_response    = dune.query(query_id) # calls POST /query/312527/execute
+
+# get status of a query
+dune.execution_status(query_response["execution_id"]) # calls GET /execution/312527/status
+
+# get the results of an execution
+dune.execution(query_response["execution_id"]) # calls GET/execution/312527/results
+
+# cancel an execution
+dune.cancel(query_response["execution_id"]) # calls POST /execution/312527/cancel
+```
+
+#### Supplying parameters
+
+Supplying parameters works by invoking the same `query` method. Make sure your query in Dune accepts parameters.
+
+```ruby
+dex_by_volume_query_id = 312527
+json = JSON.generate({ query_parameters: { grouping_parameter: 2 } })
+dune.query(dex_by_volume_query_id, json)
+```

data/lib/dune/client.rb

@@ -1,6 +1,6 @@
 class Dune
   class Client
-    attr_accessor :api_key, :connection
+    attr_accessor :api_key, :connection, :logger
 
     def initialize(api_key:, faraday_settings: {}, logger: Logger.new(IO::NULL))
       @api_key    = api_key
@@ -9,18 +9,22 @@ class Dune
     end
 
     def query(id, body = nil, headers = nil, &block)
+      logger.debug("#{self} #{__method__} with #{id}")
       parse(connection.post("query/#{id}/execute", body, headers, &block))
     end
 
     def execution_status(id, params = nil, headers = nil, &block)
+      logger.debug("#{self} #{__method__} with #{id}")
       parse(connection.get("execution/#{id}/status", params, headers, &block))
     end
 
     def execution(id, params = nil, headers = nil, &block)
+      logger.debug("#{self} #{__method__} with #{id}")
       parse(connection.get("execution/#{id}/results", params, headers, &block))
     end
 
     def cancel(id, params = nil, headers = nil, &block)
+      logger.debug("#{self} #{__method__} with #{id}")
       parse(connection.post("execution/#{id}/cancel", params, headers, &block))
     end
 
@@ -32,6 +36,7 @@ class Dune
       else
         error          = Dune::Error.new("Dune API replied with status #{response.status}")
         error.response = response
+        logger.error(error)
         raise error
       end
     end

data/lib/dune/version.rb

@@ -1,3 +1,3 @@
 class Dune
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dune
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - shellandbull
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-10 00:00:00.000000000 Z
+date: 2022-11-11 00:00:00.000000000 Z
 dependencies: []
 description:
 email: