gares 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f69434b674f7dce5269749d0101d1bd97b468c8a
+  data.tar.gz: 85cdf302cca179cb12fc017aceb06557db090c1a
+SHA512:
+  metadata.gz: 774313d7b1f6f0d42e9b81e841089af25df06a178034edeb416d38eb4b96cc458e6c98a9177b5430e0722533855968c980ef432847ca7196d57e8a8805f5a8a3
+  data.tar.gz: 2e1bbd9c18f5731b28e17a79fd884f22d0c4bfc5c4c4f185b7f84c5a7b92bb3a92dc6c09251b5e7fbb3d9f6dd26ee3d41c55d328f32c6b26b565b535e74018d0

data/.gitignore

@@ -0,0 +1,8 @@
+pkg/*
+doc/*
+rdoc/*
+*.gem
+.bundle
+Gemfile.lock
+.rvmrc
+.gh_pages

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-06-01 12:18:38 +0200 using RuboCop version 0.22.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+ClassLength:
+  Max: 142
+
+# Offense count: 1
+CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 5
+Documentation:
+  Enabled: false
+
+# Offense count: 53
+LineLength:
+  Max: 704
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+MethodLength:
+  Max: 19
+
+# Offense count: 2
+MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 5
+RescueModifier:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+notifications:
+  email: false
+
+rvm:
+  - 2.0
+  - 2.1
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+before_install:
+  - gem install fakeweb
+
+script:
+  - "bundle exec rake spec"

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2015 Paul Bonaud
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,85 @@
+# Gares (en-mouvement)
+
+## Description
+
+The Gares gem allows you to easy access publicly available data from gares-en-mouvement.com.
+
+## Features
+
+Gares currently features the following:
+
+* Search for a gare
+* Retrieve complete gare information
+
+## Examples
+
+### Gare:
+
+    g = Gares::Gare.new("frabt")
+
+    g.name
+    #=> "Abancourt"
+
+    g.services.first
+    #=> "Borne Automatique"
+
+### Searching:
+
+    g = Gares::Search.new("Aix")
+
+    g.gares.size
+    #=> 3
+
+## Installation
+
+    gem install gares
+
+Or, if you're using this in a project with Bundler:
+
+    gem gares
+
+## Running Tests
+
+As this gem uses content from gare-en-mouvement.com, the test suite uses a set of
+pre-defined fixute files in `spec/fixtures`. These fixtures are
+copies of gares-en-mouvement page used in tests.
+
+Run bundle install to install all dependencies, including fakeweb, which
+will serve the fixture files instead of doing actual requests to gares-en-mouvement.com.
+
+    $ bundle install
+
+Next, simple run `rake` to run the entire test suite.
+
+### Running against actual gare-en-mouvement data
+
+It's possible to run the test suite directly against gares-en-mouvement.com. This has
+two disadvantages:
+
+ 1. Tests will be slow
+ 2. Running tests often will probably get you into trouble, see Disclaimer.
+
+    $ LIVE_TEST=true rake
+
+If you want to run against actual gares-en-mouvement data, it's better to just update
+the fixture files once with up-to-date content:
+
+    $ rake fixtures:refresh
+
+When you run the test suite now, it will use the updated fixture files.
+
+## Disclaimer
+
+Neither I, nor any developer who contributed to this project, accept any kind of
+liability for your use of this library.
+
+gares-en-mouvement does not permit use of its data by third parties without their consent.
+
+Using this library for anything other than limited personal use may result
+in an IP ban to the gares-en-mouvement website.
+
+_This gem is not endorsed or affiliated with gares-en-mouvement.com, or SNCF, Inc._
+
+## License
+
+See [MIT-LICENSE](https://github.com/paulrbr/gares/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+load File.expand_path(File.dirname(__FILE__) + '/tasks/fixtures.rake')
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'gares/version'
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Gares #{Gares::VERSION} documentation"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--webcvs=http://github.com/paulrbr/gares/tree/master/'
+end
+
+require 'gokdok'
+Gokdok::Dokker.new do |gd|
+  gd.repo_url = 'git@github.com:paulrbr/gares.git'
+  gd.doc_home = 'rdoc'
+  gd.remote_path = '.'
+end

data/gares.gemspec

@@ -0,0 +1,32 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'gares/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'gares'
+  s.licenses    = ['MIT']
+  s.version     = Gares::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Paul Bonaud']
+  s.email       = ['paul+gh@bonaud.fr']
+  s.homepage    = 'http://github.com/paulrbr/gares'
+  s.summary     = %q(Easily access the publicly available information on gares-en-mouvement.com.)
+  s.description = %q(Easily use Ruby or the command line to find information on gares-en-mouvement.com.)
+
+  s.rubyforge_project = 'gares'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'nokogiri', '~> 1.6'
+  s.add_dependency 'hashie', '~> 0'
+  s.add_dependency 'unidecoder', '~> 0'
+
+  s.add_development_dependency 'rake', '~> 0'
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_development_dependency 'gokdok', '~> 0'
+  s.add_development_dependency 'rdoc', '~> 0'
+  s.add_development_dependency 'fakeweb', '~> 0'
+
+end

data/lib/gares/base.rb

@@ -0,0 +1,49 @@
+module Gares
+  # Represents something on gare-en-mouvement.com
+  class Base
+    attr_accessor :slug, :name
+
+    # Initialize a new Gare object with it's gare-en-mouvemnt id (as a String)
+    #
+    #   gare = Gares::Gare.new("frabt")
+    #
+    # Gares::Gare objects are lazy loading, meaning that no HTTP request
+    # will be performed when a new object is created. Only when you use an
+    # accessor that needs the remote data, a HTTP request is made (once).
+    #
+    def initialize(slug, name = nil)
+      @slug = slug
+      @name = name if name
+    end
+
+    def horaires
+      document.at('ul.ouverture_heure').inner_html rescue nil
+    end
+
+    # Returns a string containing the name
+    def name(force_refresh = false)
+      if @name && !force_refresh
+        @name
+      else
+        @name = document.at('h1').inner_html.gsub(/En direct de /, '') rescue nil
+      end
+    end
+
+    private
+
+    # Returns a new Nokogiri document for parsing.
+    def document
+      @document ||= Nokogiri::HTML(Gares::Gare.find_by_slug(@slug))
+    end
+
+    # Use HTTParty to fetch the raw HTML for this movie.
+    def self.find_by_slug(slug, page = :"votre-gare")
+      open("http://www.gares-en-mouvement.com/fr/#{slug}/#{page}")
+    end
+
+    # Convenience method for search
+    def self.search(query)
+      Gares::Search.new(query).gares
+    end
+  end # Gare
+end # Gares

data/lib/gares/gare.rb

@@ -0,0 +1,5 @@
+module Gares
+  # Represents a Gare on gares-en-mouvement.com
+  class Gare < Base
+  end # Gare
+end # Gares

data/lib/gares/gare_list.rb

@@ -0,0 +1,15 @@
+module Gares
+  class GareList
+    def gares
+      @gares ||= parse_gares
+    end
+
+    private
+
+    def parse_gares
+      result.compact.uniq.map do |gare|
+        Gares::Gare.new(gare.slug, gare.name)
+      end
+    end
+  end # GareList
+end # Gares

data/lib/gares/search.rb

@@ -0,0 +1,48 @@
+module Gares
+  # Search Gares-en-mouvement for a gare name
+  class Search < GareList
+    attr_reader :query
+
+    GARES_LIST_URL = "https://www.kimonolabs.com/api/7jys32dy?apikey=lsOO4tNm78cH9JxqWg9gAk9l4nYaou9j&kimmodify=1"
+
+    # Initialize a new Gares search with the specified query
+    #
+    #   search = Gares::Search.new("Aix")
+    #
+    # Gares::Search is lazy loading, meaning that unless you access the +gares+
+    # attribute, no query is made to gares-en-mouvement.com.
+    #
+    def initialize(query)
+      @query = query
+    end
+
+    # Returns an array of Gares::Gare objects for easy search result yielded.
+    # If the +query+ was an exact match, a single element array will be returned.
+    def gares
+      @gares ||= (exact_match? ? parse_gare : parse_gares)
+    end
+
+    private
+
+    def document
+      @document ||= Hashie::Mash.new(JSON.load(Gares::Search.query))
+    end
+
+    def result
+      @result ||= document.results.collection1.map(&:station).select { |gare| gare.name.to_ascii =~ /#{@query}/i }
+    end
+
+    def self.query
+      open(GARES_LIST_URL)
+    end
+
+    def parse_gare
+      gare = result.first
+      [Gares::Gare.new(gare.slug, gare.name)]
+    end
+
+    def exact_match?
+      result.count == 1
+    end
+  end # Search
+end # Gares

data/lib/gares/string_extensions.rb

@@ -0,0 +1,22 @@
+require 'cgi'
+
+module Gares #:nordoc:
+  module StringExtensions
+    # Unescape HTML
+    def unescape_html
+      CGI.unescapeHTML(encode('UTF-8'))
+    end
+
+    # Strip tags
+    def strip_tags
+      gsub(/<\/?[^>]*>/, '')
+    end
+
+    # Strips out whitespace then tests if the string is empty.
+    def blank?
+      strip.empty?
+    end unless method_defined?(:blank?)
+  end
+end
+
+String.send :include, Gares::StringExtensions

data/lib/gares/version.rb

@@ -0,0 +1,3 @@
+module Gares
+  VERSION = '0.1.0'
+end

data/lib/gares.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__)) unless
+  $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'open-uri'
+require 'rubygems'
+require 'nokogiri'
+require 'json'
+require 'hashie'
+require 'unidecoder'
+
+require 'gares/base'
+require 'gares/gare'
+require 'gares/gare_list'
+require 'gares/search'
+require 'gares/string_extensions'
+require 'gares/version'