crypto_tracker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71a7450582ebdc2b24262fe63234d78e61dfd0801e733071dbf283c122b37fcb
+  data.tar.gz: 0a9e4941543b97463771fc044d8e2eb9ffc42bd373347a2e90072e8e565f1c60
+SHA512:
+  metadata.gz: 286d5e94067f84c60c450d8833ef966057269032ad362146e4dea1a395f6a2554adeee9506855ce6429f101601ed18240c5bc6c9c6d33cb943fb7e57e7a58246
+  data.tar.gz: 8a6a7b4a3c39e9c72a583ee633074aa92a1d80b5247db3e2f8dc18c0fbe73ef4fc03158c2406352140e4288f6bef36ba3f42da495740741e30959340f12f288b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: disable
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 40
+  Exclude:
+    - "spec/**/*"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Davide Almeida
+
+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/Makefile

@@ -0,0 +1,8 @@
+build:
+	rm -f *.gem && gem build crypto_tracker.gemspec
+
+install:
+	gem install crypto_tracker-0.1.0.gem
+
+uninstall:
+	gem uninstall crypto_tracker

data/README.md

@@ -0,0 +1,101 @@
+# CryptoTracker
+CryptoTracker é uma gem Ruby que permite consultar o preço atual e o histórico de preços de qualquer criptomoeda suportada pela API CoinGecko. Os valores podem ser retornados em reais (BRL) ou dólares (USD).
+
+## 📌 Funcionalidades
+- Obtenha o preço atual de qualquer criptomoeda;
+- Consulte o histórico de preços dos últimos 7, 30, 90 ou mais dias;
+- Suporte para diferentes moedas (BRL e USD);
+- Integração com a API da CoinGecko (Plano Gratuito).
+
+## 🛠️ Stack
+- Ruby 3.4.1;
+- Faraday para requisições HTTP;
+- CoinGecko API como fonte de dados.
+
+## 📦 Instalação
+Adicione a seguinte linha ao seu `Gemfile`:
+```ruby
+# Gemfile
+gem 'crypto_tracker'
+```
+
+Depois, execute:
+```bash
+bundle install
+```
+
+Ou instale manualmente:
+```bash
+gem install crypto_tracker
+```
+
+## 🚀 Como Usar
+Primeiro, carregue a gem no seu código:
+```bash
+require 'crypto_tracker'
+```
+### 🔹 Obter o preço atual
+```bash
+CryptoTracker.price("bitcoin", "brl")  # Preço atual do Bitcoin em BRL
+CryptoTracker.price("ethereum", "usd") # Preço atual do Ethereum em USD
+```
+
+📌 Exemplo de resposta:
+```json
+{ "coin": "bitcoin", "price": 350000, "currency": "brl", "timestamp": "2025-01-30T14:00:00Z" }
+```
+
+### 🔹 Obter o histórico de preços
+```bash
+CryptoTracker.history("bitcoin", 7, "usd")   # Histórico do bitcoin nos últimos 7 dias em USD
+CryptoTracker.history("ethereum", 30, "brl") # Histórico do ethereum nos últimos 30 dias em BRL
+```
+
+📌 Exemplo de resposta:
+```json
+[
+  { "timestamp": "2025-01-23T14:00:00Z", "price": 34000 },
+  { "timestamp": "2025-01-24T14:00:00Z", "price": 34500 },
+  { "timestamp": "2025-01-25T14:00:00Z", "price": 35000 }
+]
+```
+
+## ⏳ Rate Limit da API CoinGecko
+A gem CryptoTracker está configurada para usar o plano gratuito da API CoinGecko. Isso significa que há um limite de:
+- 30 chamadas por minuto;
+- Máximo de 10.000 chamadas por mês.
+
+Se você ultrapassar esses limites, a API pode bloquear temporariamente as requisições. Para um uso mais intensivo, considere um plano pago da CoinGecko ([mais detalhes aqui](https://www.coingecko.com/en/api/pricing?utm_source=chatgpt.com)).
+
+## 🛠️ Desenvolvimento
+Se quiser modificar a gem, clone o repositório e instale as dependências:
+```bash
+git clone git@github.com:davide-almeida/crypto_tracker.git
+cd crypto_tracker
+bundle install
+```
+
+### 🔹 Testar a gem localmente
+Dentro do projeto, execute:
+```bash
+irb -I lib -r "crypto_tracker"
+```
+
+E teste os métodos:
+```bash
+CryptoTracker.price("bitcoin", "usd")
+CryptoTracker.history("ethereum", 7, "brl")
+```
+
+Você também pode usar alguns alias do `Makefile` para testes no IRB ou Rails Console:
+| Comando | Descrição |
+|-|-|
+| make build | remove arquivos `.gem` (caso existam) e gera um novo `.gem` |
+| make install | instala a gem localmente |
+| make uninstall | desinstala a gem localmente |
+
+## 📜 Licença
+Este projeto está licenciado sob a MIT License - veja o arquivo [LICENSE](https://github.com/davide-almeida/crypto_tracker/blob/main/LICENSE.txt) para mais detalhes.
+
+## 🤝 Contribuição
+Se você encontrar bugs ou quiser sugerir melhorias, sinta-se à vontade para abrir um Issue ou enviar um Pull Request. 😊

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/crypto_tracker/client.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module CryptoTracker
+  class Client
+    BASE_URL = 'https://api.coingecko.com/api/v3'
+
+    def self.get(endpoint, params = {})
+      response = Faraday.get("#{BASE_URL}/#{endpoint}", params)
+      JSON.parse(response.body)
+    rescue StandardError => e
+      { error: e.message }
+    end
+  end
+end

data/lib/crypto_tracker/crypto.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CryptoTracker
+  class Crypto
+    attr_reader :coin, :currency
+
+    def initialize(coin, currency)
+      @coin = coin.downcase
+      @currency = currency.downcase
+
+      validate_inputs
+    end
+
+    def current_price
+      response = Client.get("coins/#{coin}")
+      price = response.dig('market_data', 'current_price', currency)
+
+      return { error: 'Preço não disponível' } unless price
+
+      { coin: coin, price: price, currency: currency, timestamp: Time.now }
+    end
+
+    def price_history(days)
+      response = Client.get("coins/#{coin}/market_chart", { vs_currency: currency, days: days })
+
+      return { error: 'Histórico não disponível' } unless response['prices']
+
+      response['prices'].map do |price_data|
+        { timestamp: Time.at(price_data[0] / 1000), price: price_data[1] }
+      end
+    end
+
+    private
+
+    def validate_inputs
+      unless CryptoTracker.supported_coins.include?(coin)
+        raise ArgumentError, "Moeda '#{coin}' não é suportada pela API CoinGecko."
+      end
+
+      return if CryptoTracker::SUPPORTED_CURRENCIES.include?(currency)
+
+      raise ArgumentError,
+            "Moeda '#{currency}' não é suportada. Opções: #{CryptoTracker::SUPPORTED_CURRENCIES.join(", ")}"
+    end
+  end
+end

data/lib/crypto_tracker/version.rb

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

data/lib/crypto_tracker.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'crypto_tracker/version'
+require 'crypto_tracker/client'
+require 'crypto_tracker/crypto'
+
+module CryptoTracker
+  SUPPORTED_CURRENCIES = %w[usd brl].freeze
+
+  def self.price(coin, currency = 'usd')
+    Crypto.new(coin, currency).current_price
+  end
+
+  def self.history(coin, days = 30, currency = 'usd')
+    Crypto.new(coin, currency).price_history(days)
+  end
+
+  def self.supported_coins
+    response = Client.get('coins/list')
+
+    unless response.is_a?(Array)
+      puts "Erro ao buscar criptomoedas: #{response}"
+      return []
+    end
+
+    response.map { |coin| coin['id'] }
+  end
+end

data/sig/crypto_tracker.rbs

@@ -0,0 +1,4 @@
+module CryptoTracker
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: crypto_tracker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Davide Almeida
+bindir: exe
+cert_chain: []
+date: 2025-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+description: Permite consultar o preço atual e histórico de diferentes criptomoedas
+  em BRL e USD.
+email:
+- davide.jhonatan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/crypto_tracker.rb
+- lib/crypto_tracker/client.rb
+- lib/crypto_tracker/crypto.rb
+- lib/crypto_tracker/version.rb
+- sig/crypto_tracker.rbs
+homepage: https://github.com/davide-almeida/crypto_tracker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/davide-almeida/crypto_tracker
+  source_code_uri: https://github.com/davide-almeida/crypto_tracker
+  changelog_uri: https://github.com/davide-almeida/crypto_tracker/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Gem para obter preços e histórico de criptomoedas.
+test_files: []