{"id":20851651,"url":"https://github.com/emsk/backlog_kit","last_synced_at":"2025-05-12T04:32:16.161Z","repository":{"id":31598877,"uuid":"35163739","full_name":"emsk/backlog_kit","owner":"emsk","description":"Client library for the Nulab's Backlog API version 2 written in Ruby.","archived":false,"fork":false,"pushed_at":"2022-06-28T11:35:52.000Z","size":285,"stargazers_count":29,"open_issues_count":2,"forks_count":17,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-14T09:12:13.851Z","etag":null,"topics":["api-client","backlog","gem","ruby"],"latest_commit_sha":null,"homepage":null,"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/emsk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-06T14:33:00.000Z","updated_at":"2023-02-08T04:12:30.000Z","dependencies_parsed_at":"2022-09-14T10:03:00.918Z","dependency_job_id":null,"html_url":"https://github.com/emsk/backlog_kit","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fbacklog_kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fbacklog_kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fbacklog_kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emsk%2Fbacklog_kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emsk","download_url":"https://codeload.github.com/emsk/backlog_kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225119935,"owners_count":17423818,"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","backlog","gem","ruby"],"created_at":"2024-11-18T03:14:27.229Z","updated_at":"2024-11-18T03:14:27.965Z","avatar_url":"https://github.com/emsk.png","language":"Ruby","readme":"# BacklogKit\n\n[![Gem Version](https://badge.fury.io/rb/backlog_kit.svg)](https://badge.fury.io/rb/backlog_kit)\n[![Build Status](https://github.com/emsk/backlog_kit/actions/workflows/build.yml/badge.svg)](https://github.com/emsk/backlog_kit/actions/workflows/build.yml)\n[![Build Status](https://travis-ci.org/emsk/backlog_kit.svg?branch=main)](https://travis-ci.org/emsk/backlog_kit)\n[![Build status](https://ci.appveyor.com/api/projects/status/no4jqaoimctfsejj?svg=true)](https://ci.appveyor.com/project/emsk/backlog-kit)\n[![Build Status](https://dev.azure.com/emsk/backlog_kit/_apis/build/status/emsk.backlog_kit?branchName=main)](https://dev.azure.com/emsk/backlog_kit/_build/latest?definitionId=1\u0026branchName=main)\n[![Codecov](https://codecov.io/gh/emsk/backlog_kit/branch/main/graph/badge.svg)](https://codecov.io/gh/emsk/backlog_kit)\n[![Code Climate](https://codeclimate.com/github/emsk/backlog_kit/badges/gpa.svg)](https://codeclimate.com/github/emsk/backlog_kit)\n[![Inline docs](https://inch-ci.org/github/emsk/backlog_kit.svg?branch=main)](https://inch-ci.org/github/emsk/backlog_kit)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\nRuby wrapper for the Nulab's Backlog API.\n\nhttps://developer.nulab.com/docs/backlog/\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'backlog_kit'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install backlog_kit\n\n## Usage\n\n```ruby\nrequire 'backlog_kit'\n\nclient = BacklogKit::Client.new(\n  space_id: 'emsk',\n  api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234'\n)\n\nclient.get_space.body # get body\nclient.get_space.headers # get headers\nclient.get_space.status # get status\n\nclient.get_space_activities # no params\nclient.get_space_activities(activity_type_id: [1, 4], min_id: 100) # underscored key\nclient.get_space_activities(activityTypeId: [1, 4], minId: 100) # camelized key\n\nclient.get_groups.body[0].members[0].mail_address # method chaining\n```\n\nYou can also use low-level methods.\n\n```ruby\nclient.get('projects/1234/customFields') # GET\nclient.post('groups', name: 'beer') # POST\nclient.put('space/notification', content: 'Cheers!') # PUT\nclient.patch('groups/3712', name: 'whiskey') # PATCH\nclient.delete('groups/3712') # DELETE\n```\n\n## Authentication\n\n### API key\n\n```ruby\nclient = BacklogKit::Client.new(\n  space_id: 'emsk',\n  api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234'\n)\n```\n\n### OAuth access token\n\n```ruby\nclient = BacklogKit::Client.new(\n  space_id: 'emsk',\n  api_key: nil, # api_key should be nil\n  access_token: 'abcdefghij1234567890abcdefghij1234567890abcdefghij1234567890abcd'\n)\n```\n\n## BacklogKit::Client Config\n\n| Variable | ENV Variable | Description | Default |\n| :------- | :----------- | :---------- | :------ |\n| `space_id` | `BACKLOG_SPACE_ID` | Your Backlog SPACE ID. ||\n| `second_level_domain` | `BACKLOG_SECOND_LEVEL_DOMAIN` | Your Backlog SECOND LEVEL DOMAIN. | `backlog` |\n| `top_level_domain` | `BACKLOG_TOP_LEVEL_DOMAIN` | Your Backlog TOP LEVEL DOMAIN. | `com` |\n| `api_key` | `BACKLOG_API_KEY` | Your Backlog API KEY. ||\n| `client_id` | `BACKLOG_OAUTH_CLIENT_ID` | CLIENT ID of your Backlog application. ||\n| `client_secret` | `BACKLOG_OAUTH_CLIENT_SECRET` | CLIENT SECRET of your Backlog application. ||\n| `refresh_token` | `BACKLOG_OAUTH_REFRESH_TOKEN` | REFRESH TOKEN obtained from the token endpoint. ||\n\nIf you set ENV variables, you can create an instance more simply.\n\n```ruby\nclient = BacklogKit::Client.new\n```\n\n## Supported Backlog API Version\n\nBacklogKit supports Backlog API [2.32.2](https://developer.nulab.com/docs/backlog/changes/#2-32-2-2018-12-18).\n\nBacklogKit's API documentation is [here](https://www.rubydoc.info/gems/backlog_kit).\n\n## Supported Ruby Versions\n\n* Ruby 2.0.0\n* Ruby 2.1\n* Ruby 2.2\n* Ruby 2.3\n* Ruby 2.4\n* Ruby 2.5\n* Ruby 2.6\n* Ruby 2.7\n\n## Contributing\n\n1. Fork it ( https://github.com/emsk/backlog_kit/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsk%2Fbacklog_kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femsk%2Fbacklog_kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femsk%2Fbacklog_kit/lists"}