ruby-factual 0.1.3 → 0.1.4

data/README.md

@@ -1,37 +1,42 @@
 ## Sample Usage
 
 A block of code is worth a thousand words.
->     require 'rubygems'
->     gem 'ruby-factual'
->     require 'factual'
->     
->     api = Factual::Api.new(:api_key => "<YOUR_FACTUAL_API_KEY>")
->     
->     # get table and its metadata
->     # table metadata: name, description, rating, source, creator, created_at,
->     #                 updated_at, total_row_count, geo_enabled, downloadable, 
->     #                 fields (array of hash)
->     table = api.get_table("g9R1u2")
->     puts table.name, table.creator
->     
->     # read rows after filtering and sorting
->     table.filter(:two_letter_abbrev => "CA").sort(:state => -1).page(1, :size => 5).each_row do |state_info|
->
->       # read facts
->       # fact attributes: value, subject_key, field_ref, field (hash)
->       fact = state_info["state"]
->       puts fact.value, fact.subject_key
->
->       # write facts
->       if fact.input("Kalifornia", :source => "source", :comment => "comment")
->         puts "inputted"
->       end
->     end
->     
->     # add a row
->     ret = table.input(:state => "Nebraska", :two_letter_abbrev => "NE")
->     
->     # get a row object from resp
->     subject_key = ret["subjectKey"]
->     row = Factual::Row.new(table, subject_key)
->     puts row["state"].value
+
+    require 'rubygems'
+    gem 'ruby-factual'
+    require 'factual'
+    
+    api = Factual::Api.new(:api_key => "<YOUR_FACTUAL_API_KEY>")
+    
+    # get table and its metadata
+    # table metadata: name, description, rating, source, creator, created_at,
+    #                 updated_at, total_row_count, geo_enabled, downloadable, 
+    #                 fields (array of hash)
+    table = api.get_table("g9R1u2")
+    puts table.name, table.creator
+    
+    # read rows after filtering and sorting
+    table.filter(:two_letter_abbrev => "CA").sort(:state => -1).page(1, :size => 5).each_row do |state_info|
+
+      # read facts
+      # fact attributes: value, subject_key, field_ref, field (hash)
+      fact = state_info["state"]
+      puts fact.value, fact.subject_key
+
+      # write facts
+      if fact.input("Kalifornia", :source => "source", :comment => "comment")
+        puts "inputted"
+      end
+    end
+    
+    # you can also get rows by search
+    row = table.search("hawaii").find_one
+    puts row["state"]
+
+    # add a row
+    ret = table.input(:state => "Nebraska", :two_letter_abbrev => "NE")
+    
+    # get a row object from resp
+    subject_key = ret["subjectKey"]
+    row = Factual::Row.new(table, subject_key)
+    puts row["state"].value

data/lib/factual.rb

@@ -94,6 +94,20 @@ module Factual
       return self
     end
 
+    # Define table search queries, it can be chained before +find_one+ or +each_row+.
+    # 
+    # The params can be:
+    # * A query string
+    # * An array of query strings
+    #
+    # Samples:
+    #   table.serach('starbucks').find_one # one query
+    #   table.search('starbucks', 'burger king').find_one # multiple queries
+    def search(*queries)
+      @searches = queries
+      return self
+    end
+
     # Define table filters, it can be chained before +find_one+ or +each_row+.
     # 
     # The params can be:
@@ -132,12 +146,17 @@ module Factual
     # Samples:
     # * <tt>table.filter(:state => 'CA').find_one</tt>
     # * <tt>table.filter(:state => 'CA').sort(:city => 1).find_one</tt>
+    # * <tt>table.filter(:state => 'CA').search('starbucks').sort(:city => 1).find_one</tt>
     def find_one
-      resp = @adapter.read_table(@table_key, @filters, @sorts, 1)
-      row_data = resp["data", 0]
+      resp = @adapter.read_table(@table_key, 
+          :filters   => @filters, 
+          :searches  => @searches, 
+          :sorts     => @sorts, 
+          :page_size => 1)
+      row_data = resp["data"].first
 
       if row_data.is_a?(Array)
-        subject_key = row_data.unshift
+        subject_key = row_data.shift
         return Row.new(self, subject_key, row_data)
       else
         return nil
@@ -147,17 +166,22 @@ module Factual
     # An iterator on each row (a Factual::Row object) of the filtered and/or sorted table data
     #
     # Samples:
-    #   table.filter(:state => 'CA').sort(:city => 1).each do |row|
+    #   table.filter(:state => 'CA').search('starbucks').sort(:city => 1).each do |row|
     #     puts row.inspect
     #   end
     def each_row
-      resp = @adapter.read_table(@table_key, @filters, @sorts, @page_size, @page)
+      resp = @adapter.read_table(@table_key, 
+          :filters   => @filters, 
+          :searches  => @searches, 
+          :sorts     => @sorts, 
+          :page_size => @page_size, 
+          :page      => @page)
 
       @total_rows = resp["total_rows"]
       rows = resp["data"]
 
       rows.each do |row_data|
-        subject_key = row_data.unshift
+        subject_key = row_data.shift
         row = Row.new(self, subject_key, row_data) 
         yield(row) if block_given?
       end
