next_muni 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. data/CHANGELOG +2 -0
  2. data/Manifest +1 -1
  3. data/README.rdoc +26 -0
  4. data/Rakefile +1 -1
  5. data/next_muni.gemspec +5 -5
  6. metadata +5 -5
  7. data/README +0 -0
data/CHANGELOG CHANGED
@@ -1,3 +1,5 @@
1
+ v0.1.2 Brief Documentation
2
+
1
3
  v0.1.1 Fixed gem for release
2
4
 
3
5
  v0.1.0 get_stops and get_times implemented. Basic organization set up.
data/Manifest CHANGED
@@ -1,5 +1,5 @@
1
1
  CHANGELOG
2
- README
2
+ README.rdoc
3
3
  Rakefile
4
4
  lib/next_muni.rb
5
5
  lib/next_muni/api.rb
data/README.rdoc ADDED
@@ -0,0 +1,26 @@
1
+ == NextMuni Gem
2
+
3
+ The NextMuni gem makes it easy to access your NextMuni daily buses arrival times. First, start by entering your bus number
4
+ to identify your stop_id, Then pass both the bus number and your stop_id to get an array of next arrival times.
5
+
6
+ Currently, the API is only currently tested to work with the SF Muni services.
7
+
8
+ Questions are welcome on the github wiki for now – https://github.com/hjhart/next_muni_gem/wiki
9
+
10
+ == Usage
11
+
12
+ # get_stops(route_no)
13
+ NextMuni.get_stops(45)
14
+
15
+ This will return you a Hash with keys being the stop_id and the values being the name of the stop.
16
+ Use this function to figure out the stop_id you want to grab from the get_times function.
17
+
18
+ # get_times(route_no, stop_id)
19
+ NextMuni.get_times(45, 6771)
20
+
21
+ This will return you upcoming times for the next (up to four) buses coming to that stop.
22
+
23
+ == Todo
24
+
25
+ • Cache the route stops
26
+ • Need to separate out stops between different bus directions
data/Rakefile CHANGED
@@ -2,7 +2,7 @@ require 'rubygems'
2
2
  require 'rake'
3
3
  require 'echoe'
4
4
 
5
- Echoe.new('next_muni', '0.1.1') do |p|
5
+ Echoe.new('next_muni', '0.1.2') do |p|
6
6
  p.description = "A gem to access San Francisco's Next Muni API easily"
7
7
  p.url = "http://www.github.com/hjhart/next_muni_gem"
8
8
  p.author = "James Hart"
data/next_muni.gemspec CHANGED
@@ -2,17 +2,17 @@
2
2
 
3
3
  Gem::Specification.new do |s|
4
4
  s.name = %q{next_muni}
5
- s.version = "0.1.1"
5
+ s.version = "0.1.2"
6
6
 
7
7
  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
8
8
  s.authors = ["James Hart"]
9
- s.date = %q{2011-03-14}
9
+ s.date = %q{2011-03-16}
10
10
  s.description = %q{A gem to access San Francisco's Next Muni API easily}
11
11
  s.email = %q{hjhart@gmail.com}
12
- s.extra_rdoc_files = ["CHANGELOG", "README", "lib/next_muni.rb", "lib/next_muni/api.rb"]
13
- s.files = ["CHANGELOG", "README", "Rakefile", "lib/next_muni.rb", "lib/next_muni/api.rb", "Manifest", "next_muni.gemspec"]
12
+ s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/next_muni.rb", "lib/next_muni/api.rb"]
13
+ s.files = ["CHANGELOG", "README.rdoc", "Rakefile", "lib/next_muni.rb", "lib/next_muni/api.rb", "Manifest", "next_muni.gemspec"]
14
14
  s.homepage = %q{http://www.github.com/hjhart/next_muni_gem}
15
- s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Next_muni", "--main", "README"]
15
+ s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Next_muni", "--main", "README.rdoc"]
16
16
  s.require_paths = ["lib"]
17
17
  s.rubyforge_project = %q{next_muni}
18
18
  s.rubygems_version = %q{1.5.3}
metadata CHANGED
@@ -2,7 +2,7 @@
2
2
  name: next_muni
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: 0.1.1
5
+ version: 0.1.2
6
6
  platform: ruby
7
7
  authors:
8
8
  - James Hart
@@ -10,7 +10,7 @@ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
12
 
13
- date: 2011-03-14 00:00:00 -07:00
13
+ date: 2011-03-16 00:00:00 -07:00
14
14
  default_executable:
15
15
  dependencies: []
16
16
 
@@ -22,12 +22,12 @@ extensions: []
22
22
 
23
23
  extra_rdoc_files:
24
24
  - CHANGELOG
25
- - README
25
+ - README.rdoc
26
26
  - lib/next_muni.rb
27
27
  - lib/next_muni/api.rb
28
28
  files:
29
29
  - CHANGELOG
30
- - README
30
+ - README.rdoc
31
31
  - Rakefile
32
32
  - lib/next_muni.rb
33
33
  - lib/next_muni/api.rb
@@ -44,7 +44,7 @@ rdoc_options:
44
44
  - --title
45
45
  - Next_muni
46
46
  - --main
47
- - README
47
+ - README.rdoc
48
48
  require_paths:
49
49
  - lib
50
50
  required_ruby_version: !ruby/object:Gem::Requirement
data/README DELETED
File without changes