paladins 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42432f594e2c2125cdcd88c3d0152beeb6c52933
-  data.tar.gz: c4e0e45e844e7b2fca35992ce60c2b65d89a9901
+SHA256:
+  metadata.gz: a1459a4fe6fcf781c004bb9842aab968dc537ed38a74cca643ef78d40ab7cb82
+  data.tar.gz: 53a2c401373e5ecf077a3d9942deb66768050d7af8a7733120f6957c07d23155
 SHA512:
-  metadata.gz: ebf5656d12ec086b78105e46868f9fabf3567cd7f91b7025396c056feb1e1fa66e6fabf4919eddd73e1e5865f33b0092a255ab03f38bca8ccedfe4ac3301f66d
-  data.tar.gz: 29d936e169429307260d2974d82bdc57ce0a9cd02f61b7e2b5559732f53fe6c0067c46714ee97ffbddba9befe0926c3f158523a337f798e6434049ec1fa7ec82
+  metadata.gz: c740c94a9317523bdf299fff8f9d1c462b3737c5408dbbc743b1269c4d1b32700b217cb605f3955f36f5663cbccd7af0dd92c371e71a476ff1348f8c8cc1bc2a
+  data.tar.gz: ef16c78222bb039fa977cbb3afebadab36165a53d2fec49a6df8ffc00505a69b3c22eb5f137ef86cba04725d9e9a55e6137d3fd5be87e8eb4df7c0187e3e087f

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.2 (alpha)
+
+- added support for method Paladins.ping
+- added support for method Paladins.gethirezserverstatus
+- added support for method Paladins.getchampionranks(player_name)
+- add this CHANGELOG :)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    paladins (0.1.0)
+    paladins (0.1.1)
       faraday
       json
 
@@ -10,7 +10,6 @@ GEM
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
-    dotenv (2.4.0)
     faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
     json (2.1.0)
@@ -39,7 +38,6 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  dotenv
   paladins!
   pry
   rake (~> 10.0)

data/README.md

@@ -6,7 +6,7 @@ See [Paladins API DOCS](https://docs.google.com/document/d/1OFS-3ocSx-1Rvg4afAnE
 
 ## Status
 
-*NOT PRODUCTION READY*
+Alpha (see CHANGELOG.md)
 
 ## Installation
 
@@ -26,13 +26,26 @@ Or install it yourself as:
 
 ## Usage
 
-Create an initializer in `config/initializers` to specify your `dev_id` and `auth_key` in a block:
+Create an initializer in `config/initializers` to set your `dev_id` and `auth_key` in a block:
 
 ```ruby
 Paladins.configure do |config|
   config.dev_id = ''
   config.auth_key = ''
 end
+
+Paladins.getfoobar
+```
+
+or
+
+```ruby
+config = Paladins::Configuration.new
+config.dev_id = ''
+config.auth_key = ''
+
+client = Paladins::Client.new(config)
+client.getfoobar
 ```
 
 Configs are then available like:
@@ -58,7 +71,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/davieghz/paladins.
+Bug reports and pull requests are welcome on GitHub at https://github.com/davideghz/paladins.
 
 ## License
 

data/bin/console

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require 'pry'
 require "paladins"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/lib/paladins.rb

@@ -1,7 +1,7 @@
-require "paladins/configuration"
 require "paladins/version"
-require "paladins/player"
-require "paladins/session"
+require "paladins/configuration"
+require "paladins/client"
+require "paladins/utils"
 
 module Paladins
   class << self
@@ -9,14 +9,30 @@ module Paladins
   end
 
   def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.reset
-    @configuration = Configuration.new
+    @configuration ||= Paladins::Configuration.new
   end
 
   def self.configure
     yield(configuration)
   end
+
+  # def self.configure(&block)
+  #   c = self.configuration
+  #   block.call(c)
+  # end
+
+  def self.gethirezserverstatus
+    client = Paladins::Client.new(configuration)
+    client.get_hirez_server_status
+  end
+
+  def self.ping
+    client = Paladins::Client.new(configuration)
+    client.ping
+  end
+
+  def self.getchampionranks(player_name)
+    client = Paladins::Client.new(configuration)
+    client.get_champion_ranks(player_name)
+  end
 end

data/lib/paladins/client.rb

@@ -0,0 +1,74 @@
+require 'faraday'
+require 'json'
+require 'digest'
+
+module Paladins
+  class Client
+    @@session_id = nil
+
+    attr_accessor :api_url, :dev_id, :auth_key, :response_format
+
+    def initialize(configuration)
+      @api_url     = configuration.api_url
+      @dev_id      = configuration.dev_id
+      @auth_key    = configuration.auth_key
+      @response_format = configuration.response_format
+    end
+
+    def get_signature(method_name, time_now)
+      raise ArgumentError.new('Missing dev_id or auth_key') if ( @dev_id.to_s.empty? || @auth_key.to_s.empty? )
+      Digest::MD5.hexdigest(@dev_id + method_name + @auth_key + time_now);
+    end
+
+    def create_session
+      # /createsession[ResponseFormat]/{developerId}/{signature}/{timestamp}
+      response = Faraday.get(url(method: 'createsession', session: false))
+      @@session_id = JSON.parse(response.body).dig('session_id')
+
+      @@session_id
+    end
+
+    def test_session
+      # /testsession[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}
+      time_now = Paladins::Utils.time_now
+      response = Faraday.get("#{@api_url}/testsessionJson/#{@dev_id}/#{get_signature('testsession', time_now)}/#{@@session_id}/#{time_now}")
+      attributes = JSON.parse(response.body)
+    end
+
+    def session_expired?
+      true
+      ## TODO: return TRUE only when #test_session returns something saying session is expired
+    end
+
+    def get_or_create_session
+      create_session if ( @@session_id.nil? || session_expired? )
+    end
+
+    def ping
+      # /ping[ResponseFormat]
+      response = Faraday.get("#{@api_url}/pingJson")
+      attributes = JSON.parse(response.body)
+    end
+
+    def get_hirez_server_status
+      # /gethirezserverstatus[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}
+      response = Faraday.get(url(method: 'gethirezserverstatus', session: true))
+      attributes = JSON.parse(response.body)
+    end
+
+    def get_champion_ranks(player_name)
+      # /getchampionranks[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}
+      response = Faraday.get(url(method: 'getchampionranks', session: true) + "/#{player_name}")
+      attributes = JSON.parse(response.body)
+    end
+
+    def url(method:, session: false)
+      time_now = Paladins::Utils.time_now
+      url = "#{@api_url}/#{method}#{@response_format}/#{@dev_id}/#{get_signature(method, time_now)}"
+      url += "/#{get_or_create_session}" if session
+      url += "/#{time_now}"
+
+      url
+    end
+  end
+end

data/lib/paladins/configuration.rb

@@ -1,11 +1,12 @@
 module Paladins
   class Configuration
-    attr_accessor :api_url, :dev_id, :auth_key
+    attr_accessor :api_url, :dev_id, :auth_key, :response_format
 
     def initialize
-      @api_url = "http://api.paladins.com/paladinsapi.svc"
-      @dev_id = nil
-      @auth_key = nil
+      @api_url     = "http://api.paladins.com/paladinsapi.svc"
+      @dev_id      = ENV['PALADINS_DEV_ID'] || nil
+      @auth_key    = ENV['PALADINS_AUTH_KEY'] || nil
+      @response_format = 'Json'
     end
   end
 end

data/lib/paladins/utils.rb

@@ -0,0 +1,11 @@
+require 'faraday'
+require 'json'
+require 'digest'
+
+module Paladins
+  class Utils
+    def self.time_now
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+  end
+end

data/lib/paladins/version.rb

@@ -1,3 +1,3 @@
 module Paladins
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paladins
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Davide Ghezzi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2018-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -112,9 +113,9 @@ files:
 - bin/console
 - bin/setup
 - lib/paladins.rb
+- lib/paladins/client.rb
 - lib/paladins/configuration.rb
-- lib/paladins/player.rb
-- lib/paladins/session.rb
+- lib/paladins/utils.rb
 - lib/paladins/version.rb
 - paladins.gemspec
 homepage: https://www.github.com/davideghz/paladins
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for Paladins API.

data/lib/paladins/player.rb

@@ -1,13 +0,0 @@
-require 'faraday'
-require 'json'
-
-module Paladins
-  class Player
-    def self.getchampionranks(player_name)
-      # /getchampionranks[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{player}
-
-      response = Faraday.get("#{Paladins.configuration.api_url}/getchampionranksJson/#{Paladins.configuration.dev_id}/#{get_signature('createsession', date_time)}/#{date_time}/#{player_name}")
-      attributes = JSON.parse(response.body)
-    end
-  end
-end

data/lib/paladins/session.rb

@@ -1,48 +0,0 @@
-require 'faraday'
-require 'json'
-require 'digest'
-
-module Paladins
-  class Session
-    def self.ping
-      # /ping[ResponseFormat]
-
-      response = Faraday.get("#{Paladins.configuration.api_url}/pingJson")
-      attributes = JSON.parse(response.body)
-    end
-
-    def self.createsession
-      # /createsession[ResponseFormat]/{developerId}/{signature}/{timestamp}
-
-      date_time = Time.now.utc.strftime("%Y%m%d%H%M%S")
-      url = "#{Paladins.configuration.api_url}/createsessionJson/#{Paladins.configuration.dev_id}/#{get_signature('createsession', date_time)}/#{date_time}"
-      response = Faraday.get(url)
-      attributes = JSON.parse(response.body)
-    end
-
-    def self.testsession(session_id)
-      # /testsession[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}
-
-      date_time = Time.now.utc.strftime("%Y%m%d%H%M%S")
-      url = "#{Paladins.configuration.api_url}/testsessionJson/#{Paladins.configuration.dev_id}/#{get_signature('testsession', date_time)}/#{session_id}/#{date_time}"
-      response = Faraday.get(url)
-      attributes = JSON.parse(response.body)
-    end
-
-    def self.gethirezserverstatus(session_id)
-      # /gethirezserverstatus[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}
-
-      date_time = Time.now.utc.strftime("%Y%m%d%H%M%S")
-      url = "#{Paladins.configuration.api_url}/gethirezserverstatusJson/#{Paladins.configuration.dev_id}/#{get_signature('gethirezserverstatus', date_time)}/#{session_id}/#{date_time}"
-      response = Faraday.get(url)
-      attributes = JSON.parse(response.body)
-    end
-
-    private
-
-    def self.get_signature(method_name, date_time)
-      raise ArgumentError.new('Missing dev_id or auth_key') if ( Paladins.configuration.dev_id.to_s.empty? || Paladins.configuration.auth_key.to_s.empty? )
-      Digest::MD5.hexdigest(Paladins.configuration.dev_id + method_name + Paladins.configuration.auth_key + date_time);
-    end
-  end
-end