tfgm 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTZlMDUzY2FlNmExMDZkMDdmNzdmN2FjOTY1MDQzNTliNDYxMjcxNA==
+    NWYzMDM3YWQxNDYzMDVmMjlkM2NlMWFjMTk5ZTBlYzBjOWViNzE0Mw==
   data.tar.gz: !binary |-
-    MDEzNmJmYmFjY2ViNGM2MGJhZTA0MjNhOTZlNDVkYzI4OTZjMzE3Yg==
+    Mzk4NzlmNWE2NGNjZTc3MGRkMWY1ODJkODE2YzNhZDk1YmYyMDk2Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzBiN2M4MWM0Yzg1MzFhYzUxNmRiYzRkYWRkNDRhYjMyOTMwYWRhYWU2ZGJi
-    ZTJjMTFkZDZhZDVhZmM2MzgyYmRlOTc3MzQxMjQwNzc0OWU5NDFiMDgyNDhj
-    OTljNGEzNzFkYzc4YWYzNGI2YjM1ZTQ3MTU2ZDMzMWQ3NjA1OWI=
+    OGI1NjhjNzJjZDJlZTdjYTY4NGY3YTAxOGVhZTU5ZWY4NGRlMGJmZDhmYmVj
+    ZjJkY2ViZmMxYmEzMjEwZmMwZjk1NWFkYTIwNWUwMDA4MThhNDdiYWVmYTAy
+    MWRhMmM3YmMwMTA5NTgzYjU2Zjg0NWE1MzdmOTQwNDBlZWMxMmQ=
   data.tar.gz: !binary |-
-    MDUyNmMwZWJhNTQ5MWE5MGFmMTgwN2RkZDI0ZDg3NmQxNjNiZTczYzZiNzMz
-    YmQ2MjE3OGE4NDA4OTU4NjAxMmZkZjNkYWEwM2Y1MTU0NzM3MGRmN2Q4MTZj
-    ODJkOTY3NmE3OTI2OTQ0ZTY5ODQ1MWE3ZmQyNDQ1MzRlMTk3NmE=
+    MmU1ZjA0Zjg2NTUzNDVlNjM2MjlkODg5NTRhNThlMTU3M2I4YTAwMTZhYmE1
+    YjJhZWRlMTM5NmYwYTZiMTM3YWM2YTdjZTA4Yzg2MWE3MDZmNWJlYTdkMWU2
+    ZGI5Y2NmOWRmNmM5NDU1NTIyNWM2Y2RkOGU0YTY2NWFlYjQzODk=

data/README.markdown

@@ -1,2 +1,131 @@
-# Transport for Greater Manchester Rubygem
-It is early. Very.
+![](http://i.imgur.com/6PGUo4g.png)
+# TFGM Unofficial Rubygem
+This is a Rubygem which acts as a wrapper for the [Transport for Greater Manchester REST API](http://developer.tfgm.com). This provides the most accurate car parks, bus and metrolink information available to freely consume through the **opendata.tfgm.com** REST API.
+
+We built this to use internally in our project, EventBrite, for the [Innovation Challenge in Manchester](http://futureeverything.org/summit/conference/workshops-fringe-events/innovation-challenge/) (which won Best Under 21). The TFGM REST API is **new and unstable** as of March 2013 so we would avoid using it in production.
+
+## Getting Started
+* **Sign up for an API Key** — It's easy to sign up at [developer.tfgm.com](http://developer.tfgm.com) and you'll need a developer & application key. An example of what both the keys should like are: `a1b23cd4-ef67-890g-h123-4567i8jk9lmn` and they must be 36 characters in length.
+
+* **Install the gem**
+```ruby
+gem install tfgm
+```
+ 
+* **Include it in your Ruby** — Insert this at the top of your Ruby code where you'll using TFGM.
+```ruby
+require 'tfgm'
+```
+
+* **Create an instance of TFGM::API**
+```ruby
+instance = TFGM::API.new("Developer Key", "Application Key")
+```
+
+* **Make it do something** — if you're unsure of what it can do, scroll down to "Manual" on this page.
+```ruby
+instance.stops_on_route('X50')
+```
+
+* **Have fun.** — Everything is returned as a `Hash.new` in Ruby. Use `.inspect` to extract data you need.
+
+-----------------
+
+## TFGM::API Manual
+There's very limited data available, but we've outlined what's currently available below. Parameters denoted with `*` are mandatory.
+
+### Car Parks
+
+* Find all car parks in Greater Manchester
+```ruby
+# Parameters:
+# (int)  *page     = default: 0
+# (int)  *per_page = default: 10
+instance.carparks(0, 5)
+```
+
+* Find a car park by ID
+```ruby
+# Parameters:
+# (int) *id
+instance.carpark(21915)
+```
+
+### Routes
+
+* View all bus routes running in Greater Manchester
+```ruby
+# Parameters:
+# None
+instance.routes
+```
+
+* View bus route by ID
+```ruby
+# Parameters
+# (string) *bus_code
+instance.route('X50')
+```
+
+* Verify bus route exists
+```ruby
+# Parameters:
+# (string) *bus_code
+if instance.is_route('X50') then
+# Route exists, yay!
+end
+```
+
+* Bus stops on bus route
+```ruby
+# Parameters
+# (string) *bus_code
+instance.stops_on_route('X50')
+```
+
+### Bus stops
+
+* Find bus stops near a geolocation
+```ruby
+# Parameters:
+# (double) *latitude
+# (double) *longitude
+instance.bus_stops_near(52.91391221, -3.39414441)
+```
+
+* Find bus stop by ATCO Code
+```ruby
+# Parameters:
+# (string) *atco_code
+instance.bus_stop('1800SB04781')
+```
+
+* Find routes running from bus stop
+```ruby
+# Parameters:
+# (string) *atco_code
+instance.buses_on_stop('1800SB04781')
+```
+
+### Metrolink times
+
+* View all journey times
+```ruby
+# Parameters:
+# None
+instance.journey_times
+```
+
+* View journey times for a single route
+```ruby
+# Parameters:
+# (string) *journey_id
+instance.journey_times('A56-Dunham_proxy')
+```
+
+-----------------
+
+## Contributing
+We all know the REST API for TFGM is **really buggy**, but it's a great start. I'm glad that it's available and can foster innovation in the city, so if you're interested in developing it with me, just play about with it.
+
+Let me know via [@bilawalhameed on Twitter](http://twitter.com/bilawalhameed/) if you're interested before sending a pull request.

data/lib/tfgm.rb

@@ -28,7 +28,7 @@ module TFGM
     TFGM_BASE_URL = "http://opendata.tfgm.com"
 
     ## The version
-    TFGM_VERSION = "0.0.1"
+    TFGM_VERSION = "0.0.3"
     
     ##
     ## When we call TFGM::API.new, we automatically call initialize. Interesting.
@@ -71,10 +71,8 @@ module TFGM
 
         ## Right, throw an error if we can't authorize.
         throw TFGM_Error::DeveloperOrApplicationKeyNotAccepted if _result['Message'].eql?("Authorization has been denied for this request.")
-      rescue TypeError
+      rescue TypeError, JSON::ParserError
         ## Empty by design.
-      rescue JSON::ParserError
-        throw TFGM_Error::JSONParserError
       end
 
       _result
@@ -83,11 +81,11 @@ module TFGM
     ##
     ## Show all car parks
     ##
-    def carparks(page = 1, per_page = 10, options = {})
+    def carparks(page = 0, per_page = 10, options = {})
       _options = { :pageIndex => page, :pageSize => per_page }
 
       ## This validates whether a car park state is valid.
-      if options.has_key?('state')
+      if options.has_key?('state') then
         _enums = self._call('/api/enums')
         throw TFGM_Error::CarParkStateTypeInvalid unless _enums.member?(options['state'])
       end
@@ -120,6 +118,10 @@ module TFGM
       self._call("/api/routes/#{bus_code.to_s}", options)
     end
 
+    def is_route(bus_code, options = {})
+      self.route(bus_code, options).count > 0
+    end
+
     def buses_on_route(bus_code, options = {})
       self._call("/api/routes/#{bus_code.to_s}/buses", options)
     end
@@ -144,12 +146,12 @@ module TFGM
     ##
     ## Journey times
     ##
-    def journey_times(options = {})
-      self._call("/api/journeytimes", options)
-    end
-
-    def journey_time(journey_id, options = {})
-      self._call("/api/journeytimes/#{journey_id.to_s}", options)
+    def journey_times(journey_id = 0, options = {})
+      if journey_id > 0 then
+        self._call("/api/journeytimes/#{journey_id.to_s}", options)
+      else 
+        self._call("/api/journeytimes", options)
+      end
     end
 
     ##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tfgm
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bilawal Hameed