beaconcha 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38bda97ce7fea8fe8440d0adfa3f33a4c12203ceeaabff5f11c4ed7c5bb81e6c
+  data.tar.gz: ea23d6c39c05093a919ae7109e4de01c8337887c5fb684ac058d17d7c446501e
+SHA512:
+  metadata.gz: 6ad1e5be6f6303f86bae0eae122e0fa6e9f43f272b5b9039ce079a04f2274c50a651095a1e6c5e7282a02d2d8362255b53bccbf3290ad5fa91373b150eb93353
+  data.tar.gz: fd55204bb2ae65dd053fc1fcdb5bbfacdc61cfda3d89e7ff00158583d7cf7c38bc862d2891b9afb494b539727806312c90e1cc1dc9ff73e4f1ff4180fac768a8

data/.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2.1 # Use 2.1 to enable using orbs and other features.
+
+# Declare the orbs that we'll use in our config.
+orbs:
+  ruby: circleci/ruby@1.0
+
+jobs:
+  rubocop:
+    parallelism: 1
+    docker:
+      - image: cimg/ruby:3.1-node
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      ruby-image:
+        type: string
+    parallelism: 1
+    docker:
+      - image: << parameters.ruby-image >>
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run tests
+          command: bundle exec rspec -fd
+
+workflows:
+  version: 2
+  checks:
+    jobs:
+      - rubocop
+      - test:
+          matrix:
+            parameters:
+              ruby-image:
+                - cimg/ruby:2.6-node
+                - cimg/ruby:2.7-node
+                - cimg/ruby:3.0-node
+                - cimg/ruby:3.1-node
+                - cimg/ruby:3.2-node

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: webmock
+    versions:
+    - 3.11.1
+    - 3.11.3
+  - dependency-name: rspec
+    versions:
+    - 3.10.0

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+.env
+
+*.gem
+*.ruby-*
+.envrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "**/*.gemspec"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [1.0.0]
+
+### Added
+
+- Initialise repository.
+- Add Beaconcha::Client to connect to Beaconcha API using user credentials.
+- Add spec for Client with a cached response using VCR.
+- Add CircleCI to run the specs on pull requests.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liuliang@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/liuliang/beaconcha. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/liuliang/beaconcha/blob/main/CODE_OF_CONDUCT.md).

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Include gem dependencies from beaconcha.gemspec
+gemspec
+
+gem "byebug", "~> 11.1.3"
+gem "dotenv", "~> 2.8.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.47.0"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    beaconcha (1.0.0)
+      httparty (>= 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.47.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.12.0)
+    unicode-display_width (2.4.2)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  beaconcha!
+  byebug (~> 11.1.3)
+  dotenv (~> 2.8.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.47.0)
+  vcr (~> 6.1.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alex
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# Ruby Beaconcha
+
+[![Gem Version](https://badge.fury.io/rb/beaconcha.svg)](https://badge.fury.io/rb/beaconcha)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/liuliang/beaconcha/blob/main/LICENSE.txt)
+[![CircleCI Build Status](https://circleci.com/gh/liuliang/beaconcha.svg?style=shield)](https://circleci.com/gh/liuliang/beaconcha)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/maintainability)](https://codeclimate.com/github/codeclimate/codeclimate/maintainability)
+
+Use the [Beaconcha API](https://beaconcha.in/api/v1/docs/index.html) with Ruby! 
+
+## Installation
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+    gem "beaconcha"
+```
+
+And then execute:
+
+$ bundle install
+
+### Gem install
+
+Or install with:
+
+$ gem install beaconcha
+
+and require with:
+
+```ruby
+    require "beaconcha"
+```
+
+## Usage
+
+- Get your API key from [https://beaconcha.in/user/settings#api](https://beaconcha.in/user/settings#api)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+    client = Beaconcha::Client.new(api_key: "api_key_goes_here", uri_base: "https://beaconcha.in")
+```
+
+### With Config
+
+For a more robust setup, you can configure the gem with your API keys, for example in an `beaconcha.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
+
+```ruby
+    Beaconcha.configure do |config|
+        config.api_key = ENV.fetch('BEACONCHA_API_KEY')
+        config.uri_base = ENV.fetch('BEACONCHA_URI_BASE')
+    end
+```
+
+Then you can create a client like this:
+
+```ruby
+    client = Beaconcha::Client.new
+```
+
+### Example
+
+```ruby
+    client.epoch.retrieve(id: 10000)
+    client.eth_store.retrieve(day: "latest")
+    client.execution.eth1deposit(txhash: "xxxx")
+    client.execution.produced(id: "xxxx", limit: 1, offset: 1)
+    client.misc.healthz
+    client.rocketpool.stats
+    client.slot.retrieve(id: "xxxx")
+    client.sync_committee.retrieve(period: "xxxx")
+    client.validator.retrieve(id: "xxxx")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Release
+
+First run the specs without VCR so they actually hit the API. This will cost about 2 cents. You'll need to add your `BEACONCHA_API_KEY=` in `.env`.
+
+```
+  NO_VCR=true bundle exec rspec
+```
+
+Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/liuliang/beaconcha>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/liuliang/beaconcha/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby Beaconcha project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/liuliang/beaconcha/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/beaconcha.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/beaconcha/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "beaconcha"
+  spec.version       = Beaconcha::VERSION
+  spec.authors       = ["liuliang"]
+  spec.email         = ["liuliang@users.noreply.github.com"]
+
+  spec.summary       = "A Ruby gem for the Beaconcha  API"
+  spec.homepage      = "https://github.com/liuliang/beaconcha"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/liuliang/beaconcha"
+  spec.metadata["changelog_uri"] = "https://github.com/liuliang/beaconcha/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", ">= 0.18.1"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "beaconcha"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/beaconcha/client.rb

@@ -0,0 +1,79 @@
+module Beaconcha
+  class Client
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def epoch
+      @epoch ||= Beaconcha::Epoch.new
+    end
+
+    def slot
+      @slot ||= Beaconcha::Slot.new
+    end
+
+    def validator
+      @validator ||= Beaconcha::Validator.new
+    end
+
+    def sync_committee
+      @sync_committee ||= Beaconcha::SyncCommittee.new
+    end
+
+    def execution
+      @execution ||= Beaconcha::Execution.new
+    end
+
+    def eth_store
+      @eth_store ||= Beaconcha::EthStore.new
+    end
+
+    def misc
+      @misc ||= Beaconcha::Misc.new
+    end
+
+    def rocketpool
+      @rocketpool ||= Beaconcha::Rocketpool.new
+    end
+
+    def self.get(path:, query: {})
+      HTTParty.get(
+        uri(path: path),
+        query: query&.compact,
+        headers: headers
+      )
+    end
+
+    def self.get_without_version(path:, query: {})
+      HTTParty.get(
+        uri_without_version(path: path),
+        query: query&.compact,
+        headers: headers
+      )
+    end
+
+    def self.post(path:, parameters:)
+      HTTParty.post(
+        uri(path: path),
+        headers: headers,
+        body: parameters&.compact&.to_json
+      )
+    end
+
+    private_class_method def self.uri(path:)
+      "#{Beaconcha.configuration.uri_base}/api/#{Beaconcha.configuration.api_version}#{path}"
+    end
+
+    private_class_method def self.uri_without_version(path:)
+      "#{Beaconcha.configuration.uri_base}/api#{path}"
+    end
+
+    private_class_method def self.headers
+      {
+        "Content-Type" => "application/json",
+        "apikey" => Beaconcha.configuration.api_key.to_s
+      }
+    end
+  end
+end

data/lib/beaconcha/epoch.rb

@@ -0,0 +1,16 @@
+module Beaconcha
+  class Epoch
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def retrieve(id:)
+      Beaconcha::Client.get(path: "/epoch/#{id}")
+    end
+
+    def slots(id:)
+      Beaconcha::Client.get(path: "/epoch/#{id}/slots")
+    end
+  end
+end

data/lib/beaconcha/eth_store.rb

@@ -0,0 +1,12 @@
+module Beaconcha
+  class EthStore
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def retrieve(day:)
+      Beaconcha::Client.get(path: "/ethstore/#{day}")
+    end
+  end
+end

data/lib/beaconcha/execution.rb

@@ -0,0 +1,29 @@
+module Beaconcha
+  class Execution
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def eth1deposit(txhash:)
+      Beaconcha::Client.get(path: "/eth1deposit/#{txhash}")
+    end
+
+    def address(address:, token: nil)
+      Beaconcha::Client.get(path: "/execution/address/#{address}", query: { token: token })
+    end
+
+    def block(block_number:)
+      Beaconcha::Client.get(path: "/execution/block/#{block_number}")
+    end
+
+    def gasnow
+      Beaconcha::Client.get(path: "/execution/gasnow")
+    end
+
+    def produced(id:, limit: nil, offset: nil)
+      Beaconcha::Client.get(path: "/execution/#{id}/produced",
+                            query: { limit: limit, offset: offset })
+    end
+  end
+end

data/lib/beaconcha/misc.rb

@@ -0,0 +1,24 @@
+module Beaconcha
+  class Misc
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def healthz
+      Beaconcha::Client.get_without_version(path: "/healthz")
+    end
+
+    def healthz_loadbalancer
+      Beaconcha::Client.get_without_version(path: "/healthz-loadbalancer")
+    end
+
+    def chart(chart:)
+      Beaconcha::Client.get(path: "/chart/#{chart}")
+    end
+
+    def graffitiwall(slot: nil)
+      Beaconcha::Client.get(path: "/graffitiwall", query: { slot: slot })
+    end
+  end
+end

data/lib/beaconcha/rocketpool.rb

@@ -0,0 +1,16 @@
+module Beaconcha
+  class Rocketpool
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def validator(id:)
+      Beaconcha::Client.get(path: "/rocketpool/validator/#{id}")
+    end
+
+    def stats
+      Beaconcha::Client.get(path: "/rocketpool/stats")
+    end
+  end
+end

data/lib/beaconcha/slot.rb

@@ -0,0 +1,32 @@
+module Beaconcha
+  class Slot
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def retrieve(id:)
+      Beaconcha::Client.get(path: "/slot/#{id}")
+    end
+
+    def attestations(id:)
+      Beaconcha::Client.get(path: "/slot/#{id}/attestations")
+    end
+
+    def attesterslashings(id:)
+      Beaconcha::Client.get(path: "/slot/#{id}/attesterslashings")
+    end
+
+    def deposits(id:)
+      Beaconcha::Client.get(path: "/slot/#{id}/deposits")
+    end
+
+    def proposerslashings(id:)
+      Beaconcha::Client.get(path: "/slot/#{id}/proposerslashings")
+    end
+
+    def voluntaryexits(id:)
+      Beaconcha::Client.get(path: "/slot/#{id}/voluntaryexits")
+    end
+  end
+end

data/lib/beaconcha/sync_committee.rb

@@ -0,0 +1,12 @@
+module Beaconcha
+  class SyncCommittee
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def retrieve(period:)
+      Beaconcha::Client.get(path: "/sync_committee/#{period}")
+    end
+  end
+end

data/lib/beaconcha/validator.rb

@@ -0,0 +1,67 @@
+module Beaconcha
+  class Validator
+    def initialize(api_key: nil, uri_base: nil)
+      Beaconcha.configuration.api_key = api_key if api_key
+      Beaconcha.configuration.uri_base = uri_base if uri_base
+    end
+
+    def eth1(address:, limit: nil, offset: nil)
+      Beaconcha::Client.get(path: "/validator/eth1/#{address}",
+                            query: { limit: limit, offset: offset })
+    end
+
+    def leaderboard
+      Beaconcha::Client.get(path: "/validator/leaderboard")
+    end
+
+    def stats(id:)
+      Beaconcha::Client.get(path: "/validator/stats/#{id}")
+    end
+
+    def retrieve(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}")
+    end
+
+    def attestationeffectiveness(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/attestationeffectiveness")
+    end
+
+    def attestationefficiency(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/attestationefficiency")
+    end
+
+    def attestations(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/attestations")
+    end
+
+    def balancehistory(id:, latest_epoch: nil, limit: nil, offset: nil)
+      Beaconcha::Client.get(path: "/validator/#{id}/balancehistory",
+                            query: { latest_epoch: latest_epoch,
+                                     limit: limit, offset: offset })
+    end
+
+    def deposits(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/deposits")
+    end
+
+    def execution_performance(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/execution/performance")
+    end
+
+    def incomedetailhistory(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/incomedetailhistory")
+    end
+
+    def performance(id:)
+      Beaconcha::Client.get(path: "/validator/#{id}/performance")
+    end
+
+    def proposals(id:, epoch: nil)
+      Beaconcha::Client.get(path: "/validator/#{id}/proposals", query: { epoch: epoch })
+    end
+
+    def queue
+      Beaconcha::Client.get(path: "/validators/queue")
+    end
+  end
+end

data/lib/beaconcha/version.rb

@@ -0,0 +1,3 @@
+module Beaconcha
+  VERSION = "1.0.0".freeze
+end

data/lib/beaconcha.rb

@@ -0,0 +1,53 @@
+require "httparty"
+
+require_relative "beaconcha/client"
+require_relative "beaconcha/epoch"
+require_relative "beaconcha/slot"
+require_relative "beaconcha/validator"
+require_relative "beaconcha/sync_committee"
+require_relative "beaconcha/execution"
+require_relative "beaconcha/eth_store"
+require_relative "beaconcha/rocketpool"
+require_relative "beaconcha/misc"
+require_relative "beaconcha/version"
+
+module Beaconcha
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :api_key, :uri_base
+    attr_accessor :api_version
+
+    DEFAULT_API_VERSION = "v1".freeze
+
+    def initialize
+      @api_key = nil
+      @api_version = DEFAULT_API_VERSION
+      @uri_base = nil
+    end
+
+    def api_key
+      @api_key
+    end
+
+    def uri_base
+      return @uri_base if @uri_base
+
+      error_text = "Beaconcha uri base missing! See https://github.com/liuliang/beaconcha#usage"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Beaconcha::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: beaconcha
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- liuliang
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description:
+email:
+- liuliang@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- beaconcha.gemspec
+- bin/console
+- bin/setup
+- lib/beaconcha.rb
+- lib/beaconcha/client.rb
+- lib/beaconcha/epoch.rb
+- lib/beaconcha/eth_store.rb
+- lib/beaconcha/execution.rb
+- lib/beaconcha/misc.rb
+- lib/beaconcha/rocketpool.rb
+- lib/beaconcha/slot.rb
+- lib/beaconcha/sync_committee.rb
+- lib/beaconcha/validator.rb
+- lib/beaconcha/version.rb
+homepage: https://github.com/liuliang/beaconcha
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/liuliang/beaconcha
+  source_code_uri: https://github.com/liuliang/beaconcha
+  changelog_uri: https://github.com/liuliang/beaconcha/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: A Ruby gem for the Beaconcha  API
+test_files: []