alch 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f36ac89d85c1648f5362ab9a6897b973fb6895f6
-  data.tar.gz: e66ce5de6bff1c0d40b9c09b6ff90989666e837d
+  metadata.gz: ff2bd271557caedefb37170982b626bd69f5e359
+  data.tar.gz: e32809b2594420db925e84257506fe5d07b3e3a2
 SHA512:
-  metadata.gz: b597cf3f2a5ee2891fb3a6c0b9a2b4d7db2f28ba11aab4d200c7356073b3bf2e610b9c958303b25dc7c2735d5721264df5246d7d54400d47b2b9183f8479da1c
-  data.tar.gz: 744b5551e403863d6ef9b3336049d64cf9c2384986ad6ab13bc3f7047068161616a0796f20dacf4ad10ac11370684e7285e63c01bb664bd5d0551e863280a818
+  metadata.gz: 3ea9bf387fa650c21ccf3ddf83b7960902ea036939290ab30c46fc95fcf8c0ab712c0e91db2acd74cb509e26fabf300261d7601df4660c0b1cc91c96a2d940f1
+  data.tar.gz: aa7f18f3e1346c4b5973097de2831c8e504c634d3edc7f7b0626c7086b785e098c6485c4c9e4983fdb6fad11382a4ee5bed5c5b9e4907c279924e91751b9f92c

data/README.md

@@ -1,45 +1,29 @@
 # Alch.rb
-A simplistic Runescape Alchemy API that can help you get alch prices of certain items.
+A simplistic Runescape Alchemy API that can help you get alch prices of certain items in no time at all.  The API is well-documented with good examples.  Start building your application now!
 
 ## Installation
-You can get the newest gem of Alch.rb.  Just enter the following in your command line:
+You can get the newest gem of `Alch.rb` just by using the following command:
 
-`$ gem install alch`
+`gem install alch`
 
-That's it! You are now able to include the API into your projects.
+That's it! You're now able to include the API into your projects.
 
-If you plan on using alch in a class or file, you have to require it at the top of your Ruby file, like so:
+If you plan on using Alch in your project, you will need to require it at the top of the Ruby file, like so:
 
-```ruby
-require 'alch'
-```
+`require 'alch'`
 
-### Dependencies
-Ruby 2.0 and up
+## Dependencies
+* `Ruby 2.3`
 
 ## Usage Examples
-A very basic use case:
+Basic use case:
 
 ```ruby
 require 'alch'
 
 # Create ruby and nature rune items
 item = Item.new(1603)
-nature_rune = Item.new(Runes::NATURE_RUNE_ID)
-
-# output => 'Profit from alching Ruby: -692'
-print "Profit from alching #{item.name}: "
-puts item.high_alch - (item.price + nature_rune.price)
-```
-
-Alternatively, you can also get the Item's ID by the Item's name.
-
-```ruby
-require 'alch'
-
-# Create ruby and nature rune items
-item = Item.new(Item.id_by_name('ruby'))
-nature_rune = Item.new(Runes::NATURE_RUNE_ID)
+nature_rune = Item.new(Item.id_by_name('nature rune'))
 
 # output => 'Profit from alching Ruby: -692'
 print "Profit from alching #{item.name}: "
@@ -47,4 +31,4 @@ puts item.high_alch - (item.price + nature_rune.price)
 ```
 
 # Full Documentation
