logo_dev 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70d310347a2eaf2243832d898b27179440609f3ccf31dc97cbe13c0cffc1731f
+  data.tar.gz: 8386beddfc6de8ef1f133c3a0d3be9cfbfd66da6d58232c322ce93d055f1e6d7
+SHA512:
+  metadata.gz: 523644141a060c960e2caf890da5064fd6a01538a806955fbcf2bf0ae4e6bb0d9b20adfee6b69cd45859d4677896c6e7ec298dbfb90a960c2614f8a4169f3a61
+  data.tar.gz: 725bc53ef7c3171880b2664d85dae5d4fcb5ddc85748ecd20aec39748b726a6a12fcbad03435adf05b873f7705dc98f01a2e320a0a98e33343e70494d96f1ef5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 swlkr
+
+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,137 @@
+# LogoDev
+
+A lightweight, zero-dependency Ruby client for [Logo.dev](https://www.logo.dev).
+
+## Features
+
+- **Zero Dependencies**: Uses only Ruby standard library (`net/http`, `json`).
+- **Complete Coverage**: Supports Logo, Brand, Search, Transactions, and Describe APIs.
+- **Easy to Use**: Clean and intuitive API.
+- **Secure**: Handles authentication via secret and publishable keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logo_dev'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install logo_dev
+```
+
+## Usage
+
+### Configuration
+
+You can configure the client globally (e.g., in a Rails initializer):
+
+```ruby
+require 'logo_dev'
+
+LogoDev.configure do |config|
+  config.secret_key = ENV["LOGODEV_SECRET_KEY"]
+  config.publishable_key = ENV["LOGODEV_PUBLISHABLE_KEY"]
+end
+
+# Then you can initialize a client without arguments
+client = LogoDev.new
+```
+
+Alternatively, you can pass keys directly when initializing a client:
+
+```ruby
+client = LogoDev.new(
+  secret_key: 'sk_...',      # Required for REST APIs
+  publishable_key: 'pk_...'  # Optional, used for Logo URL generation
+)
+```
+
+
+### Logo API
+
+Generate a URL for a company logo. This doesn't make an API call; it simply constructs a signed URL.
+
+```ruby
+# By domain
+client.logo_url('google.com')
+# => "https://img.logo.dev/google.com?token=pk_..."
+
+# With options
+client.logo_url('stripe.com', size: 128, format: 'png')
+# => "https://img.logo.dev/stripe.com?size=128&format=png&token=pk_..."
+
+# By ticker, ISIN, or crypto symbol
+client.logo_url('AAPL')
+client.logo_url('US0378331005')
+client.logo_url('BTC')
+```
+
+### Search API
+
+Resolve a human-typed company name to its canonical domain.
+
+```ruby
+client.search('Apple')
+# => [{"name"=>"Apple", "domain"=>"apple.com", ...}, ...]
+```
+
+### Describe API
+
+Enrich a domain into structured company data (name, description, brand colors, social profiles).
+
+```ruby
+client.describe('apple.com')
+# => {"name"=>"Apple Inc.", "description"=>"...", "colors"=>[...], "social"=>[...]}
+```
+
+### Brand API
+
+Retrieve a full brand profile for a given domain, including banners and brandmarks.
+
+```ruby
+client.brand('airbnb.com')
+```
+
+### Transaction API
+
+Normalize and clean raw card-transaction descriptors.
+
+```ruby
+client.transaction('SQ *BLUE BOTTLE 1523 OAKLAND CA', country_code: 'US')
+# => {"name"=>"Blue Bottle Coffee", "domain"=>"bluebottlecoffee.com", ...}
+```
+
+## Error Handling
+
+The gem defines the following error classes:
+
+- `LogoDev::AuthenticationError`: Raised when the API key is missing or invalid.
+- `LogoDev::ResponseError`: Raised when the API returns an error status code.
+- `LogoDev::RequestError`: Raised when a network error occurs.
+
+```ruby
+begin
+  client.describe('invalid.com')
+rescue LogoDev::ResponseError => e
+  puts "API Error: #{e.message}"
+  puts "Response Code: #{e.response.code}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/logo_dev/client.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+module LogoDev
+  class Client
+    API_BASE = "https://api.logo.dev"
+    IMG_BASE = "https://img.logo.dev"
+
+    def initialize(secret_key: nil, publishable_key: nil)
+      @secret_key = secret_key
+      @publishable_key = publishable_key
+    end
+
+    # Logo API
+    # Generates a URL for a logo image.
+    # @param identifier [String] domain, ticker, ISIN, or crypto symbol
+    # @param options [Hash] size, format, etc.
+    def logo_url(identifier, **options)
+      token = options.delete(:token) || @publishable_key
+      
+      params = options.dup
+      params[:token] = token if token
+
+      query = URI.encode_www_form(params)
+      "#{IMG_BASE}/#{identifier}#{query.empty? ? "" : "?#{query}"}"
+    end
+
+    # Search API
+    # Resolves a human-typed company name to its canonical domain.
+    # @param query [String] company name
+    def search(query)
+      get("/search", q: query)
+    end
+
+    # Describe API
+    # Enriches a domain into structured company data.
+    # @param domain [String]
+    def describe(domain)
+      get("/describe/#{domain}")
+    end
+
+    # Brand API
+    # Retrieves a full brand profile for a given domain.
+    # @param domain [String]
+    def brand(domain)
+      get("/brand/#{domain}")
+    end
+
+    # Transaction API
+    # Identifies and cleans raw card-transaction descriptors.
+    # @param transaction [String] raw transaction string
+    # @param country_code [String] optional ISO 3166-1 alpha-2 code
+    def transaction(transaction, country_code: nil)
+      body = { transaction: transaction }
+      body[:country_code] = country_code if country_code
+      post("/transaction", body)
+    end
+
+    private
+
+    def get(path, params = {})
+      uri = URI("#{API_BASE}#{path}")
+      uri.query = URI.encode_www_form(params) unless params.empty?
+      
+      request = Net::HTTP::Get.new(uri)
+      perform_request(uri, request)
+    end
+
+    def post(path, body = {})
+      uri = URI("#{API_BASE}#{path}")
+      
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/json"
+      request.body = JSON.generate(body)
+      
+      perform_request(uri, request)
+    end
+
+    def perform_request(uri, request)
+      raise AuthenticationError, "Secret key is required for this API" unless @secret_key
+
+      request["Authorization"] = "Bearer #{@secret_key}"
+      request["Accept"] = "application/json"
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      handle_response(response)
+    rescue SocketError, Net::OpenTimeout => e
+      raise RequestError, "Failed to connect to Logo.dev: #{e.message}"
+    end
+
+    def handle_response(response)
+      case response.code.to_i
+      when 200..299
+        JSON.parse(response.body)
+      when 401
+        raise AuthenticationError, "Invalid secret key"
+      else
+        begin
+          error_data = JSON.parse(response.body)
+          message = error_data["error"] || error_data["message"] || response.message
+        rescue JSON::ParserError
+          message = response.message
+        end
+        raise ResponseError.new("Logo.dev API error: #{message}", response)
+      end
+    end
+  end
+end

data/lib/logo_dev/error.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LogoDev
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class RequestError < Error; end
+  class ResponseError < Error
+    attr_reader :response
+
+    def initialize(message, response = nil)
+      super(message)
+      @response = response
+    end
+  end
+end

data/lib/logo_dev/version.rb

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

data/lib/logo_dev.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "logo_dev/version"
+require_relative "logo_dev/error"
+require_relative "logo_dev/client"
+
+module LogoDev
+  class Configuration
+    attr_accessor :secret_key, :publishable_key
+
+    def initialize
+      @secret_key = ENV["LOGODEV_SECRET_KEY"]
+      @publishable_key = ENV["LOGODEV_PUBLISHABLE_KEY"]
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def new(secret_key: nil, publishable_key: nil)
+      secret_key ||= configuration.secret_key
+      publishable_key ||= configuration.publishable_key
+      Client.new(secret_key: secret_key, publishable_key: publishable_key)
+    end
+  end
+end
+

data/logo_dev.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "logo_dev"
+  spec.version       = "0.1.0"
+  spec.authors       = ["swlkr"]
+  spec.email         = ["me@swlkr.com"]
+
+  spec.summary       = "A Ruby client for the Logo.dev API"
+  spec.description   = "Wrap the Logo.dev API with zero dependencies. Support for Logo, Brand, Search, Transactions, and Describe APIs."
+  spec.homepage      = "https://github.com/swlkr/logodev"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: logo_dev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- swlkr
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Wrap the Logo.dev API with zero dependencies. Support for Logo, Brand,
+  Search, Transactions, and Describe APIs.
+email:
+- me@swlkr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/logo_dev.rb
+- lib/logo_dev/client.rb
+- lib/logo_dev/error.rb
+- lib/logo_dev/version.rb
+- logo_dev.gemspec
+homepage: https://github.com/swlkr/logodev
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/swlkr/logodev
+  source_code_uri: https://github.com/swlkr/logodev
+  changelog_uri: https://github.com/swlkr/logodev/blob/main/CHANGELOG.md
+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.7.2
+specification_version: 4
+summary: A Ruby client for the Logo.dev API
+test_files: []