one_bus_away 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 628ea7954f796b3dce9a2dc744ee7f5c5e9a5261
-  data.tar.gz: a62af7684ca5bd5aebbec632807718f4c652dec6
+  metadata.gz: cb4cdf6f62d4648d4903644aa16332432a8a4da1
+  data.tar.gz: 08ba7dd760a9689cd393d0b64a34aa7493933a8b
 SHA512:
-  metadata.gz: 019da129cd7e004b56b46802b6d4bd1190366c7034adf2e6ad84b19fd708bb1907e72c16c85a1f951e812877f71afcc5d493e9fd5229a8a2d1c300022e97ab0d
-  data.tar.gz: 56c543723160f605d9349708e83da35f14b0a289c75ecb9693fa835c6b8fc5d8269b4eacb5e33cfe21f9f53be9803d3c9171e216b196b578a876ff116147fe1c
+  metadata.gz: 73641a3964d0fd91e848e8c0074a6eb10ee6fc46b6074a146d3ca1ff6cddc6a8f222dc8aea812bb2ad2b631869bc953ac5f65384fb554eaa1b4cad4e27ea431a
+  data.tar.gz: c984fba70ef2f9efcde525ffae6f16ef8ee304c73c57b0e149272b158e2bf2499b67012772faf7b27abeab1299117806eb61ea68b46066741ac2d4f129b064ce

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/README.md

@@ -17,13 +17,22 @@ And then execute:
 Or install it yourself as:
 
     $ gem install one_bus_away
+	
+Then you will need to create the file ~/.one_bus_away which contains just your API key which can be requested here: http://pugetsound.onebusaway.org/p/OneBusAwayApiService.action
+
+    $ cat ~/.one_bus_away
+	6xxxxxf7-6ec4-45adsf22-bf33-sdfsdfs
+	
 
 ## Usage
 
 
 one-bus-away arrivals-and-departures-for-stop [stop] [route] [arrival time from now]
 