-[View the Full Documentation](http://www.rubydoc.info/gems/alch/1.1.1)
+[View the Full Documentation on RubyGems](http://www.rubydoc.info/gems/alch/2.0.0)

data/lib/alch.rb

@@ -1,8 +1,7 @@
-# Require this file if you are to use this in a project
+# Require this file if you wish to use this in a project
 # Released under the MIT License agreement
 
-# @author RubySometimes (GitHub)
-# @version 1.1.1
-require_relative('alch/item')
-require_relative('alch/osrs')
-require_relative('alch/runes')
+# @author Marcello A. Sabino
+# @version 2.0.0
+require_relative 'item'
+require_relative 'osrs'

data/lib/item.rb

@@ -0,0 +1,141 @@
+require 'open-uri'
+require 'json'
+require_relative 'osrs'
+
+# Items are anything that are in the Grand Exchange,
+# traded, or alched.
+#
+# @author Marcello A. Sabino
+# @since 0.0.2
+class Item
+  # @return [Integer] the Item's ID
+  attr_reader :id
+  # @return [String] the Item's name
+  attr_reader :name
+  # @return [Integer] the price based on the Grand Exchange
+  attr_reader :price
+  # @return [Integer] the price based on the store
+  attr_reader :store_price
+  # @return [Integer] the amount of GP from low alching
+  attr_reader :low_alch
+  # @return [Integer] the amount of GP from high alching
+  attr_reader :high_alch
+  # @return [String] the image url of the Item
+  attr_reader :image
+
+  # Creates a new Item object
+  #
+  # You must give the Item's ID to create an item.
+  #
+  # @note it takes parameter id and casts to a String type
+  # @param id - the ID of the Item (numerical)
+  # @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
+  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'))
+  #   price = abyssal_whip < ruby #=> false
+  def <(other)
+    price < other.price
+  end
+
+  # Checks if this item's GE price is greater 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'))
+  #   price = abyssal_whip > ruby #=> true
+  def >(other)
+    price > other.price
+  end
+
+  # Take another item's price and subtract it from this 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'))
+  #   price = abyssal_whip - santa_hat #=> 1788200
+  def -(other)
+    price - other.price
+  end
+
+  # Take another item's price and add it with this item's price
+  # @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'))
+  #   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']
+  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'])
+  end
+
+  # @return [Integer] the store price of the Item
+  def generate_store
+    JSON.parse(open(OSRS::SHOP_DATA, &:read))[@id]['store'].to_i
+  end
+
+  # @return [String] image url of the Item
+  def generate_image
+    JSON.parse(open(OSRS::GE_JSON + @id, &:read))['item']['icon_large']
+  end
+
+  # Turns a price, like 1.9m and converts it to an Integer.
+  # @param price [String] the price of an Item
+  # @return [Integer] the price as an Integer
+  def price_to_int(price)
+    pf = price.sub(/,/, '').to_f # strip commas
+    return (pf *= 1_000_000).to_i if price[-1] == 'm'
+    return (pf *= 1_000).to_i if price[-1] == 'k'
+    pf.to_i
+  end
+end

data/lib/{alch/osrs.rb → osrs.rb}

@@ -1,4 +1,5 @@
 # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alch
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Marcello A. Sabino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies: []
 description: A simple way to determine alch prices on Oldschool Runescape
 email: march@marchy.me
@@ -18,9 +18,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/alch.rb
-- lib/alch/item.rb
-- lib/alch/osrs.rb
-- lib/alch/runes.rb
+- lib/item.rb
+- lib/osrs.rb
 homepage: http://rubygems.org/gems/alch
 licenses:
 - MIT
@@ -33,7 +32,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/alch/item.rb

@@ -1,136 +0,0 @@
-require 'json'
-require 'net/http'
-require_relative 'osrs'
-require_relative 'runes'
-
-# Items are anything that can be in your inventory.
-#
-# @author Marcello A. Sabino
-class Item
-  # Returns the id of the item
-  # @return [Integer] the item's id
-  attr_reader :id
-  # Returns the item's name
-  # @return [String] the item's name
-  attr_reader :name
-  # Returns the Grand Exchange price of the item
-  # @return [Integer] the Grand Exchange's price
-  attr_reader :price
-  # Returns the store's price of the item
-  # @return [Integer] the store's price
-  attr_reader :store_price
-  # Returns the gold pieces from low alching the item
-  # @return [Integer] the amount of GP from low alching
-  attr_reader :low_alch
-  # Returns the golf pieces from high alching the item
-  # @return [Integer] the amount of GP from high alching
-  attr_reader :high_alch
-  # Returns the image url of the item as a string.
-  # @return [String] the image url of the item, on Runescape.com
-  attr_reader :image
-
-  # Creates a new Item object
-  # @param [Integer] id - the id of the Item
-  def initialize(id)
-    @id = id.to_i
-    @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 [String] item_name - the name of the item to search for
-  #        the item_name gets capitalized for search.
-  # @return [Integer] 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 [Item] other - the other item to compare to
-  # @return [Boolean] 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 [Item] other - the other item to compare to
-  # @return [Boolean] 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 [Item] other - the other item, which price we will subtract from
-  # @return [Integer] self.price - other.price
-  def -(other)
-    price - other.price
-  end
-
-  # Take another item's price and add it with this item's price
-  # @param [Item] other - the other item, which price we will subtract from
-  # @return [Integer] 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 [Integer] 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 [Integer] 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 [Integer] 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 [Float] price - the price from the JSON in string form.
-  def clean_price(price)
-    price.sub(/,/, '').to_f
-  end
-end

data/lib/alch/runes.rb

@@ -1,7 +0,0 @@
-# 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