metalpriceapi 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b752dcae214e6d63cf250ae83b7749f19986f644b89c5a57a71946a35c4d85f0
-  data.tar.gz: 716d1d203372742a7e66f48c1901bb54f5e35338c841c3484aed457b5e310fc0
+  metadata.gz: b62712677891b353f2d7a9cdba4828642f028b2b7ca7ea8a1d9da26d9cf387be
+  data.tar.gz: 3c2200eaf7ca8a0ce5f7a2b23ead0b5e5a4518a1387ab6c1263b26286a75a6d1
 SHA512:
-  metadata.gz: c7d6d999df3dd81f25ca2e91fa43244a5ed6e74dc6e1b5ede72c770e0d5c112719c1f80ef4820d4710dbb7864475fdd7c1460205b86bd63882fc0ad555c7292d
-  data.tar.gz: b12c1ea4110ca309d98714b573b5e67bbdb4dd8e670469ad50bdb8e0e5c8837db3a7f34b0606c34e91f6655aecaee455d443a18d1bd2e57dd6fcdf6619af1144
+  metadata.gz: 11715fca73cf0cc67c6834200f3f79fb6d9c84d6e31cb73abd020614712474b0125b49313f24ac0aeede4e454499902d743420e9d66d6f1539411c3b70c952d7
+  data.tar.gz: 662abe1157a08cd35d965e97851a244f2ccb3224677ae3228705ddc723032316832173372e115018906875fbb1c6023df43aeeebede20eb85a0d8b0d9e5e3cb0

data/README.md

@@ -15,7 +15,28 @@ gem 'metalpriceapi'
 
 api_key = 'SET_YOUR_API_KEY_HERE'
 client = MetalpriceAPI::Client.new(api_key: api_key)
+
+# Or use EU server:
+# client = MetalpriceAPI::Client.new(api_key: api_key, server: 'eu')
 ```
+---
+## Server Regions
+
+MetalpriceAPI provides two regional endpoints. Choose the one closest to your servers for optimal performance.
+
+| Region | Base URL |
+|--------|----------|
+| United States (default) | `https://api.metalpriceapi.com/v1` |
+| Europe | `https://api-eu.metalpriceapi.com/v1` |
+
+```ruby
+# Default (US)
+client = MetalpriceAPI::Client.new(api_key: 'SET_YOUR_API_KEY_HERE')
+
+# Europe
+client = MetalpriceAPI::Client.new(api_key: 'SET_YOUR_API_KEY_HERE', server: 'eu')
+```
+
 ---
 ## Documentation
 
@@ -27,32 +48,62 @@ client.fetchSymbols()
 [Link](https://metalpriceapi.com/documentation#api_symbol)
 
 ---
-#### fetchLive(base, currencies)
+#### setServer(server)
+
+- `server` <[string]> Pass `'eu'` to use the EU server (`api-eu.metalpriceapi.com`), or `'us'` for the US server. Defaults to US if not specified.
+
+```ruby
+client.setServer('eu')
+```
+
+---
+#### fetchLive(base, currencies, unit, purity, math)
 
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
+- `unit` <[string]> Optional. Pass in a unit for metal prices (e.g. `troy_oz`, `gram`, `kilogram`).
+- `purity` <[string]> Optional. Pass in a purity level for metal prices.
+- `math` <[string]> Optional. Pass in a math expression to apply to the rates.
 
 ```ruby
-client.fetchLive(base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
+client.fetchLive('USD', ['XAU', 'XAG', 'XPD', 'XPT'], 'troy_oz')
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_realtime)
 
 ---
-#### fetchHistorical(date, base, currencies)
+#### fetchHistorical(date, base, currencies, unit)
 
 - `date` <[string]> Required. Pass in a string with format `YYYY-MM-DD`
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
+- `unit` <[string]> Optional. Pass in a unit for metal prices (e.g. `troy_oz`, `gram`, `kilogram`).
 
 ```ruby
-client.fetchHistorical(date='2021-04-05', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
+client.fetchHistorical('2024-02-05', 'USD', ['XAU', 'XAG', 'XPD', 'XPT'], 'troy_oz')
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_historical)
 
 ---
-#### fetchOHLC(base, currency, date, unit, dateType)
+#### hourly(base, currency, unit, start_date, end_date, math, date_type)
+
+- `base` <[string]> Optional. Pass in a base currency, defaults to USD.
+- `currency` <[string]> Required. Specify currency you would like to get hourly rates for.
+- `unit` <[string]> Optional. Pass in a unit for metal prices (e.g. `troy_oz`, `gram`, `kilogram`).
+- `start_date` <[string]> Required. Specify the start date using the format `YYYY-MM-DD`.
+- `end_date` <[string]> Required. Specify the end date using the format `YYYY-MM-DD`.
+- `math` <[string]> Optional. Pass in a math expression to apply to the rates.
+- `date_type` <[string]> Optional. Pass in a date type, overrides date parameters if passed in.
+
+```ruby
+client.hourly('USD', 'XAU', 'troy_oz', '2025-11-03', '2025-11-03')
+```
+
+[Link](https://metalpriceapi.com/documentation#api_hourly)
+
+---
+#### fetchOHLC(base, currency, date, unit, date_type)
 
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currency` <[string]> Required. Specify currency you would like to get OHLC for.
@@ -61,60 +112,65 @@ client.fetchHistorical(date='2021-04-05', base='USD', currencies=['XAU', 'XAG',
 - `date_type` <[string]> Optional. Pass in a date type, overrides date parameter if passed in.
 
 ```ruby
-client.fetchOHLC(base='USD', currency='XAU', date='2024-02-05', unit='troy_oz', date_type=nil)
+client.fetchOHLC('USD', 'XAU', '2024-02-06', 'troy_oz')
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_ohlc)
 
 ---
-#### convert(from_currency, to_currency, amount, date)
+#### convert(from_currency, to_currency, amount, date, unit)
 
 - `from_currency` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `to_currency` <[string]> Required. Specify currency you would like to convert to.
 - `amount` <[number]> Required. The amount to convert.
 - `date` <[string]> Optional. Specify date to use historical midpoint value for conversion with format `YYYY-MM-DD`. Otherwise, it will use live exchange rate date if value not passed in.
+- `unit` <[string]> Optional. Pass in a unit for metal prices (e.g. `troy_oz`, `gram`, `kilogram`).
 
 ```ruby
-client.convert(from_currency='USD', to_currency='EUR', amount=100, date='2021-04-05')
+client.convert('USD', 'EUR', 100, '2024-02-05')
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_convert)
 
 ---
-#### timeframe(start_date, end_date, base, currencies)
+#### timeframe(start_date, end_date, base, currencies, unit)
 
 - `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.
 - `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
+- `unit` <[string]> Optional. Pass in a unit for metal prices (e.g. `troy_oz`, `gram`, `kilogram`).
 
 ```ruby
-client.timeframe(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
+client.timeframe('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT'], 'troy_oz')
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_timeframe)
 
 ---
