alch 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff2bd271557caedefb37170982b626bd69f5e359
-  data.tar.gz: e32809b2594420db925e84257506fe5d07b3e3a2
+  metadata.gz: 0421dd1fabbd36b971e6828a591e9c554d95fec9
+  data.tar.gz: c123074c01000c9baa261464c56ec1f6578fb50e
 SHA512:
-  metadata.gz: 3ea9bf387fa650c21ccf3ddf83b7960902ea036939290ab30c46fc95fcf8c0ab712c0e91db2acd74cb509e26fabf300261d7601df4660c0b1cc91c96a2d940f1
-  data.tar.gz: aa7f18f3e1346c4b5973097de2831c8e504c634d3edc7f7b0626c7086b785e098c6485c4c9e4983fdb6fad11382a4ee5bed5c5b9e4907c279924e91751b9f92c
+  metadata.gz: 4ce6b1c8257fc877390039b1c6de64d5a2161be73e63bf296e86bec2986c6812b441d30529873276e4e47b331d3c0fceff29a8b46934539a47d6107097830d7b
+  data.tar.gz: bb050fe0c9dace8e2038a4370d1204f18aaa733ab585d4849054902e13de31ff9ae403257eb486c40b2e8e058332a50a1d523e3ebcf9cdd2b03ccfbfa27d0280

data/README.md

