city_utc 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9e1ce9b68125ef57c5f00a5f4ff372e851d76c4
-  data.tar.gz: 01dba33affe44d348cc00b09b7516629cd55b6e5
+  metadata.gz: c2343450636306b04bfae4726b8798130c95eaac
+  data.tar.gz: 8172d54d3305360d3a9d0d6ac50af16318853363
 SHA512:
-  metadata.gz: 92e90ee4e18720738e8903834facd3295195f214c95352c61a1e70460d1e45bf8a8d0e1f25ee9fe583d36427477a15aa4e7ca791bddcf0c7d6873408fbb0e46b
-  data.tar.gz: 9825559d32534fc920875ededc2ac42664a0bae23504d15aefe756b73d4933c7fb4ac3d938d29e60bd5b65394a01ced7ac7cab175a3d9516c1b4bdae4a1426f4
+  metadata.gz: 342d51d9e8e424cfee494bb53436d03ddcefe682d0a1fe92c9039dc8e66b921d861f31738404f531395370ab8f31b189be85ddd219fbd8f4bd4d3b2829e883c7
+  data.tar.gz: 69ef914f7e8f1d7f26b451b0704a120dd1803302680824382c987a6d3e9cce0d66bbf51887bd273fbf7f159caef7fe6b953bc484c3f78b2fff4098243ef5d457

data/sources/city_utc/models/city.rb

@@ -4,12 +4,12 @@ module CityUTC
   # == Schema for `cities` table
   #
   #   CREATE TABLE `cities` (
-  #     `id`	INTEGER PRIMARY KEY AUTOINCREMENT,
-  #     `city`	TEXT,
-  #     `country`	TEXT,
-  #     `latitude`	REAL,
-  #     `longitude`	REAL,
-  #     `population`	INTEGER,
+  #     `id`	          INTEGER PRIMARY KEY AUTOINCREMENT,
+  #     `city`	        TEXT,
+  #     `country`	      TEXT,
+  #     `latitude`	    REAL,
+  #     `longitude`	    REAL,
+  #     `population`	  INTEGER,
   #     `timezone_code`	INTEGER
   #   );
   class City < Sequel::Model

data/sources/city_utc/models/timezone.rb

@@ -5,7 +5,7 @@ module CityUTC
   #
   #   CREATE TABLE `timezones` (
   # 	  `timezone`	TEXT,
-  # 	  `code`	INTEGER,
+  # 	  `code`	    INTEGER,
   # 	  PRIMARY KEY(`code`)
   #   );
   class Timezone < Sequel::Model

data/sources/city_utc/sqlite.rb

@@ -12,16 +12,15 @@ module CityUTC
     private_class_method :restore_database
 
     def self.restorable?  # no-doc
-      archive  = File.join(__dir__, '..', 'database', 'sqlite.db.gz')
-      database = File.join(__dir__, '..', 'database', 'sqlite.db')
+      path_to_archive  = File.join(__dir__, '..', 'database', 'sqlite.db.gz')
+      path_to_database = File.join(__dir__, '..', 'database', 'sqlite.db')
 
-      File.exist?(archive) && !File.exist?(database)
+      File.exist?(path_to_archive) && !File.exist?(path_to_database)
     end
     private_class_method :restorable?
 
     def self.connect_to_db # no-doc
-      path_to_database =
-        File.join(__dir__, '..', 'database', 'sqlite.db')
+      path_to_database = File.join(__dir__, '..', 'database', 'sqlite.db')
 
       Sequel.connect "sqlite://#{path_to_database}"
     end

data/sources/city_utc/utc_time.rb

@@ -28,8 +28,8 @@ module CityUTC
     # Presents time instance as pretty formatted string.
     #
     # @example
-    #   time # ==> 2017-01-13 12:37:34 UTC
-    #   formatted(time) # ==> "UTC: 2017-01-13 12:37:34"
+    #   time                   # ==> 2017-01-13 12:37:34 UTC
+    #   pretty_formatted(time) # ==> "UTC: 2017-01-13 12:37:34"
     #
     # @param [Time] time
     #

data/spec/integration/city_utc_db_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require 'spec_helper'
 
-describe "As database." do
+describe "As database" do
   it 'it creates valid Sequel::Model relation for Cities table' do
     cities = CityUTC::City
 
@@ -12,4 +12,4 @@ describe "As database." do
                  .to_a.collect(&:city)
     ).to contain_exactly "tokyo", "shanghai", "bombay"
   end
-end # describe "As database."
+end # describe "As database"

data/spec/integration/city_utc_web_spec.rb

@@ -4,7 +4,7 @@ require 'net/http'
 
 # To pass this tests launch the server!
 # TODO add rspec helper to check server state and launch up when s isn't started
-describe "As Web Server." do
+describe "As web application" do
   context 'When client sends valid request' do
     it 'returns time' do
       uri = URI('http://127.0.0.1/time?')
@@ -43,7 +43,7 @@ describe "As Web Server." do
 
       expect(response.body).to match /UNKNOWN/
     end
-  end # context 'valid request'
+  end # context 'When client sends valid request'
 
   # ----------------------------------------------------
 
@@ -59,5 +59,5 @@ describe "As Web Server." do
       expect(response.body)
         .to match /Please use get http request for 'time' api endpoint/
     end
-  end # context 'invalid request'
-end # describe "As Web Server. When client sends"
+  end # context 'When client sends invalid request'
+end # describe "As web application"

data/spec/tserver/utc_time_spec.rb

@@ -8,7 +8,7 @@ module CityUTC
       allow(Time).to receive(:now).and_return local_time
     end
 
-    context '#by_location' do
+    context '#for_city' do
       it "returns +'UNKNOWN'+ when +:local_location+ unrecognized" do
         expect(described_class.for_city('there_is_no_city_with_dat_name'))
           .to be_eql "UNKNOWN"
@@ -29,11 +29,11 @@ module CityUTC
         expect(described_class.for_city('Ufa').to_s)
           .to be_eql("Ufa: 2015-04-11 15:30:50")
       end
-    end # context '#by_location'
+    end # context '#for_city'
 
     # ----------------------------------------------------
 
-    context '#formatted' do
+    context '#pretty_formatted' do
       it 'presents time as expected(formatted string)' do
         expect(described_class.pretty_formatted(Time.now.utc))
           .to be_eql("UTC: 2015-04-11 10:30:50")
@@ -43,6 +43,6 @@ module CityUTC
         expect(described_class.pretty_formatted(Time.now.utc, "PREFIX"))
           .to be_eql("PREFIX: 2015-04-11 10:30:50")
       end
-    end # context '#formatted'
+    end # context '#pretty_formatted'
   end # describe CityUTC
 end # module CityUTC

data/tasks/database.rake

@@ -1,17 +1,19 @@
 # encoding: utf-8
 # frozen_string_literal: true
-desc 'Restores database'
-task :restore_database! do
-  path_to_folder = File.join(__dir__, "..", "sources", "database")
-  path_to_database = File.join(path_to_folder, 'sqlite.db.gz')
+namespace :development do
+  desc 'Restores database'
+  task :restore_database! do
+    path_to_folder = File.join(__dir__, "..", "sources", "database")
+    path_to_database = File.join(path_to_folder, 'sqlite.db.gz')
 
-  Kernel.system "gzip -d #{path_to_database} #{path_to_folder}"
-end
+    Kernel.system "gzip -d #{path_to_database} #{path_to_folder}"
+  end
 
-desc 'Compresses database'
-task :compress_database! do
-  path_to_folder = File.join(__dir__, "..", "sources", "database")
-  path_to_database = File.join(path_to_folder, 'sqlite.db')
+  desc 'Compresses database'
+  task :compress_database! do
+    path_to_folder = File.join(__dir__, "..", "sources", "database")
+    path_to_database = File.join(path_to_folder, 'sqlite.db')
 
-  Kernel.system "gzip -k #{path_to_database} #{path_to_folder}"
-end
+    Kernel.system "gzip -k #{path_to_database} #{path_to_folder}"
+  end
+end # namespace :development

