streetfoodr 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 613a4aeff572ff4e20f6435a02400bff712a2d3b
-  data.tar.gz: 98b0b6cc7d2cc5d62016d987695ff73f535792b4
+  metadata.gz: 74d59e8f2399884ef340f2ba841f3cc7d1afeeda
+  data.tar.gz: c9ef5ed17a334a7a61e7b4239e69e179556ac947
 SHA512:
-  metadata.gz: 44389dc8e7be2aabaed21ee65d3610ef93abb7a7749f3aaf423482b54dcd42b06fac1b39bb18487a8ae0d0c73833cc826ef40bf37a29c125ec06220b05e0c102
-  data.tar.gz: b13918d4651f444763d7ce307e657959d4aa8a030d44f19675ba3166420b242aec0fc776367e329bd4ae00689f35f41ae9c8935855bb450bc958fcffb98dc2da
+  metadata.gz: f7f37f8ac058816e047e257089709ff5300edc7611a94fe15991cad906e29346742a94976f22d525f912ff5ebaff73189c103606ba1d30a9245be61444352f5c
+  data.tar.gz: bbce8e46f380d8472c45ca9d54c82ecc010bc045d7b248207794963b5e4ea0922d0b76605877b6db7800cc3d9779b2fe33d8d3eaab535946565535c1953a3885

data/lib/streetfoodr.rb

@@ -1,62 +1,82 @@
 require 'rest-client'
 
-class FoodTruck
-  API_ROOT_URL = 'http://data.streetfoodapp.com/1.1/'
+##
+#This class represents food trucks
 
-  def self.get_city_trucks(city)
-    response = RestClient.get(API_ROOT_URL + "schedule/" + city)
-    JSON.parse(response)
-  end
+module Streetfoodr
+  class FoodTruck
+    API_ROOT_URL = 'http://data.streetfoodapp.com/1.1/'
+
+    ##
+    #Gets all the food trucks and their schedules for a given city
+    def self.get_city_trucks(city)
+      response = RestClient.get(API_ROOT_URL + "schedule/" + city)
+      JSON.parse(response)
+    end
 
-  def self.get_city_trucks_identifiers(city)
-    raw_data = self.get_city_trucks(city)
+    ##
+    #Gets the api identifier information for all the food trucks in a
+    #given city. The identifiers are necessary for getting information
+    #about a specific food truck only.
+    def self.get_city_trucks_identifiers(city)
+      raw_data = self.get_city_trucks(city)
 
-    identifier_name_pairs = Array.new
+      identifier_name_pairs = Array.new
 
-    raw_data['vendors'].map do |truck|
-      truck_info = Hash[identifier: truck[0], name: truck[1]["name"]]
+      raw_data['vendors'].map do |truck|
+        truck_info = Hash[identifier: truck[0], name: truck[1]["name"]]
 
-      identifier_name_pairs << truck_info
+        identifier_name_pairs << truck_info
+      end
+
+      return identifier_name_pairs
     end
 
-    return identifier_name_pairs
-  end
+    ##
+    #Finds the api identifier of a truck by name and city.
+    def self.get_api_identifier_by_name(name, city)
 
-  def self.get_api_identifier_by_name(name, city)
+      truck_info = self.get_city_trucks_identifiers(city)
+      .find { |truck_info| truck_info[:name] == name}
 
-    truck_info = self.get_city_trucks_identifiers(city)
-    .find { |truck_info| truck_info[:name] == name}
+      if truck_info == nil
+        raise ArgumentError,  "A truck with that name in that city could not be found." +
+        " Keep in mind that the name must be exact."
+      end
 
-    if truck_info == nil
-      raise ArgumentError,  "A truck with that name in that city could not be found." +
-      " Keep in mind that the name must be exact."
+      return truck_info
     end
 
-    return truck_info
-  end
-
-  def initialize(foodtruck_identifier, city)
-    @identifier = foodtruck_identifier
-    @city = city
-  end
+    ##
+    #Initializes a new instance of a specific food truck
+    def initialize(foodtruck_identifier, city)
+      @identifier = foodtruck_identifier
+      @city = city
+    end
 
-  def locations
-    response = RestClient.get(API_ROOT_URL + "locations/" + @identifier)
-    begin
-      JSON.parse(response)
-    rescue JSON::ParserError => ex
-      raise ArgumentError, "This food truck identifier does not exist"
+    ##
+    #Gets the locations and schedule of a given food truck
+    def locations
+      response = RestClient.get(API_ROOT_URL + "locations/" + @identifier)
+      begin
+        JSON.parse(response)
+      rescue JSON::ParserError => ex
+        raise ArgumentError, "This food truck identifier does not exist"
+      end
     end
-  end
 
-  def history(year, month)
-    response = RestClient.get(API_ROOT_URL + "history/" + @city + "/" +
-    year + "/" + month + "/" + @identifier)
-    begin
-      JSON.parse(response)
-    rescue JSON::ParserError => ex
-      raise ArgumentError, "Either this food truck identifier does not exist," +
-      " or there is no history for it available during the period you have chosen."
+    ##
+    #Gets the locations and schedule of a given food truck
+    #during a specific month and year
+    def history(year, month)
+      response = RestClient.get(API_ROOT_URL + "history/" + @city + "/" +
+      year + "/" + month + "/" + @identifier)
+      begin
+        JSON.parse(response)
+      rescue JSON::ParserError => ex
+        raise ArgumentError, "Either this food truck identifier does not exist," +
+        " or there is no history for it available during the period you have chosen."
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streetfoodr
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Alla Hoffman