data_science_theater_3000 0.0.3.3 → 0.0.3.4

data/README.md

@@ -1,4 +1,4 @@
-# data_science_toolkit_3000
+# data_science_theater_3000
 
 
 ## Development Installation
@@ -9,6 +9,10 @@
 ### Then:
     $ gem install data_science_theater_3000
 
+## Usage
+
+Just ...
+    require "data_science_theater_3000"
 
 ## Contributing
 

data/lib/data_science_theater_3000.rb

@@ -4,7 +4,7 @@ require "data_science_theater_3000/version"
 module DataScienceTheater3000
   # Converts an ip address into a location hash
   #
-  # @param [String] ip the ip address to be located.
+  # @param [String] ip the ip address to be located
   # @return [Hash] key is the ip string passed in as parameter, value is a hash of location information.
   def self.ip2coordinates ip
     url = "http://www.datasciencetoolkit.org"
@@ -12,6 +12,10 @@ module DataScienceTheater3000
     coordinates = make_hashy(response).with_indifferent_access
   end
 
+  # Converts a street address into a location hash
+  #
+  # @param [String] address the address to be located
+  # @return [Hash] key is the address string passed in as a paremeter, value is a hash of location information
   def self.street2coordinates address
     url = "http://www.datasciencetoolkit.org"
     address.gsub!( "," , "%2c" )
@@ -21,6 +25,11 @@ module DataScienceTheater3000
     coordinates = make_hashy(response)
   end
   
+  # Uses latitude,longitude pair to find detailed political information about a location.
+  # Currently supporting a single pair.
+  #
+  # @param [String] "latitude,longitude"
+  # @return [Array] Array containing hashes with detailed political information about a location
   def self.coordinates2politics coords
     url = "http://www.datasciencetoolkit.org"
     coords.gsub!( "," , "%2c" )

data/lib/data_science_theater_3000/version.rb

@@ -1,3 +1,3 @@
 module DataScienceTheater3000
-  VERSION = "0.0.3.3"
+  VERSION = "0.0.3.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_science_theater_3000
 version: !ruby/object:Gem::Version
-  version: 0.0.3.3
+  version: 0.0.3.4
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &17514820 !ruby/object:Gem::Requirement
+  requirement: &16748520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *17514820
+  version_requirements: *16748520
 description: Ruby interface to issue Data Science Toolkit API calls.
 email:
 - tad@isotope11.com