eztz 0.0.4 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTI2MmIyYzdhNjEzZmVlNjhhNzQxNzk0MjY0YzcxMWVkNmYyZDhlNg==
-  data.tar.gz: !binary |-
-    OWI4OGMzMWM5MzRmZGRhOWM5YzMzNThlZGI0ZDJkMWE4M2YxNTdkNA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MDMxOGY1ZmYzMTc1ZjU2MjYwZWM2YTg3ODFiZDAzN2U3MTYxN2JlMGQ3Yjc2
-    MjIzOTNlYzA2YTYwNjA4OTdkMmQ5ZjkyYTM4M2ZiNTZjZDAzOWU5YzdmNDE0
-    NDY3ZTM1ZDA1YWUxNGM4MzY5MjYzZDM0YTAwZDFmMjNmMTNiZTk=
-  data.tar.gz: !binary |-
-    ZWFjYzk4MWZkZDNjODgzNzgzMTE4MjgyMTM1YTk3YTc1NjE4OTY4NDUxY2Ez
-    ZGEzNWYzZGZhMjYwNWJmZDJmNzU5OWEyN2IyNmJhMmZhNjQ5ZGZhODNjMTIy
-    MTQ4ZTFjYjgwY2QzNDE5YzM3YmVkM2JlOGU0NWRjMDk5YTA3ODQ=
+SHA256:
+  metadata.gz: aac0186b216b00582be61d8225b7546bc14ae1848eb347a532a04ca4d86142c2
+  data.tar.gz: 87d018cd6c18a45bc0ae5b141585ae122f1d7776028c2563a63ff2880adacf12
+SHA512:
+  metadata.gz: f11c757202ea3c80d0a579be9a3eaca66e017e59ecee708373ee25871f13c38ce635841c5872139347e64cf1a3ab7c3f1b906d7d6009e5ea68bff52743e52e54
+  data.tar.gz: 2fe7186d7b8d622a3399e1f717485775a0b61a4db4c0fa870513427fd6666aac50f34126b070d8bb05a5112ec5e9d3f0c31d746bd9544d177243e0aa5d2013e8

data/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+

data/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests for Ruby ${{ matrix.ruby-version }} on ${{ matrix.os }}
+        uses: paambaati/codeclimate-action@v3.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+        with:
+          coverageCommand: bundle exec rake
+          coverageLocations: ${{github.workspace}}/coverage/coverage.json:simplecov

data/.gitignore

@@ -1,17 +1,11 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/checksums/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.tool-versions

data/.standard.yml

@@ -0,0 +1,2 @@
+ruby_version: 2.7
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at chris@chaione.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in eztz.gemspec
 gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Mason
+
+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

@@ -1,15 +1,24 @@
 # Eztz
 
+[![Tests](https://github.com/cmason/eztz/actions/workflows/test.yml/badge.svg)](https://github.com/cmason/eztz/actions/workflows/test.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0ffbd44773bb2ee6f9ed/maintainability)](https://codeclimate.com/github/cmason/eztz/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0ffbd44773bb2ee6f9ed/test_coverage)](https://codeclimate.com/github/cmason/eztz/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/eztz.png)](http://badge.fury.io/rb/eztz)
+
 Ruby wrapper for the [Google Time Zone API](https://developers.google.com/maps/documentation/timezone)
 
-[![Code Climate](https://codeclimate.com/github/cmason/eztz.png)](https://codeclimate.com/github/cmason/eztz)
-[![Build Status](https://travis-ci.org/cmason/eztz.png?branch=master)](https://travis-ci.org/cmason/eztz)
+## Requirements
+
+- Ruby >= 2.7
 
+Other versions of Ruby may work, but the gem is tested against the above versions.
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'eztz'
+```ruby
+ gem 'eztz'
+```
 
 And then execute:
 
@@ -21,33 +30,44 @@ Or install it yourself as:
 
 ## Usage
 
-    $ Eztz.timezone(lat: -33.86, lng: 151.20)
+An API key is required to access the Google Time Zone API. You can create a new
+API key from the [Google Cloud Console](https://developers.google.com/maps/documentation/timezone/get-api-key).
+
+    # Set your API key
+    Eztz.api_key = 'YOUR_API_KEY'
 
-    => #<Hashie::Mash dstOffset=3600.0 rawOffset=36000.0 status="OK" timeZoneId="Australia/Sydney" timeZoneName="Australian Eastern Daylight Time">
+    # Pass location coordinates as a string
+    $ Eztz.timezone(location: '29.65,-95.28')
+
+    => #<Eztz::TimeZoneResponse:0x007fe71ba2df78 @timestamp=1488834591, @dst_offset=0, @error_message=nil, @raw_offset=-21600, @status="OK", @id="America/Chicago", @name="Central Standard Time">
 
 or
 
-    $ Eztz.timezone(location: '-33.86,151.20')
+    # Pass location coordinates as an array
+    $ Eztz.timezone(location: [29.65, -95.28])
+
+    => #<Eztz::TimeZoneResponse:0x007fe71ba2df78 @timestamp=1488834591, @dst_offset=0, @error_message=nil, @raw_offset=-21600, @status="OK", @id="America/Chicago", @name="Central Standard Time">
 
-    => #<Hashie::Mash dstOffset=3600.0 rawOffset=36000.0 status="OK" timeZoneId="Australia/Sydney" timeZoneName="Australian Eastern Daylight Time">
+Optional parameters include:
 
-Params should take one of the following forms:
+  * `timestamp:` specifies the desired time as seconds since midnight, January 1, 1970 UTC. The Google Maps Time Zone API uses the timestamp to determine whether or not Daylight Savings should be applied. Times before 1970 can be expressed as negative values. Defaults to the current time.
+  * `language:` The language in which to return results Defaults to 'en'. A list of supported languages can be found at developers.google.com/maps/faq#languagesupport
 
-    { location: "-33.86,151.20" }
-    { lat: -33.86, lng: 151.20 }
+## Development
 
-## Calculating the Local Time
+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.
 
-The local time of a given location is the sum of the `Time.now.to_i` , and the `dstOffset` and `rawOffset` fields from the result.
+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
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/cmason/eztz. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-This code is provided under the MIT license.  See [LICENSE](LICENSE) for more details.
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1 +1,13 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+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
+# frozen_string_literal: true
+require 'bundler/setup'
+require 'eztz'
+
+# 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(__FILE__)

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/eztz.gemspec

@@ -1,26 +1,33 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/eztz/version', __FILE__)
+# frozen_string_literal: true
 
-Gem::Specification.new do |gem|
-  gem.name          = "eztz"
-  gem.authors       = ["Chris Mason"]
-  gem.email         = ["chris@chaione.com"]
-  gem.description   = %q{Ruby wrapper for the Google Time Zone API}
-  gem.license       = 'MIT'
-  gem.summary       = gem.description
-  gem.homepage      = "https://github.com/cmason/eztz"
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eztz/version"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  gem.version       = Eztz::VERSION
+Gem::Specification.new do |spec|
+  spec.name = "eztz"
+  spec.version = Eztz::VERSION
+  spec.authors = ["Chris Mason"]
+  spec.email = ["chris@chaione.com"]
 
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec', '~> 2.12.0'
-  gem.add_development_dependency 'vcr', '~> 2.4.0'
-  gem.add_development_dependency 'webmock', '~> 1.9.3'
+  spec.summary = "Ruby wrapper for the Google Time Zone API"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/cmason/eztz"
+  spec.license = "MIT"
 
-  gem.add_dependency 'httparty', '~> 0.10'
-  gem.add_dependency 'hashie', '>= 1.2.0'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+
+  spec.add_development_dependency "bundler", ">= 2.2.33"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "simplecov", ">= 0.22.0"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "webmock"
 end

data/lib/eztz/client.rb

@@ -1,49 +1,56 @@
-require 'httparty'
-require 'hashie'
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
 
 module Eztz
+  # The Google Time Zone API client.
+  # If you need to make requests with multiple api keys, then you'll probably
+  # want to use this class directly.  Otherwise, it will be easier to use
+  # {::Eztz#timezone Eztz.timezone}
   class Client
-    include HTTParty
-    base_uri 'https://maps.googleapis.com'
+    attr_reader :api_key
+
+    def initialize(api_key: Eztz.api_key)
+      @api_key = api_key
+      @uri = URI("https://maps.googleapis.com/maps/api/timezone/json")
+    end
 
     # Gets timezone information for a location on earth,
     # as well as that location's time offset from UTC.
     #
-    # @param [Hash] params options to get timezone information.
-    #   Must include :location or :lat & :lng
-    # @option params [String] :location a comma-separated lat,lng tuple. (eg. "-33.86,151.20")
-    # @option params [String, Float] :lat latitude (eg. -33.86)
-    # @option params [String, Float] :lng longitude (ex. 151.20)
-    # @option params [Boolean] :sensor specifies whether the application requesting data is using a sensor. Defaults to _false_
-    # @option params [Integer] :timestamp specifies the desired time as seconds since midnight, January 1, 1970 UTC. Defaults to _now_
-    # @option params [String] :language the language in which to return results. Defaults to _en_.
-    # @raise [ArgumentError] if :location or :lat and :lng are not provided
-    # @return [Hashie::Mash] the resulting timezone data. Response has the following properties:
-    #   * *dstOffset* : the offset for daylight-savings time in seconds.
-    #     This will be zero if the time zone is not in Daylight Savings Time during the specified timestamp.
-    #   * *rawOffset* : the offset from UTC (in seconds) for the given location.
-    #     This does not take into effect daylight savings.
-    #   * *timeZoneId* : a string containing the ID of the time zone, such as "America/Los_Angeles" or "Australia/Sydney".
-    #   * *timeZoneName* : a string containing the long form name of the time zone.
-    #     This field will be localized if the language parameter is set.
-    #     eg. "Pacific Daylight Time" or "Australian Eastern Daylight Time"
-    #   * *status* : a string indicating the status of the response. Status will be one of the following:
-    #     * *OK* - indicates that the request was successful.
-    #     * *INVALID_REQUEST* - indicates that the request was malformed.
-    #     * *OVER_QUERY_LIMIT* - indicates the requestor has exceeded quota.
-    #     * *REQUEST_DENIED* - indicates that the the API did not complete the request. Confirm that the request was sent over http instead of https.
-    #     * *UNKNOWN_ERROR* - indicates an unknown error.
-    #     * *ZERO_RESULTS* - indicates that no time zone data could be found for the specified position or time.
-    #       Confirm that the request is for a location on land, and not over water.
-    # @example Get timezone data
-    #   Eztz::Client.timezone(location: "-33.86,151.20")
-    #   => #<Hashie::Mash dstOffset=3600.0 rawOffset=36000.0 status="OK" timeZoneId="Australia/Sydney" timeZoneName="Australian Eastern Daylight Time">
-    def self.timezone(params={})
-      params[:location] = "#{params.delete(:lat)},#{params.delete(:lng)}" if params[:lat] && params[:lng]
-      raise ArgumentError, 'You must provide a location' if params[:location].nil? || params[:location].empty? || params[:location] == ','
-      params[:sensor] ||= false
-      params[:timestamp] ||= Time.now.to_i
-      Hashie::Mash.new self.get('/maps/api/timezone/json', query: params)
+    # @param location [String, Array] a comma-separated lat,lng tuple
+    #   (eg. "-33.86,151.20"), representing the location to look up. Can also be
+    #   an array (eg. [-33.86, 151.20]).
+    # @param timestamp [Integer] specifies the desired time as seconds
+    #   since midnight, January 1, 1970 UTC. The Google Maps Time Zone API uses
+    #   the timestamp to determine whether or not Daylight Savings should be
+    #   applied. Times before 1970 can be expressed as negative values.
+    #   Defaults to the current time.
+    # @param language [String] The language in which to return results
+    #   Defaults to 'en'. A list of supported languages can be found at
+    #   https://developers.google.com/maps/faq#languagesupport
+    # @raise [ArgumentError] if location is not provided
+    # @raise [ApiError] if the API returns an error response.
+    # @return [Eztz::TimeZoneResponse] the resulting timezone data.
+    def timezone(location:, timestamp: Time.now.utc.to_i, language: "en")
+      uri.query = query_params(location, timestamp, language)
+      res = Net::HTTP.get_response(uri)
+      raise ApiError, res.body unless res.is_a?(Net::HTTPSuccess)
+      TimeZoneResponse.new(timestamp, JSON.parse(res.body))
+    end
+
+    private
+
+    attr_reader :uri
+
+    def query_params(location, timestamp, language)
+      URI.encode_www_form(
+        location: (location.respond_to?(:join) ? location.join(",") : location),
+        timestamp: timestamp,
+        language: language,
+        key: api_key
+      )
     end
   end
 end

data/lib/eztz/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Eztz
+  # Thrown when the API returns an error response.
+  class ApiError < StandardError
+    attr_reader :message
+
+    def initialize(response)
+      @message = response
+    end
+
+    def to_s
+      @message.to_s
+    end
+  end
+end

data/lib/eztz/response.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Eztz
+  # Encapsulates the data from the timezone api
+  class TimeZoneResponse
+    # @!attribute dst_offset [r]
+    #   @return [Integer] The offset for daylight-savings time in seconds.
+    #     This will be zero if the time zone is not in Daylight Savings Time
+    #     during the specified timestamp.
+    # @!attribute error_message [r]
+    #   @return [String] More detailed information about the reasons behind the
+    #     given status code, if other than OK.
+    # @!attribute id [r]
+    #   @return [String] A string containing the ID of the time zone, such as
+    #     "America/Los_Angeles" or "Australia/Sydney".
+    # @!attribute name [r]
+    #   @return [String] A string containing the long form name of the time
+    #     zone. This field will be localized if the language parameter was set.
+    #     eg. "Pacific Daylight Time" or "Australian Eastern Daylight Time"
+    # @!attribute raw_offset [r]
+    #   @return [Integer] The offset from UTC (in seconds) for the given
+    #     location. This does not take into effect daylight savings.
+    # @!attribute status [r]
+    #   @return [String] a string indicating the status of the response. Status
+    #     will be one of the following:
+    #     * *OK* - indicates that the request was successful.
+    #     * *INVALID_REQUEST* - indicates that the request was malformed.
+    #     * *OVER_QUERY_LIMIT* - indicates the requestor has exceeded quota.
+    #     * *REQUEST_DENIED* - indicates that the the API did not complete the
+    #       request. Confirm that the request was sent over http instead of
+    #       https.
+    #     * *UNKNOWN_ERROR* - indicates an unknown error.
+    #     * *ZERO_RESULTS* - indicates that no time zone data could be found
+    #       for the specified position or time. Confirm that the request is for
+    #       a location on land, and not over water.
+    # @!attribute timestamp [r]
+    #   @return [Integer] The timestamp used in the request.
+    attr_reader :dst_offset, :error_message, :id, :name,
+      :raw_offset, :status, :timestamp
+
+    # @param timestamp [Integer] The timestamp used in the request
+    # @param response [Hash] The parsed JSON response from the api call
+    def initialize(timestamp, response)
+      @timestamp = timestamp
+      @dst_offset, @error_message, @raw_offset, @status, @id, @name =
+        response.values_at(
+          "dstOffset", "error_message", "rawOffset", "status", "timeZoneId",
+          "timeZoneName"
+        )
+    end
+
+    def success?
+      status == "OK"
+    end
+
+    # The local time of the location is the sum of the :timestamp,
+    # :dst_offset and :raw_offset.
+    # @return [Time]
+    def local_time
+      Time.at(timestamp.to_i + dst_offset.to_i + raw_offset.to_i)
+    end
+
+    # The object as a Hash.
+    # @return [Hash]
+    def to_h
+      {
+        dst_offset: dst_offset,
+        error_message: error_message,
+        id: id,
+        name: name,
+        raw_offset: raw_offset,
+        status: status,
+        timestamp: timestamp
+      }
+    end
+  end
+end

data/lib/eztz/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Eztz
-  VERSION = "0.0.4"
+  VERSION = "2.0.0"
 end

data/lib/eztz.rb

@@ -1,22 +1,68 @@
+# frozen_string_literal: true
+
 require "eztz/client"
+require "eztz/errors"
+require "eztz/response"
 require "eztz/version"
 
+# Ruby wrapper for the Google Time Zone API.
+# @example Sample usage
+#   # Set your api key
+#   Eztz.api_key = 'YOUR_API_KEY'
+#   # location as a string
+#   Eztz.timezone(location: "-33.86,151.20")
+#   # location as an array
+#   Eztz.timezone(location: [-33.86,151.20])
 module Eztz
-  # Gets timezone information for a location on earth,
-  # as well as that location's time offset from UTC.
-  #
-  # @param [Hash] params options to get timezone information.
-  #   Must include :location or :lat & :lng
-  # @option params [String] :location a comma-separated lat,lng tuple. (eg. "-33.86,151.20")
-  # @option params [String, Float] :lat latitude (eg. -33.86)
-  # @option params [String, Float] :lng longitude (ex. 151.20)
-  # @raise [ArgumentError] if :location or :lat and :lng are not provided
-  # @return [Hashie::Mash] the resulting timezone data.
-  # @example Get timezone data
-  #   Eztz.timezone(lat: -33.86, lng: 151.20)
-  #   => #<Hashie::Mash dstOffset=3600.0 rawOffset=36000.0 status="OK" timeZoneId="Australia/Sydney" timeZoneName="Australian Eastern Daylight Time">
-  # @see Client.timezone
-  def self.timezone(params={})
-    Eztz::Client.timezone(params)
+  class << self
+    # @!attribute api_key
+    #   @return [String] Your application's API key.
+    #     Api keys can be obtained at
+    #     https://developers.google.com/maps/documentation/timezone/get-api-key
+    attr_accessor :api_key
+
+    # @example Configure api key with a configuration block
+    #   Eztz.configure do |config|
+    #     config.api_key = 'XYZ'
+    #   end
+    def configure
+      yield self
+      true
+    end
+
+    # The Eztz client
+    # @return [Eztz::Client]
+    def client
+      @client ||= Eztz::Client.new
+    end
+
+    # Gets timezone information for a location on earth,
+    # as well as that location's time offset from UTC.
+    #
+    # @param location [String, Array] a comma-separated lat,lng tuple
+    #   (eg. "-33.86,151.20"), representing the location to look up. Can also be
+    #   an array (eg. [-33.86, 151.20]).
+    # @param timestamp [Integer] specifies the desired time as seconds
+    #   since midnight, January 1, 1970 UTC. The Google Maps Time Zone API uses
+    #   the timestamp to determine whether or not Daylight Savings should be
+    #   applied. Times before 1970 can be expressed as negative values.
+    #   Defaults to the current time.
+    # @param language [String] The language in which to return results
+    #   Defaults to 'en'. A list of supported languages can be found at
+    #   https://developers.google.com/maps/faq#languagesupport
+    # @raise [ArgumentError] if location is not provided
+    # @raise [ApiError] if the API returns an error response.
+    # @return [Eztz::TimeZoneResponse] the resulting timezone data.
+    # @example Get the timezone for a location
+    #   Eztz.timezone(location: "-33.86,151.20")
+    #   => #<Eztz::TimeZoneResponse:0x007fe71c906298 @timestamp=1488580176,
+    #     @dst_offset=3600, @error_message=nil, @raw_offset=36000,
+    #     @status="OK", @id="Australia/Sydney",
+    #     @name="Australian Eastern Daylight Time">
+    def timezone(location:, timestamp: Time.now.utc.to_i, language: "en")
+      client.timezone(location: location,
+        timestamp: timestamp,
+        language: language)
+    end
   end
 end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: eztz
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Mason
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2023-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.3
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.9.3
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '0'
 description: Ruby wrapper for the Google Time Zone API
 email:
 - chris@chaione.com
@@ -101,49 +101,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".editorconfig"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - eztz.gemspec
 - lib/eztz.rb
 - lib/eztz/client.rb
+- lib/eztz/errors.rb
+- lib/eztz/response.rb
 - lib/eztz/version.rb
-- spec/acceptance/get_timezone_spec.rb
-- spec/eztz_spec.rb
-- spec/fixtures/cassettes/emtpy_results.yml
-- spec/fixtures/cassettes/valid_timezone_lookup.yml
-- spec/spec_helper.rb
 homepage: https://github.com/cmason/eztz
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Google Time Zone API
-test_files:
-- spec/acceptance/get_timezone_spec.rb
-- spec/eztz_spec.rb
-- spec/fixtures/cassettes/emtpy_results.yml
-- spec/fixtures/cassettes/valid_timezone_lookup.yml
-- spec/spec_helper.rb
+test_files: []

data/.rspec

@@ -1 +0,0 @@
---format nested --colour

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - "1.9.2"
-  - "1.9.3"
-  - "2.0.0"
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
-# uncomment this line if your project needs to run something other than `rake`:
-script: bundle exec rspec spec
-

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Chris Mason
-
-MIT License
-
-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/spec/acceptance/get_timezone_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-
-describe Eztz do
-  context "lookup timezone" do
-    it "by location" do
-      VCR.use_cassette("valid_timezone_lookup") do
-        tz = Eztz.timezone(location: "37.7749295,-122.4194155", timestamp: 1362096689)
-        tz.dstOffset.should == 0.0
-        tz.rawOffset.should == -28800.0
-        tz.status.should == 'OK'
-        tz.timeZoneId.should == "America/Los_Angeles"
-        tz.timeZoneName.should == "Pacific Standard Time"
-      end
-    end
-
-    it "by :lat :lng" do
-      VCR.use_cassette("valid_timezone_lookup") do
-        tz = Eztz.timezone(lat: 37.7749295, lng: -122.4194155, timestamp: 1362096689)
-        tz.dstOffset.should == 0.0
-        tz.rawOffset.should == -28800.0
-        tz.status.should == 'OK'
-        tz.timeZoneId.should == "America/Los_Angeles"
-        tz.timeZoneName.should == "Pacific Standard Time"
-      end
-    end
-
-    it "with no results" do
-      VCR.use_cassette("emtpy_results") do
-        tz = Eztz.timezone(lat: 0, lng: 0, timestamp: 1362096689)
-        tz.status.should == 'ZERO_RESULTS'
-        tz.timeZpneId.should be_nil
-      end
-    end
-  end
-end

data/spec/eztz_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-
-describe Eztz do
-  it "should define a version" do
-    Eztz::VERSION.should_not be_nil
-  end
-
-  context "timezone lookup" do
-    let(:query) {
-       {
-         query: {
-          location:"37.7749295,-122.4194155",
-          timestamp:1,
-          sensor:false
-          }
-       }
-    }
-
-    context "with invalid parameters" do
-      it "should raise an argument error" do
-        expect { Eztz.timezone }.to raise_error ArgumentError
-        expect { Eztz.timezone lat: '', lng: ''}.to raise_error ArgumentError
-      end
-    end
-
-    context "by location" do
-      let(:params) { {location: "37.7749295,-122.4194155", timestamp: 1, sensor: false} }
-      it "should get timezone by location" do
-        Eztz::Client.should_receive(:get).with("/maps/api/timezone/json", query )
-        Eztz.timezone(params)
-      end
-    end
-
-    context "by :lat :lng" do
-      let(:params) { {lat: 37.7749295, lng: -122.4194155, timestamp: 1, sensor: false } }
-      it "should get timezone by lat lng" do
-        Eztz::Client.should_receive(:get).with("/maps/api/timezone/json", query )
-        Eztz.timezone(params)
-      end
-    end
-  end
-end

data/spec/fixtures/cassettes/emtpy_results.yml

@@ -1,36 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: https://maps.googleapis.com/maps/api/timezone/json?location=0,0&sensor=false&timestamp=1362096689
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers: {}
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=UTF-8
-      Access-Control-Allow-Origin:
-      - ! '*'
-      Date:
-      - Fri, 01 Mar 2013 14:55:57 GMT
-      Server:
-      - mafe
-      Cache-Control:
-      - private
-      X-Xss-Protection:
-      - 1; mode=block
-      X-Frame-Options:
-      - SAMEORIGIN
-      Transfer-Encoding:
-      - chunked
-    body:
-      encoding: US-ASCII
-      string: ! "{\n   \"status\" : \"ZERO_RESULTS\"\n}\n"
-    http_version: 
-  recorded_at: Fri, 01 Mar 2013 14:55:57 GMT
-recorded_with: VCR 2.4.0

data/spec/fixtures/cassettes/valid_timezone_lookup.yml

@@ -1,38 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: https://maps.googleapis.com/maps/api/timezone/json?location=37.7749295,-122.4194155&sensor=false&timestamp=1362096689
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers: {}
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Type:
-      - application/json; charset=UTF-8
-      Access-Control-Allow-Origin:
-      - ! '*'
-      Date:
-      - Fri, 01 Mar 2013 00:11:30 GMT
-      Server:
-      - mafe
-      Cache-Control:
-      - private
-      X-Xss-Protection:
-      - 1; mode=block
-      X-Frame-Options:
-      - SAMEORIGIN
-      Transfer-Encoding:
-      - chunked
-    body:
-      encoding: US-ASCII
-      string: ! "{\n   \"dstOffset\" : 0.0,\n   \"rawOffset\" : -28800.0,\n   \"status\"
-        : \"OK\",\n   \"timeZoneId\" : \"America/Los_Angeles\",\n   \"timeZoneName\"
-        : \"Pacific Standard Time\"\n}\n"
-    http_version: 
-  recorded_at: Fri, 01 Mar 2013 00:11:30 GMT
-recorded_with: VCR 2.4.0

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-lib = File.expand_path('../../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rubygems'
-require 'rspec'
-require 'vcr'
-require 'httparty'
-require 'eztz'
-
-VCR.configure do |c|
-  c.cassette_library_dir = 'spec/fixtures/cassettes'
-  c.hook_into :webmock
-  c.allow_http_connections_when_no_cassette = true
-end