user_timezone 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79f9b7d75beac7d2d4e5dbba1aa4b65f4f8bbfba
+  data.tar.gz: 60d17f2f052ba8b82523b4c05b537c1e0eec6e1f
+SHA512:
+  metadata.gz: 902ea953a3034d4a01c209eb9435c7da9c4b40dd07d5f7d0b5b60bc2e19c4d8867ce6d56ce366dd37364994a251c349b7120ae75bdb8cdb17a1f845d6ce81e59
+  data.tar.gz: cf343e688ba0df0fcbac918a5ff9400c5d843493ba50b19399a66a1dd0859a8bf0932ff66ebf985b3cad664ce6575e9135a95cada29accbd0c5bda69dca8d7ca

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+ - "1.9.3"
+ - "2.1.0"
+ - "2.2.3"
+script: 'bundle exec rake'
+script: rspec spec
+notifications:
+  email:
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jay El-Kaake
+
+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,116 @@
+![](http://i.imgur.com/JlHfMxf.jpg)
+
+# User Timezone Detector Gem
+![Travis build for User Timezone Gem](https://travis-ci.org/jayelkaake/user_timezone.svg?branch=master)
+
+The user timezone detector Gem lets you attach the `detects_timezone` trait to your User, Account or Contact
+classes and auto-populate the timezone field with detected attributes.
+
+**Table of Contents**
+
+* [User Timezone Detector Gem](#user-timezone-detector-gem)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    * [Automatically populating the timezone field](#automatically-populating-the-timezone-field)
+    * [Getting the current time for a user, contact or account](#getting-the-current-time-for-a-user,-contact-or-account)
+    * [Compatible Lookup Combinations](#compatible-lookup-combinations)
+    * [What if my local class attributes are different?](#what-if-my-local-class-attributes-are-different?)
+  * [Development](#development)
+  * [Contributing](#contributing)
+  * [Rate Limits](#rate-limits)
+  * [License](#license)
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'user_timezone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install user_timezone
+
+## Usage
+
+### Automatically populating the timezone field
+This example assumes you have a table called "contacts" and it has a column with "zip" and "country" or some other compatible lookup combinations (see [Compatible Lookup Combinations](#)).
+```ruby
+class Contact < ActiveRecord::Base
+    detects_timezone log: true, on: :before_safe
+end
+contact = Contact.new(zip: 78729, country: "US")
+contact.save!
+puts contact.timezone
+# OUTPUT: "America/Chicago"
+```
+
+### Getting the current time for a user, contact or account
+Continuing on from the previous example, we can now also get the current time for the user.
+```ruby
+contact.current_time
+# Output: "2016-02-21T16:37:10.064-06:00"
+```
+This returns a ruby time object so you can manipulate it whatever way you want.
+Here's an example where we check to see if the user is awake:
+```ruby
+contact_hour = contact.current_time.hour
+if (contact_hour > 0 && contact_hour < 8)
+    puts "User is still sleeping, don't bother them - it's only #{contact_hour}am their time!"
+else
+    puts "User is awake, time to party! ┏(-_-)┛ ┗(-_- )┓ ┗(-_-)┛ ┏(-_-)┓ "
+end
+# OUTPUT (for example if it's 4am for them): User is still sleeping, don't bother them - it's only 4am their time!
+```
+
+### Compatible Lookup Combinations
+The API will accept any parameters and try to make a best guess of what the timezone is, even if the timezone
+guess will be very inaccurate when a broad filter is provided (such as only country). The attributes that will be
+looked at are:
+ * state - as a province code or full province name. It'll be more accurate with the code for North America.
+ * zip  - can be any string
+ * country  - as a 2-letter ISO country code
+ * city - This can be any string
+
+All fields are case insensitive.
+
+### What if my local class attributes are different?
+If your class's attributes are different than "zip", "state", etc you can map them using
+ the "using" config in your `detects_timezone` call like this:
+```ruby
+class Contact < ActiveRecord::Base
+    detects_timezone using: { :province => :state, :postal_code => :zip, :country => :country, :city => :city }
+end
+contact = Contact.new(postal_code: 78729, province: "US")
+contact.save!
+puts contact.timezone
+# OUTPUT: "America/Chicago"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/jayelkaake/user_timezone.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## Rate Limits
+Since this gem actually hits a free service that links timezones to locations, I've set a rate limit of 60 requests per minute.
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "user_timezone"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/user_timezone/detects_timezone.rb

@@ -0,0 +1,60 @@
+require "active_support/concern"
+require "user_timezone/timezone_detector"
+module UserTimezone
+  module DetectsTimezone
+    extend ::ActiveSupport::Concern
+
+    module ClassMethods
+      def detects_timezone(options = {})
+        cattr_accessor :timezone_detector
+        self.timezone_detector = UserTimezone::TimezoneDetector.new(options)
+        include LocalInstanceMethods
+        case options[:on]
+          when :before_save
+            before_save :detect_timezone!
+          when :before_create
+            before_create :detect_timezone!
+          else
+            # Do nothing, but using switch statement
+        end
+      end
+    end
+
+    module LocalInstanceMethods
+      ##
+      # @return [String] Uses the configured address fields to return a timezone value such as "America/Chicago"
+      #
+      def detect_timezone
+        self.class.timezone_detector.detect(self)
+      end
+
+      ##
+      # Detects the timezone using the self.#detect_timezone then sets the value
+      # into the local timezone field (as configured)
+      # @see #detect_timezone
+      #
+      def detect_timezone!
+        self.send(self.class.timezone_detector.options.as, self.detect_timezone)
+      end
+
+      ##
+      # @return [String] Gets he GMT offset that ruby likes (such as -05:00) in +/-HH:MM form
+      def utc_offset
+        offset = self.class.timezone_detector.detect(self, 'utc_offset')
+        return nil if offset.nil?
+        offset_val = offset.to_i
+        (offset_val < 0 ? '-' : '+') + Time.at(offset_val.abs.to_i).utc.strftime("%H:%M")
+      end
+      alias_method :gmt_offset, :utc_offset
+
+      ##
+      # @return [Time] What time is it for this user?
+      def current_time
+        Time.now.utc.getlocal(utc_offset) unless utc_offset.nil?
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, UserTimezone::DetectsTimezone

data/lib/user_timezone/timezone_detector.rb

@@ -0,0 +1,153 @@
+require 'httparty'
+require 'open-uri'
+require 'logger'
+module UserTimezone
+  ##
+  # The timezone detector class takes in smoe options, then when given
+  # an object (user, contact, account, whatever) that has address information
+  # returns back the timezone for that person.
+  #
+  class TimezoneDetector
+
+    attr_reader :options
+    ##
+    # @param [Hash] options (optional) Options hash... that's a bit weird to say.
+    # Check out https://github.com/jayelkaake/user_timezone for more information
+    # on options
+    def initialize(options = {})
+      @options = default_options.merge(options)
+      @request_cache = {}
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    end
+
+    ##
+    # @param [Hash] object What is the subject that we are detecting the timezone for?
+    #                      or alternatively, what is the hash?
+    #                      This can be a hash or object, as long as it contains the attributes
+    #                      that we want (like street, city, country, zip, etc) or has the attributes
+    #                      mapped by the options array "using" key (see https://github.com/jayelkaake/user_timezone)
+    # @param [String] what_to_detect What should be detected? (default: 'timezone') Also 'current_timestamp' also acceptable.
+    #
+    # @return [String] Timezone value or nil if no timezone was found for the given object.
+    def detect(object, what_to_detect='timezone')
+      request_url = api_request_url(object)
+      results = @request_cache[request_url] ? @request_cache[request_url] : HTTParty.get(request_url)
+      if results.empty?
+        nil
+      else
+        results.first[what_to_detect]
+      end
+    rescue Exception => e
+      err e.inspect
+      raise e if @options[:raise_errors]
+      nil
+    end
+
+
+    ##
+    # @return [Hash] default options for the timezone detector class
+    def default_options
+      {
+          using: [:city, :state, :country, :zip],
+          raise_errors: false,
+          as: :timezone
+      }
+    end
+
+
+    ##
+    # Gets the API request URL with the search parameters
+    #
+    # @param [Hash] object What is the subject that we are detecting the timezone for?
+    #                      or alternatively, what is the hash?
+    #                      This can be a hash or object, as long as it contains the attributes
+    #                      that we want (like street, city, country, zip, etc) or has the attributes
+    #                      mapped by the options array "using" key (see https://github.com/jayelkaake/user_timezone)
+    #
+    # @return [String] api request URL
+    #
+    def api_request_url(object)
+      api_uri = 'http://timezonedb.wellfounded.ca/api/v1'
+      api_request_url = "#{api_uri}/timezones?"
+      api_request_url << get_filters(object).join('&')
+      log "Making request to #{api_request_url} for timezone."
+      api_request_url
+    end
+
+
+    ##
+    # Gets the API request filter parts
+    #
+    # @param [Hash] object What is the subject that we are detecting the timezone for?
+    #                      or alternatively, what is the hash?
+    #                      This can be a hash or object, as long as it contains the attributes
+    #                      that we want (like street, city, country, zip, etc) or has the attributes
+    #                      mapped by the options array "using" key (see https://github.com/jayelkaake/user_timezone)
+    #
+    # @return [Array] Gets an array of field_name=value filters for the search
+    #
+    def get_filters(object)
+      if @options[:using].is_a?(Array)
+        get_array_attribute_filters(object, @options[:using])
+      else
+        get_map_attribute_filters(object, @options[:using])
+      end
+    end
+
+    ##
+    # Gets the API request URL with the search parameters
+    #
+    # @param [Hash] object What is the subject that we are detecting the timezone for?
+    #                      or alternatively, what is the hash?
+    #                      This can be a hash or object, as long as it contains the attributes
+    #                      that we want (like street, city, country, zip, etc) or has the attributes
+    #                      mapped by the options array "using" key (see https://github.com/jayelkaake/user_timezone)
+    # @param [Hash] attributes Attributes to use in generating filters
+    # @return [String] api request URL
+    #
+    def get_array_attribute_filters(object, attributes)
+      filters = []
+      attributes.each do |filter_name|
+        filters << get_object_filter(object, filter_name, filter_name)
+      end
+      filters
+    end
+
+    def get_map_attribute_filters(object, map)
+      filters = []
+      map.each do |local_name, filter_name|
+        filters << get_object_filter(object, local_name, filter_name)
+      end
+      filters
+    end
+
+
+    def get_object_filter(object, local_name, filter_name)
+      if object.is_a?(Hash)
+        filter_val = object[local_name]
+        ("#{filter_name}=" << URI::encode(filter_val)) unless filter_val.nil?
+      elsif object.respond_to?(local_name)
+        filter_val = object.send(local_name)
+        ("#{filter_name}=" << URI::encode(filter_val)) unless filter_val.nil?
+      else
+        ''
+      end
+    end
+
+    ##
+    # Logs out as 'info' level using whatever logger the system is using
+    #
+    def log(msg)
+      @logger.info("UserTimezone::TimezoneDetector - #{msg}") if @options[:log]
+    end
+
+    ##
+    # Log out an error using the system's logger.
+    #
+    # @param [Exception] e exception or error encountered to send to the logger
+    def err(e)
+      @logger.error(e)
+    end
+
+  end
+end

data/lib/user_timezone/version.rb

@@ -0,0 +1,3 @@
+module UserTimezone
+  VERSION = "0.3.0"
+end

data/lib/user_timezone.rb

@@ -0,0 +1,9 @@
+require "user_timezone/version"
+
+module UserTimezone
+
+  if defined?(Rails)
+    require 'user_timezone/detects_timezone'
+  end
+
+end

data/user_timezone.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'user_timezone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "user_timezone"
+  spec.version       = UserTimezone::VERSION
+  spec.authors       = ["Jay El-Kaake"]
+  spec.email         = ["najibkaake@gmail.com"]
+
+  spec.summary       = %q{Detects a user's timezone based on their country/state/city/etc}
+  spec.description   = %q{This gem lets you add a 'has_timezone' to a User, Contact or Account that has a city, state, country or zip and it will add the #timezone attribute that will automatically populate the timezone attribute.}
+  spec.homepage      = "https://www.github.com/jayelkaake/user_timezone"
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_runtime_dependency 'httparty', '~> 0.13'
+
+  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", '~> 10.0'
+
+  spec.add_development_dependency "rspec", '~> 3.4'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: user_timezone
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Jay El-Kaake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 'This gem lets you add a ''has_timezone'' to a User, Contact or Account
+  that has a city, state, country or zip and it will add the #timezone attribute that
+  will automatically populate the timezone attribute.'
+email:
+- najibkaake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/user_timezone.rb
+- lib/user_timezone/detects_timezone.rb
+- lib/user_timezone/timezone_detector.rb
+- lib/user_timezone/version.rb
+- user_timezone.gemspec
+homepage: https://www.github.com/jayelkaake/user_timezone
+licenses:
+- MIT
+metadata: {}
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Detects a user's timezone based on their country/state/city/etc
+test_files: []
+has_rdoc: