listingcheck_api 0.1.0 → 0.2.0

data/README.md

@@ -24,7 +24,9 @@ Or install it yourself as:
 
     api = ListingcheckApi::Client.new(:auth_token => 'your_ubersecret_token')
 
-Locally setup a new Scan to peform:
+### Scan
+
+Locally setup a new Scan to perform:
 
     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)
@@ -32,10 +34,25 @@ Locally setup a new Scan to peform:
 Send API call to create the scan and next perform it.
 
     api.create_scan(scan)
-    api.perform_scan
+    api.perform_scan(scan.access_token)
 
 You will receive the Scan with a unique access_token and all matched listings.
 
+### Listings
+
+To directly retreive a certain Listing of which you know the uid and type.
+With this request the Listing should exist at ListingCheck (eg. from a previous Scan)!
+
+    api.listing('facebook_places_listing', 142709532406955)
+
+To refresh a certain Listing from the original source:
+
+    api.refresh_listing('facebook_places_listing', 142709532406955)
+
+To create a new Listing (independent of a Scan):
+
+    api.create_listing('facebook_places_listing', 142709532406955)
+
 ## Supported Listings
 
 We currently support (among others) listings from:

data/lib/listingcheck_api.rb

@@ -9,7 +9,8 @@ require 'api_smith'
 # 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', )
+# api.refresh_listing('facebook_places_listing', 142709532406955)
+# api.create_listing('facebook_places_listing', 142709532406955)
 module ListingcheckApi
 
   class Listing < APISmith::Smash
@@ -17,11 +18,23 @@ module ListingcheckApi
     property :uid
     property :url
     property :name
-    property :phone
     property :full_address
     property :country_code
+
+    property :phone
+    property :fax
+    property :website
+    property :email
+
     property :lat
     property :lng
+
+    property :rating
+    property :reviews_count
+    property :checkins.count
+    property :likes_count
+    property :talking_about_count
+    property :were_here_count
   end
 
   class Place < APISmith::Smash
@@ -104,6 +117,11 @@ module ListingcheckApi
       self.put("listing_types/#{type}/listings/#{uid}.json", :transform => Listing)
     end
 
+    # Updates an existing Listing of a particular type with the latest info from the API.
+    def refresh_listing(type, uid)
+      self.put("listing_types/#{type}/listings/#{uid}/refresh.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.

data/lib/listingcheck_api/version.rb

@@ -1,3 +1,3 @@
 module ListingcheckApi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Joost Hietbrink
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-11 00:00:00 +02:00
+date: 2012-10-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency