PSN::Client

A Ruby client for the PlayStation Network (PSN) API. Handles authentication via an NPSSO cookie and provides access to user trophy data.

Install the gem and add to the application's Gemfile by executing:

bundle add psn-client

If bundler is not being used to manage dependencies, install the gem by executing:

gem install psn-client

Authentication requires three environment variables. You can find the values in the PSN API documentation or the bundled API reference.

require 'psn/client'

access_token = PSN::Client::Auth.authenticate

authenticate exchanges your NPSSO token for a short-lived PSN access token string.

Pass the access token to PSN::Client::Trophies and call the relevant method. All user_id parameters default to 'me' (the authenticated user).

trophies = PSN::Client::Trophies.new(access_token)

# Overall trophy level, points, and earned counts
trophies.trophy_summary
trophies.trophy_summary(user_id: 'example_user')

# List of trophy titles (games) for a user
trophies.trophy_titles
trophies.trophy_titles(limit: 100, offset: 0)

# Trophy groups defined for a title
# Use `platform:` shorthand ('PS3', 'PS4', 'PSVita', 'PS5', 'PC') or pass
# `np_service_name:` directly ('trophy' or 'trophy2').
trophies.title_trophy_groups(np_communication_id: 'NPWR12345_00', platform: 'PS5')

# Trophy group progress earned by a user on a title
trophies.earned_trophy_groups(np_communication_id: 'NPWR12345_00', platform: 'PS5')

# Full trophy list for a title
trophies.title_trophies(np_communication_id: 'NPWR12345_00', platform: 'PS5')

# Trophy earned status for a user on a title
trophies.earned_trophies(np_communication_id: 'NPWR12345_00', platform: 'PS5')

After 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.

For breakpoints while working on the gem, use Ruby's debug gem. After running bin/setup or bundle install, add binding.break where you want execution to pause and run the code under bundle exec, for example bundle exec rspec or bundle exec ruby bin/verify_trophies.rb.

To 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.

Bug reports and pull requests are welcome on GitHub at https://github.com/MattyJacques/psn-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the PSN::Client project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.