simplegeo 0.5.1 → 0.5.3

data/README.rdoc

@@ -8,46 +8,4 @@ For the specific documentation on APIs (and the full list of parameters) see:
 * http://simplegeo.com/docs/clients-code-libraries/ruby
 * http://simplegeo.com/docs/tutorials/ruby
 
-== Installation
-
-Open the Terminal or other UNIX shell and type:
-
-  sudo gem install simplegeo
-
-== Examples
-
-Start by requiring SimpleGeo and setting your authentication credentials:
-
-  require 'simple_geo'
-  SimpleGeo::Client.set_credentials('token', 'secret')
-  
-=== Other APIs
-
-For more examples see: spec/client_spec.rb 
-
-=== Building
-
-  rake gemspec
-  gem build simplegeo.gemspec
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Running tests
-* Use rspec 2 and run "rspec spec" from the project root to run all of the specs
-* You're going to require rspec json oauth fakeweb, vcr and autotest (plus their dependencies)
-
-== Adding tests
-* If you want to add new tests, you will need to put a valid token and secret into a before block - similar to lines 4-6 in spec/client_spec.rb, but you'll have to enter valid credentials.
-* Look at spec/features_spec.rb for examples of how to write a vcr test. First time it runs the remote connection. After that it uses the data stored in the vcr/cassette directory. Make sure to sanitize your yml vcr files before committing them by removing your oauth token which is stored there by default.
-
-== Copyright
-
-Copyright (c) 2010 Dan Dofter. See LICENSE for details.
+Copyright (c) 2011 SimpleGeo Inc., Brian Ryckbost, Dan Dofter. See LICENSE for details.

data/lib/simple_geo/client.rb

@@ -12,11 +12,22 @@ module SimpleGeo
         Record.parse_geojson_hash(record_hash)
       end
 
-      def set_credentials(token, secret)
+      # If you don't supply your credentials, we assume they're set in the environment.
+      # Using the environment variables is how you would use the client on Heroku, for example.
+      def set_credentials(token=nil, secret=nil)
+        token, secret = check_credentials(token, secret)
         @@connection = Connection.new(token, secret)
         @@connection.debug = @@debug
       end
 
+      def check_credentials(token, secret)
+        if (token.nil? and secret.nil?)
+          token=ENV['SIMPLEGEO_KEY']         
+          secret=ENV['SIMPLEGEO_SECRET']
+        end
+        return token, secret
+      end
+
       def debug=(debug_flag)
         @@debug = debug_flag
         @@connection.debug = @@debug  if @@connection
@@ -115,19 +126,24 @@ module SimpleGeo
         nearby_records
       end
 
-      def get_context(lat, lon)
-        geojson_hash = get Endpoint.context(lat, lon)
+      def get_context(lat, lon, filter=nil)
+        geojson_hash = get Endpoint.context(lat, lon, filter)
         HashUtils.recursively_symbolize_keys geojson_hash
       end
       
-      def get_context_by_address(address)
+      def get_context_by_address(address, filter=nil)
         address = URI.escape(address, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-        geojson_hash = get Endpoint.context_by_address(address)
+        geojson_hash = get Endpoint.context_by_address(address, filter)
+        HashUtils.recursively_symbolize_keys geojson_hash
+      end
+      
+      def get_context_ip(ip, filter=nil)
+        geojson_hash = get Endpoint.context_ip(ip, filter)
         HashUtils.recursively_symbolize_keys geojson_hash
       end
       
-      def get_context_ip(ip)
-        geojson_hash = get Endpoint.context_ip(ip)
+      def geocode_from_ip(ip="ip")
+        geojson_hash = get Endpoint.geocode_from_ip(ip)
         HashUtils.recursively_symbolize_keys geojson_hash
       end
       

data/lib/simple_geo/endpoint.rb

@@ -45,16 +45,32 @@ module SimpleGeo
         endpoint_url "records/#{layer}/nearby/#{ip}.json", '0.1'
       end
 
-      def context(lat, lon)
-        endpoint_url "context/#{lat},#{lon}.json", '1.0'
+      def context(lat, lon, filter)
+        if defined?(filter)
+          endpoint_url "context/#{lat},#{lon}.json?filter=#{filter}", '1.0'
+        else
+          endpoint_url "context/#{lat},#{lon}.json", '1.0'
+        end
       end
       
-      def context_by_address(address)
-        endpoint_url "context/address.json?address=#{address}", '1.0'
+      def context_by_address(address, filter)
+        if defined?(filter)
+          endpoint_url "context/address.json?address=#{address}&filter=#{filter}", '1.0'
+        else
+          endpoint_url "context/address.json?address=#{address}", '1.0'
+        end
       end
       
-      def context_ip(ip)
-        endpoint_url "context/#{ip}.json", '1.0'
+      def context_ip(ip, filter)
+        if defined?(filter)
+          endpoint_url "context/#{ip}.json?filter=#{filter}", '1.0'
+        else
+          endpoint_url "context/#{ip}.json", '1.0'
+        end
+      end
+
+      def geocode_from_ip(ip)
+        endpoint_url "context/#{ip}.json?filter=query", '1.0'
       end
       
       def places(lat, lon, options)

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: simplegeo
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 13
   prerelease: 
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 3
+  version: 0.5.3
 platform: ruby
 authors: 
-- Andrew Mager
 - Brian Ryckbost
+- Andrew Mager
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 Z
+date: 2011-06-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth
@@ -80,7 +80,23 @@ dependencies:
         version: 1.2.0
   type: :development
   version_requirements: *id004
-description: A SimpleGeo Ruby client
+- !ruby/object:Gem::Dependency 
+  name: vcr
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  version_requirements: *id005
+description: 
 email: andrew@simplegeo.com
 executables: []
 
@@ -142,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: nowarning
-rubygems_version: 1.7.2
+rubyforge_project: 
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: A SimpleGeo Ruby Client