citygrid 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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.md

@@ -0,0 +1,46 @@
+# Citygrid
+
+This is a Ruby wrapper for the [CityGrid API](http://developer.citysearch.com/home).
+
+## Installation
+
+As a gem:
+
+    sudo gem install citygrid
+
+As a plugin (in your Rails directory:
+
+    script/plugin install git://github.com/phuphighter/citygrid.git
+    
+## Get a Citygrid API key
+
+Sign up for a CityGrid API key: [http://developer.citysearch.com/member/register](http://developer.citysearch.com/member/register)
+    
+## Usage
+
+### Instantiate a client
+
+    >> citygrid = Citygrid::Client.new(:api_key => 'your_api_key')
+    
+### or configure once
+
+    >> Citygrid.configure do |config|
+    >>   config.api_key = 'your_api_key'
+    >> end
+    >> citygrid = Citygrid::Client.new
+    
+#### Examples
+
+    >> citygrid.search_locations(:what => "roots coffee", :where => "76180", :rpp => 1)
+    => {"results"=>{"region"=>{"name"=>"76180", "latitude"=>"32.86399", "type"=>"postal_code", "longitude"=>"-97.215194", "defaultradius"=>"4.3600"}, "firsthit"=>"1", "uri"=>"http://api.citysearch.com/search/locations?what=roots+coffee&where=76180&rpp=1&publisher=acme", "location"=>{"name"=>"Roots Coffeehouse", "address"=>{"city"=>"N Richland Hills", "postalcode"=>"76180", "street"=>"9101 Boulevard 26", "state"=>"TX"}, "rating"=>nil, "latitude"=>"32.849869", "userreviewcount"=>"0", "profile"=>"http://national.citysearch.com/profile/613027480/n_richland_hills_tx/roots_coffeehouse.html", "featured"=>"false", "phonenumber"=>"8175037344", "offers"=>nil, "id"=>"613027480", "hasvideo"=>"false", "hasoffers"=>"false", "neighborhood"=>nil, "longitude"=>"-97.193291", "samplecategories"=>"Coffeehouses"}, "queryid"=>"", "totalhits"=>"1", "histogram"=>{"name"=>"Categories", "item"=>"http://api.citysearch.com/search/locations?what=roots+coffee&tag=1726&where=76180&rpp=1&publisher=acme"}, "lasthit"=>"1"}}
+    
+    >>  citygrid.profile(:listing_id => '613027480', :client_ip => 'any_client_ip')
+    => {"locations"=>{"location"=>{"display_ad"=>"true", "name"=>"Roots Coffeehouse", "address"=>{"city"=>"N Richland Hills", "latitude"=>"32.849869", "postal_code"=>"76180", "street"=>"9101 Boulevard 26", "delivery_point"=>nil, "cross_street"=>nil, "longitude"=>"-97.193291", "state"=>"TX"}, "urls"=>{"email_link"=>"http://national.citysearch.com/profile/email_business/613027480/n_richland_hills_tx/roots_coffeehouse.html", "reviews_url"=>"http://national.citysearch.com/review/613027480", "video_url"=>nil, "website_url"=>"http://national.citysearch.com/profile/external/613027480/n_richland_hills_tx/roots_coffeehouse.html", "map_url"=>"http://national.citysearch.com/profile/map/613027480/n_richland_hills_tx/roots_coffeehouse.html", "custom_link_1"=>nil, "profile_url"=>"http://national.citysearch.com/profile/613027480/n_richland_hills_tx/roots_coffeehouse.html", "custom_link_2"=>nil, "menu_url"=>nil, "reservation_url"=>nil, "send_to_friend_url"=>"http://national.citysearch.com/profile/sendto/613027480/n_richland_hills_tx/roots_coffeehouse.html"}, "markets"=>{"market"=>"Fort Worth, TX Metro"}, "offers"=>nil, "attributes"=>nil, "contact_info"=>{"display_phone"=>"8175037344", "display_url"=>"http://national.citysearch.com/profile/613027480/n_richland_hills_tx/roots_coffeehouse.html"}, "customer_content"=>{"customer_message_url"=>nil, "customer_message"=>nil, "bullets"=>nil}, "tips"=>nil, "id"=>"613027480", "reference_id"=>"1", "parking"=>nil, "images"=>nil, "infousa_id"=>"695618793", "teaser"=>nil, "neighborhoods"=>nil, "business_hours"=>nil, "reviews"=>{"total_user_reviews"=>nil, "total_user_reviews_shown"=>nil, "overall_review_rating"=>"NA"}, "categories"=>{"category"=>{"name"=>"Coffeehouses", "parent"=>"Restaurants", "parentid"=>"1722", "nameid"=>"1726"}}, "editorials"=>nil}}}
+    
+You can search for locations and events, get reviews, and get business profiles.
+
+## Copyright
+
+Contact me if you have any suggestions and feel free to fork it!
+
+Copyright (c) 2009 Johnny Khai Nguyen, released under the MIT license

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "citygrid"
+    gem.summary = %Q{Ruby wrapper for the CityGrid API}
+    gem.description = %Q{Ruby wrapper for the CityGrid API}
+    gem.email = "johnnyn@gmail.com"
+    gem.homepage = "http://github.com/phuphighter/citygrid"
+    gem.authors = ["Johnny Khai Nguyen"]
+    
+    gem.add_dependency('httparty', '>= 0.5.0')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the citygrid plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the citygrid plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Citygrid'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/citygrid/client.rb

@@ -0,0 +1,40 @@
+module Citygrid
+  
+  class Client
+    include HTTParty
+    base_uri "http://api2.citysearch.com"
+    
+    attr_reader :api_key
+                
+    def initialize(options={})
+      @api_key = options[:api_key] || Citygrid.api_key
+    end
+
+    def search_locations(options={})
+      response = self.class.get("/search/locations", :query => options.merge(self.default_options))
+    end
+    
+    def search_events(options={})
+      response = self.class.get("/search/events", :query => options.merge(self.default_options))
+    end
+    
+    def profile(options={})
+      if options[:client_ip].nil?
+        puts "Dude, a client_ip is required."
+      else
+        response = self.class.get("/profile/", :query => options.merge(self.default_options))
+      end
+    end
+    
+    def reviews(options={})
+      response = self.class.get("/reviews/", :query => options.merge(self.default_options))
+    end
+    
+    protected
+    
+    def default_options
+      {:api_key => @api_key, :publisher => "acme"}
+    end
+    
+  end
+end

data/lib/citygrid.rb

@@ -0,0 +1,36 @@
+# Citygrid
+require 'rubygems'
+gem 'httparty'
+require 'httparty'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+module Citygrid
+  
+  # create config/initializers/citygrid.rb
+  # 
+  # Citygrid.configure do |config|
+  #   config.api_key = 'api_key'
+  # end
+  # client = Citygrid::Client.new
+  #
+  # or
+  #
+  # Citygrid.api_key = 'api_key'
+  #
+  # or
+  #
+  # Citygrid::Client.new(:api_key => 'api_key')
+  
+  def self.configure
+    yield self
+    true
+  end
+
+  class << self
+    attr_accessor :api_key
+  end
+  
+end
+
+require File.join(directory, 'citygrid', 'client')

data/tasks/citygrid_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :citygrid do
+#   # Task goes here
+# end

data/test/citygrid_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CitygridTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: citygrid
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Johnny Khai Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id001
+description: Ruby wrapper for the CityGrid API
+email: johnnyn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/citygrid.rb
+- lib/citygrid/client.rb
+- tasks/citygrid_tasks.rake
+- test/citygrid_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/phuphighter/citygrid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the CityGrid API
+test_files: 
+- test/citygrid_test.rb
+- test/test_helper.rb