locotimezone 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e657574099f1b13af081ca48ef623040afa09d37
-  data.tar.gz: 259c4a4b9276418d3444e96dfe59dd4e44aa5f86
+  metadata.gz: 783972c9c5361402295db42561c18b992da83d99
+  data.tar.gz: ab45f48e2876e9f0767cab6791e40bff9051d8e6
 SHA512:
-  metadata.gz: 65f6917a871bdfc316b91457130b76cf94cdaa6d716fefceda5dd23b7960c5982366b801e7f00681e13ab27c85e81dd23c3182cd95e8fa591e6b05c7aade9293
-  data.tar.gz: f4963c6a2c9da0446e48d861e72bac011b389e3305bd7e927588ad5e4b22c12689d7f6d9bd63e65b830b858b06fe74a7ffc2e35226b05b0529deaf676fbf1826
+  metadata.gz: fb49e000537228660584ecf4c8bf29dd5cdd8bd4c27df8d9c2c3a2025d65257722bac5579ffa316992822f4306520501a4753a69aff0666ab2a2d003730431fb
+  data.tar.gz: 61f5013bfdaccdd8a8962b5772ba19b05b42b252a77d02332d1e67f5aa34d81c0c19220801008c05f083c56e8fb1f784f33d1c5fdeea2531271aafb15e7a9111

data/.gitignore

@@ -8,3 +8,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/rails_locotimezone

data/README.md

