exchangerateapinet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f84083556736ef031f6f5cb2ced5f793a2767adb2dcc284c4caef0c1a2be4989
+  data.tar.gz: 6d7daf56e32206da3ce5d56702b0204f095579a55d47b3f73a4c9f270994edd0
+SHA512:
+  metadata.gz: 75587b674c59b556ab28e45aaf9efffe544c607f3e375128ff3dddf9925032b151c381460f96c45fd8fed4d45c5c2b29c2fb250c778aaad30cb537766ecc1c95
+  data.tar.gz: cdda2f9ed515c1ed6dc4604193920b158b7fa8ddec8f4968c6967e3ef0cddca20cef6699383418acd4c691befe3af8705a03756acb36c6f764e97c4677e43ea6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+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,73 @@
+# exchangerateapi-ruby
+
+[![Gem Version](https://img.shields.io/gem/v/exchangerateapi-ruby.svg)](https://rubygems.org/gems/exchangerateapi-ruby)
+[![Downloads](https://img.shields.io/gem/dt/exchangerateapi-ruby.svg)](https://rubygems.org/gems/exchangerateapi-ruby)
+[![GitHub release](https://img.shields.io/github/v/release/exchangerateapinet/exchangerateapi-ruby?display_name=tag&sort=semver)](https://github.com/exchangerateapinet/exchangerateapi-ruby/releases)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+Small Ruby client for exchangerateapi.net with straightforward methods and no external dependencies.
+
+- Website: [exchangerateapi.net](https://exchangerateapi.net)
+
+## Installation
+
+```bash
+gem install exchangerateapinet
+```
+
+## Quick start
+
+```ruby
+require "exchangerateapi/client"
+client = Exchangerateapi::Client.new(api_key: "YOUR_API_KEY")
+```
+
+## Usage patterns
+
+- Get the newest rates for a base currency; optionally select specific symbols.
+- Look up historical rates for a given date and base.
+
+### Configure
+
+You can tweak the base URL and provide your own HTTP timeouts by wrapping calls in `Net::HTTP.start` or using a proxy. The client constructs a query-string request and parses JSON.
+
+### Latest
+
+```ruby
+client.latest(base: "USD")
+client.latest(base: "EUR", symbols: ["USD", "GBP", "JPY"])
+```
+
+### Historical
+
+```ruby
+client.historical(date: "2024-01-02", base: "USD")
+client.historical(date: "2024-01-02", base: "EUR", symbols: ["USD", "GBP", "JPY"])
+```
+
+### Error handling
+
+When the API returns an error payload, the client raises `StandardError` with a short message. Wrap calls with `begin/rescue` to surface user-friendly messages or to retry.
+
+```ruby
+begin
+  client.latest(base: "XYZ") # invalid base
+rescue => e
+  warn "request failed: #{e.message}"
+end
+```
+
+### Run the examples
+
+```bash
+EXCHANGERATEAPI_KEY=your_api_key ruby examples/latest.rb
+EXCHANGERATEAPI_KEY=your_api_key ruby examples/historical.rb
+```
+
+## Free usage
+
+A free tier is available for testing and light workloads. It uses an API key and includes basic access to the latest and historical endpoints with rate limits. Refer to the latest details on [exchangerateapi.net](https://exchangerateapi.net).
+
+## License
+
+MIT

data/lib/exchangerateapi/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+module Exchangerateapi
+  class Client
+    DEFAULT_BASE = "https://api.exchangerateapi.net/v1"
+
+    def initialize(api_key:, base_url: DEFAULT_BASE)
+      raise ArgumentError, "api_key is required" if api_key.to_s.strip.empty?
+      @api_key = api_key
+      @base_url = base_url.chomp("/")
+    end
+
+    def latest(base:, symbols: nil)
+      raise ArgumentError, "base is required" if base.to_s.strip.empty?
+      params = { base: base, apikey: @api_key }
+      params[:symbols] = Array(symbols).join(",") if symbols && !Array(symbols).empty?
+      get_json("/latest", params)
+    end
+
+    def historical(date:, base:, symbols: nil)
+      raise ArgumentError, "date is required" if date.to_s.strip.empty?
+      raise ArgumentError, "base is required" if base.to_s.strip.empty?
+      params = { date: date, base: base, apikey: @api_key }
+      params[:symbols] = Array(symbols).join(",") if symbols && !Array(symbols).empty?
+      get_json("/historical", params)
+    end
+
+    private
+
+    def get_json(path, params)
+      uri = URI.parse(@base_url + path)
+      uri.query = URI.encode_www_form(params)
+      res = Net::HTTP.get_response(uri)
+      body = JSON.parse(res.body)
+      if body.is_a?(Hash) && body["error"]
+        msg = body["error"]["message"] rescue "API error"
+        raise StandardError, msg
+      end
+      body
+    end
+  end
+end

data/lib/exchangerateapi/version.rb

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

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: exchangerateapinet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- exchangerateapinet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-10-22 00:00:00.000000000 Z
+dependencies: []
+description: Lightweight wrapper offering access to latest and historical endpoints.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/exchangerateapi/client.rb
+- lib/exchangerateapi/version.rb
+homepage: https://github.com/exchangerateapinet/exchangerateapi-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+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 exchangerateapi.net
+test_files: []