emt_api 0.0.0.3 → 0.0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d3b77f18b216d98f73993b02edf6f45f84d001f
-  data.tar.gz: c5061c3114296e4d10e4be3e6e34b921733ad455
+  metadata.gz: 2b88a0c69df58eb8e5ff9341922dd3e1f8c14ec7
+  data.tar.gz: f11991b1767a9987246224a3eda5dd94c9103b48
 SHA512:
-  metadata.gz: 1e2273bad226346c5dacab29d2e74cab75d136b0d0ddfabe872301ea1661ea11eac6369fc93231404a2a6aa7658f892863c64507a39406ed62f7500e83aaed69
-  data.tar.gz: 7b47fe118f183e75654223bc07c266c7cd2c63c2e9126580e35f726a450de62f86a10d916882c402d430f639454782198a3db175a0ba9dd167ecb4972620ba40
+  metadata.gz: e459255a76deaee063239de730c8896bdf731467964435aca5e1d89835fcdd67133097df178d9c70af8d145d06da447e0e829caf21daa3b98e78459236194de3
+  data.tar.gz: 01292adaf66ac1a4ba31dde2f077e9b6591ea63a8b613c478b3f2854f5a2e6a38aee7c0e9717645636c027e3f1cca5fd22027445ce4b8b5a0e119fb83f8f0db0

data/README.md

@@ -1,9 +1,10 @@
 # EmtApi
 
