free_currency-API 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d3d8f30522a187c2e46cff20b69ece8b1682ac5603b0aa3b3e49cf6a6227cd58
+  data.tar.gz: 7af4ce142bb209915fc5b1aa93ebfe6f7e1f566e9c47ce40e34cba8486b7e20f
+SHA512:
+  metadata.gz: '092efa9c1ff84c7c6191aa097076f8e66afbb28326db66969a63354d648bd05cb1592e8ad44053f1647df1d442c3c62a2e4bc190378da10e8f18be9205ecbeea'
+  data.tar.gz: bb2ee6645332c2d28a7a28fbeddb2c79d55eaea73876af515463913435cca6614bf4391200b7ddf32fc872d43f89488e483432c498c951df35b5aa8c7ca7fb07

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in free_currency-API.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    free_currency-API (0.1.0)
+      faraday
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  free_currency-API!
+  rake (~> 13.0)
+  rspec
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -0,0 +1,35 @@
+# FreeCurrency::API
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/free_currency/API`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'free_currency-API'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install free_currency-API
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/free_currency-API.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/free_currency-API.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "free_currency-API"
+  spec.version       = "0.1.1"
+  spec.authors       = ["João Oliveira"]
+  spec.email         = ["joao.oliveira@hole19golf.com"]
+
+  spec.summary       = "The freecurrencyAPI ruby API :D"
+  spec.description   = "Provides easier interaction with the freecurrencyAPI REST API"
+  #spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  #spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/JonhyOliveira/freecurrencyAPI-gem.git"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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"]
+
+  # Dependencies
+
+  spec.add_development_dependency "rspec"
+
+  # Use faraday to interact with freecurrency REST API
+  spec.add_dependency "faraday"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/freecurrencyAPI/API.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'faraday'
+
+module FreeCurrencyAPI
+
+    class API
+        def initialize api_key
+            @conn = Faraday.new "https://api.freecurrencyapi.com/v1/" do |c|
+            c.response :json
+            c.adapter :net_http
+            c.headers = {apikey: "#{api_key}"}
+            end
+        end
+
+        def latest_exchange_rates
+            do_request "latest"
+        end
+
+        def available_currencies
+            do_request "currencies"
+        end
+
+        private
+        #
+        # Makes a request to an endpoint and returns the result
+        #
+        # @param [String] endpoint the string describing the endpoint
+        #
+        # @return [Hash|String] the result of the request, if successfull will return an hash 
+        # describing the returned data, otherwise returns a message specifying what went wrong
+        #
+        def do_request endpoint
+            resp = @conn.get endpoint
+
+            if resp.success?
+                return resp.body["data"]
+            else
+                return resp.body["message"]
+            end
+        end
+    end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: free_currency-API
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- João Oliveira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides easier interaction with the freecurrencyAPI REST API
+email:
+- joao.oliveira@hole19golf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- free_currency-API.gemspec
+- lib/freecurrencyAPI/API.rb
+homepage:
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/JonhyOliveira/freecurrencyAPI-gem.git
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: The freecurrencyAPI ruby API :D
+test_files: []