backpack_tf 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0bb160d7663670acc3d14ca49f79e5fc97f8387
-  data.tar.gz: d928ca0ec022d0e73cebb5bd174dac654621623e
+  metadata.gz: bcb589dbd6d876a5691b061847e9a3a349a034c3
+  data.tar.gz: 6418bd7b7a7c3b6f4fc55577c1ef414208ce3ad5
 SHA512:
-  metadata.gz: 5e10182770c9739e8ff40067e3da906923be2b2684a664e8e8d56fe9885e5dd1dda9c22b83fe95e22ee31bae202944e38a9ac81c9aa0b6beb6ba234c1ce9273e
-  data.tar.gz: e0f8b763197c2f372385f090d4d9caa2d61688da1c37efeab0ae2ce37e5cffe1cc14d0a78d6b5ec23cb6918eae3cc4b39b44f35b48655ceedd47997ff2e1af1d
+  metadata.gz: 90d18da71c8c9504088b6a3a53956272430b512b72761143ad39669e7000054282f0c698eb455861ff3534e9a3b5c7c1563e27a7d81fe859ace62635025ba014
+  data.tar.gz: a0bdd6b0b0394126d92cf5f55cab2b7f70f19f88afe6d3de41101e7990ddd2c4c2d4fc42ff81c52d4d044e536e5d749dcb9e8ef350ea23d6c43771eb4b305614

data/lib/backpack_tf/client.rb

@@ -36,22 +36,19 @@ module BackpackTF
       case action
       when :get_prices, :prices
         version = 4
-        interface_url = "/#{Prices.interface}/v#{version}/?"
+        interface_url = "/#{Price.interface}/v#{version}/?"
       when :get_currencies, :currencies
         version = 1
-        interface_url = "/#{Currencies.interface}/v#{version}/?"
+        interface_url = "/#{Currency.interface}/v#{version}/?"
       when :get_special_items, :special_items
-        raise RuntimeError, "Unfortunately, this interface is not yet supported."
-        #version = 1
-        #interface_url = "/IGetSpecialItems/v#{version}/?"
+        version = 1
+        interface_url = "/#{SpecialItem.interface}/v#{version}/?"
       when :get_users, :users
-        raise RuntimeError, "Unfortunately, this interface is not yet supported."
-        #version = 3
-        #interface_url = "/IGetUsers/v#{version}/?"
-      when :get_user_listings, :user_listings
-        raise RuntimeError, "Unfortunately, this interface is not yet supported."
-        #version = 1
-        #interface_url = "/IGetUserListings/v#{version}/?"
+        version = 3
+        interface_url = "/#{User.interface}/v#{version}/?"
+      when :get_user_listings, :user_listing, :user_listings
+        version = 1
+        interface_url = "/#{UserListing.interface}/v#{version}/?"
       else
         raise ArgumentError, 'pass in valid action as a Symbol object'
       end

data/lib/backpack_tf/{currencies.rb → currency.rb}

@@ -2,7 +2,7 @@ module BackpackTF
 
   # ruby representations of a JSON response to
   # `IGetCurrencies`['response']
-  class Currencies < Response
+  class Currency < Response
 
     ###########################
     #     Class Methods

data/lib/backpack_tf/item.rb

@@ -1,39 +1,13 @@
 module BackpackTF
 
   class Item
-
-    include BackpackTF::Finder
-
-    ###########################
-    #     Class Methods
-    ###########################
-
-    #def self.generate_price_keys item_hash
-    #  raise TypeError unless item_hash.class == Hash
-    #  prices = item_hash['prices']
-
-    #  prices.each_pair.inject([]) do |gen_keys, (key, val)|
-    #    quality = BackpackTF::ItemPrice.qualities[key.to_i]
-    #    new_key = [quality.to_s]
-
-    #    tradability = val.keys.first
-    #    new_key << tradability
-
-    #    craftability = prices[key][tradability].keys.first
-    #    new_key << craftability
-
-    #    gen_keys << new_key.join('_')
-    #  end
-
-    #end
-
     ###########################
     #     Instance Methods
     ###########################
 
     # @return [String] the name of item
     attr_reader :item_name
-    # @return [Fixnum] the index on which you can link this item to Team Fortress 2's Item Schema
+    # @return [Fixnum] the index to which you can link this item to Team Fortress 2's Item Schema
     attr_reader :defindex
     # @return [Hash<Fixnum, ItemPrice>] a hash object
     attr_reader :prices

data/lib/backpack_tf/item_price.rb

@@ -2,7 +2,41 @@ module BackpackTF
 
   class ItemPrice
 
-    include BackpackTF::Finder
+    ###########################
+    #      Class Methods
+    ###########################
+
+    @@required_keys = ['currency', 'value', 'last_update', 'difference']
+    def self.required_keys; @@required_keys; end
+
+    # mapping official API quality integers to quality names
+    # https://wiki.teamfortress.com/wiki/WebAPI/GetSchema#Result_Data
+    @@qualities = [
+      :Normal,
+      :Genuine,
+      nil,
+      :Vintage,
+      nil,
+      :Unusual,
+      :Unique,
+      :Community,
+      :Valve,
+      :"Self-Made",
+      nil,
+      :Strange,
+      nil,
+      :Haunted,
+      :"Collector's"
+    ]
+
+    def self.qualities; @@qualities; end
+
+    @@tradabilities = [:Tradable, :'Non-Tradable']
+    @@craftabilities = [:Craftable, :'Non-Craftable']
+    
+    ###########################
+    #     Instance Methods
+    ###########################
 
     # @return [String] the quality of the item being priced, converted to String
     attr_reader :quality
@@ -49,34 +83,6 @@ module BackpackTF
       @difference     = attr['difference']
     end
 
-    @@required_keys = %w(currency value last_update difference)
-    def self.required_keys; @@required_keys; end
-
-    # mapping official API quality integers to quality names
-    # https://wiki.teamfortress.com/wiki/WebAPI/GetSchema#Result_Data
-    @@qualities = [
-      :Normal,
-      :Genuine,
-      nil,
-      :Vintage,
-      nil,
-      :Unusual,
-      :Unique,
-      :Community,
-      :Valve,
-      :"Self-Made",
-      nil,
-      :Strange,
-      nil,
-      :Haunted,
-      :"Collector's"
-    ]
-
-    def self.qualities; @@qualities; end
-
-    @@tradabilities = [:Tradable, :'Non-Tradable']
-    @@craftabilities = [:Craftable, :'Non-Craftable']
-    
   end
 
 end

data/lib/backpack_tf/price.rb

@@ -0,0 +1,97 @@
+module BackpackTF
+
+  # ruby representations of a JSON response to
+  # `IGetPrices`['response']
+  class Price < Response
+
+    INTERFACE = :IGetPrices
+    @interface = INTERFACE
+    @response = nil
+    @items = nil
+
+    ############################
+    # CLASS METHODS
+    ############################
+
+    def self.response
+      @response = superclass.responses[to_sym]
+    end
+
+    def self.items
+      if @items.nil?
+        generate_items
+      else
+        @items
+      end
+    end
+
+    def self.generate_items
+      @items = @response[:items].inject({}) do |items, (name)|
+        defindex = @response[:items][name]['defindex'][0]
+
+        if defindex.nil? || defindex < 0
+          items
+        else
+          items[name] = Item.new(name, @response[:items][name])
+          items
+        end
+      end
+    end
+
+    def self.find_item_by_name item_name, opt = nil
+      if @items[item_name].nil?
+        raise KeyError, "item with the name #{item_name} was not found"
+      else
+        if opt.nil?
+          @items[item_name]
+        elsif @items[item_name].respond_to? opt
+          @items[item_name].public_send(opt)
+        else
+          raise KeyError, "the item, #{item_name} does not have that attribute"
+        end
+      end
+    end
+
+    def self.random_item opt = nil
+      case opt
+      when :prices, :price
+        @items[@items.keys.sample].prices
+      else
+        @items.keys.sample
+      end
+    end
+
+    def self.generate_price_keys item_hash
+      raise TypeError unless item_hash.class == Hash
+      prices = item_hash['prices']
+
+      prices.each_pair.inject([]) do |gen_keys, (key, val)|
+        quality = BackpackTF::ItemPrice.qualities[key.to_i]
+        new_key = [quality.to_s]
+
+        tradability = val.keys.first
+        new_key << tradability
+
+        craftability = prices[key][tradability].keys.first
+        new_key << craftability
+
+        gen_keys << new_key.join('_')
+      end
+
+    end
+
+    ############################
+    # INSTANCE METHODS
+    ############################
+
+    def initialize
+      msg = "This class is meant to receive the JSON response from the #{self.class.interface} interface."
+      msg << "It holds a Hash array of prices of items, but not is meant to be instantiated."
+      msg << "See the Item class if you are interested in an item."
+      msg << "However, information on items should be stored in the @items property of #{self.class}."
+      raise RuntimeError, msg
+    end
+
+  end
+
+end

data/lib/backpack_tf/response.rb

@@ -5,14 +5,14 @@ module BackpackTF
     # CLASS METHODS
     ############################
 
+    @responses = {}
+
     def self.interface; @interface; end
 
     def self.to_sym
       self.name.to_sym
     end
 
-    @responses = {}
-
     def self.responses key_val = nil
       unless key_val.nil?
         key_val = { key_val => nil } unless key_val.class == Hash

data/lib/backpack_tf/special_item.rb

@@ -0,0 +1,58 @@
+module BackpackTF
+  class SpecialItem < Response
+    INTERFACE = :IGetSpecialItems
+    @interface = INTERFACE
+    @response = nil
+    @@items = {}
+
+    def self.response
+      @response = superclass.responses[to_sym]
+    end
+
+    def self.items
+      return @response if @response.nil?
+      @@items = response[:items].inject({}) do |hash, item|
+        #item = hash_keys_to_sym(item)
+        name = item['name']
+        hash[name] = new(name, item)
+        hash
+      end
+    end
+
+    attr_reader :name
+    attr_reader :item_name
+    attr_reader :defindex
+    attr_reader :item_class
+    attr_reader :item_type_name
+    attr_reader :item_description
+    attr_reader :proper_name
+    attr_reader :item_quality
+    attr_reader :min_ilevel
+    attr_reader :max_ilevel
+    attr_reader :image_url
+    attr_reader :image_url_large
+    attr_reader :image_url_orig
+    attr_reader :image_url_large_orig
+    attr_reader :appid
+
+    def initialize name, attr
+      attr = check_attr_keys(attr)
+
+      @name                 = name
+      @item_name            = attr[:item_name]
+      @defindex             = attr[:defindex]
+      @item_class           = attr[:item_class]
+      @item_type_name       = attr[:item_type_name]
+      @item_description     = attr[:item_description]
+      @proper_name          = attr[:proper_name]
+      @item_quality         = attr[:item_quality]
+      @min_ilevel           = attr[:min_ilevel]
+      @max_ilevel           = attr[:max_ilevel]
+      @image_url            = attr[:image_url]
+      @image_url_large      = attr[:image_url_large]
+      @image_url_orig       = attr[:image_url_orig]
+      @image_url_large_orig = attr[:image_url_large_orig]
+      @appid                = attr[:appid]
+    end
+  end
+end

data/lib/backpack_tf/user.rb

@@ -0,0 +1,54 @@
+module BackpackTF
+  class User < Response
+    INTERFACE = :IGetUsers
+    @interface = INTERFACE
+    @response = nil
+    @@players = {}
+
+    def self.response
+      @response = superclass.responses[to_sym]
+    end
+
+    def self.players
+      return @response if response.nil?
+      @@players = response[:players].inject({}) do |players, (steamid, attr)|
+        players[steamid] = new(attr)
+        players 
+      end
+    end
+
+    attr_reader :steamid
+    attr_reader :success
+    attr_reader :backpack_value
+    attr_reader :backpack_update
+    attr_reader :name
+    attr_reader :backpack_tf_reputation
+    attr_reader :backpack_tf_group
+    attr_reader :backpack_tf_banned
+    attr_reader :backpack_tf_trust
+    attr_reader :steamrep_scammer
+    attr_reader :ban_economy
+    attr_reader :ban_community
+    attr_reader :ban_vac
+    attr_reader :notifications
+
+    def initialize attr
+      attr = check_attr_keys(attr)
+
+      @steamid                = attr[:steamid]
+      @success                = attr[:success]
+      @backpack_value         = attr[:backpack_value]
+      @backpack_update        = attr[:backpack_update]
+      @name                   = attr[:name]
+      @backpack_tf_reputation = attr[:backpack_tf_reputation]
+      @backpack_tf_group      = attr[:backpack_tf_group]
+      @backpack_tf_banned     = attr[:backpack_tf_banned]
+      @backpack_tf_trust      = attr[:backpack_tf_trust]
+      @steamrep_scammer       = attr[:steamrep_scammer]
+      @ban_economy            = attr[:ban_economy]
+      @ban_community          = attr[:ban_community]
+      @ban_vac                = attr[:ban_vac]
+      @notifications          = attr[:notifications]
+    end
+  end
+end

data/lib/backpack_tf/user_listing.rb

@@ -0,0 +1,60 @@
+module BackpackTF
+  class UserListing < Response
+
+    INTERFACE = :IGetUserListings
+
+    @interface = INTERFACE
+    @response = nil
+    @@listings = []
+
+    def self.interface; @interface; end
+
+    def self.response
+      @response = superclass.responses[to_sym]
+    end
+
+    def self.listings
+      return @response if response.nil?
+      @@listings = response[:listings].inject([]) do |listings, attr|
+        listings << new(attr)
+        listings
+      end
+    end
+
+    attr_reader :id
+    attr_reader :bump
+    attr_reader :created
+    attr_reader :currencies
+    attr_reader :item
+    attr_reader :details
+    attr_reader :meta
+    attr_reader :buyout
+
+    def initialize attr
+      attr = check_attr_keys(attr)
+
+      @id = attr[:id].to_sym
+      @bump = attr[:bump]
+      @created = attr[:created]
+      @currencies = attr[:currencies]
+      @item = set_keys_of_key_to_symbols(attr[:item], 'attributes')
+      @details = attr[:details]
+      @meta = self.class.hash_keys_to_sym(attr[:meta])
+      @buyout = attr[:buyout]
+    end
+
+    private
+    # Similar to Response.hash_key_to_sym, except you are returning
+    # an Array of Hash objects instead of a Hash.
+    def set_keys_of_key_to_symbols attr, key
+      return nil unless attr.has_key? key
+
+      item_attributes = attr[key].map do |set_of_attr|
+        self.class.hash_keys_to_sym(set_of_attr)
+      end
+      attr[key] = item_attributes
+
+      self.class.hash_keys_to_sym(attr)
+    end
+  end
+end