timezone_teleporter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9da1e3774d2eb580162d1c13189efb3a2047c1b6079dc81054cc89d70b66121d
-  data.tar.gz: 98a0b6c484c8645a9b520a65e9610fc1d32413233daba91846e432721e1ce16f
+  metadata.gz: ded83de005cb6eed43b3a9d76d7db0e6db9c21c79350a1fd851eb3f9564ed53e
+  data.tar.gz: efba91128741f1cbd0ee1cd5549047569e4fbc14c5cac8cfd382aa195502af92
 SHA512:
-  metadata.gz: ca47460fb521caac37437bda0b8a1beac34e7c183244d4455f791415924cd256c08e636dd8b40ebdbaf02004b5b5ca2768d3c2ad20665857bc578f8d6085fe43
-  data.tar.gz: c6a2491299f178fe1914c4bdee84278f33cc0696df508484e539fd470b662ac8d13d11c699389a1fccf015946a2d2f2f7c32e435dbbe2673abce9c3febf10c68
+  metadata.gz: 95371547b81491290c35e0bb000e250b40825423f1591b9b5b41e10015380d46b1eda2c084a781421f55b97dc605786eb77eebc1e56fa2a9ac4e6293e8d45c58
+  data.tar.gz: 795f94b0ed67791cd46a1873457584ac79115f8c64bb8161357e079751fa0f73680721b9e18d632fd9e540804ff9e7d625e679baeacc92b6986d6597a60ff0d6

data/README.md

@@ -7,7 +7,6 @@ TimezoneTeleporter anonymizes users' GPS coordinates by generating random coordi
 ## Dependencies
 
 * Uses the gem [timezone_finder](https://github.com/gunyarakun/timezone_finder) for time zone lookup.
-* Uses the gem [timezone](https://github.com/panthomakos/timezone).
 
 ## Installation
 
@@ -29,7 +28,7 @@ TimezoneTeleporter can be configured in an initializer:
 
 ```ruby
 TimezoneTeleporter.configure do |c|
-  c.silent_mode             = false
+  c.silent_exceptions       = false
   c.use_proximity_algorithm = true
   c.delta_degree            = 1
 end
@@ -37,20 +36,30 @@ end
 
 Use following configuration flags to customise the library's behaviour:
 
-* `silent_mode`: if set to true, no errors are raised (default is false),
+* `silent_exceptions`: if set to true, no errors are raised (default is false),
 * `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
 
-Use `TimezoneTeleporter.teleport(latitude, longitude)` to generate randomized coordinates in the same time zone:
+##### Teleport with coordinates
+Use `TimezoneTeleporter.teleport(lat, lng)` 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 the origin coordinates unless silent_mode is set to false.*
 
 ## Development
 
@@ -64,4 +73,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TimezoneTeleporter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/blinkist/TimezoneTeleporter/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TimezoneTeleporter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/blinkist/timezone-teleporter/blob/master/CODE_OF_CONDUCT.md).

data/lib/timezone_teleporter/configuration.rb

@@ -2,12 +2,12 @@
 
 module TimezoneTeleporter
   class Configuration
-    attr_accessor :silent_mode
+    attr_accessor :silent_exceptions
     attr_accessor :use_proximity_algorithm
     attr_accessor :delta_degree
 
     def initialize
-      @silent_mode = false
+      @silent_exceptions = false
       @use_proximity_algorithm = true
       @delta_degree = 1
     end

data/lib/timezone_teleporter/version.rb

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

data/lib/timezone_teleporter.rb

@@ -17,14 +17,30 @@ module TimezoneTeleporter
       @configuration ||= Configuration.new
     end
 
-    def teleport(lat, lng)
-      TIMEZONE_LOCATIONS[timezone_at(lat, lng)]
+    def teleport(lat_or_tz, lng=nil)
+      if lng.nil?
+        teleport_timezone(lat_or_tz)
+      else
+        teleport_location(lat_or_tz, lng)
+      end
+    end
+
+    def teleport_location(lat, lng)
+      teleport_timezone(timezone_at(lat, lng))
     rescue StandardError => e
-      raise e unless configuration.silent_mode
+      raise e unless configuration.silent_exceptions
 
       [lat, lng]
     end
 
+    def teleport_timezone(timezone)
+      location = TIMEZONE_LOCATIONS[timezone]
+
+      raise TimeZoneNotFoundError unless location || configuration.silent_exceptions
+
+      location
+    end
+
     def timezone_at(lat, lng)
       timezone_name = timezone_finder.timezone_at(lat: lat, lng: lng)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timezone_teleporter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ole Richter
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-30 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: timezone_finder
@@ -110,7 +110,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: TimezoneTeleporter gives you some new coordinates in the same timezone.
+description: TimezoneTeleporter anonymizes users' GPS coordinates by generating random
+  coordinates in the same time zone. These new coordinates may be used then safely
+  by 3rd party systems to process the users' location, without disclosing their actual
+  physical position, providing more privacy, and anonymity to users.
 email:
 - ole@blinkist.com
 - tomek@blinkist.com
@@ -126,7 +129,7 @@ files:
 - lib/timezone_teleporter/errors.rb
 - lib/timezone_teleporter/timezone_locations.rb
 - lib/timezone_teleporter/version.rb
-homepage: https://github.com/blinkist/timezone_teleporter
+homepage: https://github.com/blinkist/timezone-teleporter
 licenses:
 - MIT
 metadata: {}