https://github.com/wbnns/eyeofsatoshi

A ruby gem that pulls the current bitcoin price from multiple cryptocurrency APIs.
https://github.com/wbnns/eyeofsatoshi

bitcoin bitcoin-api bitcoin-price rails ruby ruby-on-rails rubygems

Last synced: about 1 month ago
JSON representation

A ruby gem that pulls the current bitcoin price from multiple cryptocurrency APIs.

• Host: GitHub
• URL: https://github.com/wbnns/eyeofsatoshi
• Owner: wbnns
• License: mit
• Created: 2021-03-27T16:06:00.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-03T15:40:57.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T12:04:17.889Z (about 2 months ago)
• Topics: bitcoin, bitcoin-api, bitcoin-price, rails, ruby, ruby-on-rails, rubygems
• Language: Ruby
• Homepage: https://rubygems.org/gems/eyeofsatoshi
• Size: 15.6 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Eye of Satoshi

A ruby gem that pulls the current bitcoin price from multiple cryptocurrency APIs. Ensure your app is getting the correct price by weighting against multiple sources of truth to ensure you and/or your users don't get rekt by incorrect information.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'eyeofsatoshi'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install eyeofsatoshi

## Usage

An example wrapper (`wrapper.rb`) is included in the `examples` folder to demonstrate how Eye of Satoshi can be used.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/wbnns/eyeofsatoshi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/wbnns/eyeofsatoshi/blob/master/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Eye of Satoshi's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/wbnns/eyeofsatoshi/blob/master/CODE_OF_CONDUCT.md).

## Acknowledgements

This gem would not be possible without the work of **Zayne**. It is entirely based on code from one of his tutorials about [using Ruby to interact with cryptocurrency APIs](https://www.youtube.com/watch?v=dP230gkXS0I).

Check him out on:

- [GitHub](https://github.com/zayneio)

- [Zayne.io](https://zayne.io/)

- [YouTube](https://www.youtube.com/channel/UCkoEStUK7wxmZef2DcPuCAQ/videos)

...and please consider supporting him on [Patreon](https://www.patreon.com/zayne_)!