bubus 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf278fc1b4b1fb54457bef6ee6a3058495423ec1
-  data.tar.gz: 7527e81c76a23c6bb14d24c0a3c89faf1ccc026b
+  metadata.gz: abc5f8ed69eb1364577bd557f538dfa04d53cb72
+  data.tar.gz: 15ad208790e2df9d69a04f50fa6b483da1c3d929
 SHA512:
-  metadata.gz: b1ec67b5e70c17c18c1dec41b0ab5dbe006a871b2946f6fa54d74f3588d55446ad25d50e6876904b8732f5055a60749d4fb793c8d0e64431acf4aafcda700592
-  data.tar.gz: aaacdf66a3759e5f619359594c5928c32d48b21621f40cf71296f28448d7d97cb4edbd32d941b5f35232557176997bb1267a4623cae449cfa834b306074357d5
+  metadata.gz: 30f341fbe00ff73925c243f2907ac118168d58e8cfdb123346b8970c9d439f8366fd516c974a0c4ceaf3b079a339827121e8263d4d6863cffff1dd90d2ca84ad
+  data.tar.gz: e90a9ceff51ee9e32ea205c0a3e57d323180d47ab5e92880e5e4da1f19dc110b929a1ab36748d6721394c1de317262f1e2bad5a551c8d4905b7c7de8cda203db

data/README.md

@@ -1,6 +1,6 @@
 # Bubus
 
-TODO: Write a gem description
+API Client for playing with the BU Bus API. The BU Bus API is an internal, undocumented API Boston University uses to show students bus locations.  It requires no authentication making it simple for anyone to work with. This gem handles the HTTP requests and abstracts the responses into ruby objects, making it very simple to work with.  
 
 ## Installation
 
@@ -20,7 +20,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ client = BuBus::Client.new
+    
+    $ client.buses {|bus| ... } # returns array of Bus objects, takes optional block
+    $ client.stops {|stop| ... } # returns array of Stop objects, takes optional block
+    
+###Bus
+    Bus object to abstract bus data
+    call_name: id
+    coordinates: "lng, lat"
+    general_heading: degrees clockwise from North
+    id: another id 
+    speed:  measuered in meters / hour 
+    lat: latitude of bus's current position
+    lon: longitude of bus's current position
+
+###Stop
+    Stop object to abstract bus stop data
+    id: id
+    name: name of bus stop
+    description: address of bus stop
+    lat: latitude of bus stop
+    lon: longitude of bus stop
+    times - array of estimated arrival times at bus stop
 
 ## Contributing
 

data/lib/bubus.rb

@@ -1,6 +1,7 @@
 require "bubus/version"
 require "bubus/client"
 require "bubus/bus"
+require "bubus/stop"
 
 module BuBus
 end

data/lib/bubus/bus.rb

@@ -1,13 +1,16 @@
-class Bus
-  attr_accessor :call_name, :coordinates, :general_heading, :id, :speed, :lat, :lng
-  
-  def initialize(bus_hash)
-    @call_name = bus_hash["call_name"]
-    @coordinates = bus_hash["coordinates"]
-    @general_heading = bus_hash["general_heading"]
-    @id = bus_hash["id"]
-    @speed = bus_hash["speed"]
-    @lat = bus_hash["lat"]
-    @lng = bus_hash["lng"]
+module BuBus
+  class Bus
+    attr_accessor :call_name, :coordinates, :general_heading, :id, :speed, :lat, :lng
+    URL = "http://www.bu.edu/bumobile/rpc/bus/livebus.json.php"
+
+    def initialize(bus_hash)
+      @call_name = bus_hash["call_name"]
+      @coordinates = bus_hash["coordinates"]
+      @general_heading = bus_hash["general_heading"]
+      @id = bus_hash["id"]
+      @speed = bus_hash["speed"]
+      @lat = bus_hash["lat"]
+      @lng = bus_hash["lng"]
+    end
   end
 end

data/lib/bubus/client.rb

@@ -3,35 +3,33 @@ require 'json'
 
 module BuBus
   class Client
-    BASE_URL = "http://www.bu.edu/bumobile/rpc/bus/livebus.json.php"
-    
+            
     def initialize()
-      @buses = []
     end
 
     def buses(&block)
-      res = request
-      buses = res["ResultSet"]["Result"]
-      @buses = buses.map do |bus|
-        Bus.new(bus)
-      end
-
-      if block_given?
-        @buses.map do |bus|
-          block.call(bus)
-        end
-      else
-        @buses
-      end
+      buses = request(BuBus::Bus::URL)["ResultSet"]["Result"]
+      buses = buses.map {|bus| Bus.new(bus) }
+      
+      return buses unless block_given?
+      buses.map {|bus| block.call(bus)} 
     end 
-   
-    def request
-      uri = URI(BASE_URL)
-      res = Net::HTTP.get_response(uri)
+
+    def stops(&block)
+      stops = request(BuBus::Stop::URL)["ResultSet"]["Result"]
+      stops = stops.map {|stop| Stop.new(stop)}
+
+      return stops unless block_given?
+      stops.map {|stop| block.call(stop)}
+    end
+  
+   private 
+    def request(url)
+      res = Net::HTTP.get_response(URI(url))
       if(res.is_a?(Net::HTTPOK))
         res = JSON.parse(res.body)
       else
-        raise 'Error'
+        raise 'Error server responded with: #{res.code}'
       end
     end
   end

data/lib/bubus/stop.rb

@@ -0,0 +1,15 @@
+module BuBus
+  class Stop
+    attr_accessor :id, :name, :description, :lat, :lon
+    URL =  "http://www.bu.edu/bumobile/rpc/bus/stops.json.php?service_id=fall"
+
+    def initialize(res)
+      @id = res['stop_id']
+      @name = res['stop_name']
+      @description = res['stop_desc']
+      @lat = res['stop_lat']
+      @lon = res['stop_long']
+      @times = res['times']
+    end
+  end
+end

data/lib/bubus/version.rb

@@ -1,3 +1,3 @@
 module Bubus
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bubus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alex Wheeler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -107,6 +107,7 @@ files:
 - lib/bubus.rb
 - lib/bubus/bus.rb
 - lib/bubus/client.rb
+- lib/bubus/stop.rb
 - lib/bubus/version.rb
 - spec/spec_helper.rb
 homepage: ''