{"id":25757959,"url":"https://github.com/aj-rom/warframe-ruby","last_synced_at":"2025-10-31T20:02:44.164Z","repository":{"id":44040256,"uuid":"426515250","full_name":"aj-rom/warframe-ruby","owner":"aj-rom","description":"Ruby Client for the Warframe Stat API packaged into a gem.","archived":false,"fork":false,"pushed_at":"2022-02-12T18:52:23.000Z","size":256,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-21T03:19:50.272Z","etag":null,"topics":["ruby","ruby-gem","warframe","warframe-community"],"latest_commit_sha":null,"homepage":"https://rubydoc.info/gems/warframe","language":"Ruby","has_issues":false,"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/aj-rom.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-10T06:52:58.000Z","updated_at":"2024-05-21T03:19:50.273Z","dependencies_parsed_at":"2022-08-28T09:31:45.443Z","dependency_job_id":null,"html_url":"https://github.com/aj-rom/warframe-ruby","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aj-rom%2Fwarframe-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aj-rom%2Fwarframe-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aj-rom%2Fwarframe-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aj-rom%2Fwarframe-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aj-rom","download_url":"https://codeload.github.com/aj-rom/warframe-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240891578,"owners_count":19874209,"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":["ruby","ruby-gem","warframe","warframe-community"],"created_at":"2025-02-26T16:35:51.313Z","updated_at":"2025-10-31T20:02:44.112Z","avatar_url":"https://github.com/aj-rom.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# warframe-ruby\n[![Supported by Warframe Community Developers](https://warframestat.us/wfcd.png)](https://github.com/WFCD/banner/blob/main/PROJECTS.md \"Supported by Warframe Community Developers\")\n[![Ruby Gem Version](https://badgen.net/rubygems/v/warframe)](https://rubygems.org/gems/warframe)\n[![Downloads](https://badgen.net/rubygems/dt/warframe)](https://rubygems.org/gems/warframe)\n[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)\n[![Platform](https://badgen.net/rubygems/p/warframe)](https://www.ruby-lang.org/en/)\n\n\nA Ruby client for [Warframe Stat](https://warframestat.us) bringing you live modeled data from their API.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'warframe'\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install warframe\n\n## Usage\n\nTo get started accessing live data, you must instantiate a new `Warframe::REST::Client`\n```ruby\nrequire 'warframe'\n\nclient = Warframe::REST::Client.new # =\u003e \u003cWarframe::REST::Client platform='pc' language='en'\u003e\n\n# You can supply a hash to set your preferred platform or language.\nmy_custom_options = { platform: 'ps4', language: 'de' }\ngerman_ps4 = Warframe::REST:Client.new my_custom_options # =\u003e \u003cWarframe::REST::Client platform='ps4' language='de'\u003e\n```\n\nThis gives us access to a plethora of methods, check out the [documentation](https://rubydoc.info/gems/warframe) for more info.\n```ruby\n\nclient = Warframe::REST::Client.new\nclient.nightwave # =\u003e \u003cWarframe::Models::Nightwave\u003e\nclient.alerts # =\u003e [ \u003cWarframe::Models::Alert\u003e, \u003cWarframe::Models::Alert\u003e ]\n```\n\n## Documentation\n\nDocumentation is currently provided by [rubydoc.info](https://rubydoc.info), check out the current versions documentation at https://rubydoc.info/gems/warframe.\n\n## Development\n\n### Dependency Management\nAfter checking out the repo, run: \n\n    $ bundle install\n    \n\u003e This will install all required dependencies for this gem to run.\n\n### Testing\nTo check if your changes are passing tests, run:\n\n    $ thor test:rspec\n\n\u003e Testing framework provided by [RSpec](https://rspec.info/).\n\n### Linting\nTo auto-correct styling offenses, run: \n\n    $ thor style:fix\n\n\u003e All linting is provided by [RuboCop](https://github.com/rubocop/rubocop).\n\n### Generating New Routes / Models with Thor\nUsing Thor allows us to create new routes and models via the command line, making it very simple to add new elements.\n\nFor example if we wanted to add, [conclaveChallenges](https://docs.warframestat.us/#tag/Worldstate/paths/~1{platform}~1conclaveChallenges/get) we run:\n\n    $ thor generate conclaveChallenges \n    \n    \u003e       create  lib/warframe/models/conclave_challenge.rb\n    \u003e       create  lib/warframe/rest/api/conclave_challenges.rb\n    \u003e       conflict  lib/warframe/rest/api.rb\n    \u003e Overwrite ~/warframe/lib/warframe/rest/api.rb? (enter \"h\" for help) [Ynaqdh] \n    \n    $ Y\n    \n    \u003e       force  lib/warframe/rest/api.rb\n\nThis creates a blank [model](/lib/warframe/models) for the data and a [route](/lib/warframe/rest/api) with a name spaced method for it, and then adds this method to our [REST::API](/lib/warframe/rest/api). Add attributes to the corresponding model and then write associated tests.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/aj-rom/warframe-ruby. 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/aj-rom/warframe-ruby/blob/master/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faj-rom%2Fwarframe-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faj-rom%2Fwarframe-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faj-rom%2Fwarframe-ruby/lists"}