factual 0.1

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile
+Gemfile.lock
+pkg/*
+*.sw?
+.DS_Store
+coverage
+pkg

data/README

@@ -0,0 +1,47 @@
+Factual Gem
+===========
+Factual Gem is a Ruby wrapper for the Factual API v3.  It is based on the HTTParty gem by John Nunemaker.
+
+
+Factual API v3 Docs
+===================
+http://developer.factual.com/display/docs/Factual+Developer+APIs+Version+3
+You will need to request a beta API key at http://www.factual.com/devtools/beta
+
+
+CROSSWALK USAGE
+===============
+client = Factual::Client.new("YOUR_API_KEY")
+crosswalk = Factual::Crosswalk.new(client)
+
+# parameters: factual_id of the place
+results = crosswalk.search_by_factual_id('1234567890')
+
+# parameters: namespace, namespace_id
+results = crosswalk.search_by_factual_id('foursquare', '54634563473')
+
+
+CROSSREF USAGE
+===============
+client = Factual::Client.new("YOUR_API_KEY")
+crossref = Factual::Crossref.new(client)
+
+# parameters: factual_id of the place
+results = crossref.search_by_factual_id('1234567890')
+
+# parameters: url
+results = crossref.search_by_url('http://www.yelp.com/some-business')
+
+
+RESOLVE USAGE
+===============
+client = Factual::Client.new("YOUR_API_KEY")
+resolve = Factual::Resolve.new(client)
+
+# parameters: hash of values
+results = resolve.search_by_values({:name => 'name', :latitude => 37.63326, :longitude => -127.35625})
+
+
+INSTALLATION
+============
+gem install factual

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/factual.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "factual/version"
+
+Gem::Specification.new do |s|
+  s.name        = "factual"
+  s.version     = Factual::VERSION
+  s.authors     = ["Justin Copeland"]
+  s.email       = ["justin@gootnau.com"]
+  s.homepage    = "http://github.com/jmcopeland/factual"
+  s.summary     = %q{Factual v3 API wrapper}
+  s.description = %q{Factual v3 API wrapper}
+
+  s.rubyforge_project = "factual"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "httparty"
+  s.add_runtime_dependency "hashie"
+  s.add_runtime_dependency "rash"
+end

data/lib/factual/categories.rb

@@ -0,0 +1,11 @@
+module Factual
+  class Categories
+
+      include HTTParty
+        
+      def list
+        CategoriesResponse.new(get('http://developer.factual.com/download/attachments/1310739/categories_heir.json?version=10&modificationDate=1321655545493'))
+      end
+    
+  end
+end

data/lib/factual/categories_response.rb

@@ -0,0 +1,40 @@
+module Factual
+  class CategoriesResponse
+    
+    attr_accessor :body
+    
+    def initialize(response)
+        @body = rash_response(response)
+    end
+    
+    def error_message
+      # @body.message.text unless success?
+    end
+    
+    def data
+        if !@body.blank?
+            @body
+        end
+    end
+    
+    private
+    
+    def rash_response(response)
+      if response.is_a?(Array)
+        @body = []
+        response.each do |b|
+          if b.is_a?(Hash)
+            @body << Hashie::Rash.new(b)
+          else
+            @body << b
+          end
+        end
+      elsif response.is_a?(Hash)
+        @body = Hashie::Rash.new(response)
+      else
+        @body = response
+      end
+    end
+    
+  end
+end

data/lib/factual/client.rb

@@ -0,0 +1,13 @@
+module Factual
+  class Client
+    
+    include HTTParty
+    base_uri 'api.v3.factual.com'
+    format :json
+    
+    def initialize(factual_key)
+      self.class.default_params :KEY => factual_key
+    end
+    
+  end
+end

data/lib/factual/core.rb

@@ -0,0 +1,15 @@
+module Factual
+  class Core
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      @client = client
+    end
+    
+    def schema_for_table(table)
+      CoreResponse.new(@client.class.get("/t/#{table}/schema"))
+    end
+      
+  end
+end

data/lib/factual/core_response.rb

@@ -0,0 +1,52 @@
+module Factual
+  class CoreResponse
+    
+    attr_accessor :body
+    
+    def initialize(response)
+        @body = rash_response(response)
+    end
+    
+    def version
+        @body.version
+    end
+    
+    def status
+        @body.status
+    end
+    
+    def success?
+        @body.status == "ok"
+    end
+    
+    def error_message
+      # @body.message.text unless success?
+    end
+        
+    def schema
+        if !@body.response.view.blank?
+            @body.response.view
+        end
+    end
+    
+    private
+    
+    def rash_response(response)
+      if response.is_a?(Array)
+        @body = []
+        response.each do |b|
+          if b.is_a?(Hash)
+            @body << Hashie::Rash.new(b)
+          else
+            @body << b
+          end
+        end
+      elsif response.is_a?(Hash)
+        @body = Hashie::Rash.new(response)
+      else
+        @body = response
+      end
+    end
+    
+  end
+end

data/lib/factual/crossref.rb

@@ -0,0 +1,32 @@
+module Factual
+  class Crossref
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      @client = client
+    end
+    
+    #  optional parameters include: 
+    #    limit: default is 500, must use OAuth to exceed
+    def search_by_factual_id(factual_id, optional = {})
+      options = {:factual_id => factual_id}
+      process(options, optional)
+    end
+    
+    #  optional parameters include: 
+    #    limit: default is 500, must use OAuth to exceed
+    def search_by_url(url, optional = {})
+      options = {:url => url}
+      process(options, optional)
+    end
+    
+    private
+    
+    def process(options, optional)
+      options.merge!(optional) unless optional.blank?
+      PlacesResponse.new(@client.class.get('/places/crossref', :query => options))
+    end
+  
+  end
+end

data/lib/factual/crosswalk.rb

@@ -0,0 +1,74 @@
+module Factual
+  class Crosswalk
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      @client = client
+    end
+    
+    #  optional parameters include: 
+    #    limit: default is 50, must use OAuth to exceed
+    #    only: namespace_id to restrict returns
+    def search_by_factual_id(factual_id, optional = {})
+      options = {:factual_id => factual_id}
+      process(options, optional)
+    end
+    
+    #  optional parameters include: 
+    #    limit: default is 50, must use OAuth to exceed
+    #    only: namespace_id to restrict returns
+    def search_by_namespace(namespace, namespace_id, optional = {})
+      options = {:namespace => namespace, :namespace_id => namespace_id}
+      process(options, optional)
+    end
+    
+    def namespaces
+        [
+            "allmenus",
+            "allpages",
+            "aol",
+            "chow",
+            "citysearch",
+            "dexknows",
+            "explore_to",
+            "facebook",
+            "foursquare",
+            "fwix",
+            "gogobot",
+            "gowalla",
+            "greatschools",
+            "grubhub",
+            "hotelscombined",
+            "hunch",
+            "insiderpages",
+            "loopt",
+            "manta",
+            "menupages",
+            "menupix",
+            "menuplatform",
+            "merchantcircle",
+            "openmenu",
+            "opentable",
+            "restaurants",
+            "retailigence",
+            "simplegeo",
+            "superpages",
+            "urbanspoon",
+            "yahoolocal",
+            "yellowbook",
+            "yelp",
+            "yp",
+            "zagat"
+        ]
+    end
+    
+    private
+    
+    def process(options, optional)
+      options.merge!(optional) unless optional.blank?
+      PlacesResponse.new(@client.class.get('/places/crosswalk', :query => options))
+    end
+  
+  end
+end

data/lib/factual/places.rb

@@ -0,0 +1,33 @@
+module Factual
+  class Places
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      @client = client
+    end
+
+    # http://developer.factual.com/display/docs/Core+API+-+Read
+    # Optional parameters:
+    #   filters: http://developer.factual.com/display/docs/Core+API+-+Row+Filters
+    #   include_count: default is false
+    #   facet: comma seperated list of fields; returns counts grouped by distinct fields
+    #   geo: send a hash {:latitude => lat, :longitude => lng, :radius => rad}
+    #   limit: default is 20, max is 50
+    #   q: full-text search, "sushi bar" searches for sushi AND bar; "sushi,bar" searches sushi OR bar
+    #   offset
+    #   select: fields to include in the query response
+    #   sort: field_name:(asc|desc), $distance:(asc|desc), or $relevance:(asc|desc)
+    
+    def search_table(optional = {})
+      optional[:geo] = create_geo_filter(optional[:geo]) if optional[:geo].exists?
+      PlacesResponse.new(@client.class.get("/t/<table_id>", :query => optional))
+    end
+    
+    private
+    def create_geo_filter(geo_hash)
+        return "{'$circle':{'$center':[#{geo_hash['latitude']}, #{geo_hash['longitude']}],'$meters':#{geo_hash['radius']}}}".to_json
+    end
+      
+  end
+end

data/lib/factual/places_response.rb

@@ -0,0 +1,60 @@
+module Factual
+  class PlacesResponse
+    
+    attr_accessor :body
+    
+    def initialize(response)
+        @body = rash_response(response)
+    end
+    
+    def version
+        @body.version
+    end
+    
+    def status
+        @body.status
+    end
+    
+    def success?
+        @body.status == "ok"
+    end
+    
+    def error_message
+      # @body.message.text unless success?
+    end
+    
+    def included_rows
+        @body.included_rows
+    end
+    
+    def total_rows
+        @body.total_row_count
+    end
+    
+    def data
+        if !@body.response.data.blank?
+            @body.response.data
+        end
+    end
+    
+    private
+    
+    def rash_response(response)
+      if response.is_a?(Array)
+        @body = []
+        response.each do |b|
+          if b.is_a?(Hash)
+            @body << Hashie::Rash.new(b)
+          else
+            @body << b
+          end
+        end
+      elsif response.is_a?(Hash)
+        @body = Hashie::Rash.new(response)
+      else
+        @body = response
+      end
+    end
+    
+  end
+end

data/lib/factual/resolve.rb

@@ -0,0 +1,16 @@
+module Factual
+  class Resolve
+    
+    attr_accessor :client
+    
+    def initialize(client)
+      @client = client
+    end
+    
+    def search_by_values(params)
+      values = params.to_json
+      PlacesResponse.new(@client.class.get('/places/resolve', :query => {:values => values}))
+    end
+      
+  end
+end

data/lib/factual/version.rb

@@ -0,0 +1,3 @@
+module Factual
+  VERSION = "0.1"
+end

data/lib/factual.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'httparty'
+require 'hashie'
+require 'rash'
+
+require 'factual/categories'
+require 'factual/categories_response'
+require 'factual/client'
+require 'factual/core'
+require 'factual/core_response'
+require 'factual/crossref'
+require 'factual/crosswalk'
+require 'factual/places'
+require 'factual/places_response'
+require 'factual/resolve'
+require "factual/version"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: factual
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: 
+- Justin Copeland
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rash
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Factual v3 API wrapper
+email: 
+- justin@gootnau.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- README
+- Rakefile
+- factual.gemspec
+- lib/.DS_Store
+- lib/factual.rb
+- lib/factual/categories.rb
+- lib/factual/categories_response.rb
+- lib/factual/client.rb
+- lib/factual/core.rb
+- lib/factual/core_response.rb
+- lib/factual/crossref.rb
+- lib/factual/crosswalk.rb
+- lib/factual/places.rb
+- lib/factual/places_response.rb
+- lib/factual/resolve.rb
+- lib/factual/version.rb
+homepage: http://github.com/jmcopeland/factual
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: factual
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Factual v3 API wrapper
+test_files: []
+