weather_by_ip 0.1.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    weather_by_ip (0.0.1)
+      api_object (>= 0.3)
+      geo_ip
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    api_object (0.3.3)
+      activesupport
+      nori (>= 1.1)
+      rest-client (>= 1.6)
+    geo_ip (0.5.0)
+      json (~> 1.4)
+      rest-client (~> 1.6.1)
+    i18n (0.6.0)
+    json (1.7.3)
+    mime-types (1.18)
+    minitest (3.0.1)
+    multi_json (1.3.6)
+    nori (1.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  weather_by_ip!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 tmoskun
+
+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,55 @@
+# WeatherByIp
+
+This gem captures weather information based on ip. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'weather_by_ip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weather_by_ip
+
+## Usage
+
+The gem relies on [ipinfodb.com](http://ipinfodb.com/) webservice to retrieve location based on ip. 
+
+The service requires an API key, in order to get it [register](http://ipinfodb.com/register.php) at the web site. 
+
+Consider making a donation to [ipinfodb.com](http://ipinfodb.com/) at [http://ipinfodb.com/donate.php](http://ipinfodb.com/donate.php).
+
+The gem also uses Google weather service to the weather information by location. It doesn't require any key. 
+
+The weather information then is obtained as the following:
+
+```
+WeatherByIp.get_weather(<your ip>, <your ipinfodb_key>)
+```
+
+## Limitations
+
+THe location by ip service is free and doesn't always give the correct location. 
+
+## Testing
+
+For the test to be run, the ipinfodb.com api key should be either placed into the test/data/keys/ipinfodb_key.txt file or passed as an environment variable:
+
+```
+API_KEY='<your key>' rake test
+```
+
+There is no existing api key provided with this gem as per the Terms and Conditions of the ipinfodb service. 
+
+## 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

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc 'Run tests'
+    task :test do
+      result = system("ruby -Ilib -Itest -e 'ARGV.take(ARGV.size-1).each { |f| load f }' test/unit/* '#{File.read('test/data/keys/ipinfodb_key.txt') rescue ENV['API_KEY']}'")
+      exit(result ? 0 : 1)
+    end
+    
+    task :ci => [:test]
+    task :default => [:test]
+    
+    namespace :pre_commit do
+      desc "run the tests"
+      task :ci => [:test]
+end

data/lib/weather_by_ip.rb

@@ -0,0 +1,18 @@
+require "weather_by_ip/version"
+require 'weather_by_ip/weather'
+
+class WeatherByIp
+
+  class << self
+  
+      include WeatherInfo
+            
+      def get_weather ip, key
+        Weather.new(Weather.get_results_by_ip(ip, key, :weather => :zip_code))
+        rescue
+          puts "Cannot obtain location or weather. Verify that you've obtained and set the api_key for the ipinfodb.com webservice"
+          return
+      end
+            
+  end
+end

data/lib/weather_by_ip/version.rb

@@ -0,0 +1,3 @@
+module WeatherInfo
+  VERSION = "0.1.0"
+end

data/lib/weather_by_ip/weather.rb

@@ -0,0 +1,86 @@
+require 'api_object'
+module WeatherInfo 
+
+  URL = "http://www.google.com"
+  
+  def self.included(base)
+    base.send(:include, ActiveApi)
+  end
+  
+  module WeatherMethods   
+    def to_s
+      inspect
+    end
+    def get_icon_path icon
+      "#{URL.chomp('/')}/#{icon}"
+    end
+  end
+  
+  class ForecastInfo < ActiveApi::ApiObject
+    include WeatherMethods
+    attr_reader :city, :postal_code, :current_date, :current_time
+    
+    api_column :current_date, :forecast_date
+    api_column :current_time, :current_date_time
+    
+    def inspect
+      "#{@city} #{@current_time}"
+    end
+    
+    def ==(other_info)
+      return false if other_info.nil?
+      self.city == other_info.city
+    end
+    
+  end
+  
+  class CurrentWeather < ActiveApi::ApiObject
+    include WeatherMethods
+    attr_reader :sky, :temp_f, :temp_c, :humidity, :wind, :icon
+    
+    api_column :sky, :condition
+    api_column :wind, :wind_condition
+    
+    def inspect
+      "Today #{@temp_f}F (#{@temp_c}C), #{@sky}, #{@humidity}, #{@wind}"
+    end
+  end
+  
+  class WeatherForecast < ActiveApi::ApiObject
+    include WeatherMethods
+    attr_reader :day_of_week, :sky, :temp_low, :temp_high, :icon
+    
+    api_column :temp_low, :low
+    api_column :temp_high, :high
+    api_column :sky, :condition
+    
+    def inspect
+      "#{@day_of_week} low #{@temp_low}, high #{@temp_high}, #{@sky}"
+    end
+    
+    
+  end
+  
+  class Weather < ActiveApi::ApiObject
+    include WeatherMethods
+    attr_reader :forecast_information, :current_conditions, :forecast_conditions
+    
+    initialize_from_api :url => "#{URL}/ig/", :action => 'api', :data_tags => :data
+    
+    api_association :forecast_information, :as => ForecastInfo
+    api_association :current_conditions, :as => CurrentWeather
+    api_association :forecast_conditions, :as => WeatherForecast
+    
+    
+    def inspect
+      "#{@forecast_information} \n\t#{@current_conditions} \n\t#{@forecast_conditions.instance_of?(Array) ? (@forecast_conditions.inject('') {|str, e| (str + e.inspect + "\n\t")}) : @forecast_conditions}"
+    end
+    
+    def ==(other_weather)
+      return false if other_weather.nil?
+      self.forecast_information == other_weather.forecast_information && self.current_conditions != nil && other_weather.current_conditions != nil && self.forecast_conditions.size == other_weather.forecast_conditions.size
+    end
+    
+  end
+end
+  

data/test/unit/weather_by_ip_test.rb

@@ -0,0 +1,24 @@
+require 'minitest/autorun'
+require 'weather_by_ip'
+require 'weather_by_ip/weather'
+
+class WeatherByIpTest < MiniTest::Unit::TestCase  
+    
+    IP = '99.156.82.20'
+  
+    def test_should_get_correct_weather
+        weather = WeatherByIp.get_weather(IP, ARGV.last)
+        unless weather.nil?
+          refute_nil(weather.forecast_information)
+          refute_nil(weather.current_conditions)
+          refute_nil(weather.forecast_conditions)
+          assert_equal(weather.forecast_information.city, "Austin, TX")
+          assert_equal(weather.forecast_information.current_date, Date.today.to_s)
+          assert_match(/^\/ig\/images\/weather\/.+\.gif/, weather.current_conditions.icon)
+          assert(weather.forecast_conditions.size > 3)
+          assert_equal(weather.forecast_conditions[1].day_of_week, Date.tomorrow.strftime("%a"))
+          assert_match(/^\/ig\/images\/weather\/.+\.gif/, weather.forecast_conditions[1].icon)
+        end
+    end
+
+end

data/weather_by_ip.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/weather_by_ip/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["tmoskun"]
+  gem.email         = ["tanyamoskun@gmail.com"]
+  gem.description   = %q{An interface to load weather information based on an approximate user location}
+  gem.summary       = %q{An interface to load weather information based on an approximate user location}
+  gem.homepage      = ""
+
+  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.name          = "weather_by_ip"
+  gem.require_paths = ["lib"]
+  gem.version       = WeatherInfo::VERSION
+  
+  gem.add_development_dependency "minitest"
+  gem.add_dependency('api_object', '>= 0.4')
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: weather_by_ip
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- tmoskun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &72318530 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72318530
+- !ruby/object:Gem::Dependency
+  name: api_object
+  requirement: &72318140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *72318140
+description: An interface to load weather information based on an approximate user
+  location
+email:
+- tanyamoskun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/weather_by_ip.rb
+- lib/weather_by_ip/version.rb
+- lib/weather_by_ip/weather.rb
+- test/unit/weather_by_ip_test.rb
+- weather_by_ip.gemspec
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: An interface to load weather information based on an approximate user location
+test_files:
+- test/unit/weather_by_ip_test.rb