steam-trade 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 821dfc0b7359db3a2119a930ca53b13a543634d4
-  data.tar.gz: 20e4fcdf9864d781083a9fa6360927bc1593e341
+  metadata.gz: 8e65c68cce7672c15f8bc79fabbbdff115f458a3
+  data.tar.gz: 49ef4f902b97621dba4c2b3825584b0079bf5aff
 SHA512:
-  metadata.gz: 07ce8d290f7ebc8ebd3cae55984b896c8f2b6970c9c577e3428a732bd35b17250e2df40fd18a8709610858205066cd7c475a28a6c4efb26824bcf51fe684b97b
-  data.tar.gz: f671b05935a3c504ee86ad53f4cf5c4bc95fc4fce5eb326d6a2d8a361abce98bba7fbf172ad1b899a206c8bbcc9517a344c7646933b77b9c8a04d91766385344
+  metadata.gz: 6eb0c8f83eb83c7a80833b44dbf8e20a72b898fe0cf0b95278562448785bac166c0f2e0acfe15bfd629f81bae1fce31f55741cb2637aae5f7041e41f7e8d1f47
+  data.tar.gz: cd414d6caa1f967dc653b6e0c3858b8889f28f8f5132ef8399b0dccd2b3d21711c6a8c944ce21fb95035903aa6ef18e5e9d5f823feaf1be00adc7d7266c4c402

data/README.md

@@ -1,4 +1,5 @@
-# steam-trade V0.0.9
+# steam-trade V0.1.1
+Please check constantly for updates cause i'm still making this gem.
 
 This gem simplifes/allows sending steam trade offers programmatically.
 
@@ -8,10 +9,26 @@ this gem is primarly for trading cards, tho can be used to CS:GO and other games
 - [Installation](#installation)
 - [Usage & Examples](#usage)
   - [Logging-in](#logging-in)
+    - [Hander.new() (this is how you login)](#handlernewusername-passwordshared_secret)
+    - [mobile_info()](#mobile_infoidentity_secret)
   - [Getting someone's inventory](#getting-someones-inventory)
+    - [normal_get_inventory()](#normal_get_inventorysteamidinventoryappid)
+    - [raw_get_inventory()](#raw_get_inventorytargetinventoryappidtrimming)
+    - [set_inventory_cache()](#set_inventory_cache)
   - [Sending a trade offer](#sending-a-trade-offer)
+    - [send_offer()](#send_offermyarraytheirarraytrade_offer_linkmessage)
+  - [Handling Trade Offers](#handling-trade-offers)
+    - [set_api_key()](#set_api_keyapi_key)
+    - [get_trade_offers()](#get_trade_offerstime)
+    - [get_trade_offer()](#get_trade_offertrade_offer_id)
+    - [accept_trade_offer()](#accept_trade_offertrade_offer_id)
+    - [decline_trade_offer()](#decline_trade_offertrade_offer_id)
+    - [cancel_trade_offer()](#cancel_trade_offertrade_offer_id)
   - [Counting badges owned](#counting-badges-owned)
+    - [sets_count()](#sets_counttargetnon_marketable)
   - [2FA codes](#2fa-codes)
+    - [fa()](#fashared_secret)
+  - [More commands](#more-commands)
 
 ## Installation
 in your commandline :
@@ -24,17 +41,13 @@ First you need to require the gem:
 require 'steam-trade'
 ```
 ## Logging-in
+#### `Handler.new(username, password,shared_secret)`
 then you need to login and optionally set your shared_secret and identity_secret:
 - `shared_secret` is used to generate steam authentication codes so you won't have to write them manually each time you login.
-- `identity_secret` is used to confirm trade offers automatically.
 ```ruby
 require 'steam-trade'
 
 account = Handler.new('username','password','shared_secret') # share secret is optional
-#username and password are required, shared_secret is optional
-
-account.mobile_info('identity_secret')
-#identity_secret is required
 
 ##########
 account = Handler.new('username') #this of course counts as non logged in
@@ -48,7 +61,18 @@ account = Handler.new()
 puts account.fa('v3dWNq2Ncutc7RelwRVXswT8CJX=v3dWNq2Ncutc7WelwRVXswT8CJk=') => random code
 
 ```
+#### `mobile_info(identity_secret)`
+- `identity_secret` is your account's identity secret (try using google if you don't know what this is).
+- `identity_secret` is used to automatically confirm trade offers.
+```ruby
+require 'steam-trade'
+
+account = Handler.new('username','password','shared_secret')
+account.mobile_info('identity_secret')
+```
+
 ## Getting someone's inventory
+you might want to read this [guide](https://dev.doctormckay.com/topic/332-identifying-steam-items/)
 #### `normal_get_inventory('steamid','inventoryappid')`
 - `steamid` is the target's steamID, or profileID, or trade link
 - `inventoryappid` is the inventory type you want to load, `ex : normal inventory(the one which holds trading cards), it's is 753`
@@ -89,6 +113,46 @@ each item is a hash which contains information about the item in the form of `{"
 `market_fee_app` key gives you the appid of the game's app (for trading cards), for other items technically `inventoryappid` is the games appid.
 
 `name` key gives you the item name.
+#### `raw_get_inventory(target,inventoryappid,trimming)`
+**IMPORTANT**: this command efficiency is better than `normal_get_inventory`, therefore i **recommend**  using this one.
+- `target` is a steamID/profileID/trade link
+- `inventoryappid` is the inventory type you want to load, `ex : normal inventory(the one which holds trading cards), it's is 753`
+- `trimming`, defaults to `true` this will remove images link and steam-server-side related informations from the descriptions hash, drastically reducing the size of data received.
+
+This command will return a hash nearly identitical to the one received from steam the hash will have 2 keys `assets` and `descriptions`:
+- `assets` has an array as value, identical to steam's [(example)](https://steamcommunity.com/inventory/76561198044170935/753/6?start_assetid=0&count=100)
+- `descriptions` has an array as a value identical to steam's [(example)](https://steamcommunity.com/inventory/76561198044170935/753/6?start_assetid=0&count=100)
+
+```ruby
+require 'steam-trade'
+logged = Handler.new('username','password','shared_secret')
+inv = logged.raw_get_inventory() #works
+inv = logged.raw_get_inventory(false) # returns non trimmed
+inv = logged.raw_get_inventory(440) #works
+inv = logged.raw_get_inventory(76561198044170935,false) #works
+inv = logged.raw_get_inventory(76561198044170935,440) # works
+
+print inv['assets'] will print all the assets
+print inv['descriptions'] will print all the descriptions
+
+### how to accurately use this
+
+class_instance = {}
+## map all the items
+inv['descriptions'].each { |desc|
+  identifier = desc['classid'] + '_' + desc['instanceid']
+  class_instance[identifier] = desc
+}
+
+## identify your items
+
+inv['assets'].each { |asset|
+  identifier = asset['classid'] + '_' + asset['instanceid']
+  puts class_instance[identifier] this will output the item's description
+}
+
+```
+
 #### `set_inventory_cache()`
 `set_inventory_cache()` is:
 
@@ -145,6 +209,117 @@ account.send_offer(myarray,theirarray,'76561198370420964',message)
 # whenever
 account.send_offer(myarray,theirarray,"https://steamcommunity.com/tradeoffer/new/?partner=410155236&token=H-yK-GFt",message)
 
+```
+## Handling Trade Offers
+you might want to read [Steam Trading API](https://developer.valvesoftware.com/wiki/Steam_Web_API/IEconService)
+
+**ALL OF THE COMMANDS BELOW REQUIRE AN API_KEY**
+
+#### `set_api_key(API_KEY)`
+**NOTE**:If you are using a **logged in** Handler there is no need to set the API_KEY.
+- `API_KEY` is your apikey, you can get that from [here](https://steamcommunity.com/dev/apikey).
+```ruby
+require 'steam-trade'
+acc = Handler.new()
+trade_offers = acc.get_trade_offers() # will raise an exception
+acc.set_api_key('mykey')
+trade_offers = acc.get_trade_offers() # after setting an API_KEY this will succeed
+```
+#### `get_trade_offers(time)`
+- `time` is the moment from which you want to get updates (explained in the example)
+this will return a hash with `trade_offers_sent`, `trade_offers_received`, `descriptions` as keys.
+`descriptions` includes the descriptions of all items returned from `trade_offers_sent` or `trade_offers_received`
+
+```ruby
+require 'steam-trade'
+logged = Handler.new('username','password','shared_secret')
+logged.mobile_info('identity_secret')
+
+time = '' # this is the initial check for offers so we want them all
+polling = Thread.new(logged) { |logged|
+  loop do
+    offers = logged.get_trade_offers(time)
+    time = Time.new.to_i # we save the time of the last check
+    next if offers['trade_offers_received'] == nil # do nothing, if there is no trades
+    puts offers['trade_offers_received'] # puts the trades
+    sleep(15) # make sure not to spam steam's server or they will block list your IP for a period of time therefore you can't make requests
+  end
+}
+```
+#### `get_trade_offer(trade_offer_id)`
+gets more information about a specific trade offer
+- `trade_offer_id` is the id of the offer you want to confirm (you can get the id using [this](#get_trade_offerstime) to get the offerID
+
+have no example how to actually use this cause `get_trade_offers(time)` is probably better
+
+#### `accept_trade_offer(trade_offer_id)`
+- `trade_offer_id` is the id of the offer you want to confirm (you can get the id using [this](#get_trade_offerstime) to get the offerID
+```ruby
+require 'steam-trade'
+logged = Handler.new('username','password','shared_secret')
+logged.mobile_info('identity_secret')
+
+time = '' # this is the initial check for offers so we want them all
+polling = Thread.new(logged) { |logged|
+  loop do
+    offers = logged.get_trade_offers(time)
+    time = Time.new.to_i # we save the time of the last check
+    next if offers['trade_offers_received'] == nil # do nothing, if there is no trades
+    offers['trade_offers_received'].each { |trade|
+      if trade['accountid_other'].to_i == 83905207 ## this will accept all trade received from 83905207 (Steam32 ID)
+        logged.accept_trade_offer(trade['tradeofferid']) # to accept the trade
+      end
+    }
+    sleep(15) # make sure not to spam steam's server or they will block list your IP for a period of time therefore you can't make requests
+  end
+}
+```
+#### `decline_trade_offer(trade_offer_id)`
+this declines a trade offer you **RECEIVED**
+- `trade_offer_id` is the id of the offer you want to confirm (you can get the id using [this](#get_trade_offerstime) to get the offerID
+
+```ruby
+require 'steam-trade'
+logged = Handler.new('username','password','shared_secret')
+logged.mobile_info('identity_secret')
+
+time = '' # this is the initial check for offers so we want them all
+polling = Thread.new(logged) { |logged|
+  loop do
+    offers = logged.get_trade_offers(time)
+    time = Time.new.to_i # we save the time of the last check
+    next if offers['trade_offers_received'] == nil # do nothing, if there is no trades
+    offers['trade_offers_received'].each { |trade| # we need to check received offers to use 'decline'
+      if trade['accountid_other'].to_i != 83905207 ## notice the '!='
+        logged.decline_trade_offer(trade['tradeofferid']) # decline the trade
+      end
+    }
+    sleep(15) # make sure not to spam steam's server or they will block list your IP for a period of time therefore you can't make requests
+  end
+}
+```
+#### `cancel_trade_offer(trade_offer_id)`
+this cancels a trade offer you **SENT**
+- `trade_offer_id` is the id of the offer you want to confirm (you can get the id using [this](#get_trade_offerstime) to get the offerID
+```ruby
+require 'steam-trade'
+logged = Handler.new('username','password','shared_secret')
+logged.mobile_info('identity_secret')
+
+time = '' # this is the initial check for offers so we want them all
+polling = Thread.new(logged) { |logged|
+  loop do
+    offers = logged.get_trade_offers(time)
+    time = Time.new.to_i # we save the time of the last check
+    next if offers['trade_offers_sent'] == nil # do nothing, if there is no trades
+    offers['trade_offers_sent'].each { |trade| # we need to check sentoffers to use 'cancel'
+      if trade['accountid_other'].to_i != 83905207 ## notice the '!='
+        logged.cancel_trade_offer(trade['tradeofferid']) # cancel the trade
+      end
+    }
+    sleep(15) # make sure not to spam steam's server or they will block list your IP for a period of time therefore you can't make requests
+  end
+}
 ```
 ## Counting badges owned
 #### `sets_count(target,non_marketable)`
@@ -201,7 +376,8 @@ puts nonlogged.fa() # will not work
 puts logged.fa() # will give a random code
 
 ```
-
+## More commands
+you can find more non-vital commands in the [wiki](https://github.com/OmG3r/steam-trade/wiki)
 ## License
 
 The gem is available as open source under the terms of the [GNU GPLV3](https://github.com/OmG3r/steam-trade/blob/master/LICENSE).

data/lib/Badge.rb

@@ -114,35 +114,30 @@ module BadgeCommands
               v
             end
             eachappidsets.reverse!
-            begin
-                  File.truncate("./#{filename}_badges.txt", 0)
-            rescue
-            end
             output "Writing the badges to #{filename}_badges.txt "
-            File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "for #{persona}(#{steamid})"}
+            text = []
+            text << "for #{persona}(#{steamid})"
             if use_nonmarketable == false
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "total non-foil trading cards #{total_non_foil}"}
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "only marketable cards are counted"}
+                  text << "only marketable cards are counted"
+                  text << "total non-foil trading cards #{total_non_foil}"
             else
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "total non-foil trading cards #{total_non_foil}"}
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "all cards counted including non-marketable"}
+                  text << "total non-foil trading cards #{total_non_foil}"
+                  text << "all cards counted including non-marketable"
             end
 
 
-            File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "total sets in target account #{totalsets}"}
-            File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts ""}
-            File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts ""}
-
-
+            text << "total sets in target account #{totalsets}"
+            text << ""
+            text << ""
             eachappidsets.each { |appid, sets|
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "#{titles[appid]}, sets = #{sets}, appid = #{appid}"}
+                  text << "             #{titles[appid]}, sets = #{sets}, appid = #{appid}"
                   hashofcards[appid].each { |cardname, owned|
-                        File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts "#{cardname} xxx #{owned}"}
+                        text << "#{cardname} xxx #{owned}"
                   }
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts ""}
-                  File.open("./#{filename}_badges.txt",'a+:UTF-8') {|f| f.puts ""}
+                  text << ""
+                  text << ""
             }
-
+            File.open("./#{filename}_badges.txt",'w:UTF-8') {|f| f.puts text}
             output "badges.txt has been created"
       end
 

data/lib/Guard.rb

@@ -4,10 +4,10 @@ module GuardCommands
 
 
 
-      def fa(shared_secret = @secret)
+      def fa(shared_secret = @secret,time_difference = 0)
             raise "No shared_secret given" if shared_secret == nil # cause upon initialization @secret = nil
-            timestamp = Time.new.to_i
-            math = timestamp / 30
+            timestamp = Time.new.to_i + time_difference
+            math = timestamp.to_i / 30
             math = math.to_i
             time_buffer =[math].pack('Q>')
 

data/lib/Inventory.rb

@@ -45,7 +45,6 @@ module InventoryCommands
                   last_id = received['new_last_id']
                   items = items + received['assets']
                   output "loaded #{items.length}"
-                  sleep(2) if last_id != false
             end
 
             output "total loaded #{items.length} asset"
@@ -154,7 +153,6 @@ module InventoryCommands
                   hash["assets"] = hash["assets"] + received['assets']
                   hash["descriptions"] = hash["descriptions"] + received["descriptions"]
                   output "loaded #{hash["assets"].length}"
-                  sleep(2) if last_id != false
             end
 
             output "total loaded #{hash["assets"].length} asset"
@@ -178,7 +176,7 @@ module InventoryCommands
       def get_inventory_chunk_normal_way(appid,context,steamid,last_id)
 
 
-                  html = open("https://steamcommunity.com/inventory/#{steamid}/#{appid}/#{context}?start_assetid=#{last_id}&count=5000").read
+                  html = @session.get("https://steamcommunity.com/inventory/#{steamid}/#{appid}/#{context}?start_assetid=#{last_id}&count=5000").content
 
                   get = JSON.parse(html)
                   raise "something totally unexpected happened while getting inventory with appid #{appid} of steamid #{steamid} with contextid #{context}" if get.key?("error") == true
@@ -224,7 +222,7 @@ module InventoryCommands
       def get_inventory_chunk_raw_way(appid,context,steamid,last_id,trim)
 
 
-            html = open("https://steamcommunity.com/inventory/#{steamid}/#{appid}/#{context}?start_assetid=#{last_id}&count=5000").read
+            html = @session.get("https://steamcommunity.com/inventory/#{steamid}/#{appid}/#{context}?start_assetid=#{last_id}&count=5000").content
 
             get = JSON.parse(html)
             raise "something totally unexpected happened while getting inventory with appid #{appid} of steamid #{steamid} with contextid #{context}" if get.key?("error") == true

data/lib/LoginExecutor.rb

@@ -1,6 +1,7 @@
 module LoginCommands
 
 ########################################################################################
+     private
       def login()
             data = pass_stamp()
             encrypted_password = data["password"]
@@ -8,7 +9,7 @@ module LoginCommands
             repeater = 0
             until repeater == true
                   if @secret != nil
-                        guardcode = fa()
+                        guardcode = fa(@secret,@time_difference)
                   else
                         puts "please write your 2FA code"
                         guardcode = gets.chomp
@@ -87,7 +88,6 @@ module LoginCommands
 
 
 ########################################################################################
-      private
       def pass_stamp()
             response = @session.post('https://store.steampowered.com/login/getrsakey/', {'username' => @username})
 

data/lib/Misc.rb

@@ -44,7 +44,7 @@ module MiscCommands
       def output(message)
             time = Time.new
             add = time.strftime("%d-%m-%Y %H:%M:%S")
-            puts "#{time} :: #{message}" if @messages == true
+            puts "#{add} :: #{message}" if @messages == true
       end
 
       def verify_profileid_or_trade_link_or_steamid(steamid)

data/lib/meta/version.rb

@@ -1,4 +1,4 @@
 module   Meta
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
       GEM_NAME = "steam-trade"
 end

data/lib/steam-trade.rb

@@ -29,12 +29,26 @@ class Handler
       include PlayerCommands
       include TradeAPI
 
-      def initialize(username = nil ,password = nil,secret = nil)
+      def initialize(username = nil ,password = nil,*params)
+           raise "can only take 4 params, given #{params.length}" if params.length > 2
             @loggedin = false # will be set to true once we login
 
             @username = username
             @password = password
-            @secret = secret
+            @secret = nil
+            @time_difference = 0
+
+
+            if params.length == 2
+                 @secret = params[0] if params[0].class == String
+                 @time_difference = params[1] if params[1].class == Integer
+            elsif params.length == 1 && params[0].class == String
+                 @secret = params[0]
+                 @time_difference = 0
+            elsif params.length == 1 && params[0].class == Integer
+                 @secret = nil
+                 @time_difference = params[0]
+            end
 
             @steamid = nil # will be initialized once you login and can be initialized with mobile_info
             @identity_secret = nil # can and should be initialized using mobile_info
@@ -43,6 +57,7 @@ class Handler
             @session = Mechanize.new { |agent| # the session which will hold your cookies to communicate with steam
                   agent.user_agent_alias = 'Windows Mozilla'
                   agent.follow_meta_refresh = true
+                  agent.history_added = Proc.new {sleep 2}
             }
 
             @inventory_cache = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steam-trade
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - OmG3r
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-27 00:00:00.000000000 Z
+date: 2018-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler