gold_silver_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96d09225cb5edbc0614fecaa5799226f8adc0f1c1fd93620e34f48323f926f38
+  data.tar.gz: 498889025595d3b4139b9c01cddac9041cea0be71e6366a02bb41beb13ef513e
+SHA512:
+  metadata.gz: e33b359b17eb8218acd22fdd1da79b8c5c5304e81da0229d3865faf687974c9f6a06d008b6df402ad149a536f75dc0461e8b4fb7fc8988dd0ea599a14493275b
+  data.tar.gz: 3b14b6e3afd1e260591f5953ec732385bb8c8dcd8df494b90983fa9aaeb7f134cd4d317ee0cc569063ae62d2f4d908e78de441ba77b940fa9fcd61175648a295

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/CHANGES

@@ -0,0 +1 @@
+1.0.0 Initial Release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andreimerlescu@protonmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Open a pull request.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Merlescu Codez
+
+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,214 @@
+# GoldAPI Gem
+
+If you wish to use the price of Gold and Silver on your Rails application and you wish to use GoldApi.io as your data-source, then use this gem.
+
+## Installation
+
+Add this to your `Gemfile`:
+
+```ruby
+gem 'gold_silver_api', '~> 1.0'
+```
+
+Or install it locally to your system: 
+
+```bash
+gem install gold_silver_api
+```
+
+## Configuration
+
+If you're using Rails, then add a new file `config/initializers/gold_silver_api.rb` with: 
+
+```ruby
+require 'gold_silver_api'
+GoldSilver.configure do |config|
+  config.access_token = "goldapi-<access_token>-io"
+end
+```
+
+> Replace `goldapi-<access_token>-io` with your access token, which can be found **[On GoldApi.io](https://www.goldapi.io/dashboard)**.
+
+## Usage
+
+Make a request: 
+
+```ruby
+class BullionController < ActionController::Base
+
+  def index
+    @gold_price = GoldSilver::API.fetch("XAU", "USD")
+    @gold_on_november_3rd_2020 = GoldSilver::API.fetch("XAU", "USD", "20201103")
+  end #/def
+
+end #/class
+```
+
+Here is a table of argument potential values: 
+
+| `metal` | `currency` | `date` |
+|:--------|:-----------|:-------|
+| `XAU` - Gold | `AED` - U.A.E. Dirham | `YYYYMMDD` |
+| `XAG` - Silver | `AUD` - Austrialian Dollar | |
+| `XPT` - Platinum | `BTC` - Bitcoin | |
+| `XPD` - Palladium | `CAD` - Canadian Dollar | |
+| | `CHF` - Swiss Franc | |
+| | `CNY` - Chinese/Yuan renminbi | |
+| | `CZK` - Czech Krona | |
+| | `EUR` - European Euro | |
+| | `GBP` - British Pound | |
+| | `INR` - Indian Rupee | |
+| | `JPY` - Japanese Yen | |
+| | `KWD` - Kuwaiti Dinar | |
+| | `MYR` - Malaysian Ringgit | |
+| | `PLN` - Polish Zloty | |
+| | `RUB` - Russian Ruble | |
+| | `SGD` - Singapore Dollar | |
+| | `THB` - Thai Baht | |
+| | `USD` - United States Dollar | |
+| | `XAG` - Gold/Silver Ratio | |
+| | `ZAR` - South African Rand | |
+
+> Invalid metals and currencies will be rejected automatically by raising an `ArgumentError`. **NOTE**: `date` is not validated.
+
+## Advanced Usage
+
+You might want to cache your value with Redis (update the connection request to your system)...
+
+```ruby
+class BullionController < ActionController::Base
+
+  def index
+    
+    @gold_price = get_or_fetch_price("XAU", "USD") # redis.get("gold_silver_api-xau-usd")
+  end #/def
+
+  protected
+
+  def get_or_fetch_price metal, currency
+    # cert = File.open(ENV['REDIS_CERT_FILE'], 'r').read
+    # key = File.open(ENV['REDIS_KEY_FILE'], 'r').read
+    redis = Redis.new(
+      url: "#{ENV['REDIS_DSN']}/5",
+      network_timeout: 9#, 
+      # ssl: true,
+      # ssl_params: {
+      #   :ca_file     => ENV['REDIS_CA_FILE'],
+      #   :cert        => OpenSSL::X509::Certificate.new(cert),
+      #   :key         => OpenSSL::PKey::RSA.new(key),
+      #   :verify_mode => OpenSSL::SSL::VERIFY_NONE
+      # }
+    )
+
+    result = redis.get("gold_silver_api-#{metal}-#{currency}")
+    if result.nil?
+      call = GoldSilver::API.fetch(metal, currency)
+      unless call.nil?
+        result = call[:result]
+        unless result.nil?
+          redis.set("gold_silver_api-#{metal}-#{currency}", result[:price])
+          return result[:price]
+        else
+          return nil
+        end #/unless-else
+      else
+        return nil
+      end #/unless-else
+    else
+      return result
+    end #/if-else
+  end #/def
+end #/class
+```
+
+## Response from API
+
+Request `GoldSilver::API.fetch("XAU", "USD")` to get the price of Gold (Au) in US Dollars (USD) will return with the following result
+
+```json
+{
+  "timestamp":1608354836,
+  "metal":"XAU",
+  "currency":"USD",
+  "exchange":"FOREXCOM",
+  "symbol":"FOREXCOM:XAUUSD",
+  "prev_close_price":1885.56,
+  "open_price":1885.56,
+  "low_price":1877.53,
+  "high_price":1889.71,
+  "open_time":1608242400,
+  "price":1881.24,
+  "ch":-4.32,
+  "chp":-0.23,
+  "ask":1882.28,
+  "bid":1880.28
+}
+```
+
+To access the price: 
+
+```ruby
+gold_price_usd = nil
+call = GoldSilver::API.fetch("XAU", "USD")
+if call
+  result = call[:result]
+  if result
+    gold_price_usd = result["price"]
+  end #/if
+end #/if
+if gold_price_usd.nil?
+  # error we were unable to get the price
+end #/if
+# use gold_price_usd as much as you wish
+```
+
+## Testing
+
+```bash
+ruby spec/gold_silver_api_spec.rb
+```
+
+Expected output should be: 
+
+```
+Run options: --seed 21855
+
+# Running:
+
+.
+
+Finished in 0.171850s, 5.8190 runs/s, 5.8190 assertions/s.
+1 runs, 1 assertions, 0 failures, 0 errors, 0 skips
+```
+
+## Errors
+
+If you are missing the `access_token`, then if you attempt to run the tests, you might get the following kind of output: 
+
+```
+Run options: --seed 17828
+
+# Running:
+
+F
+
+Failure:
+GoldSilver::Interact with GoldApi.io#test_0001_should return the current price for gold [spec/gold_silver_api_spec.rb:14]:
+Expected nil to be an instance of Float, not NilClass.
+
+
+rails test spec/gold_silver_api_spec.rb:12
+
+
+
+Finished in 0.151836s, 6.5861 runs/s, 6.5861 assertions/s.
+1 runs, 1 assertions, 1 failures, 0 errors, 0 skips
+```
+
+## Credit
+
+This gem was created by [Andrei Merlescu](https://github.com/sponsors/patriotphoenix). 
+
+## License
+
+[MIT License](LICENSE)

data/SECURITY.md

@@ -0,0 +1,18 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| > 1.0.1   | :x:              |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

data/gold_silver_api.gemspec

@@ -0,0 +1,17 @@
+# require File.expand_path('../lib/gold_silver_api/version', __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require "gold_silver_api/version"
+
+
+Gem::Specification.new do |s|
+  s.authors                = ["Andrei Merlescu"]
+  s.email                  = ["andrei+github@merlescu.net"]
+  s.description            = s.summary = "Simple interface to access GoldApi.io"
+  s.homepage               = "https://github.com/amerlescucodez/goldsilver-api"
+  s.license                = "MIT"
+  s.files                  = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.name                   = "gold_silver_api"
+  s.require_paths          = ["lib"]
+  s.version                = GoldSilver::VERSION
+  s.add_runtime_dependency 'logging', '~> 2.2', '>= 2.2.2'
+end

data/lib/gold_silver_api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'logging'
+
+module GoldSilver
+end
+
+begin
+  require 'rails'
+rescue LoadError
+  # do nothing
+end #/begin-rescue
+
+require_relative 'gold_silver_api/config'
+require_relative 'gold_silver_api/logger'
+require_relative 'gold_silver_api/api'
+
+if defined? ::Rails::Railtie
+  require_relative 'gold_silver_api/railtie'
+end #/if

data/lib/gold_silver_api/api.rb

@@ -0,0 +1,46 @@
+require 'net/http'
+require 'json'
+require_relative 'consts'
+
+module GoldSilver
+  class API
+    class << self
+      def fetch metal, currency, date=nil
+        raise ArgumentError, "missing metal argument" if metal.nil?
+        raise ArgumentError, "invalid metal argument" unless GSAPI_METALS.include?(metal)
+        raise ArgumentError, "missing currency argument" if currency.nil?
+        raise ArgumentError, "invalid currency argument" unless GSAPI_CURRENCIES.include?(currency)
+        
+        GoldSilver.logger.debug "Attempting to fetch #{metal} in #{currency}."
+        
+        uri = nil
+        if date
+          uri = URI.parse("https://www.goldapi.io/api/#{metal&.upcase}/#{currency&.upcase}/#{date&.upcase}")
+        else
+          uri = URI.parse("https://www.goldapi.io/api/#{metal&.upcase}/#{currency&.upcase}")
+        end #/if-else
+        
+        response = nil
+        result = nil
+        Net::HTTP.start(uri.host, uri.port, use_ssl: GoldSilver.config.use_ssl) do |http|
+          req = Net::HTTP::Get.new(uri)
+          req['Content-Type'] = 'application/json'
+          req['x-access-token'] = GoldSilver.config.access_token
+          response = http.request(req)
+          result = response&.body
+        end #/block
+
+        {
+          success: response.instance_of?(Net::HTTPOK),
+          response: response,
+          result: JSON.parse(result)
+        }
+      # rescue
+      #   {
+      #     success: false,
+      #     response: nil
+      #   }
+      end #/def
+    end #/class
+  end #/class
+end #/class

data/lib/gold_silver_api/config.rb

@@ -0,0 +1,21 @@
+module GoldSilver
+  class << self
+    def configure
+      yield config
+    end #/def
+
+    def config
+      @_config ||= Config.new
+    end #/def
+  end #/class
+
+  class Config
+    attr_accessor :access_token
+    attr_accessor :use_ssl
+
+    def initialize
+      @access_token = nil
+      @use_ssl = true
+    end #/def
+  end #/class
+end #/module

data/lib/gold_silver_api/consts.rb

@@ -0,0 +1,2 @@
+GSAPI_METALS=["XAU", "XAG", "XPT", "XPD"]
+GSAPI_CURRENCIES=['AED', 'AUD', 'BTC', 'CAD', 'CHF', 'CNY', 'CZK', 'EUR', 'GBP', 'INR', 'JPY', 'KWD', 'MYR', 'PLN', 'RUB', 'SGD', 'THB', 'USD', 'XAG', 'ZAR']

data/lib/gold_silver_api/logger.rb

@@ -0,0 +1,10 @@
+require 'logging'
+module GoldSilver
+  class << self
+    def logger
+      @logger ||= Logging.logger(STDOUT)
+      @logger.level = :warn
+      return @logger
+    end #/def
+  end #/class
+end #/module

data/lib/gold_silver_api/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module GoldSilver
+  class Railtie < ::Rails::Railtie #:nodoc:
+    # Doesn't actually do anything. Just keeping this hook point, mainly for compatibility
+    initializer 'gold_silver' do
+    end
+  end
+end

data/lib/gold_silver_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GoldSilver
+  VERSION = '1.0.0'
+end #/module

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: gold_silver_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrei Merlescu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: Simple interface to access GoldApi.io
+email:
+- andrei+github@merlescu.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGES
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- SECURITY.md
+- gold_silver_api.gemspec
+- lib/gold_silver_api.rb
+- lib/gold_silver_api/api.rb
+- lib/gold_silver_api/config.rb
+- lib/gold_silver_api/consts.rb
+- lib/gold_silver_api/logger.rb
+- lib/gold_silver_api/railtie.rb
+- lib/gold_silver_api/version.rb
+homepage: https://github.com/amerlescucodez/goldsilver-api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Simple interface to access GoldApi.io
+test_files: []