ns-yapi 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9a0c3a195f10cd241f4f0a772e6847aadf53aae8
-  data.tar.gz: cf8b58cafe9440992ce191c11a2e13fd8216e695
+SHA256:
+  metadata.gz: 90e0e28a27c5819ad9ccab28567b1645e19995308e2da96345f0ef7dcb2fdff7
+  data.tar.gz: b815628df8eb973f22856ca0d95c9575e2bc02749225bb95685b622bdabe5c9c
 SHA512:
-  metadata.gz: 667f33d89852136b0b0ceaafe689d2cd35bbb1988abb4f01601b9f52da84096b3a12300f96d0ddb5a2a54d3548ce65c6856098ca9d23ddba635ff6513b9f8efd
-  data.tar.gz: d0987af5c7c1449ac9d6e10db022e686af030e55004a11f2084ebd70de32c8fd2356289e7216eeda38c37bd4c38c17dae8644be14f28ab55aa65531cb91cfb87
+  metadata.gz: 5da72d6d6be93450f0d7c84aae840719df990e26d9253250bf53fc564431f1127fb606292757fef8ef943650b5eb84834b30ca24222be6cbe5e72f83893676a6
+  data.tar.gz: 6bb0a08ac0d239b3fba39e62c094bc207f08c171b9ef3a83e739eefc91078e6fec1ff3045d7dfab95fdda435450f0399b70d102129f88044e288533f90c36b47

data/.rubocop.yml

@@ -0,0 +1,19 @@
+require: rubocop-performance
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 200

data/.ruby-version

@@ -1 +1 @@
-2.1.2
+2.6.2

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.2.2
+  - 2.6.2
+
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/Gemfile

@@ -1,15 +1,23 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
-gem "httpclient", "~> 2.3.3"
 gem 'rake'
+gem 'rest-client'
 
 gemspec
 
 group :test do
+  gem 'coveralls', require: false
+  gem 'mocha', require: 'mocha/api'
+  gem 'pry'
   gem 'rspec'
   gem 'simplecov'
-  gem "webmock", "~> 1.11.0"
-  gem "timecop", "~> 0.6.1"
-  gem 'mocha', require: 'mocha/api'
-  gem 'coveralls', require: false
+  gem 'timecop'
+  gem 'webmock'
+end
+
+group :development do
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
 end

data/Gemfile.lock

@@ -3,69 +3,120 @@ PATH
   specs:
     ns-yapi (0.5.0)
       addressable
-      httpclient
       nokogiri
       nori
+      rest-client
 
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.4)
-    colorize (0.5.8)
-    coveralls (0.6.7)
-      colorize
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      thor
-    crack (0.4.0)
-      safe_yaml (~> 0.9.0)
-    diff-lcs (1.2.4)
-    httpclient (2.3.3)
-    metaclass (0.0.1)
-    mime-types (1.23)
-    mini_portile2 (2.3.0)
-    mocha (0.14.0)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (0.3.8)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    metaclass (0.0.4)
+    method_source (0.9.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.0331)
+    mini_portile2 (2.4.0)
+    mocha (1.8.0)
       metaclass (~> 0.0.1)
-    multi_json (1.7.7)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
+    netrc (0.11.0)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
     nori (2.6.0)
-    rake (10.0.3)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    safe_yaml (0.9.3)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-    thor (0.18.1)
-    timecop (0.6.1)
-    webmock (1.11.0)
-      addressable (>= 2.2.7)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    ruby-progressbar (1.10.0)
+    safe_yaml (1.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    timecop (0.9.1)
+    tins (1.20.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.5.0)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   coveralls
-  httpclient (~> 2.3.3)
   mocha
   ns-yapi!
+  pry
   rake
+  rest-client
   rspec
+  rubocop
+  rubocop-performance
   simplecov
-  timecop (~> 0.6.1)
-  webmock (~> 1.11.0)
+  timecop
+  webmock
 
 BUNDLED WITH
-   1.16.0
+   1.17.2

data/lib/model/prices_url.rb

@@ -1,13 +1,15 @@
-class PricesUrl
+# frozen_string_literal: true
 
+class PricesUrl
   def initialize(url)
-    raise InvalidURL, "You must give an url, ie http://www.ns.nl/api" unless url
+    raise InvalidURL, 'You must give an url, ie http://www.ns.nl/api' unless url
+
     @url = url
   end
 
-  def url (opts = {date: nil, from: "", to: ""})
-    opts[:date] = opts[:date].strftime("%d%m%Y") if opts[:date]
-    uri = URI.escape(opts.collect{|k,v| "#{k}=#{v}"}.join('&'))
+  def url(opts = { date: nil, from: '', to: '' })
+    opts[:date] = opts[:date].strftime('%d%m%Y') if opts[:date]
+    uri = Addressable::URI.escape(opts.collect { |k, v| "#{k}=#{v}" }.join('&'))
     "#{@url}?#{uri}"
   end
 

data/lib/ns_client.rb

@@ -1,191 +1,219 @@
-#encoding: utf-8
+# frozen_string_literal: true
+
 require 'pathname'
 require 'time'
 require 'nori'
 require 'nokogiri'
-require 'httpclient'
-require "addressable/uri"
+require 'rest-client'
+require 'addressable/uri'
 
 this = Pathname.new(__FILE__).realpath
-lib_path = File.expand_path("..", this)
-$:.unshift(lib_path)
-
-$ROOT = File.expand_path("../", lib_path)
+lib_path = File.expand_path('..', this)
+$LOAD_PATH.unshift(lib_path)
 
 Dir.glob(File.join(lib_path, '/**/*.rb')).each do |file|
   require file
 end
 
 module NSYapi
-
   class Configuration
-    attr_accessor :username, :password
+    attr_accessor :username, :password, :configuration
   end
 
   def self.configure(configuration = NSYapi::Configuration.new)
     yield configuration if block_given?
-    @@configuration = configuration
+    @configuration = configuration
   end
 
   def self.configuration # :nodoc:
-    @@configuration ||= NSYapi::Configuration.new
+    @configuration ||= NSYapi::Configuration.new
   end
 
   def self.client
-    @client_instance = NSClient.new(configuration.username, configuration.password) unless @client_instance
+    @client_instance ||= NSClient.new(configuration.username, configuration.password)
     @client_instance
   end
-
 end
 
 class NSClient
-
-  attr_accessor :last_received_raw_xml, :last_received_corrected_xml
+  attr_accessor :last_received_raw_xml, :last_received_corrected_xml, :username, :password
 
   def initialize(username, password)
-    @client = HTTPClient.new
-    @client.set_auth("http://webservices.ns.nl", username, password)
-    @prices_url = PricesUrl.new("http://webservices.ns.nl/ns-api-prijzen-v3")
-    @last_received_raw_xml = ""
-    @last_received_corrected_xml = ""
+    @username = username
+    @password = password
+    @prices_url = PricesUrl.new('https://webservices.ns.nl/ns-api-prijzen-v3')
+    @last_received_raw_xml = ''
+    @last_received_corrected_xml = ''
   end
 
   def stations
-    parse_stations(get_xml("http://webservices.ns.nl/ns-api-stations-v2"))
+    parse_stations(get_xml('https://webservices.ns.nl/ns-api-stations-v2'))
   end
 
   def stations_short
-    parse_stations_as_map(get_xml("http://webservices.ns.nl/ns-api-stations-v2"))
+    parse_stations_as_map(get_xml('https://webservices.ns.nl/ns-api-stations-v2'))
   end
 
-  def disruptions (query = nil)
+  def disruptions(query = nil)
     response_xml = get_xml(disruption_url(query))
     raise_error_when_response_is_error(response_xml)
     parse_disruptions(response_xml)
   end
 
-  def prices (opts = {from: nil, to: nil, via: nil, date: nil})
-    raise MissingParameter, "from and to station is required" if (opts[:from] == nil && opts[:to] == nil)
-    raise MissingParameter, "from station is required" unless opts[:from]
-    raise MissingParameter, "to station is required" unless opts[:to]
-    raise SameDestinationError,
-      "from (#{opts[:from]}) and to (#{opts[:to]}) parameters should not be equal" if opts[:from] == opts[:to]
+  def prices(opts = { from: nil, to: nil, via: nil, date: nil })
+    validate_prices(opts)
     response_xml = get_xml(@prices_url.url(opts))
     raise_error_when_response_is_error(response_xml)
     parse_prices(response_xml)
   end
 
+  def validate_price_parameters(opts)
+    raise MissingParameter, 'from and to station is required' if opts[:from].nil? && opts[:to].nil?
+    raise MissingParameter, 'from station is required' unless opts[:from]
+    raise MissingParameter, 'to station is required' unless opts[:to]
+  end
+
+  def validate_prices(opts)
+    validate_price_parameters(opts)
+
+    return unless opts[:from] == opts[:to]
+
+    raise SameDestinationError,
+          "from (#{opts[:from]}) and to (#{opts[:to]}) parameters should not be equal"
+  end
+
   def parse_prices(response_xml)
     prices_response = PricesResponse.new
-    (response_xml/'/VervoerderKeuzes/VervoerderKeuze').each do |transporter|
-      prices_response.tariff_units = (transporter/'./Tariefeenheden').text.to_i
-
-      (transporter/'ReisType').each do |travel_type|
-        prices = []
-
-        (travel_type/'ReisKlasse').each do |travel_class|
-          (travel_class/'Korting/Kortingsprijs').each do |price_element|
-            product_price = ProductPrice.new
-            product_price.discount = price_element.attr("name")
-            product_price.train_class = travel_class.attr("klasse")
-            product_price.amount = price_element.attr("prijs").gsub(",", ".").to_f
-            prices << product_price
-          end
-        end
+    (response_xml / '/VervoerderKeuzes/VervoerderKeuze').each do |transporter|
+      prices_response.tariff_units = (transporter / './Tariefeenheden').text.to_i
+
+      (transporter / 'ReisType').each do |travel_type|
+        prices = parse_travel_type(travel_type)
 
         name = travel_type.attr('name')
         prices_response.products[name] = prices
       end
-
     end
     prices_response
   end
 
+  def parse_travel_type(travel_type)
+    prices = []
+
+    (travel_type / 'ReisKlasse').each do |travel_class|
+      (travel_class / 'Korting/Kortingsprijs').each do |price_element|
+        product_price = ProductPrice.new
+        product_price.discount = price_element.attr('name')
+        product_price.train_class = travel_class.attr('klasse')
+        product_price.amount = price_element.attr('prijs').tr(',', '.').to_f
+        prices << product_price
+      end
+    end
+
+    prices
+  end
+
   def parse_stations(response_xml)
     result = []
-    (response_xml/'/Stations/Station').each do |station|
-      s = Station.new
-      s.code = (station/'./Code').text
-      s.type = (station/'./Type').text
-      s.country = (station/'./Land').text
-      s.short_name = (station/'./Namen/Kort').text
-      s.name = (station/'./Namen/Middel').text
-      s.long_name = (station/'./Namen/Lang').text
-      s.lat = (station/'./Lat').text
-      s.long = (station/'./Lon').text
-      s.uiccode = (station/'./UICCode').text
-      result << s
+    (response_xml / '/Stations/Station').each do |station|
+      result << parse_station(station)
     end
     result
   end
 
+  def parse_station(station)
+    s = Station.new
+    s.code = parse_station_field(station, './Code')
+    s.type = parse_station_field(station, './Type')
+    s.country = parse_station_field(station, './Land')
+    s.short_name = parse_station_field(station, './Namen/Kort')
+    s.name = parse_station_field(station, './Namen/Middel')
+    s.long_name = parse_station_field(station, './Namen/Lang')
+    s.lat = parse_station_field(station, './Lat')
+    s.long = parse_station_field(station, './Lon')
+    s.uiccode = parse_station_field(station, './UICCode')
+    s
+  end
+
+  def parse_station_field(station, field)
+    (station / field).text
+  end
+
   def parse_stations_as_map(response_xml)
     result = {}
-    (response_xml/'/Stations/Station').each do |station|
-      code = (station/'./Code').text
-      name = (station/'./Namen/Middel').text
-      country = (station/'./Land').text
+    (response_xml / '/Stations/Station').each do |station|
+      code = (station / './Code').text
+      name = (station / './Namen/Middel').text
+      country = (station / './Land').text
       result[code] = [name, country]
     end
     result
   end
 
   def parse_disruptions(response_xml)
-    result = {planned: [], unplanned: []}
-    (response_xml/'/Storingen').each do |disruption|
-      (disruption/'Ongepland/Storing').each do |unplanned|
-        unplanned_disruption = UnplannedDisruption.new
-        unplanned_disruption.id = (unplanned/'./id').text
-        unplanned_disruption.trip = (unplanned/'./Traject').text
-        unplanned_disruption.reason = (unplanned/'./Reden').text
-        unplanned_disruption.message = (unplanned/'./Bericht').text
-        unplanned_disruption.datetime_string = (unplanned/'./Datum').text
-        unplanned_disruption.cause = (unplanned/'./Oorzaak').text
-        result[:unplanned] << unplanned_disruption
+    result = { planned: [], unplanned: [] }
+    (response_xml / '/Storingen').each do |disruption|
+      (disruption / 'Ongepland/Storing').each do |unplanned|
+        result[:unplanned] << parse_unplanned_disruption(unplanned)
       end
 
-      (disruption/'Gepland/Storing').each do |planned|
-        planned_disruption = PlannedDisruption.new
-        planned_disruption.id = (planned/'./id').text
-        planned_disruption.trip = (planned/'./Traject').text
-        planned_disruption.reason = (planned/'./Reden').text
-        planned_disruption.advice = (planned/'./Advies').text
-        planned_disruption.message = (planned/'./Bericht').text
-        planned_disruption.cause = (planned/'./Oorzaak').text
-        result[:planned] << planned_disruption
+      (disruption / 'Gepland/Storing').each do |planned|
+        result[:planned] << parse_planned_disruption(planned)
       end
     end
     result
   end
 
+  def parse_unplanned_disruption(disruption)
+    result = UnplannedDisruption.new
+    result.id = (disruption / './id').text
+    result.trip = (disruption / './Traject').text
+    result.reason = (disruption / './Reden').text
+    result.message = (disruption / './Bericht').text
+    result.datetime_string = (disruption / './Datum').text
+    result.cause = (disruption / './Oorzaak').text
+    result
+  end
+
+  def parse_planned_disruption(disruption)
+    result = PlannedDisruption.new
+    result.id = (disruption / './id').text
+    result.trip = (disruption / './Traject').text
+    result.reason = (disruption / './Reden').text
+    result.advice = (disruption / './Advies').text
+    result.message = (disruption / './Bericht').text
+    result.cause = (disruption / './Oorzaak').text
+    result
+  end
+
   def raise_error_when_response_is_error(xdoc)
-    (xdoc/'/error').each do |error|
-      message = (error/'./message').text
+    (xdoc / '/error').each do |error|
+      message = (error / './message').text
       raise InvalidStationNameError, message
     end
   end
 
   def get_xml(url)
-    response = @client.get url
-    @last_received_raw_xml = response.content
+    response = RestClient::Request.new(url: url, user: username, password: password, method: :get).execute
+    @last_received_raw_xml = response.body
     @last_received_corrected_xml = remove_unwanted_whitespace(@last_received_raw_xml)
     begin
       Nokogiri.XML(@last_received_corrected_xml) do |config|
         config.options = Nokogiri::XML::ParseOptions::STRICT
       end
     rescue Nokogiri::XML::SyntaxError => e
-      raise UnparseableXMLError.new e
+      raise UnparseableXMLError, e
     end
-
   end
 
-  def remove_unwanted_whitespace content
-    content.gsub /<\s*(\/?)\s*?([a-zA-Z0-9]*)\s*([a-zA-Z0-9]*)\s*>/, '<\1\2\3>'
+  def remove_unwanted_whitespace(content)
+    content.gsub %r{<\s*(/?)\s*?([a-zA-Z0-9]*)\s*([a-zA-Z0-9]*)\s*>}, '<\1\2\3>'
   end
 
   def disruption_url(query)
-    return "http://webservices.ns.nl/ns-api-storingen?station=#{query}" if query
-    "http://webservices.ns.nl/ns-api-storingen?actual=true"
+    return "https://webservices.ns.nl/ns-api-storingen?station=#{query}" if query
+
+    'https://webservices.ns.nl/ns-api-storingen?actual=true'
   end
 
   class PricesResponse
@@ -197,20 +225,19 @@ class NSClient
     end
 
     def enkele_reis
-      products["Enkele reis"]
+      products['Enkele reis']
     end
 
     def dagretour
-      products["Retour"]
+      products['Retour']
     end
-
   end
 
   class ProductPrice
     attr_accessor :discount, :train_class, :amount
     DISCOUNT_MAP ||= {
-      "20% korting" => "reductie_20",
-      "40% korting" => "reductie_40"
+      '20% korting' => 'reductie_20',
+      '40% korting' => 'reductie_40'
     }.freeze
 
     def type
@@ -241,5 +268,4 @@ class NSClient
 
   class SameDestinationError < StandardError
   end
-
 end