pattana 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 759605f6662a7551093ef0a53623c7e6c4dd58ea
-  data.tar.gz: 57236bd2235c8279a2cbb13a13dd73fa7c3dc553
+  metadata.gz: adfb07bf5da7444615c50e71d6c94544f2e0f1e3
+  data.tar.gz: 7551cd69fa0253398532697b39d096a842bb6791
 SHA512:
-  metadata.gz: 0527e845479cd559de18d78baf7045f75f48ef76a5d9810337d9d4f9ca4fe6553df5635916dee5930a98a95e6a288c88ebd89af555a2a9945b6840950d79290d
-  data.tar.gz: 55fc7ceee1a7196084326f29ec11b93381ae8456a3ff6bbb631a43c576ffaaaefd368722212859bca4b74abf46dd74c949961129a30f81c0951334f89432506e
+  metadata.gz: c80ecfda52ba2a395d52d87aa9f274e60435e9b10f8e029efd1e86cd6fd5069d43ced51b917e2aaed230ef772901e20da4dd2ac8d7a08b18eaf11226b9383125
+  data.tar.gz: fe782b0e033bf664a55a340ace4d418806c1a430d48a0cd6c81b9bb16ede93ca53490871627ad9433aa971d4a1a6e44200a7971fc21239bc8e8a913fddb7dd4b

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

@@ -7,9 +7,11 @@ module Pattana
           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
+              @relation = @country.cities.includes(:region, :country).where("cities.show_in_api is true").order("cities.name ASC")
+              @relation = @relation.search(params[:q]) if params[:q]
+              @cities = @relation.all
+              @data = ActiveModelSerializers::SerializableResource.new(@cities, each_serializer: CityPreviewSerializer)
               @success = true
-              @data = @cities
             else
               @success = false
               @errors = {
@@ -28,9 +30,11 @@ module Pattana
               @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
+                  @relation = @region.cities.includes(:region, :country).where("cities.show_in_api is true").order("cities.name ASC")
+                  @relation = @relation.search(params[:q]) if params[:q]
+                  @cities = @relation.all
+                  @data = ActiveModelSerializers::SerializableResource.new(@cities, each_serializer: CityPreviewSerializer)
                   @success = true
-                  @data = @cities
                 else
                   @success = false
                   @errors = {

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

@@ -5,9 +5,11 @@ module Pattana
 
         def index
           proc_code = Proc.new do
-            @countries = Country.where("show_in_api is true").order("name ASC").all
+            @relation = Country.where("countries.show_in_api is true").order("countries.name ASC")
+            @relation = @relation.search(params[:q]) if params[:q]
+            @countries = @relation.all
+            @data = ActiveModelSerializers::SerializableResource.new(@countries, each_serializer: CountryPreviewSerializer)
             @success = true
-            @data = @countries
           end
           render_json_response(proc_code)
         end

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

@@ -18,7 +18,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1"]
+          @examples = ["pos_case_1", "pos_case_2"]
 
           set_nav("docs/countries")
 
@@ -42,7 +42,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1", "neg_case_1"]
+          @examples = ["pos_case_1", "pos_case_2", "neg_case_1"]
 
           set_nav("docs/regions")
 
@@ -66,7 +66,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1", "neg_case_1"]
+          @examples = ["pos_case_1", "pos_case_2", "neg_case_1"]
 
           set_nav("docs/cities_in_a_country")
 

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

@@ -7,9 +7,11 @@ module Pattana
           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
+              @relation = @country.regions.includes(:country).where("regions.show_in_api is true").order("regions.name ASC")
+              @relation = @relation.search(params[:q]) if params[:q]
+              @regions = @relation.all
+              @data = ActiveModelSerializers::SerializableResource.new(@regions, each_serializer: RegionPreviewSerializer)
               @success = true
-              @data = @regions
             else
               @success = false
               @errors = {

data/app/models/city.rb

@@ -1,5 +1,7 @@
 class City < Pattana::ApplicationRecord
   
+  include ActiveModel::Serializers::JSON
+    
   # Constants
   EXCLUDED_JSON_ATTRIBUTES = [:created_at, :updated_at, :show_in_api]
 
@@ -17,15 +19,16 @@ class City < Pattana::ApplicationRecord
   # Class Methods
   # ------------------
 
+  # BACKUP - TODO - REMOVE - TBR
   # 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
+  # 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
 

data/app/serializers/city_preview_serializer.rb

@@ -0,0 +1,8 @@
+class CityPreviewSerializer < ActiveModel::Serializer
+  include NullAttributeReplacer
+  
+  attributes :id, :name, :priority
+  
+  belongs_to :country, serializer: CountryPreviewSerializer
+  belongs_to :region, serializer: RegionPreviewSerializer
+end

data/app/serializers/country_preview_serializer.rb

@@ -0,0 +1,4 @@
+class CountryPreviewSerializer < ActiveModel::Serializer
+  include NullAttributeReplacer
+  attributes :id, :name, :iso_name, :dialing_prefix, :priority
+end

data/app/serializers/region_preview_serializer.rb

@@ -0,0 +1,6 @@
+class RegionPreviewSerializer < ActiveModel::Serializer
+  include NullAttributeReplacer
+  attributes :id, :name, :priority
+  
+  belongs_to :country, serializer: CountryPreviewSerializer
+end

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

@@ -13,26 +13,19 @@ api_output = <<-eos
     {
       "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
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 14,
+          "name": "Abu Dhabi",
+          "priority": 1000
+      }
     },
     .
     .
@@ -40,14 +33,19 @@ api_output = <<-eos
     {
       "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
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 8,
+          "name": "Umm Al Quwain",
+          "priority": 1000
+      }
     }]
 }
 eos

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