-#### change(start_date, end_date, base, currencies)
+#### change(start_date, end_date, base, currencies, date_type)
 
 - `start_date` <[string]> Required. Specify the start date of your timeframe using the format `YYYY-MM-DD`.
 - `end_date` <[string]> Required. Specify the end date of your timeframe using the format `YYYY-MM-DD`.
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
 - `currencies` <[Array]<[string]>> Optional. Pass in an array of currencies to return values for.
+- `date_type` <[string]> Optional. Pass in a date type, overrides date parameters if passed in.
 
 ```ruby
-client.change(start_date='2021-04-05', end_date='2021-04-06', base='USD', currencies=['XAU', 'XAG', 'XPD', 'XPT'])
+client.change('2024-02-05', '2024-02-06', 'USD', ['XAU', 'XAG', 'XPD', 'XPT'])
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_change)
+
 ---
-#### carat(start_date, end_date, base, currencies)
+#### carat(base, currency, date)
 
 - `base` <[string]> Optional. Pass in a base currency, defaults to USD.
+- `currency` <[string]> Optional. Pass in a metal code to get carat prices for (defaults to XAU).
 - `date` <[string]> Optional. Specify date to get Carat for specific date using format `YYYY-MM-DD`. If not specified, uses live rates.
 
 ```ruby
-client.carat(base='USD', date='2021-04-06')
+client.carat('USD', 'XAU', '2024-02-06')
 ```
 
 [Link](https://metalpriceapi.com/documentation#api_carat)
@@ -128,6 +184,9 @@ client.usage()
 
 [Link](https://metalpriceapi.com/documentation#api_usage)
 
+---
+**[Official documentation](https://metalpriceapi.com/documentation)**
+
 ---
 ## FAQ
 

data/lib/metalpriceapi/client.rb

@@ -13,6 +13,15 @@ module MetalpriceAPI
         send("#{key}=", options[key] || MetalpriceAPI.config.send(key))
       end
       @logger ||= MetalpriceAPI::Logger.logger
+      # If server was explicitly passed, update endpoint accordingly
+      if options.key?(:server)
+        self.endpoint = MetalpriceAPI::SERVERS.fetch(options[:server], MetalpriceAPI::SERVERS['us'])
+      end
+    end
+
+    def setServer(server)
+      self.endpoint = MetalpriceAPI::SERVERS.fetch(server, MetalpriceAPI::SERVERS['us'])
+      @connection = nil  # reset memoized connection
     end
 
     class << self

data/lib/metalpriceapi/config.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
 module MetalpriceAPI
+  SERVERS = {
+    'us' => 'https://api.metalpriceapi.com/v1',
+    'eu' => 'https://api-eu.metalpriceapi.com/v1',
+  }.freeze
+
   module Config
     extend self
 
     ATTRIBUTES = %i[
       endpoint
       api_key
+      server
       proxy
       user_agent
       ca_path
@@ -19,7 +25,8 @@ module MetalpriceAPI
     attr_accessor(*Config::ATTRIBUTES)
 
     def reset
-      self.endpoint = 'https://api.metalpriceapi.com/v1'
+      self.server = 'us'
+      self.endpoint = MetalpriceAPI::SERVERS['us']
       self.api_key = nil
       self.user_agent = "MetalpriceAPI Ruby Client/#{MetalpriceAPI::VERSION}"
       self.ca_path = defined?(OpenSSL) ? OpenSSL::X509::DEFAULT_CERT_DIR : nil
@@ -29,6 +36,11 @@ module MetalpriceAPI
       self.timeout = nil
       self.open_timeout = nil
     end
+
+    def server=(value)
+      @server = value
+      self.endpoint = MetalpriceAPI::SERVERS.fetch(value, MetalpriceAPI::SERVERS['us'])
+    end
   end
 
   class << self

data/lib/metalpriceapi/endpoints/index.rb

@@ -6,67 +6,88 @@ module MetalpriceAPI
       get('symbols')
     end
 
-    def fetchLive(base = nil, currencies = nil)
+    def fetchLive(base = nil, currencies = nil, unit = nil, purity = nil, math = nil)
       options = removeEmpty({
         base: base,
-        currencies: (currencies || []).join(',')
+        currencies: (currencies || []).join(','),
+        unit: unit,
+        purity: purity,
+        math: math,
       })
       get('latest', options)
     end
 
-    def fetchHistorical(date, base = nil, currencies = nil)
+    def fetchHistorical(date, base = nil, currencies = nil, unit = nil)
       options = removeEmpty({
         base: base,
-        currencies: (currencies || []).join(',')
+        currencies: (currencies || []).join(','),
+        unit: unit,
       })
       get(date, options)
     end
 
+    def hourly(base = nil, currency = nil, unit = nil, start_date = nil, end_date = nil, math = nil, date_type = nil)
+      options = removeEmpty({
+        base: base,
+        currency: currency,
+        unit: unit,
+        start_date: start_date,
+        end_date: end_date,
+        math: math,
+        date_type: date_type,
+      })
+      get('hourly', options)
+    end
+
     def fetchOHLC(base = nil, currency = nil, date = nil, unit = nil, date_type = nil)
       options = removeEmpty({
         base: base,
         currency: currency,
         date: date,
         unit: unit,
-        date_type: dateType
+        date_type: date_type,
       })
       get('ohlc', options)
     end
 
-    def convert(from_currency = nil, to_currency = nil, amount = nil, date = nil)
+    def convert(from_currency = nil, to_currency = nil, amount = nil, date = nil, unit = nil)
       options = removeEmpty({
           'from': from_currency,
           'to': to_currency,
           'amount': amount,
-          'date': date
+          'date': date,
+          'unit': unit,
       })
       get('convert', options)
     end
 
-    def timeframe(start_date, end_date, base = nil, currencies = nil)
+    def timeframe(start_date, end_date, base = nil, currencies = nil, unit = nil)
       options = removeEmpty({
           'start_date': start_date,
           'end_date': end_date,
           'base': base,
-          'currencies': (currencies || []).join(',')
+          'currencies': (currencies || []).join(','),
+          'unit': unit,
       })
       get('timeframe', options)
     end
 
-    def change(start_date, end_date, base = '', currencies = nil)
+    def change(start_date, end_date, base = nil, currencies = nil, date_type = nil)
       options = removeEmpty({
           'start_date': start_date,
           'end_date': end_date,
           'base': base,
-          'currencies': (currencies || []).join(',')
+          'currencies': (currencies || []).join(','),
+          'date_type': date_type,
       })
       get('change', options)
     end
 
-    def carat(base = '', date = nil)
+    def carat(base = nil, currency = nil, date = nil)
       options = removeEmpty({
           'base': base,
-          'date': date
+          'currency': currency,
+          'date': date,
       })
       get('carat', options)
     end
@@ -79,7 +100,7 @@ module MetalpriceAPI
 
     def removeEmpty(options)
       options.each do |key, value|
-        if (!value || value == '')
+        if (value.nil? || value == '')
           options.delete(key)
         end
       end

data/lib/metalpriceapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetalpriceAPI
-  VERSION = '1.1.2'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: metalpriceapi
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - MetalpriceAPI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -28,16 +34,16 @@ dependencies:
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description:
 email: contact@metalpriceapi.com
 executables: []
@@ -70,14 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Official MetalpriceAPI Ruby client.