frizzle 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71bc610a691f498af1e64c506af3e9feb243a57a
-  data.tar.gz: b7288a68dac615ec55f7b00b5b156adc1cf649df
+  metadata.gz: a0f2dc3dc4aa57ce91c3701aa899733408a44c8c
+  data.tar.gz: 94904f848e313f2c57ab7505618fee2493d17dbb
 SHA512:
-  metadata.gz: 5bb87668fbc62c30b59c3e5742276933dba444b790dcbb9abe487ed12aea3e3a96d102e3a6656b5bc786e745e0a9c61583061d5f8323aef7b01d2bf610f453d4
-  data.tar.gz: eb362163b28ec7ef909eaec05a5a480a363b3082fd5b5fa417fd503adc73f7d2c01fc158338b018236649a0ed42e5cfa5cf10ea69f24dcafebfb17b593f6fd79
+  metadata.gz: ea42bff16df76c9664a574d7143cbc755b24f55010b8c020789569be8496a68fec0ee1bc196391c9531dd896bab2cf73944ef997a927efa6bdf13de6815c88ac
+  data.tar.gz: 8d71b7e6459de9a8c9e00d098a2371b1d206651bb450764a620620e8da4208aa8c2555ce979289d8bd4eea8605be85812b1ed9887423465e86711632e107a3bf

data/CHANGELOG

@@ -0,0 +1,3 @@
+Version 0.0.1: Intial Frizzle gem is released
+Version 0.0.2: Fixed README formatting for RubyDoc.info
+Version 0.1.0: The default geo radius can now be changed

data/README.md

@@ -43,11 +43,14 @@ 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.
+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. If you wish to change the default radius, it can be changed through `Frizzle.default_geo_radius` or set individually by class.
 
 ```ruby
 Frizzle.agencies.find_by_geo_area([35.80176,-78.64347])
@@ -58,7 +61,7 @@ Frizzle.agencies.find_by_geo_area([35.80176,-78.64347], 70)
 
 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:
+#### Examples:
 
 ```ruby
 Frizzle::Agencies.all
