diMLOrb 0.0.0 → 0.1.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@diMLOrb

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  nokogiri
+  rcov
+  rspec (~> 2.3.0)

data/README.rdoc

@@ -1,6 +1,23 @@
 = diMLOrb
 
-Description goes here.
+*diMLOrb* is a gem that helps you programmatically grab the timetables of the Metro Ligero Oeste (MLO) in the Madrid Community.
+
+*diMLOrb* is mainly web scraping the MLO official website (diMLO): http://www.dimlo.es/Informate/calc.aspx
+
+I just did this little tool in order to have a single click app in my iphone to check the timetable of the train I have to get everyday. For that purpose I created http://dimloya.heroku.com/ which uses this gem.
+
+Currently my little website _diMLOya_ supports only 2 stations of all the network. If someone is ever interested in having support for the whole nextwork I would be more than happy to finish the job, until then I'll leave it like that (I'm a lazy guy :P)
+
+Note that this gems depends on the diMLO website which oftenly tends to be down or not responsive.
+
+
+= Example of Usage
+    require 'diMLOrb'
+    #say I want to go from Pozuelo Oeste station to Colonia Jardín station
+    d = DiMLOrb::DiMLOrb.new(:PozueloOeste, :ColoniaJardin)
+    d.proximo   # => (in minutes) amount of time first  train will take to get to Pozuelo Oeste
+    d.siguiente # => (in minutes) amount of time second train will take to get to Pozuelo Oeste
+    d.duracion  # => (in minutes) amount of time it will take the train to get from Pozuelo Oeste to Colonia Jardin
 
 == Contributing to diMLOrb
  

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/ariera/diMLOrb"
   gem.license = "MIT"
   gem.summary = %Q{Ruby API for the diMLO web timetable service}
-  gem.description = %Q{This gem acts as an API to the MLO (Metro Ligero Oeste) public transportation of Madrid, allowing the user get ETA of the next 2 trains}
+  gem.description = %Q{This gem acts as an API to the MLO (Metro Ligero Oeste) public transportation of Madrid, allowing the user get ETAs of the next 2 trains}
   gem.email = "ariera@gmail.com"
   gem.authors = ["ariera"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.1

data/diMLOrb.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{diMLOrb}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["ariera"]
+  s.date = %q{2011-07-17}
+  s.description = %q{This gem acts as an API to the MLO (Metro Ligero Oeste) public transportation of Madrid, allowing the user get ETAs of the next 2 trains}
+  s.email = %q{ariera@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "diMLOrb.gemspec",
+    "lib/diMLOrb.rb",
+    "lib/stations.rb",
+    "spec/diMLOrb_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ariera/diMLOrb}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby API for the diMLO web timetable service}
+  s.test_files = [
+    "spec/diMLOrb_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+  end
+end
+

data/lib/diMLOrb.rb

@@ -2,19 +2,28 @@
 require 'net/http'
 require 'uri'
 require 'nokogiri'
+require 'stations'
 
 module DiMLOrb
   class DiMLOrb
-      STATIONS = {:colonia_jardin => "Colonia Jardín|ECJ|ML2", :somosaguas_sur => "Somosaguas Sur|SSU|ML2"}
+      #STATIONS = {:colonia_jardin => "Colonia Jardín|ECJ|ML2", :somosaguas_sur => "Somosaguas Sur|SSU|ML2"}
       attr_accessor :uri, :http, :html, :viewstate, :eventvalidation, :proximo, :siguiente, :cookie, :data, :duracion, :from, :to
-      def initialize(from = STATIONS[:colonia_jardin], to = STATIONS[:somosaguas_sur])
-          @from, @to = from, to
+
+      # DiMLOrb.new receives the Metro Ligero Oeste station you are going from and your desired destination
+      # it returns you an object with mainly 3 attributes:
+      # => proximo   = next train arrives in X minutes
+      # => siguiente = the following train arrives in Y minutes
+      # => duraction = how long should it take to go from one station to the other
+      def initialize(from = :ColoniaJardin, to = :SomosaguasSur)
+          @from, @to = STATIONS[from], STATIONS[to]
           @uri = URI.parse("http://www.dimlo.es/Informate/calc.aspx")
           @http = Net::HTTP.new(@uri.host, @uri.port)
           get_validations
           get_times
       end
-    
+      
+      # diMLO website uses cookies and token validations (aka protect from forgery) in its forms
+      # *get_validations* grabs this values, namely: cookie, viewstate and eventvalidation
       def get_validations
           resp = @http.get(@uri.path)
           raise "HTTP Error: #{resp.code}" if resp.code.to_i != 200
@@ -25,6 +34,8 @@ module DiMLOrb
           @eventvalidation = doc.css('#__EVENTVALIDATION').attr('value').value
       end
     
+      # *get_times* asks diMLO website for the next metro timetable and parses the html
+      # to grab the values of _proximo_, _siguiente_ and _duracion_
       def get_times
           #@html = Net::HTTP.post_form(@uri, options)
           req = Net::HTTP::Post.new(@uri.request_uri)
@@ -37,6 +48,9 @@ module DiMLOrb
           @duracion = doc.css('#DuracionTXT').inner_text
       end
     
+      protected
+      
+      # options needed in the form to get the timetables
       def options
           { 
               'origenDDL' => @from, 
@@ -47,6 +61,8 @@ module DiMLOrb
               'btnCalcular.y' =>'5'
           }
       end
+      
+      # headers with the validation tokens, etc, needed to ask for the timetables
       def headers
           {   
               'Cookie' => @cookie, 
@@ -61,16 +77,17 @@ module DiMLOrb
                'Referer' =>	'http://www.dimlo.es/Informate/calc.aspx'}
       end
     
+      # debugging function
       def to_file(file_name = 'dimlo.html')
           f = File.new(file_name,  "w+")
           f.puts @html
           `open #{file_name}`
       end
-    
+      # debugging function
       def from
         @from.split("|").first
       end
-    
+      # debugging function    
       def to
         @to.split("|").first
       end

data/lib/stations.rb

@@ -0,0 +1,34 @@
+module DiMLOrb
+
+  STATIONS = {
+    :ColoniaJardin=>"Colonia Jardín|ECJ|ML2", 
+    :PradoDeLaVega=>"Prado de la Vega|PVE|ML2", 
+    :ColoniaDeLosAngeles=>"Colonia de Los Ángeles|CLA|ML2", 
+    :PradoDelRey=>"Prado del Rey|PRE|ML2", 
+    :SomosaguasSur=>"Somosaguas Sur|SSU|ML2", 
+    :SomosaguasCentro=>"Somosaguas Centro|SCE|ML2", 
+    :PozueloOeste=>"Pozuelo Oeste|PZO|ML2", 
+    :Belgica=>"Bélgica|BLG|ML2", 
+    :DosCastillas=>"Dos Castillas|DCS|ML2", 
+    :CampusDeSomosaguas=>"Campus de Somosaguas|CSO|ML2", 
+    :AvenidaDeEuropa=>"Avenida de Europa|AEU|ML2", 
+    :Berna=>"Berna|BRN|ML2", 
+    :EstacionDeAravaca=>"Estación de Aravaca|EAV|ML2", 
+    :PuertaDeBoadilla=>"Puerta de Boadilla|PBO|ML3", 
+    :InfanteDonLuis=>"Infante Don Luis|IDL|ML3", 
+    :SigloXXI=>"Siglo XXI|SIX|ML3", 
+    :NuevoMundo=>"Nuevo Mundo|NVM|ML3", 
+    :BoadillaCentro=>"Boadilla Centro|BOC|ML3", 
+    :FerialDeBoadilla=>"Ferial de Boadilla|FBO|ML3", 
+    :Cantabria=>"Cantabria|CTB|ML3", 
+    :PradoDelEspino=>"Prado del Espino|PES|ML3", 
+    :VentorroDelCano=>"Ventorro del Cano|VCA|ML3", 
+    :Monteprincipe=>"Montepríncipe|MNT|ML3", 
+    :Retamares=>"Retamares|RTM|ML3", 
+    :Cocheras=>"Cocheras|MLO|ML3", 
+    :CiudadDelCine=>"Ciudad del Cine|CCI|ML3", 
+    :JoseIsbert=>"José Isbert|JIS|ML3", 
+    :CiudadDeLaImagen=>"Ciudad de la Imagen|CIM|ML3"
+  }
+    
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: diMLOrb
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 25
   prerelease: 
   segments: 
   - 0
-  - 0
-  - 0
-  version: 0.0.0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - ariera
@@ -124,7 +124,7 @@ dependencies:
         version: 2.3.0
   name: rspec
   version_requirements: *id007
-description: This gem acts as an API to the MLO (Metro Ligero Oeste) public transportation of Madrid, allowing the user get ETA of the next 2 trains
+description: This gem acts as an API to the MLO (Metro Ligero Oeste) public transportation of Madrid, allowing the user get ETAs of the next 2 trains
 email: ariera@gmail.com
 executables: []
 
@@ -136,12 +136,16 @@ extra_rdoc_files:
 files: 
 - .document
 - .rspec
+- .rvmrc
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
+- diMLOrb.gemspec
 - lib/diMLOrb.rb
+- lib/stations.rb
 - spec/diMLOrb_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true