rocketleague 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3aae213e01144412cf6423d503af31dff944052c
-  data.tar.gz: f1937fce750d5d689b6a3b8dd7a7c9a649bfd9cd
+  metadata.gz: 5ed39bb3ba4b136142265cf60efaa5fdf8d96f3c
+  data.tar.gz: 55a75d94479eeef90f327e296165ea13d6c01999
 SHA512:
-  metadata.gz: a5222edcf990ee095ef904da24a454c1d80b96d80e116af1828d9481396aea51e4e594809357948291457d477fa3666c2ea3d78cebd5ba82c650c192a4b4bb4f
-  data.tar.gz: 5961e4782c42bfc5c7944a0e7c8b9df242a6bb5224abf0f18c5e31c74d42034e3444cdde18ac725255c5b22c169976ed06b0cf6e895f02f9d66e86202db34a02
+  metadata.gz: 5eeeeddf927edfd6b573c10a87921e4fdfab02b2587a7e1ea1be6c72a071d0132d89f5ab6f34d6e973854e624a4992b98b995b9da67c95b8e2c7e558ee7825ca
+  data.tar.gz: 8658ba7ac5be7cd8fe0139e2007b40dd30d0224a87e2e26dbd7de8d1e3570ee364c11e7a64a80f7ed60e20ca2d297a63bdce805e48a88783e725c06cbc73de72

data/README.md

@@ -1,41 +1,75 @@
-# Rocketleague
+# RocketLeague [![Gem](https://img.shields.io/gem/v/rocketleague.svg?style=flat-square)](https://rubygems.org/gems/rocketleague)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rocketleague`. To experiment with that code, run `bin/console` for an interactive prompt.
+*Who needs standards?* ¯\\\_(ツ)\_/¯
 
-TODO: Delete this and the text above, and describe your gem
+A work in progress ruby gem for the Rocket League API.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rocketleague'
+```shell
+gem install rocketleague
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rocketleague
-
-## Usage
+## Example usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
+```ruby
+require "rocketleague"
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rocketleague.
+# these parameters seem to change very rarely
+rl = RocketLeague::API.new "https://psyonix-rl.appspot.com", 342373649, "Steam", "dUe3SE4YsR8B0c30E6r7F2KqpZSbGiVx", "pX9pn8F4JnBpoO8Aa219QC6N7g18FJ0F"
 
+# let's start a session!
+rl.login 123456789, "MyUserName", "MyAuthCode"
 
-## License
+# we want to get some generic info + game servers
+payload = rl.procencode([["GetGenericDataAll"], ["GetGameServerPingList"]])
+response = rl.request "/callproc105/", payload
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+# parse the response
+result = rl.procparse(response.body)
+```
 
+The result looks like this:
+```ruby
+[
+  [
+    {
+      "DataKey" => "Analytics",
+      "DataValue" => "1"
+    }, {
+      "DataKey" => "BugReports",
+      "DataValue" => "0"
+    }, {
+      "DataKey" => "RankEnabled",
+      "DataValue" => "1"
+    }
+  ], [
+    {
+      "Region" => "ASC",
+      "IP" => "103.16.26.248:7717"
+    }, {
+      "Region" => "EU",
+      "IP" => "104.238.188.227:7762"
+    }, {
+      "Region" => "JPN",
+      "IP" => "45.32.19.87:7798"
+    }, {
+      "Region" => "ME",
+      "IP" => "45.32.152.240:7906"
+    }, {
+      "Region" => "nrt",
+      "IP" => "103.16.26.248:7801"
+    }, {
+      "Region" => "OCE",
+      "IP" => "45.32.241.199:7874"
+    }, {
+      "Region" => "SAM",
+      "IP" => "185.50.104.101:7756"
+    }, {
+      "Region" => "USE",
+      "IP" => "104.238.137.154:7758"
+    }, {
+      "Region" => "USW",
+      "IP" => "45.32.206.103:7818"
+    }
+  ]
+]
+```

data/lib/rocketleague.rb

@@ -1,5 +1,6 @@
 require "rocketleague/version"
+require "rocketleague/api"
 
-module Rocketleague
-  # TODO
-end
+module RocketLeague
+
+end

data/lib/rocketleague/api.rb

@@ -0,0 +1,138 @@
+require "uri"
+require "net/http"
+require "net/https"
+
+module RocketLeague
+  class API
+    DEFAULT_HEADERS = {
+      "Content-Type" => "application/x-www-form-urlencoded",
+      "Environment" => "Prod",
+      "User-Agent" => "UE3-TA,UE3Ver(10897)",
+      "Cache-Control" => "no-cache"
+    }
+
+    # initializes the API
+    # api_url should be "https://psyonix-rl.appspot.com"
+    # build_id changes with every Rocket League update
+    # platform is one of "Steam", "PS4", "XboxOne"
+    # login_secret_key should be "dUe3SE4YsR8B0c30E6r7F2KqpZSbGiVx" (it's not very secret)
+    # call_proc_key should be "pX9pn8F4JnBpoO8Aa219QC6N7g18FJ0F"
+    def initialize(api_url, build_id, platform, login_secret_key, call_proc_key)
+      @api_url = api_url
+      @build_id = build_id
+      @platform = platform
+      @login_secret_key = login_secret_key
+      @call_proc_key = call_proc_key
+    end
+
+    # returns a Psyonix-Style www-form-urlencoded string
+    # which always starts with '&'
+    # and keys are not encoded (e.g. contain unencoded '[]')
+    def formencode obj
+      params = [""]
+      obj.each do |key, val|
+        if val.kind_of? Array
+          val.each do |v|
+            params << "#{key}=#{URI.encode_www_form_component(v)}"
+          end
+        else
+          params << "#{key}=#{URI.encode_www_form_component(val)}"
+        end
+      end
+      params.join("&")
+    end
+
+    # decodes a www-form-urlencoded string
+    # returns a key-value Hash, where values are either strings
+    # or Array of strings if the key is not unique
+    def formdecode str
+      result = {}
+      URI.decode_www_form(str).each do |pair|
+        key = pair.first
+        val = pair.last
+        if result.key? key
+          if result[key].kind_of? Array
+            result[key] << val
+          else
+            result[key] = [result[key], val]
+          end
+        else
+          result[key] = val
+        end
+      end
+      result
+    end
+
+    # creates a Psyonix-Style Proclist body
+    #
+    # `commands` is an array of arrays where the first item is the Proc name
+    # followed by option arguments
+    #
+    # returns a `formencode` string with 'Proc[]=' function names and 'P#P=' arguments, where '#' is the index of the Proc
+    def procencode commands
+      payload = {}
+      procs = []
+      commands.each_with_index do |cmd, i|
+        procs << cmd.shift
+        payload["P#{i}P[]"] = cmd
+      end
+      payload["Proc[]"] = procs
+      formencode payload
+    end
+
+    # parses the response to a Proc request
+    # returns an Array of results, which should be analogue to the `procencode` command order.
+    # each result is an Array of `formdecode` Hashes.
+    def procparse response
+      results = []
+      parts = response.split(/^\r\n/, -1) # Psyonix ¯\_(ツ)_/¯
+      parts.pop
+      parts.each do |part|
+        result = []
+        lines = part.split "\r\n"
+        lines.each do |line|
+          result << formdecode(line)
+        end
+        results << result
+      end
+      results
+    end
+
+    # performs a POST request to the Rocket League API
+    # with the `DEFAULT_HEADERS` and `extra_headers`
+    # SessionID and CallProcKey headers are added unless SessionID is unset
+    # returns HTTPResponse
+    def request(path, exra_headers = {}, payload)
+      uri = URI.parse(@api_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = (uri.scheme == "https")
+
+      if @SessionID
+        # Used for all requests except initial auth call
+        exra_headers.merge!({
+          "SessionID" => @SessionID,
+          "CallProcKey" => @call_proc_key
+        })
+      end
+
+      req = Net::HTTP::Post.new(path, DEFAULT_HEADERS.merge(exra_headers))
+      req.body = payload
+      http.request(req)
+    end
+
+    # initiates a new session by authenticating against the API
+    # returns boolean whether a SessionID was returned
+    def login player_id, player_name, auth_code
+      payload = formencode({
+        "PlayerName" => player_name,
+        "PlayerID" => player_id,
+        "Platform" => @platform,
+        "BuildID" => @build_id,
+        "AuthCode" => auth_code,
+        "IssuerID" => 0
+      })
+      response = request("/auth/", {"LoginSecretKey" => @login_secret_key }, payload)
+      !!(@SessionID = response["sessionid"])
+    end
+  end
+end

data/lib/rocketleague/version.rb

@@ -1,3 +1,3 @@
-module Rocketleague
-  VERSION = "0.0.1"
+module RocketLeague
+  VERSION = "0.0.3"
 end

data/rocketleague.gemspec

@@ -5,11 +5,11 @@ require 'rocketleague/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rocketleague"
-  spec.version       = Rocketleague::VERSION
+  spec.version       = RocketLeague::VERSION
   spec.author        = "rltracker"
 
-  spec.summary       = "[WIP]"
-  spec.description   = "[WIP]"
+  spec.summary       = "Rocket League API"
+  spec.description   = "Rocket League API"
   spec.homepage      = "https://github.com/rltracker/rocketleague"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketleague
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - rltracker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-description: "[WIP]"
+description: Rocket League API
 email: 
 executables: []
 extensions: []
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - lib/rocketleague.rb
+- lib/rocketleague/api.rb
 - lib/rocketleague/version.rb
 - rocketleague.gemspec
 homepage: https://github.com/rltracker/rocketleague
@@ -90,5 +91,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: "[WIP]"
+summary: Rocket League API
 test_files: []