pattana 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d2b566f1a20f35368c5e99d93fdde8a3b3a9e18
-  data.tar.gz: 688dbf20ca7c12c1af959a0dbf1965ef77ce1a6c
+  metadata.gz: 468d2c5b68afe569337545a39e80ec8d9d6f1160
+  data.tar.gz: 1ec9df908fd6cff6318c9d6306995621a1119dce
 SHA512:
-  metadata.gz: b9abfefaaff0c9ffc6809b62abc7fb9220394dbc6af6a574c6969df3086cfac245d58feef19e540358621407740483a4365ba38be88b3d49fb8850eef71d3566
-  data.tar.gz: 109ee72c4ee3f9d0693b923a224ad82e21f484296a2d4771edcadbcdcae7554ec319293a58740a7121ac7c8918a23f3d34d3a5ffb33c94a97bb53295a442f0ba
+  metadata.gz: 07daba96fbfdd05189785d0579c0cf571e0888af8251f92d4bdc295db7536dccbc085b35c02115f33aee801b99e26b90edaf1d5d4a08f6f1be50951ef09d4c72
+  data.tar.gz: 9fc208a79e6d001d26da026cd262b9b52439148c4a67fab280a7fb685f79a05bf66285d28c2ade6772ad2f7dfd445fa7758c056e445734e21d6f0e08da62a669

data/app/controllers/pattana/api/v1/base_controller.rb

@@ -0,0 +1,12 @@
+module Pattana
+  module Api
+    module V1
+      class BaseController < ActionController::API
+
+        include ActionController::HttpAuthentication::Token::ControllerMethods
+        include RenderApiHelper
+
+      end
+    end
+  end
+end

data/app/controllers/pattana/api/v1/cities_controller.rb

@@ -0,0 +1,62 @@
+module Pattana
+  module Api
+    module V1
+      class CitiesController < BaseController
+
+        def cities_in_a_country
+          proc_code = Proc.new do
+            @country = Country.find_by_id(params[:country_id])
+            if @country
+              @cities = @country.cities.where("show_in_api is true").order("name ASC").all
+              @success = true
+              @data = @cities
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.cities.country_not_found.heading"),
+                message: I18n.translate("api.cities.country_not_found.message")
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+
+        def cities_in_a_region
+          proc_code = Proc.new do
+            @region = Region.find_by_id(params[:region_id])
+            if @region
+              @country = Country.find_by_id(params[:country_id])
+              if @country
+                if @region.country_id == @country.id
+                  @cities = @region.cities.where("show_in_api is true").order("name ASC").all
+                  @success = true
+                  @data = @cities
+                else
+                  @success = false
+                  @errors = {
+                    heading: I18n.translate("api.cities.region_id_not_matching.heading"),
+                    message: I18n.translate("api.cities.region_id_not_matching.message")
+                  }
+                end
+              else
+                @success = false
+                @errors = {
+                  heading: I18n.translate("api.cities.country_not_found.heading"),
+                  message: I18n.translate("api.cities.country_not_found.message")
+                }
+              end
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.cities.region_not_found.heading"),
+                message: I18n.translate("api.cities.region_not_found.message")
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+      end
+    end
+  end
+end
+

data/app/controllers/pattana/api/v1/countries_controller.rb

@@ -0,0 +1,18 @@
+module Pattana
+  module Api
+    module V1
+      class CountriesController < BaseController
+
+        def index
+          proc_code = Proc.new do
+            @countries = Country.where("show_in_api is true").order("name ASC").all
+            @success = true
+            @data = @countries
+          end
+          render_json_response(proc_code)
+        end
+      end
+    end
+  end
+end
+

data/app/controllers/pattana/api/v1/docs_base_controller.rb

@@ -0,0 +1,21 @@
+module Pattana
+  module Api
+    module V1
+      class DocsBaseController < Kuppayam::BaseController
+
+        layout 'kuppayam/docs'
+        
+        private
+
+        def breadcrumbs_configuration
+          {
+            heading: "Pattana - API Documentation",
+            description: "A brief documentation of all APIs implemented in the gem Pattana with input and output details and examples",
+            links: []
+          }
+        end
+        
+      end
+    end
+  end
+end

