frizzle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c7035aef1e6d6cfd06387fd23c123cd89cb8fa1
+  data.tar.gz: e4bb1013ea4dc5e8abcb1a0b7fff2460326e4746
+SHA512:
+  metadata.gz: 35467cf9d3843705c3daecf22e006a5c004d0db1e659d7ac36a2c93ec31e1a1166409e408136a530094c1555a1e852c3b3066e171b89c02b1febf6758ba986c9
+  data.tar.gz: 75b45a6e7737b4afeef4c19c22f0759fc40eaca1ee68ae000743b9e23463e1aac2b73d85689c559577ebef8f36f84d441760a59a05288f4582b5e5e0abe01586

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Tyler Pearson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# Frizzle: A Ruby wrapper for the TransLoc API
+
+Frizzle is a Ruby wrapper for the [TransLoc Public API](http://api.transloc.com/doc/).
+
+Supports all the TransLoc v1.2 API methods. You can either use the whole API wrapper through `Frizzle` or use parts of it i.e. `Frizzle::Agencies.all` if you solely want to work with a particular resource.
+
+For more information on the TransLoc API, visit [http://api.transloc.com/doc/](http://api.transloc.com/doc/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'frizzle', :git => "git://github.com/tylerpearson/frizzle.git"
+```
+
+Or install it yourself as:
+
+```ruby
+gem install "frizzle", :git => "git://github.com/tylerpearson/frizzle.git"
+```
+
+## Usage
+
+To start using the gem, you can either perform direct calls on `Frizzle`
+
+```ruby
+Frizzle.agencies.all
+```
+
+or through the corresponding class and class methods
+
+```ruby
+Frizzle::Agencies.all
+```
+
+The TransLoc API does not require an API key.
+
+For methods that allow limiting the results with a geographical area filter, there are two form options: *rectangle form* and *point and radius form*.
+
+To limit with *rectangle form*, pass two arrays ([lat, lng]) for the two geo area arguments. It would look like:
+```ruby
+Frizzle.agencies.find_by_geo_area([35.80176,-78.64347], [35.78061,-78.68218])
+```
+
+To limit with *point and radius*, pass an array ([lat, lng]) to the first argument. The second argument is optional and can be used to pass a radius in meters of a circle around the point. If this is not filled out, it will default to 100.
+
+```ruby
+Frizzle.agencies.find_by_geo_area([35.80176,-78.64347])
+Frizzle.agencies.find_by_geo_area([35.80176,-78.64347], 70)
+```
+
+### Agencies
+
+Agencies can be accessed through `Frizzle.agencies` or `Frizzle::Agencies`. This API call can be requested every 10 seconds from the same IP address.
+
+*Examples:*
+```ruby
+Frizzle::Agencies.all
+Frizzle.agencies.all
+Frizzle.agencies.find_by_id(168)
+Frizzle.agencies.find_by_id([168,24])
+Frizzle.agencies.find_by_geo_area([35.80176,-78.64347], 75.5)
+Frizzle.agencies.find_by_geo_area([35.80176,-78.64347])
+Frizzle.agencies.find_by_id_and_geo_area("168", [35.80176,-78.64347])
+Frizzle.agencies.find_by_id_and_geo_area("168", [35.80176,-78.64347], 120)
+Frizzle.agencies.find({:agencies => "12", :geo_area => "35.80176,-78.64347|100"})
+```
+
+###  Segments
+
+Segments can be accessed through `Frizzle.segments` or `Frizzle::Segments`. This API call can be requested every 10 seconds from the same IP address.
+
+*Examples:*
+```ruby
+Frizzle::Segments.find_by_agencies(24)
+Frizzle.segments.find_by_agencies(24)
+Frizzle.segments.find_by_agencies(24)
+Frizzle.segments.find_by_agencies([24,22])
+Frizzle.segments.find_by_agencies_and_routes(24, [4000078, 4000383])
+Frizzle.segments.find_by_agencies_and_geo_area(24, [35.98974,-78.90292])
+Frizzle.segments.find_by_agencies_and_geo_area(24, [35.98974,-78.90292], 100)
+Frizzle.segments.find({:agencies => "24"}
+```
+
+### Routes
+
+Routes can be accessed through `Frizzle.routes` or `Frizzle::Routes`. This API call can be requested every 10 seconds from the same IP address.
+
+*Examples:*
+```ruby
+Frizzle::Routes.find_by_agencies("24")
+Frizzle.routes.find_by_agencies("24")
+Frizzle.routes.find_by_agencies([24, 132])
+Frizzle.routes.find_by_agencies_and_geo_area(24, [35.98974,-78.90292])
+Frizzle::Routes.find({:agencies => "24"})
+```
+
+### Stops
+
+Stops can be accessed through `Frizzle.stops` or `Frizzle::Stops`. This API call can be requested every 10 seconds from the same IP address.
+
+*Examples:*
+
+```ruby
+Frizzle::Stops.find_by_agencies(24)
+Frizzle.stops.find_by_agencies(24)
+Frizzle.stops.find_by_agencies_and_geo_area(24, [35.98974,-78.90292])
+Frizzle::Stops.find({:agencies => "24"})
+```
+
+### Vehicles
+
+Vehicles can be accessed through `Frizzle.vehicles` or `Frizzle::Vehicles`. This API call can be requested every 1 second from the same IP address.
+
+*Examples:*
+```ruby
+Frizzle::Vehicles.find_by_agencies("24")
+Frizzle.vehicles.find_by_agencies("24")
+Frizzle.vehicles.find_by_agencies_and_routes("24", ["4003034","4003038"])
+Frizzle.vehicles.find_by_agencies_and_routes_geo_area(24, ["4003034","4003038"], [35.98974,-78.90292])
+Frizzle::Vehicles.find({:agencies => "24"})
+```
+
+### Arrival Estimates
+
+Arrival estimates can be accessed through `Frizzle.arrival_estimates` or `Frizzle::ArrivalEstimates`. This API call can be requested every 1 second from the same IP address.
+
+*Examples:*
+```ruby
+Frizzle::ArrivalEstimates.find_by_agencies("24")
+Frizzle.arrival_estimates.find_by_agencies("24")
+Frizzle.arrival_estimates.find_by_agencies_and_routes("24", ["4003034","4003038"])
+Frizzle.arrival_estimates.find_by_agencies_and_stops("24", "1029")
+Frizzle.arrival_estimates.find_by_agencies_and_routes_and_stops("24", ["4003034","4003038"], "1029")
+Frizzle::ArrivalEstimates.find({:agencies => "24"})
+```
+
+## Contributing
+
+This is my first Ruby gem, so any issues or pull requests with suggested improvements is appreciated.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Tyler Pearson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/frizzle/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/frizzle.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frizzle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "frizzle"
+  spec.version       = Frizzle::VERSION
+  spec.authors       = ["Tyler Pearson"]
+  spec.email         = ["ty.pearson@gmail.com"]
+  spec.description   = %q{A wrapper for the TransLoc API}
+  spec.summary       = %q{A wrapper for the TransLoc API}
+  spec.homepage      = "https://github.com/tylerpearson/frizzle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "turn"
+  spec.add_development_dependency "minitest"
+
+  spec.add_runtime_dependency "httparty"
+  spec.add_runtime_dependency "hashie"
+end

data/lib/frizzle.rb

@@ -0,0 +1,43 @@
+require "httparty"
+require 'singleton'
+require 'hashie'
+
+Hash.send :include, Hashie::Extensions::DeepMerge
+
+require_relative 'frizzle/version'
+require_relative 'frizzle/exceptions'
+require_relative 'frizzle/base'
+require_relative 'frizzle/agencies'
+require_relative 'frizzle/segments'
+require_relative 'frizzle/routes'
+require_relative 'frizzle/stops'
+require_relative 'frizzle/vehicles'
+require_relative 'frizzle/arrival_estimates'
+
+module Frizzle
+
+  def self.agencies
+    Frizzle::Agencies
+  end
+
+  def self.segments
+    Frizzle::Segments
+  end
+
+  def self.routes
+    Frizzle::Routes
+  end
+
+  def self.stops
+    Frizzle::Stops
+  end
+
+  def self.vehicles
+    Frizzle::Vehicles
+  end
+
+  def self.arrival_estimates
+    Frizzle::ArrivalEstimates
+  end
+
+end

data/lib/frizzle/agencies.rb

@@ -0,0 +1,32 @@
+module Frizzle
+  class Agencies < Base
+
+    def self.all
+      fetch("/agencies.json")
+    end
+
+    def self.find(options={})
+      fetch("/agencies.json",
+        :query => options )
+    end
+
+    def self.find_by_id(agencies)
+      fetch("/agencies.json",
+        :query => { :agencies => formatted_list(agencies) })
+    end
+
+    def self.find_by_geo_area(geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
+      fetch("/agencies.json",
+        :query => { :geo_area => formatted_geo_area(geo_area_first, geo_area_second) })
+    end
+
+    def self.find_by_id_and_geo_area(agencies, geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
+      fetch("/agencies.json",
+        :query => {
+          :agencies => formatted_list(agencies),
+          :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
+        })
+    end
+
+  end
+end

data/lib/frizzle/arrival_estimates.rb

@@ -0,0 +1,41 @@
+module Frizzle
+  class ArrivalEstimates < Base
+
+    def self.find(options={})
+      fetch("/arrival-estimates.json",
+        :query => options )
+    end
+
+    # 168,275
+    def self.find_by_agencies(agencies)
+      fetch("/arrival-estimates.json",
+        :query => { :agencies => formatted_list(agencies) })
+    end
+
+    def self.find_by_agencies_and_routes(agencies, routes)
+      fetch("/arrival-estimates.json",
+        :query => {
+          :agencies => formatted_list(agencies),
+          :routes => formatted_list(routes)
+        })
+    end
+
+    def self.find_by_agencies_and_stops(agencies, stops)
+      fetch("/arrival-estimates.json",
+        :query => {
+          :agencies => formatted_list(agencies),
+          :stops => formatted_list(stops)
+        })
+    end
+
+    def self.find_by_agencies_and_routes_and_stops(agencies, routes, stops)
+      fetch("/arrival-estimates.json",
+          :query => {
+            :agencies => formatted_list(agencies),
+            :routes => formatted_list(routes),
+            :stops => formatted_list(stops)
+        })
+    end
+
+  end
+end

data/lib/frizzle/base.rb

@@ -0,0 +1,58 @@
+module Frizzle
+  class Base
+    include Singleton
+    include HTTParty
+
+    API_VERSION = "1.2".freeze
+    DEFAULT_GEO_RADIUS = 100
+
+    base_uri "http://api.transloc.com/#{API_VERSION}"
+
+    def self.init_settings(options={})
+      {
+        :headers => {
+          "User-Agent" => "frizzle-ruby-#{Frizzle::VERSION}",
+          "Content-Type" => "application/json",
+          "Accept" => "application/json"
+        }
+      }.deep_merge(options)
+    end
+
+    def self.fetch(url, options = {})
+      options = self.init_settings(options)
+      response = get(url, options)
+      if response.success?
+        data = response.parsed_response['data']
+      elsif response.code == 403
+        raise "TransLoc API limit: #{response.response}"
+      else
+        raise TransLocAPIError.new, "#{response}"
+      end
+    end
+
+    def self.is_numeric?(obj)
+       obj.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) == nil ? false : true
+    end
+
+    def self.formatted_list(list)
+      if list.instance_of? Array
+        list = list.join(',')
+      end
+      list.to_s
+    end
+
+    # Rectangle form: http://api.transloc.com/1.2/agencies.json?geo_area=35.80176,-78.64347|35.78061,-78.68218
+    # Point and radius form: http://api.transloc.com/1.2/agencies.json?geo_area=35.80176,-78.64347|75.5
+    def self.formatted_geo_area(first_geo, second_geo=DEFAULT_GEO_RADIUS)
+      if first_geo.instance_of?(Array) && second_geo.instance_of?(Array)
+        coordinates = "#{first_geo.join(',')}|#{second_geo.join(',')}"
+      elsif first_geo.instance_of?(Array) && is_numeric?(second_geo)
+        coordinates = "#{first_geo.join(',')}|#{second_geo}"
+      else
+        raise(ArgumentError, "Geo arguments do not match the required format")
+      end
+      "#{coordinates}"
+    end
+
+  end
+end

data/lib/frizzle/exceptions.rb

@@ -0,0 +1,8 @@
+module Frizzle
+
+  class Error < RuntimeError; end
+
+  # Exception that is raised when Transloc responds with an error
+  class TransLocAPIError < Error; end
+
+end

data/lib/frizzle/routes.rb

@@ -0,0 +1,25 @@
+module Frizzle
+  class Routes < Base
+
+    def self.find(options={})
+      fetch("/routes.json",
+        :query => options )
+    end
+
+    # 168,275
+    def self.find_by_agencies(agencies)
+      fetch("/routes.json",
+        :query => { :agencies => formatted_list(agencies) })
+    end
+
+    # 168    35.80176,-78.64347|75.5
+    def self.find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
+      fetch("/routes.json",
+        :query => {
+          :agencies => formatted_list(agencies),
+          :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
+        })
+    end
+
+  end
+end