locotimezone 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b87b061e997bc3ae7a367d1765c501b30422075a
-  data.tar.gz: a47d4a027ab9e915d07be5c4e5a23ebd1e50bf3b
+  metadata.gz: c86c7b42877e96caf8e4448343121a107ba9f2f0
+  data.tar.gz: f0a5aa2dafb18f4e66d0255cee959a9e16f2c1e1
 SHA512:
-  metadata.gz: 475227bb475696f5964b56ff35fc93ed7e7b27666563064ca209c3dca90734c185f44fa5f6b1a42e4da69ee5a9cf24372b4423ef1a8d27fdd3786c0534ebda87
-  data.tar.gz: 890d77907597f2a0275f2f8f92a6a5df1864fe8e3d0fe7ea3554b64974b0d026e6662638f9296c0e0c08c22bd3c843eb56e292ae4c639952e4da031e2771344e
+  metadata.gz: 8e55cf04e424a7c6b594ab96f259071dc880274b744999f94cc0de709541583c993d92e99bd79b62d9b642ae4c4c46521bfbb69a9356b2eb097eff6a764752f3
+  data.tar.gz: 5aee7cd402ef6db9d71d01043b01bd6a7e75b3f55bbbf6a54f51d3de764350e6862caecd0e1f4567a0f9beb277100f7a1965d96130c2116502ebcea1aa783733

data/README.md

@@ -40,24 +40,25 @@ Locotimezone.locotime address: address
 #   {:timezone_id=>"America/New_York", :timezone_name=>"Eastern Daylight Time"}}
 ```
 
-Not interested in timezone? Skip it. 
+Not interested in timezone? Skip it to just get geocoded results.
 
 ```ruby
 require 'locotimezone'
 
-Locotimezone.locotime address: address, location_only: true
+Locotimezone.locotime address: address, skip: :timezone
 # =>
 # {:geo=>
 #   {:formatted_address=>"525 NW 1st Ave, Fort Lauderdale, FL 33301, USA",
 #      :location=>{:lat=>26.1288238, :lng=>-80.1449743}}}
 ```
 
-Only want timezone? No problem, but you'll need include a location hash.
+If you alredy have latitude and longitude, and you're only interested in getting
+the timezone data, just pass your own location hash like so:
 
 ```ruby
 location = { lat: 26.1288238, lng: -80.1449743 }
 
-Locotimezone.locotime location: location, timezone_only: true
+Locotimezone.locotime location: location
 # =>
 # {:timezone=>
 #   {:timezone_id=>"America/New_York", :timezone_name=>"Eastern Daylight Time"}}
@@ -69,6 +70,14 @@ If the address or location cannot be resolved, an empty hash will be returned.
 Locotimezone.locotime address: '1234 Fake Address'
 # => 
 # {:geo=>{}, :timezone=>{}}
+
+Locotimezone.locotime address: '1234 Fake Address', skip: :timezone
+# => 
+# {:geo=>{}}
+
+Locotimezone.locotime location: { lat: 0, lng: 0 }
+# => 
+# {:timezone=>{}}
 ```
 
 ## Options and Setup

data/lib/locotimezone/location.rb

@@ -1,36 +1,38 @@
-class Location
-  attr_reader :key, :address
+module Locotimezone
+  class Location
+    attr_reader :key, :address
 
-  def initialize(address, key)
-    @address = address
-    @key     = key
-  end
+    def initialize(address, key)
+      @address = address
+      @key     = key
+    end
 
-  def geolocate
-    response = open(geolocation_query_url) { |f| JSON.parse f.read }
-  rescue OpenURI::HTTPError
-    {}
-  else
-    format_results response
-  end
+    def geolocate
+      response = open(geolocation_query_url) { |f| JSON.parse f.read }
+    rescue OpenURI::HTTPError
+      {}
+    else
+      format_results response
+    end
 
-  private 
+    private 
 
-  def geolocation_query_url
-    'https://maps.googleapis.com/maps/api/geocode/json' + '?key=' + key +
-      '&address=' + address
-  end
+    def geolocation_query_url
+      'https://maps.googleapis.com/maps/api/geocode/json' + '?key=' + key +
+        '&address=' + address.to_s
+    end
 
-  def format_results(response)
-    return {} if response['results'].empty?
-    Hash[
-      formatted_address: response['results'][0]['formatted_address'],
-      location: symbolize_keys(response['results'][0]['geometry']['location'])
-    ]
-  end
+    def format_results(response)
+      return {} if response['results'].empty?
+      Hash[
+        formatted_address: response['results'][0]['formatted_address'],
+        location: symbolize_keys(response['results'][0]['geometry']['location'])
+      ]
+    end
 
-  def symbolize_keys(response)
-    response.map { |k,v| [k.to_sym, v] }.to_h
-  end
+    def symbolize_keys(response)
+      response.map { |k,v| [k.to_sym, v] }.to_h
+    end
 
+  end
 end

data/lib/locotimezone/loco_time.rb

@@ -1,53 +1,50 @@
 require 'open-uri'
 require 'json'
-require 'pry'
-
-class LocoTime
-  attr_reader :location_only, :timezone_only, :address, :key
-  attr_accessor :location
-
-  def initialize(location_only:, timezone_only:, address:, location:, key:)
-    @location_only = location_only
-    @timezone_only = timezone_only
-    @location      = location
-    @address       = address
-    @key           = key || ''
-  end
 
-  def transform
-    validate_options
-    location_data = get_location unless timezone_only 
-    timezone_data = get_timezone unless location_only
-    build_hash(location_data, timezone_data)
-  end
+module Locotimezone
+  class LocoTime
+    attr_reader :skip, :address, :key
+    attr_accessor :location
 
-  private
+    def initialize(address:, location:, skip:, key:)
+      @location      = location
+      @address       = address
+      @skip          = location ? :location : skip
+      @key           = key || ''
+    end
 
-  def validate_options
-    if address.nil? && !timezone_only
-      raise ArgumentError, 
-        'locotimezone: address is required unless timezone_only'
-    elsif location.nil? && timezone_only
-      raise ArgumentError, 
-        'locotimezone: location is required when timezone_only'
+    def transform
+      validate_options
+      location_data = get_location unless skip == :location
+      timezone_data = get_timezone unless skip == :timezone
+      build_hash(location_data, timezone_data)
     end
-  end 
 
-  def get_location
-    results = Location.new(address, key).geolocate
-    self.location = results[:location] || {}
-    results
-  end
+    private
 
-  def get_timezone
-    Timezone.new(location, key).timezone
-  end
+    def validate_options
+      if address.nil? && (skip == :timezone || skip.nil?)
+        raise ArgumentError, 
+          'locotimezone: missing address or location.'
+      end
+    end 
 
-  def build_hash(location_data, timezone_data)
-    data = Hash.new
-    data[:geo]      = location_data unless location_data.nil?
-    data[:timezone] = timezone_data unless timezone_data.nil?
-    data
-  end
+    def get_location
+      results = Location.new(address, key).geolocate
+      self.location = results[:location] || {}
+      results
+    end
+
+    def get_timezone
+      Timezone.new(location, key).timezone
+    end
 
+    def build_hash(location_data, timezone_data)
+      data = Hash.new
+      data[:geo]      = location_data unless location_data.nil?
+      data[:timezone] = timezone_data unless timezone_data.nil?
+      data
+    end
+
+  end
 end

data/lib/locotimezone/timezone.rb

@@ -1,45 +1,49 @@
-class Timezone
-  attr_reader :key, :location
-
-  def initialize(location, key)
-    @location = location
-    @key      = key
-  end
-
-  def timezone
-    return {} if location_invalid?
-    response = open(timezone_query_url) { |f| JSON.parse f.read }
-    rescue OpenURI::HTTPError
-      {}
-    else
-      format_results response
-  end
-
-  private
-
-  def location_invalid?
-    location.empty? || !location.respond_to?(:has_key?)
-  end
-
-  def timezone_query_url
-    'https://maps.googleapis.com/maps/api/timezone/json' + '?key=' + key + 
-      '&location=' + latitude_longitude + '&timestamp=' + timestamp
-  end
-
-  def latitude_longitude
-      lat_lng = Array.new
-      location.each { |k, v| lat_lng.push v.to_s }
-      lat_lng.join(',')
-  end
-
-  def timestamp
-    Time.now.to_i.to_s
-  end
-
-  def format_results(response)
-    Hash[
-      timezone_id: response['timeZoneId'], 
-      timezone_name: response['timeZoneName']
-    ]
+module Locotimezone
+  class Timezone
+    attr_reader :key, :location
+
+    def initialize(location, key)
+      @location = location
+      @key      = key
+    end
+
+    def timezone
+      return {} if location_invalid?
+      response = open(timezone_query_url) { |f| JSON.parse f.read }
+      rescue OpenURI::HTTPError
+        {}
+      else
+        format_results response
+    end
+
+    private
+
+    def location_invalid?
+      return true if !location.respond_to? :has_key?
+      location.empty?
+    end
+
+    def timezone_query_url
+      'https://maps.googleapis.com/maps/api/timezone/json' + '?key=' + key + 
+        '&location=' + latitude_longitude + '&timestamp=' + timestamp
+    end
+
+    def latitude_longitude
+        lat_lng = Array.new
+        location.each { |k, v| lat_lng.push v.to_s }
+        lat_lng.join(',')
+    end
+
+    def timestamp
+      Time.now.to_i.to_s
+    end
+
+    def format_results(response)
+      return {} if response['status'] == 'ZERO_RESULTS'
+      Hash[
+        timezone_id: response['timeZoneId'], 
+        timezone_name: response['timeZoneName']
+      ]
+    end
   end
 end

data/lib/locotimezone/version.rb

@@ -1,3 +1,3 @@
 module Locotimezone
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/locotimezone.rb

@@ -6,18 +6,11 @@ require 'locotimezone/timezone'
 module Locotimezone
 
   def self.locotime(options = {})
-    location_only = options.fetch(:location_only, false)
-    timezone_only = options.fetch(:timezone_only, false)
-    location      = options.fetch(:location, nil)
-    address       = options.fetch(:address, nil)
-    key           = options.fetch(:key, ENV['GOOGLE_API_KEY'])
-
     LocoTime.new(
-      location_only: location_only,
-      timezone_only: timezone_only, 
-      location: location,
-      address: address, 
-      key: key
+      location: options.fetch(:location, nil),
+      address: options.fetch(:address, nil), 
+      skip: options.fetch(:skip, nil),
+      key: options.fetch(:key, ENV['GOOGLE_API_KEY'])
     ).transform
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locotimezone
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler