national_rail_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99ee836dcd2515425170ffaa55ee22ae480f2c78cadabf9760e23875b75bcedd
+  data.tar.gz: 6f853eb30da343fe43f2e203e1d90c6e17689eb70ec6fdde19f812bdc5cf93fe
+SHA512:
+  metadata.gz: 31e503ebae006ce399d95db1c681ce26b4730b6d7a8cc7d87c97e548c8e954a9b68d811877a9ff1eed6522ed863008ef347814a352ff75c5743dc2fc14b77cac
+  data.tar.gz: '081b46ce7cea303c5affdfb24f51610414ee407312225af55579d6535a6a6daa5db099f592e6142c41b2199980852ceb6e2ff7d0720402c15b28932e126c8e19'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at marc.best@intellectionsoftware.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in national_rail_wrapper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    national_rail_wrapper (0.1.0)
+      ox
+      typhoeus
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.11.2)
+    method_source (0.9.2)
+    ox (2.11.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  national_rail_wrapper!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marc Best
+
+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,104 @@
+# NationalRailWrapper
+
+A wrapper around the National Rail open data API 
+
+| Service                        | Integrated      |
+| ------------------------------ | --------------- |
+| Knowledge Base                 | Yes             |
+| Historical Service Performance | Yes             |
+| Live Departure Boards          | No              |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'national_rail_wrapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install national_rail_wrapper
+
+## Usage
+client = NationalRailWrapper::Feeds::Client.new(username: username, password: password)
+
+### Knowledge Base 
+```
+client = NationalRailWrapper::Feeds::KnowledgeBase::Client.new(username: USER_NAME, password: PASSWORD)
+```
+#### Incidents 
+```
+client.incidents
+```
+#### National Service Indicators 
+```
+client.national_service_indicators
+```
+#### Public Promotions 
+```
+client.public_promotions
+```
+#### Stations 
+```
+client.stations
+```
+#### Ticket Restrictions 
+```
+client.ticket_restrictions
+```
+#### Ticket Types 
+```
+client.ticket_types
+```
+#### TOC's 
+```
+client.tocs
+```
+
+### Historical Service Performance
+```
+client = NationalRailWrapper::Feeds::HistoricalServicePerformance::Client.new(username: USER_NAME, password: PASSWORD)
+```
+
+#### ServiceMetrics 
+```
+params = {
+    from_loc: 'HML',
+    to_loc: 'EUS',
+    from_time: '0800',
+    to_time: '0822',
+    from_date: '2019-10-01',
+    to_date: '2019-10-01',
+    days: 'WEEKDAY'
+}
+
+client.service_metrics(params)
+```
+#### ServiceDetails 
+```
+rid = '201607294212242'
+client.service_details(rid)
+```
+
+#### Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/national_rail_wrapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NationalRailWrapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/national_rail_wrapper/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+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 "national_rail_wrapper"
+
+# 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/national_rail_wrapper/client.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  class Client
+
+    def initialize(username: username, password: password)
+      @credentials = {username: username, password: password}
+    end
+
+  end
+end 

data/lib/national_rail_wrapper/feeds/base/requests/base.rb

@@ -0,0 +1,34 @@
+module NationalRailWrapper
+  module Feeds
+    module Base
+      module Requests
+        class Base
+          
+          def call(options = {})
+            method          = options.fetch(:method, :get)
+            path            = options.fetch(:path, '')
+            body            = options.fetch(:body, {})
+            query           = options.fetch(:query, {})
+            auth_token      = options.fetch(:auth_token, {})
+
+            url = base_url + path
+
+            request = Typhoeus::Request.new(url, request_params(method, body, query, auth_token))
+            response = request.run
+
+            response
+          end
+
+          def request_params(method, body, query, auth_token)
+            raise NotImplementedError
+          end
+
+          def base_url 
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/national_rail_wrapper/feeds/historical_service_performance/client.rb

@@ -0,0 +1,23 @@
+module NationalRailWrapper
+  module Feeds
+    module HistoricalServicePerformance
+      class Client < NationalRailWrapper::Client
+
+        def service_details(rid, parse_result: false)
+          body = {rid: rid}
+          HistoricalServicePerformance::Requests::ServiceDetails.new.run(auth_token: auth_token, body: body)
+        end
+
+        def service_metrics(body, parse_result: false)
+          HistoricalServicePerformance::Requests::ServiceMetrics.new.run(auth_token: auth_token, body: body)
+        end
+
+        private
+
+        def auth_token
+          Base64.strict_encode64("#{@credentials[:username]}:#{@credentials[:password]}")
+        end
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/historical_service_performance/requests/base.rb

@@ -0,0 +1,22 @@
+module NationalRailWrapper
+  module Feeds::HistoricalServicePerformance::Requests
+    class Base < Feeds::Base::Requests::Base
+      def request_params(method, body, query, auth_token)
+        {
+          method: method,
+          body: body.empty? ? '' : body.to_json, 
+          params: query, 
+          headers: {
+            'Content-Type' => 'application/json', 
+            "Authorization" => "Basic #{auth_token}"
+          }, 
+          ssl_verifypeer: false
+        }
+      end
+
+      def base_url 
+        'https://hsp-prod.rockshore.net/api/v1'
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/historical_service_performance/requests/service_details.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  module Feeds::HistoricalServicePerformance::Requests
+    class ServiceDetails < Base
+      def run(auth_token: , body:)
+        call(path: '/serviceDetails', method: :post, body: body, auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/historical_service_performance/requests/service_metrics.rb

@@ -0,0 +1,10 @@
+module NationalRailWrapper
+  module Feeds::HistoricalServicePerformance::Requests
+    class ServiceMetrics < Base
+      def run(auth_token: , body:)
+        call(path: '/serviceMetrics', method: :post, body: body, auth_token: auth_token)
+      end
+    end
+  end
+end
+

data/lib/national_rail_wrapper/feeds/knowledge_base/client.rb

@@ -0,0 +1,66 @@
+module NationalRailWrapper
+  module Feeds
+    module KnowledgeBase
+      class Client < NationalRailWrapper::Client
+
+        def incidents(parse_result: true)
+          request = KnowledgeBase::Requests::Incidents.new.run(auth_token)
+
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        def national_service_indicators(parse_result: true)
+          request = KnowledgeBase::Requests::NationalServiceIndicators.new.run(auth_token)
+
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        def public_promotions(parse_result: true)
+          request = KnowledgeBase::Requests::PublicPromotions.new.run(auth_token)
+
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        def stations(parse_result: true)
+          request = KnowledgeBase::Requests::Stations.new.run(auth_token) 
+
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        def ticket_restrictions(parse_result: true)
+          request = KnowledgeBase::Requests::TicketRestrictions.new.run(auth_token) 
+
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        def ticket_types(parse_result: true)
+          request = KnowledgeBase::Requests::TicketTypes.new.run(auth_token)
+          
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        def tocs(parse_result: true)
+          request = KnowledgeBase::Requests::Tocs.new.run(auth_token)
+
+          parse_result ? Ox.parse(request.response_body).to_json : request.response_body 
+        end
+
+        private
+
+        def auth_token
+          return @auth_token if !@auth_token.nil? && @auth_token_expires_at >= Time.now
+
+          response = Net::HTTP.post_form(URI('https://opendata.nationalrail.co.uk/authenticate'), @credentials)
+          response.value # Raise an exception if not successful
+          data = JSON.parse(response.body)
+          token = data.fetch('token')
+
+          # Token expires in 1 hour. Using 55 minutes provides a safety margin.
+          @auth_token_expires_at = Time.now + (55 * 60)
+
+          @auth_token = token
+        end
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/base.rb

@@ -0,0 +1,21 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class Base < Feeds::Base::Requests::Base
+
+      def request_params(method, body, query, auth_token)
+        {
+          method: method,
+          body: body.empty? ? '' : body.to_json,
+          params: query,
+          headers: {'X-Auth-Token' => auth_token},
+          ssl_verifypeer: false
+        }
+      end
+
+      def base_url 
+        'https://opendata.nationalrail.co.uk/api/staticfeeds'
+      end
+
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/incidents.rb

@@ -0,0 +1,10 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class Incidents < Base
+      def run(auth_token)
+        call(path: '/5.0/incidents', auth_token: auth_token)
+      end
+    end
+  end
+end
+

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/national_service_indicators.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class NationalServiceIndicators < Base
+      def run(auth_token)
+        call(path: '/4.0/serviceIndicators', auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/public_promotions.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class PublicPromotions < Base
+      def run(auth_token)
+        call(path: '/4.0/promotions-publics', auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/stations.rb

@@ -0,0 +1,10 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class Stations < Base
+
+      def run(auth_token) 
+        call(path: '/4.0/stations', auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/ticket_restrictions.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class TicketRestrictions < Base
+      def run(auth_token)
+        call(path: '/4.0/ticket-restrictions', auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/ticket_types.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class TicketTypes < Base
+      def run(auth_token) 
+        call(path: '/4.0/ticket-types', auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/knowledge_base/requests/tocs.rb

@@ -0,0 +1,9 @@
+module NationalRailWrapper
+  module Feeds::KnowledgeBase::Requests
+    class Tocs < Base
+      def run(auth_token) 
+        call(path: '/4.0/tocs', auth_token: auth_token)
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/feeds/live_departure_boards/client.rb

@@ -0,0 +1,14 @@
+module NationalRailWrapper
+  module Feeds
+    module LiveDepartureBoards
+      class  Client < NationalRailWrapper::Client
+
+        private
+
+        def auth_token
+          Base64.strict_encode64("#{@credentials[:username]}:#{@credentials[:password]}")
+        end
+      end
+    end
+  end
+end

data/lib/national_rail_wrapper/version.rb

@@ -0,0 +1,3 @@
+module NationalRailWrapper
+  VERSION = "0.1.0"
+end

data/lib/national_rail_wrapper.rb

@@ -0,0 +1,27 @@
+require 'typhoeus'
+require 'ox'
+
+require "national_rail_wrapper/version"
+require "national_rail_wrapper/client"
+
+require_relative "national_rail_wrapper/feeds/base/requests/base"
+
+require_relative "national_rail_wrapper/feeds/knowledge_base/client"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/base"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/incidents"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/national_service_indicators"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/public_promotions"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/stations"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/ticket_restrictions"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/ticket_types"
+require_relative "national_rail_wrapper/feeds/knowledge_base/requests/tocs"
+
+require_relative "national_rail_wrapper/feeds/historical_service_performance/client"
+require_relative "national_rail_wrapper/feeds/historical_service_performance/requests/base"
+require_relative "national_rail_wrapper/feeds/historical_service_performance/requests/service_details"
+require_relative "national_rail_wrapper/feeds/historical_service_performance/requests/service_metrics"
+
+module NationalRailWrapper
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/national_rail_wrapper.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "national_rail_wrapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "national_rail_wrapper"
+  spec.version       = NationalRailWrapper::VERSION
+  spec.authors       = ["Marc Best"]
+  spec.email         = ["marcbest123@gmail.com.com"]
+
+  spec.summary       = %q{A wrapper for the National Rail open data API}
+  spec.description   = %q{A wrapper around the National Rail open data API. Including Darwin and Knowledge base}
+  spec.homepage      = "https://github.com/marcbest/national_rails_wrapper"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/marcbest/national_rails_wrapper"
+    spec.metadata["changelog_uri"] = "https://github.com/marcbest/national_rails_wrapper"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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 = `git ls-files`.split("\n")
+  # 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"]
+
+  spec.add_dependency "typhoeus"
+  spec.add_dependency "ox"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/national_rail_wrapper_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe NationalRailWrapper do
+  it "has a version number" do
+    expect(NationalRailWrapper::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "national_rail_wrapper"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: national_rail_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marc Best
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A wrapper around the National Rail open data API. Including Darwin and
+  Knowledge base
+email:
+- marcbest123@gmail.com.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/national_rail_wrapper.rb
+- lib/national_rail_wrapper/client.rb
+- lib/national_rail_wrapper/feeds/base/requests/base.rb
+- lib/national_rail_wrapper/feeds/historical_service_performance/client.rb
+- lib/national_rail_wrapper/feeds/historical_service_performance/requests/base.rb
+- lib/national_rail_wrapper/feeds/historical_service_performance/requests/service_details.rb
+- lib/national_rail_wrapper/feeds/historical_service_performance/requests/service_metrics.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/client.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/base.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/incidents.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/national_service_indicators.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/public_promotions.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/stations.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/ticket_restrictions.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/ticket_types.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/requests/tocs.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/incidents.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/national_services_indicators.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/public_promotions.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/stations.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/ticket_restrictions.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/ticket_types.rb
+- lib/national_rail_wrapper/feeds/knowledge_base/response_parser/tocs.rb
+- lib/national_rail_wrapper/feeds/live_departure_boards/client.rb
+- lib/national_rail_wrapper/version.rb
+- national_rail_wrapper.gemspec
+- spec/national_rail_wrapper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/marcbest/national_rails_wrapper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/marcbest/national_rails_wrapper
+  source_code_uri: https://github.com/marcbest/national_rails_wrapper
+  changelog_uri: https://github.com/marcbest/national_rails_wrapper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A wrapper for the National Rail open data API
+test_files: []