playstationnetwork-api 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b351e27faebd09b7f6bc892b4d1fc40695215fce
-  data.tar.gz: a6ddc6114a636d2807d96046fd0f2f31a4ecd6d1
+  metadata.gz: 9f3c3689cc62489a651c56c93e9213e5a89a1524
+  data.tar.gz: 21817fc6629fd58cd1bfffe0efb2c80f19538081
 SHA512:
-  metadata.gz: 50ddf55978fdac5795b0659dadef194ae8fa432f6eeef224b91d25591ee86108167be7dd6120c9ab1e3a36d76bbe6b4ec3b004aa8a42d59232d817dde1f5e93b
-  data.tar.gz: 120f05a6ed7c9307a3d6cc89fbffba0fb8266a86626e4b7e7def000b67b09c9b506aeeb068199c03a79e1df225ca5685f6a8447aac15b24cc3f0b57c7f5f20cc
+  metadata.gz: 81387ed680b523227612b17f717648e24202ad112736bd999f296c472cd9515023ad4811532c5d8e66f6ff427bcba1ecfcebd4f0ac0f82df15ad9fdfea4ffb57
+  data.tar.gz: 46b4d4cce48795bf6e81b377f7074dcbfa4709b5c9248f79b37981efb77262047430c458a0f05d3c2d5e772693e9d082cd35f26cb083b7bd2e9a3b8220483c12

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'httparty'
-# Specify your gem's dependencies in playstationnetwork-api.gemspec
+gem 'json'
+gem 'activesupport'
+
 gemspec

data/lib/playstationnetwork-api.rb

@@ -3,7 +3,7 @@ require 'httparty'
 
 module PlayStationNetwork
 
-  Dir[File.dirname(__FILE__) + '/playstationnetwork/*.rb'].each do |file|
+  Dir[File.dirname(__FILE__) + '/playstationnetwork/**/*.rb'].each do |file|
     require file
   end
 end

data/lib/playstationnetwork/api.rb

@@ -2,16 +2,15 @@ module PlayStationNetwork
   module API
     include HTTParty
 
-    base_uri 'http://psnapi-studio51.rhcloud.com/PSN/'
+    base_uri 'https://www.happynation.co.uk/api'
 
     def self.config