@@ -1,14 +1,14 @@
 [![Code Triagers Badge](https://www.codetriage.com/apmiller108/locotimezone/badges/users.svg)](https://www.codetriage.com/apmiller108/locotimezone)
 
-# Locotimezone
+[![Build Status](https://travis-ci.org/apmiller108/locotimezone.svg?branch=active-model-integration)](https://travis-ci.org/apmiller108/locotimezone)
 
+# 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
@@ -23,7 +23,61 @@ Or install it yourself as:
 
     $ gem install locotimezone
 
-## Usage
+## Rails Usage 
+Setup an initializer. It might look something like this:
+
+```ruby
+# config/initializers/locotimezone.rb
+
+Locotimezone.configure do |config|
+  config.google_api_key = ENV['GOOGLE_API_KEY']
+end
+```
+
+You can use a callback to set the following attributes on your model:
+`:latitude`, `:longitude`, and `:timezone_id`.  Most likely, the address data
+will be in stored separate fields, so create method that aggregates the address
+information into a single string.  For more options, see [detailed usage](#detailed-usage) below.
+
+```ruby
+# app/models/user.rb
+
+class User < ApplicationRecord
+  after_validation -> { locotime address: address } 
+
+  def address
+    [street, city, region, postal_code, country].join(' ')
+  end
+end
+```
+
+The default model attributes are `:latitude`, `:longitude`, and `:timezone_id`.  
+You can override the defaults and setup your own default attribute names in the 
+configuration block. 
+
+```ruby
+# config/initializers/locotimezone.rb
+
+Locotimezone.configure do |config|
+  config.google_api_key = ENV['GOOGLE_API_KEY']
+  config.attributes = {
+    latitude: :lat,
+    longitude: :lng,
+    timezone_id: :tz_id
+  }
+end
+```
+
+
+## Detailed Usage
+First, set your [Google API
+key](https://developers.google.com/maps/documentation/geocoding/get-api-key):
+
+```ruby
+Locotimezone.configure do |config|
+  config.google_api_key = 'YOUR_API_KEY' 
+end
+```
 Geolocate and get timezone details:
 
 ```ruby
@@ -52,7 +106,7 @@ Locotimezone.locotime address: address, skip: :timezone
 #      :location=>{:lat=>26.1288238, :lng=>-80.1449743}}}
 ```
 
-If you alredy have latitude and longitude, and you're only interested in getting
+If you already have latitude and longitude, and you're only interested in getting
 the timezone data, just pass your own location hash like so:
 
 ```ruby
@@ -80,17 +134,22 @@ Locotimezone.locotime location: { lat: 0, lng: 0 }
 # {:timezone=>{}}
 ```
 
-## Options and Setup
+## Options
 
 `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`.
+* `:address` is a string representation of a street address.
 * `:location` is a hash containing the latitude and longitude: `{ lat: 26.1288238, lng: -80.1449743 }`. When passing a location hash, the call to Google Maps Geolocation API is skipped.
-* `: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.
 * `skip: :timezone` skips the call to Google Maps Timezone API. For geolocation,
-  only.
+  only
+
+## Setup
+
+`Locotimezone.configuration` takes a block where the following can be setup:
+* `google_api_key`. Create an API key and enable APIs in your [Google
+  Developer Console](https://console.developers.google.com).
+* `attributes`.  For overriding the default attribute names used for Rails models.
+  The defaults are `:latitude`, `:longitude`, and `:timezone_id`. See example
+  above under [Rails usage](#rails-usage)
 
 ## Command Line Utility
 
@@ -117,7 +176,7 @@ It has been tested on the following versions of Ruby:
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `rake run` for an interactive prompt that will allow you to experiment. `rake run` will automatically run the configuration block which sets the `google_api_key` to `ENV['GOOGLE_API_KEY']`.
 
 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).
 
@@ -129,4 +188,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/apmill
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -7,4 +7,9 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
+task :run do
+  exec 'pry -r locotimezone -I ./lib -e '\
+    '"Locotimezone.configure { |c| c.google_api_key = ENV[\'GOOGLE_API_KEY\'] }"'
+end
+
 task :default => :test

data/lib/locotimezone/active_record_helper.rb

@@ -0,0 +1,38 @@
+module Locotimezone
+  module ActiveRecordHelper
+
+   def locotime(options = {})
+     data = Locotimezone.locotime(options)
+     geolocation_attributes data[:geo] unless data[:geo].nil?
+     timezone_attribute data[:timezone] unless data[:timezone].nil?
+   end
+
+   def geolocation_attributes(geolocation_data)
+     return nil if geolocation_data.empty?
+     geolocation_data[:location].each do |key, value|
+       attribute = :latitude
+       attribute = :longitude if key == :lng
+       save_attribute(attribute, value)
+     end
+   end
+
+   def timezone_attribute(timezone_data)
+     return nil if timezone_data.empty?
+     save_attribute(:timezone_id, timezone_data[:timezone_id])
+   end
+
+   def save_attribute(attribute, value)
+     if self.respond_to? attr_writers[attribute]
+      send attr_writers[attribute], value
+     end
+   end
+
+   def attr_writers
+     attrs = {}
+     Locotimezone.configuration.attributes.each do |key, value|
+       attrs[key] = "#{value}="
+     end
+     attrs
+   end
+  end
+end

data/lib/locotimezone/configuration.rb

@@ -0,0 +1,20 @@
+module Locotimezone
+  class Configuration
+    attr_accessor :google_api_key
+    attr_reader :attributes
+    
+    def initialize
+      @attributes = {
+        latitude: :latitude,
+        longitude: :longitude,
+        timezone_id: :timezone_id
+      }
+    end
+
+    def attributes=(value)
+      if value.respond_to? :has_key?
+        @attributes = attributes.merge value
+      end
+    end
+  end
+end

data/lib/locotimezone/{location.rb → geolocate.rb}

@@ -1,13 +1,13 @@
+require 'pry'
 module Locotimezone
-  class Location
-    attr_reader :key, :address
+  class Geolocate
+    attr_reader :address
 
-    def initialize(address, key)
+    def initialize(address)
       @address = address
-      @key     = key
     end
 
-    def geolocate
+    def get_geo
       response = open(geolocation_query_url) { |f| JSON.parse f.read }
     rescue OpenURI::HTTPError
       {}
@@ -18,8 +18,8 @@ module Locotimezone
     private 
 
     def geolocation_query_url
-      'https://maps.googleapis.com/maps/api/geocode/json' + '?key=' + key +
-        '&address=' + address.to_s
+      'https://maps.googleapis.com/maps/api/geocode/json' + '?address=' + 
+        address.to_s + '&key=' + Locotimezone.configuration.google_api_key
     end
 
     def format_results(response)

data/lib/locotimezone/loco_time.rb

@@ -3,14 +3,13 @@ require 'json'
 
 module Locotimezone
   class LocoTime
-    attr_reader :skip, :address, :key
+    attr_reader :skip, :address
     attr_accessor :location
 
-    def initialize(address:, location:, skip:, key:)
+    def initialize(address:, location:, skip:)
       @location      = location
       @address       = address
       @skip          = location ? :location : skip
-      @key           = key || ''
     end
 
     def transform
@@ -24,19 +23,18 @@ module Locotimezone
 
     def validate_options
       if address.nil? && (skip == :timezone || skip.nil?)
-        raise ArgumentError, 
-          'locotimezone: missing address or location.'
+        raise ArgumentError, 'locotimezone is missing address or location.'
       end
     end 
 
     def get_location
-      results = Location.new(address, key).geolocate
+      results = Geolocate.new(address).get_geo
       self.location = results[:location] || {}
       results
     end
 
     def get_timezone
-      Timezone.new(location, key).timezone
+      Timezone.new(location).timezone
     end
 
     def build_hash(location_data, timezone_data)
@@ -45,6 +43,5 @@ module Locotimezone
       data[:timezone] = timezone_data unless timezone_data.nil?
       data
     end
-
   end
 end

data/lib/locotimezone/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'locotimezone/active_record_helper'
+
+module Locotimezone
+  class Railtie < Rails::Railtie
+    initializer 'locotimezone.active_record_helper' do
+      ActiveSupport.on_load(:active_record) do
+        include Locotimezone::ActiveRecordHelper
+      end
+    end
+  end
+end

data/lib/locotimezone/timezone.rb

@@ -1,37 +1,37 @@
 module Locotimezone
   class Timezone
-    attr_reader :key, :location
+    attr_reader :location
 
-    def initialize(location, key)
+    def initialize(location)
       @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
+    rescue OpenURI::HTTPError
+      {}
+    else
+      format_results response
     end
 
     private
 
     def location_invalid?
-      return true if !location.respond_to? :has_key?
+      return true unless 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
+      'https://maps.googleapis.com/maps/api/timezone/json' + '?key=' + 
+        Locotimezone.configuration.google_api_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(',')
+      lat_lng = Array.new
+      location.each { |k, v| lat_lng.push v.to_s }
+      lat_lng.join(',')
     end
 
     def timestamp
@@ -39,7 +39,7 @@ module Locotimezone
     end
 
     def format_results(response)
-      return {} if response['status'] == 'ZERO_RESULTS'
+      return {} if response['timeZoneId'].nil?
       Hash[
         timezone_id: response['timeZoneId'], 
         timezone_name: response['timeZoneName']

data/lib/locotimezone/version.rb

@@ -1,3 +1,3 @@
 module Locotimezone
-  VERSION = "0.4.1"
+  VERSION = "1.0.0"
 end

data/lib/locotimezone.rb

@@ -1,17 +1,41 @@
 require 'locotimezone/version'
 require 'locotimezone/loco_time'
-require 'locotimezone/location'
+require 'locotimezone/geolocate'
 require 'locotimezone/timezone'
+require 'locotimezone/configuration'
+require 'locotimezone/active_record_helper'
+require 'locotimezone/railtie' if defined?(Rails)
 
 module Locotimezone
 
+  class << self
+    attr_accessor :configuration
+  end
+
   def self.locotime(options = {})
+    set_default_configuration
     LocoTime.new(
       location: options.fetch(:location, nil),
       address: options.fetch(:address, nil), 
-      skip: options.fetch(:skip, nil),
-      key: options.fetch(:key, ENV['GOOGLE_API_KEY'])
+      skip: options.fetch(:skip, nil)
     ).transform
   end
 
+  def self.configure
+    self.configuration ||= Configuration.new 
+    yield configuration if block_given?
+    self
+  end
+
+  def self.reset_configuration
+    self.configuration = Configuration.new
+  end
+
+  def self.set_default_configuration
+    if Locotimezone.configuration.nil?
+      Locotimezone.configure do |config|
+        config.google_api_key = ''
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locotimezone
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-16 00:00:00.000000000 Z
+date: 2016-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,8 +84,11 @@ files:
 - bin/locotimezone
 - bin/setup
 - lib/locotimezone.rb
-- lib/locotimezone/location.rb
+- lib/locotimezone/active_record_helper.rb
+- lib/locotimezone/configuration.rb
+- lib/locotimezone/geolocate.rb
 - lib/locotimezone/loco_time.rb
+- lib/locotimezone/railtie.rb
 - lib/locotimezone/timezone.rb
 - lib/locotimezone/version.rb
 - locotimezone.gemspec