connexionz 0.0.1

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - jruby
+  - rbx
+  - ree
+  - ruby-head

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in connexionz.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2011, Connexionz
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Code for America nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,77 @@
+# Connexionz API
+
+Ruby wrapper for the Connexionz API 
+
+Installation
+------------
+    gem install connexionz
+
+Documentation
+-------------
+[http://rdoc.info/gems/connexionz](http://rdoc.info/gems/connexionz)
+
+Continuous Integration
+----------------------
+[![Build Status](http://travis-ci.org/ryanatwork/connexionz.png)](http://travis-ci.org/ryanatwork/connexionz)
+
+Usage Examples
+--------------
+    require 'connexionz'
+
+    @client = Connexionz::Client.new({:endpoint => "http://businfo.santa-clarita.com/"})
+    @client.platform # Returns all the platforms
+    a = @client.route_position_et({:platformno => "16890"})
+	a = route_position_et.platform.name # Returns "McBean Pky & Valencia Blvd"
+
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues](https://github.com/ryanatwork/connexionz/issues)
+* by reviewing patches
+
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](https://github.com/ryanatwork/connexionz/issues)
+to track bugs and features. Before submitting a bug report or feature request,
+check to make sure it hasn't already been submitted. You can indicate support
+for an existing issuse by voting it up. When submitting a bug report, please
+include a [Gist](https://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version,
+Ruby version, and operating system. Ideally, a bug report should include a pull
+request with failing specs.
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Credits
+-------
+[Connexionz](http://www.connexionz.co.nz/) 
+
+Inspiration
+-----------
+Connexionz was heavily inspired by the [https://github.com/codeforamerica/gem_template](Code for America Gem Template)
+
+Copyright
+---------
+Copyright (c) 2011 Ryan Resella
+See [LICENSE](https://github.com/ryanatwork/connexionz/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/connexionz.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/connexionz/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'connexionz'
+  gem.version     = Connexionz::VERSION
+  gem.author      = "Ryan Resella"
+  gem.email       = 'ryan@codeforamerica.org'
+  gem.homepage    = 'https://github.com/ryanatwork/connexionz/'
+  gem.summary     = gem.description
+  gem.description = %q{A Ruby wrapper for the Connexionz bus api}
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'webmock', '~> 1.6'
+  gem.add_development_dependency 'yard', '~> 0.7'
+
+  gem.add_runtime_dependency 'faraday', '~> 0.6.1'
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.6.3'
+  gem.add_runtime_dependency 'hashie', '~> 1.0.0'
+  gem.add_runtime_dependency 'multi_json', '~> 1.0.2'
+  gem.add_runtime_dependency 'multi_xml', '~> 0.2.2'
+  gem.add_runtime_dependency 'patron', '~> 0.4.11'
+  gem.add_runtime_dependency 'rash', '~> 0.3.0'
+end

data/lib/connexionz.rb

@@ -0,0 +1,22 @@
+require 'connexionz/configuration'
+require 'connexionz/client'
+
+module Connexionz
+  extend Configuration
+  # Alias for Connexionz::Client.new
+  #
+  # @return [Connexionz::Client]
+  def self.client(options={})
+    Connexionz::Client.new(options)
+  end
+
+  # Delegate to Connexionz::Client
+  def self.method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_private=false)
+    client.respond_to?(method, include_private) || super(method, include_private)
+  end
+end

data/lib/connexionz/client.rb

@@ -0,0 +1,86 @@
+require 'connexionz/client/connection'
+require 'connexionz/client/request'
+
+module Connexionz
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    
+    def initialize(options={})
+      options = Connexionz.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+    
+    include Connexionz::Client::Connection
+    include Connexionz::Client::Request
+        
+    # Returns all platform locations (WGS84), Id’s & names.
+    #
+    # @param options [Hash] A customizable set of options. 
+    # @return {Hash}
+    # @example
+    #   Connexionz.platform
+    def platform(options={})
+       get("rtt/public/utility/file.aspx?contenttype=SQLXML&Name=Platform.xml", options)
+    end
+    
+    # Returns details platform groups where a number of platforms are grouped together under a common name. Use PlatformTag to link to the platform locations in the above.
+    #
+    # @param options [Hash] A customizable set of options. 
+    # @return {Hash}
+    # @example
+    #   Connexionz.platform_group    
+    def platform_group(options={})
+       get("rtt/public/utility/file.aspx?contenttype=SQLXML&Name=PlatformGroup.xml", options)
+    end
+ 
+    # Route patterns, details all the route patterns (described in the MapInfo MIB/MIF CDATA entities) in the system & the associated platforms. Use PlatformTag to link to the platform locations.
+    #
+    # @param options [Hash] A customizable set of options. 
+    # @return {Hash}
+    # @example
+    #   Connexionz.route_pattern     
+    #def route_pattern(options={})
+    #   get("rtt/public/utility/file.aspx?contenttype=SQLXML&Name=RoutePattern.rxml", options)
+    #end
+    
+    # Provide ETA predictions for an individual platform or platform group.Use PlatformTag (internal key to a platform) or PlatformNo (number physically attached to a bus stop which may change from time to time) arguments.
+    #
+    # @param options [Hash] A customizable set of options. 
+    # @param options PlatformNo [String] The number posted on the bus stop
+    # @param options PlatformTag [String] The ID of the bus stop
+    # @return {Hash}
+    # @example
+    #   Connexionz.route_position_et
+    #   Connexionz.route_position_et({:PlatformNo =>"19812"})
+    #   Connexionz.route_position_et({:PlatformTag =>"428"})       
+    def route_position_et(options={})
+       get("rtt/public/utility/file.aspx?contenttype=SQLXML&Name=RoutePositionET.xml", options)
+    end
+
+    # Returns the master list of schedules
+    #
+    # @param options [Hash] A customizable set of options. 
+    # @return {Hash}
+    # @example
+    #   Connexionz.schedule_master 
+    def schedule_master(options={})
+       get("rtt/public/utility/file.aspx?contenttype=SQLXML&Name=ScheduleMaster.xml", options)
+    end
+    
+    # Returns the schedule detail for the route. 
+    #
+    # @param servicename [String] Weekday, Saturday, Sunday
+    # @param options [Hash] A customizable set of options. 
+    # @param options id [String] The ID of the route number
+    # @return {Hash}
+    # @example
+    #   Connexionz.schedule_detail("Weekday")
+    #   Connexionz.schedule_detail("Weekday", {:id =>"1"})
+    def schedule_detail(servicename, options={})
+       get("rtt/public/utility/file.aspx?contenttype=SQLXML&Name=ScheduleDetail.xml&ServiceName=#{servicename}", options)
+    end
+    
+  end
+end

data/lib/connexionz/client/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday_middleware'
+
+module Connexionz
+  class Client
+    module Connection
+      private
+      
+      def connection(raw=false)
+        options = {
+          :url => endpoint
+        }
+
+        Faraday.new(options) do |connection|
+          connection.use Faraday::Request::UrlEncoded
+          connection.use Faraday::Response::RaiseError
+          connection.use Faraday::Response::Rashify
+          connection.use Faraday::Response::ParseXml
+          connection.adapter (adapter)
+        end
+      end
+    end
+  end
+end

data/lib/connexionz/client/request.rb

@@ -0,0 +1,18 @@
+module Connexionz
+  class Client
+    module Request
+      def get(path, options={})
+        request(:get, path, options)
+      end
+
+      private
+
+      def request(method, path, options)
+        response = connection.send(method) do |request|
+          request.url(path, options)
+        end
+        response.body
+      end
+    end
+  end
+end

data/lib/connexionz/configuration.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'connexionz/version'
+
+module Connexionz
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :endpoint,
+      :format,
+      :proxy,
+      :user_agent].freeze
+
+    VALID_FORMATS = [
+      :xml].freeze
+
+    DEFAULT_ADAPTER      = :patron #Faraday.default_adapter
+    DEFAULT_ENDPOINT     = nil
+    DEFAULT_FORMAT       = :xml
+    DEFAULT_PROXY        = nil
+    DEFAULT_USER_AGENT   = "Connexionz Ruby Gem #{Connexionz::VERSION}".freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset
+      self.adapter      = DEFAULT_ADAPTER
+      self.endpoint     = DEFAULT_ENDPOINT
+      self.format       = DEFAULT_FORMAT
+      self.proxy        = DEFAULT_PROXY
+      self.user_agent   = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/connexionz/version.rb

@@ -0,0 +1,3 @@
+module Connexionz
+  VERSION = "0.0.1"
+end

data/spec/connexionz/client_spec.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+describe Connexionz::Client do
+  describe ".new" do
+     it "should return a Connexionz::Client" do
+       Connexionz::Client.new.should be_a Connexionz::Client
+     end
+   end
+  
+  before do
+    @client = Connexionz::Client.new({:endpoint => "http://businfo.santa-clarita.com/"})
+  end
+  
+  describe "#platform" do
+    it "should return a list of all the platforms" do
+      test = @client.platform
+      test.platforms.platform[1].platform_no.should == "12412"
+    end
+  end
+  
+  describe "#platform_group" do
+    it "should return a list of all the platforms" do
+      test = @client.platform_group
+      test.platform_groups.platform_group[1].name.should == "Ave Stanford & Rye Cyn"
+    end
+  end
+  
+  #describe "#route_pattern" do
+  #  it "should return all the route patterns" do
+  #    test = @client.route_pattern
+  #    test.routepattern.project.route.destination_name = "Ave Stanford & Rye Cyn"
+  #  end
+  #end
+  
+  describe "#route_position_et" do
+    it "should return the ET for the current bus stop" do
+      test = @client.route_position_et({:platformno => "16890"})
+      test.route_position_et.platform.name.should == "McBean Pky & Valencia Blvd"
+    end
+  end
+  
+  describe "#schedule_master" do
+    it "should return the master schedule list" do
+      test = @client.schedule_master
+      test.schedule_master.project.schedule.route[0].name.should == "Whites Cyn/Castaic"
+    end
+  end
+  
+  describe "#schedule_detail" do
+    it "should return the schedule detail for the correct route id" do
+      test = @client.schedule_detail("Weekday",{:id => "1"})
+      test.schedule_detail.route.destination_group.name.should == "Castaic to Whites Cyn"
+    end
+  end
+  
+end