air-pollution-gem 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d94869a1ac8267d23b102c972bd7d2e2984364855be0f7d0606799a7125124
-  data.tar.gz: dfc7071e4981cded9fd10b4d12b899a27c376c0f61194b5e50ceab7612adecd3
+  metadata.gz: 67fd26a7cd72f197d5350b116a418b7bc18a9cd0a707e36108dc7c816c336f7a
+  data.tar.gz: aad7425bba719a0dde1bb514988b380f6eea9f2d5f5b4c2e0133081a65884bd3
 SHA512:
-  metadata.gz: 52db1bfc7c864ab8cf55782e6eca6e61620de88d928d784ecd060f59c5360df340ae0bc074cde831ec47ae5bb307bebfc4562022576c1e37dae7c824c0b0a965
-  data.tar.gz: d50cb6c4c7ff67f943ca641bfadbc37de233eab6c556e8c08f54c29a3eabb2cfebd05b3b619d15e165bcf6a98e676946471be7b323f56d418ba1716a061e3cbc
+  metadata.gz: c37c75d588c56b0ba05bebbd69adae6fb220e1be496b20c118fc387482ec1fc7abecb1cf0a7f6cff2a05f7915c3ec920228f5a6689c31bf5dd848ce865b0552a
+  data.tar.gz: 7d1fb6970935504b526c6dd1f5947b1d3a34fef7bbed312383f34ef254cfa389f430b2dcdb62f3d1e492fb30a343ddee7657867a3b647a4b01245060840ea21d

data/lib/pollution.rb

@@ -5,10 +5,17 @@ class Pollution
 	
 	@token
 
+	##
+	# => Initialize the Pollution class and set the token variable.
+	##
 	def initialize(token)
 		@token = token
 	end
 
+	##
+	# => Returns the air pollution data of the given city or throws an error if the city wasn't found.
+	##
+
 	def city(cityname)
 		data = JSON.parse(Net::HTTP.get('api.waqi.info', "/feed/#{cityname}/?token=#{@token}"))
 		if data['status'] == 'error'
@@ -18,6 +25,10 @@ class Pollution
 		end
 	end
 
+	##
+	# => Returns the air pollution data of the current location (IP Based).
+	##
+
 	def here
 		data = JSON.parse(Net::HTTP.get('api.waqi.info', "/feed/here/?token=#{@token}"))
 		if data['status'] == 'error'
@@ -27,14 +38,9 @@ class Pollution
 		end
 	end
 
-	def geo(latitude, longitude)
-		data = JSON.parse(Net::HTTP.get('api.waqi.info', "/feed/geo:#{latitude};#{longitude}/?token=#{@token}"))
-		if data['status'] == 'error'
-			raise data['data']
-		else
-			return data
-		end
-	end
+	##
+	# => Returns the air pollution data of the given coordinates.
+	##
 
 	def geo(latitude, longitude)
 		data = JSON.parse(Net::HTTP.get('api.waqi.info', "/feed/geo:#{latitude};#{longitude}/?token=#{@token}"))
@@ -45,6 +51,10 @@ class Pollution
 		end
 	end
 
+	##
+	# => Returns the air pollution data of the area between the given coordinates. This method takes 4 arguments: Latitude 1, Longitude 1, Latitude 2, Longitude 2.
+	##
+
 	def map(latitude_min, longitude_min, latitude_max, longitude_max)
 		latlng = latitude_min.to_s + longitude_min.to_s + latitude_max.to_s + longitude_max.to_s
 		data = JSON.parse(Net::HTTP.get('api.waqi.info', "/map/bounds/?token=#{@token}&latlng=#{latlng}"))
@@ -55,6 +65,10 @@ class Pollution
 		end
 	end
 
+	##
+	# => Returns data about stations near the searched keyword.
+	##
+
 	def search(keyword)
 		data = JSON.parse(Net::HTTP.get('api.waqi.info', "/search/?keyword=#{keyword}&token=#{@token}"))
 		if data['status'] == 'error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: air-pollution-gem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cosimo Libutti
@@ -23,8 +23,8 @@ homepage: https://rubygems.org/gems/example
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/example/example
-  api_docs: https://aqicn.org/json-api/doc/
+  source_code_uri: https://github.com/3llish/air-pollution-gem
+  api_docs: https://github.com/3llish/air-pollution-gem
 post_install_message: 
 rdoc_options: []
 require_paths: