rail_feeds 0.0.1 → 0.0.2

data/lib/rail_feeds/network_rail/schedule/days.rb

@@ -85,6 +85,7 @@ module RailFeeds
 
           def days_from_cif(value)
             return [nil, nil, nil, nil, nil, nil, nil] if value.nil?
+
             Array.new(7) { |i| value[i]&.eql?('1') }
           end
         end

data/lib/rail_feeds/network_rail/schedule/fetcher.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'net/http'
-
 module RailFeeds
   module NetworkRail
     module Schedule
@@ -177,6 +175,7 @@ module RailFeeds
             unless %w[mon tue wed thu fri sat sun].include?(day)
               fail ArgumentError, 'day is invalid'
             end
+
             day = "toc-update-#{day}"
             type = "CIF_#{toc}_UPDATE_DAILY"
           end

data/lib/rail_feeds/network_rail/schedule/header/json.rb

@@ -49,7 +49,7 @@ module RailFeeds
           end
 
           # rubocop:disable Metrics/MethodLength
-          def to_json
+          def to_json(**opts)
             {
               'JsonTimetableV1' => {
                 'classification' => 'public',
@@ -65,7 +65,7 @@ module RailFeeds
                   'sequence' => sequence
                 }
               }
-            }.to_json
+            }.to_json(**opts)
           end
           # rubocop:enable Metrics/MethodLength
 

data/lib/rail_feeds/network_rail/schedule/header.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'header/cif'
-require_relative 'header/json'
-
 module RailFeeds
   module NetworkRail
     module Schedule

data/lib/rail_feeds/network_rail/schedule/parser/json.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-
 module RailFeeds
   module NetworkRail
     module Schedule

data/lib/rail_feeds/network_rail/schedule/parser.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'parser/cif'
-require_relative 'parser/json'
-
 module RailFeeds
   module NetworkRail
     module Schedule
@@ -75,7 +72,7 @@ module RailFeeds
         end
         # rubocop:enable Metrics/ParameterLists
 
-        # Parse the data in CIF file.
+        # Parse the data in file.
         # @param [IO] file
         #   The file to load data from.
         def parse_file(file)

data/lib/rail_feeds/network_rail/schedule/tiploc.rb

@@ -81,7 +81,7 @@ module RailFeeds
           ].join) + "\n"
         end
 
-        def to_json
+        def to_json(**opts)
           {
             'TiplocV1' => {
               'transaction_type' => 'Create',
@@ -92,7 +92,7 @@ module RailFeeds
               'description' => nlc_description,
               'tps_description' => tps_description
             }
-          }.to_json
+          }.to_json(**opts)
         end
       end
     end

data/lib/rail_feeds/network_rail/schedule/train_schedule/location.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'location/intermediate'
-require_relative 'location/origin'
-require_relative 'location/terminating'
-
 module RailFeeds
   module NetworkRail
     module Schedule
@@ -65,6 +61,7 @@ module RailFeeds
 
           def allowance_json(value)
             return nil if value.nil?
+
             i = value.to_i
             f = value.to_f - i
             f.eql?(0.5) ? "#{i}H" : i.to_s

data/lib/rail_feeds/network_rail/schedule/train_schedule.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
-require 'time'
-
-require_relative 'train_schedule/change_en_route'
-require_relative 'train_schedule/location'
-
 module RailFeeds
   module NetworkRail
     module Schedule
@@ -181,7 +175,7 @@ module RailFeeds
 
         # rubocop:disable Metrics/AbcSize
         # rubocop:disable Metrics/MethodLength
-        def to_json
+        def to_json(**opts)
           {
             'JsonScheduleV1' => {
               'CIF_bank_holiday_running' => bank_holiday_running,
@@ -218,7 +212,7 @@ module RailFeeds
                 'schedule_location' => journey.map(&:to_hash_for_json).reject(&:nil?)
               }
             }
-          }.to_json
+          }.to_json(**opts)
         end
         # rubocop:enable Metrics/AbcSize
         # rubocop:enable Metrics/MethodLength
@@ -318,10 +312,11 @@ module RailFeeds
         end
 
         def self.location_from_json(hash)
-          return lo_from_json(hash) if hash['record_identity'].eql?('LO')
-          return li_from_json(hash) if hash['record_identity'].eql?('LI')
-          return lt_from_json(hash) if hash['record_identity'].eql?('LT')
-          nil
+          case hash['record_identity']
+          when 'LO' then lo_from_json(hash)
+          when 'LI' then li_from_json(hash)
+          when 'LT' then lt_from_json(hash)
+          end
         end
         private_class_method :location_from_json
 
@@ -380,6 +375,7 @@ module RailFeeds
 
         def self.parse_allowance(value)
           return nil if value.nil? || value.empty?
+
           half = value[-1].eql?('H')
           value = value.to_f
           half ? value + 0.5 : value

data/lib/rail_feeds/network_rail/schedule.rb

@@ -1,31 +1,24 @@
 # frozen_string_literal: true
 
-require_relative 'schedule/days'
-require_relative 'schedule/stp_indicator'
-require_relative 'schedule/association'
-require_relative 'schedule/header'
-require_relative 'schedule/tiploc'
-require_relative 'schedule/train_schedule'
-require_relative 'schedule/fetcher'
-require_relative 'schedule/parser'
-require_relative 'schedule/data'
-
 module RailFeeds
   module NetworkRail
     module Schedule # :nodoc:
       def self.nil_or_i(value)
         return nil if value.to_s.strip.empty?
+
         value.to_i
       end
 
       def self.nil_or_strip(value)
         return nil if value.to_s.strip.empty?
+
         value.strip
       end
 
       def self.make_date(value, allow_nil: false)
         return nil if allow_nil && value.strip.empty?
         return Date.new(9999, 12, 31) if value.eql?('999999')
+
         Date.strptime(value, '%y%m%d')
       end
     end

data/lib/rail_feeds/network_rail/smart.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'set'
-
 module RailFeeds
   module NetworkRail
     # rubocop:disable Metrics/ModuleLength
@@ -16,6 +13,7 @@ module RailFeeds
         def from_direction
           return :up if event_direction.eql?(:down)
           return :down if event_direction.eql?(:up)
+
           nil
         end
 
@@ -32,15 +30,15 @@ module RailFeeds
       # @param [RailFeeds::NetworkRail::Credentials] credentials
       # @param [String] file
       #   The path to the file to save the .json.gz download in.
-      def self.download(file, credentials: Credentials)
+      def self.download(file, credentials = Credentials)
         client = HTTPClient.new(credentials: credentials)
         client.download 'ntrod/SupportingFileAuthenticate?type=SMART', file
       end
 
       # Fetch the current SMART data.
       # @param [RailFeeds::NetworkRail::Credentials] credentials
-      # @return [Tempfile]
-      def self.fetch(credentials: Credentials)
+      # @return [IO]
+      def self.fetch(credentials = Credentials)
         client = HTTPClient.new(credentials: credentials)
         client.fetch 'ntrod/SupportingFileAuthenticate?type=SMART'
       end
@@ -60,7 +58,7 @@ module RailFeeds
       # @param [RailFeeds::NetworkRail::Credentials] credentials
       #  The credentials to authenticate with.
       # @return [Array<RailFeeds::NetworkRail::SMART::Step>]
-      def self.fetch_data(credentials: Credentials)
+      def self.fetch_data(credentials = Credentials)
         client = HTTPClient.new(credentials: credentials)
         client.fetch_unzipped('ntrod/SupportingFileAuthenticate?type=SMART') do |file|
           break parse_json file.read
@@ -147,6 +145,7 @@ module RailFeeds
 
       def self.nilify(value)
         return nil if value.nil? || value.empty?
+
         value
       end
       private_class_method :nilify
@@ -154,6 +153,7 @@ module RailFeeds
       def self.event_type(value)
         return :arrive if value.eql?('A') || value.eql?('C')
         return :depart if value.eql?('B') || value.eql?('D')
+
         nil
       end
       private_class_method :event_type
@@ -161,24 +161,24 @@ module RailFeeds
       def self.event_direction(value)
         return :up if value.eql?('A') || value.eql?('B')
         return :down if value.eql?('C') || value.eql?('D')
+
         nil
       end
       private_class_method :event_direction
 
       # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
       def self.step_type(value)
-        return :between if value.eql?('B')
-        return :from if value.eql?('F')
-        return :to if value.eql?('T')
-        return :intermediate_first if value.eql?('D')
-        return :clearout if value.eql?('C')
-        return :interpose if value.eql?('I')
-        return :intermediate if value.eql?('E')
-        nil
+        case value
+        when 'B' then :between
+        when 'F' then :from
+        when 'T' then :to
+        when 'D' then :intermediate_first
+        when 'E' then :intermediate
+        when 'C' then :clearout
+        when 'I' then :interpose
+        end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
       private_class_method :step_type
     end
     # rubocop:enable Metrics/ModuleLength

data/lib/rail_feeds/network_rail/stomp_client.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'socket'
-require 'stomp'
-
 module RailFeeds
   module NetworkRail
     # A wrapper class for ::Stomp::Client which provides durable subscriptions
@@ -27,6 +24,7 @@ module RailFeeds
       # Connect to the network rail server.
       def connect
         return if @client && client.open?
+
         client_options = {
           hosts: [{
             host: HOST,
@@ -49,6 +47,7 @@ module RailFeeds
       # Disconnect from the network rail server.
       def disconnect
         return if @client.nil?
+
         @client.close
       end
 

data/lib/rail_feeds/network_rail.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'network_rail/credentials'
-require_relative 'network_rail/http_client'
-require_relative 'network_rail/stomp_client'
-require_relative 'network_rail/corpus'
-require_relative 'network_rail/schedule'
-require_relative 'network_rail/smart'
-
 module RailFeeds
   module NetworkRail # :nodoc:
   end

data/lib/rail_feeds/version.rb

@@ -5,7 +5,7 @@ module RailFeeds
   class Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/lib/rail_feeds.rb

@@ -1,10 +1,46 @@
 # frozen_string_literal: true
 
-require 'json'
+module RailFeeds # :nodoc:
+end
+
+require 'date'
+require 'forwardable'
+require 'logger'
+
+require 'nokogiri'
+require 'stomp'
 
+require_relative 'rail_feeds/version'
 require_relative 'rail_feeds/logging'
 require_relative 'rail_feeds/credentials'
+require_relative 'rail_feeds/http_client'
+require_relative 'rail_feeds/national_rail'
+require_relative 'rail_feeds/national_rail/credentials'
+require_relative 'rail_feeds/national_rail/http_client'
+require_relative 'rail_feeds/national_rail/knowledge_base'
+require_relative 'rail_feeds/national_rail/knowledge_base/national_service_indicator'
 require_relative 'rail_feeds/network_rail'
-
-module RailFeeds # :nodoc:
-end
+require_relative 'rail_feeds/network_rail/credentials'
+require_relative 'rail_feeds/network_rail/http_client'
+require_relative 'rail_feeds/network_rail/stomp_client'
+require_relative 'rail_feeds/network_rail/corpus'
+require_relative 'rail_feeds/network_rail/smart'
+require_relative 'rail_feeds/network_rail/schedule'
+require_relative 'rail_feeds/network_rail/schedule/days'
+require_relative 'rail_feeds/network_rail/schedule/stp_indicator'
+require_relative 'rail_feeds/network_rail/schedule/association'
+require_relative 'rail_feeds/network_rail/schedule/data'
+require_relative 'rail_feeds/network_rail/schedule/fetcher'
+require_relative 'rail_feeds/network_rail/schedule/tiploc'
+require_relative 'rail_feeds/network_rail/schedule/header'
+require_relative 'rail_feeds/network_rail/schedule/header/cif'
+require_relative 'rail_feeds/network_rail/schedule/header/json'
+require_relative 'rail_feeds/network_rail/schedule/parser'
+require_relative 'rail_feeds/network_rail/schedule/parser/cif'
+require_relative 'rail_feeds/network_rail/schedule/parser/json'
+require_relative 'rail_feeds/network_rail/schedule/train_schedule'
+require_relative 'rail_feeds/network_rail/schedule/train_schedule/change_en_route'
+require_relative 'rail_feeds/network_rail/schedule/train_schedule/location'
+require_relative 'rail_feeds/network_rail/schedule/train_schedule/location/intermediate'
+require_relative 'rail_feeds/network_rail/schedule/train_schedule/location/origin'
+require_relative 'rail_feeds/network_rail/schedule/train_schedule/location/terminating'

data/rail_feeds.gemspec

@@ -3,30 +3,35 @@
 $LOAD_PATH.push File.expand_path('lib', __dir__)
 require File.join(File.dirname(__FILE__), 'lib', 'rail_feeds', 'version')
 
-Gem::Specification.new do |s|
-  s.name        = 'rail_feeds'
-  s.license     = 'BSD 3 clause'
-  s.version     = RailFeeds::Version
-  s.authors     = ['Robert Gauld']
-  s.email       = ['robert@robertgauld.co.uk']
-  s.homepage    = 'https://github.com/robertgauld/rail_feeds'
-  s.summary     = 'Make use of the various open data rails feeds in the UK.'
-  s.description = 'Make use of the various open data rails feeds in the UK. Currently only some from Network Rail.'
+Gem::Specification.new do |gem|
+  gem.name        = 'rail_feeds'
+  gem.license     = 'BSD 3 clause'
+  gem.version     = RailFeeds::Version
+  gem.authors     = ['Robert Gauld']
+  gem.email       = ['robert@robertgauld.co.uk']
+  gem.homepage    = 'https://github.com/robertgauld/rail_feeds'
+  gem.summary     = 'Make use of the various open data rails feeds in the UK.'
+  gem.description = 'Make use of the various open data rails feeds in the UK. Currently only some from Network Rail.'
 
-  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']
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
 
-  s.add_dependency 'stomp', '~> 1.4'
+  gem.required_ruby_version     = '>= 2.4'
+  gem.required_rubygems_version = '>= 2.6.14'
 
-  s.add_development_dependency 'coveralls', '~> 0.7'
-  s.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.5'
-  s.add_development_dependency 'guard-rubocop', '~> 1.3'
-  s.add_development_dependency 'rake', '~> 12.0'
-  s.add_development_dependency 'rb-inotify', '~> 0.9'
-  s.add_development_dependency 'rspec', '>= 3.7', '< 4'
-  s.add_development_dependency 'rubocop', '~> 0.57.1'
-  s.add_development_dependency 'simplecov', '~> 0.7'
-  s.add_development_dependency 'timecop', '~> 0.5'
+  gem.add_dependency 'nokogiri', '~> 1.8'
+  gem.add_dependency 'stomp', '~> 1.4'
+
+  gem.add_development_dependency 'coveralls', '~> 0.7'
+  gem.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.5'
+  gem.add_development_dependency 'guard-rubocop', '~> 1.3'
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rb-inotify', '~> 0.9'
+  gem.add_development_dependency 'rspec', '>= 3.7', '< 4'
+  gem.add_development_dependency 'rubocop', '~> 0.67'
+  gem.add_development_dependency 'rubocop-performance', '~> 1.1'
+  gem.add_development_dependency 'simplecov', '~> 0.7'
+  gem.add_development_dependency 'timecop', '~> 0.5'
 end

data/spec/rail_feeds/credentials_spec.rb

@@ -2,6 +2,8 @@
 
 describe RailFeeds::Credentials do
   context 'Using system wide credentials' do
+    subject { described_class.new }
+
     before :each do
       described_class.configure(
         username: 'user@example.com',
@@ -20,7 +22,6 @@ describe RailFeeds::Credentials do
     end
   end
 
-
   context 'Using specific credentials' do
     subject do
       described_class.new(
@@ -43,4 +44,30 @@ describe RailFeeds::Credentials do
       expect(described_class.password).to eq ''
     end
   end
+
+  describe 'Outputs an array' do
+    subject { described_class.new username: 'user-i', password: 'pass-i' }
+
+    it '::to_a' do
+      described_class.configure username: 'user', password: 'pass'
+      expect(described_class.to_a).to eq ['user', 'pass']
+    end
+
+    it '#to_a' do
+      expect(subject.to_a).to eq ['user-i', 'pass-i']
+    end
+  end
+
+  describe 'Outputs a hash' do
+    subject { described_class.new username: 'user-i', password: 'pass-i' }
+
+    it '::to_h' do
+      described_class.configure username: 'user', password: 'pass'
+      expect(described_class.to_h).to eq({ username: 'user', password: 'pass' })
+    end
+
+    it '#to_h' do
+      expect(subject.to_h).to eq({ username: 'user-i', password: 'pass-i' })
+    end
+  end
 end

data/spec/rail_feeds/http_client_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+describe RailFeeds::HTTPClient do
+  let(:temp_file) { double Tempfile }
+  let(:uri) { double URI }
+
+  describe '#download' do
+    let(:file) { double File }
+
+    it 'Saves the file' do
+      expect(subject).to receive(:fetch).with('url').and_yield(temp_file)
+      expect(File).to receive(:open).with('file', 'w').and_yield(file)
+      expect(IO).to receive(:copy_stream).with(temp_file, file)
+      subject.download('url', 'file')
+    end
+  end
+
+  describe '#fetch' do
+    describe 'Yields an IO' do
+      it 'When uri.open gives a TempFile' do
+        expect(URI).to receive(:parse).with('https://www.example.com/path').and_return(uri)
+        expect(uri).to receive(:open).and_return(temp_file)
+        expect { |a| subject.fetch('https://www.example.com/path', &a) }.to yield_with_args(temp_file)
+      end
+
+      it 'When uri.open gives a StringIO' do
+        string_io = double StringIO
+        expect(URI).to receive(:parse).with('https://www.example.com/path').and_return(uri)
+        expect(uri).to receive(:open).and_return(string_io)
+        expect { |a| subject.fetch('https://www.example.com/path', &a) }.to yield_with_args(string_io)
+      end
+    end
+
+    it 'Adds credentials when getting path' do
+      credentials = RailFeeds::NetworkRail::Credentials.new(
+        username: 'user',
+        password: 'pass'
+      )
+      expect(URI).to receive(:parse).and_return(uri)
+      expect(uri).to receive(:open)
+        .with(http_basic_authentication: ['user', 'pass'])
+        .and_return(temp_file)
+      subject = described_class.new credentials: credentials
+      subject.fetch('path') {}
+    end
+
+    it 'Handles special characters in credentials' do
+      credentials = RailFeeds::NetworkRail::Credentials.new(
+        username: 'a@example.com',
+        password: '!:@'
+      )
+      expect(URI).to receive(:parse).and_return(uri)
+      expect(uri).to receive(:open).and_return(temp_file)
+      subject = described_class.new credentials: credentials
+      expect { subject.fetch('path') {} }.to_not raise_error
+    end
+
+    it 'Passes extra options on' do
+      expect(URI).to receive(:parse).and_return(uri)
+      expect(uri).to receive(:open)
+        .with({ a: 'a', http_basic_authentication: [] })
+        .and_return(temp_file)
+      subject.fetch('path', { a: 'a' }) {}
+    end
+  end
+
+  describe '#fetch_unzipped' do
+    it 'Returns what Zlib::GzipReader.open does' do
+      reader = double Zlib::GzipReader
+      expect(subject).to receive(:fetch).with('url').and_yield(temp_file)
+      expect(Zlib::GzipReader).to receive(:new).with(temp_file).and_return(reader)
+      expect { |a| subject.fetch_unzipped('url', &a) }.to yield_with_args(reader)
+    end
+  end
+end

data/spec/rail_feeds/national_rail/credentials_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+describe RailFeeds::NationalRail::Credentials do
+  it 'Is a RailFeeds::Credentials' do
+    expect(described_class).to be < RailFeeds::Credentials
+  end
+
+  it 'Has seperate values to RailFeeds::Credentials' do
+    described_class.configure username: 'a', password: 'b'
+    expect(described_class.username).to_not eq RailFeeds::Credentials.username
+    expect(described_class.password).to_not eq RailFeeds::Credentials.password
+  end
+end

data/spec/rail_feeds/national_rail/http_client_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+describe RailFeeds::NationalRail::HTTPClient do
+  let(:uri) { double URI }
+
+  it 'Is a RailFeeds::HTTPClient' do
+    expect(described_class).to be < RailFeeds::HTTPClient
+  end
+
+  it 'has correct default credentials' do
+    expect(subject.send(:credentials)).to eq RailFeeds::NationalRail::Credentials
+  end
+
+  describe '#fetch' do
+    context 'Gets an auth token when' do
+      before(:each) { allow(uri).to receive(:open) }
+
+      it 'It has not been fetched yet' do
+        expect(subject).to receive(:auth_token)
+        expect(URI).to receive(:parse).with('https://datafeeds.nationalrail.co.uk/path').and_return(uri)
+        subject.fetch('path') {}
+      end
+
+      it 'Token is over an hour old' do
+        expect(subject).to receive(:auth_token).twice
+        expect(URI).to receive(:parse).with('https://datafeeds.nationalrail.co.uk/path')
+                                      .and_return(uri).twice
+        subject.fetch('path') {} # Get the auth token
+        Timecop.travel 3601
+        subject.fetch('path') {} # Token expired so should reget it
+      end
+
+      it 'Getting the token' do
+        subject = described_class.new(credentials: RailFeeds::Credentials.new(username: '', password: ''))
+        response = double Net::HTTPCreated
+        expect(response).to receive(:value)
+        expect(response).to receive(:body).and_return('{"token":"TOKEN"}')
+        expect(Net::HTTP).to receive(:post_form)
+          .with(URI('https://datafeeds.nationalrail.co.uk/authenticate'), { username: '', password: '' })
+          .and_return(response)
+        expect(subject.send(:auth_token)).to eq 'TOKEN'
+      end
+    end
+
+    context 'Has a valid auth_token' do
+      before :each do
+        allow(subject).to receive(:auth_token).and_return('auth_token')
+      end
+
+      it 'Adds server to path then delegates to super' do
+        expect(URI).to receive(:parse).with('https://datafeeds.nationalrail.co.uk/path').and_return(uri)
+        expect(uri).to receive(:open)
+        subject.fetch('path') {}
+      end
+    end
+  end
+end