alch 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fb60e6e423677cd1c0488e22874d87cc542b8dd
-  data.tar.gz: 0cdc2a36fc4e601a49066dc2978af99862f5aa5d
+  metadata.gz: cd3b7a3bd27afaf7c06e66161ceacfb90422ca0a
+  data.tar.gz: b6da70617e798c4ed9d8ee355d9f7285d9571ec0
 SHA512:
-  metadata.gz: f5b84d51c8348384ba2ddea3cd34e797b6cf413cb519e7237083d8efecf5a8de2de42f894c75a64196ef2d1cdc74e3001695d958f4e78ade1735108898e71d5c
-  data.tar.gz: c265351ae3da28092cc72d2c427c768f96f230ec0fcfaafab5b895fac587e432bbeb9e84935767575bf010bc46c4ea2c38846a7f19b9439a0495f8fe2b019db6
+  metadata.gz: b9fd3042b517f31681f9d9143e87168c099aceb40831c46c10ae92c1368ccc5801e74f2028283d5914fbfbaba0f266521f5b96136965e1be1bc3ab96b73e6c64
+  data.tar.gz: 3ad58144391253b2c54bd18270d4c05bcd3d0476b58de8cc5f56a1e363180a6af85dd38c15277ff175934cc8e97cb364b024123d0dbc8987da745672712796ca

data/README.md

@@ -1,24 +1,25 @@
 # Alch.rb
-A very simplistic Runescape Alchemy API that can help you get alch prices of certain items.  It's written in Ruby so that it can also be easily accessable within Rails.
+A simplistic Runescape Alchemy API that can help you get alch prices of certain items.
 
 ## Installation
-You can download the newest version of Alch.rb through Git.  Just enter the following in your command line:
+You can get the newest gem of Alch.rb.  Just enter the following in your command line:
 
 `$ gem install alch`
 
 That's it! You are now able to include the API into your projects.
 
-To do so, include the src files in your project and when you'd like to use this API in a Class, just require the `alch.rb` file like so:
+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:
 
 ```ruby
 require 'alch'
 ```
 
 ### Dependencies
-Since this was written in Ruby, you will need Ruby to use this API.
+Ruby 2.0 and up
 
 ## Usage Examples
 A very basic use case:
+
 ```ruby
 require 'alch'
 
@@ -46,6 +47,4 @@ puts item.high_alch - (item.price + nature_rune.price)
 ```
 
 # Full Documentation
-## Classes
-* **[Item.rb](https://github.com/RubySometimes/alchrb/blob/master/docs/classes/Item.md)**
-
+[View the Full Documentation](http://www.rubydoc.info/gems/alch/)

data/lib/alch.rb

@@ -2,7 +2,7 @@
 # Released under the MIT License agreement
 
 # @author RubySometimes (GitHub)
-# @version 0.0.1
+# @version 1.0.5
 require_relative('alch/item')
 require_relative('alch/osrs')
 require_relative('alch/runes')

data/lib/alch/item.rb

@@ -5,19 +5,13 @@ require('net/http')
 
 # Items are anything that can be in your inventory.
 #
-# @author RubySometimes (GitHub)
+# @author Marcello A. Sabino
 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
+  attr_reader :id, :name, :price, :store_price,
+              :low_price, :high_alch, :image
 
   # Creates a new Item object
-  # @param id - the id of the Item
+  # @param [Integer] 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
@@ -31,9 +25,9 @@ class Item
   end
 
   # Class method to get the item's id by name
-  # @param item_name - the name of the item to search for
+  # @param [String] item_name - the name of the item to search for
   #        the item_name gets capitalized for search.
-  # @return the item's id
+  # @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
@@ -46,29 +40,29 @@ class Item
   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.
+  # @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 other_item - the other item to compare to
-  # @return true if this item is worth less than the other_item.
+  # @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 other - the other item, which price we will subtract from
-  # @return self.price - other.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
 
   # 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
+  # @param [Item] other - the other item, which price we will subtract from
+  # @return [Integer] self.price - other.price
   def +(other)
     price + other.price
   end
@@ -84,7 +78,7 @@ class Item
   end
 
   # Gets the store price of the Item
-  # @return 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))
@@ -92,7 +86,7 @@ class Item
   end
 
   # Gets the average price of the Item on the GE
-  # @return the average price 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))
@@ -109,7 +103,7 @@ class Item
 
   # 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.
+  # @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'
@@ -118,7 +112,7 @@ class Item
   end
 
   # Takes a price as a string, and removes any commas.
-  # @param price - the price from the JSON in string form.
+  # @param [Float] price - the price from the JSON in string form.
   def clean_price(price)
     price.sub(/,/, '').to_f
   end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: alch
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Marcello A. Sabino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies: []
-description: A simple way to determine alch prices on Oldschool Runescape.
+description: A simple way to determine alch prices on Oldschool Runescape
 email: march@marchy.me
 executables: []
 extensions: []