namaz 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00a014d75a7276b009668a2f0ae8a348f3d45307
-  data.tar.gz: 6abb47879abeb515c7c0e50c9d374ce3af1bab39
+SHA256:
+  metadata.gz: 66dad608d2a8a98f4f9b47d4c993d5c24b16d16052da321523837bce8e2372c3
+  data.tar.gz: 8e4a24b7ea26f07beff019aec0824c3d04131934d3aee17c1597f4ecf2814086
 SHA512:
-  metadata.gz: aeef25610a99af0a7ed6c75faaa7411c04be4d0d88fba6eaafd124131db849772936dbc5c0b9b86536b4da88e0a68901e60dce70460b24ad020df6ba662612f7
-  data.tar.gz: dfd9a5130f48702e5b77925a00ceb52172cc949053e5e3c6ef8f704fad6c95b5be339a1e57b07ea1e8fd0d835f51ea005af605bb45e483b20ce5978268a8bfbf
+  metadata.gz: 44fd65370a4f9b7e4d83f4eb69842a2301c006fadc3a82b0316a52ec691b68a9841e6c09b813f1f952912e51c60c8a2d326a07908573e7a822008ada314c6f45
+  data.tar.gz: 39ac0bd0f2ce964d8f19c716fcfba11df05b50c92f669b7b4fb4b1e5fc906fa77d52e4e384845490f64efdf30d56d5b4146be0cf6291a4a9f3fb0146f844bc33

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.byebug_history

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Sohair Ahmad
+Copyright (c) 2018 Sohair Ahmad
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,8 @@
 # Namaz
