readwhitepaper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bfa6b799eaef4e5a86a4ca4525f37b815cc9c28fd1542f32b64cb762b254a4a
+  data.tar.gz: 4ba87c616663bb14273c7fc4ca354004334884665fcb5c8c74b611c8fd79958e
+SHA512:
+  metadata.gz: 46c032496af8c6a4f4a34c1a30e1788e08b5357f7ea336f2620558ce275b42e55e3be0914989b3f90f454a83e7bbc3991ccfaaaca1e746ea96674f15bdfc91a8
+  data.tar.gz: b2d1c580aa7d5202872c17cf54b25cb09f0811ca386dac3f479a31f4127a989bdcc21204e5945ece0311a258da1852bfe54a58e6199a0b2bdfe857f60beeb40a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dobestan
+
+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 @@
+# readwhitepaper
+
+[![Gem Version](https://badge.fury.io/rb/readwhitepaper.svg)](https://rubygems.org/gems/readwhitepaper)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Zero Dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)](https://rubygems.org/gems/readwhitepaper)
+
+Ruby client for the [ReadWhitepaper](https://readwhitepaper.com) API — a blockchain whitepaper database hosting 30 cryptocurrency whitepapers with section-level content, 163 glossary terms, full-text search, and 3,458 translations across 15 languages. Zero dependencies, uses only `net/http`.
+
+> **Explore the whitepapers at [readwhitepaper.com](https://readwhitepaper.com)** — [Bitcoin Whitepaper](https://readwhitepaper.com/bitcoin/), [Ethereum Whitepaper](https://readwhitepaper.com/ethereum/), [API Docs](https://readwhitepaper.com/developers/)
+
+## Install
+
+```bash
+gem install readwhitepaper
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "readwhitepaper"
+```
+
+## Quick Start
+
+```ruby
+require "readwhitepaper"
+
+# Initialize the client — no API key needed
+client = ReadWhitepaper::Client.new
+
+# List all 30 cryptocurrency whitepapers
+whitepapers = client.list_whitepapers
+whitepapers["results"].each do |wp|
+  puts "#{wp['crypto']['ticker']} — #{wp['authors'].first} (#{wp['year']})"
+  # BTC — Satoshi Nakamoto (2008)
+  # ETH — Vitalik Buterin (2013)
+end
+
+# Read Bitcoin's whitepaper section by section
+bitcoin = client.get_whitepaper("bitcoin")
+bitcoin["sections"].each do |section|
+  puts "§#{section['section_number']}: #{section['heading_text']}"
+end
+
+# Search across all whitepapers
+results = client.search("proof of work")
+results.each do |r|
+  puts "#{r['slug']} — #{r['heading']}: #{r['snippet']}"
+end
+
+# Get the blockchain glossary
+glossary = client.list_glossary(limit: 5)
+glossary["results"].each do |term|
+  puts "#{term['term']} [#{term['category']}] — appears #{term['occurrence_count']}x"
+end
+```
+
+## What You'll Find on ReadWhitepaper
+
+ReadWhitepaper hosts the foundational documents of 30 major cryptocurrencies. A cryptocurrency whitepaper is the primary technical document describing a blockchain protocol's design, consensus mechanism, and economic model. The tradition began with Satoshi Nakamoto's 2008 Bitcoin whitepaper.
+
+| Rank | Ticker | Author(s) | Year | Sections |
+|------|--------|-----------|------|----------|
+| 1 | BTC | Satoshi Nakamoto | 2008 | 14 |
+| 2 | ETH | Vitalik Buterin | 2013 | 23 |
+| 3 | USDT | J.R. Willett | 2016 | 10 |
+| 4 | XRP | D. Schwartz, N. Youngs, A. Britto | 2014 | 11 |
+| 5 | SOL | Anatoly Yakovenko | 2017 | 12 |
+
+163 blockchain glossary terms across 12 categories, 15-language translations with 3,458 individual translations, and a whitepaper relationship graph.
+
+## API Methods
+
+| Method | Description |
+|--------|-------------|
+| `list_whitepapers(limit:, page:, language:)` | List all 30 whitepapers |
+| `get_whitepaper(slug, language:)` | Get whitepaper detail with sections |
+| `get_sections(slug, language:)` | Get sections only |
+| `get_toc(slug, language:)` | Get table of contents |
+| `get_coverage(slug)` | Get translation coverage |
+| `list_glossary(limit:, page:, language:)` | List 163 glossary terms |
+| `get_glossary_term(slug, language:)` | Get term detail |
+| `search(query, slug:, language:)` | Full-text search |
+| `get_stats` | Platform statistics |
+| `get_languages` | Supported languages |
+| `get_graph` | Relationship graph |
+
+## Learn More About Blockchain Whitepapers
+
+- **Read**: [Bitcoin Whitepaper](https://readwhitepaper.com/bitcoin/) . [Ethereum Whitepaper](https://readwhitepaper.com/ethereum/) . [All Whitepapers](https://readwhitepaper.com/)
+- **Explore**: [Blockchain Glossary](https://readwhitepaper.com/glossary/) . [Whitepaper Graph](https://readwhitepaper.com/graph/)
+- **API**: [REST API Docs](https://readwhitepaper.com/developers/)
+
+## Also Available
+
+| Platform | Package | Install |
+|----------|---------|---------|
+| **PyPI** | [readwhitepaper](https://pypi.org/project/readwhitepaper/) | `pip install readwhitepaper` |
+| **npm** | [readwhitepaper](https://www.npmjs.com/package/readwhitepaper) | `npm install readwhitepaper` |
+| **Go** | [readwhitepaper-go](https://github.com/dobestan/readwhitepaper-go) | `go get github.com/dobestan/readwhitepaper-go` |
+| **Rust** | [readwhitepaper](https://crates.io/crates/readwhitepaper) | `cargo add readwhitepaper` |
+
+## License
+
+MIT

data/lib/readwhitepaper/client.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+module ReadWhitepaper
+  # Client for the ReadWhitepaper blockchain whitepaper API.
+  #
+  # Provides access to 30 cryptocurrency whitepapers, 163 glossary terms,
+  # full-text search, and 15-language translations. Zero dependencies.
+  #
+  # @example
+  #   client = ReadWhitepaper::Client.new
+  #   whitepapers = client.list_whitepapers
+  #   bitcoin = client.get_whitepaper("bitcoin")
+  #   results = client.search("proof of work")
+  class Client
+    DEFAULT_BASE_URL = "https://readwhitepaper.com/api"
+    DEFAULT_TIMEOUT = 30
+
+    # @param base_url [String] API base URL
+    # @param language [String] Default language code
+    # @param timeout [Integer] Request timeout in seconds
+    def initialize(base_url: DEFAULT_BASE_URL, language: "en", timeout: DEFAULT_TIMEOUT)
+      @base_url = base_url.chomp("/")
+      @language = language
+      @timeout = timeout
+    end
+
+    # ── Whitepapers ──────────────────────────────────────────
+
+    # List all whitepapers with optional pagination.
+    # @param limit [Integer, nil] Number of results per page
+    # @param page [Integer, nil] Page number
+    # @param language [String, nil] Language code
+    # @return [Hash] Paginated response with :count, :next, :previous, :results
+    def list_whitepapers(limit: nil, page: nil, language: nil)
+      params = { language: language || @language }
+      params[:limit] = limit if limit
+      params[:page] = page if page
+      request("/whitepapers/", params)
+    end
+
+    # Get full whitepaper detail with all sections.
+    # @param slug [String] Whitepaper slug (e.g. "bitcoin", "ethereum")
+    # @param language [String, nil] Language code
+    # @return [Hash] Whitepaper detail with sections
+    def get_whitepaper(slug, language: nil)
+      request("/whitepapers/#{slug}/", { language: language || @language })
+    end
+
+    # Get whitepaper sections.
+    # @param slug [String] Whitepaper slug
+    # @param language [String, nil] Language code
+    # @return [Array<Hash>] List of sections
+    def get_sections(slug, language: nil)
+      request("/whitepapers/#{slug}/sections/", { language: language || @language })
+    end
+
+    # Get table of contents for a whitepaper.
+    # @param slug [String] Whitepaper slug
+    # @param language [String, nil] Language code
+    # @return [Array<Hash>] TOC entries
+    def get_toc(slug, language: nil)
+      data = request("/whitepapers/#{slug}/toc/", { language: language || @language })
+      data["toc"]
+    end
+
+    # Get translation coverage for a whitepaper.
+    # @param slug [String] Whitepaper slug
+    # @return [Hash] Coverage data with per-language completion
+    def get_coverage(slug)
+      request("/whitepapers/#{slug}/coverage/")
+    end
+
+    # ── Glossary ─────────────────────────────────────────────
+
+    # List blockchain glossary terms with pagination.
+    # @param limit [Integer, nil] Number of results per page
+    # @param page [Integer, nil] Page number
+    # @param language [String, nil] Language code
+    # @return [Hash] Paginated response
+    def list_glossary(limit: nil, page: nil, language: nil)
+      params = { language: language || @language }
+      params[:limit] = limit if limit
+      params[:page] = page if page
+      request("/glossary/", params)
+    end
+
+    # Get a single glossary term by slug.
+    # @param slug [String] Term slug (e.g. "blockchain", "consensus")
+    # @param language [String, nil] Language code
+    # @return [Hash] Glossary term with definition
+    def get_glossary_term(slug, language: nil)
+      request("/glossary/#{slug}/", { language: language || @language })
+    end
+
+    # ── Search ───────────────────────────────────────────────
+
+    # Full-text search across all whitepapers.
+    # @param query [String] Search query
+    # @param slug [String, nil] Limit to specific whitepaper
+    # @param language [String, nil] Language code
+    # @return [Array<Hash>] Search results with snippets
+    def search(query, slug: nil, language: nil)
+      params = { q: query, language: language || @language }
+      params[:slug] = slug if slug
+      data = request("/search/", params)
+      data["results"]
+    end
+
+    # ── Stats / Languages / Graph ────────────────────────────
+
+    # Get platform statistics.
+    # @return [Hash] Stats including counts and per-whitepaper data
+    def get_stats
+      request("/stats/")
+    end
+
+    # Get all supported languages.
+    # @return [Array<Hash>] Languages with code, name, direction
+    def get_languages
+      data = request("/languages/")
+      data.is_a?(Array) ? data : data["results"]
+    end
+
+    # Get the whitepaper relationship graph.
+    # @return [Hash] Graph with :nodes and :edges
+    def get_graph
+      request("/graph/")
+    end
+
+    private
+
+    def request(path, params = {})
+      uri = URI("#{@base_url}#{path}")
+      filtered = params.compact
+      uri.query = URI.encode_www_form(filtered) unless filtered.empty?
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+
+      req = Net::HTTP::Get.new(uri)
+      req["Accept"] = "application/json"
+      req["User-Agent"] = "readwhitepaper-rb/#{VERSION}"
+
+      response = http.request(req)
+
+      unless response.is_a?(Net::HTTPSuccess)
+        body = response.body.to_s[0, 200]
+        raise APIError.new(
+          "HTTP #{response.code}: #{body}",
+          status_code: response.code.to_i
+        )
+      end
+
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/readwhitepaper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# ReadWhitepaper — Ruby client for the blockchain whitepaper database API.
+#
+# 30 cryptocurrency whitepapers, 163 glossary terms,
+# 3,458 translations across 15 languages.
+#
+# @example
+#   client = ReadWhitepaper::Client.new
+#   whitepapers = client.list_whitepapers
+#   bitcoin = client.get_whitepaper("bitcoin")
+
+require_relative "readwhitepaper/client"
+
+module ReadWhitepaper
+  VERSION = "0.1.0"
+
+  # Base error class for ReadWhitepaper API errors.
+  class Error < StandardError; end
+
+  # Raised when the API returns an error status code.
+  class APIError < Error
+    attr_reader :status_code
+
+    def initialize(message, status_code: nil)
+      @status_code = status_code
+      super(message)
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: readwhitepaper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dobestan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-29 00:00:00.000000000 Z
+dependencies: []
+description: Ruby client for the ReadWhitepaper API — 30 cryptocurrency whitepapers
+  with section-level content, 163 glossary terms, full-text search, and 3,458 translations
+  across 15 languages. Zero dependencies.
+email:
+- dobestan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/readwhitepaper.rb
+- lib/readwhitepaper/client.rb
+homepage: https://readwhitepaper.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://readwhitepaper.com
+  source_code_uri: https://github.com/dobestan/readwhitepaper-rb
+  documentation_uri: https://readwhitepaper.com/developers/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for ReadWhitepaper — blockchain whitepaper database
+test_files: []