pattana 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20fbeb2cea82de92dca7a281bdf57858e0c4d783
-  data.tar.gz: 0b1426f02942eadba4da74e25e909d37c973e537
+  metadata.gz: 6d191b186ccf58e2094dad4b6c5c3087596acd7b
+  data.tar.gz: ca76b41cafef4b27c4dfb5bf73ef268819d46ed0
 SHA512:
-  metadata.gz: ed053f2033dd03e90f4792b7290dba27aa06953579fd3c750d23ff979f1b707b2725103984234c9f5d91148119c69a27598765b465b3dfbfd3925876339e0a6b
-  data.tar.gz: 30cc1b565204f77801b35b64b11dbccc0336e61899fe2874f033d2648cac0cb9e5f4b8fdd24dbc1c8b91d365cd8c19f9789808f1a2accbbe74c9afd64071de6c
+  metadata.gz: 5a783ee301a8750c1b42981245cb5ce6c34cc9af45223400ddef74da56b02496603602be5ff3e7777642988a53476a1acb3d9c6e04b72f6d7dbdf740acfe29e8
+  data.tar.gz: 6332ae96eca914d63055208eec7d56a828d7ced81ddb5288ca8aa99759eb85b8d1cf7a0c827a84686ca8dc1fab9eac1e8ae4c9460d4f3e4f011e90ade9748a0f

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

@@ -9,6 +9,7 @@ module Pattana
             if @country
               @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]
+              @relation = @relation.operational if params[:operational] && ["y","t","yes","true",1].include?(params[:operational].downcase)
               @cities = @relation.all
               @data = ActiveModelSerializers::SerializableResource.new(@cities, each_serializer: CityPreviewSerializer)
               @success = true
@@ -29,6 +30,7 @@ module Pattana
             if @region
               @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]
+              @relation = @relation.operational if params[:operational] && ["y","t","yes","true",1].include?(params[:operational].downcase)
               @cities = @relation.all
               @data = ActiveModelSerializers::SerializableResource.new(@cities, each_serializer: CityPreviewSerializer)
               @success = true

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

@@ -5,8 +5,9 @@ module Pattana
 
         def index
           proc_code = Proc.new do
-            @relation = Country.where("countries.show_in_api is true").order("countries.name ASC")
+            @relation = Country.show_in_api.order("countries.name ASC")
             @relation = @relation.search(params[:q]) if params[:q]
+            @relation = @relation.operational if params[:operational] && ["y","t","yes","true",1].include?(params[:operational].downcase)
             @countries = @relation.all
             @data = ActiveModelSerializers::SerializableResource.new(@countries, each_serializer: CountryPreviewSerializer)
             @success = true

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

@@ -21,7 +21,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1", "pos_case_2"]
+          @examples = ["pos_case_1", "pos_case_2", "pos_case_3", "pos_case_4"]
 
           set_nav("docs/countries")
 
@@ -49,7 +49,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1", "pos_case_2", "neg_case_1"]
+          @examples = ["pos_case_1", "pos_case_2", "pos_case_3", "pos_case_4", "neg_case_1"]
 
           set_nav("docs/regions")
 
@@ -78,7 +78,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1", "pos_case_2", "neg_case_1"]
+          @examples = ["pos_case_1", "pos_case_2", "pos_case_3", "pos_case_4", "neg_case_1"]
 
           set_nav("docs/cities_in_a_country")
 
@@ -107,7 +107,7 @@ module Pattana
           }
 
           @example_path = "pattana/api/v1/docs/"
-          @examples = ["pos_case_1", "pos_case_2", "neg_case_1"]
+          @examples = ["pos_case_1", "pos_case_2", "pos_case_3", "pos_case_4", "neg_case_1"]
 
           set_nav("docs/cities_in_a_region")
 

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

@@ -9,6 +9,7 @@ module Pattana
             if @country
               @relation = @country.regions.includes(:country).where("regions.show_in_api is true").order("regions.name ASC")
               @relation = @relation.search(params[:q]) if params[:q]
+              @relation = @relation.operational if params[:operational] && ["y","t","yes","true",1].include?(params[:operational].downcase)
               @regions = @relation.all
               @data = ActiveModelSerializers::SerializableResource.new(@regions, each_serializer: RegionPreviewSerializer)
               @success = true

data/app/models/city.rb

@@ -46,6 +46,7 @@ class City < Pattana::ApplicationRecord
                                          LOWER(cities.iso_code) LIKE LOWER('%#{query}%')")}
 
   scope :show_in_api, -> { where(show_in_api: true) }
+  scope :operational, -> { where(operational: true) }
 
   # Import Methods
   

data/app/models/country.rb

@@ -40,6 +40,7 @@ class Country < Pattana::ApplicationRecord
                                         LOWER(iso_alpha_3) LIKE LOWER('%#{query}%')")}
 
   scope :show_in_api, -> { where(show_in_api: true) }
+  scope :operational, -> { where(operational: true) }
 
   # Import Methods
 

data/app/models/region.rb

@@ -34,6 +34,7 @@ class Region < Pattana::ApplicationRecord
   scope :search, lambda {|query| joins("INNER JOIN countries co on co.id = regions.country_id").where("LOWER(regions.name) LIKE LOWER('%#{query}%') || LOWER(regions.iso_code) LIKE LOWER('%#{query}%') || LOWER(co.name) LIKE LOWER('%#{query}%')")}
 
   scope :show_in_api, -> { where(show_in_api: true) }
+  scope :operational, -> { where(operational: true) }
 
   # Import Methods
 

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

@@ -0,0 +1,64 @@
+<%
+
+api_title = "Positive Case - 3 - should return cities in a particular country which are operational"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/countries/235?operational=true
+This will return only the operational cities in the country with id 235
+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_3",
+                                        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_4.html.erb

@@ -0,0 +1,64 @@
+<%
+
+api_title = "Positive Case - 4 - should search for cities in a particular country which are operational"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/countries/235?operational=true&cy=ode
+This will search for operational cities in the country with id 235 for the keyword 'ode' and will return matching results
+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_4",
+                                        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

@@ -1,6 +1,6 @@
 <%
 
-api_title = "Positive Case - 1 - should search cities in a region"
+api_title = "Positive Case - 2 - should search cities in a region"
 
 api_input = <<-eos
 Example:

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

@@ -0,0 +1,64 @@
+<%
+
+api_title = "Positive Case - 3 - should return operational cities in a region"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/regions/1403?operational=true
+This will return only the operational cities in the region with id 1403
+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_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_4.html.erb

@@ -0,0 +1,64 @@
+<%
+
+api_title = "Positive Case - 4 - should search cities in a region"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/regions/1403?operational=true&q=ode
+This will search for operational cities in the region with id 1403 for the keyword 'ode' and will return matching results
+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_4",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,51 @@
+<%
+
+api_title = "Positive Case - 3 - should return operational countries"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/countries?operational=true
+This will return only the operational countries
+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_3",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,51 @@
+<%
+
+api_title = "Positive Case - 4 - should search operational countries"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/countries?operationa=true&q=Ind
+This will search for operational countries for the keyword 'Ind' and will return matching results
+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_2.html.erb

@@ -1,6 +1,6 @@
 <%
 
-api_title = "Positive Case - 1 - should return search regions in a country"
+api_title = "Positive Case - 2 - should return search regions in a country"
 
 api_input = <<-eos
 Example:

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

@@ -0,0 +1,66 @@
+<%
+
+api_title = "Positive Case - 3 - should return search regions in a country"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/235/regions?operational=true
+This will return only the operational regions
+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_3",
+                                        api_title: api_title,
+                                        api_input: api_input,
+                                        api_output: api_output 
+                                      } %>

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

@@ -0,0 +1,66 @@
+<%
+
+api_title = "Positive Case - 4 - should return search operational regions in a country"
+
+api_input = <<-eos
+Example:
+
+GET #{request.base_url}/api/v1/235/regions?operational=true&q=Dub
+This will search for operational regions in the country with id 235 for the keyword 'Dub' and will return matching results
+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/app/views/pattana/dashboard/index.html.erb

@@ -60,4 +60,13 @@
 	
 </div>
 
-<div style="border-top:1px solid #FFF;margin-top:50px;margin-bottom:70px;"></div>
+<div style="border-top:1px solid #FFF;margin-top:50px;margin-bottom:70px;"></div>
+
+
+<div class="dx-warning">
+	<div>
+		<h2>Pattana - API Documentation</h2>
+		<p>All APIs are documented with all cases and examples.</p>
+		<a class="btn btn-success" href="/docs/api/v1/register" target="_blank">Go to the API Documentation</a>
+	</div>
+</div>

data/lib/pattana/version.rb

@@ -1,3 +1,3 @@
 module Pattana
-  VERSION = '0.1.10'
+  VERSION = '0.1.11'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattana
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - kpvarma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -398,14 +398,22 @@ files:
 - 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_country/_pos_case_3.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_country/_pos_case_4.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/_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/cities_in_a_region/_pos_case_3.html.erb
+- app/views/pattana/api/v1/docs/cities_in_a_region/_pos_case_4.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/countries/_pos_case_3.html.erb
+- app/views/pattana/api/v1/docs/countries/_pos_case_4.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/api/v1/docs/regions/_pos_case_3.html.erb
+- app/views/pattana/api/v1/docs/regions/_pos_case_4.html.erb
 - app/views/pattana/cities/_form.html.erb
 - app/views/pattana/cities/_index.html.erb
 - app/views/pattana/cities/_row.html.erb