backpack_tf 0.8.4 → 1.0.0.rc1

data/spec/fixtures/user_listing_individual.json

@@ -0,0 +1,51 @@
+{
+  "bump": 1453660379,
+  "intent": 1,
+  "currencies": {
+    "keys": 58
+  },
+  "buyout": 1,
+  "details": false,
+  "item": {
+    "id": 4224171036,
+    "original_id": 4114938468,
+    "defindex": 937,
+    "level": 85,
+    "quality": 5,
+    "inventory": 3221225475,
+    "quantity": 1,
+    "origin": 8,
+    "attributes": [
+      {
+        "defindex": 134,
+        "value": 1088421888,
+        "float_value": 7
+      },
+      {
+        "defindex": 746,
+        "value": 1065353216,
+        "float_value": 1
+      },
+      {
+        "defindex": 292,
+        "value": 1115684864,
+        "float_value": 64
+      },
+      {
+        "defindex": 388,
+        "value": 1115684864,
+        "float_value": 64
+      }
+    ]
+  },
+  "flags": {
+    "class": "pyro",
+    "slot": "misc",
+    "particle": 7,
+    "craft_material_type": "hat",
+    "priceindex": 7,
+    "sku": "440_Unusual_Wraith Wrap_1_1_7"
+  },
+  "created": 1445205322,
+  "id": "5624154aba8d884610a41c51"
+}

data/spec/spec_helper.rb

@@ -1,17 +1,20 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'backpack_tf'
 require 'webmock/rspec'
 
 def generate_fake_api_key
   hex_nums = %w(0 1 2 3 4 5 6 7 8 9 a b c d e f)
   key = ''
-  24.times{ |k| key << hex_nums.sample }
+  24.times { key << hex_nums.sample }
   key
 end
 
 # taken from httparty's spec dir
 # https://github.com/jnunemaker/httparty/blob/master/spec/spec_helper.rb
 def file_fixture(filename)
-  filename = File.join( File.dirname(__FILE__), "fixtures", "#{filename}")
+  filename = File.join(File.dirname(__FILE__), 'fixtures', filename.to_s)
   File.open(filename).read
 end
 
@@ -23,55 +26,12 @@ def stub_http_response_with(filename)
   response = Net::HTTPOK.new('1.1', 200, 'Content for you')
   allow(response).to receive(:body).and_return(data)
 
-  http_request = HTTParty::Request.new(Net::HTTP::Get, 'http://localhost', format: format)
-  allow(http_request).to receive_message_chain(:http, :request).and_return(response)
-
-  expect(HTTParty::Request).to receive(:new).and_return(http_request)
-end
-
-def make_fetch_sym
-  opt = described_class.to_s
-  ind_after_scope_operator = opt.index('::') + 2
-  opt = opt[ind_after_scope_operator..-1]
-  opt.downcase.to_sym
-end
-
-def mock_alias
-
-  case described_class.to_s
-
-  when BackpackTF::Price.to_s
-    described_class.class_eval do
-      class << self; attr_class_alias(:data_storage, :items); end
-    end
-  when BackpackTF::Currency.to_s
-    described_class.class_eval do
-      class << self; attr_class_alias :data_storage, :currencies; end
-    end
-  when BackpackTF::SpecialItem.to_s
-    described_class.class_eval do
-      class << self; attr_class_alias :data_storage, :items; end
-    end
-  when BackpackTF::User.to_s
-    described_class.class_eval do
-      class << self; attr_class_alias :data_storage, :players; end
-    end
-  when BackpackTF::UserListing.to_s
-    described_class.class_eval do
-      class << self; attr_class_alias :data_storage, :listings; end
-    end
-  else
-    raise RuntimeError, "#{described_class} != described_class"
-  end
-
-end
+  request = HTTParty::Request.new(Net::HTTP::Get,
+                                  'http://localhost',
+                                  format: format)
+  allow(request).
+    to receive_message_chain(:http, :request).
+    and_return(response)
 
-# credit: http://stackoverflow.com/a/913453/2908123
-class Module
-  def attr_class_alias(new_attr, original_attr)
-    alias_method(new_attr, original_attr) if method_defined? original_attr
-    new_writer = "#{new_attr}="
-    original_writer = "#{original_attr}="
-    alias_method(new_writer, original_writer) if method_defined? original_writer
-  end
+  expect(HTTParty::Request).to receive(:new).and_return(request)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backpack_tf
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Rafael Espinoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-09 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -59,42 +59,86 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
-- TODO.md
+- Gemfile.lock
+- README.md
+- Rakefile
 - backpack_tf.gemspec
 - lib/backpack_tf.rb
