psn-api 2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fd01e29b9e381d0e5c7fff90f9f471daf2ed212c587cb18784246f6a89b4dea
+  data.tar.gz: a085e812ec9f4810c510d3e746ff4f3918ebbc1e7ee9a99a244f143c7d992b8a
+SHA512:
+  metadata.gz: 866827eb43bc81a4db69c2ec0eaf5099cf7c3dbd342c563649fd775e4f947d32f61b38baa8688f735ec605cb6830475ad4b8eab9de6c1841d1bd6d1389bf58dc
+  data.tar.gz: 8e39cab6c3a08cb2ae2060bc11916733e74f10a1df86b0c2a84300eb9e154f2c7952dee75a92a0b1f4a2c3270e692e1d6abab461633a4f7b9207f8fa23ec208e

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore Gemfile.lock
+# 
+*.lock
+
+# Ignore generated .gem files
+# 
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@games.directory. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# PlayStationNetwork::API
+
+Retrieve User Information, Trophies, Game and Store data from the PlayStation Network
+
+## Development
+
+While I work on a proper documentation on how to use this gem, please refer to this issue on how to install and use it: https://github.com/games-directory/api-psn/issues/1
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/games-directory/api-playstationnetwork/. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2020 Vlad Radulescu, Studio51 Solutions, Studio51 Gaming Solutions, games.directory
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+require 'irb/completion'
+require 'psn-api'
+
+def reload!
+  files = $LOADED_FEATURES.select { |feat| feat =~ /\/play_station_network_api\// }
+  files.each { |file| load file }
+end
+
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/play_station_network_api/catalog.rb

@@ -0,0 +1,91 @@
+module PlayStationNetworkAPI
+  class Catalog < PlayStationNetworkAPI::Client
+
+    # offset [Integer]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 1000
+    # }
+    def most_purchased(offset: 0, limit: 10)
+      raise 'limit must be less than or equal to 1000' if limit > 1000
+      warn "[DEPRECATED] This endpoint has been marked as deprecated on the PlayStation API, don't rely on it as things might break in the future!"
+
+      # https://m.np.playstation.net/api/catalog/v2/concepts/fetch?country=GB&language=en&age=999&limit=1000&offset=1
+      get([path, 'concepts', 'fetch'].join('/'),
+        query: {
+          country: country,
+          language: language,
+          age: 999,
+          limit: limit,
+          offset: offset
+        }
+      ).parsed_response
+    end
+
+    # concept_id [Integer]
+    # metadata [Boolean]: Different data is returned when true; stuff like age restrictions, release dates in different countries etc..
+    def concept(concept_id, metadata: false)
+      options = {}
+
+      if metadata
+        options[:query] = {
+          country: country,
+          language: language,
+          age: 999
+        }
+      end
+
+      # https://m.np.playstation.net/api/catalog/v2/concepts/10000470
+      # https://m.np.playstation.net/api/catalog/v2/concepts/10000470?country=GB&language=en&age=999
+      get([path, 'concepts', concept_id].join('/'), options).parsed_response
+    end
+
+    # concept_id [Integer]
+    # offset [Integer]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 1000
+    # }
+    def products(concept_id, offset: 0, limit: 10)
+      raise 'limit must be less than or equal to 1000' if limit > 1000
+      
+      # https://m.np.playstation.net/api/catalog/v2/concepts/10000470/products?country=GB&language=en&age=999&limit=1000
+      get([path, 'concepts', concept_id, 'products'].join('/'),
+        query: {
+          country: country,
+          language: language,
+          age: age,
+          limit: limit,
+          offset: offset
+        }
+      ).parsed_response
+    end
+
+    # title_ids [Array[String]]
+    def title_ids_to_concept_id(title_ids)
+      raise 'limit must be less than or equal to 500' if title_ids.length > 500
+
+      # https://m.np.playstation.net/api/catalog/v2/titles/[..]/concepts/id
+      response = get([path, 'titles', title_ids, 'concepts', 'id'].join('/')).parsed_response
+      
+      return title_ids.length == 1 ? response[0] : response
+    end
+
+    # title_id [String]
+    def title(title_id)
+      # https://m.np.playstation.net/api/catalog/v2/titles/CUSA18182_00/?country=GB&language=en&age=999
+      get([path, 'title', title_id].join('/')).parsed_response
+    end
+
+    # title_id [String]
+    def title_age_limit(title_id)
+      get([path, 'title', title_id, 'ageLimit'].join('/')).parsed_response
+    end
+
+  private
+
+    def path
+      '/catalog/v2'.freeze
+    end
+  end
+end

data/lib/play_station_network_api/client.rb

@@ -0,0 +1,152 @@
+require 'httparty'
+
+module PlayStationNetworkAPI
+  class Client
+    VERSION ||= '2.0'
+  
+    include HTTParty
+    base_uri 'https://m.np.playstation.net/api'
+
+    attr_accessor :refresh_token, :default_headers, :account_id, :country, :language, :age
+
+    def initialize(refresh_token, account_id: 'me', country: 'GB', language: 'en')
+      @refresh_token = refresh_token
+      @default_headers = {
+        # TODO: Make this a variable for other languages
+        'Accept-Language' => 'en-US',
+        'User-Agent' => "psn-api/#{ VERSION }"
+      }
+
+      @account_id = account_id
+      @country = country
+      @language = language
+    end
+
+  public
+
+    def catalog
+      PlayStationNetworkAPI::Catalog.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def entitlement
+      PlayStationNetworkAPI::Entitlement.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def explore
+      PlayStationNetworkAPI::Explore.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def game
+      PlayStationNetworkAPI::Game.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def search
+      PlayStationNetworkAPI::Search.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def session
+      PlayStationNetworkAPI::Session.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def trophy
+      PlayStationNetworkAPI::Trophy.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+
+    def user
+      PlayStationNetworkAPI::User.new(refresh_token, 
+        account_id: account_id, 
+        country: country, 
+        language: language
+      )
+    end
+      
+    # @private true
+    def get_account_id
+      self.class.base_uri 'https://dms.api.playstation.com/api'
+
+      # https://dms.api.playstation.com/api/v1/devices/accounts/me
+      get('/v1/devices/accounts/me').parsed_response['accountId']
+    end
+
+    def get_account_devices
+      self.class.base_uri 'https://dms.api.playstation.com/api'
+
+      # https://dms.api.playstation.com/api/v1/devices/accounts/me
+      get('/v1/devices/accounts/me').parsed_response['accountDevices']
+    end
+
+  protected
+
+    def get(url, options = {})
+      access_token = PlayStationNetworkAPI::Session.new(refresh_token).access_token
+      
+      base_uri = options[:base_uri]
+      options.delete(:base_uri)
+
+      headers = options[:headers] || {}
+      options.delete(:headers)
+
+      self.class.base_uri base_uri if base_uri
+
+      self.class.get(url,
+        headers: {
+          **default_headers,
+          'Authorization' => "Bearer #{ access_token }",
+          **headers
+        },
+        **options
+      )
+    end
+
+    def post(url, options = {})
+      access_token = PlayStationNetworkAPI::Session.new(refresh_token).access_token
+      
+      self.class.post(url,
+        headers: {
+          **default_headers,
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{ access_token }"
+        },
+        **options
+      )
+    end
+
+  private
+
+    def self.changelog
+      # v2.0
+      # Implemented the new API that's currently present in the new PlayStation App.
+      # There are quite a few endpoints that currently return Access Denied, which probably means they're not active yet
+      
+      # v1.0
+    end
+  end
+end

data/lib/play_station_network_api/entitlement.rb

@@ -0,0 +1,33 @@
+module PlayStationNetworkAPI
+  class Entitlement < PlayStationNetworkAPI::Client
+
+    # offset [Integer]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 500
+    # }
+    def entitlements(offset: 0, limit: 500)
+      raise 'limit must be less than or equal to 500' if limit > 500
+
+      # https://m.np.playstation.net/api/entitlement/v2/users/me/internal/entitlements
+      get(path,
+        query: {
+          limit: limit,
+          offset: offset
+        }
+      ).parsed_response
+    end
+
+    # entitlement_id [String]
+    def entitlement(entitlement_id)
+      # https://m.np.playstation.net/api/entitlement/v2/users/me/internal/entitlements/EP0700-NPEB90430_00-RRUDEMOEU0000100
+      get([path, entitlement_id].join('/').parsed_response)
+    end
+
+  private
+
+    def path
+      '/entitlement/v2/users/me/internal/entitlements'.freeze
+    end
+  end
+end

data/lib/play_station_network_api/explore.rb

@@ -0,0 +1,15 @@
+module PlayStationNetworkAPI
+  class Explore < PlayStationNetworkAPI::Client
+    
+    def hub
+      # https://m.np.playstation.net/api/explore/v1/users/6462910331343535058/hub
+      get([path, account_id, 'hub'].join('/')).parsed_response
+    end
+
+  private
+
+    def path
+      '/explore/v1/users'.freeze
+    end
+  end
+end

data/lib/play_station_network_api/game.rb

@@ -0,0 +1,55 @@
+module PlayStationNetworkAPI
+  class Game < PlayStationNetworkAPI::Client
+
+    # @private false
+    # offset [Integer]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 300
+    # }
+    def titles(offset: 0, limit: 10)
+      raise 'limit must be less than or equal to 300' if limit > 300
+
+      # https://m.np.playstation.net/api/gamelist/v2/users/6462910331343535058/titles?limit=300&offset=0
+      get([path, account_id, 'titles'].join('/'),
+        query: {
+          offset: offset,
+          limit: limit
+        }
+      ).parsed_response
+    end
+
+    # @private false
+    # title_id [String]
+    def title(title_id)
+      # https://m.np.playstation.net/api/gamelist/v2/users/6462910331343535058/titles/CUSA00938_00
+      get([path, account_id, 'titles', title_id].join('/')).parsed_response
+    end
+
+    # COMMENT: Pretty much the same endpoint as [titles], except it gives a lot less data and there's no conceptId information
+    # 
+    # @private false
+    # offset [Integer]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 300
+    # }
+    def games(offset: 0, limit: 10)
+      raise 'limit must be less than or equal to 300' if limit > 300
+
+      # https://m.np.playstation.net/api/gamelist/v3/users/6462910331343535058/profile/games?limit=300&offset=0
+      get([path(version: 3), account_id, 'profile', 'games'].join('/'),
+        query: {
+          offset: offset,
+          limit: limit
+        }
+      ).parsed_response
+    end
+
+  private
+
+    def path(version: 2, resource: 'users')
+      "/gamelist/v#{ version }/#{ resource }/"
+    end
+  end
+end

data/lib/play_station_network_api/search.rb

@@ -0,0 +1,86 @@
+module PlayStationNetworkAPI
+  class Search < PlayStationNetworkAPI::Client
+    BUCKETS ||= {
+      BLENDED: 'Blended',
+      CONCEPT_GAME: 'ConceptGame',
+      CONCEPT_GAME_ALL: 'ConceptGameAll',
+      CONCEPT_GAME_MOBILE_APP: 'ConceptGameMobileApp',
+      CONCEPT_GAME_PS_NOW: 'ConceptGamePsNow',
+      CONCEPT_GAME_EXCLUDING_PS_NOW: 'ConceptGameExcludingPsNow',
+      CONCEPT_GAME_ADDONS: 'ConceptGameAddons',
+      CONCEPT_APPLICATION_GAME: 'ConceptApplicationGame',
+      CONCEPT_APPLICATION_VIDEO: 'ConceptApplicationVideo',
+      CONCEPT_OTHER_NON_GAME: 'ConceptOtherNonGame',
+      VIDEO_CATALOG: 'VideoCatalog',
+      VIDEO_CATALOG_MOVIE: 'VideoCatalogMovie',
+      VIDEO_CATALOG_TV_SERIES: 'VideoCatalogTVSeries',
+      SOCIAL_ALL_ACCOUNTS: 'SocialAllAccounts',
+      SOCIAL_FRIENDS: 'SocialFriends',
+      SOCIAL_FRIENDS_OF_FRIENDS: 'SocialFriendsOfFriends',
+      SOCIAL_FRIENDS_AND_FRIENDS_OF_FRIENDS: 'SocialFriendsAndFriendsOfFriends',
+      SOCIAL_UNRELATED_AND_FRIENDS_OF_FRIENDS: 'SocialUnrelatedAndFriendsOfFriends',
+      SOCIAL_UNRELATED: 'SocialUnrelated'
+    }.freeze
+    
+    # Returns a list of buckets available to pass to .query(domains: [])
+    # 
+    def buckets
+      BUCKETS.keys
+    end
+
+    # query [String]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 50
+    # }
+    # country [String]
+    # language [String]
+    def query(query, offset: 0, limit: 50, buckets: [:CONCEPT_GAME_MOBILE_APP])
+      search_domains = []
+      
+      buckets.each do |bucket|
+        search_domains.push({
+          "domain": BUCKETS[bucket.to_sym],
+          "pagination": {
+            
+            # TODO: It seems to be a Java GraphQL pagination thingy, when present it breaks the offset.
+            # So let's leave it out for now as we don't really need to paginate
+            # "cursor": "10"
+
+            "pageSize": limit,
+            "offset": offset
+          }
+        })
+      end
+
+      # https://m.np.playstation.net/api/search/v1/universalSearch
+      request = post('/search/v1/universalSearch',
+        body: {
+          "domainRequests": search_domains,
+          "age": "999",
+          "countryCode": country,
+          "searchTerm": query,
+          "languageCode": language
+        }.to_json
+      )
+
+      buckets = []
+
+      request.dig('domainResponses').map do |domain_response|
+        bucket = {}
+        bucket[domain_response['domain']] = {
+          total_results: domain_response['totalResultCount'],
+          results: domain_response['results']
+        }
+
+        buckets.push(bucket)
+      end
+
+      return {
+        query: request['prefix'],
+        suggestions: request['suggestions'],
+        buckets: buckets,
+      }
+    end
+  end
+end

data/lib/play_station_network_api/session.rb

@@ -0,0 +1,94 @@
+require 'httparty'
+
+module PlayStationNetworkAPI
+  class Session
+    include HTTParty
+    base_uri 'https://ca.account.sony.com/api'
+
+    DEFAULT_SCOPES ||= ['psn:clientapp', 'psn:mobile.v1'].join(' ').freeze
+    CLIENT_ID ||= 'ac8d161a-d966-4728-b0ea-ffec22f69edc'.freeze
+    
+    attr_accessor :token
+    
+    def initialize(token)
+      @token = token
+    end
+
+    def authenticate
+      code, cid = oauth_authorize
+      oauth_token(code)
+    end
+
+    alias_method :refresh, :authenticate
+
+    def access_token
+      oauth_token['access_token']
+    end
+
+    def expiration_date
+      (Time.now + oauth_token['refresh_token_expires_in']).to_datetime.to_s
+    end
+
+    def expired?
+      expiration_date < DateTime.now.to_s
+    end
+    
+  # private
+
+    def oauth_authorize
+      request = self.class.get('/authz/v3/oauth/authorize',
+        headers: {
+          'Cookie' => HTTParty::CookieHash.new().add_cookies({ npsso: token }).to_cookie_string
+        },
+
+        query: {
+          'access_type' => 'offline',
+          'client_id' => CLIENT_ID,
+          'redirect_uri' => 'com.playstation.PlayStationApp://redirect',
+          'response_type' => 'code',
+          'scope' => DEFAULT_SCOPES
+        },
+
+        follow_redirects: false
+      )
+
+      if (location = request.headers['location'])
+        code = location.match(/code=([A-Za-z0-9:\?_\-\.\/=]+)/)[1]
+        cid = location.match(/cid=([A-Za-z0-9:\?_\-\.\/=]+)/)[1]
+        
+        return code, cid
+      end
+    end
+
+    def oauth_token(code = nil)
+      body = {}
+
+      if code
+        body = {
+          'code' => code,
+          'grant_type' => 'authorization_code',
+          'redirect_uri' => 'com.playstation.PlayStationApp://redirect'
+        }
+      else
+        body = {
+          'refresh_token' => token,
+          'grant_type' => 'refresh_token'
+        }
+      end
+      
+      self.class.post('/authz/v3/oauth/token',
+        headers: {
+          'Host' => 'ca.account.sony.com',
+          'Referer' =>  'https://my.playstation.com/',
+          'Authorization' => 'Basic YWM4ZDE2MWEtZDk2Ni00NzI4LWIwZWEtZmZlYzIyZjY5ZWRjOkRFaXhFcVhYQ2RYZHdqMHY='
+        },
+
+        body: {
+          'scope' => DEFAULT_SCOPES,
+          **body,
+          'token_format' => 'jwt'
+        }
+      ).parsed_response
+    end
+  end
+end

data/lib/play_station_network_api/trophy.rb

@@ -0,0 +1,111 @@
+module PlayStationNetworkAPI
+  class Trophy < PlayStationNetworkAPI::Client
+    # TODO: Test against PS5 titles, using 'trophy2' as the npServiceName
+    
+    def summary
+      # https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/trophySummary
+      get([path, 'trophySummary'].join('/')).parsed_response
+    end
+
+    # title_ids [Array[String]]
+    # offset [Integer]
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 1000
+    # }
+    def titles(title_ids = [], offset: 0, limit: 10)
+      raise 'title_ids size must be less than or equal to 5' if title_ids.length > 5
+      raise 'limit must be less than or equal to 5000' if limit > 5000
+
+      if title_ids.empty?
+        # https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/trophyTitles
+        get([path, 'trophyTitles'].join('/'),
+          query: {
+            offset: offset,
+            limit: limit
+          }
+        ).parsed_response
+        
+        # TODO: Cast every response to a Model
+        # return PlayStationNetworkAPI::Models::Trophy.new(request.parsed_response)
+      else
+        # https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/titles/trophyTitles?npTitleIds=CUSA00054_00,CUSA07970_00,CUSA00208_00,CUSA00938_00,CUSA01985_00
+
+        get([path, 'titles', 'trophyTitles'].join('/'),
+          query: {
+            npTitleIds: title_ids.join(',')
+          }
+        ).parsed_response
+      end
+    end
+
+    # communication_id [String]
+    def trophy_groups(communication_id)
+      url = if account_id
+        # https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/npCommunicationIds/NPWR00133_00/trophyGroups?npServiceName=trophy
+        [path, 'npCommunicationIds', communication_id, 'trophyGroups']
+      else
+        # https://m.np.playstation.net/api/trophy/v1/npCommunicationIds/NPWR00133_00/trophyGroups?npServiceName=trophy
+        [path(communication_id), 'trophyGroups']
+      end
+
+      get(url.join('/'),
+        query: {
+          npServiceName: 'trophy'
+        }
+      ).parsed_response
+    end
+
+    # communication_id [String]
+    # trophy_group_id [String | Integer] => 'default', '001', 002
+    def trophies(communication_id, trophy_group_id = nil)
+      # BROKEN: https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/npCommunicationIds/NPWR00133_00/trophies?npServiceName=trophy
+      # https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/npCommunicationIds/NPWR00133_00/trophyGroups/default/trophies?npServiceName=trophy
+      get([path, 'npCommunicationIds', communication_id, 'trophyGroups', ([trophy_group_id, 'trophies'] if trophy_group_id)].flatten.compact.join('/'),
+        query: {
+          npServiceName: 'trophy'
+        }
+      ).parsed_response
+    end
+
+    # communication_id [String]
+    # trophy_id [Integer]
+    def trophy_details(communication_id, trophy_id)
+      url = if account_id
+        # https://m.np.playstation.net/api/trophy/v1/npCommunicationIds/NPWR00133_00/trophies/2?npServiceName=trophy
+        [path, 'npCommunicationIds', communication_id, 'trophies', trophy_id]
+      else
+        # https://m.np.playstation.net/api/trophy/v1/users/6462910331343535058/npCommunicationIds/NPWR00133_00/trophies/2?npServiceName=trophy
+        [path(communication_id), 'trophies', trophy_id]
+      end
+
+      get(url.join('/'),
+        query: {
+          npServiceName: 'trophy'
+        }
+      ).parsed_response
+    end
+
+    # title_ids Array[[String]]
+    def get_communication_id(title_ids = [])
+      # https://gb-tpy.np.community.playstation.net/trophy/v1/apps/trophyTitles?npTitleIds=CUSA15010_00,CUSA20046_00,CUSA24894_00,CUSA24269_00,CUSA24267_00
+      get('/trophy/v1/apps/trophyTitles',
+        base_uri: 'https://gb-tpy.np.community.playstation.net',
+        query: {
+          npTitleIds: title_ids.join(',')
+        },
+        
+      ).parsed_response
+    end
+
+  private
+
+    def path(communication_id = nil)
+      if communication_id
+        "/trophy/v1/npCommunicationIds/#{ communication_id }"
+      else
+        "/trophy/v1/users/#{ account_id }"
+      end
+    end
+  end
+end

data/lib/play_station_network_api/user.rb

@@ -0,0 +1,95 @@
+module PlayStationNetworkAPI
+  class User < PlayStationNetworkAPI::Client
+
+    # @private false
+    def profile
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/6462910331343535058/profiles
+      get([path, account_id, 'profiles'].join('/')).parsed_response
+    end
+
+    # @private false
+    # account_ids [Array[Integer]]
+    def profiles(account_ids)
+      raise 'account_ids size must be less than or equal to 100' if account_ids.length > 100
+
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/profiles?accountIds=6462910331343535058
+      get([path, 'profiles'].join('/'),
+        query: {
+          accountIds: account_ids.split.join(',')
+        }
+      ).parsed_response
+    end
+
+    # @private false
+    def presence
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/6462910331343535058/basicPresences?type=primary
+      get([path, account_id, 'basicPresences'].join('/'),
+        query: {
+          type: 'primary'
+        }
+      ).parsed_response
+    end
+    
+    # @private false
+    # account_ids [Array[Integer]]
+    def presences(account_ids)
+      raise 'account_ids size must be less than or equal to 100' if account_ids.length > 100
+
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/me/basicPresences?type=primary
+      get([path, 'basicPresences'].join('/'),
+        query: {
+          type: 'primary',
+          accountIds: account_ids.split.join(',')
+        }
+      ).parsed_response
+    end
+
+    # @private false
+    # limit [Integer] {
+    #   min: 1,
+    #   max: 1000
+    # }
+    def friends(limit: 1000)
+      raise 'limit must be less than or equal to 1000' if limit > 1000
+      
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/me/friends?limit=1000
+      get([path, account_id, 'friends'].join('/'),
+        query: {
+          limit: limit
+        }
+      ).parsed_response
+    end
+
+    # @private true
+    # friend_account_id [Integer]
+    def friendship(friend_account_id)
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/me/friends/9014970682312518995/summary
+      get([path, 'me', 'friends', friend_account_id, 'summary'].join('/')).parsed_response
+    end
+
+    # @private true
+    # type [Symbol] => :received, :sent
+    def friend_requests(type: :received)
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/me/friends/9014970682312518995/summary
+      get([path, 'me', 'friends', "#{ type.to_s }Requests"].join('/')).parsed_response
+    end
+
+    # @private true
+    def blocks
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/me/blocks
+      get([path, 'me', 'blocks'].join('/')).parsed_response
+    end
+
+    # @private true
+    def available_to_play
+      # https://m.np.playstation.net/api/userProfile/v1/internal/users/me/friends/subscribing/availableToPlay
+      get([path, 'me', 'friends', 'subscribing', 'availableToPlay'].join('/')).parsed_response
+    end
+
+  private
+
+    def path
+      '/userProfile/v1/internal/users'.freeze
+    end
+  end
+end

data/lib/psn-api.rb

@@ -0,0 +1,14 @@
+module PlayStationNetworkAPI
+  # Dir[File.dirname(__FILE__) + '/play_station_network_api/*.rb'].each do |file|
+  # end
+  require 'play_station_network_api/session.rb'
+  require 'play_station_network_api/client.rb'
+  require 'play_station_network_api/catalog.rb'
+  require 'play_station_network_api/entitlement.rb'
+  require 'play_station_network_api/explore.rb'
+  require 'play_station_network_api/game.rb'
+  require 'play_station_network_api/search.rb'
+  require 'play_station_network_api/session.rb'
+  require 'play_station_network_api/trophy.rb'
+  require 'play_station_network_api/user.rb'
+end

data/psn-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+# require './lib/play_station_network_api/client'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'psn-api'
+  spec.version       = '2.0'#PlayStationNetworkAPI::Client::VERSION
+  spec.authors       = ['Vlad Radulescu']
+  spec.email         = ['oss@games.directory']
+
+  spec.summary       = %q{ Ruby wrapper for the PlayStation Network API }
+  spec.description   = %q{ Use the new PlayStation Network API to get a User's Profile, Trophies, Games and more.. }
+  spec.homepage      = 'https://playstation.games.directory'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.16'
+
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake', '~> 12.3'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: psn-api
+version: !ruby/object:Gem::Version
+  version: '2.0'
+platform: ruby
+authors:
+- Vlad Radulescu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: " Use the new PlayStation Network API to get a User's Profile, Trophies,
+  Games and more.. "
+email:
+- oss@games.directory
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- bin/console
+- bin/setup
+- lib/play_station_network_api/catalog.rb
+- lib/play_station_network_api/client.rb
+- lib/play_station_network_api/entitlement.rb
+- lib/play_station_network_api/explore.rb
+- lib/play_station_network_api/game.rb
+- lib/play_station_network_api/search.rb
+- lib/play_station_network_api/session.rb
+- lib/play_station_network_api/trophy.rb
+- lib/play_station_network_api/user.rb
+- lib/psn-api.rb
+- psn-api.gemspec
+homepage: https://playstation.games.directory
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the PlayStation Network API
+test_files: []