one_bus_away 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4cdf6f62d4648d4903644aa16332432a8a4da1
-  data.tar.gz: 08ba7dd760a9689cd393d0b64a34aa7493933a8b
+  metadata.gz: 9d2d9bd435b8006453f7f7b435523828fdddf382
+  data.tar.gz: d4297a3e713d857573a3f1b4f15f0a923f8e2493
 SHA512:
-  metadata.gz: 73641a3964d0fd91e848e8c0074a6eb10ee6fc46b6074a146d3ca1ff6cddc6a8f222dc8aea812bb2ad2b631869bc953ac5f65384fb554eaa1b4cad4e27ea431a
-  data.tar.gz: c984fba70ef2f9efcde525ffae6f16ef8ee304c73c57b0e149272b158e2bf2499b67012772faf7b27abeab1299117806eb61ea68b46066741ac2d4f129b064ce
+  metadata.gz: 98e4044599cef53cdce3d783db2eeba736d7e18a6b0acf2c352d7a4342997b3041cf2e5841523d630b192b86169fd92cbccb53cc86cc79f9ec9fba19d0fe8dd1
+  data.tar.gz: 433adecd694466dd9519b1e09d330465a86739d46168700cd27b55890e1177dd8c58e14b8930c0fea9f75b72256ab67175547116350da64f93d1003dd7a5af00

data/.gitignore

@@ -13,3 +13,6 @@
 *.a
 mkmf.log
 .DS_Store
+*.gem
+*.quicktask
+/spec/vcr/

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format documentation

data/Guardfile

@@ -1,43 +1,7 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features)
-
-## Uncomment to clear the screen before every task
-# clearing :on
-
-## Guard internally checks for changes in the Guardfile and exits.
-## If you want Guard to automatically start up again, run guard in a
-## shell loop, e.g.:
-##
-##  $ while bundle exec guard; do echo "Restarting Guard..."; done
-##
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-# Note: The cmd option is now required due to the increasing number of ways
-#       rspec may be run, below are examples of the most common uses.
-#  * bundler: 'bundle exec rspec'
-#  * bundler binstubs: 'bin/rspec'
-#  * spring: 'bin/rspec' (This will use spring if running and you have
-#                          installed the spring binstubs per the docs)
-#  * zeus: 'zeus rspec' (requires the server to be started separately)
-#  * 'just' rspec: 'rspec'
-
-guard :rspec, cmd: "bundle exec rspec" do
-  require "guard/rspec/dsl"
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 
-  # Feel free to open issues for suggestions and improvements
-
   # RSpec files
   rspec = dsl.rspec
   watch(rspec.spec_helper) { rspec.spec_dir }
@@ -51,5 +15,4 @@ guard :rspec, cmd: "bundle exec rspec" do
   # Application Files
   watch(%r{^lib/(.+)\.rb})
   watch(%r{^bin/})
-
 end

data/README.md

@@ -1,6 +1,10 @@
 # OneBusAway
 
-This little 'gem' is for easily querying the next avialable bus at a given stop.
+This little 'gem' is for easily querying the next available bus at a given stop.
+
+## Pre-reqs
+
+Please have the ruby development packaged installed.
 
 ## Installation
 
@@ -11,28 +15,32 @@ gem 'one_bus_away'
 ```
 
 And then execute:
-
+```
     $ bundle
-
+```
 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 [stop]
 
-    $ one-bus-away arrivals-and-departures-for-stop 13721 "D Line" 22
+```
+    $ one-bus-away arrivals-and-departures-for-stop 13721
       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/Rakefile

@@ -1,2 +1,9 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
 
+task :test do
+  sh 'rspec'
+  sh 'yard stats --list-undoc'
+  sh 'ruby -W0 -S rubocop'
+end

data/bin/one_bus_away

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require_relative '../lib/one_bus_away'
+
+program :version, '0.0.1'
+program :description, 'Simple querying of One Bus Away'
+
+if File.exist? ENV['HOME'] + '/.one_bus_away'
+  @one_bus_away = OneBusAway.new
+else
+  fail 'please install your one-bus-away API key into ~/.one_bus_away'
+end
+
+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
+    @one_bus_away.current_time
+    p @one_bus_away.data.entry.time
+  end
+end
+
+command 'arrivals-and-departures-for-stop' do |c|
+  c.syntax = 'one-bus-away arrivals-and-departures-for-stop
+   [stop] [route] [arrival time from now]'
+  c.summary = 'Next Arrival Time for a specific Stop'
+  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|
+    @one_bus_away.arrivals_and_departures_for_stop(
+      args[0]
+    )
+
+    busses = @one_bus_away.filter_by_route
+    if busses.empty?
+      puts 'No buses in that time constrain'
+    else
+      busses.each do |bus|
+        puts "The #{bus.keys.first} arrives in #{bus.values.first} minutes"
+      end
+    end
+  end
+end

data/lib/one_bus_away.rb

@@ -1,74 +1,63 @@
-require_relative "one_bus_away/version"
-require 'rest-client'
-require 'utilities'
-require 'contracts'
+require_relative 'one_bus_away/version'
+require_relative 'one_bus_away/utilities'
+require_relative 'one_bus_away/client'
+require 'geocoder'
 
+# Main class
+# defines the way to interact with everything
 class OneBusAway
-  include Contracts::Core
-  C = Contracts
+  attr_accessor :api_method, :parameters
+  attr_reader :client, :data, :http_response
 
-  Contract String => String
-  def initialize(api_key)
-    @api_key = api_key
+  def initialize(options = {})
+    @api_method = options[:api_method]
+    @parameters = options[:parameters]
   end
 
-  Contract String
+  # Returns the current time from the One Bus Away System
   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.to_s
+    @client = OneBusAway::Client.new(
+      api_method: ['current-time']
+    )
+    call_api
   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
-
+  # get arrivales and departunes for a stop with one arguement
+  def arrivals_and_departures_for_stop(stop)
+    @client = OneBusAway::Client.new(
+      api_method: ['arrivals-and-departures-for-stop', "1_#{stop}"]
+    )
+    call_api
+  end
 
+  # Assigns the http data to the @data instance variable
+  def assign_data
+    @data = client.http_response.data
   end
-  
-  # 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)
-    
-    if json["code"] == 200
-      json["data"]["list"].include? "1_#{stop_number}"
-    else
-      fail "OneBusAway API HTTP response error #{json['code']}"
-    end
+
+  # Short hand for building the URL, calling the API, and assigning the data
+  # to @data
+  def call_api
+    @client.build_url
+    @client.get
+    assign_data
   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)
-    
-    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']}"
+  # filter the route by a specific route
+  def filter_by_route
+    array = []
+    data.entry.arrivalsAndDepartures.each do |bus|
+      time = OneBusAway::Utilities.convert_time bus.scheduledDepartureTime
+      array << { bus.routeShortName => time }
     end
+    array
   end
 
+  # Uses the google API to git the long and lat of a given location
+  def get_location(loc)
+    geo = Geocoder.search("#{loc} seattle")
+    lat = geo[0].latitude
+    lon = geo[0].longitude
+    [lon, lat]
+  end
 end

data/lib/one_bus_away/client.rb