-- lib/backpack_tf/assets/attribute_controlled_attached_particles.json
+- lib/backpack_tf/assets/particle_effects.json
 - lib/backpack_tf/client.rb
 - lib/backpack_tf/currency.rb
-- lib/backpack_tf/item.rb
-- lib/backpack_tf/item_price.rb
+- lib/backpack_tf/currency/interface.rb
+- lib/backpack_tf/currency/response.rb
+- lib/backpack_tf/helpers.rb
+- lib/backpack_tf/interface.rb
+- lib/backpack_tf/market_price.rb
+- lib/backpack_tf/market_price/interface.rb
+- lib/backpack_tf/market_price/response.rb
 - lib/backpack_tf/price.rb
+- lib/backpack_tf/price/interface.rb
+- lib/backpack_tf/price/item.rb
+- lib/backpack_tf/price/item_price.rb
+- lib/backpack_tf/price/particle_effect.rb
+- lib/backpack_tf/price/response.rb
+- lib/backpack_tf/price_history.rb
+- lib/backpack_tf/price_history/interface.rb
+- lib/backpack_tf/price_history/response.rb
 - lib/backpack_tf/response.rb
 - lib/backpack_tf/special_item.rb
+- lib/backpack_tf/special_item/interface.rb
+- lib/backpack_tf/special_item/response.rb
 - lib/backpack_tf/user.rb
+- lib/backpack_tf/user/interface.rb
+- lib/backpack_tf/user/response.rb
 - lib/backpack_tf/user_listing.rb
+- lib/backpack_tf/user_listing/interface.rb
+- lib/backpack_tf/user_listing/response.rb
 - lib/backpack_tf/version.rb
-- readme.md
 - spec/backpack_tf/client_spec.rb
+- spec/backpack_tf/currency/interface_spec.rb
+- spec/backpack_tf/currency/response_spec.rb
 - spec/backpack_tf/currency_spec.rb
-- spec/backpack_tf/inherited_class_methods_spec.rb
-- spec/backpack_tf/item_price_spec.rb
-- spec/backpack_tf/item_spec.rb
-- spec/backpack_tf/price_spec.rb
+- spec/backpack_tf/helpers_spec.rb
+- spec/backpack_tf/interface_spec.rb
+- spec/backpack_tf/market_price/interface_spec.rb
+- spec/backpack_tf/market_price/response_spec.rb
+- spec/backpack_tf/market_price_spec.rb
+- spec/backpack_tf/price/interface_spec.rb
+- spec/backpack_tf/price/item_price_spec.rb
+- spec/backpack_tf/price/item_spec.rb
+- spec/backpack_tf/price/particle_effect_spec.rb
+- spec/backpack_tf/price/response_spec.rb
+- spec/backpack_tf/price_history/interface_spec.rb
+- spec/backpack_tf/price_history/response_spec.rb
+- spec/backpack_tf/price_history_spec.rb
 - spec/backpack_tf/response_spec.rb
+- spec/backpack_tf/special_item/interface_spec.rb
+- spec/backpack_tf/special_item/response_spec.rb
 - spec/backpack_tf/special_item_spec.rb
+- spec/backpack_tf/user/interface_spec.rb
+- spec/backpack_tf/user/response_spec.rb
+- spec/backpack_tf/user_listing/interface_spec.rb
+- spec/backpack_tf/user_listing/response_spec.rb
 - spec/backpack_tf/user_listing_spec.rb
 - spec/backpack_tf/user_spec.rb
 - spec/fixtures/currencies.json
 - spec/fixtures/currencies_updated.json
 - spec/fixtures/item_crate.json
+- spec/fixtures/item_price_typical.json
+- spec/fixtures/item_price_unusual.json
 - spec/fixtures/item_typical.json
 - spec/fixtures/item_unusual.json
+- spec/fixtures/item_with_dual_craftability_tradability.json
 - spec/fixtures/item_with_unconventional_structure.json
-- spec/fixtures/item_without_defindex.json
+- spec/fixtures/market_prices.json
+- spec/fixtures/price_history.json
 - spec/fixtures/prices.json
 - spec/fixtures/special_items.json
 - spec/fixtures/user_listing.json
