{"id":15202805,"url":"https://github.com/bitodeme-integrations/bitodeme_rb","last_synced_at":"2026-02-25T19:06:30.348Z","repository":{"id":62554308,"uuid":"114513391","full_name":"bitodeme-integrations/bitodeme_rb","owner":"bitodeme-integrations","description":"Bitödeme Ruby Client","archived":false,"fork":false,"pushed_at":"2018-07-24T08:04:24.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-21T07:07:41.262Z","etag":null,"topics":["bitcoin","bitcoin-payment","bitcoin-wallet","payment-gateway","rest-client","sdk-ruby"],"latest_commit_sha":null,"homepage":"http://www.rubydoc.info/gems/bitodeme","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitodeme-integrations.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-17T06:00:23.000Z","updated_at":"2018-07-24T08:04:26.000Z","dependencies_parsed_at":"2022-11-03T04:45:38.119Z","dependency_job_id":null,"html_url":"https://github.com/bitodeme-integrations/bitodeme_rb","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bitodeme-integrations/bitodeme_rb","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitodeme-integrations%2Fbitodeme_rb","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitodeme-integrations%2Fbitodeme_rb/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitodeme-integrations%2Fbitodeme_rb/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitodeme-integrations%2Fbitodeme_rb/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitodeme-integrations","download_url":"https://codeload.github.com/bitodeme-integrations/bitodeme_rb/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitodeme-integrations%2Fbitodeme_rb/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278778968,"owners_count":26044256,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","bitcoin-payment","bitcoin-wallet","payment-gateway","rest-client","sdk-ruby"],"created_at":"2024-09-28T04:05:16.159Z","updated_at":"2025-10-08T16:20:54.805Z","avatar_url":"https://github.com/bitodeme-integrations.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bitodeme\n\nBitödeme official Ruby client.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'bitodeme'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install bitodeme\n\nThen set environment vars:\n\n```shell\nexport BITODEME_HOSTNAME=alpha.bitodeme.com; # Bitodeme Domain\nexport BITODEME_CLIENT_ID=clientidentifier; # API key\nexport BITODEME_CLIENT_SECRET=clientsecret; # API secret\nexport BITODEME_CLIENT_LOGGING=true; # To enable logging (optional)\n```\n\n## Usage\n\n### Currency\n\nFetch all currencies\n```ruby\ncurrencies = Bitodeme.list_currencies\n```\n\nFetch all updated currencies after given time in milli seconds\n```ruby\nupdated_currencies = Bitodeme.list_currencies(since: 1604131436476)\n```\n\nPagination\n```ruby\nlast_10_currencies = Bitodeme.list_currencies(page: 1, per_page: 10)\n```\n\n### Deposit (Unconfirmed deposits only)\n\nFetch all unconfirmed deposits\n\n```ruby\ndeposits = Bitodeme.list_deposits\n```\n\n### Funds\n\nFetch all funds\n```ruby\nfunds = Bitodeme.list_funds\n```\n\nFetch all updated funds after given time\n```ruby\nupdated_funds = Bitodeme.list_funds(since: 1513418293)\n```\n\n### FundAddress\n\nFetch all fund addresses\n```ruby\nfund_addresses = Bitodeme.list_fund_addresses\n```\n\nFetch all updated fund_addresses after given time\n```ruby\nupdated_fund_addresses = Bitodeme.list_fund_addresses(since: 1513418293)\n```\n\n### Invoice\n\nFetch an invoice information\n```ruby\ninvoice = Bitodeme.find_invoice('id')\n```\n\nBuild \u0026 create an invoice\n```ruby\nrequire 'securerandom'\nmy_unique_order_id = SecureRandom.hex\n\ninvoice =\n  Bitodeme.build_invoice(\n    name:                   'Virtual game gold',\n    description:            'Buy a game gold',\n    original_amount:        16.7,\n    original_currency_code: 'USD',\n    external_id:            my_unique_order_id,\n    notify_url:             'https://requestb.in/1hfs3rr1',\n    return_url:             'https://requestb.in/1hfs3rr1',\n    cancel_return_url:      'https://requestb.in/xyz',\n    purchasable:            {}\n  )\n\ninvoice = Bitodeme.create_invoice(invoice)\n```\n\n### Transaction Logs\n\nFetch all transaction logs (deposits, withdrawals and fees)\n```ruby\ntransaction_logs = Bitodeme.list_transaction_logs\n```\n\nFind a transaction_log\n```ruby\ntransaction_log = Bitodeme.find_transaction_log('id')\n```\n\n### Withdrawal (Send money)\n\nBuild \u0026 create a withdrawal (send money)\n```ruby\nfund_id    = '12b241a7-941e-43a8-878e-a467809e988e'\nwithdrawal =\n  Bitodeme.build_withdrawal(\n    amount:    0.0013,\n    address:   'morg4YKzAESEktS7H74dtaavFjuhNUi8zq',\n    fund_id:   fund_id,\n    otp_value: \"123456\" # otp value from Google Authenticator\n  )\n\nBitodeme.create_withdrawal(withdrawal)\n=\u003e {\"status\"=\u003e\"accepted\"}\n```\n\n### Notes\n\n- All plural methods support `pagination`(`per_page` and `page`) and `since` query parameters\n\n- Max allowed `per_page` value is 50, if you need more than 50 data, you have to paginate\n\n- The `since` query parameter filters data by `updated_at` attribute\n\n- The `transaction_logs` endpoint also takes `starts_at` and `ends_at` query params which filter content by creation date\n\n### Authentication\n\nBitodeme endpoint requests automatically authenticated by `bitodeme` library. But in case you need, you can fetch access token by running the command below. The token automatically renews itself, so you don't need to worry about token expiration. Note: Auth class instance is shared across the threads, so everytime you should get the same token until it expires.\n\n```ruby\nauth = Bitodeme::Auth.build\nauth.token\n```\n\n## Standalone Usage\n\nIn project root folder:\n```shell\n# Create an env file\n# Edit yout .env file from alpha.bitodeme.com client credentials\ncp .env.example .env\n\n# Bundle\nbundle\n\n# Run console\nbin/console\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/bitodeme-integrations/bitodeme_rb.\n\n## References\n\nAPI Documentation: https://documenter.getpostman.com/view/2573284/bitodeme/7ED9Yvv\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitodeme-integrations%2Fbitodeme_rb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitodeme-integrations%2Fbitodeme_rb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitodeme-integrations%2Fbitodeme_rb/lists"}