{"id":19206788,"url":"https://github.com/hausgold/billomat","last_synced_at":"2025-04-15T17:39:40.126Z","repository":{"id":25705840,"uuid":"102526740","full_name":"hausgold/billomat","owner":"hausgold","description":"API wrapper for billomat.com","archived":false,"fork":false,"pushed_at":"2025-03-06T06:49:32.000Z","size":144,"stargazers_count":4,"open_issues_count":2,"forks_count":7,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-30T12:02:05.801Z","etag":null,"topics":["api-client","billomat","gem","hacktoberfest","oss","ruby","ruby-gem"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/billomat","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/hausgold.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-05T20:27:57.000Z","updated_at":"2025-03-06T06:49:35.000Z","dependencies_parsed_at":"2023-02-10T13:32:06.586Z","dependency_job_id":"f11fe48a-9771-4bfb-8d15-f78a779b78ca","html_url":"https://github.com/hausgold/billomat","commit_stats":{"total_commits":51,"total_committers":9,"mean_commits":5.666666666666667,"dds":0.6470588235294117,"last_synced_commit":"58132958573473af108c3ae0a6e53a19cf902469"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hausgold%2Fbillomat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hausgold%2Fbillomat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hausgold%2Fbillomat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hausgold%2Fbillomat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hausgold","download_url":"https://codeload.github.com/hausgold/billomat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249120422,"owners_count":21215948,"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","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":["api-client","billomat","gem","hacktoberfest","oss","ruby","ruby-gem"],"created_at":"2024-11-09T13:17:00.625Z","updated_at":"2025-04-15T17:39:40.100Z","avatar_url":"https://github.com/hausgold.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Billomat](doc/assets/project.svg)\n\n[![Continuous Integration](https://github.com/hausgold/billomat/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/billomat/actions/workflows/test.yml)\n[![Gem Version](https://badge.fury.io/rb/billomat.svg)](https://badge.fury.io/rb/billomat)\n[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/billomat/coverage.svg)](https://knowledge.hausgold.de/coverage)\n[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/billomat/ratio.svg)](https://knowledge.hausgold.de/coverage)\n[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/billomat/documentation.svg)](https://www.rubydoc.info/gems/billomat)\n\nThis gem provides a Ruby API for [billomat.com](https://billomat.com) - an\nonline accounting service.\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [Configuration](#configuration)\n  - [Basic usage](#basic-usage)\n- [Development](#development)\n- [Code of Conduct](#code-of-conduct)\n- [Contributing](#contributing)\n- [Releasing](#releasing)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'billomat'\n```\n\nAnd then execute:\n\n```bash\n$ bundle\n```\n\nOr install it yourself as:\n\n```bash\n$ gem install billomat\n```\n\n## Usage\n\n### Configuration\n\nThe billomat gem can be easily configured.\nIf you're using Rails you might want to put this in your `application.rb`\nor inside an initializer.\n\n```ruby\nBillomat.configure do |config|\n  # Subdomain, e.g. example.billomat.net\n  config.subdomain = 'example'\n  # API key\n  config.api_key   = '4aefdc...'\n  # timeout in seconds\n  config.timeout   = 5\n\n  # You can also configure a registerd app to increase your\n  # API call limit as described here:\n  # https://www.billomat.com/en/api/basics/rate-limiting/\n  config.app_id = '12345'\n  config.app_secret = 'c3df...'\n\n  config.after_response = lambda do |response|\n    # API response callback, e.g. for inspecting the rate limit\n    # header via response.headers[:x_rate_limit_remaining]\n  end\nend\n```\n\n### Basic usage\n\nCurrently there is basic support for the models:\n* `Invoice`\n* `Client`\n* `InvoicePayment`\n* `InvoiceItem`\n* `Contact`\n\n```ruby\nBillomat::Models::Invoice.where(invoice_number: 'RE1234')\n=\u003e [#\u003cBillomat::Models::Invoice:0x005574b58d6510 ...]\n\nBillomat::Models::Invoice.find('1234')\n=\u003e #\u003cBillomat::Models::Invoice:0x005574b58d6510\n\nclient = Billomat::Models::Client.find('1234')\nclient.save\n=\u003e true\n\nclient.delete\n=\u003e true\n```\n\n## Development\n\nAfter checking out the repo, run `make install` to install dependencies. Then,\nrun `make test` to run the tests. You can also run `make shell-irb` for an\ninteractive prompt that will allow you to experiment.\n\n## Code of Conduct\n\nEveryone interacting in the project codebase, issue tracker, chat\nrooms and mailing lists is expected to follow the [code of\nconduct](./CODE_OF_CONDUCT.md).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/hausgold/billomat. Make sure that every pull request adds\na bullet point to the [changelog](./CHANGELOG.md) file with a reference to the\nactual pull request.\n\n## Releasing\n\nThe release process of this Gem is fully automated. You just need to open the\nGithub Actions [Release\nWorkflow](https://github.com/hausgold/billomat/actions/workflows/release.yml)\nand trigger a new run via the **Run workflow** button. Insert the new version\nnumber (check the [changelog](./CHANGELOG.md) first for the latest release) and\nyou're done.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhausgold%2Fbillomat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhausgold%2Fbillomat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhausgold%2Fbillomat/lists"}