tupalo_api_client 1.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*
+.rvmrc

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2011 Tupalo.com
+
+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.markdown

@@ -0,0 +1,138 @@
+Tupalo API Client
+---
+
+An interface to [Tupalo.com](Tupalo.com)'s Easy API. This allows you
+to
+
+* search for spots
+* find spots within a certain area
+* display detailed information about a spot
+* display spots on a map
+* post reviews via review widgets
+* match your spots to our spots
+* tell us about spots not yet in our database
+
+Basically this allows you to build a specialized location-based site
+or integrate Tupalo.com's content into your page.
+
+API access
+---
+
+Without an API token you will be limited to 200 requests per
+month. This has to do with the way we are licensing data from our
+partners. For the same reason tokenless requests will not include the
+phone numbers of spots.
+
+To get an API token please email api@tupalo.com and let us know what
+kind of app you have in mind, as well as an estimate on the number of
+requests you will approximately need per month.
+
+Some more guidelines:
+
+* Use the API for good and not for evil.
+* Do not scrape us.
+* Do not resell our data.
+* Create something awesome.
+* Have fun.
+
+Creating an API client instance
+---
+
+    require 'tupalo_api_client'
+    tup = TupaloApiClient.new
+
+Alternatively `#new` can take an options hash with the keys `:lang`
+and `:token` to customize the language and supply your API token.
+
+   tup = TupaloApiClient.new(:lang => 'nl', :token => 'abc123')
+
+Language-wise we currently support English (the default), German, Dutch,
+Danish, Finnish, Polish, Swedish and French.
+
+Spots search
+---
+
+Used for retrieving spots in a certain area.
+
+    tup.spots(:origin => 'Schmalzhofgasse 26, Vienna, Austria',
+       :includecategories => 'restaurant')
+
+This will return all restaurants within 0.3km (the default radius)
+with the Tupalo.com office.
+
+The following parameters are supported in the options hash:
+
+* `name`: name or part of the name of a spot
+* `origin`: an address string (example: "Schmalzhofgasse 26, Vienna, Austria")
+* `latitude`: latitude coordinate
+* `longitude`: longitude coordinate
+* `spot_id`: uses the latitude and longitude of the given spot
+* `radius`: search radius (default 0.3km)
+* `excludecategories`: comma separated category keys
+* `includecategories`: comma separated category keys
+* `map_size`: size of the static map image
+* `offset`: used for pagination (maximum 40, default 0)
+* `limit`: number of results to return (maximum 10)
+* `token`: optional access key token
+
+The list of category keys can be found here in JSON format:
+
+[http://tupalo.com/en/api/v1/categories/tree.json](http://tupalo.com/en/api/v1/categories/tree.json)
+
+Spot details
+---
+
+Returns detailed information about a spot, including reviews.
+
+    tup.spot_details(:spot_id => 'gubi')
+
+This needs a `spot_id` which has to be retrieved via `#spots` first.
+
+Review widget
+---
+
+Returns an HTML partial for a Tupalo.com review widget that you can
+use for embedding Tupalo.com reviews in your site.
+
+_This token-only method is further described in the official API
+documentation._
+
+Matching
+---
+
+Used for augmenting spot information on Tupalo.com or pushing new
+spots into our database. Changes to existing information as well as
+newly added spots will be manually reviewed before being added to the
+site.
+
+_This token-only method is further described in the official API
+documentation._
+
+Error handling
+---
+
+In case something goes wrong, an `TupaloApiErrors::ClientError` (HTTP
+4xx) or a `TupaloApiErrors::ServerError` (HTTP 5xx) get raised.
+
+A "HTTP 412 Precondition Failed" status code is returned if you go
+over your API request limit.
+
+Known problems
+---
+
+None at the moment.
+
+Todo
+---
+
+This gem models the current state of Tupalo.com's Easy API.
+
+Authors
+---
+
+Michael Kohl <michi@tupalo.com> and Andreas Tiefenthaler <andy@tupalo.com>
+
+License
+---
+
+This gem is licensed under the MIT license. See the `LICENSE` file for details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake/testtask'
+require 'fileutils'
+GEMSPEC = 'tupalo_api_client.gemspec'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test_*.rb'
+end
+
+def gemspec
+  @gemspec ||= eval(File.read(GEMSPEC), binding, GEMSPEC)
+end
+
+namespace :gem do
+  desc "Build the gem"
+  task :build => :generate_gemspec do
+    sh "gem build #{GEMSPEC}"
+    FileUtils.mkdir_p 'pkg'
+    FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  end
+
+  desc "Install the gem locally (without docs)"
+  task :install => :build do
+    sh %{gem install pkg/#{gemspec.name}-#{gemspec.version} --no-rdoc --no-ri}
+  end
+
+  desc "Generate the gemspec"
+  task :generate_gemspec do
+    puts gemspec.to_ruby
+  end
+
+  desc "Validate the gemspec"
+  task :validate_gemspec do
+    gemspec.validate
+  end
+end

data/lib/tupalo_api_client.rb

@@ -0,0 +1,60 @@
+require 'api_smith'
+require 'uri'
+
+require 'tupalo_api_client/spot'
+require 'tupalo_api_client/review'
+require 'tupalo_api_client/review_widget'
+require 'tupalo_api_client/match'
+require 'tupalo_api_client/import'
+
+require 'tupalo_api_client/errors'
+
+class TupaloApiClient
+
+  include APISmith::Client
+  include TupaloApiErrors
+
+  base_uri 'http://tupalo.com/'
+
+  def initialize(opts = {})
+    options = {
+      :lang => 'en',
+      :token => '',
+      :timeout => 15}.merge(opts)
+
+    add_query_options! :token => options[:token] unless options[:token].empty?
+    self.class.endpoint "#{options[:lang]}/api/easy/v1"
+  end
+
+  def spots(opts={})
+    get("spots/#{parameterize(opts)}", :transform => Spot)
+  end
+
+  def spot_details(opts={})
+    get("spot/#{parameterize(opts)}", :transform => Spot)
+  end
+
+  def review_widget(opts={})
+    get("review_widget/#{parameterize(opts)}", :transform => ReviewWidget)
+  end
+
+  def match(opts={})
+    transform = opts.has_key?(:spot_id) ? Match : Import
+    get("match/#{parameterize(opts)}", :transform => transform)
+  end
+
+  private
+
+  def parameterize(params)
+    "?#{URI.escape(params.map{|k,v| "#{k}=#{v}"}.join('&'))}"
+  end
+
+  def check_response_errors(response)
+    if response.code.to_s =~ /^(4|5)/
+      raise $1 == "4" ?
+        ClientError.new(response.headers["status"]) :
+        ServerError.new(response.headers["status"])
+    end
+  end
+
+end

data/lib/tupalo_api_client/errors.rb

@@ -0,0 +1,5 @@
+module TupaloApiErrors
+  class ClientError < StandardError; end
+  class ServerError < StandardError; end
+end
+

data/lib/tupalo_api_client/import.rb

@@ -0,0 +1,12 @@
+class Import < APISmith::Smash
+
+  property :name
+  property :city
+  property :country
+  property :street
+  property :phone
+  property :website
+  property :locale
+  property :returntext
+
+end

data/lib/tupalo_api_client/match.rb

@@ -0,0 +1,6 @@
+class Match < APISmith::Smash
+
+  property :url
+  property :changes
+
+end

data/lib/tupalo_api_client/review.rb

@@ -0,0 +1,8 @@
+class Review < APISmith::Smash
+
+  property :rating, :transformer => :to_i
+  property :created_at
+  property :text
+  property :user
+
+end

data/lib/tupalo_api_client/review_widget.rb

@@ -0,0 +1,6 @@
+class ReviewWidget < APISmith::Smash
+
+  property :review_widget
+  property :spot_id
+
+end

data/lib/tupalo_api_client/spot.rb

@@ -0,0 +1,23 @@
+class Spot < APISmith::Smash
+
+  property :street
+  property :state
+  property :category
+  property :website_url_formatted
+  property :icon_url
+  property :zip
+  property :city
+  property :rating, :transformer => :to_f
+  property :google_maps_url
+  property :country_code
+  property :spot_id
+  property :name
+  property :latitude, :transformer => :to_f
+  property :external_url
+  property :longitude, :transformer => :to_f
+  property :image_thumbnail_url
+
+  property :reviews, :transformer => lambda { |review| review.map { |r| Review.call(r) }.flatten }
+
+end
+

data/tupalo_api_client.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = 'tupalo_api_client'
+  s.version = '1.0.1'
+  s.authors = ['Michael Kohl', 'Andreas Tiefenthaler']
+  s.email = ['michi@tupalo.com', 'andy@tupalo.com']
+  s.description = 'A convenient wrapper for the Tupalo.com API'
+  s.summary = s.description
+  s.homepage = 'https://github.com/tupalo/tupalo_api_client'
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split("\n")
+  s.add_dependency('api_smith', '~> 1.0.0')
+  s.has_rdoc = false
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: tupalo_api_client
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Michael Kohl
+- Andreas Tiefenthaler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-23 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: api_smith
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+description: A convenient wrapper for the Tupalo.com API
+email: 
+- michi@tupalo.com
+- andy@tupalo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/tupalo_api_client.rb
+- lib/tupalo_api_client/errors.rb
+- lib/tupalo_api_client/import.rb
+- lib/tupalo_api_client/match.rb
+- lib/tupalo_api_client/review.rb
+- lib/tupalo_api_client/review_widget.rb
+- lib/tupalo_api_client/spot.rb
+- tupalo_api_client.gemspec
+has_rdoc: false
+homepage: https://github.com/tupalo/tupalo_api_client
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A convenient wrapper for the Tupalo.com API
+test_files: []
+