locotimezone 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60188c3aec6a698ff7cebff12072275d7b3beb58
+  data.tar.gz: 9d4ed88b196ab185d1add6bcb038494bbac0e0fa
+SHA512:
+  metadata.gz: e6bf3368d3f39c4f5b457ec4d540270c1d83503c1589b50d27cbd103df37566d7bccf4bb3e8236d8ebe8656cedec964b5cae9de68b64c23580976193e7905ada
+  data.tar.gz: d2efc12f85835b121b799c13ef98f4cda6cf5ab811e3578627e5e919c2bc457dd5ee7f58358079eb6d49936084eb130fe86080f18f8e2ff3ca4c7a3d1ec17fb6

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in locotimezone.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,99 @@
+# Locotimezone
+
+Transform a street address into geoloction and timezone data. Essentially, this
+is an adapter for the [Google Maps Time Zone API](https://developers.google.com/maps/documentation/timezone/intro) and the [The Google Maps Geolocation API](https://developers.google.com/maps/documentation/geolocation/intro).
+
+All requests to the Google APIs are done over SSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'locotimezone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install locotimezone
+
+## Usage
+Geolocate and get timezone details:
+
+```ruby
+require 'locotimezone'
+
+address = '525 NW 1st Ave Fort Lauderdale, FL 33301'
+
+Locotimezone.locotime address: address
+# =>
+# {:geo=>
+#   {:formatted_address=>"525 NW 1st Ave, Fort Lauderdale, FL 33301, USA",
+#      :location=>{:lat=>26.1288238, :lng=>-80.1449743}},
+#  :timezone=>
+#   {:timezone_id=>"America/New_York", :timezone_name=>"Eastern Daylight Time"}}
+```
+
+Not interested in timezone? Skip it. 
+
+```ruby
+require 'locotimezone'
+
+Locotimezone.locotime address: address, location_only: true
+# =>
+# {: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.
+
+```ruby
+location = { lat: 26.1288238, lng: -80.1449743 }
+
+Locotimezone.locotime location: location, timezone_only: true
+# =>
+# {:timezone=>
+#   {:timezone_id=>"America/New_York", :timezone_name=>"Eastern Daylight Time"}}
+```
+## Options and Setup
+
+`Locotimezone.locotime` can take the following option hash keys:
+* `:address` is a string representation of a street address. This is required except when `timezone_only: true`.
+* `:location` is required only when `timezone_only: true`. The corresponding
+  value is a hash containing the latitude and longitude: `{ lat: 26.1288238, lng: -80.1449743 }`.
+* `:key` is for your Google API key.  This is not required but recommended if you
+  want higher API quota. Create an API key and enable APIs in your [Google
+  Developer Console](https://console.developers.google.com). As an alternative
+  to passing the `:key` everytime, simply set `GOOGLE_API_KEY` environment variable.
+* `location_only: true` skips the call to Google Maps Timezone API. Geolocation only.
+* `timezone_only: true` skips the call to Google Maps Geolocation API.  Gets only the
+  timezone data for the specified `:location`.  When `timezone_only: true`, you
+  must inlcude the `:location` hash (see above).
+
+## Versions of Ruby
+
+This library should work with Ruby 2.1 and higher versions.
+
+It has been tested on the following versions of Ruby:
+* Ruby 2.3
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apmiller108/locotimezone.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "locotimezone"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/locotimezone/location.rb

@@ -0,0 +1,31 @@
+class Location
+  attr_reader :key, :address
+
+  def initialize(address, key)
+    @address = address
+    @key     = key
+  end
+
+  def geolocate
+    response = open(geolocation_query_url) { |f| JSON.parse f.read }
+    format_results response
+  end
+
+  private 
+
+  def geolocation_query_url
+    'https://maps.googleapis.com/maps/api/geocode/json' + '?key=' + key +
+      '&address=' + address
+  end
+
+  def format_results(response)
+    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
+end

data/lib/locotimezone/loco_time.rb

@@ -0,0 +1,42 @@
+require 'open-uri'
+require 'json'
+
+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
+    return nil if location_only && timezone_only
+    location_data = get_location unless timezone_only 
+    timezone_data = get_timezone unless location_only
+    build_hash(location_data, timezone_data)
+  end
+
+  private
+
+  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

data/lib/locotimezone/timezone.rb

@@ -0,0 +1,37 @@
+class Timezone
+  attr_reader :key, :location
+
+  def initialize(location, key)
+    @location = location
+    @key      = key
+  end
+
+  def timezone
+    response = open(timezone_query_url) { |f| JSON.parse f.read }
+    format_results response
+  end
+
+  private
+
+  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']
+    ]
+  end
+end

data/lib/locotimezone/version.rb

@@ -0,0 +1,3 @@
+module Locotimezone
+  VERSION = "0.1.1"
+end

data/lib/locotimezone.rb

@@ -0,0 +1,24 @@
+require 'locotimezone/version'
+require 'locotimezone/loco_time'
+require 'locotimezone/location'
+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
+    ).transform
+  end
+
+end

data/locotimezone.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locotimezone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locotimezone"
+  spec.version       = Locotimezone::VERSION
+  spec.authors       = ["Alex Miller"]
+  spec.email         = ["apmiller108@yahoo.com"]
+
+  spec.summary       = %q{Get timezone and gelocation data for a street address.}
+  spec.description   = %q{Transform a street address into geoloction and timezone data.}
+  spec.homepage      = "https://github.com/apmiller108/locotimezone"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: locotimezone
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Miller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Transform a street address into geoloction and timezone data.
+email:
+- apmiller108@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/locotimezone.rb
+- lib/locotimezone/location.rb
+- lib/locotimezone/loco_time.rb
+- lib/locotimezone/timezone.rb
+- lib/locotimezone/version.rb
+- locotimezone.gemspec
+homepage: https://github.com/apmiller108/locotimezone
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Get timezone and gelocation data for a street address.
+test_files: []