worldtimeengine 0.0.1

data/LICENSE.md

@@ -0,0 +1,20 @@
+[[Copyright]] (c) 2012 Nikita Fedyashev
+
+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,77 @@
+![travis-ci](http://travis-ci.org/nfedyashev/worldtimeengine.png)
+
+#  The WorldTimeEngine.com Ruby gem
+
+Convert any IP address to current local time.
+
+http://worldtimeengine.com/api/ip
+
+### Installation
+
+Install the gem:
+
+``` bash
+$ gem install worldtimeengine
+```
+
+Add it to your Gemfile:
+
+``` ruby
+gem 'worldtimeengine'
+```
+
+### Configuration
+
+    WorldTimeEngine.configure do |config|
+      config.api_key = YOUR_API_KEY
+    end
+
+
+### Synopsis
+
+    response = WorldTimeEngine.api('193.174.32.100')
+
+    response.version
+    => '1.1'
+    response.location.region
+    => 'Germany'
+    response.location.latitude
+    => 53.25
+    response.location.longitude
+    => 10.4
+    
+    response.time.utc
+    => 2012-08-25 14:10:29 UTC
+    response.time.local
+    => 2012-08-25 16:10:29 +0200
+    
+    response.time.zone.has_dst
+    => true
+    response.time.zone.current.abbreviation
+    => "CEST"
+    response.time.zone.current.description
+    => "Central European Summer Time"
+    response.time.zone.current.utc_offset
+    => '+2:00'
+    response.time.zone.current.is_dst
+    => true
+    response.time.zone.current.effective_until
+    => 2012-10-28 03:00:00 +0200
+    
+    response.time.zone.next.abbreviation
+    => 'CET'
+    response.time.zone.next.description
+    => "Central European Time"
+    response.time.zone.next.utc_offset
+    => "+1:00"
+    response.time.zone.next.is_dst
+    => false
+    response.time.zone.next.effective_until
+    => 2013-03-31 02:00:00 +0100
+
+
+## Copyright
+Copyright (c) 2012 Nikita Fedyashev.
+See [LICENSE][] for details.
+
+[license]: https://github.com/nfedyashev/worldtimeengine/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/worldtimeengine.rb

@@ -0,0 +1,29 @@
+require 'worldtimeengine/client'
+require 'worldtimeengine/configurable'
+
+module WorldTimeEngine
+  class << self
+    include WorldTimeEngine::Configurable
+
+    # Delegate to a WorldTimeEngine::Client
+    #
+    # @return [WorldTimeEngine::Client]
+    def client
+      if @client
+        @client
+      else
+        @client = WorldTimeEngine::Client.new(options)
+      end
+    end
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end
+
+WorldTimeEngine.setup

data/lib/worldtimeengine/client.rb

@@ -0,0 +1,59 @@
+require 'httparty'
+require 'hashie'
+require 'worldtimeengine/configurable'
+
+module WorldTimeEngine
+  # Wrapper for the WorldTimeEngine API
+  class Client
+    #include WorldTimeEngine::API
+    include WorldTimeEngine::Configurable
+
+    # Initializes a new Client object
+    #
+    # @return [WorldTimeEngine::Client]
+    def initialize(options={})
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    def api(ip)
+      endpoint = WorldTimeEngine.instance_variable_get(:@endpoint)
+      api_key = WorldTimeEngine.instance_variable_get(:@api_key)
+
+      timezone_hash = HTTParty.get("#{endpoint}/api/ip/#{api_key}/#{ip}", :format => :xml).to_hash['timezone']
+      timezone_hash.delete('xmlns:xsi')
+      timezone_hash.delete('xsi:noNamespaceSchemaLocation')
+
+      Hashie::Mash.new(timezone_hash).tap do |mash|
+        mash.time.utc = Time.parse "#{mash.time.utc} UTC"
+        mash.time.local = Time.parse "#{mash.time.local} #{mash.time.zone.current.abbreviation} #{mash.time.zone.current.utcoffset}"
+
+        mash.location.latitude = mash.location.latitude.to_f
+        mash.location.longitude = mash.location.longitude.to_f
+
+        mash.time.zone.has_dst = to_boolean mash.time.zone.hasDST
+
+        mash.time.zone.current.is_dst = to_boolean mash.time.zone.current.isdst
+        mash.time.zone.current.utc_offset = mash.time.zone.current.utcoffset
+        mash.time.zone.current.effective_until = Time.parse "#{mash.time.zone.current.effectiveUntil} #{mash.time.zone.current.abbreviation} #{mash.time.zone.current.utcoffset}"
+
+        mash.time.zone.next.is_dst = to_boolean mash.time.zone.next.isdst
+        mash.time.zone.next.utc_offset = mash.time.zone.next.utcoffset
+        mash.time.zone.next.effective_until = Time.parse "#{mash.time.zone.next.effectiveUntil} #{mash.time.zone.next.abbreviation} #{mash.time.zone.next.utcoffset}"
+      end
+    end
+
+    private
+
+      def to_time(string)
+        Time.parse string
+      end
+
+      def to_boolean(string)
+        string == 'true' ? true : false
+      end
+  end
+end

data/lib/worldtimeengine/configurable.rb

@@ -0,0 +1,47 @@
+module WorldTimeEngine
+  module Configurable
+    attr_writer :api_key
+    attr_accessor :endpoint
+
+    class << self
+
+      def keys
+        @keys ||= [
+          :api_key,
+          :endpoint
+        ]
+      end
+
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    def reset!
+      @api_key = nil
+      @endpoint = 'http://worldtimeengine.com'
+      self
+    end
+    alias setup reset!
+
+  private
+
+    # @return [Hash]
+    def credentials
+      { :api_key => @api_key }
+    end
+
+    # @return [Hash]
+    def options
+      Hash[WorldTimeEngine::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/spec/fixtures/193.174.32.100.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<timezone xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://worldtimeengine.com/timezone.xsd">
+    <version>1.1</version>
+    <location>
+        <region>Germany</region>
+        <latitude>53.25</latitude>
+        <longitude>10.4</longitude>
+    </location>
+    <time>
+        <utc>2012-08-25 14:10:29</utc>
+        <local>2012-08-25 16:10:29</local>
+        <zone>
+            <hasDST>true</hasDST>
+            <current>
+                <abbreviation>CEST</abbreviation>
+                <description>Central European Summer Time</description>
+                <utcoffset>+2:00</utcoffset>
+                <isdst>true</isdst>
+                <effectiveUntil>2012-10-28 03:00:00</effectiveUntil>
+            </current>
+            <next>
+                <abbreviation>CET</abbreviation>
+                <description>Central European Time</description>
+                <utcoffset>+1:00</utcoffset>
+                <isdst>false</isdst>
+                <effectiveUntil>2013-03-31 02:00:00</effectiveUntil>
+            </next>
+        </zone>
+    </time>
+</timezone>

data/spec/fixtures/another.xml

@@ -0,0 +1,22 @@
+  curl  http://worldtimeengine.com/api/ip/83c2bd05ec9bb21904cd8195ff93db/212.154.168.243
+<?xml version="1.0" encoding="UTF-8" ?>
+<timezone xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://worldtimeengine.com/timezone.xsd">
+    <version>1.1</version>
+    <location>
+        <region>Kazakhstan</region>
+        <latitude>51.1811</latitude>
+        <longitude>71.4278</longitude>
+    </location>
+    <time>
+        <utc>2012-08-25 18:14:04</utc>
+        <local>2012-08-26 00:14:04</local>
+        <zone>
+            <hasDST>false</hasDST>
+            <current>
+                <abbreviation>ALMT</abbreviation>
+                <description>Alma-Ata Mean Time</description>
+                <utcoffset>+6:00</utcoffset>
+            </current>
+        </zone>
+    </time>
+</timezone>

data/spec/fixtures/us.xml

@@ -0,0 +1,31 @@
+curl  http://worldtimeengine.com/api/ip/83c2bd05ec9bb21904cd8195ff93db/98.138.253.109 
+<?xml version="1.0" encoding="UTF-8" ?>
+<timezone xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://worldtimeengine.com/timezone.xsd">
+    <version>1.1</version>
+    <location>
+        <region>United States</region>
+        <latitude>37.4249</latitude>
+        <longitude>-122.0074</longitude>
+    </location>
+    <time>
+        <utc>2012-08-25 18:15:50</utc>
+        <local>2012-08-25 11:15:50</local>
+        <zone>
+            <hasDST>true</hasDST>
+            <current>
+                <abbreviation>PDT</abbreviation>
+                <description>Pacific Daylight Time</description>
+                <utcoffset>-7:00</utcoffset>
+                <isdst>true</isdst>
+                <effectiveUntil>2012-11-04 02:00:00</effectiveUntil>
+            </current>
+            <next>
+                <abbreviation>PST</abbreviation>
+                <description>Pacific Standard Time</description>
+                <utcoffset>-8:00</utcoffset>
+                <isdst>false</isdst>
+                <effectiveUntil>2013-03-10 02:00:00</effectiveUntil>
+            </next>
+        </zone>
+    </time>
+</timezone>

data/spec/helper.rb

@@ -0,0 +1,20 @@
+require 'worldtimeengine'
+require 'rspec'
+require 'webmock/rspec'
+require 'pry'
+
+def a_get(path, endpoint='http://worldtimeengine.com')
+  a_request(:get, endpoint + path)
+end
+
+def stub_get(path, endpoint='http://worldtimeengine.com')
+  stub_request(:get, endpoint + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/worldtimeengine_spec.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+describe WorldTimeEngine do
+  after do
+    WorldTimeEngine.reset!
+  end
+
+  describe "delegating to a client" do
+    before do
+      WorldTimeEngine.configure do |config|
+        config.api_key = 'abc'
+      end
+
+      stub_request(:get, "http://worldtimeengine.com/api/ip/abc/193.174.32.100").
+        to_return(:status => 200, :body => fixture('193.174.32.100.xml'), :headers => {})
+    end
+
+    it "requests the correct resource" do
+      WorldTimeEngine.api('193.174.32.100')
+
+      a_get("/api/ip/abc/193.174.32.100").should have_been_made
+    end
+
+    it "returns needed values" do
+      response = WorldTimeEngine.api('193.174.32.100')
+
+      response.version.should == '1.1'
+      response.location.region.should == 'Germany'
+      response.location.latitude.should == 53.25
+      response.location.longitude.should == 10.4
+
+      response.time.utc.should == Time.parse("2012-08-25 14:10:29 UTC")
+      response.time.local.should == Time.parse("2012-08-25 16:10:29")
+
+      response.time.zone.has_dst.should == true
+      response.time.zone.current.abbreviation.should == "CEST"
+      response.time.zone.current.description.should == "Central European Summer Time"
+      response.time.zone.current.utc_offset.should == '+2:00'
+      response.time.zone.current.is_dst.should == true
+      response.time.zone.current.effective_until.should == Time.parse("2012-10-28 03:00:00")
+
+      response.time.zone.next.abbreviation.should == 'CET'
+      response.time.zone.next.description.should == "Central European Time"
+      response.time.zone.next.utc_offset.should == "+1:00"
+      response.time.zone.next.is_dst.should == false
+      response.time.zone.next.effective_until.should == Time.parse("2013-03-31 02:00:00")
+    end
+  end
+
+  describe ".client" do
+    it "returns a WorldTimeEngine::Client" do
+      WorldTimeEngine.client.should be_a WorldTimeEngine::Client
+    end
+  end
+
+  describe ".configure" do
+    it "sets the api_key" do
+      WorldTimeEngine.configure do |config|
+        config.api_key = 'abc'
+      end
+      WorldTimeEngine.instance_variable_get(:@api_key).should eq 'abc'
+    end
+  end
+
+  describe ".credentials?" do
+    it "returns true if all credentials are present" do
+      WorldTimeEngine.configure do |config|
+        config.api_key = 'CK'
+      end
+      WorldTimeEngine.credentials?.should be_true
+    end
+    it "returns false if any credentials are missing" do
+      WorldTimeEngine.configure do |config|
+      end
+      WorldTimeEngine.credentials?.should be_false
+    end
+  end
+end

data/worldtimeengine.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'hashie'
+  gem.add_dependency 'httparty'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.authors = ["Nikita Fedyashev"]
+  gem.description = %q{A Ruby wrapper for the WorldTimeEngine.com API.}
+  gem.email = ['nfedyashev@gmail.com']
+  gem.files = %w(LICENSE.md README.md Rakefile worldtimeengine.gemspec)
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+  gem.homepage = 'https://github.com/nfedyashev/worldtimeengine'
+  gem.name = 'worldtimeengine'
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  gem.summary = %q{WorldTimeEngine API wrapper}
+  gem.test_files = Dir.glob("spec/**/*")
+  gem.version = '0.0.1'
+end
+

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: worldtimeengine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nikita Fedyashev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby wrapper for the WorldTimeEngine.com API.
+email:
+- nfedyashev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- worldtimeengine.gemspec
+- lib/worldtimeengine/client.rb
+- lib/worldtimeengine/configurable.rb
+- lib/worldtimeengine.rb
+- spec/fixtures/193.174.32.100.xml
+- spec/fixtures/another.xml
+- spec/fixtures/us.xml
+- spec/helper.rb
+- spec/worldtimeengine_spec.rb
+homepage: https://github.com/nfedyashev/worldtimeengine
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4077128795819690830
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: WorldTimeEngine API wrapper
+test_files:
+- spec/fixtures/193.174.32.100.xml
+- spec/fixtures/another.xml
+- spec/fixtures/us.xml
+- spec/helper.rb
+- spec/worldtimeengine_spec.rb