shopicruit 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a374e24e5bccf2488a2dc17e1bc18f018a5a201a
-  data.tar.gz: d502615502854a647b828a17881ed78656f62d5a
+  metadata.gz: 4983ee73be467a49610ab092a3a026a38b146bbe
+  data.tar.gz: 187f001d1f6c45130300e2d6476cb50d20c172b0
 SHA512:
-  metadata.gz: ad168c0afed0358ff34873a0944ac1b02c6de808e22d33193dff01ac4dffb21655ce4a62200defdf849cbc367da7829ab2204d68ad19523b6bf61bbffdbe9362
-  data.tar.gz: a48411a4461f61dbc4c1dc29d6d8982d45776be025e1901e4a551f1b59219db96ac925438b557e72e1adca94564064cde2efc13be042c3ade1392bb1526ddfce
+  metadata.gz: 71b0f19172d2c39442b005627008f875bfbeae60544bcc691931e51fa12377732a6ea87f419d4a69bd63714f573bf7911cff6be08044ef731a2c255acf06c918
+  data.tar.gz: adbcf173f0beaf6d6115bf8525904b39c3373ae229e38f9bfb86b686cb132d2631330b086db4400ef5d4ca38b885fd96e3c1d61fe39bf24bbbc52001b737833f

data/README.md

@@ -1,6 +1,6 @@
 # Shopicruit
 
-This is a RubyGem that will calculate the maximum amount of computers and keyboards that you would be able to purchase at Shopicruit store.
+This is a RubyGem that will calculate the maximum amount of products that you would be able to purchase at Shopicruit store.
 
 ## Installation
 
@@ -20,28 +20,35 @@ Or install it yourself as:
 
 ## Usage
 
-maxAmount method calculates the maximum amount of items that could be purchased within the weight limit.
-    
-    # Total cost
-    Shopicruit.maxAmount(100, 'cost')
+* maxAmount method calculates the maximum amount of items that could be purchased within the weight limit.\s\s
+  It takes three arguments:
+  + First argument takes in the maximum weight in kg.
+  + Second argument takes in the desired return type. ('cost', 'weight', or 'products')
+  + Third arguments takes in a list of types of products. ('Keyboard', 'Computer', 'Clock', 'Car', 'Bottle', 'Wallet', 'Knife', 'Lamp', 'Table', 'Chair', 'Hat', 'Shoes', 'Plate', 'Gloves', 'Bag', 'Coat', 'Pants')
+
+```ruby
+# Total cost
+Shopicruit.maxAmount(100, 'cost', ['Computer' ,'Keyboard'])
     
-    # Total weight 
-    Shopicruit.maxAmount(100, 'weight')
+# Total weight 
+Shopicruit.maxAmount(100, 'weight', ['Computer' ,'Keyboard'])
     
-    # A list of purchased items
-    Shopicruit.maxAmount(100, 'products')
-
+# A list of purchased items
+Shopicruit.maxAmount(100, 'products', ['Computer' ,'Keyboard'])
+```
 
-leaseCost method will take into account the cost.
+* leaseCost method will take into account the cost.
 	
-	# Total cost
-    Shopicruit.leaseCost(100, 'cost')
+```ruby
+# Total cost
+Shopicruit.leaseCost(100, 'cost', ['Computer' ,'Keyboard'])
     
-    # Total weight 
-    Shopicruit.leaseCost(100, 'weight')
+# Total weight 
+Shopicruit.leaseCost(100, 'weight', ['Computer' ,'Keyboard'])
     
-    # A list of purchased items
-    Shopicruit.leaseCost(100, 'products')
+# A list of purchased items
+Shopicruit.leaseCost(100, 'products', ['Computer' ,'Keyboard'])
+```
 
 Happy shopping.
 

data/lib/shopicruit/version.rb

@@ -1,3 +1,3 @@
 class Shopicruit
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/shopicruit.rb

@@ -3,21 +3,21 @@ require 'json'
 require 'net/http'
 
 class Shopicruit
-	def self.maxAmount(maxWeight, type)
-		products 	= get_product_list.sort_by{ |key, value| value["weight"] }.to_h
+	def self.maxAmount(maxWeight, return_type, item_list)
+		products 	= get_product_list(item_list).sort_by{ |key, value| value["weight"] }.to_h
 		result		= calculate(products, maxWeight)
-		return result[type]
+		return result[return_type]
 	end
 
 
-	def self.leastCost(maxWeight, type)
-		products 	= get_product_list.sort_by{ |key, value| value["price"] / value["weight"] }.to_h
+	def self.leastCost(maxWeight, return_type, item_list)
+		products 	= get_product_list(item_list).sort_by{ |key, value| value["price"] / value["weight"] }.to_h
 		result 		= calculate(products, maxWeight)
-		return result[type]
+		return result[return_type]
 	end
 
 
-	def self.get_product_list
+	def self.get_product_list(item_list)
 		uri = URI("http://shopicruit.myshopify.com/products.json")
 
 		res = Net::HTTP.get(uri)
@@ -25,7 +25,7 @@ class Shopicruit
 
 		desiredProductList = {}
 		product_list["products"].each do |item|
-			if (item["product_type"] == "Computer" or item["product_type"] == 'Keyboard')
+			if (item_list.include? item["product_type"])
 				item["variants"].each do |var|
 					title = item["title"] + " (" + var["title"] + ")"
 					desiredProductList[title] = { "weight" => var["grams"], "price" => var["price"].to_f }

data/spec/shopicruit_spec.rb

@@ -7,17 +7,17 @@ describe Shopicruit do
 		let(:input) { 100 }
 
 		it 'tests that the cost of leastCost method is smaller than that of maxAmount' do
-			expect( Shopicruit.maxAmount(input, 'cost')[1..-1].to_i ).to be >= ( Shopicruit.maxAmount(input, 'cost')[1..-1].to_i )
+			expect( Shopicruit.maxAmount(input, 'cost', ['Computer', 'Keyboard'])[1..-1].to_i ).to be >= ( Shopicruit.leastCost(input, 'cost', ['Computer', 'Keyboard'])[1..-1].to_i )
 		end
 
 		it 'tests that purchased weight does not exceed limit' do
-			expect( Shopicruit.maxAmount(input, 'weight')[0..-3].to_i ).to be <= input
-			expect( Shopicruit.leastCost(input, 'weight')[0..-3].to_i ).to be <= input
+			expect( Shopicruit.maxAmount(input, 'weight', ['Computer', 'Keyboard'])[0..-3].to_i ).to be <= input
+			expect( Shopicruit.leastCost(input, 'weight', ['Computer', 'Keyboard'])[0..-3].to_i ).to be <= input
 		end
 
 		it 'tests that the purchased products are valid' do
-			expect( Shopicruit.maxAmount(input, 'products').length ).to be > 0
-			expect( Shopicruit.leastCost(input, 'products').length ).to be > 0
+			expect( Shopicruit.maxAmount(input, 'products', ['Computer', 'Keyboard']).length ).to be > 0
+			expect( Shopicruit.leastCost(input, 'products', ['Computer', 'Keyboard']).length ).to be > 0
 		end
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopicruit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Lisa Weng