cryptologo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75211d3891b83a244b6ae5858315bd04aff1998321e57d77051c547798649238
+  data.tar.gz: a2ff5b4633c8672348b7407110c3ff29aef53adec4851b9d8c16179439595b12
+SHA512:
+  metadata.gz: 11ef2e7ac9585c1c45dda8fda18f299b22a248c83eb3345b54b99e6a4507991cd6180dc370b954e1e287698bfe0234b4b8d3c6638e9d14fa4267a4e4976470be
+  data.tar.gz: 80d447e1d4b3a6b2f8c02e5a89fb8d35e7e0c41c96dbee64eb5b7e379b9d2aaab9a16f3906c9a16535fbd1549b9ea08ac4420a97c6e4a8071186793456c64c79

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,134 @@
+# cryptologo
+
+[![Gem Version](https://badge.fury.io/rb/cryptologo.svg)](https://rubygems.org/gems/cryptologo)
+[![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/cryptologo)
+
+Ruby client for [crypto-logo.com](https://crypto-logo.com) — the cryptocurrency logo database with 413 coins in SVG, PNG, WebP, JPEG, and ICO formats. Zero external dependencies (stdlib `net/http` only).
+
+Every logo is available as a scalable SVG vector and pre-generated raster derivatives in 13 standard sizes (16px to 2000px). Logos are served from Cloudflare R2 CDN with immutable cache headers.
+
+> **Browse logos at [crypto-logo.com](https://crypto-logo.com)** — [API docs](https://crypto-logo.com/api/docs/)
+
+## Install
+
+```bash
+gem install cryptologo
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "cryptologo"
+```
+
+## Quick Start
+
+```ruby
+require "cryptologo"
+
+client = CryptoLogo::Client.new
+
+# List all 413 coins sorted by market cap
+coins = client.list_coins
+coins.first(3).each do |coin|
+  puts "#{coin.name} (#{coin.ticker}) — rank ##{coin.market_cap_rank}"
+end
+
+# Download Bitcoin SVG logo
+client.download_logo("bitcoin-btc", "svg", "bitcoin.svg")
+
+# Generate CDN URL for embedding
+url = client.get_cdn_url("ethereum-eth", "webp", 128)
+# https://cdn.crypto-logo.com/logos/ethereum-eth/128x128/transparent.webp
+```
+
+## What You Can Do
+
+### List Coins
+
+```ruby
+coins = client.list_coins
+
+# Filter coins with SVG logos
+svg_coins = coins.select(&:has_svg)
+puts "#{svg_coins.length} coins have SVG logos"
+
+# Find by ticker
+btc = coins.find { |c| c.ticker == "BTC" }
+puts "#{btc.name}: rank ##{btc.market_cap_rank}"
+```
+
+### Fetch Logos
+
+```ruby
+# SVG vector (no size needed)
+svg = client.get_logo("bitcoin-btc", "svg")
+
+# PNG at 256x256
+png = client.get_logo("bitcoin-btc", "png", width: 256)
+
+# OG image with white background
+og = client.get_logo("bitcoin-btc", "png", width: 1200, height: 630, bg: "FFFFFF")
+
+# Save to file
+client.download_logo("ethereum-eth", "png", "eth.png", width: 512)
+```
+
+### CDN URLs
+
+```ruby
+# CDN URL for fast display (recommended for HTML img tags)
+url = client.get_cdn_url("bitcoin-btc", "webp", 128)
+# https://cdn.crypto-logo.com/logos/bitcoin-btc/128x128/transparent.webp
+
+# API URL for downloads
+url = client.get_logo_url("bitcoin-btc", "png", width: 512)
+# https://crypto-logo.com/api/logo/bitcoin-btc.png?w=512&h=512
+```
+
+### Variants and History
+
+```ruby
+# Get a logo variant (alternate design)
+full_logo = client.get_asset("versions/bitcoin-btc-full.svg")
+
+# Get a historical logo
+old_logo = client.get_asset("history/bitcoin-btc-2009.png")
+```
+
+## Cryptocurrency Logo Standards
+
+| Use Case | Format | Size |
+|----------|--------|------|
+| Website UI | SVG | Scalable |
+| Exchange listing | PNG | 512x512 |
+| Mobile icon | PNG | 128-256px |
+| Social/OG | PNG | 1200x630 |
+| Favicon | ICO/SVG | 32x32 |
+
+Pre-generated sizes: 16, 32, 48, 64, 96, 120, 128, 200, 256, 400, 512, 1024, 2000.
+
+## API Reference
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `list_coins` | `Array<Coin>` | All 413 coins |
+| `get_logo(slug, fmt, **opts)` | `String` | Logo bytes |
+| `get_logo_url(slug, fmt, **opts)` | `String` | API URL |
+| `get_cdn_url(slug, fmt, width)` | `String` | CDN URL |
+| `download_logo(slug, fmt, dest, **opts)` | `String` | Save to file |
+| `get_asset(path)` | `String` | Variant/history |
+
+## Also Available
+
+| Platform | Package | Install |
+|----------|---------|---------|
+| **PyPI** | [cryptologo](https://pypi.org/project/cryptologo/) | `pip install cryptologo` |
+| **npm** | [cryptologo](https://www.npmjs.com/package/cryptologo) | `npm install cryptologo` |
+| **Go** | [cryptologo-go](https://github.com/dobestan/cryptologo-go) | `go get github.com/dobestan/cryptologo-go` |
+| **Rust** | [cryptologo](https://crates.io/crates/cryptologo) | `cargo add cryptologo` |
+
+## License
+
+MIT

data/lib/cryptologo/client.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+module CryptoLogo
+  # Client for the crypto-logo.com API.
+  #
+  # Provides methods to list coins, fetch logos, generate logo URLs,
+  # and download logo files. No API key required.
+  #
+  # @example
+  #   client = CryptoLogo::Client.new
+  #   coins = client.list_coins
+  #   svg = client.get_logo("bitcoin-btc", "svg")
+  #   client.download_logo("ethereum-eth", "png", "eth.png", width: 512)
+  class Client
+    USER_AGENT = "cryptologo-rb/#{VERSION}"
+
+    # @param base_url [String] API base URL
+    # @param timeout [Integer] Request timeout in seconds
+    def initialize(base_url: DEFAULT_BASE_URL, timeout: 30)
+      @base_url = base_url.chomp("/")
+      @timeout = timeout
+    end
+
+    # Fetch all active coins from the API.
+    #
+    # @return [Array<Coin>] coins sorted by market cap rank
+    #
+    # @example
+    #   coins = client.list_coins
+    #   coins.first(3).each { |c| puts "#{c.name} (#{c.ticker})" }
+    def list_coins
+      data = get_json("/api/coins.json")
+      data.map { |item| Coin.from_hash(item) }
+    end
+
+    # Fetch logo image bytes from the API.
+    #
+    # @param slug [String] Coin slug (e.g., "bitcoin-btc")
+    # @param fmt [String] Image format: "svg", "png", "webp", "jpeg", "ico"
+    # @param width [Integer, nil] Output width in pixels
+    # @param height [Integer, nil] Output height in pixels
+    # @param bg [String, nil] Background hex color without #
+    # @return [String] Raw image bytes
+    #
+    # @example
+    #   svg = client.get_logo("bitcoin-btc", "svg")
+    #   png = client.get_logo("bitcoin-btc", "png", width: 256)
+    def get_logo(slug, fmt = "svg", width: nil, height: nil, bg: nil)
+      url = get_logo_url(slug, fmt, width: width, height: height, bg: bg)
+      get_bytes(url)
+    end
+
+    # Build the API URL for a logo.
+    #
+    # @param slug [String] Coin slug
+    # @param fmt [String] Image format
+    # @param width [Integer, nil] Width in pixels
+    # @param height [Integer, nil] Height in pixels
+    # @param bg [String, nil] Background hex color
+    # @return [String] Full API URL
+    #
+    # @example
+    #   url = client.get_logo_url("bitcoin-btc", "png", width: 512)
+    #   # "https://crypto-logo.com/api/logo/bitcoin-btc.png?w=512&h=512"
+    def get_logo_url(slug, fmt = "svg", width: nil, height: nil, bg: nil)
+      url = "#{@base_url}/api/logo/#{slug}.#{fmt}"
+      params = []
+      params << "w=#{width}" if width
+      h = height || width
+      params << "h=#{h}" if h
+      params << "bg=#{bg}" if bg
+      url += "?#{params.join("&")}" unless params.empty?
+      url
+    end
+
+    # Build a CDN URL for direct image embedding.
+    #
+    # @param slug [String] Coin slug
+    # @param fmt [String] Image format
+    # @param width [Integer] Square size in pixels
+    # @param cdn_domain [String] CDN hostname
+    # @return [String] CDN URL
+    #
+    # @example
+    #   url = client.get_cdn_url("bitcoin-btc", "webp", 128)
+    #   # "https://cdn.crypto-logo.com/logos/bitcoin-btc/128x128/transparent.webp"
+    def get_cdn_url(slug, fmt = "png", width = 128, cdn_domain: DEFAULT_CDN_DOMAIN)
+      if fmt == "svg"
+        "https://#{cdn_domain}/logos/#{slug}/vector.svg"
+      else
+        "https://#{cdn_domain}/logos/#{slug}/#{width}x#{width}/transparent.#{fmt}"
+      end
+    end
+
+    # Download a logo to a local file.
+    #
+    # @param slug [String] Coin slug
+    # @param fmt [String] Image format
+    # @param dest [String] Destination file path
+    # @param width [Integer, nil] Width in pixels
+    # @param height [Integer, nil] Height in pixels
+    # @param bg [String, nil] Background hex color
+    # @return [String] Path to downloaded file
+    #
+    # @example
+    #   client.download_logo("bitcoin-btc", "svg", "bitcoin.svg")
+    #   client.download_logo("ethereum-eth", "png", "eth.png", width: 512)
+    def download_logo(slug, fmt = "svg", dest = nil, width: nil, height: nil, bg: nil)
+      data = get_logo(slug, fmt, width: width, height: height, bg: bg)
+      dest ||= if fmt == "svg"
+                 "#{slug}.svg"
+               elsif width
+                 "#{slug}-#{width}x#{height || width}.#{fmt}"
+               else
+                 "#{slug}.#{fmt}"
+               end
+      File.binwrite(dest, data)
+      dest
+    end
+
+    # Fetch a variant or historical logo file.
+    #
+    # @param file_path [String] Relative path (e.g., "versions/bitcoin-btc-full.svg")
+    # @return [String] Raw file bytes
+    def get_asset(file_path)
+      url = "#{@base_url}/api/asset/#{file_path}"
+      get_bytes(url)
+    end
+
+    private
+
+    def get_json(path)
+      url = "#{@base_url}#{path}"
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+
+      request = Net::HTTP::Get.new(uri)
+      request["Accept"] = "application/json"
+      request["User-Agent"] = USER_AGENT
+
+      response = http.request(request)
+      handle_response(response, url)
+      JSON.parse(response.body)
+    end
+
+    def get_bytes(url)
+      uri = URI.parse(url.start_with?("http") ? url : "#{@base_url}#{url}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = @timeout
+      http.read_timeout = @timeout
+
+      request = Net::HTTP::Get.new(uri)
+      request["User-Agent"] = USER_AGENT
+
+      response = http.request(request)
+      handle_response(response, url)
+      response.body
+    end
+
+    def handle_response(response, url)
+      case response.code.to_i
+      when 200..299
+        # OK
+      when 404
+        raise NotFoundError, "Not found: #{url}"
+      else
+        raise Error, "HTTP #{response.code}: #{url}"
+      end
+    end
+  end
+end

data/lib/cryptologo/types.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CryptoLogo
+  # A cryptocurrency coin with logo availability metadata.
+  #
+  # @attr_reader name [String] Display name (e.g., "Bitcoin")
+  # @attr_reader ticker [String] Trading symbol (e.g., "BTC")
+  # @attr_reader slug [String] URL-safe identifier (e.g., "bitcoin-btc")
+  # @attr_reader has_png [Boolean] Whether a PNG logo is available
+  # @attr_reader has_svg [Boolean] Whether an SVG logo is available
+  # @attr_reader search_terms [Array<String>] Localized names for search
+  # @attr_reader market_cap_rank [Integer, nil] CoinGecko market cap ranking
+  Coin = Struct.new(:name, :ticker, :slug, :has_png, :has_svg, :search_terms, :market_cap_rank,
+                     keyword_init: true) do
+    # Create a Coin from a parsed JSON hash.
+    # @param data [Hash] API response hash
+    # @return [Coin]
+    def self.from_hash(data)
+      new(
+        name: data["name"] || "",
+        ticker: data["ticker"] || "",
+        slug: data["slug"] || "",
+        has_png: data["has_png"] || false,
+        has_svg: data["has_svg"] || false,
+        search_terms: data["search_terms"] || [],
+        market_cap_rank: data["market_cap_rank"]
+      )
+    end
+  end
+
+  # Base error class for CryptoLogo client.
+  class Error < StandardError; end
+
+  # Raised when a resource is not found (HTTP 404).
+  class NotFoundError < Error; end
+end

data/lib/cryptologo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CryptoLogo
+  VERSION = "0.1.0"
+end

data/lib/cryptologo.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "cryptologo/version"
+require_relative "cryptologo/types"
+require_relative "cryptologo/client"
+
+# CryptoLogo — Ruby client for crypto-logo.com cryptocurrency logo API.
+#
+# Fetch, download, and generate URLs for 413+ cryptocurrency logos in SVG,
+# PNG, WebP, JPEG, and ICO formats. Zero external dependencies.
+#
+# @example
+#   client = CryptoLogo::Client.new
+#   coins = client.list_coins
+#   svg = client.get_logo("bitcoin-btc", "svg")
+#   client.download_logo("ethereum-eth", "png", "eth.png", width: 512)
+module CryptoLogo
+  # Standard pre-generated square sizes in pixels.
+  ALLOWED_SIZES = [16, 32, 48, 64, 96, 120, 128, 200, 256, 400, 512, 1024, 2000].freeze
+
+  # Valid ICO format sizes.
+  ICO_SIZES = [16, 32, 48, 64, 128, 256].freeze
+
+  # All supported image formats.
+  ALL_FORMATS = %w[svg png webp jpeg ico].freeze
+
+  # Default API base URL.
+  DEFAULT_BASE_URL = "https://crypto-logo.com"
+
+  # Default CDN domain.
+  DEFAULT_CDN_DOMAIN = "cdn.crypto-logo.com"
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: cryptologo
+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: Fetch, download, and generate URLs for 413+ cryptocurrency logos. Supports
+  SVG, PNG, WebP, JPEG, and ICO formats in 13 standard sizes. Zero external dependencies
+  (stdlib net/http only).
+email:
+- dobestan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/cryptologo.rb
+- lib/cryptologo/client.rb
+- lib/cryptologo/types.rb
+- lib/cryptologo/version.rb
+homepage: https://crypto-logo.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://crypto-logo.com
+  source_code_uri: https://github.com/dobestan/cryptologo-rb
+  documentation_uri: https://crypto-logo.com/api/docs/
+  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: '3.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 crypto-logo.com — 413 cryptocurrency logos in SVG, PNG, WebP,
+  ICO
+test_files: []