listingcheck_api 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in listingcheck_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joopp BV / ListingCheck
+
+MIT License
+
+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,52 @@
+# ListingcheckApi
+
+Ruby API to use the ListingCheck REST API.
+
+ListingCheck allows you to scan the Internet for listings of a business. Multiple countries are supported. See for example http://www.goedvermeld.nl, for more information check http://www.listingcheck.com.
+
+For more information on this Gem contact joost@joopp.com.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'listingcheck_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install listingcheck_api
+
+## Usage
+
+    api = ListingcheckApi::Client.new(:auth_token => 'your_ubersecret_token')
+
+Locally setup a new Scan to peform:
+
+    place = ListingcheckApi::Place.new(:name => 'Tam Tam', :phone => '015-7502000', :address => 'Patrijsweg 80', :city => 'Rijswijk')
+    scan = ListingcheckApi::Scan.new(:scan_group => 'restaurants', :place_attributes => place)
+
+Send API call to create the scan and next perform it.
+
+    api.create_scan(scan)
+    api.perform_scan
+
+You will receive the Scan with a unique access_token and all matched listings.
+
+## Supported Listings
+
+We currently support (among others) listings from:
+Facebook Places, Twitter Places, Foursquare Venues, Gouden Gids België (Yellow Pages Belgium), SaySo, Qype, Tupalo (disabled), LinkedIn (disabled), Yell, Telefoonboek.nl, TomTom Places, Yelp, Zoekned.nl, Herold.at, Iens Belgium/Netherlands, Google Plus, Dinnersite, Das Örtliche, Local.ch, Infobel, Eet.nu, Cityplug, GelbeSeiten, Souschef, Resto.be, ..
+
+New sites are added constantly, please contact us for more information.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/listingcheck_api.rb

@@ -0,0 +1,122 @@
+require "listingcheck_api/version"
+
+require 'api_smith'
+
+# api = ListingcheckApi::Client.new(:auth_token => 'your_ubersecret_token', :base_uri => '..')
+# place = ListingcheckApi::Place.new(:name => 'Bridges', :phone => '020-5553560', :address => 'Oudezijds Voorburgwal 197', :city => 'Amsterdam')
+# scan = ListingcheckApi::Scan.new(:scan_group => 'restaurants', :place_attributes => place)
+# api.create_scan(scan)
+# api.post('listings_scans.json', {:extra_query => {:listings_scan => scan}})
+# api.perform_scan
+# api.listing('facebook_places_listing', 142709532406955)
+# api.create_listing('facebook_places_listing', )
+module ListingcheckApi
+
+  class Listing < APISmith::Smash
+    property :type
+    property :uid
+    property :url
+    property :name
+    property :phone
+    property :full_address
+    property :country_code
+    property :lat
+    property :lng
+  end
+
+  class Place < APISmith::Smash
+    # Needed to create new Place for Scan
+    property :name, :required => true
+    property :phone, :required => true
+    property :address, :required => true
+    property :city, :required => true
+    
+    # Filled in
+    property :country_code
+    property :lat
+    property :lng
+  end
+
+  class Scan < APISmith::Smash
+    property :access_token
+    property :scan_group
+    # property :email
+    property :place, :transformer => Place
+    property :place_attributes, :transformer => Place
+
+    property :matched_listings, :transformer => Listing
+    property :error_listing_types
+
+    def matched_listing_types
+      matched_listings.collect(&:type)
+    end
+
+    # FIXME: What is the proper way to do this?
+    def scan!(client)
+      client.perform_scan(self.access_token)
+    end
+
+  end
+
+  class Client
+
+    include APISmith::Client
+
+    attr_reader :auth_token, :version
+
+    # Options:
+    # * :auth_token - Your ListingCheck Authentication token (API)
+    # * :version - Version (defaults to 1)
+    # * :base_uri - Set if you want to use development version
+    def initialize(options = {})
+      @auth_token = options[:auth_token]
+      @version = options[:version] || '1'
+
+      self.class.base_uri(options[:base_uri] || 'api.listingscan.com')
+      self.class.endpoint("api/v#{version}")
+
+      add_query_options!(:auth_token => auth_token)
+    end
+
+    # Opens a (Listing)Scan.
+    def scan(access_token)
+      self.get("listings_scans/#{access_token}.json", :transform => Scan)
+    end
+
+    # Creates a new Scan. Requires a associated Place.
+    def create_scan(scan)
+      self.post('listings_scans.json', {:extra_query => {:listings_scan => scan}, :transform => Scan})
+    end
+
+    # Performs a Scan (scans for Listings).
+    def perform_scan(access_token)
+      self.put("listings_scans/#{access_token}/scan.json", :transform => Scan)
+    end
+
+    # Gets a existing Listing of a particular type.
+    #   listing('facebook_places_listing', 142709532406955)
+    def listing(type, uid)
+      self.get("listing_types/#{type}/listings/#{uid}.json", :transform => Listing)
+    end
+
+    # Gets or creates a new Listing of a particular type.
+    def create_listing(type, uid)
+      self.put("listing_types/#{type}/listings/#{uid}.json", :transform => Listing)
+    end
+
+    def check_response_errors(response)
+      # In 2XX range is success otherwise it's probably error (3XX redirects range is handled by HTTParty).
+      # In case of error we lookup error class or default to ApiError.
+      if not (200..299).include?(response.code)
+        raise "Got HTTP code #{response.code} (#{response.message}) from API."
+      end
+
+      # Check JSON for error
+      # if response.parsed_response.is_a?(Hash) and (error = response.parsed_response['error'])
+      #   raise error
+      # end
+    end
+
+  end # Client
+
+end

data/lib/listingcheck_api/version.rb

@@ -0,0 +1,3 @@
+module ListingcheckApi
+  VERSION = "0.0.2"
+end

data/listingcheck_api.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/listingcheck_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Joost Hietbrink"]
+  gem.email         = ["joost@joopp.com"]
+  gem.description   = %q{Ruby API to use the ListingCheck REST API.}
+  gem.summary       = %q{Ruby API to use the ListingCheck REST API.}
+  gem.homepage      = "http://www.listingcheck.com"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "listingcheck_api"
+  gem.require_paths = ["lib"]
+  gem.version       = ListingcheckApi::VERSION
+
+  gem.add_dependency('api_smith')
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: listingcheck_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Joost Hietbrink
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: api_smith
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Ruby API to use the ListingCheck REST API.
+email: 
+- joost@joopp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/listingcheck_api.rb
+- lib/listingcheck_api/version.rb
+- listingcheck_api.gemspec
+has_rdoc: true
+homepage: http://www.listingcheck.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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 API to use the ListingCheck REST API.
+test_files: []
+