poe-watch-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bcf552167fc4cc9a0b3945ebd661e7830f3d39da65ba739a34b9dcc62f953d3
-  data.tar.gz: 0fb40c82867df71538b03e187bc09fa4b62f43007edf39d022b601c25279f434
+  metadata.gz: cf2383b4c1b9982d1f39b96e01f686c6e1ae0322b3337b8923fc290d99f7a764
+  data.tar.gz: dde62b42dc9214c046eb83f954e824e6d399455fdf3b7f610f5e76066c3db254
 SHA512:
-  metadata.gz: 4c6624a5ffc9c2ea4a5ab717121e4fdc20d48bcb40d4ba5eb42996f70c314b3b331a71ac1df9b9f88d34c5a67e0dceda0d543cc36c0148003b0f2f3bc2a6e03c
-  data.tar.gz: fae8e08f03d03d1f0e2859e9d1963144df65fe5108b1ba3e0c6715328717974669dece5baa8882862d04be74a132abc6e6e1c62064d62a97eae411b1e0587cc7
+  metadata.gz: e43560a54878190dde861ada8f0adf936ad12ecf1a08e1f51745cd7e84bb951a605ca9d1f7464532d8b8c5efd14902ef2b5f16f2e706928c162f8bdf83842c58
+  data.tar.gz: 0614bdd99b71d9bfbb7c5a99b49f99b30ccd1606928e70e67f9ce92cf79f201ea8f3d439141dbd248e98f1dc3e56226558b02206e0700cc79e87ea41c2c78526

data/README.md

@@ -50,10 +50,16 @@ or add it to your `Gemfile`
 gem 'poe-watch-api'
 ```
 
+Then 
+
+```ruby
+require 'poe_watch'
+```
+
 ## Dependencies
 
 This library has a dependency over `redis`. For it to work you need to have redis installed on your machine (and your server, in production, if using Heroku, you can use an addon like `rediscloud`).
-We use `redis` because we need to cache the data from Poe Watch to avoid refetching all the items data to often (there are almost 30k items in PoE which is quite a lot). 
+We use `redis` because we need to cache the data from Poe Watch to avoid refetching all the items data too often (there are almost 30k items in PoE which is quite a lot). 
 
 There are two ways of making this gem work with redis: 
 
@@ -84,19 +90,21 @@ end
 ```
 
 The total footprint of the data from PoeWatch API in redis is a bit less than **2 megabytes**. You can check the exact memory footprint in your redis by calling `PoeWatch::Api.memory_footprint`, the data will be displayed in kilobytes.
-The default time to live (TTL) of the cache is 45 minutes.
+The default time to live (TTL) of the cache is 1 day.
 
 ## Usage
 
 Here is a simple usage example:
-```
+```ruby
+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.find({ name: "Circle of Nostalgia" }).price_for_league('Metamorph')
 ```
 
 ### Items
@@ -121,14 +129,14 @@ 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"
 
-items.id # => 223
-items.name # => "Hubris Circlet"
+item.id # => 223
+item.name # => "Hubris Circlet"
 ```
 
 #### Item properties
 
-All properties have an accessor you can use, e.g: `item.id`, `item.name`, `item.hardcore`. 
-All boolean properties have an additionnal question mark accessor, e.g:  `item.hardcore?`.
+All properties have an accessor you can use, e.g: `item.id`, `item.name`, `item.category`. 
+All boolean properties have an additionnal question mark accessor, e.g:  `item.gem_is_corrupted?`.
 
 Items only have relevant properties (e.g: map tiers only on maps, stack_size only on currencies, etc...)
 
@@ -214,7 +222,7 @@ leagues.first.start? # => "2019-12-13T20:00:00Z"
 #### Find one specific league
 ```ruby
 league = PoeWatch::League.find(name: "Metamorph") # Return the non hardcore "Metamorph" league
-league = PoeWatch::League.find(name: /metamorph/i) # Will return the first Metamorph league found
+league = PoeWatch::League.find(name: /metamorph/i, hardcore: false) # Will return the first non hardcore Metamorph league found
 
 league.name # => "Metamorph"
 league.hardcore? # => false
@@ -278,11 +286,11 @@ All properties have an accessor you can use, e.g: `category.name`, `category.gro
 ### API Cache
 
 ```ruby
-# Fetch all the data from poe.watch API and cache it for the next 45 minutes.
+# 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 45 minutes will take longer (around 2-4 seconds, there are quite a lot of items to fetch).
+# 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 45 minutes
+# 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 
@@ -296,12 +304,12 @@ PoeWatch::Api.ready?
 
 ## Shortcomings
 
-- Doing a find or where on an item will always take some time (1-2 seconds) because it has to traverse all ~30k objects from PoE to find your matches. This could probably be optimised but I haven't had the time to get around to do it. 
+- When you want to fetch the price of an item, we do a request each time using the PoE API `/item` endpoint, which is not ideal. Ideally we'd want to use the `/compact` API for that but I haven't had the time to do that yet.
 - No rate limiter set for the moment so when fetching a bunch of item prices you could hit the rate limiter of `poe.watch`. I'll add one at some point in the future if is needed or requested.
 
 ## Contribution
 
-The code is well documented, using [tomdoc](http://tomdoc.org/), is you wish to contribute, raise an issue or fork this project and create a pull request :).
+The code is well documented, using [tomdoc](http://tomdoc.org/), if you wish to contribute, raise an issue or fork this project and create a pull request :).
 
 Most of the codebase is in `lib/api`, `lib/base` and `lib/item`.
 

data/lib/api.rb

@@ -34,7 +34,7 @@ module PoeWatch
 
     ITEM_API = "https://api.poe.watch/item"
 
-    DEFAULT_EXPIRY = 45 * 60 # 45 minutes
+    DEFAULT_EXPIRY = 86400 # 1 day
     
     @updating = false
     @redis = $redis 

data/lib/base.rb

@@ -29,6 +29,7 @@ module PoeWatch
 
       # Setter for instance variable
       def __data=(value)
+        puts "SETTING @__data"
         @__data = value
       end
 
@@ -52,14 +53,15 @@ module PoeWatch
       # Returns an Array of class instances.
       def all
         PoeWatch::Api.refresh!
-        
+
         return __data if __data.any?
-        
+        puts "PAST DATA"
         # If data isn't already loaded
         # puts "Loading #{type} data..."
         json_data = PoeWatch::Api.send(INFLECTOR[type])
         if json_data.any?
-          __data = json_data.map { |raw_data| self.new(raw_data) }
+          self.__data = json_data.map { |raw_data| self.new(raw_data) }
+          __data
         else
           []
         end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module PoeWatch
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poe-watch-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - GabrielDehan