@@ -0,0 +1,63 @@
+<%
+
+api_title = "Positive Case - 2 - should search cities in a country"
+
+api_input = <<-eos
+{
+  "q": "<Search Query>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": [
+    {
+      "id": 21,
+      "name": "Abu Dhabi",
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 14,
+          "name": "Abu Dhabi",
+          "priority": 1000
+      }
+    },
+    .
+    .
+    .
+    {
+      "id": 8,
+      "name": "Umm al Qaywayn",
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 8,
+          "name": "Umm Al Quwain",
+          "priority": 1000
+      }
+    }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_2",
+                                        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

@@ -10,8 +10,8 @@ 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."
+    "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

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

@@ -1,6 +1,6 @@
 <%
 
-api_title = "Negative Case - 2 - should show errors if a valid country id is not passed"
+api_title = "Negative Case - 2 - should show errors if a valid region id is not passed"
 
 api_input = <<-eos
 {}
@@ -20,7 +20,7 @@ eos
 
 <%= render partial: "kuppayam/api/docs/example", locals: {
                                         negative_case: true,
-                                        example_id: "neg_case_1",
+                                        example_id: "neg_case_2",
                                         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

@@ -1,6 +1,6 @@
 <%
 
-api_title = "Negative Case - 3 - should show errors if a valid country id is not passed"
+api_title = "Negative Case - 3 - should show errors if region id and country id doesn't match"
 
 api_input = <<-eos
 {}
@@ -20,7 +20,7 @@ eos
 
 <%= render partial: "kuppayam/api/docs/example", locals: {
                                         negative_case: true,
-                                        example_id: "neg_case_1",
+                                        example_id: "neg_case_3",
                                         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

@@ -1,6 +1,6 @@
 <%
 
-api_title = "Positive Case - 1 - should return all the cities in a country"
+api_title = "Positive Case - 1 - should return all the cities in a region"
 
 api_input = <<-eos
 {}
@@ -13,26 +13,19 @@ api_output = <<-eos
     {
       "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
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 14,
+          "name": "Abu Dhabi",
+          "priority": 1000
+      }
     },
     .
     .
@@ -40,14 +33,19 @@ api_output = <<-eos
     {
       "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
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 8,
+          "name": "Umm Al Quwain",
+          "priority": 1000
+      }
     }]
 }
 eos

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

@@ -1,9 +1,11 @@
 <%
 
-api_title = "Positive Case - 2 - should return all the cities in a region"
+api_title = "Positive Case - 1 - should search cities in a region"
 
 api_input = <<-eos
-{}
+{
+  "q": "<Search Query>"
+}
 eos
 
 api_output = <<-eos
@@ -13,26 +15,19 @@ api_output = <<-eos
     {
       "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
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 14,
+          "name": "Abu Dhabi",
+          "priority": 1000
+      }
     },
     .
     .
@@ -40,14 +35,19 @@ api_output = <<-eos
     {
       "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
+      "priority": 1000,
+      "country": {
+          "id": 235,
+          "name": "United Arab Emirates",
+          "iso_name": "UNITED ARAB EMIRATES",
+          "dialing_prefix": "971",
+          "priority": 1000
+      },
+      "region": {
+          "id": 8,
+          "name": "Umm Al Quwain",
+          "priority": 1000
+      }
     }]
 }
 eos
@@ -56,7 +56,7 @@ eos
 
 <%= render partial: "kuppayam/api/docs/example", locals: {
                                         negative_case: false,
-                                        example_id: "pos_case_1",
+                                        example_id: "pos_case_2",
                                         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

@@ -11,45 +11,17 @@ 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",
+            "id": 100,
+            "name": "India",
+            "iso_name": "INDIA",
+            "dialing_prefix": "91",
             "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
         },
         .
@@ -58,22 +30,8 @@ api_output = <<-eos
         {
             "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
         }]
 }

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

@@ -0,0 +1,50 @@
+<%
+
+api_title = "Positive Case - 2 - should search countries"
+
+api_input = <<-eos
+{
+  "q": "<Search Query>"
+}
+eos
+
+api_output = <<-eos
+{
+    "success": true,
+    "data": [
+        {
+            "id": 100,
+            "name": "India",
+            "iso_name": "INDIA",
+            "dialing_prefix": "91",
+            "priority": 1000
+        },
+        {
+            "id": 2,
+            "name": "Albania",
+            "iso_name": "ALBANIA",
+            "dialing_prefix": "355",
+            "priority": 1000
+        },
+        .
+        .
+        .
+        {
+            "id": 246,
+            "name": "Zimbabwe",
+            "iso_name": "ZIMBABWE",
+            "dialing_prefix": "263",
+            "priority": 1000
+        }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_2",
+                                        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

@@ -11,34 +11,43 @@ api_output = <<-eos
   "success": true,
   "data": [
     {
-      "id": 8,
-      "name": "Umm Al Quwain",
-      "iso_code": "AE-07",
-      "country_id": 235,
-      "latitude": "",
-      "longitude": "",
-      "priority": 1000
+      "id": 1329,
+      "name": "Andaman and Nicobar Islands",
+      "priority": 1000,
+      "country": {
+        "id": 100,
+        "name": "India",
+        "iso_name": "INDIA",
+        "dialing_prefix": "91",
+        "priority": 1000
+      }
     },
     {
-      "id": 9,
-      "name": "Ras Al Khaimah",
-      "iso_code": "AE-05",
-      "country_id": 235,
-      "latitude": "",
-      "longitude": "",
-      "priority": 1000
+      "id": 1328,
+      "name": "Andhra Pradesh",
+      "priority": 1000,
+      "country": {
+        "id": 100,
+        "name": "India",
+        "iso_name": "INDIA",
+        "dialing_prefix": "91",
+        "priority": 1000
+      }
     },
     .
     .
     .
     {
-      "id": 13,
-      "name": "Ajman",
-      "iso_code": "AE-02",
-      "country_id": 235,
-      "latitude": "25.41222",
-      "longitude": "55.434738",
-      "priority": 1000
+      "id": 1332,
+      "name": "Uttaranchal",
+      "priority": 1000,
+      "country": {
+        "id": 100,
+        "name": "India",
+        "iso_name": "INDIA",
+        "dialing_prefix": "91",
+        "priority": 1000
+      }
     }]
 }
 eos

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

@@ -0,0 +1,65 @@
+<%
+
+api_title = "Positive Case - 1 - should return search regions in a country"
+
+api_input = <<-eos
+{
+  "q": "<Search Query>"
+}
+eos
+
+api_output = <<-eos
+{
+  "success": true,
+  "data": [
+    {
+      "id": 1329,
+      "name": "Andaman and Nicobar Islands",
+      "priority": 1000,
+      "country": {
+        "id": 100,
+        "name": "India",
+        "iso_name": "INDIA",
+        "dialing_prefix": "91",
+        "priority": 1000
+      }
+    },
+    {
+      "id": 1328,
+      "name": "Andhra Pradesh",
+      "priority": 1000,
+      "country": {
+        "id": 100,
+        "name": "India",
+        "iso_name": "INDIA",
+        "dialing_prefix": "91",
+        "priority": 1000
+      }
+    },
+    .
+    .
+    .
+    {
+      "id": 1332,
+      "name": "Uttaranchal",
+      "priority": 1000,
+      "country": {
+        "id": 100,
+        "name": "India",
+        "iso_name": "INDIA",
+        "dialing_prefix": "91",
+        "priority": 1000
+      }
+    }]
+}
+eos
+
+%>
+
+<%= render partial: "kuppayam/api/docs/example", locals: {
+                                        negative_case: false,
+                                        example_id: "pos_case_2",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

data/lib/pattana/engine.rb

@@ -6,6 +6,7 @@ module Pattana
     require 'kuppayam'
     require 'colorize'
     require 'colorized_string'
+    require 'active_model_serializers'
     
     isolate_namespace Pattana
 

data/lib/pattana/version.rb

@@ -1,3 +1,3 @@
 module Pattana
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattana
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - kpvarma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,20 +84,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: kuppayam
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.12
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.12
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.13
 - !ruby/object:Gem::Dependency
   name: bcrypt
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +146,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -181,25 +215,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
-  name: rmagick
+  name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.3
+        version: 4.8.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.2
+        version: 4.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.3
+        version: 4.8.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.2
+        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -352,6 +386,9 @@ files:
 - app/models/country.rb
 - app/models/pattana/application_record.rb
 - app/models/region.rb
+- app/serializers/city_preview_serializer.rb
+- app/serializers/country_preview_serializer.rb
+- app/serializers/region_preview_serializer.rb
 - app/views/kuppayam/api/docs/_navigation.html.erb
 - app/views/layouts/kuppayam/_footer.html.erb
 - app/views/layouts/kuppayam/_header.html.erb
@@ -360,14 +397,17 @@ files:
 - 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_country/_pos_case_2.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/countries/_pos_case_2.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/api/v1/docs/regions/_pos_case_2.html.erb
 - app/views/pattana/cities/_form.html.erb
 - app/views/pattana/cities/_index.html.erb
 - app/views/pattana/cities/_row.html.erb