poke-go-api 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44e400f988fa8c9fac5ce45524b7479e1abc6122
-  data.tar.gz: 747e7c6b71e2f2736d50eacdb8b9f535c7a9d8f0
+  metadata.gz: c43516f50725cfda3be25e7cb083dc9a35a4561d
+  data.tar.gz: a90012ee3e68fcd5b56ec7e8241b5a43acbd69ae
 SHA512:
-  metadata.gz: 9293d55c4802524510183d77a3e2666e9522a74b4d50a58e519048a4773b37dd404b6a6fbe7382949ddc488bae6278da755386df2152be9475b885c1f3382600
-  data.tar.gz: 9d290770cc439b156b6337b3a609b29e99718a6cbbe08e84ab4fae1fd7575611d2dd020b8f83a3dc78c92b339d195b849e0dd5cee127d3bc00b4b1fb9c8e34e0
+  metadata.gz: cc884ed1e40abf088e060386105d2e0efb38e3bc6da8c7edae696872a80038f864e43fed385c4ad42fe60285a1f6b5379581abdd9111c051d961b46c857b19c8
+  data.tar.gz: 9193798106a73642003697ae4d48ca0fe0fd8f43d45199006506f5f8aa30b40039013d27fe2d0c1de24eda268320d4fdfca125cc661a4ce884b32f9060c3d8b7

data/lib/poke-api.rb

@@ -18,6 +18,6 @@ require 'poke-api/geometry/s2_lat_lon'
 require 'poke-api/geometry/s2_point'
 
 # Load Google Generated POGOProtos
-require 'poke-api/POGOProtos/Signature'
-require 'poke-api/POGOProtos/Networking/Envelopes/RequestEnvelope'
-require 'poke-api/POGOProtos/Networking/Envelopes/ResponseEnvelope'
+require 'poke-api/pogoprotos/pogoprotos_networking_envelopes'
+require 'poke-api/pogoprotos/pogoprotos_networking_requests_messages'
+require 'poke-api/pogoprotos/pogoprotos_networking_responses'

data/lib/poke-api/auth/google.rb

@@ -5,7 +5,7 @@ module Poke
     module Auth
       class GOOGLE
         include Logging
-        attr_reader :access_token, :provider
+        attr_reader :access_token, :provider, :expiry
 
         GOOGLE_LOGIN_ANDROID_ID = '9774d56d682e549c'.freeze
         GOOGLE_LOGIN_SERVICE    = 'audience:server:client_id:848232511240-7so421jotr' \
@@ -17,6 +17,7 @@ module Poke
           @username = username
           @password = password
           @provider = 'google'
+          @expiry   = 0
         end
 
         def connect
@@ -31,6 +32,7 @@ module Poke
                                         GOOGLE_LOGIN_SERVICE, GOOGLE_LOGIN_APP, GOOGLE_LOGIN_CLIENT_SIG)
           end
 
+          @expiry = auth_request['Expiry'].to_i
           @access_token = auth_request['Auth']
         end
 

data/lib/poke-api/auth/ptc.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'uri'
 require 'httpclient'
 
 module Poke
@@ -6,7 +7,7 @@ module Poke
     module Auth
       class PTC
         include Logging
-        attr_reader :access_token, :provider
+        attr_reader :access_token, :provider, :expiry
 
         PTC_LOGIN_URL = 'https://sso.pokemon.com/sso/login?service=https%3A%2F%2Fsso.pokemon.com' \
                         '%2Fsso%2Foauth2.0%2FcallbackAuthorize'.freeze
@@ -18,6 +19,7 @@ module Poke
           @password = password
           @provider = 'ptc'
           @client   = HTTPClient.new(agent_name: 'PokeAPI/0.0.1')
+          @expiry   = 0
         end
 
         def connect
@@ -60,8 +62,9 @@ module Poke
             code: ticket
           }
 
