hg-weather 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7d4ec3fd09af7a164322701fa97a41c42175df8
+  data.tar.gz: 0ceb34a84d0615f0066ee6fc436b269f03c357aa
+SHA512:
+  metadata.gz: 59d305e2b8af1144dc45abcffb5ef27edbb3521fbf8a5faf0945dae92124241085fd32c0df2d487d914db46af1b412e7c5fd415cff1a3404fc87e8c552315705
+  data.tar.gz: f941ba9d787daaf439193e0649ffc80d273c5a026a2c2aa943920fa29390ed8e9357499569f37a97ec12696f9fec16da00fc55c8dbee7939fd8276eafde70272

data/lib/hg/weather.rb

@@ -0,0 +1,66 @@
+require 'open-uri'
+require 'json'
+
+require 'hg/weather/version'
+require 'hg/weather/data'
+
+module HG
+  module Weather
+    HOST_NAME = '://api.hgbrasil.com/weather'
+
+    class << self
+      # API Key
+      attr_accessor :api_key
+      @@api_key = nil
+
+      # API Key status
+      attr_reader :api_key_status
+      @@api_key_status = :unknown
+
+      # Use SSL to access the API
+      attr_accessor :use_ssl
+      @@use_ssl = true
+
+      # Use Rails cache for recieved data (realy recommended)
+      attr_accessor :use_rails_cache
+      @@use_rails_cache = true
+
+      attr_accessor :cid, :city_name, :latitude, :longitude, :client_ip
+      @@client_ip = :remote
+    end
+
+    def self.setup(&block)
+      yield self
+    end
+
+    def self.get(options = {})
+      to_request = {
+        lat: options[:latitude], lon: options[:longitude],
+        cid: options[:cid], city_name: options[:city_name],
+        user_ip: options[:client_ip]
+      }.delete_if{|k,v| v.nil?}
+
+      process(to_request)
+    end
+
+    def self.process params
+      params = defaults.merge(params).delete_if{|k,v| v.nil?}
+
+      return HG::Weather::Data.new(params, HOST_NAME, self.use_ssl)
+    end
+
+    def self.defaults
+      {
+        lat: self.latitude,
+        lon: self.longitude,
+        user_ip: self.client_ip,
+        cid: self.cid,
+        city_name: self.city_name,
+        key: self.api_key,
+        format: :json,
+        sdk_version: "ruby_#{HG::Weather::VERSION}"
+      }
+    end
+
+  end
+end

data/lib/hg/weather/condition.rb

@@ -0,0 +1,104 @@
+require 'hg/weather/temperature'
+
+module HG
+  module Weather
+
+    class Condition
+      ONE_DAY = 86_400
+
+      # Public: Temperature
+      attr_accessor :temperature
+
+      # Public: Max Temperature
+      attr_accessor :max_temperature
+
+      # Public: Min Temperature
+      attr_accessor :min_temperature
+
+      # Public: Humidity
+      attr_accessor :humidity
+
+      # Public: Image ID
+      attr_accessor :image_id
+
+      # Public: Description
+      attr_accessor :description
+
+      # Public: Slug
+      attr_accessor :slug
+
+      # Public: Wind speedy
+      attr_accessor :wind_speed
+
+      # Public: Sunrise
+      attr_accessor :sunrise
+
+      # Public: Sunset
+      attr_accessor :sunset
+
+      # Public: Currently, day or night
+      attr_accessor :currently
+
+      # Public: Datetime, if forecast time is always midnight
+      attr_accessor :datetime
+
+      # Public: Is forecast
+      attr_accessor :is_forecast
+
+      def initialize(options = {})
+        if options.count != 0
+          @temperature      = Temperature.new(options[:temperature]) if options[:temperature]
+          @max_temperature  = Temperature.new(options[:max_temperature]) if options[:max_temperature]
+          @min_temperature  = Temperature.new(options[:min_temperature]) if options[:min_temperature]
+          @humidity         = options[:humidity].to_i if options[:humidity]
+          @image_id         = options[:image_id] if options[:image_id]
+          @description      = options[:description] if options[:description]
+          @slug             = options[:slug].to_sym if options[:slug]
+          @wind_speed       = options[:wind_speed] if options[:wind_speed]
+          @currently        = (options[:currently] == 'dia' ? :day : :night) if options[:currently]
+          @datetime         = process_datetime(options[:date], options[:time]) if options[:date]
+          @sunrise          = process_sunrise(options[:sunrise]) if options[:sunrise]
+          @sunset           = process_sunset(options[:sunset]) if options[:sunset]
+          @is_forecast      = options[:is_forecast] if options[:is_forecast]
+        end
+      end
+
+      def is_day?
+        return nil if self.currently.nil?
+        self.currently == :day
+      end
+
+      def is_night?
+        return nil if self.currently.nil?
+        self.currently == :night
+      end
+
+      protected
+      def process_datetime date, time = nil
+        return Time.now if date.nil?
+
+        return Time.strptime((date + ' ' + (time ? time : '00:00')), '%d/%m/%Y %H:%M')
+      end
+
+      def process_sunset sunset
+        return nil if sunrise.nil? || self.datetime.nil?
+        sunset = Time.parse(sunset)
+
+        return (sunset > midnight_of(self.datetime + ONE_DAY) ? sunset - ONE_DAY : sunset)
+      end
+
+      def process_sunrise sunrise
+        return nil if sunrise.nil? || self.datetime.nil?
+        sunrise = Time.parse(sunrise)
+
+        return (sunrise < midnight_of(self.datetime + ONE_DAY) ? sunrise + ONE_DAY : sunrise)
+      end
+
+      def midnight_of time
+        time = Time.now if time.nil?
+        Time.new(time.year, time.month, time.day)
+      end
+    end
+
+  end
+end

data/lib/hg/weather/data.rb

@@ -0,0 +1,71 @@
+require 'hg/weather/condition'
+
+module HG
+  module Weather
+
+    class Data
+
+      attr_accessor :request, :requested_at, :key_status
+      attr_accessor :condition, :forecast
+      attr_accessor :cid, :city_name, :search_method
+
+      def initialize params, host_name, use_ssl = true
+        query_params = params.map{|k,v| "#{k.to_s}=#{v.to_s}"}.join('&')
+        @request = (use_ssl ? 'https' : 'http') + host_name + '?' + query_params
+        @requested_at = Time.now
+
+        request_data = JSON.parse(open(self.request).read)
+
+        if request_data['results']
+          results = request_data['results']
+
+          @key_status = (params[:key] ? (request_data['key_status'] == 'valida' ? :valid : :invalid) : :empty)
+
+          @city_name = results['city_name']
+          @search_method = request_data['by']
+          @cid = results['cid']
+
+          @condition = Condition.new(to_current(results))
+
+          @forecast = []
+          results['forecast'].each do |forecast|
+            @forecast << Condition.new(to_forecast(forecast))
+          end
+        end
+
+        return self
+      end
+
+
+      def to_current r
+        {
+          temperature: r['temp'],
+          description: r['description'],
+          slug: r['condition_slug'],
+          wind_speed: r['wind_speedy'],
+          humidity: r['humidity'],
+          image_id: r['image_id'],
+          sunrise: r['sunrise'],
+          sunset: r['sunset'],
+          currently: r['currently'],
+          date: r['date'],
+          time: r['time'],
+          is_forecast: false
+        }
+      end
+
+      # TODO: Improve to get year of date
+      def to_forecast r
+        {
+          date: r['date'] + '/' + Time.now.year.to_s,
+          max_temperature: r['max'],
+          min_temperature: r['min'],
+          description: r['description'],
+          condition_slug: r['condition'],
+          is_forecast: true
+        }
+      end
+    end
+
+  end
+end

data/lib/hg/weather/temperature.rb

@@ -0,0 +1,23 @@
+module HG
+  module Weather
+
+    class Temperature
+      attr_accessor :celsius
+      attr_accessor :fahrenheit
+
+      def initialize temperature, format = :c
+        return if temperature.nil?
+        temperature = temperature.to_f
+
+        if format == :c
+          @celsius = temperature
+          @fahrenheit = (temperature * 1.8) + 32
+        else
+          @fahrenheit = temperature
+          @celsius = (temperature - 32) / 1.8
+        end
+      end
+    end
+
+  end
+end

data/lib/hg/weather/version.rb

@@ -0,0 +1,5 @@
+module HG
+  module Weather
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: hg-weather
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hugo Demiglio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-05 00:00:00.000000000 Z
+dependencies: []
+description: Get current and forecast weather using HG Weather API.
+email:
+- hugodemiglio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hg/weather.rb
+- lib/hg/weather/condition.rb
+- lib/hg/weather/data.rb
+- lib/hg/weather/temperature.rb
+- lib/hg/weather/version.rb
+homepage: http://hgbrasil.com/weather
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple gem to get weather data from HG Weather.
+test_files: []