data/app/controllers/pattana/api/v1/docs_controller.rb

@@ -0,0 +1,105 @@
+module Pattana
+  module Api
+    module V1
+      class DocsController < Pattana::Api::V1::DocsBaseController
+
+        layout 'kuppayam/docs'
+
+        def countries
+          set_title("Countries API")
+          @request_type = "GET"
+          @end_point = "/api/v1/countries"
+          @description = "This API will return all the countries with other details like dialing prefix and ISO codes."
+
+          @info = "It will return only those countries who has show_in_api set true"
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @example_path = "pattana/api/v1/docs/"
+          @examples = ["pos_case_1"]
+
+          set_nav("docs/countries")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def regions
+          set_title("Regions API")
+          @request_type = "GET"
+          @end_point = "/api/v1/:country_id/regions"
+          @description = "This API will return all the regions in a particular country. The Country ID has to be passed."
+
+          @info = "It will return only those regions who has show_in_api set true"
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @input_params = {
+            country_id: { mandatory: true, description: "The Country ID. You will get it from the Countries API", example: "for e.g: Country Id for U.A.E is 235 and that of India is 100", default: "" }
+          }
+
+          @example_path = "pattana/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1"]
+
+          set_nav("docs/regions")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def cities_in_a_country
+          set_title("Cities API (in a country)")
+          @request_type = "GET"
+          @end_point = "/api/v1/:country_id/cities"
+          @description = "This API will return all the cities in a particular country. The Country ID has to be passed"
+
+          @info = "It will return only those cities who has show_in_api set true"
+
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @input_params = {
+            country_id: { mandatory: true, description: "The Country ID. You will get it from the Countries API", example: "for e.g: Country Id for U.A.E is 235 and that of India is 100", default: "" }
+          }
+
+          @example_path = "pattana/api/v1/docs/"
+          @examples = ["pos_case_1", "neg_case_1"]
+
+          set_nav("docs/cities_in_a_country")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+        def cities_in_a_region
+          set_title("Cities API (in a region)")
+          @request_type = "GET"
+          @end_point = "/api/v1/:country_id/:region_id/cities"
+          @description = "This API will return all the cities in a particular region. The Country ID & Region ID has to be passed"
+
+          @info = "It will return only those cities who has show_in_api set true"
+          @warning = "Make sure that the region (id) belongs to the country (id). Use the countries and regions API to get real id"
+          
+          @input_headers = {
+            "Content-Type" => { value: "application/json", description: "The MIME media type for JSON text is application/json. This is to make sure that a valid json is returned. The default encoding is UTF-8. " }
+          }
+
+          @input_params = {
+            country_id: { mandatory: true, description: "The Country ID. You will get it from the Countries API", example: "for e.g: Country Id for U.A.E is 235 and that of India is 100", default: "" },
+            region_id: { mandatory: true, description: "The Region ID. You will get it from the Regions API", example: "for e.g: Country Id for India is 100 and Region ID for Kerala is 1314", default: "" }
+          }
+
+          @example_path = "pattana/api/v1/docs/"
+          @examples = ["pos_case_1", "pos_case_2", "neg_case_1", "neg_case_2", "neg_case_3"]
+
+          set_nav("docs/cities_in_a_region")
+
+          render 'kuppayam/api/docs/show'
+        end
+
+      end
+    end
+  end
+end

data/app/controllers/pattana/api/v1/regions_controller.rb

@@ -0,0 +1,27 @@
+module Pattana
+  module Api
+    module V1
+      class RegionsController < BaseController
+
+        def index
+          proc_code = Proc.new do
+            @country = Country.find_by_id(params[:country_id])
+            if @country
+              @regions = @country.regions.where("show_in_api is true").order("name ASC").all
+              @success = true
+              @data = @regions
+            else
+              @success = false
+              @errors = {
+                heading: I18n.translate("api.regions.country_not_found.heading"),
+                message: I18n.translate("api.regions.country_not_found.message")
+              }
+            end
+          end
+          render_json_response(proc_code)
+        end
+      end
+    end
+  end
+end
+

data/app/models/city.rb

@@ -1,5 +1,8 @@
 class City < Pattana::ApplicationRecord
   
+  # Constants
+  EXCLUDED_JSON_ATTRIBUTES = [:created_at, :updated_at, :show_in_api]
+
   # Associations
   belongs_to :country
   belongs_to :region, optional: true
@@ -11,6 +14,16 @@ class City < Pattana::ApplicationRecord
   # Class Methods
   # ------------------
 
+  # Exclude some attributes info from json output.
+  def as_json(options={})
+    options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
+    #options[:include] ||= []
+    #options[:methods] = []
+    #options[:methods] << :profile_image
+    json = super(options)
+    Hash[*json.map{|k, v| [k, v || ""]}.flatten]
+  end
+
   # Scopes Methods
 
   # return an active record relation object with the search query in its where clause

data/app/models/country.rb

@@ -1,5 +1,8 @@
 class Country < Pattana::ApplicationRecord
   
+  # Constants
+  EXCLUDED_JSON_ATTRIBUTES = [:created_at, :updated_at, :show_in_api]
+
   # Associations
   has_many :regions
   has_many :cities
@@ -11,6 +14,16 @@ class Country < Pattana::ApplicationRecord
   # Class Methods
   # ------------------
 
+  # Exclude some attributes info from json output.
+  def as_json(options={})
+    options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
+    #options[:include] ||= []
+    #options[:methods] = []
+    #options[:methods] << :profile_image
+    json = super(options)
+    Hash[*json.map{|k, v| [k, v || ""]}.flatten]
+  end
+
   # Scopes Methods
 
   # return an active record relation object with the search query in its where clause

data/app/models/region.rb

@@ -1,5 +1,8 @@
 class Region < Pattana::ApplicationRecord
   
+  # Constants
+  EXCLUDED_JSON_ATTRIBUTES = [:created_at, :updated_at, :show_in_api]
+
   # Associations
   belongs_to :country
   has_many :cities
@@ -11,6 +14,16 @@ class Region < Pattana::ApplicationRecord
   # Class Methods
   # ------------------
 
+  # Exclude some attributes info from json output.
+  def as_json(options={})
+    options[:except] ||= EXCLUDED_JSON_ATTRIBUTES
+    #options[:include] ||= []
+    #options[:methods] = []
+    #options[:methods] << :profile_image
+    json = super(options)
+    Hash[*json.map{|k, v| [k, v || ""]}.flatten]
+  end
+  
   # Scopes Methods
 
   # return an active record relation object with the search query in its where clause

data/app/views/kuppayam/api/docs/_navigation.html.erb

@@ -0,0 +1,31 @@
+<ul class="nav tabs-vertical">
+  <li class="<%= nav_active?('docs/countries') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/countries">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Countries</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/regions') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/regions">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Regions</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/cities_in_a_country') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/cities_in_a_country">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Cities (in a Country)</span>
+    </a>
+  </li>
+  <li class="<%= nav_active?('docs/cities_in_a_region') ? 'active' : ''  %>">
+    <a href="/docs/api/v1/cities_in_a_region">
+      <i class="fa-globe visible-xs"></i>
+      <span class="hidden-xs">Cities (in a Region)</span>
+    </a>
+  </li>
+</ul>
+
+<style type="text/css">
+  .panel-positive h4.panel-title a { color: #68b828 !important; }
+  .panel-negative h4.panel-title a { color: #cc3f44 !important; }
+</style>

data/app/views/pattana/api/v1/docs/cities_in_a_country/_neg_case_1.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 1 - should show errors if a valid country id is not passed"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Invalid Country ID",
+      "message": "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API."
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/cities_in_a_country/_pos_case_1.html.erb

@@ -0,0 +1,63 @@
+<%
+
+api_title = "Positive Case - 1 - should return all the cities in a country"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": [
+    {
+      "id": 21,
+      "name": "Abu Dhabi",
+      "alternative_names": "A-pu-that-pi,AEbu Saby,AUH,Aboe Dhabi,Abou Dabi,Abu Dabi,Abu Dabis,Abu Daby,Abu Daibi,Abu Dhabi,Abu Dhabi emiraat,Abu Zabi,Abu Zaby,Abu Zabye,Abu Zabyo,Abu á¸\u008cabi,Abu á¸\u0090abi,Abu-Dabi,Abu-Dabi khot,Abu-Dabio,Abu-Dzabi,Abú DabÃ\u00ad,Abú DaibÃ\u00ad,Abú ZabÃ\u00ad,Abû ",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 14,
+      "latitude": "24.46667",
+      "longitude": "54.36667",
+      "population": 603492,
+      "priority": 1000
+    },
+    {
+      "id": 20,
+      "name": "Adh Dhayd",
+      "alternative_names": "Adh Dhaid,Adh Dhayd,Al Daid,Al-Dhayd,Dayd,Dhaid,Dhayd,Duhayd,Ihaid,aldhyd,اÙ\u0084Ø°Ù\u008aد,á¸\u0090ayd",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 11,
+      "latitude": "25.28812",
+      "longitude": "55.88157",
+      "population": 24716,
+      "priority": 1000
+    },
+    .
+    .
+    .
+    {
+      "id": 8,
+      "name": "Umm al Qaywayn",
+      "alternative_names": "Oumm al Qaiwain,Oumm al Qaïwaïn,Um al Kawain,Um al Quweim,Umm al Qaiwain,Umm al Qawain,Umm al Qaywayn,Umm al-Quwain,Umm-ehl'-Kajvajn,Yumul al Quwain,am alqywyn,Умм-Ñ\u008dлÑ\u008c-Ð\u009aайвайн,Ø£Ù\u0085 اÙ\u0084Ù\u0082Ù\u008aÙ\u0088Ù\u008aÙ\u0086",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 8,
+      "latitude": "25.56473",
+      "longitude": "55.55517",
+      "population": 44411,
+      "priority": 1000
+    }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/cities_in_a_region/_neg_case_1.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 1 - should show errors if a valid country id is not passed"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Invalid Country ID",
+      "message": "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API."
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/cities_in_a_region/_neg_case_2.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 2 - should show errors if a valid country id is not passed"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "Invalid Region ID",
+    "message": "Pass a vaild Region ID to get the regions. Get Regions List along with their IDs from Regions API"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/cities_in_a_region/_neg_case_3.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 3 - should show errors if a valid country id is not passed"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+    "heading": "Region ID and the Country ID doesn't match",
+    "message": "Make sure that you pass the region id which belongs the right country id. This error is likely to be encountered when the region id belongs to a different country id than the one you have passed"
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/cities_in_a_region/_pos_case_1.html.erb

@@ -0,0 +1,63 @@
+<%
+
+api_title = "Positive Case - 1 - should return all the cities in a country"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": [
+    {
+      "id": 21,
+      "name": "Abu Dhabi",
+      "alternative_names": "A-pu-that-pi,AEbu Saby,AUH,Aboe Dhabi,Abou Dabi,Abu Dabi,Abu Dabis,Abu Daby,Abu Daibi,Abu Dhabi,Abu Dhabi emiraat,Abu Zabi,Abu Zaby,Abu Zabye,Abu Zabyo,Abu á¸\u008cabi,Abu á¸\u0090abi,Abu-Dabi,Abu-Dabi khot,Abu-Dabio,Abu-Dzabi,Abú DabÃ\u00ad,Abú DaibÃ\u00ad,Abú ZabÃ\u00ad,Abû ",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 14,
+      "latitude": "24.46667",
+      "longitude": "54.36667",
+      "population": 603492,
+      "priority": 1000
+    },
+    {
+      "id": 20,
+      "name": "Adh Dhayd",
+      "alternative_names": "Adh Dhaid,Adh Dhayd,Al Daid,Al-Dhayd,Dayd,Dhaid,Dhayd,Duhayd,Ihaid,aldhyd,اÙ\u0084Ø°Ù\u008aد,á¸\u0090ayd",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 11,
+      "latitude": "25.28812",
+      "longitude": "55.88157",
+      "population": 24716,
+      "priority": 1000
+    },
+    .
+    .
+    .
+    {
+      "id": 8,
+      "name": "Umm al Qaywayn",
+      "alternative_names": "Oumm al Qaiwain,Oumm al Qaïwaïn,Um al Kawain,Um al Quweim,Umm al Qaiwain,Umm al Qawain,Umm al Qaywayn,Umm al-Quwain,Umm-ehl'-Kajvajn,Yumul al Quwain,am alqywyn,Умм-Ñ\u008dлÑ\u008c-Ð\u009aайвайн,Ø£Ù\u0085 اÙ\u0084Ù\u0082Ù\u008aÙ\u0088Ù\u008aÙ\u0086",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 8,
+      "latitude": "25.56473",
+      "longitude": "55.55517",
+      "population": 44411,
+      "priority": 1000
+    }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/cities_in_a_region/_pos_case_2.html.erb

@@ -0,0 +1,63 @@
+<%
+
+api_title = "Positive Case - 2 - should return all the cities in a region"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": [
+    {
+      "id": 21,
+      "name": "Abu Dhabi",
+      "alternative_names": "A-pu-that-pi,AEbu Saby,AUH,Aboe Dhabi,Abou Dabi,Abu Dabi,Abu Dabis,Abu Daby,Abu Daibi,Abu Dhabi,Abu Dhabi emiraat,Abu Zabi,Abu Zaby,Abu Zabye,Abu Zabyo,Abu á¸\u008cabi,Abu á¸\u0090abi,Abu-Dabi,Abu-Dabi khot,Abu-Dabio,Abu-Dzabi,Abú DabÃ\u00ad,Abú DaibÃ\u00ad,Abú ZabÃ\u00ad,Abû ",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 14,
+      "latitude": "24.46667",
+      "longitude": "54.36667",
+      "population": 603492,
+      "priority": 1000
+    },
+    {
+      "id": 20,
+      "name": "Adh Dhayd",
+      "alternative_names": "Adh Dhaid,Adh Dhayd,Al Daid,Al-Dhayd,Dayd,Dhaid,Dhayd,Duhayd,Ihaid,aldhyd,اÙ\u0084Ø°Ù\u008aد,á¸\u0090ayd",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 11,
+      "latitude": "25.28812",
+      "longitude": "55.88157",
+      "population": 24716,
+      "priority": 1000
+    },
+    .
+    .
+    .
+    {
+      "id": 8,
+      "name": "Umm al Qaywayn",
+      "alternative_names": "Oumm al Qaiwain,Oumm al Qaïwaïn,Um al Kawain,Um al Quweim,Umm al Qaiwain,Umm al Qawain,Umm al Qaywayn,Umm al-Quwain,Umm-ehl'-Kajvajn,Yumul al Quwain,am alqywyn,Умм-Ñ\u008dлÑ\u008c-Ð\u009aайвайн,Ø£Ù\u0085 اÙ\u0084Ù\u0082Ù\u008aÙ\u0088Ù\u008aÙ\u0086",
+      "iso_code": "",
+      "country_id": 235,
+      "region_id": 8,
+      "latitude": "25.56473",
+      "longitude": "55.55517",
+      "population": 44411,
+      "priority": 1000
+    }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/countries/_pos_case_1.html.erb

@@ -0,0 +1,90 @@
+<%
+
+api_title = "Positive Case - 1 - should return all the countries"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+    "success": true,
+    "data": [
+        {
+            "id": 1,
+            "name": "Afghanistan",
+            "official_name": "Afghanistan",
+            "iso_name": "AFGHANISTAN",
+            "fips": "AF",
+            "iso_alpha_2": "AF",
+            "iso_alpha_3": "AFG",
+            "itu_code": "AFG",
+            "dialing_prefix": "93",
+            "tld": ".af",
+            "latitude": "33.0",
+            "longitude": "65.0",
+            "capital": "Kabul",
+            "continent": "AS",
+            "currency_code": "AFN",
+            "currency_name": "Afghani",
+            "is_independent": "Yes",
+            "languages": "fa-AF,ps,uz-AF,tk",
+            "priority": 1000
+        },
+        {
+            "id": 2,
+            "name": "Albania",
+            "official_name": "Albania",
+            "iso_name": "ALBANIA",
+            "fips": "AL",
+            "iso_alpha_2": "AL",
+            "iso_alpha_3": "ALB",
+            "itu_code": "ALB",
+            "dialing_prefix": "355",
+            "tld": ".al",
+            "latitude": "41.0",
+            "longitude": "20.0",
+            "capital": "Tirana",
+            "continent": "EU",
+            "currency_code": "ALL",
+            "currency_name": "Lek",
+            "is_independent": "Yes",
+            "languages": "sq,el",
+            "priority": 1000
+        },
+        .
+        .
+        .
+        {
+            "id": 246,
+            "name": "Zimbabwe",
+            "official_name": "Zimbabwe",
+            "iso_name": "ZIMBABWE",
+            "fips": "ZI",
+            "iso_alpha_2": "ZW",
+            "iso_alpha_3": "ZWE",
+            "itu_code": "ZWE",
+            "dialing_prefix": "263",
+            "tld": ".zw",
+            "latitude": "-20.0",
+            "longitude": "30.0",
+            "capital": "Harare",
+            "continent": "AF",
+            "currency_code": "ZWL",
+            "currency_name": "Zimbabwe Dollar",
+            "is_independent": "Yes",
+            "languages": "en-ZW,sn,nr,nd",
+            "priority": 1000
+        }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/regions/_neg_case_1.html.erb

@@ -0,0 +1,27 @@
+<%
+
+api_title = "Negative Case - 1 - should show errors if a valid country id is not passed"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": false,
+  "errors": {
+      "heading": "Invalid Country ID",
+      "message": "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API."
+  }
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: true,
+                                        example_id: "neg_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/app/views/pattana/api/v1/docs/regions/_pos_case_1.html.erb

@@ -0,0 +1,54 @@
+<%
+
+api_title = "Positive Case - 1 - should return all the regions in a country"
+
+api_input = <<-eos
+{}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": [
+    {
+      "id": 8,
+      "name": "Umm Al Quwain",
+      "iso_code": "AE-07",
+      "country_id": 235,
+      "latitude": "",
+      "longitude": "",
+      "priority": 1000
+    },
+    {
+      "id": 9,
+      "name": "Ras Al Khaimah",
+      "iso_code": "AE-05",
+      "country_id": 235,
+      "latitude": "",
+      "longitude": "",
+      "priority": 1000
+    },
+    .
+    .
+    .
+    {
+      "id": 13,
+      "name": "Ajman",
+      "iso_code": "AE-02",
+      "country_id": 235,
+      "latitude": "25.41222",
+      "longitude": "55.434738",
+      "priority": 1000
+    }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_1",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/config/locales/pattana/api.ar.yml

@@ -0,0 +1,16 @@
+en:
+  api:
+    regions:
+      country_not_found:
+        heading: "Invalid Country ID"
+        message: "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API"
+    cities:
+      country_not_found:
+        heading: "Invalid Country ID"
+        message: "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API"
+      region_not_found:
+        heading: "Invalid Region ID"
+        message: "Pass a vaild Region ID to get the regions. Get Regions List along with their IDs from Regions API"
+      region_id_not_matching:
+        heading: "Region ID and the Country ID doesn't match"
+        message: "Make sure that you pass the region id which belongs the right country id. This error is likely to be encountered when the region id belongs to a different country id than the one you have passed"

data/config/locales/pattana/api.en.yml

@@ -0,0 +1,16 @@
+en:
+  api:
+    regions:
+      country_not_found:
+        heading: "Invalid Country ID"
+        message: "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API"
+    cities:
+      country_not_found:
+        heading: "Invalid Country ID"
+        message: "Pass a vaild Country ID to get the regions. Get Countries List along with their IDs from Countries API"
+      region_not_found:
+        heading: "Invalid Region ID"
+        message: "Pass a vaild Region ID to get the regions. Get Regions List along with their IDs from Regions API"
+      region_id_not_matching:
+        heading: "Region ID and the Country ID doesn't match"
+        message: "Make sure that you pass the region id which belongs the right country id. This error is likely to be encountered when the region id belongs to a different country id than the one you have passed"

data/config/routes.rb

@@ -11,4 +11,39 @@ Pattana::Engine.routes.draw do
   resources :regions,  as: :regions
   resources :cities,  as: :cities
 
+  # get '/api/v1/countries', :controller => "/api/v1/countries", action: :index, as: :api_v1_countries
+  # get '/api/v1/:country_id/regions', :controller => "/api/v1/regions", action: :index, as: :api_v1_regions
+  # get '/api/v1/:country_id/cities', :controller => "/api/v1/cities", action: :cities_in_a_country, as: :api_v1_cities_in_a_country
+  # get '/api/v1/:country_id/:region_id/cities', :controller => "/api/v1/cities", action: :cities_in_a_region, as: :api_v1_cities_in_a_region
+
+  # namespace :docs do
+  #   namespace :api do
+  #     namespace :v1 do
+  #       get 'countries', to: "/api/v1/docs#countries"
+  #       get 'regions', to: "/api/v1/docs#regions"
+  #       get 'cities', to: "/api/v1/docs#cities"
+  #     end
+  #   end
+  # end
+
+  namespace :api do
+    namespace :v1 do
+      get 'countries', :controller => "countries", action: :index
+      get ':country_id/regions', :controller => "regions", action: :index
+      get ':country_id/cities', :controller => "cities", action: :cities_in_a_country
+      get ':country_id/:region_id/cities', :controller => "cities", action: :cities_in_a_region
+    end
+  end
+  
+  scope :docs do
+    namespace :api do
+      namespace :v1 do
+        get 'countries', :controller => "docs"
+        get 'regions', :controller => "docs"
+        get 'cities_in_a_country', :controller => "docs"
+        get 'cities_in_a_region', :controller => "docs"
+      end
+    end
+  end
+
 end

data/lib/pattana/version.rb

@@ -1,3 +1,3 @@
 module Pattana
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattana
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - kpvarma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -90,14 +90,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -333,6 +333,12 @@ files:
 - app/assets/javascripts/pattana/application.js
 - app/assets/sketches/logo.sketch
 - app/assets/stylesheets/pattana/application.css
+- app/controllers/pattana/api/v1/base_controller.rb
+- app/controllers/pattana/api/v1/cities_controller.rb
+- app/controllers/pattana/api/v1/countries_controller.rb
+- app/controllers/pattana/api/v1/docs_base_controller.rb
+- app/controllers/pattana/api/v1/docs_controller.rb
+- app/controllers/pattana/api/v1/regions_controller.rb
 - app/controllers/pattana/application_controller.rb
 - app/controllers/pattana/cities_controller.rb
 - app/controllers/pattana/countries_controller.rb
@@ -346,11 +352,22 @@ files:
 - app/models/country.rb
 - app/models/pattana/application_record.rb
 - app/models/region.rb
+- app/views/kuppayam/api/docs/_navigation.html.erb
 - app/views/layouts/kuppayam/_footer.html.erb
 - app/views/layouts/kuppayam/_header.html.erb
 - app/views/layouts/kuppayam/_navbar.html.erb
 - app/views/layouts/kuppayam/_sidebar.html.erb
 - app/views/layouts/pattana/application.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_country/_neg_case_1.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_country/_pos_case_1.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_region/_neg_case_1.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_region/_neg_case_2.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_region/_neg_case_3.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_region/_pos_case_1.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_region/_pos_case_2.html.erb
+- app/views/pattana/api/v1/docs/countries/_pos_case_1.html.erb
+- app/views/pattana/api/v1/docs/regions/_neg_case_1.html.erb
+- app/views/pattana/api/v1/docs/regions/_pos_case_1.html.erb
 - app/views/pattana/cities/_index.html.erb
 - app/views/pattana/cities/_row.html.erb
 - app/views/pattana/cities/_show.html.erb
@@ -368,6 +385,8 @@ files:
 - app/views/pattana/regions/_row.html.erb
 - app/views/pattana/regions/_show.html.erb
 - app/views/pattana/regions/index.html.erb
+- config/locales/pattana/api.ar.yml
+- config/locales/pattana/api.en.yml
 - config/routes.rb
 - db/master_data/cities.sql
 - db/master_data/countries.sql