-          @access_token = @client.post(PTC_LOGIN_OAUTH, data).body
-                                 .match(/access_token=(.*)&expires/)[1]
+          resp = URI.decode_www_form(@client.post(PTC_LOGIN_OAUTH, data).body).to_h
+          @access_token = resp['access_token']
+          @expiry = resp['expires'].to_i + Helpers.fetch_time(ms: false)
         end
       end
     end

data/lib/poke-api/auth/ticket.rb

@@ -2,6 +2,7 @@ module Poke
   module API
     module Auth
       class Ticket
+        include Logging
         attr_reader :start, :ends, :expire
 
         def initialize
@@ -28,7 +29,6 @@ module Poke
 
         def get_ticket
           return false unless check_ticket
-
           true
         end
 
@@ -36,13 +36,16 @@ module Poke
 
         def check_ticket
           return false unless has_ticket?
+          now = Helpers.fetch_time
 
-          now_ms = (Time.now.to_f * 1000).to_i
-          return true if now_ms < (@expire - 10000)
+          if now < (@expire - 10000)
+            duration = format('%02d:%02d:%02d', *Helpers.format_time_diff(now, @expire))
+            logger.info "[+] Auth ticket is valid for #{duration}"
+            return true
+          end
 
-          @expire = nil
-          @start  = nil
-          @ends   = nil
+          @expire, @start, @ends = nil
+          logger.info '[+] Removed expired auth ticket'
           false
         end
       end

data/lib/poke-api/client.rb

@@ -3,7 +3,7 @@ module Poke
     class Client
       include Logging
       attr_accessor :lat, :lng, :alt, :endpoint, :ticket, :sig_loaded
-      attr_reader :sig_path
+      attr_reader :sig_path, :auth
 
       def initialize
         @auth       = nil
@@ -18,25 +18,28 @@ module Poke
       end
 
       def login(username, password, provider)
-        provider = provider.upcase
-        raise Errors::InvalidProvider, provider unless %w(PTC GOOGLE).include?(provider)
+        @username, @password, @provider = username, password, provider.upcase
+
+        raise Errors::InvalidProvider, provider unless %w(PTC GOOGLE).include?(@provider)
         logger.info "[+] Logging in user: #{username}"
 
         begin
-          @auth = Auth.const_get(provider).new(username, password)
+          @auth = Auth.const_get(@provider).new(username, password)
           @auth.connect
         rescue StandardError => ex
-          raise Errors::LoginFailure.new(provider, ex)
+          raise Errors::LoginFailure.new(@provider, ex)
         end
 
         get_hatched_eggs
         call
-        logger.info "[+] Login with #{provider} Successful"
+        logger.info "[+] Login with #{@provider} Successful"
       end
 
       def call
         raise Errors::LoginRequired unless @auth
         raise Errors::NoRequests if @reqs.empty?
+
+        check_expiry
         req = RequestBuilder.new(@auth, [@lat, @lng, @alt], @endpoint)
 
         begin
@@ -81,6 +84,21 @@ module Poke
 
       private
 
+      def check_expiry
+        unless @ticket.has_ticket?
+          now = Helpers.fetch_time(ms: false)
+
+          if now < (@auth.expiry - 30)
+            duration = format('%02d:%02d:%02d', *Helpers.format_time_diff(now, @auth.expiry, false))
+            logger.info "[+] Provider access token is valid for #{duration}"
+            return
+          end
+
+          logger.info "[+] Refreshing access token as it is no longer valid"
+          login(@username, @password, @provider)
+        end
+      end
+
       def method_missing(method, *args)
         POGOProtos::Networking::Requests::RequestType.const_get(method.upcase)
         @reqs << (args.empty? ? method.to_sym.upcase : { method.to_sym.upcase => args.first })

data/lib/poke-api/helpers.rb

@@ -13,6 +13,10 @@ module Poke
           sym.to_s.split('_').collect(&:capitalize).join
         end
 
+        def fetch_time(ms: true)
+          ms ? (Time.now.to_f * 1000).to_i : Time.now.to_i
+        end
+
         def generate_location_one(auth_ticket, pos)
           first_hash = XXhash.xxh32(auth_ticket, 0x1B845238)
           location_bytes = d2h(pos[0]) + d2h(pos[1]) + d2h(pos[2])
