global_weather 0.0.1

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 global_weather.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eugen Ciur
+
+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,86 @@
+# GlobalWeather
+
+[Global Weather SOAP
+service](http://www.webservicex.net/WS/WSDetails.aspx?WSID=56&CATID=12)
+ruby wrapper. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'global_weather'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install global_weather
+
+This gem was tested on ruby 1.9.3p327 
+
+## Usage
+
+Basically GlobalWeather gem provides 2 classes Country (wraps
+GetCitiesByCountry soap method call) and Weather (wraps GetWeather method call)
+
+To get cities by country (e.g. Germany)
+   
+
+      country = GlobalWeather::Country.new 'Germany'
+     
+      country.cities # returns an array of strings
+
+
+In order to get current weather (e.g. country 'Germany', city 'Berlin')
+
+
+      weather = GlobalWeather::Weather.new 'Germany', 'Berlin' 
+       
+      puts weather.time[:UTC]
+
+      puts weather.temperature[:C]
+
+      puts weather.temperature[:F]
+
+      puts weather.pressure[:Hg]
+
+      puts weather.pressure[:hPa]
+
+
+See full list of attributes
+
+
+      GlobalWeather::Weather::ATTRIBUTES
+
+
+Can it be simplier?
+
+## Test
+
+Command 
+
+
+    $ rake
+
+or 
+
+
+    $ rake test
+
+will run all tests
+
+
+## Configuration
+
+There is only one client instance shared among all instances of GlobalWeather
+Weather and Country objects. 
+
+  GlobalWeather::Client.configure do |config|
+    config.log false
+    config.proxy 'http://my_company_internal_proxy'
+  end
+
+options provided this way will be passed futher down to Savon.client. See full list of all
+at [savon documentation](http://savonrb.com/version2/globals.html)

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+
+Rake::TestTask.new(:test_unit) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/unit/**/*_test.rb'
+  test.verbose = false
+end
+
+task :default => :test

data/TODO

@@ -0,0 +1,5 @@
+further improvement: 
+
+One good improvement would be to CACHE SOME SOAP REQUESTS for lets say 1
+hour o so. 
+

data/global_weather.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'global_weather/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "global_weather"
+  spec.version       = GlobalWeather::VERSION
+  spec.authors       = ["Eugen Ciur"]
+  spec.email         = ["ciur.eugen@gmail.com"]
+  spec.description   = %q{GlobalWeather SOAP service wrapper}
+  spec.summary       = %q{Provides Weather and Country objects to use easy GlobalWeather service}
+  spec.homepage      = ""
+  spec.license       = "MIT or Do whatever you want with this gem!"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 1.3"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'debugger'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock', '~> 1.8'
+  spec.add_dependency 'excon', '0.22'
+  spec.add_dependency 'savon', '~> 2.0'
+  spec.add_dependency 'nori', "~> 2.3.0"
+end

data/lib/global_weather.rb

@@ -0,0 +1,11 @@
+require 'savon'
+require "global_weather/version"
+require "global_weather/utils"
+require "global_weather/client"
+require "global_weather/errors"
+require "global_weather/country"
+require "global_weather/weather"
+
+module GlobalWeather
+  include Errors
+end

data/lib/global_weather/client.rb

@@ -0,0 +1,29 @@
+module GlobalWeather
+
+  class Client
+    @@client = nil
+    @@config = {}
+
+    def self.connect(options = {})
+
+      @@config.merge!(options)
+
+      if @@client.nil?
+        @@client = Savon.client({wsdl: Utils.local_wsdl_file}.merge(@@config))
+      else
+        @@client
+      end
+    end
+
+    def self.configure(&block)
+      class_eval &block
+    end
+
+    class << self
+      def method_missing(name, *args)
+        @@config[name.to_sym] = args[0]
+      end
+    end
+
+  end
+end

data/lib/global_weather/country.rb

@@ -0,0 +1,49 @@
+module GlobalWeather
+  class Country
+
+    attr_reader :name, :cities
+
+    def initialize(name = nil, options = {})
+
+      client = Client.connect(options)
+
+      raise Errors::CountryNotProvided if name.nil?
+
+      @name = name
+
+      response = client.call(:get_cities_by_country) do |locals|
+        locals.message 'CountryName' => name
+      end
+
+      if response.success?
+        body   = response.hash[:envelope] && response.hash[:envelope][:body]
+        if body
+          result = body[:get_cities_by_country_response] && body[:get_cities_by_country_response][:get_cities_by_country_result]
+          create_attributes(result)
+        end
+      else
+        raise Errors::RequestFailure, 'Request to SOAP service failed'
+      end
+    end
+
+    private
+
+    include Utils
+
+    # Instaniates attribute 'cites' with an array of strings (cities)
+    def create_attributes(result)
+      hrep = Nori.new.parse(result)
+      new_data_set = hrep && hrep['NewDataSet']
+      if new_data_set
+        hash_of_cities = new_data_set && new_data_set['Table']
+        if hash_of_cities
+          @cities = hash_of_cities.map{|item| item['City']}
+        else
+          raise Errors::InvalidResponseFormat, 'Unexpected response format'
+        end
+      else
+        raise Errors::CountryInvalid, 'Returned data set is empty, probably because provided country is invalid'
+      end
+    end
+  end
+end

data/lib/global_weather/errors.rb

@@ -0,0 +1,10 @@
+module GlobalWeather
+  module Errors
+    class CityNotProvided       < Exception; end
+    class CountryNotProvided    < Exception; end
+    class CityOrCountryInvalid  < Exception; end
+    class CountryInvalid        < Exception; end
+    class InvalidResponseFormat < Exception; end
+    class RequestFailure        < Exception; end
+  end
+end

data/lib/global_weather/utils.rb

@@ -0,0 +1,21 @@
+module GlobalWeather
+  module Utils
+
+    # Returns local copy of wsdl schema file
+    def self.local_wsdl_file
+      current_file = File.expand_path(File.dirname(__FILE__))
+      File.open(File.join(current_file,'..','..','wsdl','globalweather.asmx.xml'))
+    end
+
+    # Camelize input string
+    def camelize(lower_case_and_underscored_word)
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    end
+
+    # Removes <?xml ... /xml> header from xml string
+    def fix_header!(string_xml)
+      string_xml.gsub!(/\<\?.+\?\>/,'')
+    end
+  end
+end
+

data/lib/global_weather/version.rb

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

data/lib/global_weather/weather.rb

@@ -0,0 +1,85 @@
+module GlobalWeather
+  class Weather
+
+    ATTRIBUTES = %w(location time wind temperature
+                    dew_point relative_humidity pressure sky_conditions
+                    visibility)
+
+    attr_reader *ATTRIBUTES
+
+    def initialize(country = nil, city = nil, options = {})
+
+      client = Client.connect(options)
+
+      raise Errors::CityNotProvided if city.nil?
+      raise Errors::CountryNotProvided if country.nil?
+
+      response = client.call(:get_weather) do |locals|
+        locals.message 'CountryName' => country, 'CityName' => city
+      end
+
+      if response.success?
+        body   = response.hash[:envelope] && response.hash[:envelope][:body]
+        if body
+          result = body[:get_weather_response] && body[:get_weather_response][:get_weather_result]
+          create_attributes(result)
+        end
+      else
+        raise Errors::RequestFailure, 'Request to SOAP service failed'
+      end
+    end
+
+    private
+
+    include Utils
+
+    def create_attributes(string_xml_or_hash)
+      # Current weather information are returning as xml string instead of hash
+      # That is why I parse it here with Nori into a hash
+      hrep = if string_xml_or_hash.is_a?(String)
+               raise Errors::CityOrCountryInvalid if string_xml_or_hash =~ /Data Not Found/
+               Nori.new.parse(fix_header!(string_xml_or_hash))
+              # in case service will return result as hash, do nothing
+             elsif string_xml_or_hash.is_a?(Hash)
+               string_xml_or_hash
+             end
+
+      ATTRIBUTES.each do |attribute|
+        # camelize method is included from Utils
+        instance_variable_set("@#{attribute}", hrep['CurrentWeather'][camelize(attribute)])
+      end
+
+      @temperature       = Weather.convert_temperature_to_hash(@temperature)
+      @time              = Weather.convert_time_to_datetime(@time)
+      @dew_point         = Weather.convert_temperature_to_hash(@dew_point)
+      @pressure          = Weather.convert_pressure_to_hash(@pressure)
+      @relative_humidity = @relative_humidity.to_i
+    end
+
+    def self.convert_temperature_to_hash(input)
+      output = {}
+      /\s*(?<fahrenheit>\-?\d+) F\s*\((?<celsius>\-?\d+) C\)/ =~ input
+      output[:c] = output[:C] = celsius.to_i
+      output[:f] = output[:F] = fahrenheit.to_i
+      output
+    end
+    # Aug 24, 2013 - 11:20 PM EDT / 2013.08.25 0320 UTC&
+    def self.convert_time_to_datetime(input)
+      output = {}
+      edt_and_utc = input.split('/')
+      if edt_and_utc
+        output[:EDT] = output[:edt] = DateTime.parse(edt_and_utc[0].strip) unless edt_and_utc[0].nil?
+        output[:UTC] = output[:utc] = DateTime.strptime(edt_and_utc[1].strip,'%Y.%m.%d %H%M UTC') unless edt_and_utc[1].nil?
+      end
+      output
+    end
+
+    def self.convert_pressure_to_hash(input)
+      output = {}
+      /\s*(?<hg>\d+\.*\d* in\. Hg) \s*\((?<hpa>\d+\.*\d*) hPa\)/ =~ input
+      output[:Hg] = output[:hg] = hg.to_f
+      output[:hPa] = output[:hpa] = hpa.to_f
+      output
+    end
+  end
+end

data/test/functional/country_functional_test.rb

@@ -0,0 +1,26 @@
+require_relative File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class CountryPositiveTests < Test::Unit::TestCase
+  def test_basic_call
+    VCR.use_cassette('cities_by_country_basic_call') do
+      country = GlobalWeather::Country.new 'Germany'
+      assert country.cities.include?('Hannover'), "Following list of cities #{country.cities} does not include Hannover"
+    end
+  end
+end
+
+class CountryNegativeTests < Test::Unit::TestCase
+  def test_no_arguments_provided
+    assert_raise GlobalWeather::CountryNotProvided do
+      GlobalWeather::Country.new
+    end
+  end
+
+  def test_invalid_country_provided
+    VCR.use_cassette('cities_by_country_invalid_country') do
+      assert_raise GlobalWeather::CountryInvalid do
+        GlobalWeather::Country.new 'FarFarFarAway'
+      end
+    end
+  end
+end

data/test/functional/weather_functional_test.rb

@@ -0,0 +1,47 @@
+require_relative File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class GlobalWeatherPositiveTests < Test::Unit::TestCase
+  def test_basic_call
+    # This is REAL service call
+    weather = GlobalWeather::Weather.new 'Germany', 'Berlin', log: false
+
+    assert !weather.time.nil?
+    assert !weather.location.nil?
+    assert !weather.temperature.nil?
+    assert !weather.pressure.nil?
+    assert !weather.relative_humidity.nil?
+    assert !weather.dew_point.nil?
+  end
+end
+
+class GlobalWeatherNegativeTests < Test::Unit::TestCase
+  def test_no_arguments_provided
+    assert_raise GlobalWeather::CityNotProvided, GlobalWeather::CountryNotProvided do
+      GlobalWeather::Weather.new
+    end
+  end
+
+  def test_city_or_country_invalid_1
+    VCR.use_cassette('get_weather_invalid_1') do
+      assert_raise GlobalWeather::CityOrCountryInvalid do
+        GlobalWeather::Weather.new 'Blah', 'Berlin'
+      end
+    end
+  end
+
+  def test_city_or_country_invalid_2
+    VCR.use_cassette('get_weather_invalid_2') do
+      assert_raise GlobalWeather::CityOrCountryInvalid do
+        GlobalWeather::Weather.new 'Germany', 'Blah'
+      end
+    end
+  end
+
+  def test_city_or_country_invalid_3
+    VCR.use_cassette('get_weather_invalid_3') do
+      assert_raise GlobalWeather::CityOrCountryInvalid do
+        GlobalWeather::Weather.new 'Blah', 'Blah'
+      end
+    end
+  end
+end