geoapi 0.0.1 → 0.2.0

data/README

@@ -1,8 +1,13 @@
 = NOTE
 
-This is currently in Alpha Version and isn't fully functional.  Currently, you can only conduct an Entity search and get the raw_json back.
+This is still actively being developed and is very alpha.  You can currently conduct a simple search and an MQL query.  The results are returned as ruby hash.
+
+== TODO
+
+- Building data objects to represent Entities and Views.
+
+- Allow updates to views.
 
-I am quickly developing this into a fully featured gem that supports the full MQL queries offered by GeoAPI.com, so expect frequent updates until a major point release is reached.
 
 = GeoAPI
 
@@ -20,14 +25,14 @@ A Ruby wrapper for the GeoAPI.com APIs.  This gem was almost entirely inspired b
   longitude = -131.000
   
   # Non Required Options
-  optional_parameters = {:radius => '500m', :type => 'POI', :include_parents => true, :limit => 5, :pretty => true}
+  optional_parameters = {:radius => '500m', :type => 'POI', "include-parents" => true, :limit => 5, :pretty => true}
   
-  # Lookup
-  entities = GeoAPI::Entity.search(latitude, longitude, optional_parameters)
+  # Simple Search
+  result = GeoAPI::Query.simple_search(latitude, longitude, optional_parameters)
 
-  entities.each do |i| 
-    puts "guid: #{i.guid}\nname: #{i.name}\ntype: #{i.type}\nviews: #{i.views}\nuserviews: #{i.userviews}"
-  end
+  # MQL Query
+  q = {:lat => 37.75629, :lon => -122.4213, :radius => "1km", :entity => [{:type => "business", :guid => nil}]}
+  results = GeoAPI::Query.query(q)
   
 
 

data/geoapi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "geoapi"
-  s.version  = "0.0.1"
+  s.version  = "0.2.0"
   s.date     = "2009-11-10"
   s.summary  = "A Ruby wrapper for the GeoAPI.com API."
   s.email    = "chrisabruce@gmail.com"
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 		"LICENSE",
 		"geoapi.gemspec", 
 		"lib/geoapi.rb",
-		"lib/geoapi/base.rb",
+		"lib/geoapi/query.rb",
 		"lib/geoapi/entity.rb",
 		"lib/geoapi/view.rb",
 		"lib/geoapi/version.rb"

data/lib/geoapi.rb

@@ -12,9 +12,9 @@ else
 end
  
 require 'geoapi/version'
-require 'geoapi/base'
 require 'geoapi/entity'
 require 'geoapi/view'
+require 'geoapi/query'
  
 module GeoAPI
   API_VERSION = "v1"

data/lib/geoapi/entity.rb

@@ -1,29 +1,10 @@
 module GeoAPI
-  class Entity < Base
+  class Entity
     attr_reader  :guid, :name, :type, :geom, :url, :latitude, :longitude, :views, :userviews, :raw_json
     
     alias_method :lat, :latitude 
     alias_method :lon, :longitude
- 
-    # Class methods
-    def self.search(lat, lon, options = {})
-      options[:lat] = lat
-      options[:lon] = lon
-      url = build_url('search', options)
-      get_then_parse(url)
-    end
-    
-    def self.get_then_parse(url)
-      response = JSON.parse(get(url))
-      results = []
-      if response && response['result']
-        response['result'].each do |entity|
-          results << Entity.new(entity)
-        end
-      end
-      return results
-    end
-    
+
     # Instance methods
     def initialize(attrs)
       @raw_json = JSON.generate(attrs)

data/lib/geoapi/{base.rb → query.rb}

@@ -1,14 +1,35 @@
 module GeoAPI
-  class Base
+  class Query
+    
     class << self
+      # Uses GeoAPI's simple search method
+      def simple_search(lat, lon, options = {})
+        options[:lat] = lat
+        options[:lon] = lon
+        url = build_url('search', options)
+        get_then_parse(url)
+      end
+    
+      # Uses GeoAPI's MQL query method
+      def query(query)
+        q = JSON.generate(query)
+        url = build_url('q', {:q => URI.escape(q)})
+        get_then_parse(url)     
+      end
+    
+    
+      def get_then_parse(url)
+        JSON.parse(get(url))
+      end
+    
       def build_url(resource_path, options = {})
 
         options[:apikey] ||= GeoAPI.apikey
         query_string = build_query_params(options)
-        
+      
         "#{GeoAPI::API_URL}#{resource_path}#{query_string}"
       end
-      
+    
       def get(url)
         RestClient.get(url)
       rescue RestClient::RequestFailed
@@ -16,16 +37,16 @@ module GeoAPI
       rescue RestClient::ResourceNotFound
         raise NotFound, "GUID invalid"
       end
- 
+
       protected
-      
+    
       # Take options and build query string
       def build_query_params(options)
         query = {}
-        
-        # Filter '_' and convert True/False
+      
+        #convert True/False
         options.each_pair do |key, value|
-          new_key = key.to_s.gsub(/_/, '-')
+          new_key = key.to_s
           new_val = case value
             when TrueClass then 1
             when FalseClass then 0
@@ -37,4 +58,4 @@ module GeoAPI
       end
     end
   end
-end
+end

data/lib/geoapi/version.rb

@@ -1,8 +1,8 @@
 module GeoAPI
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 2
+    MINOR = 1
+    TINY  = 0
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/lib/geoapi/view.rb

@@ -1,4 +1,4 @@
 module GeoAPI
-  class View < Base
+  class View
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: geoapi
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Chris Bruce
@@ -45,7 +45,7 @@ files:
 - LICENSE
 - geoapi.gemspec
 - lib/geoapi.rb
-- lib/geoapi/base.rb
+- lib/geoapi/query.rb
 - lib/geoapi/entity.rb
 - lib/geoapi/view.rb
 - lib/geoapi/version.rb