alch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 617a0a12f9f2da25046bdd402c248e76ef1048e8
+  data.tar.gz: ba05835bfe9aa78861c34936d7d35bf79cccfdf6
+SHA512:
+  metadata.gz: 61864e4634bf09e9c0b83f7e15bb83e97bd372b00172b8fa4e0d5c4709da55a26864887878bb1d54c0462e0e198fa5443f38287423a6ba0dc49d7eb07beffcb4
+  data.tar.gz: 922f4196c930b09fa2bd590904a101da197bcc1f312bfe4169dd27979a5474db0309060365e2ec70b2d8a9e5c1760eac2b1c163c31f6026ee2b9acdb56bca2d6

data/lib/alch.rb

@@ -0,0 +1,8 @@
+# Require this file if you are to use this in a project
+# Released under the MIT License agreement
+
+# @author RubySometimes (GitHub)
+# @version 1.0.5
+require_relative('alch/item')
+require_relative('alch/osrs')
+require_relative('alch/runes')

data/lib/alch/item.rb

@@ -0,0 +1,125 @@
+require_relative('osrs')
+require_relative('runes')
+require('json')
+require('net/http')
+
+# Items are anything that can be in your inventory.
+#
+# @author RubySometimes (GitHub)
+class Item
+  # Attributes
+  attr_reader :id
+  attr_reader :name
+  attr_reader :price
+  attr_reader :store_price
+  attr_reader :low_alch
+  attr_reader :high_alch
+  attr_reader :image
+
+  # Creates a new Item object
+  # @param id - the id of the Item
+  # @raise RunTimeError if the id is not an integer
+  def initialize(id)
+    raise 'Parameter id must be an Integer' unless id.instance_of? Integer
+    @id = id
+    @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 name
+  # @param item_name - the name of the item to search for
+  #        the item_name gets capitalized for search.
+  # @return the item's id
+  # @raise RunTimeError if the item doesn't exist
+  def self.id_by_name(item_name)
+    item_name = item_name.capitalize
+    uri = URI(OSRS::SHOP_DATA)
+    json = JSON.parse(Net::HTTP.get(uri))
+    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
+  end
+
+  # Checks if this item's GE price is less than another item's
+  # @param other - the other item to compare to
+  # @return true if this item is worth less than the other_item.
+  def <(other)
+    price < other.price
+  end
+
+  # Checks if this item's GE price is greater than another item's
+  # @param other_item - the other item to compare to
+  # @return true if this item is worth less than the other_item.
+  def >(other)
+    price > other.price
+  end
+
+  # Take another item's price and subtract it from this item
+  # @param other - the other item, which price we will subtract from
+  # @return self.price - other.price
+  def -(other)
+    price - other.price
+  end
+
+  # Take another item's price and add it with this item's price
+  # @param other - the other item, which price we will subtract from
+  # @return self.price - other.price
+  def +(other)
+    price + other.price
+  end
+
+  private
+
+  # Gets the name of the Item
+  # @return the name of the Item
+  def generate_name
+    uri = URI(OSRS::SHOP_DATA)
+    json = JSON.parse(Net::HTTP.get(uri))
+    json[@id.to_s]['name']
+  end
+
+  # Gets the store price of the Item
+  # @return the store price of the Item
+  def generate_store
+    uri = URI(OSRS::SHOP_DATA)
+    json = JSON.parse(Net::HTTP.get(uri))
+    json[@id.to_s]['store'].to_i
+  end
+
+  # Gets the average price of the Item on the GE
+  # @return the average price on the GE
+  def generate_price
+    uri = URI(OSRS::GE_JSON + @id.to_s)
+    json = JSON.parse(Net::HTTP.get(uri))
+    price_to_int(json['item']['current']['price'])
+  end
+
+  # Gets the image url of the item.
+  # @return the image url of the item as a string.
+  def generate_image
+    uri = URI(OSRS::GE_JSON + @id.to_s)
+    json = JSON.parse(Net::HTTP.get(uri))
+    json['item']['icon_large']
+  end
+
+  # Turns a price, like 1.9m and converts to an Integer.
+  # @param price - the price of an item in string form
+  # @return the integer form of a price.
+  def price_to_int(price)
+    price_float = clean_price(price.to_s)
+    price_float *= 1_000_000 if price[-1] == 'm'
+    price_float *= 1_000 if price[-1] == 'k'
+    price_float.to_i
+  end
+
+  # Takes a price as a string, and removes any commas.
+  # @param price - the price from the JSON in string form.
+  def clean_price(price)
+    price.sub(/,/, '').to_f
+  end
+end

data/lib/alch/osrs.rb

@@ -0,0 +1,7 @@
+# Old School Runescape Module
+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
+end

data/lib/alch/runes.rb

@@ -0,0 +1,7 @@
+# Information on runes that are needed to perform alchemy
+module Runes
+  # Nature Rune ID
+  NATURE_RUNE_ID = 561
+  # Fire Rune ID
+  FIRE_RUNE_ID = 554
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: alch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcello A. Sabino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-03 00:00:00.000000000 Z
+dependencies: []
+description: A simple way to determine alch prices on Oldschool Runescape.
+email: march@marchy.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/alch.rb
+- lib/alch/item.rb
+- lib/alch/osrs.rb
+- lib/alch/runes.rb
+homepage: http://rubygems.org/gems/alch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Grab OSRS Alch Prices
+test_files: []