namaz 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307e0c3bb43668c6b4b94ae8da31bf5f50ab1f1c
-  data.tar.gz: aef40096f162d0cd1a7ec0d4fc841c601f1bfd85
+  metadata.gz: 7b39bf28d699c1998b865cd87b3e6d3c4ea67ba2
+  data.tar.gz: f3a4f0a38adfbf56479dbd898bd0b5d5cbe6ceba
 SHA512:
-  metadata.gz: 7b2c2f99665a1033fe02b061b0e5abe76f0755272bee92550a0af0a20e4417a9fa9917510e38308bdca1921f8c17a9d5eaf10484bfa80791344a76aecb8ce521
-  data.tar.gz: fb8cc3ef5b26c008ef6c4201c6d976203b57b8089438f4064faaf101159c0ac667efca1470717bc46fcf1fb2c04fe3ffca4076a8402f586a73dc9ef218df034a
+  metadata.gz: fdb13b1901f4cd8c936d5be1b9db383e1b3a6695ec3d568bfd03f10c4f6bfc9b271450be33417a1a89a0aa15443e8579c46b96a981540b1105f0ec33ceb0cdc6
+  data.tar.gz: b1283a5803549a5ab9003326134f6d9035b6bedc6eceb859ce1b56a5d01184319c0fd8341a74a43fc70df9186fa19fda9cffc7a5530d55fa28c47e0834fdfbed

data/README.md

@@ -1,6 +1,6 @@
 # Namaz
-[namaz](https://aladhan.com/prayer-times-api) API wrapper in Ruby.
-Namaz is aladhan.com wrapper in ruby to use REST API that is open for public use. The API only supports the GET method and returns JSON.
+[namaz](https://aladhan.com/prayer-times-api) ruby gem is an API wrapper.
+Namaz is aladhan.com wrapper in ruby to use REST API that is open for public use.
 
 ## Installation
 
@@ -30,6 +30,7 @@ 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.
 ```ruby
@@ -40,33 +41,81 @@ Namaz.timings_by_city(city:, country:, method:, options: {})
 ```
 
 ### 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_by_city(city: 'Karachi', country: 'PK', method: 1, options: {timestamp: Time.now.to_i})
-```
 
-##### Example Request Using Altitudes
+##### Example Request and response Using Altitudes
 
 ```ruby
 timings = Namaz.timings(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karachi", method: 1, options: {timestamp: Time.now.to_i})
+
+#=> #<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"
 ```
 ##### Example Request Using Country and City Information
 
 ```ruby
 timings = Namaz.timings_by_city(city: 'Karachi', country: 'PK', method: 1, options: {state: 'Punjab', timestamp: Time.now.to_i})
+
+#<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"
 ```
-##### Example Response
+
+## Calender
 
 ```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">
+## Using City and Country Information:
+Namaz.calender_by_city(city:, country:, method:, options: {})
+## Using City and Country Information:
+Namaz.calendar(latitude:, longitude:, timezonestring:, method:, options: {})
+```
 
-timings.Fajr
- => "05:19"
+#### Optional Params
+`(options: {month: '8', year: '2017', state: 'Punjab' })`
+- **month** - 1 or 2 digit month. Example: '08' or '8' for August, **DEFAULT is current month**, if not given
+- **year** - 4 digit year. Example: 2017, **DEFAULT is current year**, if not given
+
+
+### Examples:
+
+##### Example Request and response Using Altitudes
+```ruby
+calendar = Namaz.calendar(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karachi", method: 1, options: {month: '02', year: '2017'})
+
+calendar.first
+#<Hashie::Mash date=#<Hashie::Mash readable="01 Feb 2017" timestamp="1485921661"> timings=#<Hashie::Mash Asr="15:15 (PKT)" Dhuhr="12:16 (PKT)" Fajr="05:32 (PKT)" Imsak="05:22 (PKT)" Isha="19:00 (PKT)" Maghrib="17:37 (PKT)" Midnight="00:16 (PKT)" Sunrise="06:55 (PKT)" Sunset="17:37 (PKT)">>
+
+calendar.first.timings
+#=> #<Hashie::Mash Asr="15:15 (PKT)" Dhuhr="12:16 (PKT)" Fajr="05:32 (PKT)" Imsak="05:22 (PKT)" Isha="19:00 (PKT)" Maghrib="17:37 (PKT)" Midnight="00:16 (PKT)" Sunrise="06:55 (PKT)" Sunset="17:37 (PKT)">
+
+calendar.first.timings.Asr
+#=> "15:15 (PKT)"
+
+calendar.first.date
+#<Hashie::Mash readable="01 Feb 2017" timestamp="1485921661">
+```
+
+##### 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.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)">>
+
+calendar.first.timings
+#=> #<Hashie::Mash Asr="15:31 (PKT)" Dhuhr="12:15 (PKT)" Fajr="05:23 (PKT)" Imsak="05:13 (PKT)" Isha="19:07 (PKT)" Maghrib="18:01 (PKT)" Midnight="00:15 (PKT)" Sunrise="06:30 (PKT)" Sunset="18:01 (PKT)">
+
+calendar.first.timings.Asr
+#=> "15:31 (PKT)"
+
+calendar.first.date
+#<Hashie::Mash readable="01 Feb 2017" timestamp="1485921661">
 ```
 
-### Parameters Description
+## 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.
 
 * **latitude** - the decimal value for the latitude co-ordinate of the location you want the time computed for. Example: 51.75865125
@@ -118,15 +167,13 @@ end
 * **0.1.1:** Added new request Using Country and City Information
 * **0.1.2:** Updated method name for Timings information for city from `timings` to `timings_by_city`
 
-**TODO:**
+## 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
 
-* Calendar
 * Current Time Stamp
 * Current Time
 * City Geolocation Info
 * Address Geolocation Info
-* Calendar by City
 * Timings by Address
 * Calendar by Address
 

data/lib/namaz.rb

@@ -26,7 +26,7 @@ module Namaz
         method: method
       }
 
-      namaz_response(namaz_url, params)
+      namaz_time_response(namaz_url, params)
     end
 
     # Retrieve the namaz timings for a given city, country, method.
@@ -47,9 +47,57 @@ module Namaz
         method: method
       }
 
-      namaz_response(namaz_url, params)
+      namaz_time_response(namaz_url, params)
     end
 
+    # Retrieve the namaz timings for a given latitude, longitude, timezonestring and method.
+    #
+    # @param [Float] latitude.
+    # @param [Float] longitude.
+    # @param [String] timezonestring
+    # @param [Integer] method
+    # @param [Hash] options, year, month, and state are OPTIONAL
+    # year is default to current year, and month is default to current month if not sent in OPTIONAL params
+    def calendar(latitude:, longitude:, timezonestring:, method:, options: {})
+      namaz_url = [DEFAULT_API_URL, 'calendar'].join('/')
+
+      params = {
+        latitude: latitude,
+        longitude: longitude,
+        timezonestring: timezonestring,
+        month: options[:month],
+        year: options[:year],
+        method: method
+      }
+
+      namaz_calender_response(namaz_url, params)
+    end
+
+
+    # Retrieve the calender for a given city, country, method.
+    # By default Retrieve current year, month
+    #
+    # @param [String] city
+    # @param [String] country
+    # @param [Integer] method
+    # @param [Hash] options, year, month, and state are OPTIONAL
+    # year is default to current year, and month is default to current month if not sent in OPTIONAL params
+    def calendar_by_city(city:, country:, method:, options: {})
+      namaz_url = [DEFAULT_API_URL, 'calendarByCity'].join('/')
+
+      params = {
+        city: city,
+        country: country,
+        month: options[:month],
+        year: options[:year],
+        state: options[:state],
+        method: method
+      }
+
+      namaz_calender_response(namaz_url, params)
+    end
+
+
     # Build or get an HTTP connection object.
     def connection
       @connection ||= Faraday.new
@@ -68,9 +116,15 @@ module Namaz
       connection.get(path, params)
     end
 
-    def namaz_response(namaz_url, params)
+    def namaz_time_response(namaz_url, params)
       response = connection.get(namaz_url, params)
       return Hashie::Mash.new(MultiJson.load(response.body)).data.timings if response.success?
     end
+
+    def namaz_calender_response(namaz_url, params)
+      response = connection.get(namaz_url, params)
+      return Hashie::Mash.new(MultiJson.load(response.body)).data if response.success?
+    end
+
   end
 end

data/lib/namaz/version.rb

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

data/namaz.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sohair1991@gmail.com"]
 
   spec.summary       = %q{Returns all prayer times for a specific date}
-  spec.description   = %q{Namaz is AlAdhan.com wrapper in ruby to use REST API that is open for public use. The API only supports the GET method and returns JSON. Currently this includes Timings only}
+  spec.description   = %q{Namaz gem is AlAdhan.com wrapper in ruby to use REST API that is open for public use.}
   spec.homepage      = "https://github.com/Sohair63/namaz"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: namaz
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sohair Ahmad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-23 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,9 +108,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Namaz is AlAdhan.com wrapper in ruby to use REST API that is open for
-  public use. The API only supports the GET method and returns JSON. Currently this
-  includes Timings only
+description: Namaz gem is AlAdhan.com wrapper in ruby to use REST API that is open
+  for public use.
 email:
 - sohair1991@gmail.com
 executables: []