geoapi 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Chris Bruce
+
+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

@@ -0,0 +1,57 @@
+= 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.
+
+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
+
+A Ruby wrapper for the GeoAPI.com APIs.  This gem was almost entirely inspired by the various geoplanet gems.
+
+== Usage
+
+=== Reverse Geocoding:
+
+  require 'geoapi'
+  GeoAPI.apikey = [Your App ID Here]
+  
+  # Location
+  latitude = -27.000
+  longitude = -131.000
+  
+  # Non Required Options
+  optional_parameters = {:radius => '500m', :type => 'POI', :include_parents => true, :limit => 5, :pretty => true}
+  
+  # Lookup
+  entities = GeoAPI::Entity.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
+  
+
+
+== REQUIREMENTS:
+
+To use this library, you must have a valid GeoAPI.com API Key. 
+You can get one at http://api.geoapi.com
+
+Additionally, geoapi has the following gem dependencies:
+
+* rest-client >= 0.9
+* json >= 1.1.3
+
+Please note that if you have ActiveSupport::JSON defined (either by
+manually having loaded it or when you use geoapi within a Rails
+application) the json dependency will be ignored and geoapi uses
+ActiveSupport::JSON instead.
+
+== INSTALL:
+
+This gem is hosted on Gemcutter. To install gemcutter:
+  gem install gemcutter
+  gem tumble
+  
+To install geoapi after gemcutter:
+  gem install geoapi
+  

data/geoapi.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name     = "geoapi"
+  s.version  = "0.0.1"
+  s.date     = "2009-11-10"
+  s.summary  = "A Ruby wrapper for the GeoAPI.com API."
+  s.email    = "chrisabruce@gmail.com"
+  s.homepage = "http://github.com/chrisabruce/GeoAPI/"
+  s.description = "A Ruby wrapper for the GeoAPI.com API. See http://api.geoapi.com for more information about the API."
+  s.authors  = ["Chris Bruce"]
+  
+  s.files    = [
+		"README",
+		"LICENSE",
+		"geoapi.gemspec", 
+		"lib/geoapi.rb",
+		"lib/geoapi/base.rb",
+		"lib/geoapi/entity.rb",
+		"lib/geoapi/view.rb",
+		"lib/geoapi/version.rb"
+	]
+  
+  s.add_dependency("rest-client",   [">= 0.9"])
+  s.add_dependency("json", [">= 1.1.3"])
+  
+  s.has_rdoc = false
+  s.rdoc_options = ["--main", "README.rdoc"]
+end

data/lib/geoapi.rb

@@ -0,0 +1,30 @@
+%w{rubygems rest_client}.each { |x| require x }
+ 
+if defined?(ActiveSupport::JSON)
+  JSON = ActiveSupport::JSON
+  module JSON
+    def self.parse(json)
+      decode(json)
+    end
+  end
+else
+  require 'json'
+end
+ 
+require 'geoapi/version'
+require 'geoapi/base'
+require 'geoapi/entity'
+require 'geoapi/view'
+ 
+module GeoAPI
+  API_VERSION = "v1"
+  API_URL     = "http://api.geoapi.com/#{API_VERSION}/"
+    
+  class << self
+    attr_accessor :apikey
+  end
+ 
+  class BadRequest           < StandardError; end
+  class NotFound             < StandardError; end
+  class NotAcceptable        < StandardError; end
+end

data/lib/geoapi/base.rb

@@ -0,0 +1,40 @@
+module GeoAPI
+  class Base
+    class << self
+      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
+        raise BadRequest, "Parameter invalid"
+      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
+        options.each_pair do |key, value|
+          new_key = key.to_s.gsub(/_/, '-')
+          new_val = case value
+            when TrueClass then 1
+            when FalseClass then 0
+            else value
+          end
+          query[new_key] = new_val 
+        end
+        "?" + query.map{|k,v| "#{k}=#{v}"}.join('&')
+      end
+    end
+  end
+end

data/lib/geoapi/entity.rb

@@ -0,0 +1,49 @@
+module GeoAPI
+  class Entity < Base
+    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)
+      @guid = attrs['guid']
+      if attrs['meta']
+        @name = attrs['meta']['name']
+        @views = attrs['meta']['views'] || []
+        @userviews = attrs['meta']['userviews'] || []
+        @type = attrs['meta']['type'].to_sym
+      end
+      self
+    end
+    
+    def to_s
+      self.name
+    end
+    
+    def to_json
+      self.raw_json
+    end
+    
+  end
+end

data/lib/geoapi/version.rb

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

data/lib/geoapi/view.rb

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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: geoapi
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Bruce
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: A Ruby wrapper for the GeoAPI.com API. See http://api.geoapi.com for more information about the API.
+email: chrisabruce@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- LICENSE
+- geoapi.gemspec
+- lib/geoapi.rb
+- lib/geoapi/base.rb
+- lib/geoapi/entity.rb
+- lib/geoapi/view.rb
+- lib/geoapi/version.rb
+has_rdoc: true
+homepage: http://github.com/chrisabruce/GeoAPI/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the GeoAPI.com API.
+test_files: []
+