-one-bus-away arrivals-and-departures-for-stop 29215 "44" 15
+    $ one-bus-away arrivals-and-departures-for-stop 13721 "D Line" 22
+      The D Line arrives in 4 minutes
+      The D Line arrives in 19 minutes
+	  
 ## Contributing
 
 1. Fork it ( https://github.com/ellisandy/one-bus-away-cli/fork )

data/bin/one-bus-away

@@ -2,19 +2,22 @@
 
 require 'rubygems'
 require 'commander/import'
-require 'one_bus_away'
+#require 'one_bus_away'
+require_relative '../lib/one_bus_away'
 
 program :version, '0.0.1'
 program :description, 'Simple querying of One Bus Away'
 
+# puts $LOAD_PATH
+@one_bus_away = OneBusAway.new(File.read(ENV['HOME']+"/.one_bus_away"))
+
 command "current-time" do |c|
   c.syntax = 'one-bus-away current-time'
   c.summary = 'Get the current system time from One Bus Away'
   c.description = 'Makes the current_time API call against the One Bus Away API. Simple, Straightforward, Unneeded'
   c.example '','one-bus-away current-time'
   c.action do |args, options|
-    puts OneBusAway.current_time
-    notify 'Something happened'
+    puts @one_bus_away.current_time
   end
 end
 
@@ -24,12 +27,13 @@ command "arrivals-and-departures-for-stop" do |c|
   c.description = 'By default, you can get the next available arrival time.'
   c.example 'description', 'one-bus-away arrivals-and-departures-for-stop [stop] [route] [arrival time from now]'
   c.action do |args, options|
-# Implement arrivals-and-departures-for-stop [stop] [route]
-    
-    arrivals = OneBusAway.arrivals_and_departures_for_stop(args[0], args[1], args[2])
-    
-    arrivals.each do |arrival|
-      puts "The #{args[1]} arrives in #{arrival}"
+    arrivals = @one_bus_away.arrivals_and_departures_for_stop(args[0], args[1], args[2])
+    unless arrivals.empty?
+      arrivals.each do |arrival|
+        puts "The #{args[1]} arrives in #{arrival}"
+      end
+    else
+      puts "No buses in that time constrain"
     end
   end
 end

data/lib/one_bus_away/version.rb

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

data/lib/one_bus_away.rb

@@ -1,33 +1,74 @@
-require "one_bus_away/version"
+require_relative "one_bus_away/version"
 require 'rest-client'
 require 'utilities'
+require 'contracts'
 
-module OneBusAway
-  def self.api_key
-    return File.read(ENV['HOME']+"/.one_bus_away")
+class OneBusAway
+  include Contracts::Core
+  C = Contracts
+
+  Contract String => String
+  def initialize(api_key)
+    @api_key = api_key
   end
-  
-  def self.current_time
-    response = RestClient.get("http://api.pugetsound.onebusaway.org/api/where/current-time.json?key=#{self.api_key}")
+
+  Contract String
+  def current_time
+    response = RestClient.get("http://api.pugetsound.onebusaway.org/api/where/current-time.json?key=#{@api_key}")
     json = JSON.parse(response)
     time = json["data"]["entry"]["time"]
-    return time
+    return time.to_s
+  end
+
+  # Contract C::Num, C::Or[C::Num, String], C::Num => C::ArrayOf[C::Any]
+  def arrivals_and_departures_for_stop(stop, route, time_to_look_for)
+    if valid_stop?(stop) && valid_route?(route)
+      response = RestClient.get("http://api.pugetsound.onebusaway.org/api/where/arrivals-and-departures-for-stop/1_#{stop}.json?key=#{@api_key}&minutesAfter=#{time_to_look_for}")
+      json = JSON.parse(response)
+      arrivalsAndDepartures = json["data"]["entry"]["arrivalsAndDepartures"]
+
+      outputs = []
+
+      arrivalsAndDepartures.each do |bus|
+        if bus["routeShortName"] == route
+          outputs.sort
+          outputs.push(Utilities.convert_time(bus["scheduledDepartureTime"].to_s))
+        end
+      end
+
+    return outputs
+    else
+      fail "Either your route or stop is invalid."
+    end
+
+
   end
   
-  def self.arrivals_and_departures_for_stop(stop, route, time_to_look_for)
-    #
-    response = RestClient.get("http://api.pugetsound.onebusaway.org/api/where/arrivals-and-departures-for-stop/1_#{stop}.json?key=#{self.api_key}&minutesAfter=#{time_to_look_for}")
+  # Contract C::Num => C::Bool
+  def valid_stop?(stop_number)
+    response = RestClient.get("http://api.pugetsound.onebusaway.org/api/where/stop-ids-for-agency/1.json?key=#{@api_key}")
     json = JSON.parse(response)
-    arrivalsAndDepartures = json["data"]["entry"]["arrivalsAndDepartures"]
     
-    @arrivalsAndDepartures2 = []
-  
-    arrivalsAndDepartures.each do |bus|
-      if bus["routeShortName"] == route      
-        @arrivalsAndDepartures2.push(Utilities.convert_time(bus["scheduledDepartureTime"].to_s))
-      end
+    if json["code"] == 200
+      json["data"]["list"].include? "1_#{stop_number}"
+    else
+      fail "OneBusAway API HTTP response error #{json['code']}"
     end
+  end
+
+  # Contract C::Or[C::Num, String] => C::Bool
+  def valid_route?(route_name)
+    response = RestClient.get("http://api.pugetsound.onebusaway.org/api/where/routes-for-agency/1.json?key=#{@api_key}")
+    json = JSON.parse(response)
     
-    return @arrivalsAndDepartures2
+    if json["code"] == 200
+      array = []
+      json["data"]["list"].map { |x| array.push x["shortName"] }
+      
+      array.include? route_name.to_s
+    else
+      fail "OneBusAway API HTTP response error #{json['code']}"
+    end
   end
+
 end

data/lib/utilities.rb

@@ -1,22 +1,21 @@
 require("date")
-
 class Utilities
   def self.convert_time(time)
     stripped_time = self.strip_time(time)
-    
+
     converted_date = DateTime.strptime(stripped_time,"%s")
-    
+
     new_time = converted_date.to_time#.strftime "%I:%M %P"
     distance_of_time_in_hours_and_minutes(new_time, Time.now)
   end
-  
+
   def self.strip_time(time_to_strip)
     n = time_to_strip.size
     stripped_time = time_to_strip[0..n-4]
     return stripped_time
-  
+
   end
-  
+
   def self.distance_of_time_in_hours_and_minutes(from_time, to_time)
     from_time = from_time.to_time if from_time.respond_to?(:to_time)
     to_time = to_time.to_time if to_time.respond_to?(:to_time)
@@ -30,4 +29,4 @@ class Utilities
     words << "#{hours} #{hours > 1 ? 'hours' : 'hour' } and " if hours > 0
     words << "#{minutes} #{minutes == 1 ? 'minute' : 'minutes' }"
   end
-end
+end

data/one_bus_away.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "contracts"
   spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency "terminal-notifier-guard"
   spec.add_dependency('commander')
   spec.add_dependency('rest-client')
-end
+end

data/spec/one_bus_away_spec.rb

@@ -1,24 +1,34 @@
 require 'one_bus_away'
 
 RSpec.describe OneBusAway do
-  context "Testing" do
-    it "runs initial test" do
-      expect(OneBusAway).not_to eq(nil)
+  describe '.new' do
+    it 'should raise error without arguements' do
+      expect { OneBusAway.new() }.to raise_error
+    end
+    
+    it 'should accept API_KEY as arguement' do
+      expect { OneBusAway.new("somestring")}.not_to raise_error
     end
   end
   
-  context "api_key" do
-    it "does not equal nil" do
-      expect(OneBusAway.api_key).not_to eq(nil)
+  describe '#current_time' do
+    let(:one_bus_away) { OneBusAway.new("6a1c72f7-6ec4-4522-bf33-3698b3ad86c2") }
+    it 'returns true' do
+      expect { one_bus_away.current_time }.not_to raise_error
     end
-    it "errors out when no file is found" do
-      expect(OneBusAway.api_key).to eq(File.read(ENV['HOME']+"/.one_bus_away"))
+  end
+  
+  describe '#arrivals_and_departures_for_stop' do
+    let(:one_bus_away) { OneBusAway.new("6a1c72f7-6ec4-4522-bf33-3698b3ad86c2") }
+    it 'returns true' do
+      expect { one_bus_away.arrivals_and_departures_for_stop(18145, "40", 10) }.not_to raise_error
     end
   end
   
-  context 'get current time' do
-    it 'returns the current time' do
-      expect(OneBusAway.current_time.class).to eq(Fixnum)
+  describe '#valid_stop?' do
+    let(:one_bus_away) { OneBusAway.new("6a1c72f7-6ec4-4522-bf33-3698b3ad86c2") }
+    it 'returns true' do
+      expect { one_bus_away.valid_stop?(18145) }.not_to raise_error
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: one_bus_away
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jack Ellis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  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: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  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: commander
   requirement: !ruby/object:Gem::Requirement
@@ -144,3 +172,4 @@ summary: Simple Gem to query One Bus Away API
 test_files:
 - spec/one_bus_away_spec.rb
 - spec/spec_helper.rb
+has_rdoc: