metromobilite 0.2 → 0.2.1

data/README.md

@@ -1,12 +1,24 @@
-# ruby-metromobilite
-Implémentation Ruby de l'API Métromobilite (Transports en commun de Grenoble et d'Isère)
-
-Pour plus d'informations, voir la [Documentation de l'API](http://www.metromobilite.fr/pages/opendata/OpenDataApi.html)
-
-# Utilisation
-
-```ruby
-require 'metromobilite'
-
-Metromobilite::Times.readStop '{SEM,C38}:id'
-```
+[![Gem Version](https://badge.fury.io/rb/metromobilite.svg)](https://badge.fury.io/rb/metromobilite)
+# ruby-metromobilite
+Implémentation Ruby de l'API Métromobilite (Transports en commun de Grenoble et d'Isère)
+
+Pour plus d'informations, voir la [Documentation de l'API](https://www.mobilites-m.fr/pages/opendata/OpenDataApi.html)
+
+# Installation
+En ligne de commande :
+```bash
+$ gem install metromobilite
+```
+
+Gemfile :
+```ruby
+gem 'metromobilite', '>= 0.2'
+```
+
+# Utilisation
+
+```ruby
+require 'metromobilite'
+
+Metromobilite::Times.readStop '{SEM,C38}:id'
+```

data/Rakefile

@@ -1,8 +1,6 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "metromobilite"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/metromobilite/model/pattern.rb

@@ -1,31 +1,31 @@
-require 'json'
-
-module Metromobilite
-    module Model
-        class Pattern
-
-            # Initializes a new Metromobilite::Pattern object
-            #
-            # +jsonData_Hash+::
-            #   The JSON data received and parsed as a Hash
-            def initialize(jsonData)
-
-            @id = jsonData['id']
-            @desc = jsonData['desc']
-            @dir = jsonData['dir']
-            @shortDesc = jsonData['shortDesc']
-            end
-            
-            attr_reader :id
-            attr_reader :desc
-            attr_reader :dir
-            attr_reader :shortDesc
-
-            def to_json(opts = nil)
-                hash = {}
-                instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
-                hash.to_json
-            end
-        end
-    end
+require 'json'
+
+module Metromobilite
+    module Model
+        class Pattern
+
+            # Initializes a new Metromobilite::Pattern object
+            #
+            # +jsonData_Hash+::
+            #   The JSON data received and parsed as a Hash
+            def initialize(jsonData)
+
+            @id = jsonData['id']
+            @desc = jsonData['desc']
+            @dir = jsonData['dir']
+            @shortDesc = jsonData['shortDesc']
+            end
+            
+            attr_reader :id
+            attr_reader :desc
+            attr_reader :dir
+            attr_reader :shortDesc
+
+            def to_json(opts = nil)
+                hash = {}
+                instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+                hash.to_json
+            end
+        end
+    end
 end

data/lib/metromobilite/model/stop.rb

@@ -1,21 +1,21 @@
-require 'json'
-
-module Metromobilite
-    module Model
-        class Stop
-            def initialize(pattern, times)
-                @pattern = pattern
-                @times = times
-            end
-
-            attr_reader :pattern
-            attr_reader :times
-
-            def to_json(opts = nil)
-                hash = {}
-                instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
-                hash.to_json
-            end
-        end
-    end
-end
+require 'json'
+
+module Metromobilite
+    module Model
+        class Stop
+            def initialize(pattern, times)
+                @pattern = pattern
+                @times = times
+            end
+
+            attr_reader :pattern
+            attr_reader :times
+
+            def to_json(opts = nil)
+                hash = {}
+                instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+                hash.to_json
+            end
+        end
+    end
+end

data/lib/metromobilite/model/time.rb

@@ -1,49 +1,49 @@
-require 'json'
-
-module Metromobilite
-    module Model
-        class Time
-            # Class representing time info at a stop for a single route
-
-            # Instantiates a new Time object from received JSON data
-            # :call-seq:
-            #   Time.new(jsonObj)
-            #
-            # +jsonData_Hash+::
-            #   The Time JSON hash object received from the API
-            def initialize(jsonData)
-                @stopId = jsonData['stopId']
-                @stopName = jsonData['stopName']
-                @scheduledArrival = jsonData['scheduledArrival']
-                @scheduledDeparture = jsonData['scheduledDeparture']
-                @realtimeArrival = jsonData['realtimeArrival']
-                @realtimeDeparture = jsonData['realtimeDeparture']
-                @arrivalDelay = jsonData['arrivalDelay']
-                @departureDelay = jsonData['departureDelay']
-                @timepoint = jsonData['timepoint']
-                @realtime = jsonData['realtime']
-                @serviceDay = jsonData['serviceDay']
-                @tripId = jsonData['tripId']
-            end
-            
-            attr_reader :stopId
-            attr_reader :stopName
-            attr_reader :scheduledArrival
-            attr_reader :scheduledDeparture
-            attr_reader :realtimeArrival
-            attr_reader :realtimeDeparture
-            attr_reader :arrivalDelay
-            attr_reader :departureDelay
-            attr_reader :timepoint
-            attr_reader :realtime
-            attr_reader :serviceDay
-            attr_reader :tripId
-
-            def to_json(opts = nil)
-                hash = {}
-                instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
-                hash.to_json
-            end
-        end
-    end
-end
+require 'json'
+
+module Metromobilite
+    module Model
+        class Time
+            # Class representing time info at a stop for a single route
+
+            # Instantiates a new Time object from received JSON data
+            # :call-seq:
+            #   Time.new(jsonObj)
+            #
+            # +jsonData_Hash+::
+            #   The Time JSON hash object received from the API
+            def initialize(jsonData)
+                @stopId = jsonData['stopId']
+                @stopName = jsonData['stopName']
+                @scheduledArrival = jsonData['scheduledArrival']
+                @scheduledDeparture = jsonData['scheduledDeparture']
+                @realtimeArrival = jsonData['realtimeArrival']
+                @realtimeDeparture = jsonData['realtimeDeparture']
+                @arrivalDelay = jsonData['arrivalDelay']
+                @departureDelay = jsonData['departureDelay']
+                @timepoint = jsonData['timepoint']
+                @realtime = jsonData['realtime']
+                @serviceDay = jsonData['serviceDay']
+                @tripId = jsonData['tripId']
+            end
+            
+            attr_reader :stopId
+            attr_reader :stopName
+            attr_reader :scheduledArrival
+            attr_reader :scheduledDeparture
+            attr_reader :realtimeArrival
+            attr_reader :realtimeDeparture
+            attr_reader :arrivalDelay
+            attr_reader :departureDelay
+            attr_reader :timepoint
+            attr_reader :realtime
+            attr_reader :serviceDay
+            attr_reader :tripId
+
+            def to_json(opts = nil)
+                hash = {}
+                instance_variables.each {|var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+                hash.to_json
+            end
+        end
+    end
+end

data/lib/metromobilite/request.rb

@@ -1,14 +1,15 @@
-require 'httparty'
-require 'json'
-
-module Metromobilite
-    module Request
-        API_URI = 'http://data.metromobilite.fr/api'
-        
-        def self.get(reqUri)
-            puts 'Calling GET on ' + API_URI + reqUri
-            httpResult = HTTParty.get(API_URI + reqUri)
-            JSON.parse(httpResult.body)
-        end
-    end
-end
+require 'httparty'
+require 'json'
+
+module Metromobilite
+    module Request
+        API_URI = 'http://data.mobilites-m.fr/api'
+        HEADERS = { 'Origin' => 'rubygems.org' }
+
+        def self.get(reqUri)
+            puts 'Calling GET on ' + API_URI + reqUri
+            httpResult = HTTParty.get(API_URI + reqUri, headers: HEADERS)
+            JSON.parse(httpResult.body)
+        end
+    end
+end

data/lib/metromobilite/times.rb

@@ -1,34 +1,34 @@
-require 'metromobilite/request'
-require 'metromobilite/model/pattern'
-require 'metromobilite/model/time'
-require 'metromobilite/model/stop'
-require 'json'
-
-module Metromobilite
-    module Times
-        RECORDS_URI = '/ficheHoraires/json'
-        LIVE_URI = '/routers/default/index/stops/%s/stoptimes'
-        
-        # Reads the next stop times at a stop, eventually for a given route
-        # Returns an array of Metromobilite::Model::Stop with their associated stop times
-        #
-        # +stopId_string+::
-        #   the stop id
-        #
-        def self.readStop(stopId)
-            uri = LIVE_URI % stopId.to_s
-            jsonData = Metromobilite::Request.get(uri)
-            res = []
-            jsonData.each do |item|
-                pattern = Metromobilite::Model::Pattern.new(item['pattern'])
-                times = []
-                item['times'].each do |timeJson|
-                    times.push(Metromobilite::Model::Time.new timeJson)
-                end
-                res.push(Metromobilite::Model::Stop.new pattern, times)
-            end
-
-            return res
-        end
-    end
-end
+require 'metromobilite/request'
+require 'metromobilite/model/pattern'
+require 'metromobilite/model/time'
+require 'metromobilite/model/stop'
+require 'json'
+
+module Metromobilite
+    module Times
+        RECORDS_URI = '/ficheHoraires/json'
+        LIVE_URI = '/routers/default/index/stops/%s/stoptimes'
+        
+        # Reads the next stop times at a stop, eventually for a given route
+        # Returns an array of Metromobilite::Model::Stop with their associated stop times
+        #
+        # +stopId_string+::
+        #   the stop id
+        #
+        def self.readStop(stopId)
+            uri = LIVE_URI % stopId.to_s
+            jsonData = Metromobilite::Request.get(uri)
+            res = []
+            jsonData.each do |item|
+                pattern = Metromobilite::Model::Pattern.new(item['pattern'])
+                times = []
+                item['times'].each do |timeJson|
+                    times.push(Metromobilite::Model::Time.new timeJson)
+                end
+                res.push(Metromobilite::Model::Stop.new pattern, times)
+            end
+
+            return res
+        end
+    end
+end

data/lib/metromobilite/version.rb

@@ -0,0 +1,3 @@
+module Metromobilite
+  VERSION = "0.2.1"
+end

data/lib/metromobilite.rb

@@ -1,2 +1,2 @@
-require 'metromobilite/times'
-require 'metromobilite/request'
+require 'metromobilite/times'
+require 'metromobilite/request'

data/metromobilite.gemspec

@@ -1,21 +1,34 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |spec|
-  spec.add_dependency 'faraday', '~> 0.15'
-  spec.add_dependency 'json', '~> 2.1'
-  spec.add_dependency 'httparty', '~> 0.17.3'
-  spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.authors = ['Léo Gatellier']
-  spec.summary = 'Implémentation Ruby de l\'API Métromobilite (Transports en commun de Grenoble et d\'Isère).'
-  spec.description = 'Implémentation Ruby de l\'API Métromobilité (Transports en commun de Grenoble et d\'Isère) initialement développée pour être intégrée dans un job dashing/smashing'
-  spec.email = %w(github@leogatellier.fr)
-  spec.files = %w(LICENSE README.md metromobilite.gemspec Rakefile) + Dir['lib/**/*.rb']
-  spec.homepage = 'https://github.com/lgatellier/ruby-metromobilite/'
-  spec.licenses = %w(GPL-3.0)
-  spec.name = 'metromobilite'
-  spec.require_paths = %w(lib)
-  spec.required_ruby_version = '>= 2'
-  spec.required_rubygems_version = '>= 1.3.5'
-  spec.version = 0.2
-end
+require_relative 'lib/metromobilite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metromobilite"
+  spec.version       = Metromobilite::VERSION
+  spec.license       = 'GPL-3.0'
+  spec.authors       = ["Léo GATELLIER"]
+  spec.email         = ["github@leogatellier.fr"]
+
+  spec.summary       = %q{Wrapper Ruby de l'API Métromobilite (Transports en commun de Grenoble et d'Isère).}
+  spec.description   = %q{Wrapper Ruby de l'API Métromobilité (Transports en commun de Grenoble et d'Isère) initialement développée pour être intégrée dans un job smashing.}
+  spec.homepage      = "https://github.com/lgatellier/ruby-metromobilite"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "#{spec.homepage}/issues"
+
+  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'json', '~> 2.1'
+  spec.add_dependency 'httparty', '~> 0.17.3'
+
+  spec.add_development_dependency 'bundler', '~> 2.2.10'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metromobilite
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
 platform: ruby
 authors:
-- Léo Gatellier
+- Léo GATELLIER
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,36 +58,50 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-description: Implémentation Ruby de l'API Métromobilité (Transports en commun de Grenoble
-  et d'Isère) initialement développée pour être intégrée dans un job dashing/smashing
+        version: 2.2.10
+description: Wrapper Ruby de l'API Métromobilité (Transports en commun de Grenoble
+  et d'Isère) initialement développée pour être intégrée dans un job smashing.
 email:
 - github@leogatellier.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".vscode/launch.json"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/metromobilite.rb
 - lib/metromobilite/model/pattern.rb
 - lib/metromobilite/model/stop.rb
 - lib/metromobilite/model/time.rb
 - lib/metromobilite/request.rb
 - lib/metromobilite/times.rb
+- lib/metromobilite/version.rb
 - metromobilite.gemspec
-homepage: https://github.com/lgatellier/ruby-metromobilite/
+homepage: https://github.com/lgatellier/ruby-metromobilite
 licenses:
 - GPL-3.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/lgatellier/ruby-metromobilite
+  source_code_uri: https://github.com/lgatellier/ruby-metromobilite
+  changelog_uri: https://github.com/lgatellier/ruby-metromobilite/CHANGELOG.md
+  bug_tracker_uri: https://github.com/lgatellier/ruby-metromobilite/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -96,16 +110,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.5
+      version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Implémentation Ruby de l'API Métromobilite (Transports en commun de Grenoble
-  et d'Isère).
+summary: Wrapper Ruby de l'API Métromobilite (Transports en commun de Grenoble et
+  d'Isère).
 test_files: []