aemet_opendata 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7f4fa2502e57760e72513d608c52257c102f8668dc97f6471cda9db3c352311
-  data.tar.gz: 191d32de5ce06e1694952686f56d1ba275bfab52534ecc5d9ab758a0b9cfc585
+  metadata.gz: 9c932797e860c6c72540fdd3e4183e565964e972acc266ff187962a864b08137
+  data.tar.gz: dbd13826f541c2ea9ae085b7579727f3277e8aab20ad429ae06329c51f5760b6
 SHA512:
-  metadata.gz: 362054b3c3e879105cf74316f2296278e3c28b14cb3421087a6f3a062cefcce488c89a8186bb8075baa333ac8700e41effd7465b9bae394c8f12bf27f28674ca
-  data.tar.gz: 4ca70c238d66bc10b6d0e4753a6bb5eb93a6945233fb2efea03a7d6f38f6d12190dda320414f241347a0e6372d9248c9b1da081b6639a766ca7124f44ce13917
+  metadata.gz: ab17dfc1819b50c02dd69e2c730f1571285aeb22a03e6a4cd106b7275d1de34fe45728c4156b70bdad684257e7a08aa76b15b78aa89d8574ba189d8ad18f7ff5
+  data.tar.gz: 45a448931bb565df2e5aee11de85514caed400e095f7b3ad9d57b05d6a8149d344fe7e7483f3cc926615257253b55ba6d1d696b75f32909935cc95c940ebe898

data/.travis.yml

@@ -1,7 +1,6 @@
----
-sudo: false
+before_install:
+  - npm i -g npm
+  - gem install bundler
 language: ruby
-cache: bundler
 rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.4
+ - 2.2

data/Gemfile.lock

@@ -1,16 +1,19 @@
 PATH
   remote: .
   specs:
-    aemet_opendata (0.0.1)
+    aemet_opendata (0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
     faraday (0.15.3)
       multipart-post (>= 1.2, < 3)
     faraday-encoding (0.0.5)
       faraday
+    ffi (1.9.25)
     json (2.1.0)
     multipart-post (2.0.0)
     rake (10.5.0)
@@ -27,6 +30,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (4.0.0)
 
 PLATFORMS
   ruby
@@ -34,11 +40,13 @@ PLATFORMS
 DEPENDENCIES
   aemet_opendata!
   bundler (~> 1.16)
-  faraday
-  faraday-encoding
-  json
+  faraday (>= 0.15.3)
+  faraday-encoding (>= 0.0.5)
+  json (>= 1.5.5)
   rake (~> 10.0)
   rspec (~> 3.0)
+  typhoeus (>= 1.3.0)
+  vcr (>= 4.0.0)
 
 BUNDLED WITH
    1.16.5

data/README.md

@@ -1,8 +1,11 @@
 # AemetOpendata
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/aemet_opendata`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/aemet_opendata.svg)](https://rubygems.org/gems/aemet_opendata)
+[![Code Climate](https://codeclimate.com/github/noloman/aemet_opendata/badges/gpa.svg)](https://codeclimate.com/github/noloman/aemet_opendata)
 
-TODO: Delete this and the text above, and describe your gem
+### Información elaborada por la [Agencia Estatal de Meteorología](https://www.aemet.es)
+
+Gem that fetches meteorological information from https://opendata.aemet.es, the OpenData web portal from spanish meteorological agency, [AEMET](https://www.aemet.es)
 
 ## Installation
 
@@ -22,7 +25,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you need to have a valid API key for making requests. Just go to https://opendata.aemet.es/centrodedescargas/altaUsuario and get one.
+
+Once you have a valid API key, you can enter it as in the following example:
+```
+AemetOpendata.configure do |config|
+  config.api_key = 'api-key'
+end
+```
+Then after you have entered your API key, just `AemetOpendata.fetch_city(city_name)` where `city_name` is the name of the city you want to fetch. (**NOTE**: as this is a gem in a very alpha stage, it will just return an 'idema' number).
 
 ## Development
 
@@ -32,7 +43,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/aemet_opendata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/noloman/aemet_opendata. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/aemet_opendata.gemspec

@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "json", "~> 1.5.5"
-  spec.add_development_dependency "faraday", "~> 0"
-  spec.add_development_dependency "faraday-encoding", "~> 0"
-  spec.add_development_dependency 'vcr', "~> 0"
+  spec.add_development_dependency "json", ">= 1.5.5"
+  spec.add_development_dependency "faraday", ">= 0.15.3"
+  spec.add_development_dependency "faraday-encoding", ">= 0.0.5"
+  spec.add_development_dependency 'vcr', ">= 4.0.0"
+  spec.add_development_dependency 'typhoeus', ">= 1.3.0"
 end

data/lib/aemet_opendata.rb

@@ -4,10 +4,15 @@ require 'json'
 require 'faraday'
 require 'faraday-encoding'
 
+##
+# Main module
 module AemetOpendata
   extend Configuration
-  # Fetches a city from the stations
+  ##
+  # Class that handles fetching of a city data from the API
   class << self
+    ##
+    # Fetches the 'idema' number from Aemet
     def fetch_city(city_name)
       if !AemetOpendata.api_key.nil?
         conn = Faraday.new "#{AemetOpendata.api_endpoint}", ssl: { verify: false }
@@ -28,6 +33,8 @@ module AemetOpendata
 
     private
 
+    ##
+    # Parses the API response
     def parse_response(response, city_name)
       data_connection = Faraday.new(response['datos'].to_s, ssl: { verify: false }) do |connection|
         connection.response :encoding  # use Faraday::Encoding middleware
@@ -35,16 +42,46 @@ module AemetOpendata
       end
 
       json_array = JSON.parse(data_connection.get.body)
-      parse_cities(city_name, json_array)
+      city_idema = parse_and_fetch_city_idema(city_name, json_array)
+      unless city_idema.nil?
+        ##
+        # Now we have to fetch the conventional observation weather from the idema.
+        # It should return a hash containing JSON objects of the weather in
+        # the place defined by the idema in the following 24 hours.
+        city_weather_url = "#{AemetOpendata.api_endpoint}/opendata/api/observacion/convencional/datos/estacion/#{city_idema}?api_key=#{AemetOpendata.api_key}"
+        city_weather_hash =
+          get_city_weather_from_idema(city_weather_url)
+      end
     end
 
-    def parse_cities(city_name, json_array)
+    ##
+    # Parses the city name from the JSON array containing the data
+    def parse_and_fetch_city_idema(city_name, json_array)
+      res = nil
       json_array.each do |key|
         city = key.to_h
         if city['ubi'].force_encoding('UTF-8').include?(city_name.upcase)
-          return city['idema'].encode('UTF-8')
+          res = city['idema'].encode('UTF-8')
         end
       end
+      res
+    end
+
+    ##
+    # Retrieves a hash with the city weather for the next 24 hours.
+    def get_city_weather_from_idema(data_url)
+      city_connection = Faraday.new(data_url, ssl: { verify: false }) do |connection|
+        connection.response :encoding # use Faraday::Encoding middleware
+        connection.adapter Faraday.default_adapter # net/http
+      end
+
+      conn_hash = JSON.parse(city_connection.get.body)
+      datos_url = conn_hash['datos']
+      datos_connection = Faraday.new(datos_url, ssl: { verify: false }) do |connection|
+        connection.response :encoding # use Faraday::Encoding middleware
+        connection.adapter Faraday.default_adapter # net/http
+      end
+      JSON.parse(datos_connection.get.body)
     end
   end
 end

data/lib/aemet_opendata/version.rb

@@ -1,3 +1,3 @@
 module AemetOpendata
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aemet_opendata
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Manuel Lorenzo Parejo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,58 +56,72 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.5
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.3
 - !ruby/object:Gem::Dependency
   name: faraday-encoding
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 description: 
 email:
 - manulorenzop@gmail.com