namaz 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd82a6f994dc25e50a61a02c2ca8ff19122fc7a5
-  data.tar.gz: d6ad635eb5da639a308f02f4ef3054bd8fde1081
+  metadata.gz: 871d931898844bbe7491afe62ab6c0bde3312f0b
+  data.tar.gz: cb6f79d1f7dd858e93b70da77c5e2a31ab766aef
 SHA512:
-  metadata.gz: 7fad7a149e77080f674128aeef8418901cd5f5d2f67e5a743b15301d77d2ec77dcc27bcf656df5f34968778bb69e126cebbc8f2ad48bbcb12051ccd30ea595b7
-  data.tar.gz: 2245dba4a8c9215590bd2453a2a5481860146a5d2dd0b710ea7164717cdc4f2aa4a91091c4c159cd46faf559ddacd4ad4a38648a626b04c6429350d2ec72dd2f
+  metadata.gz: 4269271a282a9783631b840125f21f09e1b54abf89bb73b357fa3c91f5de0e7ffba626ae0356874ac7c3b9f1a399c48e540ec92ff8b58249235391a3aeac2a82
+  data.tar.gz: 8e2949eaca4652acc770baa2b37dba51b0312f1de39e40d2020524080c0b48f525f6ba32d130ceee0f4ba0b774daa2ce7780d9c1767a47da8ea146ad0b23757b

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
     $ gem install namaz
 
-## Usage
+# Usage
 Make sure you require the library, where you want to use it, Or require in `application.rb` to use all over the application.
 
 ```ruby
@@ -33,19 +33,51 @@ require 'namaz'
 
 You can then make requests to the following method.
 ```ruby
+## Using Altitudes:
 Namaz.timings(latitude:, longitude:, timezonestring:, method:, options: {})
+## Using City and Country Information:
+Namaz.timings(city:, country:, method:, options: {})
 ```
 
-Example
+### Examples:
 ```ruby
+# Using Altitudes:
 Namaz.timings(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karachi", method: 1, options: {timestamp: Time.now.to_i})
+# Using City and Country Information:
+Namaz.timings(city: 'Karachi', country: 'PK', method: 1, options: {timestamp: Time.now.to_i})
 ```
 
-### Parameters
+##### Example Request Using Altitudes
+
+```ruby
+timings = Namaz.timings(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karachi", method: 1, options: {timestamp: Time.now.to_i})
+```
+##### Example Request Using Country and City Information
+
+```ruby
+timings = Namaz.timings(city: 'Karachi', country: 'PK', method: 1, options: {state: 'Punjab', timestamp: Time.now.to_i})
+```
+##### Example Response
+
+```ruby
+ => #<Hashie::Mash Asr="15:27" Dhuhr="12:16" Fajr="05:19" Imsak="05:09" Isha="19:14" Maghrib="17:53" Midnight="00:17" Sunrise="06:41" Sunset="17:53">
+
+timings.Fajr
+ => "05:19"
+```
+
+### 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.
+
 * **latitude** - the decimal value for the latitude co-ordinate of the location you want the time computed for. Example: 51.75865125
 * **longitude** - the decimal value for the longitude co-ordinate of the location you want the time computed for. Example: -1.25387785
 * **timezonestring** - A valid timezone name as specified on http://php.net/manual/en/timezones.php. Example: Europe/London
+
+
+* **city** - A city name. Example: London
+* **country** - A country name or 2 character alpha ISO 3166 code. Example: GB or United Kindom
+* **state** - State or province (optional). A state name or abbreviation. Example: Colorado / CO / Punjab / Bengal
+
 * **method** - these are the different methods identifying various schools of thought about how to compute the timings. This parameter accepts values from 0-7, as signified below:
     * 0 - Shia Ithna-Ashari
     * 1 - University of Islamic Sciences, Karachi
@@ -55,18 +87,6 @@ Namaz.timings(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karac
     * 5 - Egyptian General Authority of Survey
     * 7 - Institute of Geophysics, University of Tehran
 
-### Example Request
-
-```ruby
-timings = Namaz.timings(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karachi", method: 1, options: {timestamp: Time.now.to_i})
-```
-### Example Response
-```ruby
- => #<Hashie::Mash Asr="15:27" Dhuhr="12:16" Fajr="05:19" Imsak="05:09" Isha="19:14" Maghrib="17:53" Midnight="00:17" Sunrise="06:41" Sunset="17:53">
-
-timings.Fajr
- => "05:19"
-```
 ## Optional HTTP Configuration
 The HTTP requests are made with [Faraday](https://github.com/lostisland/faraday), which uses `Net::HTTP` by default. Changing the adapter is easy. We will use typhoeus as an example.
 

data/lib/namaz.rb

@@ -26,8 +26,28 @@ module Namaz
         method: method
       }
 
-      namaz_response = connection.get(namaz_url, params)
-      return Hashie::Mash.new(MultiJson.load(namaz_response.body)).data.timings if namaz_response.success?
+      namaz_response(namaz_url, params)
+    end
+
+    # Retrieve the namaz timings for a given city, country, method.
+    #
+    # @param latitude [Float] Latitude.
+    # @param longitude [Float] Longitude.
+    # @param timezonestring [String]
+    # @param method [Integer]
+    # @param options [Hash], Have optional values like timestamp, that is default to Current timestamp
+    def timings(city:, country:, method:, options: {})
+      timestamp = options[:timestamp] ? options[:timestamp] : Time.now.to_i
+      namaz_url = [DEFAULT_API_URL, 'timingsByCity', timestamp].join('/')
+
+      params = {
+        city: city,
+        country: country,
+        state: options[:state],
+        method: method
+      }
+
+      namaz_response(namaz_url, params)
     end
 
     # Build or get an HTTP connection object.
@@ -47,5 +67,10 @@ module Namaz
     def get(path, params = {})
       connection.get(path, params)
     end
+
+    def namaz_response(namaz_url, params)
+      namaz_response = connection.get(namaz_url, params)
+      return Hashie::Mash.new(MultiJson.load(namaz_response.body)).data.timings if namaz_response.success?
+    end
   end
 end

data/lib/namaz/version.rb

@@ -1,3 +1,3 @@
 module Namaz
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: namaz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sohair Ahmad