-[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.
+
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/a00997d44c73474b9372b8e88ae04fd5)](https://app.codacy.com/app/sohair.ahmad/namaz?utm_source=github.com&utm_medium=referral&utm_content=Sohair63/namaz&utm_campaign=Badge_Grade_Dashboard)
+
+namaz ruby gem is an API wrapper. Namaz is aladhan.com wrapper in ruby to use REST API that is open for public use.
 
 ## Installation
 
@@ -13,7 +15,7 @@ gem 'namaz'
 For latest code:
 
 ```ruby
-gem 'namaz', git: 'git@github.com:Sohair63/namaz.git'
+gem 'namaz', git: 'https://github.com/Sohair63/namaz.git'
 ```
 
 And then execute:
@@ -31,6 +33,31 @@ Make sure you require the library, where you want to use it, Or require in `appl
 require 'namaz'
 ```
 
+## Upcoming Namaz and Namaz Time remain
+Returns upcoming prayer time with the its name.
+Note that: Returning time is in seconds, to help users to convert seconds to bigger units according to their needs or may be better use is placing in some jquery plugin e.g. jquery-countdown.
+
+```ruby
+## Using Altitudes:
+upcoming_namaz = Namaz.upcoming_namaz(latitude: 31.5546, longitude: 74.3572, timezonestring: "Asia/Karachi", method: 1, options: {timestamp: Time.now.to_i})
+
+ => #<Hashie::Mash namaz_name="Fajr" time_remaining_in_seconds=54821.0>
+
+upcoming_namaz.namaz_name
+ => "Fajr"
+upcoming_namaz.time_remaining_in_seconds
+ => 54821.0
+
+## Using City and Country Information:
+ upcoming_namaz = Namaz.upcoming_namaz_by_city(city: 'Karachi', country: 'PK', method: 1, options: {state: 'Punjab', timestamp: Time.now.to_i})
+=> #<Hashie::Mash namaz_name="Fajr" time_remaining_in_seconds=54821.0>
+
+ upcoming_namaz.namaz_name
+ => "Fajr"
+upcoming_namaz.time_remaining_in_seconds
+ => 54821.0
+```
+
 ## 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
@@ -212,7 +239,7 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Copyright
 
-Copyright (c) 2013-2016 Sohair S. Ahmad. See LICENSE.txt for further details.
+Copyright (c) 2018 Sohair S. Ahmad. See LICENSE.txt for further details.
 
 ## Development
 

data/lib/namaz.rb

@@ -3,11 +3,50 @@ require 'namaz/version'
 require 'hashie'
 require 'multi_json'
 require 'faraday'
+require 'time'
+require 'active_support/core_ext/time/zones'
 
 module Namaz
-  DEFAULT_API_URL = 'http://api.aladhan.com'
+  DEFAULT_API_URL = 'http://api.aladhan.com/v1'
 
   class << self
+    # Retrieve the remaining time to next namaz for a given latitude, longitude, timezonestring and method.
+    #
+    # @param [Float] latitude.
+    # @param [Float] longitude.
+    # @param [String] timezonestring
+    # @param [Integer] method
+    # @param options [Hash], Have optional values like timestamp, that is default to Current timestamp
+    # @return [Hash] namaz_name, and time remain in seconds
+    def upcoming_namaz(latitude:, longitude:, timezonestring:, method:, options: {})
+      namaz_time_response = timings(
+        latitude: latitude,
+        longitude: longitude,
+        timezonestring: timezonestring,
+        method: method,
+        options: options
+      )
+
+      prayer_and_time_remain(namaz_time_response, timezonestring)
+    end
+
+    # Retrieve the remaining time to next namaz for a given city, country, method and timezonestring
+    #
+    # @param [String] city
+    # @param [String] country
+    # @param [Integer] method
+    # @param [Hash] options, Have optional values like timestamp, that is default to Current timestamp
+    # @return [Hash] namaz_name, and time remain in seconds
+    def upcoming_namaz_by_city(city:, country:, method:, timezonestring:, options: {})
+      namaz_time_response = timings_by_city(
+        city: city,
+        country: country,
+        method: method,
+        options: options)
+
+      prayer_and_time_remain(namaz_time_response, timezonestring)
+    end
+
     # Retrieve the latitude, longitude and timezone for a given city
     # @param [String] city
     # @param [String] country
@@ -62,7 +101,6 @@ module Namaz
     #
     # @param [String] city
     # @param [String] country
-    # @param [String] timezonestring
     # @param [Integer] method
     # @param [Hash] options, Have optional values like timestamp, that is default to Current timestamp
     def timings_by_city(city:, country:, method:, options: {})
@@ -154,5 +192,27 @@ module Namaz
       return Hashie::Mash.new(MultiJson.load(response.body)).data if response.success?
     end
 
+    def prayer_and_time_remain(times, timezonestring)
+      times.delete('Sunset')
+      times.delete('Sunrise')
+      times.delete('Midnight')
+      times.delete('Imsak')
+
+      Time.zone = timezonestring
+      current_time = Time.now
+      current_time_hms = current_time.strftime('%H:%M:%S')
+      current_time_hm = current_time.strftime('%H:%M')
+
+      times.select { |key, value| times[key] = Time.strptime(value, '%H:%M').strftime('%H:%M') }
+      namaz_name, namaz_time = times.select { |_, value| current_time_hm <= value }.first
+      namaz_name, namaz_time = times.first if namaz_time.blank?
+      time_diff = Time.parse(namaz_time) - Time.parse(current_time_hms)
+      [namaz_name, time_diff.abs]
+
+      Time.zone = nil
+
+      Hashie::Mash.new(namaz_name: namaz_name, time_remaining_in_seconds: time_diff.abs)
+    end
+
   end
 end

data/lib/namaz/version.rb

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

data/namaz.gemspec

@@ -30,12 +30,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'faraday', '~> 0'
-  spec.add_dependency 'multi_json', '~> 0'
-  spec.add_dependency 'hashie', '~> 0'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'hashie'
 
-  spec.add_development_dependency 'typhoeus', '~> 0'
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'typhoeus', '~> 1'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: namaz
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Sohair Ahmad
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 description: Namaz gem is AlAdhan.com wrapper in ruby to use REST API that is open
   for public use.
 email:
@@ -135,7 +135,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Returns all prayer times for a specific date
 test_files: []