+[![Gem Version](https://badge.fury.io/rb/emt_api.svg)](https://badge.fury.io/rb/emt_api)
 [![Build Status](https://travis-ci.org/amiedes/emt_api.svg?branch=master)](https://travis-ci.org/amiedes/emt_api)
 [![Coverage Status](https://coveralls.io/repos/github/amiedes/emt_api/badge.svg)](https://coveralls.io/github/amiedes/emt_api)
 
-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/emt_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+`EmtApi` is a Ruby wrapper around the Madrid [EMT](http://www.emtmadrid.es/Home) API which provides an easier and more ruby-like access to the information related to Madrid city urban buses.
 
 ## Installation
 
@@ -16,7 +17,7 @@ gem 'emt_api'
 And then execute:
 
 ```
-$ bundle
+$ bundle install
 ```
 
 Or install it yourself as:
@@ -25,9 +26,61 @@ Or install it yourself as:
 $ gem install emt_api
 ```
 
+The EMT API requires you to have a `idClient` and `passKey` (called `EMT_CLIENT` and `EMT_SECRET` respectively from now on) to authenticate your requests. You can get these freely by filling [this form](http://opendata.emtmadrid.es/Formulario).
+
+`emt_api` expects them to be accessible as environment variables. To do this on Mac OS X you'll have to edit your `.bash_profile` and add the following lines:
+
+```bash
+# ~/.bash_profile
+export EMT_CLIENT="your idClient"
+export EMT_SECRET="your passKey"
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+### Get basic info about bus lines
+
+```ruby
+require 'emt_api'
+
+line = EmtApi::Line.find(1)
+
+line.id           # => "001"
+line.label        # => "1"
+line.date_first   # => #<Date: 2017-01-09 ((2457763j,0s,0n),+0s,2299161j)>
+line.date_end     # => #<Date: 2999-12-31 ((2816787j,0s,0n),+0s,2299161j)>
+line.origin       # => "Cristo Rey"
+line.destination  # => "Prosperidad"
+
+all_lines = EmtApi::Line.all
+
+all_lines.size      # => 208
+
+all_lines.first.id  # => "001"
+# etc.
+```
+
+### Get basic info about bus stops
+
+```ruby
+require 'emt_api'
+
+stop = EmtApi::Stop.find(1)
+
+stop.id         # => 1
+stop.name       # => "Av. Valdemarin - Altair"
+stop.lines      # => ["", "161/1/1"]
+stop.wifi?      # => false
+stop.latitude   # => 40.47004454502
+stop.longitude  # => -3.782887713069
+
+all_stops = EmtApi::Stop.all
+
+all_stops.size      # => 4677
+
+all_stops.first.id  # => 1
+# etc.
+```
 
 ## Development
 
@@ -37,8 +90,10 @@ 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]/emt_api.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/amiedes/emt_api](https://github.com/amiedes/emt_api).
 
 ## License
 
+*Powered by EMT Madrid* - [Terms & Conditions](http://opendata.emtmadrid.es/Documentos/terminosycondiciones.aspx?lang=es-ES)
+
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/emt_api.rb

@@ -1,6 +1,7 @@
 require 'emt_api/version'
 require 'emt_api/api'
 require 'emt_api/line'
+require 'emt_api/stop'
 
 module EmtApi
   # Your code goes here...

data/lib/emt_api/api.rb

@@ -1,9 +1,10 @@
 require 'http'
-require_relative 'response'
+require 'emt_api/response'
 
 module EmtApi
   class Api
     GET_LIST_LINES_URL = 'https://openbus.emtmadrid.es:9443/emt-proxy-server/last/bus/GetListLines.php'
+    GET_NODE_LINES_URL = 'https://openbus.emtmadrid.es:9443/emt-proxy-server/last/bus/GetNodesLines.php'
     EMT_CLIENT = ENV['EMT_CLIENT']
     EMT_SECRET = ENV['EMT_SECRET']
 
@@ -21,5 +22,20 @@ module EmtApi
       emt_response.valid_data? ? emt_response.data : nil
     end
 
+    # Recupera todos los identificadores de parada, junto con su coordenada UTM,
+    # nombre y la relación de líneas/sentido que pasan por cada uno de ellos.
+    def self.get_nodes_lines(stop_id = nil)
+
+      http_response = HTTP.post(GET_NODE_LINES_URL, form: {
+          idClient: EMT_CLIENT,
+          passKey: EMT_SECRET,
+          Nodes: stop_id
+      })
+
+      emt_response = EmtApi::Response.new(http_response)
+
+      emt_response.valid_data? ? emt_response.data : nil
+    end
+
   end
 end

data/lib/emt_api/line.rb

@@ -1,5 +1,5 @@
-require_relative 'parser'
-require_relative 'api'
+require 'emt_api/parser'
+require 'emt_api/api'
 
 module EmtApi
   class Line

data/lib/emt_api/parser.rb

@@ -8,6 +8,7 @@ module EmtApi
 
     def self.parse_sentence(sentence)
       sentence = remove_trailing_whitespaces(sentence)
+      sentence = add_spaces_between_separators(sentence)
       capitalize_sentence(sentence)
     end
 
@@ -15,6 +16,21 @@ module EmtApi
       sentence.rstrip
     end
 
+    def self.add_spaces_between_separators(sentence)
+      spaced_sentence = sentence
+
+      # Add space before the '-' character
+      spaced_sentence.gsub!(/(?!\s)\-/, ' -')
+
+      # Add space after the '-' character
+      spaced_sentence.gsub!(/\-(?!\s)/, '- ')
+
+      # Add space after the '.' used for abbreviations
+      spaced_sentence.gsub!(/\.(?!\s)/, '. ')
+
+      spaced_sentence
+    end
+
     def self.capitalize_sentence(sentence)
       sentence.split.map { |word| word.capitalize }.join(' ')
     end

data/lib/emt_api/stop.rb

@@ -0,0 +1,37 @@
+require 'byebug'
+
+module EmtApi
+  class Stop
+    attr_accessor :id, :name, :lines, :latitude, :longitude
+
+    def initialize(stop_data = {})
+      @id         = stop_data['node']
+      @name       = EmtApi::Parser.parse_sentence stop_data['name']
+      @lines      = stop_data['lines']
+      @wifi       = (stop_data['Wifi'].to_i == 1)
+      @latitude   = stop_data['latitude']
+      @longitude  = stop_data['longitude']
+    end
+
+    def self.all
+      response_data = EmtApi::Api.get_nodes_lines
+      stops = []
+
+      unless response_data.nil?
+        response_data.each { |stop| stops << EmtApi::Stop.new(stop) }
+      end
+
+      stops
+    end
+
+    def self.find(id)
+      response_data = EmtApi::Api.get_nodes_lines(id)
+      response_data.nil? ? nil : EmtApi::Stop.new(response_data)
+    end
+
+    def wifi?
+      @wifi
+    end
+
+  end
+end

data/lib/emt_api/version.rb

@@ -1,3 +1,3 @@
 module EmtApi
-  VERSION = "0.0.0.3"
+  VERSION = "0.0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emt_api
 version: !ruby/object:Gem::Version
-  version: 0.0.0.3
+  version: 0.0.0.4
 platform: ruby
 authors:
 - Alberto Miedes Garcés
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -130,6 +130,7 @@ files:
 - lib/emt_api/line.rb
 - lib/emt_api/parser.rb
 - lib/emt_api/response.rb
+- lib/emt_api/stop.rb
 - lib/emt_api/version.rb
 homepage: https://github.com/amiedes/emt_api
 licenses: