Poe Watch Ruby API

require 'poe_watch'

$redis = Redis.new

# In production for instance if you were to use rediscloud on heroku :
url = ENV["REDISCLOUD_URL"] # or whatever is the URL of your redis

if url
  $redis = Redis.new(:url => url)
end

PoeWatch::Api.redis = Redis.new

# In production for instance, if you were to use rediscloud on heroku:
url = ENV["REDISCLOUD_URL"] # or whatever is the URL of your redis

if url
  PoeWatch::Api.redis = Redis.new(:url => url)
end

require 'poe_watch'

# See the dependencies section
PoeWatch::Api.redis = Redis.new

# Non mandatory
PoeWatch::Api.refresh!(3600) # cache for 1 hour

PoeWatch::Item.find({ name: "Circle of Nostalgia" }).price_for_league('Metamorph')

PoeWatch::Item.all # => array of PoeWatch::Item objects
PoeWatch::Item.count  # => total number of items

items = PoeWatch::Item.where(name: /circle/i) # Returns all items with a name containing "circle"

items.first.id # => 223
items.first.name # => "Hubris Circlet"

item = PoeWatch::Item.find(name: "Circle of Nostalgia") # Returns the item "Circle of Nostalgia"
item = PoeWatch::Item.find(name: /circle/i) # Returns the first item with a name containing "circle"

item.id # => 223
item.name # => "Hubris Circlet"

item = PoeWatch::Item.find(name: "Circle of Nostalgia")

# Returns price data for all leagues
item.prices

# Returns price data for all leagues matching the name
item.price_for_leagues("Metamorph") # => all metamorph leagues (HC / SC) price data

# Returns price data for a specific league
item.price_for_leagues("Metamorph") # => Price data for "Metamorph"
item.price_for_leagues(/metamorph/i) # => Price data for the first metamorph league found

PoeWatch::League.all # => array of PoeWatch::League objects
PoeWatch::League.count  # => total number of leagues

leagues = PoeWatch::League.where(hardcore: false) # Returns all non hardcore leagues
leagues = PoeWatch::League.where(name: /metamorph/i) # You can use regular expressions or strings for your queries

leagues.first.name # => "Hardcore Metamorph"
leagues.first.hardcore? # => true
leagues.first.start? # => "2019-12-13T20:00:00Z"

league = PoeWatch::League.find(name: "Metamorph") # Return the non hardcore "Metamorph" league
league = PoeWatch::League.find(name: /metamorph/i, hardcore: false) # Will return the first non hardcore Metamorph league found

league.name # => "Metamorph"
league.hardcore? # => false
league.start? # => "2019-12-13T20:00:00Z"

PoeWatch::Categories.all # => array of PoeWatch::Category objects
PoeWatch::Categories.count  # => total number of categories

categories = PoeWatch::Category.where(name: /accessory/i) # You can use regular expressions or strings for your queries

categories.first.display # => "Accessories"

category = PoeWatch::Category.find(name: /accessory/i) # You can use regular expressions or strings for your queries

category.display # => "Accessories"
category.groups # => [#<OpenStruct id=1, name="amulet", display="Amulets">, ...]
category.groups.first.name # => "amulet"

# Fetch all the data from poe.watch API and cache it for the next 1 day.
# You don't actually need to call this. It is automatically called when using `::find`, `::where`, `::all` or `::count`, and won't do anything if the cache already contains data. 
# Although beware that if you don't call it first, the first call to find/where/all/count every 1 day will take longer (around 2-4 seconds, there are quite a lot of items to fetch).
PoeWatch::Api.refresh! 
# You can also specify a cache TTL different than 1 day
PoeWatch::Api.refresh!(3600) # 1 hour cache

# If you need to force clear the cache, you can use 
PoeWatch::Api.clear!

# You can check if the cache has expired with 
PoeWatch::Api.has_expired?
# Or do the opposite with 
PoeWatch::Api.ready?