timezone_teleporter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ded83de005cb6eed43b3a9d76d7db0e6db9c21c79350a1fd851eb3f9564ed53e
-  data.tar.gz: efba91128741f1cbd0ee1cd5549047569e4fbc14c5cac8cfd382aa195502af92
+  metadata.gz: 4793314fdb8c13a7af74a3647a6839eafe2d4ee87222878dcda7090035284b2e
+  data.tar.gz: 1f614d3ea16f76c320740dfb7945b4abab6c74829230f643337ef321c0842f35
 SHA512:
-  metadata.gz: 95371547b81491290c35e0bb000e250b40825423f1591b9b5b41e10015380d46b1eda2c084a781421f55b97dc605786eb77eebc1e56fa2a9ac4e6293e8d45c58
-  data.tar.gz: 795f94b0ed67791cd46a1873457584ac79115f8c64bb8161357e079751fa0f73680721b9e18d632fd9e540804ff9e7d625e679baeacc92b6986d6597a60ff0d6
+  metadata.gz: 6f1bb4c295cb22006ced5e929a28d841fcc17fa3d2af73b9acdd70ee85f36e900e4d3b1a2cb2c564d610147ca382ed5327123f339ee17a76b604acdd6e923e8c
+  data.tar.gz: 865bcf801a341c6355962d3b113c622a6d6c910abf9da75d121765bfa73227880698592841f714e23a2d25e444da48abbdf74c123adc417cf6ac8bc958747da5

data/README.md

@@ -28,7 +28,7 @@ TimezoneTeleporter can be configured in an initializer:
 
 ```ruby
 TimezoneTeleporter.configure do |c|
-  c.silent_exceptions       = false
+  c.silent_exceptions       = true
   c.use_proximity_algorithm = true
   c.delta_degree            = 1
 end
@@ -36,30 +36,35 @@ end
 
 Use following configuration flags to customise the library's behaviour:
 
-* `silent_exceptions`: if set to true, no errors are raised (default is false),
+* `silent_exceptions`: if set to true, no errors are raised and `teleport` returns nil in case no location could be found (default is true),
 * `use_proximity_algorithm`: if the timezone is not found, TimezoneTeleporter tries to find the closest timezone within +-1 delta_degree longitude and +-1 delta_degree latitude (default is true),
 * `delta_degree`: defines the radius for the proximity algorithm (default is 1).
 
 ### Usage
 
-##### Teleport with coordinates
-Use `TimezoneTeleporter.teleport(lat, lng)` to generate randomized coordinates inside the same time zone by passing coordinates:
+##### Teleport with coordinates or timezone
+Use `TimezoneTeleporter.teleport(lat, lng)` or `TimezoneTeleporter.teleport(timezone)` to generate randomized coordinates inside the same time zone by passing coordinates:
 
 ```ruby
 TimezoneTeleporter.teleport(52.520007, 13.404954)
 # => [51.165691, 10.451526]
 ```
-*Note: If time zone is not found, `TimezoneTeleporter.teleport` will return the origin coordinates if silent_exceptions is set to true.*
-
-##### Teleport with time zone
-Use `TimezoneTeleporter.teleport(timezone)` to generate randomized coordinates inside the same time zone by passing a time zone:
 
 ```ruby
 TimezoneTeleporter.teleport("Europe/Berlin")
 # => [51.165691, 10.451526]
 ```
-*Note: If time zone is not found, `TimezoneTeleporter.teleport` will return nil if silent_exceptions is set to true.*
 
+**Note: If time zone is not found, `TimezoneTeleporter.teleport` will return nil if silent_exceptions is set to true.**
+
+To get the best result, use both versions together with silent exceptions:
+
+```ruby
+TimezoneTeleporter.configure { |c| c.silent_exceptions = true }
+
+TimezoneTeleporter.teleport("Europe/Berlin") || TimezoneTeleporter.teleport(52.520007, 13.404954)
+# => [51.165691, 10.451526]
+```
 
 ## Development
 

data/lib/timezone_teleporter.rb

@@ -29,8 +29,6 @@ module TimezoneTeleporter
       teleport_timezone(timezone_at(lat, lng))
     rescue StandardError => e
       raise e unless configuration.silent_exceptions
-
-      [lat, lng]
     end
 
     def teleport_timezone(timezone)

data/lib/timezone_teleporter/configuration.rb

@@ -7,7 +7,7 @@ module TimezoneTeleporter
     attr_accessor :delta_degree
 
     def initialize
-      @silent_exceptions = false
+      @silent_exceptions = true
       @use_proximity_algorithm = true
       @delta_degree = 1
     end

data/lib/timezone_teleporter/timezone_locations.rb

@@ -2,6 +2,14 @@
 
 module TimezoneTeleporter
   TIMEZONE_LOCATIONS = {
+    "Asia/Yangon" => [
+      "16.7833",
+      "96.1667"
+    ],
+    "Asia/Famagusta" => [
+      "35.0375",
+      "33.9833"
+    ],
     "Indian/Mauritius" => [
       -20.348404,
       57.55215200000001

data/lib/timezone_teleporter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TimezoneTeleporter
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timezone_teleporter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ole Richter
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: timezone_finder