@@ -35,6 +39,27 @@ module Poke
         def d2h(input)
           [input].pack('d').unpack('Q').first.to_s(16).split.pack('H*')
         end
+
+        def format_time_diff(low, high, ms = true)
+          diff = high - low
+          m, s = ms ? (diff / 1000).divmod(60) : diff.divmod(60)
+          m.divmod(60) + [s]
+        end
+
+        def get_cells(lat, lng, radius = 10)
+          s2_point = Poke::API::Geometry::S2LatLon.new(lat, lng).to_point
+          s2_cell  = Poke::API::Geometry::S2CellId.from_point(s2_point).parent(15)
+
+          next_cell = s2_cell.next
+          prev_cell = s2_cell.prev
+
+          radius.times.reduce([s2_cell.id]) do |acc, el|
+            acc += [next_cell.id, prev_cell.id]
+            next_cell = next_cell.next
+            prev_cell = prev_cell.prev
+            acc
+          end.sort
+        end
       end
     end
   end

data/lib/poke-api/logging.rb

@@ -15,7 +15,7 @@ module Poke
 
       def logger
         @@loggers[self.class.name] ||= Logger.new(STDOUT).tap do |logger| 
-          logger.progname = self.class.name
+          logger.progname = self.class.name == 'Module' ? self.name : self.class.name
           logger.level = Logger.const_get(@@log_level)
           logger.formatter = @@formatter
         end

data/lib/poke-api/pogoprotos/pogoprotos_data.rb

@@ -0,0 +1,94 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: POGOProtos.Data.proto
+
+require 'google/protobuf'
+
+require_relative 'pogoprotos_enums'
+require_relative 'pogoprotos_inventory_item'
+require_relative 'pogoprotos_data_player'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "POGOProtos.Data.PokemonData" do
+    optional :id, :fixed64, 1
+    optional :pokemon_id, :enum, 2, "POGOProtos.Enums.PokemonId"
+    optional :cp, :int32, 3
+    optional :stamina, :int32, 4
+    optional :stamina_max, :int32, 5
+    optional :move_1, :enum, 6, "POGOProtos.Enums.PokemonMove"
+    optional :move_2, :enum, 7, "POGOProtos.Enums.PokemonMove"
+    optional :deployed_fort_id, :string, 8
+    optional :owner_name, :string, 9
+    optional :is_egg, :bool, 10
+    optional :egg_km_walked_target, :double, 11
+    optional :egg_km_walked_start, :double, 12
+    optional :origin, :int32, 14
+    optional :height_m, :float, 15
+    optional :weight_kg, :float, 16
+    optional :individual_attack, :int32, 17
+    optional :individual_defense, :int32, 18
+    optional :individual_stamina, :int32, 19
+    optional :cp_multiplier, :float, 20
+    optional :pokeball, :enum, 21, "POGOProtos.Inventory.Item.ItemId"
+    optional :captured_cell_id, :uint64, 22
+    optional :battles_attacked, :int32, 23
+    optional :battles_defended, :int32, 24
+    optional :egg_incubator_id, :string, 25
+    optional :creation_time_ms, :uint64, 26
+    optional :num_upgrades, :int32, 27
+    optional :additional_cp_multiplier, :float, 28
+    optional :favorite, :int32, 29
+    optional :nickname, :string, 30
+    optional :from_fort, :int32, 31
+  end
+  add_message "POGOProtos.Data.PlayerData" do
+    optional :creation_timestamp_ms, :int64, 1
+    optional :username, :string, 2
+    optional :team, :enum, 5, "POGOProtos.Enums.TeamColor"
+    repeated :tutorial_state, :enum, 7, "POGOProtos.Enums.TutorialState"
+    optional :avatar, :message, 8, "POGOProtos.Data.Player.PlayerAvatar"
+    optional :max_pokemon_storage, :int32, 9
+    optional :max_item_storage, :int32, 10
+    optional :daily_bonus, :message, 11, "POGOProtos.Data.Player.DailyBonus"
+    optional :equipped_badge, :message, 12, "POGOProtos.Data.Player.EquippedBadge"
+    optional :contact_settings, :message, 13, "POGOProtos.Data.Player.ContactSettings"
+    repeated :currencies, :message, 14, "POGOProtos.Data.Player.Currency"
+  end
+  add_message "POGOProtos.Data.AssetDigestEntry" do
+    optional :asset_id, :string, 1
+    optional :bundle_name, :string, 2
+    optional :version, :int64, 3
+    optional :checksum, :fixed32, 4
+    optional :size, :int32, 5
+    optional :key, :bytes, 6
+  end
+  add_message "POGOProtos.Data.PokedexEntry" do
+    optional :pokemon_id, :enum, 1, "POGOProtos.Enums.PokemonId"
+    optional :times_encountered, :int32, 2
+    optional :times_captured, :int32, 3
+    optional :evolution_stone_pieces, :int32, 4
+    optional :evolution_stones, :int32, 5
+  end
+  add_message "POGOProtos.Data.DownloadUrlEntry" do
+    optional :asset_id, :string, 1
+    optional :url, :string, 2
+    optional :size, :int32, 3
+    optional :checksum, :fixed32, 4
+  end
+  add_message "POGOProtos.Data.PlayerBadge" do
+    optional :badge_type, :enum, 1, "POGOProtos.Enums.BadgeType"
+    optional :rank, :int32, 2
+    optional :start_value, :int32, 3
+    optional :end_value, :int32, 4
+    optional :current_value, :double, 5
+  end
+end
+
+module POGOProtos
+  module Data
+    PokemonData = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.PokemonData").msgclass
+    PlayerData = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.PlayerData").msgclass
+    AssetDigestEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.AssetDigestEntry").msgclass
+    PokedexEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.PokedexEntry").msgclass
+    DownloadUrlEntry = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.DownloadUrlEntry").msgclass
+    PlayerBadge = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.PlayerBadge").msgclass
+  end
+end