data/tasks/server.rake

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # frozen_string_literal: true
-desc 'Launches web-server (CityUTC#WebServer)'
-task :launch_web_server! do
+desc 'Launches web-server for CityUTC'
+task :launch_city_utc_web_app! do
   settings = [
     '--max-conns 2048',
     '--address 127.0.0.1',

data/tasks/timezones_converter.rake

@@ -1,45 +1,47 @@
 # encoding: utf-8
 # frozen_string_literal: true
-desc "DEVELOPMENT ONLY !!! (Requests ruby >= 2.4.0"             \
-     "Creates two csv files for later import into sqlite db. "  \
-     "Original file can been downloaded by following link: "    \
-     "http://download.maxmind.com/download/worldcities/worldcitiespop.txt.gz"
-# Note for csv to sqlite.db converting 'DB Browser for SQLite' was used.
-task :prepare_for_import_to_db do
-  require 'csv'
-  require 'nearest_time_zone' # TODO remove dependency with original csv database
-  require 'timezone'
+namespace :development do
+  desc "Note: requests ruby >= 2.4.0"                             \
+       "Creates two csv files for later import into sqlite db. "  \
+       "Original file can been downloaded by following link: "    \
+       "http://download.maxmind.com/download/worldcities/worldcitiespop.txt.gz"
+  # Note for csv to sqlite.db converting 'DB Browser for SQLite' was used.
+  task :prepare_for_import_to_db do
+    require 'csv'
+    require 'nearest_time_zone' # TODO remove dependency with original csv database
+    require 'timezone'
 
-  origin_csv = File.join(__dir__, '..', 'tmp', 'worldcitiespop.txt')
-  timezone_mapping = Hash.new
+    origin_csv = File.join(__dir__, '..', 'tmp', 'worldcitiespop.txt')
+    timezone_mapping = Hash.new
 
-  zones = Timezone.names.sort_by &:to_s
-  zones.each_with_index { |zone, index| timezone_mapping[zone] = index }
+    zones = Timezone.names.sort_by &:to_s
+    zones.each_with_index { |zone, index| timezone_mapping[zone] = index }
 
-  list = []
-  CSV.foreach(origin_csv, encoding: 'iso-8859-1:utf-8', headers: true,
-              liberal_parsing: true) do |row|
+    list = []
+    CSV.foreach(origin_csv, encoding: 'iso-8859-1:utf-8', headers: true,
+                liberal_parsing: true) do |row|
 
-    city_name  = row.fetch("City")
-    country    = row.fetch("Country")
-    lat        = row.fetch("Latitude").to_f.round(3)
-    lng        = row.fetch("Longitude").to_f.round(3)
-    population = row.fetch("Population").to_i
-    timezone   = NearestTimeZone.to(lat, lng)
+      city_name  = row.fetch("City")
+      country    = row.fetch("Country")
+      lat        = row.fetch("Latitude").to_f.round(3)
+      lng        = row.fetch("Longitude").to_f.round(3)
+      population = row.fetch("Population").to_i
+      timezone   = NearestTimeZone.to(lat, lng)
 
-    list << [ city_name, country, lat, lng,
-              population, timezone_mapping[timezone] ]
-  end
+      list << [ city_name, country, lat, lng,
+                population, timezone_mapping[timezone] ]
+    end
 
-  path_to_mapping = File.join(__dir__, '..', 'tmp', 'timezones.csv')
-  CSV.open(path_to_mapping , "wb") do |csv|
-    csv << ["timezone", "code"]
-    timezone_mapping.each_pair { |key, value| csv << [key, value] }
-  end
+    path_to_mapping = File.join(__dir__, '..', 'tmp', 'timezones.csv')
+    CSV.open(path_to_mapping , "wb") do |csv|
+      csv << ["timezone", "code"]
+      timezone_mapping.each_pair { |key, value| csv << [key, value] }
+    end
 
-  path_to_new_csv = File.join(__dir__, '..', 'tmp', 'cities.csv')
-  CSV.open(path_to_new_csv, "wb") do |csv|
-    csv << ["city", "country", "latitude", "longitude", "population", "timezone_code"]
-    list.each { |row| csv << row }
+    path_to_new_csv = File.join(__dir__, '..', 'tmp', 'cities.csv')
+    CSV.open(path_to_new_csv, "wb") do |csv|
+      csv << ["city", "country", "latitude", "longitude", "population", "timezone_code"]
+      list.each { |row| csv << row }
+    end
   end
-end
+end # namespace :development

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: city_utc
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Kuzichev Michael
@@ -133,7 +133,7 @@ homepage: https://github.com/Medvedu/City-UTC
 licenses:
 - MIT
 metadata: {}
-post_install_message: Sqlite
+post_install_message: 
 rdoc_options: []
 require_paths:
 - sources
@@ -152,9 +152,11 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: This project consist of two parts. First part includes sqlite database with
-  two tables (see Readme.md for details) with cities, coordinates and timezones. Second
-  part is thin (web) application for work with the database.
+summary: 'This project consist of two parts First part includes sqlite database with
+  two tables based on worldcitiespop.csv (http://download.maxmind.com/download/):
+  cities(city, country, latitude, longitude, population, timezone_code) timezones(timezone,
+  code)  Second part is sinatra (web) application for work with the database throw
+  Sequel ORM.'
 test_files:
 - spec/tserver/utc_time_spec.rb
 - spec/spec_helper.rb