@@ -31,4 +31,4 @@ puts item.high_alch - (item.price + nature_rune.price)
 ```
 
 # Full Documentation
-[View the Full Documentation on RubyGems](http://www.rubydoc.info/gems/alch/2.0.0)
+[View the Full Documentation on RubyGems](http://www.rubydoc.info/gems/alch/2.1.0)

data/lib/alch.rb

@@ -2,6 +2,6 @@
 # Released under the MIT License agreement
 
 # @author Marcello A. Sabino
-# @version 2.0.0
+# @version 2.1.0
 require_relative 'item'
 require_relative 'osrs'

data/lib/item.rb

@@ -15,7 +15,7 @@ class Item
   # @return [Integer] the price based on the Grand Exchange
   attr_reader :price
   # @return [Integer] the price based on the store
-  attr_reader :store_price
+  attr_reader :store
   # @return [Integer] the amount of GP from low alching
   attr_reader :low_alch
   # @return [Integer] the amount of GP from high alching
@@ -25,49 +25,35 @@ class Item
 
   # Creates a new Item object
   #
-  # You must give the Item's ID to create an item.
+  # You can create a new Item by specifying the Item's name or
+  # the Item's id number as an integer.
   #
-  # @note it takes parameter id and casts to a String type
-  # @param id - the ID of the Item (numerical)
+  # @note when passing the id number as the parameter, it must be an Integer
+  # @note when passing the Item's name as the parameter, it's case INSENSITIVE
+  # @param item - either the Item's name as a String or Item's id as an Integer
   # @return [Item] a new Item object
   # @example Create a new Item
   #   Item.new(1603) #=> Item
-  #   Item.new(Item.id_by_name('ruby')) #=> Item
-  def initialize(id)
-    @id = id.to_s
-    @name = generate_name
-    @price = generate_price
-    @store_price = generate_store
-    @low_alch = (@store_price * 0.4).to_i
-    @high_alch = (@store_price * 0.6).to_i
-    @image = generate_image
-  end
-
-  # Class method to get the Item's ID by Item's name
-  # @note The `item_name` gets capitalized for search!
-  #       So this is case insensitive.
-  # @param item_name [String] the name of the Item to search
-  # @return [Integer] the Item's ID
-  # @raise RunTimeError if the Item doesn't exist
-  # @example Creating an Item object
-  #   Item.new(Item.id_by_name('uncut ruby')) #=> Item
-  #   Item.new(Item.id_by_name('UNCUT rUby')) #=> Item
-  #   Item.new(Item.id_by_name('incit rbuy')) #=> RunTimeError
-  def self.id_by_name(item_name)
-    item_name.capitalize!
-    json = JSON.parse(open(OSRS::SHOP_DATA, &:read))
-    item_id = 0
-    json.each { |id, name| item_id = id if name['name'].eql? item_name }
-    raise "Item (#{item_name}) doesn't exist." if item_id.eql? 0
-    item_id.to_i
+  #   Item.new('ruby') #=> Item
+  #   Item.new('1603') #=> RunTimeError (Item doesn't exist)
+  def initialize(item)
+    @id = item if item.is_a?(Integer)
+    @id = id_by_name(item) if item.is_a?(String)
+    @grand_exchange = JSON.parse(open(OSRS::GE_JSON + @id.to_s, &:read)).freeze
+    @name = OSRS::STORE_DATA[@id.to_s]['name']
+    @price = price_to_int(@grand_exchange['item']['current']['price'].to_s)
+    @store = OSRS::STORE_DATA[@id.to_s]['store'].to_i
+    @low_alch = (@store * 0.4).to_i
+    @high_alch = (@store * 0.6).to_i
+    @image = @grand_exchange['item']['icon_large']
   end
 
   # Checks if this item's GE price is less than another item's
   # @param [Item] other - the other item to compare to
   # @return [Boolean] true if this item is worth less than the other item.
   # @example Example
-  #   abyssal_whip = Item.new(Item.id_by_name('abyssal whip'))
-  #   ruby = Item.new(Item.id_by_name('ruby'))
+  #   abyssal_whip = Item.new('abyssal whip')
+  #   ruby = Item.new('ruby')
   #   price = abyssal_whip < ruby #=> false
   def <(other)
     price < other.price
@@ -77,8 +63,8 @@ class Item
   # @param [Item] other - the other item to compare to
   # @return [Boolean] true if this item is worth less than the other item.
   # @example Example
-  #   abyssal_whip = Item.new(Item.id_by_name('abyssal whip'))
-  #   ruby = Item.new(Item.id_by_name('ruby'))
+  #   abyssal_whip = Item.new('abyssal whip')
+  #   ruby = Item.new('ruby')
   #   price = abyssal_whip > ruby #=> true
   def >(other)
     price > other.price
@@ -88,8 +74,8 @@ class Item
   # @param [Item] other - the other item, which price we will subtract from
   # @return [Integer] self.price - other.price
   # @example Example
-  #   abyssal_whip = Item.new(Item.id_by_name('abyssal whip'))
-  #   santa_hat = Item.new(Item.id_by_name('santa hat'))
+  #   abyssal_whip = Item.new('abyssal whip')
+  #   santa_hat = Item.new('santa hat')
   #   price = abyssal_whip - santa_hat #=> 1788200
   def -(other)
     price - other.price
@@ -99,34 +85,41 @@ class Item
   # @param [Item] other - the other item, which price we will subtract from
   # @return [Integer] self.price - other.price
   # @example Example
-  #   abyssal_whip = Item.new(Item.id_by_name('abyssal whip'))
-  #   santa_hat = Item.new(Item.id_by_name('santa hat'))
+  #   abyssal_whip = Item.new('abyssal whip')
+  #   santa_hat = Item.new('santa hat')
   #   price = abyssal_whip + santa_hat #=> 1811800
   def +(other)
     price + other.price
   end
 
-  private
-
-  # @return [String] the name of the Item
-  def generate_name
-    JSON.parse(open(OSRS::SHOP_DATA, &:read))[@id]['name']
+  # @example Profit from high alching a Rune Dagger
+  #   Item.new('rune dagger').high_alch #=> 26
+  # @return the total profit from high alching this Item
+  def high_profit
+    high_alch - (self + Item.new(561))
   end
 
-  # @return [Integer] the Grand Exchange price of the Item
-  def generate_price
-    json = JSON.parse(open(OSRS::GE_JSON + @id, &:read))
-    price_to_int(json['item']['current']['price'])
+  # @example Profit from low alching a Rune Dagger
+  #   Item.new('rune dagger').low_price #=> -1574
+  # @return the total profit from low alching this Item
+  def low_profit
+    low_alch - (self + Item.new(561))
   end
 
-  # @return [Integer] the store price of the Item
-  def generate_store
-    JSON.parse(open(OSRS::SHOP_DATA, &:read))[@id]['store'].to_i
-  end
+  private
 
-  # @return [String] image url of the Item
-  def generate_image
-    JSON.parse(open(OSRS::GE_JSON + @id, &:read))['item']['icon_large']
+  # Gets the id of the item based on it's name
+  # @param [String] item_name - the name of the Item
+  # @return [Integer] Item's id
+  # @raise RunTimeError - if the Item doesn't exist in the database
+  def id_by_name(item_name)
+    item_name.capitalize!.freeze
+    item_id = 0
+    OSRS::STORE_DATA.each do |id, name|
+      item_id = id if name['name'] == item_name
+    end
+    raise "Item (#{item_name}) doesn't exist." if item_id.eql? 0
+    item_id.to_i
   end
 
   # Turns a price, like 1.9m and converts it to an Integer.

data/lib/osrs.rb

@@ -1,8 +1,13 @@
+require 'json'
+require 'open-uri'
+
 # Old School Runescape Module
 # @since 0.0.2
 module OSRS
   # Links to GE specific data
   GE_JSON = 'http://services.runescape.com/m=itemdb_oldschool/api/catalogue/detail.json?item='.freeze
-  # Link to Shop Data
-  SHOP_DATA = 'http://marchy.me/data/shop.json'.freeze
+  # Link to Store JSON
+  STORE_JSON = 'http://marchy.me/data/shop.json'.freeze
+  # Store data
+  STORE_DATA = JSON.parse(open(STORE_JSON, &:read)).freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alch
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Marcello A. Sabino