-      @@config
-    end
-
-    def self.key(api_key)
-      @@config = {
-        api_key: api_key,
-        format: 'json'
+      {
+        body: {
+          api_key: '4047cc6b66393a82a0c7d90844cf0d88b14e0c3a',
+          api_secret: 'pacMakaveli90',
+          response_type: 'json'
+        }
       }
     end
   end

data/lib/playstationnetwork/g/game.rb

@@ -0,0 +1,97 @@
+module PlayStationNetwork
+  module G
+
+    class Game
+      attr_accessor :media, :updates, :trophies, :stats,
+        :psn_id, :psn_hash, :psn_type, :psn_slug, :name, :cover, :platforms,
+        :updated, :checked,
+        :total, :platinum, :gold, :silver, :bronze,
+        :points, :points_platinum, :average_percentage, :owners, :completers, :completers_platinum, :trophies_earned, :played_this_week
+
+      def initialize(
+          psn_id, psn_hash, psn_type, psn_slug, name, cover, platforms,
+          updated, checked,
+          artworks, videos,
+          total, platinum, gold, silver, bronze,
+          points, points_platinum, average_percentage, owners, completers, completers_platinum, trophies_earned, played_this_week
+        )
+
+        game_updates = Hash.new
+        game_updates[:last_updated] = updated
+        game_updates[:last_checked] = checked
+
+        game_media = Hash.new
+        game_media[:artworks] = artworks
+        game_media[:videos]   = videos
+
+        game_trophies = Hash.new
+        game_trophies[:total]    = total
+        game_trophies[:platinum] = platinum
+        game_trophies[:gold]     = gold
+        game_trophies[:silver]   = silver
+        game_trophies[:bronze]   = bronze
+
+        game_stats = Hash.new
+        game_stats[:points]              = points
+        game_stats[:points_platinum]     = points_platinum
+        game_stats[:average_percentage]  = "#{average_percentage}%"
+        game_stats[:owners]              = owners
+        game_stats[:completers]          = completers
+        game_stats[:completers_platinum] = completers_platinum
+        game_stats[:trophies_earned]     = trophies_earned
+        game_stats[:played_this_week]    = played_this_week
+
+        self.psn_id    = psn_id
+        self.psn_hash  = psn_hash
+        self.psn_type  = psn_type
+        self.psn_slug  = psn_slug
+        self.name      = name
+        self.cover     = cover
+        self.platforms = platforms.split(',')
+        self.media     = game_media
+        self.updates   = game_updates
+        self.trophies  = game_trophies
+        self.stats     = game_stats
+      end
+
+      def self.find(psn_game_id)
+        response = PlayStationNetwork::API.post("/psnGetGame",
+                   PlayStationNetwork::API.config[:body].merge({ npcommid: psn_game_id }))
+
+        if response.success?
+          parsed = JSON.parse(response)
+
+          new(
+            parsed['npcommid'],
+            parsed['game_hash'],
+            parsed['content_Type'],
+            parsed['unique_url'],
+            parsed['title'],
+            parsed['image'],
+            parsed['pf'],
+            parsed['updated'].to_i,
+            parsed['meta_check'].to_i,
+            parsed['screenshots'],
+            parsed['videos'],
+            parsed['total'].to_i,
+            parsed['platinum'].to_i,
+            parsed['gold'].to_i,
+            parsed['silver'].to_i,
+            parsed['bronze'].to_i,
+            parsed['total_points'].to_i,
+            parsed['total_points_plat'].to_i,
+            parsed['average_perc'].to_f,
+            parsed['owners'].to_i,
+            parsed['completers'].to_i,
+            parsed['platters'].to_i,
+            parsed['trophies_earned'].to_i,
+            parsed['played_this_week'].to_i
+          )
+        else
+          raise response.response
+        end
+      end
+    end
+
+  end
+end

data/lib/playstationnetwork/g/games.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'active_support/core_ext/hash'
+require 'pp'
+
+module PlayStationNetwork
+  module G
+
+    class Games
+      attr_accessor :success, :total_games, :games
+
+      def initialize(success, total_games, games)
+        self.success     = success
+        self.total_games = total_games
+        self.games       = games
+      end
+
+      # Available platform options
+      #
+      # => all returns all PlayStation Network games
+      # => psp2 returns all PSP games
+      # => ps3 returns all PS3 games
+      # => ps4 returns all PS4 games
+      #
+      def self.all(psn_platform = 'all')
+        response = PlayStationNetwork::API.post('/psnListGames',
+                   PlayStationNetwork::API.config[:body].merge({ platform: psn_platform }))
+
+        sanitized_response = response.gsub('<?xml version=\"1.0\"?>', '').gsub('<\/', '</').tr('"', '')
+        parsed_response    = Hash.from_xml(sanitized_response)
+
+        if response.success?
+          new(
+            (parsed_response['psn_api']['success'].to_i == 1 ? true : false),
+            parsed_response['psn_api']['game'].size,
+            parsed_response['psn_api']['game']
+          )
+        else
+          raise response.response
+        end
+      end
+
+      def self.popular
+        response = PlayStationNetwork::API.post('/psnPopularThisWeek')
+
+        sanitized_response = response.gsub('<?xml version=\"1.0\"?>', '').gsub('<\/', '</').tr('"', '')
+        parsed_response    = Hash.from_xml(sanitized_response)
+
+        if response.success?
+          new(
+            (parsed_response['psn_api']['success'].to_i == 1 ? true : false),
+            parsed_response['psn_api']['game'].size,
+            parsed_response['psn_api']['game']
+          )
+        else
+          raise response.response
+        end
+      end
+
+    end
+  end
+end

data/lib/playstationnetwork/g/trophies.rb

@@ -0,0 +1,34 @@
+module PlayStationNetwork
+  module G
+
+    class Trophies
+      attr_accessor :psn_id, :image_prefix, :trophies, :groups
+
+      def initialize(psn_id, image_prefix, trophies, groups)
+        self.psn_id       = psn_id
+        self.image_prefix = image_prefix
+        self.trophies     = trophies
+        self.groups       = groups
+      end
+
+      def self.all(psn_game_id)
+        response = PlayStationNetwork::API.post('/psnGetTrophies',
+                   PlayStationNetwork::API.config[:body].merge({ npcommid: psn_game_id }))
+
+        if response.success?
+          parsed = JSON.parse(response)
+
+          new(
+            parsed['npcommid'],
+            parsed['image_prefix'],
+            parsed['trophies'],
+            parsed['groups']
+          )
+        else
+          raise response.response
+        end
+      end
+    end
+
+  end
+end

data/lib/playstationnetwork/u/games.rb

@@ -0,0 +1,30 @@
+module PlayStationNetwork
+  module U
+
+    class Games
+      attr_accessor :total_games, :games
+
+      def initialize(total_games, games)
+        self.total_games = total_games
+        self.games       = games
+      end
+
+      def self.all(psn_user_id)
+        response = PlayStationNetwork::API.post('/psnGetUserGames',
+                   PlayStationNetwork::API.config[:body].merge({ user_id: psn_user_id }))
+
+        if response.success?
+          parsed = JSON.parse(response)
+
+          new(
+            parsed['games'].size,
+            parsed['games']
+          )
+        else
+          raise response.response
+        end
+      end
+    end
+
+  end
+end

data/lib/playstationnetwork/u/trophies.rb

@@ -0,0 +1,28 @@
+module PlayStationNetwork
+  module U
+
+    class Trophies
+      attr_accessor :trophies
+
+      def initialize(trophies)
+        self.trophies = trophies
+      end
+
+      def self.all(psn_user_id, psn_game_id)
+        response = PlayStationNetwork::API.post('/psnGetUserTrophies',
+                   PlayStationNetwork::API.config[:body].merge({ user_id: psn_user_id, npcommid: psn_game_id }))
+
+        if response.success?
+          parsed = JSON.parse(response)
+
+          new(
+            parsed['trophies']
+          )
+        else
+          raise response.response
+        end
+      end
+    end
+
+  end
+end

data/lib/playstationnetwork/u/user.rb

@@ -0,0 +1,121 @@
+module PlayStationNetwork
+  module U
+
+    class User
+      attr_accessor :profile, :trophies, :points, :level, :stats,
+        :membership, :avatar, :username, :about, :country, :region,
+        :total, :platinum, :gold, :silver, :bronze, :total_possible,
+        :points_base, :points, :points_next,
+        :level, :projected_level, :progress, :projected_progress,
+        :total_games, :completed_games, :completion_percentage, :world_rank, :region_rank, :hardcore_rank
+
+      def initialize(
+          membership, avatar, username, about, country, region,
+          total, platinum, gold, silver, bronze, total_possible,
+          points_base, points, points_next,
+          level, projected_level, progress, projected_progress,
+          total_games, completed_games, completion_percentage, world_rank, region_rank, hardcore_rank
+        )
+
+        # Build the Profile Hash
+        #
+        psn_profile = Hash.new
+        psn_profile[:membership] = membership.to_i
+        psn_profile[:avatar]     = avatar
+        psn_profile[:username]   = username
+        psn_profile[:about]      = about
+        psn_profile[:location]   = Hash.new
+        psn_profile[:location][:country] = country
+        psn_profile[:location][:region]  = region
+
+        # Build the Trophies hash
+        #
+        psn_profile_trophies = Hash.new
+        psn_profile_trophies[:total]          = total.to_i
+        psn_profile_trophies[:platinum]       = platinum.to_i
+        psn_profile_trophies[:gold]           = gold.to_i
+        psn_profile_trophies[:silver]         = silver.to_i
+        psn_profile_trophies[:bronze]         = bronze.to_i
+        psn_profile_trophies[:total_possible] = total_possible.to_i
+
+        # Build the Points hash
+        #
+        psn_profile_points = Hash.new
+        psn_profile_points[:base]   = points_base.to_i
+        psn_profile_points[:actual] = points.to_i
+        psn_profile_points[:next]   = points_next.to_i
+
+        # Build the Level hash
+        #
+        psn_profile_level = Hash.new
+        psn_profile_level[:level]              = level.to_i
+        psn_profile_level[:projected_level]    = projected_level.to_i
+        psn_profile_level[:progress]           = progress.to_f
+        psn_profile_level[:projected_progress] = projected_progress.to_f
+
+        # Build the Points hash
+        #
+        psn_profile_stats = Hash.new
+        psn_profile_stats[:games]                 = total_games.to_i
+        psn_profile_stats[:completed_games]       = completed_games.to_i
+        psn_profile_stats[:completion_percentage] = completion_percentage.to_f
+        psn_profile_stats[:rank]                  = Hash.new
+        psn_profile_stats[:rank][:world_rank]     = world_rank.to_i
+        psn_profile_stats[:rank][:region_rank]    = region_rank.to_i
+        psn_profile_stats[:rank][:hardcore_rank]  = hardcore_rank.to_i
+
+        self.profile  = psn_profile
+        self.trophies = psn_profile_trophies
+        self.level    = psn_profile_level
+        self.points   = psn_profile_points
+        self.stats    = psn_profile_stats
+
+      end
+
+      def self.profile(psn_user_id)
+        response = PlayStationNetwork::API.post('/psnGetUser',
+                   PlayStationNetwork::API.config[:body].merge({ user_id: psn_user_id }))
+
+        if response.success?
+          parsed = JSON.parse(response)
+
+          self.new(
+            parsed['psnplus'],
+            parsed['avatar'],
+            parsed['psn_id'],
+            parsed['about_me'],
+            parsed['country'],
+            parsed['region'],
+
+            parsed['total'],
+            parsed['platinum'],
+            parsed['gold'],
+            parsed['silver'],
+            parsed['bronze'],
+            parsed['total_possible_trophies'],
+
+            parsed['base'],
+            parsed['points'],
+            parsed['next'],
+
+            parsed['level'],
+            parsed['projected_level'],
+            parsed['progress'],
+            parsed['projected_progress'],
+
+            parsed['total_games'],
+            parsed['games_complete'],
+            parsed['completion_percentage'],
+            parsed['worldrank'],
+            parsed['regionrank'],
+            parsed['hardcore_rank']
+
+          )
+        else
+          raise response.response
+        end
+      end
+    end
+
+  end
+end

data/lib/playstationnetwork/version.rb

@@ -1,7 +1,9 @@
 module PlayStationNetwork
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 
   # Changelog
+  #
+
   #
   # v0.0.1 - Initial
   # v0.0.2 - Added Trophy Information
@@ -10,4 +12,8 @@ module PlayStationNetwork
   # v0.1.1 - Added a convenient method 'all' on Trophies, without having to pass
   # the group id as an argument
 
+  #
+  # v1.0.0 - Introduces a new API, new endpoints and new format for requesting data
+  # it's basically a new gem
+
 end

data/playstationnetwork-api.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Vlad Radulescu"]
   spec.email         = ["pacMakaveli90@gmail.co.uk"]
 
-  spec.summary       = %q{A ruby wrapper for PSN API}
-  spec.description   = %q{A ruby wrapper for PSN API}
+  spec.summary       = %q{A Ruby wrapper for Studio51's PlayStation Network API}
+  spec.description   = %q{A Ruby wrapper for Studio51's PlayStation Network API for grabbing User profiles, Games and Trophies}
   spec.homepage      = ''
   spec.license       = "MIT"
 
@@ -17,7 +17,9 @@ Gem::Specification.new do |spec|
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'httparty'
+  spec.add_dependency 'httparty', '~> 0'
+  spec.add_dependency 'json', '~> 0'
+  spec.add_dependency 'activesupport', '~> 0'
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,27 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: playstationnetwork-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Vlad Radulescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -66,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: A ruby wrapper for PSN API
+description: A Ruby wrapper for Studio51's PlayStation Network API for grabbing User
+  profiles, Games and Trophies
 email:
 - pacMakaveli90@gmail.co.uk
 executables:
@@ -84,10 +113,12 @@ files:
 - bin/setup
 - lib/playstationnetwork-api.rb
 - lib/playstationnetwork/api.rb
-- lib/playstationnetwork/games.rb
-- lib/playstationnetwork/profile.rb
-- lib/playstationnetwork/trophies.rb
-- lib/playstationnetwork/trophy_groups.rb
+- lib/playstationnetwork/g/game.rb
+- lib/playstationnetwork/g/games.rb
+- lib/playstationnetwork/g/trophies.rb
+- lib/playstationnetwork/u/games.rb
+- lib/playstationnetwork/u/trophies.rb
+- lib/playstationnetwork/u/user.rb
 - lib/playstationnetwork/version.rb
 - playstationnetwork-api.gemspec
 - spec/playstationnetwork/api_spec.rb
@@ -115,7 +146,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A ruby wrapper for PSN API
+summary: A Ruby wrapper for Studio51's PlayStation Network API
 test_files:
 - spec/playstationnetwork/api_spec.rb
 - spec/spec_helper.rb

data/lib/playstationnetwork/games.rb

@@ -1,27 +0,0 @@
-module PlayStationNetwork
-  class Games
-    attr_accessor :total_games, :offset, :limit, :games
-
-    def initialize(total_games, offset, limit, games)
-      self.total_games = total_games
-      self.offset      = offset
-      self.limit       = limit
-      self.games       = games
-    end
-
-    def self.find(username, offset = 0)
-      response = PlayStationNetwork::API.get("/#{username}/trophies/o/#{offset}")
-
-      if response.success?
-        new(
-          response['totalResults'],
-          response['offset'],
-          response['limit'],
-          response['trophyTitles']
-        )
-      else
-        raise response.response
-      end
-    end
-  end
-end

data/lib/playstationnetwork/profile.rb

@@ -1,42 +0,0 @@
-module PlayStationNetwork
-  class Profile
-    attr_accessor :id,
-                  :avatar,
-                  :username,
-                  :about,
-                  :membership,
-                  :level,
-                  :progress,
-                  :trophies
-
-    def initialize(id, avatar, username, about, membership, level, progress, trophies)
-      self.id         = id
-      self.avatar     = avatar
-      self.username   = username
-      self.about      = about
-      self.membership = membership
-      self.level      = level
-      self.progress   = progress
-      self.trophies   = trophies
-    end
-
-    def self.find(username)
-      response = PlayStationNetwork::API.get("/#{username}")
-
-      if response.success?
-        self.new(
-          response['npId'],
-          response['avatarUrl'],
-          response['onlineId'],
-          response['aboutMe'],
-          response['plus'],
-          response['trophySummary']['level'],
-          response['trophySummary']['progress'],
-          response['trophySummary']['earnedTrophies']
-        )
-      else
-        raise response.response
-      end
-    end
-  end
-end

data/lib/playstationnetwork/trophies.rb

@@ -1,64 +0,0 @@
-module PlayStationNetwork
-
-  class Trophies
-    attr_accessor :psn_id, :group_id, :trophies #, :trophy_id, :hidden, :type, :name, :description, :cover, :rarity, :earned_rate
-
-    def initialize(psn_id, group_id, trophies)# trophy_id, hidden, type, name, description, cover, rarity, earned_rate)
-      self.psn_id      = psn_id
-      self.group_id    = group_id
-      self.trophies    = trophies
-      # self.trophy_id   = trophy_id
-      # self.hidden      = hidden
-      # self.type        = type
-      # self.name        = name
-      # self.description = description
-      # self.cover       = cover
-      # self.rarity      = rarity
-      # self.earned_rate = earned_rate
-    end
-
-    def self.find(username, game_id, group_id)
-      response = PlayStationNetwork::API.get("/#{username}/trophies/#{game_id}/groups/#{group_id}")
-
-      if response.success?
-        new(
-          game_id,
-          group_id,
-          response['trophies']
-          # response['trophyId'],
-          # response['trophyHidden'],
-          # response['trophyType'],
-          # response['trophyName'],
-          # response['trophyDetail'],
-          # response['trophyIconUrl'],
-          # response['trophyRare'],
-          # response['trophyEarnedRate']
-        )
-      else
-        raise response.response
-      end
-    end
-
-    def self.all(username, game_id)
-      response = PlayStationNetwork::API.get("/#{username}/trophies/#{game_id}")
-
-      if response.success?
-        new(
-          game_id,
-          nil,
-          response['trophies']
-          # response['trophyId'],
-          # response['trophyHidden'],
-          # response['trophyType'],
-          # response['trophyName'],
-          # response['trophyDetail'],
-          # response['trophyIconUrl'],
-          # response['trophyRare'],
-          # response['trophyEarnedRate']
-        )
-      else
-        raise response.response
-      end
-    end
-  end
-end

data/lib/playstationnetwork/trophy_groups.rb

@@ -1,30 +0,0 @@
-module PlayStationNetwork
-
-  class TrophyGroups
-    attr_accessor :psn_id, :groups #:group_id, :name, :description, :cover, :defined_trophies
-
-    def initialize(psn_id, groups) # group_id, name, description, cover, defined_trophies)
-
-      self.psn_id           = psn_id
-      self.groups           = groups
-      # self.group_id         = group_id
-      # self.name             = name
-      # self.description      = description
-      # self.cover            = cover
-      # self.defined_trophies = defined_trophies
-    end
-
-    def self.find(username, game_id)
-      response = PlayStationNetwork::API.get("/#{username}/trophies/#{game_id}/groups")
-
-      if response.success?
-        new(
-          game_id,
-          response['trophyGroups']
-        )
-      else
-        raise response.response
-      end
-    end
-  end
-end