+- spec/fixtures/user_listing_individual.json
 - spec/fixtures/users.json
 - spec/spec_helper.rb
 homepage: https://github.com/NerdDiffer/backpack_tf
@@ -109,16 +153,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: a wrapper for the backpack.tf API
 test_files: []
+has_rdoc: 

data/TODO.md

@@ -1,15 +0,0 @@
-##TODO list
-
-#####testing:
-* a mock backpack.tf service
-* stubs & archived cache data
-
-#####documentation:
-* better documentation on all classes, modules, methods, attributes, etc
-* support for YARD or RDOC
-
-#####caching:
-* options to cache data and force a refresh
-
-#####formats:
-* the API outputs 3 formats: JSON (default), JSONP and VDF. Currently, the gem supports JSON input only. Support for JSONP & VDF is needed.

data/lib/backpack_tf/item.rb

@@ -1,84 +0,0 @@
-module BackpackTF
-
-  class Item
-    ###########################
-    #     Instance Methods
-    ###########################
-
-    # @return [String] the name of item
-    attr_reader :item_name
-    # @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
-
-    def initialize item_name, attr
-      @item_name  = item_name
-
-      unless attr.class == Hash
-        attr = JSON.parse(attr) 
-      end
-
-      @defindex   = process_defindex(attr['defindex'])
-      @prices     = generate_prices_hash(attr)
-    end
-
-    def process_defindex arr
-      return nil if arr.length == 0
-      return arr[0] if arr.length == 1
-      arr
-    end
-
-    def generate_prices_hash input_hash
-
-      raise TypeError, 'expecting a Hash object' unless input_hash.class == Hash
-      unless input_hash.has_key? 'prices'
-        msg = "input_hash must be at the one level above the point where 'prices' is a key in the JSON hash"
-        raise KeyError, msg
-      end
-
-      prices = input_hash['prices']
-
-      prices.inject({}) do |hash, (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
-
-        new_key = new_key.join(ItemPrice::KEYNAME_DELIMITER)
-
-        prefix = prices[key][tradability][craftability]
-
-        if (prefix.length <= 1)
-          item_prices = prefix[0]
-          # patch for oddly-structured items, ie: Aqua Summer 2013 Cooler
-          item_prices = prefix.values.first if item_prices.nil?
-
-          item_price_obj = ItemPrice.new(new_key, item_prices)
-          hash[new_key] = item_price_obj
-        elsif key == '5' # item with 'Unusual' quality
-          prefix.keys.each do |prefix_key|
-            item_prices = prefix[prefix_key]
-            item_price_obj = ItemPrice.new(new_key, item_prices, prefix_key)
-            hash[item_price_obj.effect] = item_price_obj
-          end
-        else # a Crate
-          prefix.keys.each do |prefix_key|
-            temp_key = "#{new_key}_##{prefix_key.to_i}"
-            item_prices = prefix[prefix_key]
-            item_price_obj = ItemPrice.new(temp_key, item_prices, prefix_key)
-            hash[temp_key] = item_price_obj
-          end
-        end
-        hash
-      end
-
-    end
-
-  end
-end

data/lib/backpack_tf/item_price.rb

@@ -1,172 +0,0 @@
-module BackpackTF
-
-  class ItemPrice
-
-    KEYNAME_DELIMITER = '_'
-    PARTICLE_EFFECTS_KEY = 'attribute_controlled_attached_particles'
-    PARTICLE_EFFECTS_FILE = "./lib/backpack_tf/assets/#{PARTICLE_EFFECTS_KEY}.json"
-
-    ###########################
-    #      Class Methods
-    ###########################
-
-    # 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"
-    ]
-
-    @@tradabilities = [:Tradable, :'Non-Tradable']
-    @@craftabilities = [:Craftable, :'Non-Craftable']
-    @@required_keys = ['currency', 'value', 'last_update', 'difference']
-
-    def self.qualities; @@qualities; end
-    def self.required_keys; @@required_keys; end
-
-    def self.quality_name_to_index q
-      @@qualities.index(q.to_sym) unless q.nil?
-    end
-
-    def self.hash_particle_effects
-
-      file = File.open(PARTICLE_EFFECTS_FILE).read
-      effects_arr = JSON.parse(file)[PARTICLE_EFFECTS_KEY]
-
-      effects_arr.inject({}) do |hash, pe|
-        id = pe['id']
-        name = pe['name']
-        hash[id] = name
-        hash
-      end
-
-    end
-
-    @@particle_effects = self.hash_particle_effects
-    def self.particle_effects; @@particle_effects; end
-
-    def self.ins_sp str
-      str = str.split('')
-      new_str = ''
-      str.each_with_index do |c, i|
-        if i == 0
-          new_str += c
-        else
-          unless c == c.upcase && str[i-1] == str[i-1].upcase
-            new_str += c
-          else
-            new_str += (' ' + c)
-          end
-        end
-      end
-      new_str
-    end
-
-    ###########################
-    #     Instance Methods
-    ###########################
-
-    # @return [String] the quality of the item being priced, converted to String
-    attr_reader :quality
-    # @return [Symbol] either :Tradable or :'Non-Tradable'
-    attr_reader :tradability
-    # @return [Symbol] either :Craftable or :'Non-Craftable'
-    attr_reader :craftability
-    # @return [NilClass or Fixnum] Primarily used to signify crate series or unusual effect. Otherwise, this is 0
-    attr_reader :priceindex
-    # @return [Symbol] The currency that the item's price is based on
-    attr_reader :currency
-    # @return [Float] The value of the item in said currency
-    attr_reader :value
-    # @return [Float] The item's upper value measured in said currency. only set if the item has a price range
-    attr_reader :value_high
-    # @return [Float] The item's value in the lowest currency without rounding. If raw is set to 2, this is the lower value if a high value exists. Otherwise, this is the average between the high and low value. Requires raw to be enabled. 
-    attr_reader :value_raw
-    # @return [Float] The item's value in the lowest currency without rounding. Reques raw to be enabled and set to 2
-    attr_reader :value_high_raw
-    # @return [Fixnum] A timestamp of when the price was last updated
-    attr_reader :last_update
-    # @return [Fixnum] A relative difference between the former price and the current price. If 0, assume new price.
-    attr_reader :difference
-    # @return [String] Result of @@particle_effects[@priceindex]
-    attr_reader :effect
-
-    def initialize key, attr, priceindex = nil
-      attr = JSON.parse(attr) unless attr.class == Hash
-
-      key = key.split(KEYNAME_DELIMITER)
-      key = process_key(key)
-
-      validate_attributes(attr)
-
-      @quality        = key[0]
-      @tradability    = key[1]
-      @craftability   = key[2]
-      @currency       = attr['currency'].to_sym
-      @value          = attr['value']
-      @value_high     = attr['value_high']
-      @value_raw      = attr['value_raw']
-      @value_high_raw = attr['value_high_raw']
-      @last_update    = attr['last_update']
-      @difference     = attr['difference']
-      @priceindex     = priceindex
-      @effect         = self.class.particle_effects[priceindex.to_i]
-    end
-
-    private
-    # requires the key to an Array with length of 3 or more
-    # converts each element to a Symbol object
-    # The 3 bits of info are subject to a NameError if any one of them is invalid
-    # @return [Array] an Array of Symbol objects
-    # @raises NameError, ArgumentError
-    def process_key key
-
-      unless key.length >= 3
-        raise ArgumentError, "This key must have a length of 3 or greater"
-      end
-
-      key.map! { |bit| bit.to_sym }
-
-      unless @@qualities.include? key[0]
-        raise NameError, 'Must include a valid Quality'
-      end
-      unless @@tradabilities.include? key[1]
-        raise NameError, 'Must include a valid Tradability'
-      end
-      unless @@craftabilities.include? key[2]
-        raise NameError, 'Must include a valid Craftability'
-      end
-
-      key
-    end
-
-    def validate_attributes attributes
-
-      raise TypeError unless attributes.class == Hash
-
-      unless @@required_keys.all? { |k| attributes.keys.member? k }
-        msg = "The passed-in hash is required to have at least these 4 keys: "
-        msg += "#{self.class.required_keys.join(', ')}"
-        raise KeyError, msg
-      end
-
-      attributes
-
-    end
-
-  end
-
-end

data/readme.md

@@ -1,96 +0,0 @@
-#backpack_tf
-Backpack.tf is a website for the in-game economies of Team Fortress 2 and Dota 2. This gem is a wrapper for the backpack.tf [API](http://backpack.tf/api). The goal is to capture the results and turn them into Ruby objects for use in your application.
-
-It is in the early stages of development. See the [TODO](TODO.md) list if you are interested in contributing.
-
-###Installation
-#####install any dependencies
-`bundle install`
-
-######Install it as a gem:  
-`gem install backpack_tf`  
-
-######Or add it to your project's Gemfile:  
-`gem 'backpack_tf'`
-
-###Usage
-* [Register an API key](http://backpack.tf/api). You'll need to log in with your Steam account if you haven't already done so.  
-* Assign your key to an environment variable through your terminal:  
-  `export BPTF_API_KEY='SECRET_KEY'`
-* Load the gem into your project:  
-  `require 'backpack_tf'`
-
-###Examples
-
-``` ruby
-##### create a new Client object  
-bp = BackpackTF::Client.new
-
-##### fetch some data
-fetched_prices = bp.fetch(:prices, { :compress => 1 })
-fetched_currencies = bp.fetch(:currencies, { :compress => 1 })
-fetched_special_items = bp.fetch(:special_items, { :compress => 1})
-fetched_users = bp.fetch(:users, { :steamids => [64_bit_steam_id_of_one_user, 64_bit_steam_id_of_another_user] })
-fetched_listings = bp.fetch(:user_listings, { :steamid => 64_bit_steam_id_of_one_user })
-
-##### update a class with the data
-# *note*: you should send a message from your Client object to the class before
-# using any of those class' methods.
-# This does not apply to the `Item` class and the `ItemPrice` class.
-# Those are updated through the `Price` class.
-
-bp.update(BackpackTF::Price, fetched_prices)
-bp.update(BackpackTF::Currency, fetched_currencies)
-bp.update(BackpackTF::SpecialItem, fetched_special_items)
-bp.update(BackpackTF::User, fetched_users)
-bp.update(BackpackTF::UserListing, fetched_listings)
-
-##### look at prices of a random item
-random_key = BackpackTF::Price.items.sample
-BackpackTF::Price.items[random_key]
-
-```
-
-##Interfaces
-
-####IGetPrices
-* Get pricing data for all priced items
-* [official doc](http://backpack.tf/api/prices)
-
-API responses from this interface are captured in the `Price` class. The `Price` class is not meant to be instantiated. One of the class attributes is `@@items`, a Hash object. Information on any particular item, ie: 'Eviction Notice', is captured in an instance of the `Item` class. Furthermore, there may be several prices for the same item, ie: an Eviction Notice with the Unique quality has a different price than a Eviction Notice with a Strange quality.  Each price is an instance of the `ItemPrice` class, and is stored in the `@prices` hash of that item.
-
-######a visual
-* `Price` class
-  * `@@items` hash of `Price` class.
-    * `Item` object (ie: 'Beast From Below')
-    * `Item` object (ie: 'Taunt: Rock, Paper Scissors')
-    * `Item` object (ie: 'Eviction Notice')
-      * `@prices` hash of an `Item` object
-        * `ItemPrice` object (ie: price for Unique Eviction Notice)
-        * `ItemPrice` object (ie: price for Collector's Eviction Notice)
-        * `ItemPrice` object (ie: price for Strange Eviction Notice)
-
-####IGetCurrencies
-* Get internal currency data for a given game
-* [official doc](http://backpack.tf/api/currencies)
-
-API responses from this interface are captured in the `Currency` class. Similar the `Price` class, it has a set of class methods, and attributes to describe the API response. Unlike, the `Price` class, this one can be instantiated. There are currently 4 currencies available through the API. Each one is an instance of `Currency` and is held in the `@@currencies` hash of the `Currency` class.
-
-####IGetSpecialItems
-* Get internal backpack.tf item placeholders for a given game.
-* [official doc](http://backpack.tf/api/special)
-
-This is for items that only exist on backpack.tf. They are not real game items, but you will see them returned in a call to `IGetPrices`. The class for this interface is `SpecialItem`.
-
-####IGetUsers
-* Get profile info for a list of 64-bit Steam IDs.
-* Does not require an API key
-* [official doc](http://backpack.tf/api/users)
-
-Get some basic information for a list of backpack.tf users. It's basically the info that you'd see on their profile page. The response for this interface is captured in the `User` class. You can request several users at once by sending them in an array.
-
-####IGetUserListings
-  * Get classified listings for a given user
-  * [official doc](http://backpack.tf/api/classifieds)
-
-Request all classified listings for one user. You must pass in the 64-bit `steamid`. The response is captured in the `UserListing` class.