@@ -0,0 +1,75 @@
+require 'rest-client'
+require 'recursive-open-struct'
+
+class OneBusAway
+  # Class for establishing a connection to one bus away
+  class Client
+    attr_accessor :api_method, :api_key, :parameters
+    attr_reader :base_url, :url, :http_response
+
+    def initialize(options = {})
+      @api_method = options[:api_method]
+      @api_key = options[:api_key] || apply_local_api_key
+      @parameters = options[:parameters]
+      @base_url = 'api.pugetsound.onebusaway.org'
+    end
+
+    # Verifies that @api_method and @api_key are set
+    def valid?
+      if api_method && api_key
+        true
+      else
+        false
+      end
+    end
+
+    # Provided that @url is set, HTTP get @url
+    def get
+      if @url
+        response = RestClient.get(@url)
+        json = JSON.parse(response)
+        @http_response = RecursiveOpenStruct.new(
+          json, recurse_over_arrays: true
+        )
+      else
+        fail 'url is not properly built'
+      end
+    end
+
+    # Builds a valid url, then sets this string to @url
+    def build_url
+      @url = URI::HTTP.build(
+        host: @base_url,
+        path: build_path,
+        query: build_query
+      ).to_s if valid?
+    end
+
+    # Builds the path for utilization in #build_url
+    def build_path
+      path = %w(api where)
+      path.concat api_method
+      path = path.join('/')
+      @path = "/#{path}.json"
+    end
+
+    # Build query for utilization in #build_url
+    def build_query
+      query = { key: @api_key }
+      query.merge! @parameters if @parameters
+      query.map { |k, v| "#{k}=#{v}" }.join('&')
+    end
+
+    # Applies ~/.one_bus_away to @api if the file exists
+    # otherwise, it fails.
+    def apply_local_api_key
+      if File.exist? ENV['HOME'] + '/.one_bus_away'
+        file = File.read(ENV['HOME'] + '/.one_bus_away')
+        @api_key = file.chomp
+      else
+        fail 'no API key provided. Please ensure you have your api key'\
+          'installed in here: ~/.one_bus_away'
+      end
+    end
+  end
+end

data/lib/one_bus_away/utilities.rb

@@ -0,0 +1,25 @@
+require 'date'
+require 'active_support'
+require 'action_view'
+
+include ActionView::Helpers::DateHelper
+
+class OneBusAway
+  # Useful cross class methods for sting modifications
+  class Utilities
+    # Converts time into a consumable format
+    def self.convert_time(time)
+      obj = OneBusAway::Utilities.new
+      stripped_time = obj.strip_time(time)
+      converted_date = DateTime.strptime(stripped_time, '%s')
+      distance_of_time_in_words_to_now(converted_date.to_time)
+    end
+
+    # Removes the last three characters from a string
+    def strip_time(time)
+      time = time.to_s
+      n = time.size
+      time[0..n - 4]
+    end
+  end
+end

data/lib/one_bus_away/version.rb

@@ -1,3 +1,5 @@
+# Defining the version for this gem
 class OneBusAway
-  VERSION = "0.0.2"
+  # Version for one_bus_away gem
+  VERSION = '0.0.4'
 end

data/one_bus_away.gemspec

@@ -4,26 +4,39 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'one_bus_away/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "one_bus_away"
+  spec.name          = 'one_bus_away'
   spec.version       = OneBusAway::VERSION
-  spec.authors       = ["Jack Ellis"]
-  spec.email         = ["jack@mnmlst.cc"]
-  spec.summary       = "Simple Gem to query One Bus Away API"
-  spec.description   = "This is a simple gem to query bus stops, delay times, and additional features. This does require that you apply for an API key from One Bus Away -- http://pugetsound.onebusaway.org/p/OneBusAwayApiService.action"
-  spec.homepage      = "https://github.com/ellisandy/one-bus-away-cli"
-  spec.license       = "MIT"
+  spec.authors       = ['Jack Ellis']
+  spec.email         = ['jack@mnmlst.cc']
+  spec.summary       = 'Simple Gem to query One Bus Away API'
+  spec.description   = 'This is a simple gem to query bus stops,'\
+                       'delay times, and additional features. This'\
+                       'does require that you apply for an API key'\
+                       'from One Bus Away --'\
+                       'http://pugetsound.onebusaway.org/p/OneBusAwayApiService.action'
+  spec.homepage      = 'https://github.com/ellisandy/one-bus-away-cli'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  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')
+  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 'rspec-mocks', '~> 3.2'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'contracts', '~> 0.12'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6'
+  spec.add_development_dependency 'fuubar', '~> 2.0'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_dependency 'commander', '~> 4.3'
+  spec.add_dependency 'rest-client', '~> 1.8'
+  spec.add_dependency 'recursive-open-struct', '~> 0.6'
+  spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'actionview', '~> 4.2'
+  spec.add_dependency 'geocoder', '~> 1.2'
 end