factual-api 1.3.1 → 1.3.2

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v1.3.2
+* added integration test for unicode queries
+* added insert
+* changed factual-auth yaml file from under the integration test folder to ~/.factual
+* added clear
+* timeout support
+
 ## v1.3.1
 * removed sugar crosswalk, switch to normal table
 

data/lib/factual.rb

@@ -1,3 +1,6 @@
+require 'rubygems'
+gem 'oauth'
+
 require 'oauth'
 require 'factual/api'
 require 'factual/query/table'
@@ -9,13 +12,16 @@ require 'factual/query/geocode'
 require 'factual/query/geopulse'
 require 'factual/write/flag'
 require 'factual/write/submit'
+require 'factual/write/clear'
+require 'factual/write/insert'
 require 'factual/multi'
 
 class Factual
   def initialize(key, secret, options = {})
     debug_mode = options[:debug].nil? ? false : options[:debug]
     host = options[:host]
-    @api = API.new(generate_token(key, secret), debug_mode, host)
+    timeout = options[:timeout]
+    @api = API.new(generate_token(key, secret), debug_mode, host, timeout)
   end
 
   def table(table_id_or_alias)
@@ -63,7 +69,21 @@ class Factual
     multi.send
   end
 
-  def flag(table, factual_id, problem, user)
+  def clear(*params)
+    fields = []
+    fields = params.pop if params.last.is_a? Array
+
+    table, user, factual_id = params
+    clear_params = {
+      :table => table,
+      :factual_id => factual_id,
+      :fields => fields.join(","),
+      :user => user }
+
+    Write::Clear.new(@api, clear_params)
+  end
+
+  def flag(table, user, factual_id, problem)
     flag_params = {
       :table => table,
       :factual_id => factual_id,
@@ -75,7 +95,7 @@ class Factual
 
   def submit(*params)
     values = {}
-    values = params.last if params.last.is_a? Hash
+    values = params.pop if params.last.is_a? Hash
 
     table, user, factual_id = params
     submit_params = {
@@ -86,6 +106,18 @@ class Factual
     Write::Submit.new(@api, submit_params)
   end
 
+  def insert(*params)
+    values = {}
+    values = params.pop if params.last.is_a? Hash
+
+    table, user = params
+    insert_params = {
+      :table => table,
+      :user => user,
+      :values => values }
+    Write::Insert.new(@api, insert_params)
+  end
+
   private
 
   def generate_token(key, secret)

data/lib/factual/api.rb

@@ -1,16 +1,18 @@
 require 'json'
 require 'cgi'
+require 'timeout'
 
 class Factual
   class API
-    VERSION = "1.3.1"
+    VERSION = "1.3.2"
     API_V3_HOST = "api.v3.factual.com"
     DRIVER_VERSION_TAG = "factual-ruby-driver-v" + VERSION
     PARAM_ALIASES = { :search => :q, :sort_asc => :sort }
 
-    def initialize(access_token, debug_mode = false, host = nil)
+    def initialize(access_token, debug_mode = false, host = nil, timeout = nil)
       @access_token = access_token
       @debug_mode = debug_mode
+      @timeout = timeout
       @host = host || API_V3_HOST
     end
 
@@ -92,9 +94,9 @@ class Factual
       headers = { "X-Factual-Lib" => DRIVER_VERSION_TAG }
 
       res = if (method == :get)
-              @access_token.get(url, headers)
+              Timeout::timeout(@timeout){ @access_token.get(url, headers) }
             elsif (method == :post)
-              @access_token.post(url, body, headers)
+              Timeout::timeout(@timeout){ @access_token.post(url, body, headers) }
             else
               raise StandardError.new("Unknown http method")
             end
@@ -125,7 +127,7 @@ class Factual
       puts "--- Driver version: #{DRIVER_VERSION_TAG}"
       puts "--- request debug ---"
       puts "req url: #{url}"
-      puts "req method: #{method.upcase}"
+      puts "req method: #{method.to_s.upcase}"
       puts "req headers: #{JSON.pretty_generate(headers)}"
       puts "req body: #{body}" if body
       puts "---------------------"

data/lib/factual/write/clear.rb

@@ -0,0 +1,36 @@
+require 'factual/write/base'
+
+class Factual
+  module Write
+    class Clear < Base
+      VALID_KEYS = [
+        :table, :user,
+        :factual_id, :fields,
+        :comment, :reference
+      ]
+
+      def initialize(api, params)
+        validate_params(params)
+        super(api, params)
+      end
+
+      VALID_KEYS.each do |key|
+        define_method(key) do |*args|
+          Clear.new(@api, @params.merge(key => form_value(args)))
+        end
+      end
+
+      def path
+        "/t/#{@params[:table]}/#{@params[:factual_id]}/clear"
+      end
+
+      private
+
+      def validate_params(params)
+        params.keys.each do |key|
+          raise "Invalid submit option: #{key}" unless VALID_KEYS.include?(key)
+        end
+      end
+    end
+  end
+end

data/lib/factual/write/insert.rb

@@ -0,0 +1,36 @@
+require 'factual/write/base'
+
+class Factual
+  module Write
+    class Insert < Base
+      VALID_KEYS = [
+        :table, :user,
+        :values,
+        :comment, :reference
+      ]
+
+      def initialize(api, params)
+        validate_params(params)
+        super(api, params)
+      end
+
+      VALID_KEYS.each do |key|
+        define_method(key) do |*args|
+          Insert.new(@api, @params.merge(key => form_value(args)))
+        end
+      end
+
+      def path
+        "/t/#{@params[:table]}/insert"
+      end
+
+      private
+
+      def validate_params(params)
+        params.keys.each do |key|
+          raise "Invalid insert option: #{key}" unless VALID_KEYS.include?(key)
+        end
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: factual-api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors: 
 - Rudiger Lippert
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-20 00:00:00 Z
+date: 2012-11-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth
@@ -68,7 +68,9 @@ files:
 - lib/factual/query/resolve.rb
 - lib/factual/query/table.rb
 - lib/factual/write/base.rb
+- lib/factual/write/clear.rb
 - lib/factual/write/flag.rb
+- lib/factual/write/insert.rb
 - lib/factual/write/submit.rb
 - lib/factual.rb
 - README.md