{"id":23433932,"url":"https://github.com/ioki-mobility/airship-ruby","last_synced_at":"2025-10-30T20:36:56.365Z","repository":{"id":49793077,"uuid":"516325857","full_name":"ioki-mobility/airship-ruby","owner":"ioki-mobility","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-10T16:43:08.000Z","size":103,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-04T23:50:59.204Z","etag":null,"topics":[],"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/ioki-mobility.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"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":"2022-07-21T10:30:11.000Z","updated_at":"2024-02-12T13:08:31.000Z","dependencies_parsed_at":"2024-12-23T11:35:47.957Z","dependency_job_id":"c829f540-6403-44d6-9e65-feca96413eaa","html_url":"https://github.com/ioki-mobility/airship-ruby","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/ioki-mobility/airship-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fairship-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fairship-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fairship-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fairship-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ioki-mobility","download_url":"https://codeload.github.com/ioki-mobility/airship-ruby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fairship-ruby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276954365,"owners_count":25734700,"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-09-25T02:00:09.612Z","response_time":80,"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":[],"created_at":"2024-12-23T11:35:41.501Z","updated_at":"2025-09-25T17:18:57.119Z","avatar_url":"https://github.com/ioki-mobility.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# airship-ruby [![CI Status](https://github.com/ioki-mobility/airship-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/ioki-mobility/airship-ruby/actions/workflows/main.yml)\n\nThis library helps to integrate the Airship's web-api.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'airship-ruby'\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install airship-ruby\n\n## Configuration (optional)\n\nConfigure custom tracking-procedures in an initializer file `config/airship.rb`\n\n```ruby\nrequire 'airship'\n\nAirship.config.request_tracker = proc do |api_endpoint|\n  MyLoggingService.log(\n    \"Hey guys, I just made a request to Airship (api_endpoint=#{api_endpoint})!\"\n  )\nend\n\nAirship.config.error_tracker = proc do |api_endpoint, response_code|\n  MyErrorMonitoringService.track_error(\n    :airship_request_failed,\n    endpoint: api_endpoint,\n    response_code: response_code\n  )\nend\n```\n\n## Usage\nTo load this gem run:\n```ruby\nrequire 'airship'\n```\n\nTo perform any Api call:\n```ruby\nAirship::Api::NamedUserLookup.call(\n  app_key:       'my-airship-app-key',\n  token:         '***SECRET_AIRSHIP_TOKEN***',\n  named_user_id: 'harry.potter'\n)\n```\n\nThe response of an Api call usually returns an json-string of the response-body:\n\n```json\n{\n  \"ok\": true,\n  \"named_user\": {\n      \"named_user_id\": \"harry.potter\",\n      \"tags\": {\n          \"prison_of_azkaban\": [\"locked\"]\n      },\n      \"created\": \"2020-03-30T14:38:49\",\n      \"last_modified\": \"2020-03-31T09:57:32\",\n      \"channels\": [{\n          \"channel_id\": \"70c0b58f-942f-4b27-b4e3-13f47a80ab28\",\n          \"device_type\": \"email\",\n          \"installed\": true,\n          \"opt_in\": true,\n          \"background\": false,\n          \"created\": \"2020-03-27T07:40:57\",\n          \"last_registration\": \"2020-03-30T15:12:35\",\n          \"alias\": null,\n          \"tags\": [],\n          \"tag_groups\": {\n              \"ua_channel_type\": [\"email\"],\n              \"prison_of_azkaban\": [\"locked\"],\n              \"timezone\": [\"Europe/Paris\"],\n              \"named_user_id\": [\"f4f489d7-bb08-4be6-b7a6-0775d3e7f591\"],\n              \"ua_locale_language\": [\"en\"],\n              \"ua_opt_in\": [\"true\"],\n              \"ua_background_enabled\": [\"false\"]\n          },\n          \"commercial_opted_in\": \"2020-03-30T15:12:35\"\n      }]\n  }\n}\n```\n\nAny request that results in an unexpected error (meaning all response https-status-codes except `2**`) will raise an `Airship::Api::Error`. Depending on the exact kind  of error it will raise different subclasses of `Airship::Api::Error`:\n\n* `Airship::Api::Unauthorized` if http-status is `401`\n* `Airship::Api::Forbidden` if http-status is `403`\n* `Airship::Api::ChannelNotFound` if the error-payload of the response-body includes something like `'Channel ID .*does not exist.*'`\n* `Airship::Api::UnexpectedResponseCode` for any other kind of error (like http-stauts `500`)\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 the created tag, 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/ioki-mobility/airship-ruby.\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%2Fioki-mobility%2Fairship-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fioki-mobility%2Fairship-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fioki-mobility%2Fairship-ruby/lists"}