factual-api 1.0.3 → 1.1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.1
+* debug mode
+* raw read
+
 ## v1.0.3
 * adding crosswalk(namespace_id, namespace)
 

data/README.md

@@ -402,5 +402,26 @@ You can query Factual for the detailed schema of any specific table in Factual.
 factual.table("global").schema
 ````
 
+# Raw Read Queries
 
+You can perform any read queries documented in the Factual API using the
+raw read query. Just supply the full path (including the first
+forward-slash) and the request will be made using your OAuth token:
 
+````ruby
+# Find rows in the restaurant database whose name begins with "Star" and return both the data and a total count of the matched rows
+factual.read('/t/restaurants-us?filters={"name":{"$bw":"Star"}}&include_count=true')
+````
+
+# Debug Mode
+
+To see the query paths generated by the driver you can use it in debug mode by passing true as
+the third argument of the Factual constructor. Here is an example in irb:
+
+
+````ruby
+> factual = Factual.new(key, secret, true)
+> factual.table("places").filters("name" => {"$bw" => "starbucks"})
+Request: http://api.v3.factual.com/t/places?filters=%7B%22name%22%3A%7B%22%24bw%22%3A%22starbucks%22%7D%7D
+ => [{"address"=>"11290 Donner Pass Rd", "category"=>"Food & Beverage > Cafes, Coffee Houses & Tea Houses", ...
+````

data/lib/factual.rb

@@ -5,8 +5,8 @@ require 'factual/query/resolve'
 require 'factual/query/crosswalk'
 
 class Factual
-  def initialize(key, secret)
-    @api = API.new(generate_token(key, secret))
+  def initialize(key, secret, debug_mode = false)
+    @api = API.new(generate_token(key, secret), debug_mode)
   end
 
   def table(table_id_or_alias)
@@ -25,6 +25,10 @@ class Factual
     Query::Resolve.new(@api, :values => values)
   end
 
+  def read(path)
+    @api.raw_read(path)
+  end
+
   private
 
   def generate_token(key, secret)

data/lib/factual/api.rb

@@ -7,8 +7,9 @@ class Factual
     DRIVER_VERSION_TAG = "factual-ruby-driver-1.0"
     PARAM_ALIASES      = { :search => :q, :sort_asc => :sort }
 
-    def initialize(access_token)
+    def initialize(access_token, debug_mode = false)
       @access_token = access_token
+      @debug_mode = debug_mode
     end
 
     def execute(query, other_params={})
@@ -20,18 +21,27 @@ class Factual
       handle_request(:schema, query.path + "/schema", query.params)["view"]
     end
 
+    def raw_read(path)
+      payload = JSON.parse(make_request("#{API_V3_HOST}#{path}").body)
+      handle_payload(payload)
+    end
+
     private
 
     def handle_request(action, path, params)
-      payload = JSON.parse(make_request(path, params).body)
+      url = "#{API_V3_HOST}/#{path}?#{query_string(params)}"
+      puts "Request: #{url}" if @debug_mode
+      payload = JSON.parse(make_request(url).body)
+      handle_payload(payload)
+    end
+
+    def handle_payload(payload)
       raise StandardError.new(payload["message"]) unless payload["status"] == "ok"
       payload["response"]
     end
 
-    def make_request(path, params)
-      url = "#{API_V3_HOST}/#{path}?#{query_string(params)}"
+    def make_request(url)
       headers = { "X-Factual-Lib" => DRIVER_VERSION_TAG }
-
       @access_token.get(url, headers)
     end
 

metadata

@@ -2,7 +2,7 @@
 name: factual-api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.3
+  version: "1.1"
 platform: ruby
 authors: 
 - Rudiger Lippert
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-13 00:00:00 +08:00
+date: 2012-03-30 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency