alquran 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0d4684603e83ea987b54a2bce6e433dc356f3f5b47e2808708f2fee109ea680
+  data.tar.gz: 642d68cb747f4eb031683ea227f9f4fee91e22428860fe83e243b8789cc37bc4
+SHA512:
+  metadata.gz: 7183f3d14f11371d041907989598293b9ebf3cb2033cacdaa8bcb15d2d5d1eceb34806e97575e8beb8795ac2c73d4f3a27efd6a5a7ff49d15eb3a7eaa265219d
+  data.tar.gz: f57f0a15e00fbc48ecf64f4d565605531f9e6d44e09bc054435ee8f6be900076f9d0964148f22795c4e95f2aa6091835630f19345363359f4486fa081bf3c2d0

data/lib/alquran.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+require 'active_support/inflector'
+
+require_relative 'alquran/base'
+require_relative 'alquran/parah'
+require_relative 'alquran/surah'
+require_relative 'alquran/ayah'
+require_relative 'alquran/edition'
+
+require_relative 'api/url_parser'
+require_relative 'api/client'
+
+require_relative 'extensions'
+
+module Alquran
+end

data/lib/alquran/ayah.rb

@@ -0,0 +1,25 @@
+module Alquran
+  class Ayah < Base
+    class << self
+      def fetch(**options)
+        Api::Client.fetch(filter_options(options))
+      end
+
+      private
+        def show_options(options)
+          edition_option = { edition: options[:edition] }.compact
+          options.slice(:number).merge(self.entity_option).merge(action: :show).merge(extras: edition_option)
+        end
+
+        def filter_options(**options)
+          return show_options(options) unless options.has_key?(:sajdah)
+
+          action_option = { action: :sajdah }
+
+          edition_option = { edition: options[:edition] }.compact
+
+          options.slice(:number).merge(self.entity_option).merge(action_option).merge(extras: edition_option)
+        end
+    end
+  end
+end

data/lib/alquran/base.rb

@@ -0,0 +1,10 @@
+module Alquran
+  class Base
+    class << self
+      protected
+        def entity_option
+          { entity: self.name.demodulize.downcase.to_sym }
+        end
+    end
+  end
+end

data/lib/alquran/edition.rb

@@ -0,0 +1,14 @@
+module Alquran
+  class Edition < Base
+    class << self
+      def fetch(**options)
+        Api::Client.fetch(filter_options(options))
+      end
+
+      private
+        def filter_options(**options)
+          self.entity_option.merge(action: :index)
+        end
+    end
+  end
+end

data/lib/alquran/parah.rb

@@ -0,0 +1,40 @@
+module Alquran
+  class Parah < Base
+    class << self
+      def fetch(**options)
+        Api::Client.fetch(filter_options(options))
+      end
+
+      private
+        def index_options
+          self.entity_option.merge(action: :index)
+        end
+
+        def show_options(number)
+          self.entity_option.merge(action: :show, number: number)
+        end
+
+        def filter_options(**options)
+          return index_options unless options.has_key?(:number)
+          return show_options(options[:number]) unless options.has_key?(:collection)
+
+          action_option = case options
+            when -> (opts) { opts[:collection] === :surahs }
+              { action: :surahs }
+            when -> (opts) { opts[:collection] === :ayahs }
+              { action: :ayahs }
+            else
+              raise RuntimeApiError.new
+          end
+
+          extra_options = {
+            offset: options[:offset],
+            limit: options[:limit],
+            sajdah: options[:sajdah]
+          }.compact
+
+          options.slice(:number).merge(self.entity_option).merge(action_option).merge(extras: extra_options)
+        end
+    end
+  end
+end

data/lib/alquran/surah.rb

@@ -0,0 +1,43 @@
+module Alquran
+  class Surah < Base
+    class << self
+      def fetch(**options)
+        Api::Client.fetch(filter_options(options))
+      end
+
+      private
+        def index_options
+          self.entity_option.merge(action: :index)
+        end
+
+        def show_options(options)
+          edition_option = { edition: options[:edition] }.compact
+          options.slice(:number).merge(self.entity_option).merge(action: :show).merge(extras: edition_option)
+        end
+
+        def filter_options(**options)
+          return index_options unless options.has_key?(:number)
+          return show_options(options) unless has_extra_option?(options)
+
+          action_option = { action: :ayahs }
+
+          extra_options = {
+            offset: options[:offset],
+            limit: options[:limit],
+            edition: options[:edition],
+            sajdah: options[:sajdah]
+          }.compact
+
+          options.slice(:number).merge(self.entity_option).merge(action_option).merge(extras: extra_options)
+        end
+
+        def has_extra_option?(options)
+          not available_extra_options.map(&options).compact.empty?
+        end
+
+        def available_extra_options
+          %i(offset limit sajdah)
+        end
+    end
+  end
+end

data/lib/api/client.rb

@@ -0,0 +1,28 @@
+module Api
+  class Client
+    extend UrlParser
+
+    class << self
+      def fetch(**options)
+        get(parse_url(options))
+      end
+
+      private
+        def get(url)
+          response = HTTParty.get(url, headers: headers)
+          handle_request_response(response)
+        end
+
+        def handle_request_response(response)
+          case response.code
+            when 200..201 then JSON.parse(response.body)
+            else raise RuntimeApiError.new
+          end
+        end
+
+        def headers
+          { 'Accept': 'application/alquran; v1' }
+        end
+    end
+  end
+end

data/lib/api/url_parser.rb

@@ -0,0 +1,55 @@
+module Api
+  module UrlParser
+    # BASE_URL = 'http://api.alquranpak.com'
+    BASE_URL = 'http://localhost:3001'
+    RELATIVE_PARAH_PATH = 'parahs'
+    RELATIVE_SURAH_PATH = 'surahs'
+    RELATIVE_AYAH_PATH = 'ayahs'
+    RELATIVE_EDITION_PATH = 'editions'
+
+    def parse_url(**params)
+      method_name = "handle_#{params[:entity].to_s}_urls"
+      self.send(method_name, params)
+    end
+
+    def handle_parah_urls(**params)
+      case params[:action]
+        when :index then [BASE_URL, RELATIVE_PARAH_PATH].join('/')
+        when :show then [BASE_URL, RELATIVE_PARAH_PATH, params[:number]].join('/')
+        when :surahs then [BASE_URL, RELATIVE_PARAH_PATH, params[:number], params[:action]].join('/')
+        when :ayahs
+          relative_url = [BASE_URL, RELATIVE_PARAH_PATH, params[:number], params[:action]].join('/')
+          [relative_url, prepare_query_string(params[:extras])].join('?')
+      end
+    end
+
+    def handle_surah_urls(**params)
+      case params[:action]
+        when :index then [BASE_URL, RELATIVE_SURAH_PATH].join('/')
+        when :show
+          relative_url = [BASE_URL, RELATIVE_SURAH_PATH, params[:number]].join('/')
+          [relative_url, prepare_query_string(params[:extras])].join('?')
+        when :ayahs
+          relative_url = [BASE_URL, RELATIVE_SURAH_PATH, params[:number], params[:action]].join('/')
+          [relative_url, prepare_query_string(params[:extras])].join('?')
+      end
+    end
+
+    def handle_ayah_urls(**params)
+      case params[:action]
+        when :show
+          relative_url = [BASE_URL, RELATIVE_AYAH_PATH, params[:number]].join('/')
+          [relative_url, prepare_query_string(params[:extras])].join('?')
+        when :sajdah then [BASE_URL, RELATIVE_AYAH_PATH, :sujood].join('/')
+      end
+    end
+
+    def handle_edition_urls(**params)
+      [BASE_URL, RELATIVE_EDITION_PATH, params[:number]].join('/')
+    end
+
+    def prepare_query_string(extras)
+      extras.to_a.map(&:join.with('=')).join('&')
+    end
+  end
+end

data/lib/extensions.rb

@@ -0,0 +1,8 @@
+class Symbol
+  def with(*args, &block)
+    -> (caller, *rest) { caller.send(self, *rest, *args, &block) }
+  end
+end
+
+class RuntimeApiError < RuntimeError
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: alquran
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Ahsan Ellahi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: All the details can be collected of Holy Quran inclduing Parahs, Surahs,
+  Ayahs and Transcriptions etc.
+email: ahsan.ellahi896@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/alquran.rb
+- lib/alquran/ayah.rb
+- lib/alquran/base.rb
+- lib/alquran/edition.rb
+- lib/alquran/parah.rb
+- lib/alquran/surah.rb
+- lib/api/client.rb
+- lib/api/url_parser.rb
+- lib/extensions.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Provides all the information regarding the Holy Quran (Book)
+test_files: []