tfgm 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGVkMzBiMDBmYTE2OWJlZjc3NWMxYTQ2YWU0YmU0YmM2NDY5M2Q1ZA==
+  data.tar.gz: !binary |-
+    OWNlZmI1YjgyNGUwODYyMmYwZGIwNzRmN2M1YTVhMjQ0MjkzNzllNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjNmOGI5OWRkNjQ4ZmFlNDczNTYxNDQ5YjkzMjc4M2E2MzYxYzM1OTM5NjUz
+    MGNjYmYwY2UyZmUyYTgyMDlhMzBmNTg0MWEzYTA4NDljZWRmZDg0NWYzZGY0
+    YzYyOTBmZWYwYjc4N2FlMjEyYWQ4YzJmZGJiNzY1MjM3ZGRlZWQ=
+  data.tar.gz: !binary |-
+    OWZkMjg1ODc0MmFhZmNkMTBmYmU4NmI2MGJlNzk5MjJlM2Q0NTMzOGRkMzYx
+    MjlmZmJlMGFhOTk0NGNhZjVmNDgxOGFmNGY5MDk0M2FkZWMxNjUwMzE3NzM4
+    YWZiOTkwZDdiMDE4YjExYmY2MTAxZDdmODM0MjY5NTYzY2NjYWU=

data/README.markdown

@@ -0,0 +1,2 @@
+# Transport for Greater Manchester Rubygem
+It is early. Very.

data/lib/tfgm.rb

@@ -0,0 +1,164 @@
+##
+## Dependencies (used for development and using this module independently)
+##
+['rubygems', 'curb', 'json', 'active_support/core_ext/object/to_query'].each { |_require| require _require }
+
+##
+## Some nice camel-cased error names. Gotta catch 'em all.
+##
+module TFGM_Error
+  class Error < StandardError; end
+  class InvalidDeveloperKey < Error; end
+  class InvalidApplicationKey < Error; end
+  class DeveloperOrApplicationKeyNotAccepted < Error; end
+  class CarParkStateTypeInvalid < Error; end
+end
+
+##
+## Let's get to work.
+##
+module TFGM
+
+  ##
+  ## TFGM::API represents external API calls.
+  ##
+  class API
+
+    ## The endpoint we're calling, stored as a constant.
+    TFGM_BASE_URL = "http://opendata.tfgm.com"
+
+    ## The version
+    TFGM_VERSION = "0.0.1"
+    
+    ##
+    ## When we call TFGM::API.new, we automatically call initialize. Interesting.
+    ##
+    def initialize(dev_key, app_key)
+
+      ## Developer key is needed.
+      throw TFGM_Error::InvalidDeveloperKey if not dev_key.to_s.length == 36
+
+      ## Oops, and an application key. They're tied.
+      throw TFGM_Error::InvalidApplicationKey if not app_key.to_s.length == 36
+
+      ## Move the keys to class-based variables
+      @developer_key = dev_key
+      @application_key = app_key
+    end
+
+    ##
+    ## Our central API beast.
+    ##
+    def _call(endpoint, params = {})
+      ## Compile RESTful API address.
+      _query = TFGM_BASE_URL + endpoint
+      _query += "?" + params.to_query if params.count > 0
+
+      ## Make the call
+      _response = Curl::Easy.perform(_query.to_s) do |_curl|
+        _curl.useragent = "Ruby/Curb/TFGM_API/#{TFGM_VERSION}"
+        _curl.headers['DevKey'] = @developer_key
+        _curl.headers['AppKey'] = @application_key
+        _curl.headers['Content-type'] = 'text/json'
+      end
+
+      ## Exception catching to make it work smoothly.
+      begin
+        _result = JSON.parse(_response.body_str) ## Parse
+
+        ## 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
+        ## Empty by design.
+      rescue JSON::ParserError
+        throw TFGM_Error::JSONParserError
+      end
+
+      _result
+    end
+
+    ##
+    ## Show all car parks
+    ##
+    def carparks(page = 1, per_page = 10, options = {})
+      _options = { :pageIndex => page, :pageSize => per_page }
+
+      ## This validates whether a car park state is valid.
+      if options.has_key?('state')
+        _enums = self._call('/api/enums')
+        throw TFGM_Error::CarParkStateTypeInvalid unless _enums.member?(options['state'])
+      end
+
+      self._call('/api/carparks', _options.merge(options))
+    end
+
+    ##
+    ## Show a single car park
+    ##
+    def carpark(id, options = {})
+      self._call('/api/carparks/' + id.to_s, options)
+    end
+
+    ##
+    ## Show states of car parks.
+    ##
+    def carpark_states(options = {})
+      self._call('/api/enums', options)
+    end
+
+    ##
+    ## Hi, buses.
+    ##
+    def routes(options = {})
+      self._call("/api/routes", options)
+    end
+
+    def route(bus_code, options = {})
+      self._call("/api/routes/#{bus_code.to_s}", options)
+    end
+
+    def buses_on_route(bus_code, options = {})
+      self._call("/api/routes/#{bus_code.to_s}/buses", options)
+    end
+
+    def stops_on_route(bus_code, options = {})
+      self._call("/api/routes/#{bus_code.to_s}/stops", options)
+    end
+
+    def bus_stops_near(lat, lng, options = {})
+      _options = { "latitude" => lat, "longitude" => lng }
+      self._call("/api/stops", _options.merge(options))
+    end
+
+    def bus_stop(atco_code, options = {})
+      self._call("/api/stops/#{atco_code.to_s}", options)
+    end
+
+    def buses_on_stop(atco_code, options = {})
+      self._call("/api/stops/#{atco_code}/route", options)
+    end
+
+    ##
+    ## 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)
+    end
+
+    ##
+    ## Version
+    ##
+    def version
+      TFGM_VERSION
+    end
+
+  end
+end
+
+##
+## Built by Bilaw.al, but please, be awesome and improve it :)
+##

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: tfgm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bilawal Hameed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curb
+  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: json
+  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: active_support
+  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'
+description: ! "  A lightweight Ruby wrapper for the Transport for Greater Manchester
+  Open Data REST API. It was built on the Routes to the Future Innovation Challenge
+  in Manchester by @bilawalhameed.\n  As of March 2013, it supports the REST API to
+  query data such as bus routes, car parks, metrolinks based in Greater Manchester.
+  The API itself is new, so I would take caution.\n"
+email: b@bilawal.co.uk
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- lib/tfgm.rb
+- README.markdown
+homepage: http://github.com/bih/tfgm
+licenses:
+- MIT
+metadata: {}
+post_install_message: ! '>> NOTICE: The TFGM REST API is unstable and is not recommended
+  for production. It is purely for testing at this stage, and we encourage contributing
+  to this gem via http://github.com/bih/tfgm <<'
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Transport for Greater Manchester's API
+test_files: []