namaz 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b39bf28d699c1998b865cd87b3e6d3c4ea67ba2
-  data.tar.gz: f3a4f0a38adfbf56479dbd898bd0b5d5cbe6ceba
+  metadata.gz: 00a014d75a7276b009668a2f0ae8a348f3d45307
+  data.tar.gz: 6abb47879abeb515c7c0e50c9d374ce3af1bab39
 SHA512:
-  metadata.gz: fdb13b1901f4cd8c936d5be1b9db383e1b3a6695ec3d568bfd03f10c4f6bfc9b271450be33417a1a89a0aa15443e8579c46b96a981540b1105f0ec33ceb0cdc6
-  data.tar.gz: b1283a5803549a5ab9003326134f6d9035b6bedc6eceb859ce1b56a5d01184319c0fd8341a74a43fc70df9186fa19fda9cffc7a5530d55fa28c47e0834fdfbed
+  metadata.gz: aeef25610a99af0a7ed6c75faaa7411c04be4d0d88fba6eaafd124131db849772936dbc5c0b9b86536b4da88e0a68901e60dce70460b24ad020df6ba662612f7
+  data.tar.gz: dfd9a5130f48702e5b77925a00ceb52172cc949053e5e3c6ef8f704fad6c95b5be339a1e57b07ea1e8fd0d835f51ea005af605bb45e483b20ce5978268a8bfbf

data/README.md

@@ -30,9 +30,9 @@ Make sure you require the library, where you want to use it, Or require in `appl
 ```ruby
 require 'namaz'
 ```
-## Timings
 
-You can then make requests to the following method.
+## Timings
+Returns all prayer times for a specific date and for a specific date in a city. You can then make requests to the following method.
 ```ruby
 ## Using Altitudes:
 Namaz.timings(latitude:, longitude:, timezonestring:, method:, options: {})
@@ -64,7 +64,7 @@ timings.Fajr
 ```
 
 ## Calender
-
+Returns prayer times for a specific month (in a given year) and for a specific month in a city
 ```ruby
 ## Using City and Country Information:
 Namaz.calender_by_city(city:, country:, method:, options: {})
@@ -100,7 +100,7 @@ calendar.first.date
 ##### Example Request Using Country and City Information
 
 ```ruby
-calendar = Namaz.calender_by_city(city: 'Lahore', country: 'PK', method: 2, options: {month: '03', year: '2017'})
+calendar = Namaz.calender_by_city(city: 'Lahore', country: 'PK', method: 2, options: {month: '02', year: '2017'})
 
 calendar.first
 #<Hashie::Mash date=#<Hashie::Mash readable="01 Feb 2017" timestamp="1485921661"> timings=#<Hashie::Mash Asr="15:54 (PKT)" Dhuhr="12:46 (PKT)" Fajr="05:56 (PKT)" Imsak="05:46 (PKT)" Isha="19:35 (PKT)" Maghrib="18:17 (PKT)" Midnight="00:46 (PKT)" Sunrise="07:14 (PKT)" Sunset="18:17 (PKT)">>
@@ -115,6 +115,37 @@ calendar.first.date
 #<Hashie::Mash readable="01 Feb 2017" timestamp="1485921661">
 ```
 
+## City Information
+Returns City Geolocation Info of latitude, longitude and timezone for a given city
+### Example:
+```ruby
+city_info = Namaz.city_info(city: 'Lahore', country: 'PK', options: {state: 'Punjab'})
+#<Hashie::Mash latitude="31.5546061" longitude="74.3571581" timezone="Asia/Karachi">
+city_info.longitude
+# => "74.3571581"
+city_info.timezone
+# => "Asia/Karachi"
+```
+
+## Address Information
+Returns Address Geolocation Info of latitude, longitude and timezone for a given city
+
+### Additional Parameter
+
+**address** - A complete address string. Example: 10 Upper Bank Street, London, Canary Wharf, London, UK
+
+### Examples:
+```ruby
+address_info = address_info(address: '10 Upper Bank Street, London, Canary Wharf, London, UK')
+#<Hashie::Mash latitude="51.5026562" longitude="-0.0171995" timezone="Europe/London">
+                                -- OR --
+address_info = address_info(address: 'Upper Bank Street, London, Canary Wharf, London, UK')
+#<Hashie::Mash latitude=51.5045201 longitude=-0.0171009 timezone="Europe/London">
+                                -- OR --
+address_info = address_info(address: 'Bank Street, London, Canary Wharf, London, UK')
+#<Hashie::Mash latitude=51.5035329 longitude=-0.0213304 timezone="Europe/London">
+```
+
 ## General Parameters Description
 * **timestamp OPTIONAL** - `DEFAULT = Time.now.to_i` a UNIX timestamp (from any time of the day) of the day for which you want the timings. If you don't specify a timestamp, the result will come back for today - today being the date in the Europe/London timezone.
 
@@ -163,17 +194,15 @@ end
 
 ## CHANGE LOG:
 
-* **0.1.0:** Request Using Altitudes
-* **0.1.1:** Added new request Using Country and City Information
+* **0.1.4:** Added methods `city_info` and `address_info`
+* **0.1.3:** Added methods `calendar` and `calendar_by_city`
 * **0.1.2:** Updated method name for Timings information for city from `timings` to `timings_by_city`
+* **0.1.1:** Added new request Using Country and City Information
+* **0.1.0:** Request Using Altitudes
 
 ## TODO:
 Follow the link https://aladhan.com/prayer-times-api and add patch by creating a Pull Rquest, I will merge and publish new version
 
-* Current Time Stamp
-* Current Time
-* City Geolocation Info
-* Address Geolocation Info
 * Timings by Address
 * Calendar by Address
 

data/lib/namaz.rb

@@ -8,6 +8,35 @@ module Namaz
   DEFAULT_API_URL = 'http://api.aladhan.com'
 
   class << self
+    # Retrieve the latitude, longitude and timezone for a given city
+    # @param [String] city
+    # @param [String] country
+    # @param [Hash] options state is OPTIONAL
+    # @return [Hashie::Mash] having latitude longitude and timezone
+    def city_info(city:, country:, options: {})
+      url = [DEFAULT_API_URL, 'cityInfo'].join('/')
+
+      params = {
+        city: city,
+        country: country,
+        state: options[:state]
+      }
+
+      response = connection.get(url, params)
+      return Hashie::Mash.new(MultiJson.load(response.body)).data if response.success?
+    end
+
+    # Retrieve the latitude, longitude and timezone for given address
+    # @param [address] A complete address string
+    # @return [Hashie::Mash] having latitude longitude and timezone
+    def address_info(address:)
+      url = [DEFAULT_API_URL, 'addressInfo'].join('/')
+
+      params = { address: address }
+      response = connection.get(url, params)
+      return Hashie::Mash.new(MultiJson.load(response.body)).data if response.success?
+    end
+
     # Retrieve the namaz timings for a given latitude, longitude, timezonestring and method.
     #
     # @param [Float] latitude.
@@ -97,7 +126,6 @@ module Namaz
       namaz_calender_response(namaz_url, params)
     end
 
-
     # Build or get an HTTP connection object.
     def connection
       @connection ||= Faraday.new

data/lib/namaz/version.rb

@@ -1,3 +1,3 @@
 module Namaz
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namaz
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sohair Ahmad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-28 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday