Module: Weatherzone::Finder

Included in:
Weather
Defined in:
lib/weatherzone/finder.rb

Constant Summary collapse

INCLUDES_MAP = 
{
  :forecasts => "fc=1",
  :point_forecasts => "fc=3",
  :district_forecasts => "dist_fc=1",
  :conditions => "obs=1",
  :warnings => "warn=2",
  :state_forecasts => "state_fc=1",
  :uv_index => "uv=1",
  :sun => "fc_sun=2",
  :moon => "fc_moon=1",
  :historical_observations => "histobs=1",
  :daily_observations => "dlyobs=7",
  :position => "latlon=1",
  :moon_phases => "moon=1",
  :news_items => "news=2",
  :almanac => "almanac=1",
  :links => "links=1",
  :radar_animator => "ra=1",
  :radar_still => "rs=1",
  :satellite_animator => "sa=1",
  :satellite_still => "ss=1",
  :marine_forecast => "marine=1",
  :tides => "tides=4",
  :tide_height => "tideh=1",
  :surf_report => "surf_rpt=2",
  :climate_periods => "climate=1(months=12)",
  :related_locations => "locdet=1",
  :buoy_observations => "buoy=1(period=24)",
  :snow_reports => "snow=3"
}

Class Method Summary collapse

Class Method Details

.included(klass) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/weatherzone/finder.rb', line 35

def self.included(klass)
  klass.class_eval do
    class << self
      def parse_file(file_name)
        parse(File.open(file_name))
      end
      
      def find(connection, options, location_code=nil)
        url_only = options.delete(:url_only)
        set_options(connection, options)
        make_request(connection, build_params(location_code, options), url_only)
      end
      
      def find_by_location_code(connection, location_code, options={})
        options = options.dup
        find(connection, options, location_code)
      end
      
      def find_by_twcid(connection, twcid, options={})
        options = options.dup
        options.merge!(:params => "&lt=twcid&lc=#{twcid}")
        find(connection, options)
      end

      def find_by_location_name(connection, location_name, options={})
        options = options.dup
        location_name = location_name.gsub(" ", "%20").gsub("-", "%20")
        options.merge!(:params => "&lt=aploc&ln=#{location_name}")
        find(connection, options)
      end

      def find_by_swellnet_code(connection, swellnet_code, options={})
        options = options.dup
        options.merge!(:params => "&lt=swellnet&lc=#{swellnet_code}")
        find(connection, options)
      end

      def find_snow_resort(connection, resort_code, options={})
        options = options.dup
        options.merge!(:params => "&lt=snow&lc=#{resort_code}")
        find(connection, options)
      end

      def find_by_location_filter(connection, filter, options={})
        options = options.dup
        options.merge!(:params => "&lt=twcid&lf=#{filter}")
        find(connection, options)
      end
      
      def find_by_district(connection, district_code, options={})
        options = options.dup
        options.merge!(:params => "&lt=twcid&dist=#{district_code}&lf=twcfcast")
        find(connection, options)            
      end

      def find_districts_by_state(connection, state, options={})
        options = options.dup
        options.merge!(:params => "&lt=dist&state=#{state}")
        options[:url_only] ? find(connection, options) : find(connection, options).countries.first.locations
      end

      def find_radars_by_state(connection, state, options={})
        options = options.dup
        options.merge!(:params => "&lt=radar&links=1&ra=1&state=#{state}")
        options[:url_only] ? find(connection, options) : find(connection, options).countries.first.locations
      end
      
      def find_by_radar_code(connection, radar_code, options={})
        options = options.dup
        options.merge!(:params => "&lt=radar&lc=#{radar_code}&links=1&ra=1")
        find(connection, options)   
      end

      def build_params(location_code, options)
        params = location_code ? "&lc=#{location_code}" : ""
        params  += options.delete(:params)                  if options[:params]
        params  += options.delete(:sr_params)               if options[:sr_params]
        params  += include_params(options.delete(:include)) if options[:include]
        params  += include_image(options.delete(:image))    if options[:image]
        params  += parse_params(options) unless options.empty?
        params
      end

      protected
      def set_options(connection, options)
        connection.settings.weather_class ||= self
        self.temperature_unit = options.delete(:temperature_unit)
      end

      def make_request(connection, params, url_only)
        return connection.wz_url_for(params) if url_only
        response = connection.request(params)
        parse(response)
      end
      
      def include_params(includes)
        includes.inject("") do |params, relationship|
          if param = INCLUDES_MAP[relationship]
            params += "&#{param}"
          else
            params
          end
        end
      end
  
      def include_image(image)
        "&images=#{image[:type]}(days=#{image[:days]};size=#{image[:size]})"   
      end

      def parse_params(options)
        options.inject("") do |params, (key, value)|
          params += "&#{key}=#{value}"
        end      
      end
    end
  end
end