eztz 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDU5NWRkZjA2ZGVmMjdkMWEwMzA4NjBhMTNlZjRlYTYyMTY5ZWI3Nw==
+  data.tar.gz: !binary |-
+    ODVmODE5NmZlMDJlMDA0NTA4YWQxNzJkZTNmZTlmZmUwNGRiMTQyOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2Y2ZjU2YjZhODFiNDRlZjBiNzU3ZTUyZGFlNDM0YTljOWVmMTEyYzMxMTQz
+    YzEyZTQxZWE2N2FkNWQ3NTQzYzcyY2U2MDQyMzA5YzFkMTI1ZGYyYjUzZTU5
+    MTgxMDljNWM4ZmEwN2JhOGYwYjRiNTU3NjRiOTE0NzAyZjA4ZDQ=
+  data.tar.gz: !binary |-
+    MGUxZDFkMjcyNTY2MmE1OTZjM2IyNjcxMmE3M2E1MDM3ZWFjOGRlMGE3N2U4
+    MjQyMGJlZGY5NDcwN2Y3NTY0ZTVjOTYyYjgwN2MwZTk1YTUzN2UyYWUyM2My
+    MmQ2NGZjYTFjYmFkM2QzOTc4ZGVkODg0NDdlOWM0YzBhYzVhOGM=

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+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/README.md

@@ -0,0 +1,50 @@
+# Eztz
+
+Ruby wrapper for the [Google Time Zone API](https://developers.google.com/maps/documentation/timezone)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eztz'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eztz
+
+## Usage
+
+    $ 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">
+
+or
+
+    $ Eztz.timezone(location: '-33.86,151.20')
+
+    => #<Hashie::Mash dstOffset=3600.0 rawOffset=36000.0 status="OK" timeZoneId="Australia/Sydney" timeZoneName="Australian Eastern Daylight Time">
+
+Params should take one of the following forms:
+
+    { location: "-33.86,151.20" }
+    { lat: -33.86, lng: 151.20 }
+
+## Calculating the Local Time
+
+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.
+
+## 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
+
+## License
+
+This code is provided under the MIT license.  See [LICENSE](LICENSE) for more details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/eztz.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/eztz/version', __FILE__)
+
+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.summary       = gem.description
+  gem.homepage      = "https://github.com/cmason/eztz"
+
+  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.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'
+
+  gem.add_dependency 'httparty', '~> 0.10.0'
+  gem.add_dependency 'hashie', '>= 1.2.0'
+end

data/lib/eztz.rb

@@ -0,0 +1,22 @@
+require "eztz/client"
+require "eztz/version"
+
+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)
+  end
+end

data/lib/eztz/client.rb

@@ -0,0 +1,49 @@
+require 'httparty'
+require 'hashie'
+
+module Eztz
+  class Client
+    include HTTParty
+    base_uri 'https://maps.googleapis.com'
+
+    # 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[:sensor] ||= false
+      params[:timestamp] ||= Time.now.to_i
+      Hashie::Mash.new self.get('/maps/api/timezone/json', query: params)
+    end
+  end
+end

data/lib/eztz/version.rb

@@ -0,0 +1,3 @@
+module Eztz
+  VERSION = "0.0.1"
+end

data/spec/acceptance/get_timezone_spec.rb

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,41 @@
+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
+      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

@@ -0,0 +1,36 @@
+---
+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

@@ -0,0 +1,38 @@
+---
+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

@@ -0,0 +1,13 @@
+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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: eztz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Ruby wrapper for the Google Time Zone API
+email:
+- chris@chaione.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- eztz.gemspec
+- lib/eztz.rb
+- lib/eztz/client.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: []
+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.0.0
+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
+has_rdoc: