playstationnetwork-api 2.1.2 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b9b7df510bfc8a63fa11d22d7df2b71d4995a48
-  data.tar.gz: bfaa01f192a7fa3947b970fc4be2200ef7c95359
+SHA256:
+  metadata.gz: c8cde5f136529fe70ed2ff0ba248bb9bce19b3cd239fcba0447d3012c9f13c99
+  data.tar.gz: 69853132e57e9c6f9a78b16a268d37471c10da3ae4c9734ff8738762613b0778
 SHA512:
-  metadata.gz: 21798f59011e728095efe55e76ce331d138a7f2f5c101f0c048791f72574599b5190b0606a9112a4439ba12aed8b8262081ebb205bf1cb3814d5cbcf59661424
-  data.tar.gz: a54fe341db147350244270536b8a1d5a1068a514dc5da886462cf5916b97bfdaba2910411a9a5081c180f1e04c6641d412752b456e64ca12027e78f2918a6b3f
+  metadata.gz: 0c782e782b3f3b4216235f33e8901ed7e74f97ad200465ec7ef7e5f1db4aaa8a5ea0170dcd39412926892abf2c01c33eaa659ae2a7673477e5f7afe12d240b0a
+  data.tar.gz: 368acdefb82b2a0194c649a48c3b9251705b253e37d97f43a80daea6a72830db4bd9c1f9107970d16d97080cc1167a276d6a9c8060f4c5fa1cc0c5227cdc7a19

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -7,7 +7,7 @@ Retrieve User, Trophies and Game data from PlayStationNetwork.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'playstationnetwork-api', '~> 2.0'
+gem 'playstationnetwork-api', '~> 2.1'
 ```
 
 And then execute:
@@ -40,7 +40,7 @@ Or install it yourself as:
 
 
 #### Get all Games
-`PlayStationNetwork::Game.new().all(platform: 'ps4') # you don't have to pass an argument. By default, it will get all games.`
+`PlayStationNetwork::Game.new().all(platform: 'ps4') # you don't have to pass an argument. It will get all games by default.`
 
 #### Get Popular Games
 `PlayStationNetwork::Game.new().all(popular: true)`
@@ -54,10 +54,23 @@ PlayStationNetwork::API.configure do |config|
   config.key = '<API_KEY>',
   config.secret = '<API_SECRET>'
   config.url = '<API_URL>'
+  config.verify_ssl = boolean ( default is true )
 })
+
+# visit: http://www.psnleaderboard.com/ to get your key, secret and endpoint details
+```
+
+`verify_ssl` was introduced in v2.1.0 in order to fix an error returned by the API when communicating through SSL.
+If you get the following error when trying to access the API, set `verify_ssl` to `false`
+```
+{ 
+  success: false, 
+  code: 500, 
+  message: #<OpenSSL::SSL::SSLError: hostname '<API_URL>' does not match the server certificate>
+}
 ```
 
-Get Endpoint, your Key and Secret from: http://www.psnleaderboard.com/
+Please note this option may be removed in a future release when a proper fix will be implemented.
 
 ## Development
 

data/lib/playstationnetwork/api.rb

@@ -29,15 +29,14 @@ module PlayStationNetwork
 
   module API
     include HTTParty
-    
-    # base_uri ""
-
     extend self
 
-    MISSING_CONFIGURATION ||= "You must configure the PlayStationNetwork module before using this Gem. See the README.md for how to configure it"
-    MISSING_URL ||= "You must pass the 'url' to the PlayStationNetwork module before using this Gem. See the README.md for how to configure it"
-    MISSING_KEY ||= "You must pass your 'key' to the PlayStationNetwork module before using this Gem. See the README.md for how to configure it"
-    MISSING_SECRET ||= "You must pass your 'secret' to the PlayStationNetwork module before using this Gem. See the README.md for how to configure it"
+    DEFAULT_MESSAGE ||= 'the PlayStationNetwork module before using this gem. See the README.md for how to configure it'
+
+    MISSING_CONFIGURATION ||= 'You must configure ' + DEFAULT_MESSAGE
+    MISSING_URL ||= "You must pass the 'url' to " + DEFAULT_MESSAGE
+    MISSING_KEY ||= "You must pass your 'key' to " + DEFAULT_MESSAGE
+    MISSING_SECRET ||= "You must pass your 'secret' to " + DEFAULT_MESSAGE
 
     def request
       handle_response do
@@ -78,7 +77,7 @@ module PlayStationNetwork
             JSON.parse(request)[reduce_to]
           end
         rescue
-          raise "There was a problem parsing the JSON. Most likely an API problem."
+          raise 'There was a problem parsing the JSON. Most likely an API problem.'
         end
       else
         raise request.response

data/lib/playstationnetwork/game.rb

@@ -9,7 +9,7 @@ module PlayStationNetwork
     INVALID_PLATFORM_PARAM ||= "'platform' needs to be one of #{ GAMES_PARAMETERS_TYPES.join(', ') }"
     INVALID_POPULAR_TYPE ||= "'popular' parameter needs to be a Boolean"
     
-    def initialize(npcommid = "")
+    def initialize(npcommid = '')
       PlayStationNetwork::API.handle_response do
         raise INVALID_NPCOMMID_TYPE unless npcommid.is_a?(String)
 
@@ -52,7 +52,7 @@ module PlayStationNetwork
           begin
             parse_xml(request)['psn_api']
           rescue
-            raise "There was a problem parsing the XML response"
+            raise 'There was a problem parsing the XML response'
           end
         else
           raise request.response

data/lib/playstationnetwork/store.rb

@@ -0,0 +1,83 @@
+module PlayStationNetwork
+  class Store
+    include HTTParty
+    base_uri "https://store.playstation.com"
+
+    attr_reader :args, :region, :language
+
+    def initialize(args, region: 'GB', language: 'en')
+      @args = args
+      @region = region
+      @language = language
+    end
+
+    def search(game_type = 'Full Game')
+      raise '' unless game_type != 'Full Game' || game_type != 'Bundle'
+
+      options = {
+        headers: {
+          "User-Agent" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36",
+          "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
+          "Authority" => "store.playstation.com"
+        },
+        
+        query: {
+          suggested_size: 5,
+          mode: 'game'
+        }
+      }
+
+      request = self.class.get(search_url(args), options)
+
+      if request.success?
+        response = []
+
+        results = request.parsed_response['included'].select do |result|
+          result['attributes']['game-content-type'] == game_type
+        end
+
+        results.each do |result|
+          response << {
+            store_id: result['id'],
+            name: result['attributes']['name'],
+            description: result['attributes']['long-description'],
+            type: result['type'],
+            raw: result
+          }
+        end
+
+        return response
+      else
+        raise request.response
+      end
+    end
+
+    def details
+      options = {
+        headers: {
+          "User-Agent" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.132 Safari/537.36",
+          "Accept" => "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
+          "Authority" => "store.playstation.com"
+        }
+      }
+
+      request = self.class.get(details_url(args), options)
+
+      if request.success?
+        return request.parsed_response
+      else
+        raise request.response
+      end
+    end
+
+  private
+
+    def search_url(query)
+      "/valkyrie-api/#{ language }/#{ region }/19/tumbler-search/#{ URI.encode(query) }"
+    end
+
+    def details_url(identifier)
+      "/store/api/chihiro/00_09_000/container/#{ region }/#{ language }/19/#{ identifier }"
+    end
+  end
+end

data/lib/playstationnetwork/version.rb

@@ -1,5 +1,5 @@
 module PlayStationNetwork
-  VERSION ||= '2.1.2'
+  VERSION ||= '2.2'
 
   def self.changelog
     puts "
@@ -50,6 +50,9 @@ module PlayStationNetwork
 
       v2.1.2
         - Added 'verify: false' option introduced in v2.1.0 as a configurable option in the initializer
+
+      v2.2
+        - Added experimental PlayStation Store endpoint
     "
   end
 end

data/playstationnetwork-api.gemspec

@@ -5,20 +5,20 @@ Gem::Specification.new do |spec|
   spec.name          = 'playstationnetwork-api'
   spec.version       = PlayStationNetwork::VERSION
   spec.authors       = ['Vlad Radulescu']
-  spec.email         = ['vlad@games.directory']
+  spec.email         = ['oss@games.directory']
 
-  spec.summary       = %q{ A Ruby wrapper for PSN Leaderboard API }
-  spec.description   = %q{ A Ruby wrapper around PSN Leaderboard's API for grabbing Users, Games and Trophies }
+  spec.summary       = %q{ A Ruby wrapper around PSN Leaderboard's API }
+  spec.description   = %q{ Allows your app to communicate with the PlayStation Network API and retrieve your, or a given user, Games, Trophies and Achievements. API is provided by psnloaderboard.com . }
   spec.homepage      = ''
   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.require_paths = ['lib']
 
-  spec.add_dependency 'httparty', '~> 0.15.6'
-  spec.add_development_dependency 'bundler', '~> 1.15.3'
-  spec.add_development_dependency 'rake', '~> 12.0.0'
-  spec.add_development_dependency 'rspec', '~> 3.6.0'
+  spec.add_dependency 'httparty', '~> 0.16.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: playstationnetwork-api
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: '2.2'
 platform: ruby
 authors:
 - Vlad Radulescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,60 +16,47 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: 0.16.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.6
+        version: 0.16.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.6.0
-description: " A Ruby wrapper around PSN Leaderboard's API for grabbing Users, Games
-  and Trophies "
+        version: '12.3'
+description: " Allows your app to communicate with the PlayStation Network API and
+  retrieve your, or a given user, Games, Trophies and Achievements. API is provided
+  by psnloaderboard.com . "
 email:
-- vlad@games.directory
+- oss@games.directory
 executables:
 - console
 - setup
@@ -77,20 +64,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
 - Gemfile
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
 - lib/playstationnetwork-api.rb
 - lib/playstationnetwork/api.rb
 - lib/playstationnetwork/game.rb
+- lib/playstationnetwork/store.rb
 - lib/playstationnetwork/user.rb
 - lib/playstationnetwork/version.rb
 - playstationnetwork-api.gemspec
-- spec/playstationnetwork/api_spec.rb
-- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -111,11 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: A Ruby wrapper for PSN Leaderboard API
-test_files:
-- spec/playstationnetwork/api_spec.rb
-- spec/spec_helper.rb
-has_rdoc: 
+summary: A Ruby wrapper around PSN Leaderboard's API
+test_files: []

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/spec/playstationnetwork/api_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe PlayStationNetwork do
-  it 'has a version number' do
-    expect(PlayStationNetwork::VERSION).not_to be nil
-  end
-
-  it 'does something useful' do
-    expect(false).to eq(true)
-  end
-end

data/spec/spec_helper.rb

@@ -1 +0,0 @@
-require './lib/playstationnetwork/api'