uk_buses 0.0.2 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4805f4887607804abe20dae87c22fe79acbf950
-  data.tar.gz: 32626cdee3fb531cf1e505a3b2f9bb974c9d2639
+  metadata.gz: 6cfa62662695c6e4e22febb44997d22ae276ee9e
+  data.tar.gz: cf1c691507e203b60423084b8a2f13f7fd4c33d0
 SHA512:
-  metadata.gz: 0bbdde79b78c7f60fb47c3fd636493423b4c177fe2f600a4f0fb0e8301f3390b7332e1c90bbb092300b32c1d6ca4e39c08d420fd347986a7c2b407e7f8f1bcc9
-  data.tar.gz: 63c850cb25bed477247fdcfe2c9e53bee213fa831042d61f1437064cf76e9b9d14f8e4951bd520eb4174900416643975f2632d7ebd8d5112b2c628208290c68b
+  metadata.gz: beb02f3754d626c50379fe5e3d4d1a45a6a1725da9d98e178d7015d92b6cb59cdb82684daa4d9b91e1d37fe3bb569d20326371b364bc9f44524a07dab1389137
+  data.tar.gz: 0585de01e573357570ebea9a6805e3f0532365f1f70ef1529f20b42bcee3f3325886c4a8b486617393c3e891c01840674ca3728fe5393635bb1703b87a60b7c7

data/Guardfile

@@ -3,7 +3,7 @@
 
 guard 'rspec', :cli => "--color --format nested" do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/uk_buses/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
 

data/README.md

@@ -7,41 +7,30 @@ Grab *real-time* bus information across the entire United Kingdom.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add it to your Gemfile:
 
-    gem 'uk_buses'
+`gem 'uk_buses'`
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install uk_buses
-
-## Usage
-
-Using UKBuses couldn't be simpler. 
-
-Firstly, require it at the top of your file:
+## Use it
 
     require 'uk_buses'
+    ...
+    UkBuses::Query.new('cditmpa').fetch_buses
 
-Create a `Query` object containing the bus stop code. This is normally the code written on bus stops that you text to a number to get real-time updates. They usually begin with a 2 letter code that represents your area, `cd` for Cardiff, `bn` for Brighton & Hove etc.
-
-    q = UkBuses::Query.new('cdijtgm')
+    #=>
+    [#<UkBuses::Bus:0x007f8fe31aa2f0 @route_number="39", @destination="Heath Hospital", @arrives="4 mins">, #<UkBuses::Bus:0x007f8fe31a9aa8 @route_number="38", @destination="Heath, Childrens Unit", @arrives="20:45">, #<UkBuses::Bus:0x007f8fe31a9260 @route_number="39", @destination="Heath Hospital", @arrives="34 mins">, #<UkBuses::Bus:0x007f8fe31a8a18 @route_number="38", @destination="Heath, Childrens Unit", @arrives="21:15">, #<UkBuses::Bus:0x007f8fe31a81d0 @route_number="39", @destination="Heath Hospital", @arrives="21:30">, #<UkBuses::Bus:0x007f8fe38af780 @route_number="38", @destination="Heath, Childrens Unit", @arrives="21:45">, #<UkBuses::Bus:0x007f8fe38aef10 @route_number="39", @destination="Heath Hospital", @arrives="22:00">, #<UkBuses::Bus:0x007f8fe38ade58 @route_number="38", @destination="Heath, Childrens Unit", @arrives="22:15">, #<UkBuses::Bus:0x007f8fe38acf58 @route_number="39", @destination="Heath Hospital", @arrives="22:30">, #<UkBuses::Bus:0x007f8fe38ac710 @route_number="38", @destination="Heath, Childrens Unit", @arrives="22:45">]
 
-Then execute the query to scrape the data:
-This happens automatically.
-**This can take a little while!**
+**That's it.**
 
-It will return an array of `UkBuses::Bus` objects. 
+## Is this ok?
 
-That's it!
+I don't know. This was a weekend hack project; there's no intention here to commercialise anything or commit any crime. This data is available in the **public domain**, on publically accessible websites, this gem just displays the data in a more geek-friendly format. But I'm aware that some companies aren't too keen on this.
+Use of the MIT licence implies that you use this gem at your own risk.
 
-UkBuses doesn't implement any caching, but it is designed to pull real-time data so it won't be required unless you're servicing thousands of requests.
+My views mirror that of ScraperWiki:
 
-This is a 0.0.1 release currently so Pull Requests are greatfully received.
+*It is our view that, where a web server responds to an unauthenticated HTTP request, there is an implied licence to use the HTML that is returned for reading and automatically extracting that information. This, in our view, is how the web is designed to operate. If the proprietor of a web host wishes (for example) to charge for use of their site, HTTP provides mechanisms to require payment or authentication for use. They may also make use of the robots exclusion protocol to prevent scraping and spidering of any kind.
+Of course we may be wrong about this. The question has not been tested in any UK court and, we understand, there is not much more clarity world-wide. If you are in doubt about whether what you are doing is lawful, you should seek your own legal advice, rather than relying on our best guess.*
 
 ## Contributing
 

data/fixtures/vcr_cassettes/response.yml

@@ -0,0 +1,131 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://nextbuses.mobi/WebView/BusStopSearch/BusStopSearchResults/cditmpa
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private
+      Content-Type:
+      - text/html; charset=utf-8
+      Vary:
+      - Accept-Encoding
+      Server:
+      - Microsoft-IIS/8.0
+      X-Aspnetmvc-Version:
+      - '2.0'
+      X-Aspnet-Version:
+      - 2.0.50727
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 20 May 2013 19:09:09 GMT
+      Content-Length:
+      - '1404'
+    body:
+      encoding: UTF-8
+      string: "\r\n\r\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"
+        \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\r\n<html xmlns=\"http://www.w3.org/1999/xhtml\"
+        xml:lang=\"en\">\r\n<head id=\"ctl00_Head1\">\r\n        <link href=\"/Assets/site.css\"
+        rel=\"stylesheet\" type=\"text/css\" />\r\n        <meta name=\"viewport\"
+        content=\"width=device-width, initial-scale=1.0, target-densitydpi=device-dpi\"
+        />\r\n    <link rel=\"shortcut icon\" href=\"/Assets/Images/favicon.ico\"
+        type=\"image/x-icon\" />\r\n    <meta name=\"HandheldFriendly\" content=\"true\"
+        />\r\n    \r\n<title>\r\n\tNextBuses | Bus Stop Search Results\r\n</title></head>\r\n<body
+        id=\"ctl00_nextBuses\">\r\n    <div id=\"wrapper\">\r\n    <div id=\"nbHeader\"
+        class=\"header\">\r\n        <div class=\"nbLogo\"></div>\r\n        <div
+        class=\"tlLogo\"></div>\r\n        <div class=\"clear\"></div>\r\n    </div>\r\n
+        \   <div class=\"top-menu\">\r\n        <a class=\"active\" href=\"/WebView/BusStopSearch/Index\">Home</a>\r\n
+        \       <a href=\"/WebView/Feedback/Feedback\">Feedback</a>\r\n        <a
+        href=\"/WebView/Help/Help\">Info</a>\r\n    </div>\r\n    <div class=\"top-menu-ds\"></div>\r\n
+        \   <div class=\"content\">\r\n        \r\n    \r\n             <!-- Departure
+        Board Results -->\r\n             <h2>Departures</h2>  \r\n             <h5>\r\n
+        \               20/05/2013 20:09:09<br />\r\n                Churchill Way
+        (Stop HQ), Cardiff\r\n            </h5>\r\n            \r\n                <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa\">[Refresh
+        Departures]</a></p>\r\n                \r\n                <table class=\"BusStops\"
+        style=\"width:794px;\">\r\n                \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=38\">38</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;in 5 mins</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=39\">39</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;in 20 mins</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=38\">38</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 20:45</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=39\">39</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 21:00</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=38\">38</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 21:15</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=39\">39</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 21:30</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=38\">38</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 21:45</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=39\">39</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 22:00</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=38\">38</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 22:15</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                    <tr>\r\n
+        \                       <td class=\"Number\">\r\n                            <p
+        class=\"Stops\"><a href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchType=route&amp;searchFilter=39\">39</a></p>\r\n
+        \                       </td>\r\n                        <td>\r\n                            <p
+        class=\"Stops\">Heath Hospital&nbsp;at 22:30</p>\r\n                        </td>\r\n
+        \                   </tr>\r\n                    \r\n                </table>\r\n
+        \               \r\n                <div class=\"clear\"></div>\r\n                \r\n
+        \               <!-- MAP -->\r\n                <p class=\"Stops\">\r\n                <a
+        href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?searchMap=true\">[Show
+        Stop on Map]</a>\r\n                </p>    \r\n                \r\n                <p
+        class=\"Stops\">\r\n                    <a href=\"/WebView/BusStopSearch/BusStopSearchResults/ll_51.4814,-3.17261~Churchill%20Way,%20Cardiff\">[Show
+        Nearby Stops]</a>\r\n                </p>\r\n                \r\n                <table
+        id=\"tblPaging\" class=\"Paging\" style=\"width: 794px;\">\r\n                \r\n
+        \                   <tr>\r\n                        <td class=\"Top\" colspan=\"3\"></td>\r\n
+        \                   </tr>\r\n                    <tr>\r\n                        <td
+        class=\"Side\"><a class=\"Zoom Left invisible\" href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?currentPage=-1\">Previous</a></td>\r\n
+        \                       <td></td>\r\n                        <td class=\"Side\"><a
+        class=\"Zoom Right visible\" href=\"/WebView/BusStopSearch/BusStopSearchResults/cditmpa?currentPage=1\">Next</a></td>\r\n
+        \                   </tr>\r\n                    <tr>\r\n                        <td
+        class=\"Top\" colspan=\"3\"></td>\r\n                    </tr>\r\n                </table>
+        \r\n                <div class=\"clear\"></div>\r\n                \r\n        <div
+        class=\"clear\"></div>\r\n        \r\n    </div>\r\n    <div class=\"footer\"></div>\r\n
+        \   </div>\r\n</body>\r\n</html>\r\n"
+    http_version: 
+  recorded_at: Mon, 20 May 2013 19:09:03 GMT
+recorded_with: VCR 2.5.0

data/lib/uk_buses/query.rb

@@ -4,15 +4,28 @@ require 'open-uri'
 module UkBuses
   class Query
 
+    attr_accessor :stop_code
+
     def initialize(stop_code)
-      fetch_buses(stop_code)
+      @stop_code = stop_code
+    end
+
+    def url
+      "http://nextbuses.mobi/WebView/BusStopSearch/BusStopSearchResults/#{ @stop_code }"
+    end
+
+    def xpath
+      '//*[@id="wrapper"]/div[4]/table[1]/tr'
+    end
+
+    def get_document
+      Nokogiri::HTML(open(url))
     end
 
-    def fetch_buses(stop_code)
+    def fetch_buses
       buses = []
-      doc = Nokogiri::HTML(open("http://nextbuses.mobi/WebView/BusStopSearch/BusStopSearchResults/#{ stop_code }"))
 
-      doc.xpath('//*[@id="wrapper"]/div[4]/table[1]/tr').each do |row|
+      get_document.xpath(xpath).each do |row|
         current_bus = {}
           row.children.each do |child|
 

data/lib/uk_buses/version.rb

@@ -1,3 +1,3 @@
 module UkBuses
-  VERSION = "0.0.2"
+  VERSION = "0.5"
 end

data/spec/query_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe 'initialize' do
+  
+  it 'should create a new Query object' do
+    b = UkBuses::Query.new("atestcode")
+    expect(b.class).to eq(UkBuses::Query)
+  end
+
+  it 'should assign the stop_code to the object' do
+    b = UkBuses::Query.new("atestcode")
+    expect(b.stop_code).to eq('atestcode')
+  end
+
+end
+
+describe 'fetch_buses' do
+
+  it 'should return an Array' do
+    VCR.use_cassette('response') do
+      b = UkBuses::Query.new('cditmpa')
+      expect(b.fetch_buses.class).to eq(Array)
+    end
+  end
+
+  it 'should return an Array of Bus objects' do
+    VCR.use_cassette('response') do
+      b = UkBuses::Query.new('cditmpa')
+      expect(b.fetch_buses.first.class).to eq(UkBuses::Bus)
+    end
+  end
+
+end
+
+describe 'url' do
+
+  it 'should return the base URL with the stopcode appended' do
+    b = UkBuses::Query.new('cditmpa')
+    expect(b.url).to eq('http://nextbuses.mobi/WebView/BusStopSearch/BusStopSearchResults/cditmpa')
+  end
+
+end
+
+describe 'xpath' do
+
+  it 'should return an XPath string' do
+    b = UkBuses::Query.new('cditmpa')
+    expect(b.xpath).to eq('//*[@id="wrapper"]/div[4]/table[1]/tr')
+  end
+
+end
+
+describe 'get_document' do
+
+  it 'should return a Nokogiri::Document object' do
+    VCR.use_cassette('response') do
+      b = UkBuses::Query.new('cditmpa')
+      expect(b.get_document.class).to eq(Nokogiri::HTML::Document)
+    end
+  end
+
+end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/spec/spec_helper.rb

@@ -2,6 +2,13 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'uk_buses'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.allow_http_connections_when_no_cassette = true
+end
 
 RSpec.configure do |config|
   # some (optional) config here

data/uk_buses.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_dependency "nokogiri"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uk_buses
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: '0.5'
 platform: ruby
 authors:
 - Max Woolf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: webmock
+  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'
 description: Web scraper for all UK bus data
 email:
 - maximus@zingysaturn.co.uk
@@ -66,12 +94,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- fixtures/vcr_cassettes/response.yml
 - lib/.DS_Store
 - lib/uk_buses.rb
 - lib/uk_buses/bus.rb
 - lib/uk_buses/query.rb
 - lib/uk_buses/version.rb
 - spec/bus_spec.rb
+- spec/query_spec.rb
 - spec/spec_helper.rb
 - uk_buses.gemspec
 homepage: http://maxehmookau.github.io
@@ -100,4 +130,5 @@ specification_version: 4
 summary: Grab real-time bus info for all UK buses using a groovy Ruby DSL
 test_files:
 - spec/bus_spec.rb
+- spec/query_spec.rb
 - spec/spec_helper.rb