@@ -76,7 +79,7 @@ Frizzle.agencies.find({:agencies => "12", :geo_area => "35.80176,-78.64347|100"}
 
 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:
+#### Examples:
 
 ```ruby
 Frizzle::Segments.find_by_agencies(24)
@@ -93,7 +96,7 @@ Frizzle.segments.find({:agencies => "24"}
 
 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:
+#### Examples:
 
 ```ruby
 Frizzle::Routes.find_by_agencies("24")
@@ -107,7 +110,7 @@ Frizzle::Routes.find({:agencies => "24"})
 
 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:
+#### Examples:
 
 ```ruby
 Frizzle::Stops.find_by_agencies(24)
@@ -120,7 +123,7 @@ Frizzle::Stops.find({:agencies => "24"})
 
 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:
+#### Examples:
 
 ```ruby
 Frizzle::Vehicles.find_by_agencies("24")
@@ -134,7 +137,7 @@ Frizzle::Vehicles.find({:agencies => "24"})
 
 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:
+#### Examples:
 
 ```ruby
 Frizzle::ArrivalEstimates.find_by_agencies("24")

data/lib/frizzle.rb

@@ -15,29 +15,39 @@ require_relative 'frizzle/vehicles'
 require_relative 'frizzle/arrival_estimates'
 
 module Frizzle
+  class << self
 
-  def self.agencies
-    Frizzle::Agencies
-  end
+    def agencies
+      Frizzle::Agencies
+    end
 
-  def self.segments
-    Frizzle::Segments
-  end
+    def segments
+      Frizzle::Segments
+    end
 
-  def self.routes
-    Frizzle::Routes
-  end
+    def routes
+      Frizzle::Routes
+    end
 
-  def self.stops
-    Frizzle::Stops
-  end
+    def stops
+      Frizzle::Stops
+    end
 
-  def self.vehicles
-    Frizzle::Vehicles
-  end
+    def vehicles
+      Frizzle::Vehicles
+    end
 
-  def self.arrival_estimates
-    Frizzle::ArrivalEstimates
-  end
+    def arrival_estimates
+      Frizzle::ArrivalEstimates
+    end
+
+    def default_geo_radius=(radius)
+      Frizzle::Base.default_geo_radius = radius
+    end
 
+    def default_geo_radius
+      Frizzle::Base.default_geo_radius
+    end
+
+  end
 end

data/lib/frizzle/agencies.rb

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

data/lib/frizzle/arrival_estimates.rb

@@ -1,41 +1,42 @@
 module Frizzle
   class ArrivalEstimates < Base
+    class << self
 
-    def self.find(options={})
-      fetch("/arrival-estimates.json",
-        :query => options )
-    end
+      def 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 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 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_routes_and_stops(agencies, routes, stops)
-      fetch("/arrival-estimates.json",
+      def find_by_agencies_and_stops(agencies, stops)
+        fetch("/arrival-estimates.json",
           :query => {
             :agencies => formatted_list(agencies),
-            :routes => formatted_list(routes),
             :stops => formatted_list(stops)
-        })
-    end
+          })
+      end
 
+      def 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
 end

data/lib/frizzle/base.rb

@@ -4,55 +4,60 @@ module Frizzle
     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
+    @default_geo_radius = 100
+
+    class << self
 
-    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}"
+      def default_geo_radius=(radius)
+        @default_geo_radius = radius
       end
-    end
 
-    def self.is_numeric?(obj)
-       obj.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) == nil ? false : true
-    end
+      def default_geo_radius
+        @default_geo_radius || Frizzle::Base.default_geo_radius
+      end
 
-    def self.formatted_list(list)
-      if list.instance_of? Array
-        list = list.join(',')
+      def init_settings(options={})
+        {
+          :headers => {
+            "User-Agent" => "frizzle-ruby-#{Frizzle::VERSION}",
+            "Content-Type" => "application/json",
+            "Accept" => "application/json"
+          }
+        }.deep_merge(options)
       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
+      def fetch(url, options = {})
+        options = self.init_settings(options)
+        response = get(url, options)
+        if response.success?
+          response.parsed_response['data']
+        elsif response.code == 403
+          raise "TransLoc API limit: #{response.response}"
+        else
+          raise TransLocAPIError.new, "#{response}"
+        end
+      end
+
+      def is_numeric?(obj)
+         obj.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/) == nil ? false : true
+      end
+
+      def formatted_list(list)
+        if list.instance_of? Array
+          list = list.join(',')
+        end
+        list.to_s
+      end
+
+      def formatted_geo_area(first_geo, second_geo=nil)
+        return "#{first_geo.join(',')}|#{second_geo.join(',')}" if first_geo.instance_of?(Array) && second_geo.instance_of?(Array)
+        return "#{first_geo.join(',')}|#{second_geo}"  if first_geo.instance_of?(Array) && !second_geo.nil?
+        return "#{first_geo.join(',')}|#{self.default_geo_radius}" if first_geo.instance_of?(Array) && second_geo.nil?
         raise(ArgumentError, "Geo arguments do not match the required format")
       end
-      "#{coordinates}"
     end
-
   end
 end

data/lib/frizzle/routes.rb

@@ -1,23 +1,25 @@
 module Frizzle
   class Routes < Base
+    class << self
 
-    def self.find(options={})
-      fetch("/routes.json",
-        :query => options )
-    end
+      def find(options={})
+        fetch("/routes.json",
+          :query => options )
+      end
 
-    def self.find_by_agencies(agencies)
-      fetch("/routes.json",
-        :query => { :agencies => formatted_list(agencies) })
-    end
+      def find_by_agencies(agencies)
+        fetch("/routes.json",
+          :query => { :agencies => formatted_list(agencies) })
+      end
 
-    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
+      def find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=nil)
+        fetch("/routes.json",
+          :query => {
+            :agencies => formatted_list(agencies),
+            :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
+          })
+      end
 
+    end
   end
 end

data/lib/frizzle/segments.rb

@@ -1,31 +1,33 @@
 module Frizzle
   class Segments < Base
+    class << self
 
-    def self.find(options={})
-      fetch("/segments.json",
-        :query => options )
-    end
+      def find(options={})
+        fetch("/segments.json",
+          :query => options )
+      end
 
-    def self.find_by_agencies(agencies)
-      fetch("/segments.json",
-        :query => { :agencies => formatted_list(agencies) })
-    end
+      def find_by_agencies(agencies)
+        fetch("/segments.json",
+          :query => { :agencies => formatted_list(agencies) })
+      end
 
-    def self.find_by_agencies_and_routes(agencies, routes)
-      fetch("/segments.json",
-        :query => {
-          :agencies => formatted_list(agencies),
-          :routes => formatted_list(routes)
-        })
-    end
+      def find_by_agencies_and_routes(agencies, routes)
+        fetch("/segments.json",
+          :query => {
+            :agencies => formatted_list(agencies),
+            :routes => formatted_list(routes)
+          })
+      end
 
-    def self.find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
-      fetch("/segments.json",
-        :query => {
-          :agencies => formatted_list(agencies),
-          :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
-        })
-    end
+      def find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=nil)
+        fetch("/segments.json",
+          :query => {
+            :agencies => formatted_list(agencies),
+            :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
+          })
+      end
 
+    end
   end
 end

data/lib/frizzle/stops.rb

@@ -1,23 +1,25 @@
 module Frizzle
   class Stops < Base
+    class << self
 
-    def self.find(options={})
-      fetch("/stops.json",
-        :query => options )
-    end
+      def find(options={})
+        fetch("/stops.json",
+          :query => options )
+      end
 
-    def self.find_by_agencies(agencies)
-      fetch("/stops.json",
-        :query => { :agencies => formatted_list(agencies) })
-    end
+      def find_by_agencies(agencies)
+        fetch("/stops.json",
+          :query => { :agencies => formatted_list(agencies) })
+      end
 
-    def self.find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
-      fetch("/stops.json",
-        :query => {
-          :agencies => formatted_list(agencies),
-          :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
-        })
-    end
+      def find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=nil)
+        fetch("/stops.json",
+          :query => {
+            :agencies => formatted_list(agencies),
+            :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
+          })
+      end
 
+    end
   end
 end

data/lib/frizzle/vehicles.rb

@@ -1,40 +1,42 @@
 module Frizzle
   class Vehicles < Base
+    class << self
 
-    def self.find(options={})
-      fetch("/vehicles.json",
-        :query => options )
-    end
+      def find(options={})
+        fetch("/vehicles.json",
+          :query => options )
+      end
 
-    def self.find_by_agencies(agencies)
-      fetch("/vehicles.json",
-        :query => { :agencies => formatted_list(agencies) })
-    end
+      def find_by_agencies(agencies)
+        fetch("/vehicles.json",
+          :query => { :agencies => formatted_list(agencies) })
+      end
 
-    def self.find_by_agencies_and_routes(agencies, routes)
-      fetch("/vehicles.json",
-        :query => {
-          :agencies => formatted_list(agencies),
-          :routes => formatted_list(routes)
-        })
-    end
-
-    def self.find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
-      fetch("/vehicles.json",
-        :query => {
-          :agencies => formatted_list(agencies),
-          :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
-        })
-    end
+      def find_by_agencies_and_routes(agencies, routes)
+        fetch("/vehicles.json",
+          :query => {
+            :agencies => formatted_list(agencies),
+            :routes => formatted_list(routes)
+          })
+      end
 
-    def self.find_by_agencies_and_routes_and_geo_area(agencies, routes, geo_area_first, geo_area_second=Frizzle::Base::DEFAULT_GEO_RADIUS)
-      fetch("/vehicles.json",
+      def find_by_agencies_and_geo_area(agencies, geo_area_first, geo_area_second=nil)
+        fetch("/vehicles.json",
           :query => {
             :agencies => formatted_list(agencies),
-            :routes => formatted_list(routes),
             :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
-        })
-    end
+          })
+      end
 
+      def find_by_agencies_and_routes_and_geo_area(agencies, routes, geo_area_first, geo_area_second=nil)
+        fetch("/vehicles.json",
+            :query => {
+              :agencies => formatted_list(agencies),
+              :routes => formatted_list(routes),
+              :geo_area => formatted_geo_area(geo_area_first, geo_area_second)
+          })
+      end
+
+    end
   end
 end

data/lib/frizzle/version.rb

@@ -1,3 +1,3 @@
 module Frizzle
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/lib/frizzle/version_spec.rb

@@ -3,7 +3,7 @@ require_relative '../../spec_helper'
 describe Frizzle::VERSION do
 
   it "must be the correct Gem version" do
-    Frizzle::VERSION.must_equal "0.0.1"
+    Frizzle::VERSION.must_equal "0.1.0"
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frizzle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Tyler Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md