data/lib/poke-api/pogoprotos/pogoprotos_data_battle.rb

@@ -0,0 +1,91 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: POGOProtos.Data.Battle.proto
+
+require 'google/protobuf'
+
+require_relative 'pogoprotos_data'
+require_relative 'pogoprotos_data_player'
+require_relative 'pogoprotos_data_gym'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "POGOProtos.Data.Battle.BattlePokemonInfo" do
+    optional :pokemon_data, :message, 1, "POGOProtos.Data.PokemonData"
+    optional :current_health, :int32, 2
+    optional :current_energy, :int32, 3
+  end
+  add_message "POGOProtos.Data.Battle.BattleParticipant" do
+    optional :active_pokemon, :message, 1, "POGOProtos.Data.Battle.BattlePokemonInfo"
+    optional :trainer_public_profile, :message, 2, "POGOProtos.Data.Player.PlayerPublicProfile"
+    repeated :reverse_pokemon, :message, 3, "POGOProtos.Data.Battle.BattlePokemonInfo"
+    repeated :defeated_pokemon, :message, 4, "POGOProtos.Data.Battle.BattlePokemonInfo"
+  end
+  add_message "POGOProtos.Data.Battle.BattleResults" do
+    optional :gym_state, :message, 1, "POGOProtos.Data.Gym.GymState"
+    repeated :attackers, :message, 2, "POGOProtos.Data.Battle.BattleParticipant"
+    repeated :player_experience_awarded, :int32, 3
+    optional :next_defender_pokemon_id, :int64, 4
+    optional :gym_points_delta, :int32, 5
+  end
+  add_message "POGOProtos.Data.Battle.BattleAction" do
+    optional :Type, :enum, 1, "POGOProtos.Data.Battle.BattleActionType"
+    optional :action_start_ms, :int64, 2
+    optional :duration_ms, :int32, 3
+    optional :energy_delta, :int32, 5
+    optional :attacker_index, :int32, 6
+    optional :target_index, :int32, 7
+    optional :active_pokemon_id, :fixed64, 8
+    optional :player_joined, :message, 9, "POGOProtos.Data.Battle.BattleParticipant"
+    optional :battle_results, :message, 10, "POGOProtos.Data.Battle.BattleResults"
+    optional :damage_windows_start_timestamp_mss, :int64, 11
+    optional :damage_windows_end_timestamp_mss, :int64, 12
+    optional :player_left, :message, 13, "POGOProtos.Data.Battle.BattleParticipant"
+    optional :target_pokemon_id, :fixed64, 14
+  end
+  add_message "POGOProtos.Data.Battle.BattleLog" do
+    optional :state, :enum, 1, "POGOProtos.Data.Battle.BattleState"
+    optional :battle_type, :enum, 2, "POGOProtos.Data.Battle.BattleType"
+    optional :server_ms, :int64, 3
+    repeated :battle_actions, :message, 4, "POGOProtos.Data.Battle.BattleAction"
+    optional :battle_start_timestamp_ms, :int64, 5
+    optional :battle_end_timestamp_ms, :int64, 6
+  end
+  add_enum "POGOProtos.Data.Battle.BattleType" do
+    value :BATTLE_TYPE_UNSET, 0
+    value :BATTLE_TYPE_NORMAL, 1
+    value :BATTLE_TYPE_TRAINING, 2
+  end
+  add_enum "POGOProtos.Data.Battle.BattleState" do
+    value :STATE_UNSET, 0
+    value :ACTIVE, 1
+    value :VICTORY, 2
+    value :DEFEATED, 3
+    value :TIMED_OUT, 4
+  end
+  add_enum "POGOProtos.Data.Battle.BattleActionType" do
+    value :ACTION_UNSET, 0
+    value :ACTION_ATTACK, 1
+    value :ACTION_DODGE, 2
+    value :ACTION_SPECIAL_ATTACK, 3
+    value :ACTION_SWAP_POKEMON, 4
+    value :ACTION_FAINT, 5
+    value :ACTION_PLAYER_JOIN, 6
+    value :ACTION_PLAYER_QUIT, 7
+    value :ACTION_VICTORY, 8
+    value :ACTION_DEFEAT, 9
+    value :ACTION_TIMED_OUT, 10
+  end
+end
+
+module POGOProtos
+  module Data
+    module Battle
+      BattlePokemonInfo = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattlePokemonInfo").msgclass
+      BattleParticipant = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleParticipant").msgclass
+      BattleResults = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleResults").msgclass
+      BattleAction = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleAction").msgclass
+      BattleLog = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleLog").msgclass
+      BattleType = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleType").enummodule
+      BattleState = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleState").enummodule
+      BattleActionType = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Battle.BattleActionType").enummodule
+    end
+  end
+end

data/lib/poke-api/{POGOProtos/Data/Capture/CaptureProbability.rb → pogoprotos/pogoprotos_data_capture.rb}

@@ -1,10 +1,17 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: POGOProtos/Data/Capture/CaptureProbability.proto
+# source: POGOProtos.Data.Capture.proto
 
 require 'google/protobuf'
 
-require 'poke-api/POGOProtos/Inventory/Item/ItemId'
+require_relative 'pogoprotos_enums'
+require_relative 'pogoprotos_inventory_item'
 Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "POGOProtos.Data.Capture.CaptureAward" do
+    repeated :activity_type, :enum, 1, "POGOProtos.Enums.ActivityType"
+    repeated :xp, :int32, 2
+    repeated :candy, :int32, 3
+    repeated :stardust, :int32, 4
+  end
   add_message "POGOProtos.Data.Capture.CaptureProbability" do
     repeated :pokeball_type, :enum, 1, "POGOProtos.Inventory.Item.ItemId"
     repeated :capture_probability, :float, 2
@@ -15,6 +22,7 @@ end
 module POGOProtos
   module Data
     module Capture
+      CaptureAward = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Capture.CaptureAward").msgclass
       CaptureProbability = Google::Protobuf::DescriptorPool.generated_pool.lookup("POGOProtos.Data.Capture.CaptureProbability").msgclass
     end
   end