@@ -236,19 +260,22 @@ module Factual
       @adapter     = @table.adapter
 
       if row_data.empty? && subject_key
+        single_row_mode = true
         row_data = @adapter.read_row(@table_key, subject_key) 
       end
 
+      idx_offset = single_row_mode ? 1 : 0;
+
       @subject     = []
       @fields.each_with_index do |f, idx|
         next unless f["isPrimary"]
-        @subject << row_data[idx+1]
+        @subject << row_data[idx + idx_offset]
       end
 
       @facts_hash  = {}
       @fields.each_with_index do |f, idx|
         next if f["isPrimary"]
-        @facts_hash[f["field_ref"]] = Fact.new(@table, @subject_key, f, row_data[idx+1])
+        @facts_hash[f["field_ref"]] = Fact.new(@table, @subject_key, f, row_data[idx + idx_offset])
       end
     end
 
@@ -292,9 +319,10 @@ module Factual
       return false if value.nil?
 
       hash = opts.merge({
-        :subjectKey => @subject_key,
-        :fieldId    => @field['id'],
-        :value      => value
+        :subjectKey => @subject_key.first,
+        :values     => [{
+          :fieldId    => @field['id'],
+          :value      => value }]
       })
 
       @adapter.input(@table_key, hash)
@@ -382,12 +410,20 @@ module Factual
       return row_data
     end
 
-    def read_table(table_key, filters=nil, sorts=nil, page_size=nil, page=nil)
+    def read_table(table_key, options={})
+      filters   = options[:filters]
+      sorts     = options[:sorts]
+      searches  = options[:searches]
+      page_size = options[:page_size]
+      page      = options[:page]
+
       limit = page_size.to_i 
       limit = DEFAULT_LIMIT unless limit > 0
       offset = (page.to_i - 1) * limit
       offset = 0 unless offset > 0
 
+      filters  = (filters || {}).merge( "$search" => searches) if searches
+
       filters_query = "&filters=" + CGI.escape(filters.to_json) if filters
 
       if sorts
@@ -395,7 +431,8 @@ module Factual
         sorts_query = "&sort=" + sorts.to_json
       end
 
-      url  = "/tables/#{table_key}/read.jsaml?limit=#{limit}&offset=#{offset}" + filters_query.to_s + sorts_query.to_s
+      url  = "/tables/#{table_key}/read.jsaml?limit=#{limit}&offset=#{offset}" 
+      url += filters_query.to_s + sorts_query.to_s
       resp = api_call(url)
 
       return resp["response"]
@@ -410,7 +447,10 @@ module Factual
 
     def input(table_key, params)
       token = params.delete(:token)
-      query_string = params.to_a.collect{ |k,v| CGI.escape(k.to_s) + '=' + CGI.escape(v.to_json) }.join('&')
+      query_string = params.to_a.collect do |k,v| 
+        v_string = (v.is_a?(Hash) || v.is_a?(Array)) ? v.to_json : v.to_s
+        CGI.escape(k.to_s) + '=' + CGI.escape(v_string) 
+      end.join('&')
 
       url  = "/tables/#{table_key}/input.js?" + query_string
       url += "&token=" + token if token

data/test/unit/adapter.rb

@@ -40,7 +40,7 @@ class AdapterTest < Factual::TestCase # :nodoc:
   end
 
   def test_reading_table_with_filter
-    resp = @adapter.read_table(TABLE_KEY, {:two_letter_abbrev => 'CA'})
+    resp = @adapter.read_table(TABLE_KEY, :filters => {:two_letter_abbrev => 'CA'})
     assert_equal resp['total_rows'], 1
   end
 

data/test/unit/table.rb

@@ -1,5 +1,5 @@
-require 'lib/factual'
-require 'test/unit/helper'
+require './lib/factual'
+require './test/unit/helper'
 
 class TableTest < Factual::TestCase # :nodoc:
   def setup
@@ -23,6 +23,14 @@ class TableTest < Factual::TestCase # :nodoc:
     assert_equal states.length, TOTAL_ROWS
   end
 
+  def test_search
+    row = @table.search('hawaii').find_one
+    assert_equal row["state"].value, "hawaii"
+
+    row = @table.search('hi', 'hawaii').find_one
+    assert_equal row["state"].value, "hawaii"
+  end
+
   def test_filtering
     row = @table.filter(:two_letter_abbrev => 'WA').find_one
     assert_equal row["state"].value, "Washington"
@@ -62,12 +70,9 @@ class TableTest < Factual::TestCase # :nodoc:
   def test_adding_row
     row = @table.input(:two_letter_abbrev => 'NE', :state => 'Nebraska')
   end
-
+  
   def test_row
     row = Factual::Row.new(@table, SUBJECT_KEY)
-    assert_equal row["state"].value, "California"
-  end
-
-  def test_fact
+    assert_equal row['state'].value, 'California'
   end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-factual
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+  prerelease: 
+  version: 0.1.4
 platform: ruby
 authors: 
 - Forrest Cao
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 +08:00
+date: 2011-06-17 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 2
-        - 0
         version: 1.2.0
   type: :runtime
   version_requirements: *id001
@@ -66,24 +56,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: 11
-      segments: 
-      - 1
-      - 2
       version: "1.2"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: ""