yarel 0.0.1

data/lib/yarel.rb

@@ -0,0 +1,26 @@
+require 'active_support'
+require 'active_model'
+require 'net/http'
+require 'cgi'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/class/attribute_accessors'
+
+module Yarel
+  extend ActiveSupport::Autoload
+  eager_autoload do
+    autoload :Table
+    autoload :Connection
+    # autoload :Base
+  end
+  
+  def Yarel.const_missing(const_name)
+    yql_table_name = const_name.to_s.underscore.gsub("_", ".")
+    const_set const_name, Table.new(yql_table_name)
+  end  
+end
+require 'yarel/extensions/object_extensions'
+
+Logger = ActiveSupport::BufferedLogger.new(File.open('yarel.log', 'w+')) unless Module.const_defined?("Logger")

data/lib/yarel/base.rb

@@ -0,0 +1,36 @@
+module Yarel
+  class Exception < StandardError
+  end
+  
+  module Base
+    attr_accessor :count
+    
+    module ClassMethods
+      def all
+        response = Connection.get(table.to_yql)
+        raise Exception.new(response["error"]["description"]) if response["error"]
+        [response["query"]["results"].first[1]].flatten
+      end
+      
+      [:sort, :order, :limit, :where, :from, :project, :select].each do |chainable_method|
+        class_eval <<-RUBY_EVAL, __FILE__, __LINE__
+        def #{chainable_method}(*args)
+          self.table = self.table.send(:#{chainable_method}, *args)
+          self
+        end
+        RUBY_EVAL
+      end
+    end
+    
+    def self.included(klass)
+      klass.cattr_accessor :table
+      klass.table = Table.new(klass.name.underscore.gsub("/", "."), klass)
+      klass.instance_eval do
+        class << self
+          delegate :to_yql, :to => :table
+        end
+      end
+      klass.extend ClassMethods
+    end
+  end
+end

data/lib/yarel/connection.rb

@@ -0,0 +1,10 @@
+module Yarel
+  class Connection
+    END_POINT_URL = 'http://query.yahooapis.com/v1/public/yql'
+
+    def self.get(yql)
+      response = Net::HTTP.post_form(URI.parse(END_POINT_URL), { :q => yql, :format => :json })
+      ActiveSupport::JSON.decode response.body
+    end
+  end
+end

data/lib/yarel/extensions/object_extensions.rb

@@ -0,0 +1,7 @@
+module ObjectExtensions
+  def deep_clone
+    Marshal.load( Marshal.dump(self))
+  end
+end
+
+Object.send :include, ObjectExtensions

data/lib/yarel/table.rb

@@ -0,0 +1,82 @@
+module Yarel
+  class Exception < StandardError
+  end
+  
+  class Table
+    attr_accessor :table_name, :projections, :conditions, :limit_to, :offset, :sort_columns
+    
+    def initialize(table_name)
+      @table_name = table_name
+      @projections = "*"
+      @conditions = []
+      @limit_to = @offset = :default
+    end
+    
+    def all
+      yql = to_yql
+      Logger.info "Generated YQL: #{yql.inspect}\n"
+      response = Connection.get(yql)
+      raise Exception.new(response["error"]["description"]) if response["error"]
+      response["query"]["results"] ? [response["query"]["results"].first[1]].flatten : []
+    end    
+
+    def from(table_name)
+      modify_clone { self.table_name = table_name }
+    end
+
+    def project(*field_names)
+      modify_clone { self.projections = field_names.join(", ") }
+    end
+
+    alias_method :select, :project
+
+    def where(condition)
+      new_condition =
+      case
+      when condition.kind_of?(Hash)
+        condition.map do |key, value|
+          condition_string = value.kind_of?(self.class) ? "#{key} in ( #{value.to_yql} )" : "#{key} = '#{value}'"
+        end
+      when condition.kind_of?(String)
+        condition
+      when condition.kind_of?(Array)
+        send :sprintf, condition[0].gsub("?", "'%s'"), *condition[1..-1]
+      end
+
+      modify_clone { self.conditions << new_condition }
+    end
+
+    def limit(*options)
+      lim = options[0]
+      off, lim = options[0..1] unless options.size == 1
+      modify_clone {
+        self.limit_to = lim.to_i if lim
+        self.offset = off.to_i if off
+      }
+    end
+    
+    def sort(*columns)
+      modify_clone { self.sort_columns = columns.try(:join, ", ") }
+    end
+    
+    alias_method :order, :sort
+
+    def to_yql
+      yql = ["SELECT #{projections} FROM #{table_name}"]
+      yql << "WHERE #{conditions.join(' AND ')}" unless conditions.empty?
+      yql << "LIMIT #{limit_to}" if limit_to != :default
+      yql << "OFFSET #{offset}" if offset != :default
+      yql << "| sort(field='#{sort_columns}')" if sort_columns
+      yql.join " "
+    end
+    
+    alias_method :to_s, :to_yql
+
+    private
+    def modify_clone(&block)
+      cloned_obj = self.deep_clone
+      cloned_obj.instance_eval &block
+      cloned_obj
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.join File.dirname(__FILE__) + "/../lib"
+
+require 'rubygems'
+require 'spec'
+require 'yarel'

data/spec/yarel/base_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "Yarel::Base" do
+  LocalSearch = Yarel::Table.new("local.search")
+
+  it "should create an instance of table" do
+    LocalSearch.should be_kind_of Yarel::Table
+  end
+
+  describe "all" do
+    it "should raise exception back if response has errors" do
+      lambda {
+        LocalSearch.order('test').all
+      }.should raise_error(Yarel::Exception, "Cannot find required keys in where clause;   expecting required keys: (query, longitude, latitude)")
+    end
+
+    it "should take the result part alone" do
+      GeoPlaces = Yarel::Table.new("geo.places")
+      GeoPlaces.where(:text => "north beach, san francisco").all.should == [{"name"=>"North Beach", "woeid"=>"2460640", "uri"=>"http://where.yahooapis.com/v1/place/2460640", "boundingBox"=>{"northEast"=>{"latitude"=>"37.808270", "longitude"=>"-122.399467"}, "southWest"=>{"latitude"=>"37.795399", "longitude"=>"-122.418381"}}, "postal"=>{"type"=>"Zip Code", "content"=>"94133"}, "country"=>{"code"=>"US", "type"=>"Country", "content"=>"United States"}, "placeTypeName"=>{"code"=>"22", "content"=>"Suburb"}, "centroid"=>{"latitude"=>"37.805939", "longitude"=>"-122.411118"}, "areaRank"=>"1", "admin1"=>{"code"=>"US-CA", "type"=>"State", "content"=>"California"}, "popRank"=>"0", "locality1"=>{"type"=>"Town", "content"=>"San Francisco"}, "admin2"=>{"code"=>"", "type"=>"County", "content"=>"San Francisco"}, "lang"=>"en-US", "locality2"=>{"type"=>"Suburb", "content"=>"North Beach"}, "admin3"=>nil}]
+    end
+    
+    it "should return mulitple records" do
+      LocalNewSearch = Yarel::Table.new("local.search")
+      
+      LocalNewSearch.where(:zip => 94085, :query => 'pizza').limit(2).all.should == [
+        {"MapUrl"=>"http://maps.yahoo.com/maps_result?q1=1127+N+Lawrence+Expy+Sunnyvale+CA&gid1=21341983", "Distance"=>"1.28", "Longitude"=>"-121.996017", "City"=>"Sunnyvale", "Url"=>"http://local.yahoo.com/info-21341983-giovannis-pizzeria-sunnyvale", "Title"=>"Giovannis Pizzeria", "Latitude"=>"37.397058", "Phone"=>"(408) 734-4221", "id"=>"21341983", "Categories"=>{"Category"=>[{"id"=>"96926234", "content"=>"Carry Out & Take Out"}, {"id"=>"96926236", "content"=>"Restaurants"}, {"id"=>"96926243", "content"=>"Pizza"}]}, "BusinessUrl"=>"http://giovannisnypizza.com/", "ClickUrl"=>"http://local.yahoo.com/info-21341983-giovannis-pizzeria-sunnyvale", "Rating"=>{"TotalReviews"=>"44", "AverageRating"=>"4", "TotalRatings"=>"44", "LastReviewIntro"=>"this is one of the best pizzas i had..very tasty,crispy..value for the money spent..try it out once", "LastReviewDate"=>"1273837240"}, "Address"=>"1127 N Lawrence Expy", "State"=>"CA", "BusinessClickUrl"=>"http://giovannisnypizza.com/"},
+        {"MapUrl"=>"http://maps.yahoo.com/maps_result?q1=1155+Reed+Ave+Sunnyvale+CA&gid1=21332026", "Distance"=>"1.79", "Longitude"=>"-121.997904", "City"=>"Sunnyvale", "Url"=>"http://local.yahoo.com/info-21332026-vitos-famous-pizza-sunnyvale", "Title"=>"Vitos Famous Pizza", "Latitude"=>"37.367029", "Phone"=>"(408) 246-8800", "id"=>"21332026", "Categories"=>{"Category"=>[{"id"=>"96926190", "content"=>"Italian Restaurants"}, {"id"=>"96926234", "content"=>"Carry Out & Take Out"}, {"id"=>"96926236", "content"=>"Restaurants"}, {"id"=>"96926242", "content"=>"Fast Food"}, {"id"=>"96926243", "content"=>"Pizza"}]}, "BusinessUrl"=>"http://vitosfamouspizza.com/", "ClickUrl"=>"http://local.yahoo.com/info-21332026-vitos-famous-pizza-sunnyvale", "Rating"=>{"TotalReviews"=>"16", "AverageRating"=>"4.5", "TotalRatings"=>"16", "LastReviewIntro"=>"As an East Coaster, I am picky about my pizza, and this place is really a great find!", "LastReviewDate"=>"1247669752"}, "Address"=>"1155 Reed Ave", "State"=>"CA", "BusinessClickUrl"=>"http://vitosfamouspizza.com/"}
+      ]
+    end
+
+    it "should handle empty results" do
+      places = Yarel::Table.new("geo.places")
+      places.where(:text => "unkown place").all.should == []
+    end
+  end
+end

data/spec/yarel/yarel_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe "yarel" do
+  before(:each) do
+    @table_name = "answers.getbycategory"
+    @yarel_table = Yarel::Table.new(@table_name)
+  end
+
+  it "should be chainable" do
+    @yarel_table.from("answers.new_table").should be_kind_of(Yarel::Table)
+  end
+
+  describe "return the yql" do
+    it "should be constructed taking the table name" do
+      yarel_table = Yarel::Table.new("ns.table_name").to_yql.should == "SELECT * FROM ns.table_name"
+    end
+
+    it "for from" do
+      @yarel_table.from("answers.new_table").to_yql.should == "SELECT * FROM answers.new_table"
+    end
+
+    it "for the latest from" do
+      @yarel_table.from("answers.new_table").from("answers.new_new_table").to_yql.should == "SELECT * FROM answers.new_new_table"
+    end
+
+    it "for project" do
+      @yarel_table.project(:this_column).to_yql.should == "SELECT this_column FROM answers.getbycategory"
+      @yarel_table.project(:this_column, :that_column).to_yql.should == "SELECT this_column, that_column FROM answers.getbycategory"
+    end
+
+    it "for limit" do
+      @yarel_table.limit(10).to_yql.should == "SELECT * FROM answers.getbycategory LIMIT 10"
+    end
+
+    it "for limit should not mutate" do
+      q1 = @yarel_table.limit(10)
+      q2 = @yarel_table.limit(5)
+      q1.to_yql.should == "SELECT * FROM answers.getbycategory LIMIT 10"
+      q2.to_yql.should == "SELECT * FROM answers.getbycategory LIMIT 5"
+    end
+
+    it "for offset along with limit" do
+      @yarel_table.limit(10, 20).to_yql.should == "SELECT * FROM answers.getbycategory LIMIT 20 OFFSET 10"
+    end
+
+    describe "where" do
+      it "hash" do
+        @yarel_table.where(:this_column => 5).to_yql.should == "SELECT * FROM answers.getbycategory WHERE this_column = '5'"
+      end
+
+      it "string" do
+        @yarel_table.where("this_column = '5'").to_yql.should == "SELECT * FROM answers.getbycategory WHERE this_column = '5'"
+      end
+
+      it "array interpolation" do
+        @yarel_table.where(["this_column = ?", 'asd']).to_yql.should == "SELECT * FROM answers.getbycategory WHERE this_column = 'asd'"
+      end
+
+      it "should multiple interpolation" do
+        @yarel_table.where(["this_column = ? AND that_column = ?", 5, 10]).to_yql.should == "SELECT * FROM answers.getbycategory WHERE this_column = '5' AND that_column = '10'"
+      end
+
+      it "should be able to call multiple times" do
+        @yarel_table.where(["this_column = ?", 5]).project(:this_column).where(:that_column => 10).to_yql.should == "SELECT this_column FROM answers.getbycategory WHERE this_column = '5' AND that_column = '10'"
+      end
+
+      it "should not mutate the current object" do
+        @yarel_table.where(["this_column = ?", 5]).to_yql.should == "SELECT * FROM answers.getbycategory WHERE this_column = '5'"
+        @yarel_table.where(["this_column = ? AND that_column = ?", 5, 10]).to_yql.should == "SELECT * FROM answers.getbycategory WHERE this_column = '5' AND that_column = '10'"
+      end
+      
+      describe "where with sub queries" do
+        it "as a hash" do
+          @yarel_table.where(:this_column => Yarel::Table.new(:sub_table).project("sub_table_column")).to_yql.should ==
+            "SELECT * FROM answers.getbycategory WHERE this_column in ( SELECT sub_table_column FROM sub_table )"
+        end
+      end
+    end
+    
+    it "for sort" do
+      @yarel_table.sort('Rating.AverageRating').to_s.should == "SELECT * FROM answers.getbycategory | sort(field='Rating.AverageRating')"
+    end
+  end
+end
+
+
+describe "yarel module" do
+  it "should construct table object" do
+    Yarel::GeoLocation.should be_kind_of Yarel::Table
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: yarel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Selvakumar Natesan
+- Sharanya Sennimalai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-25 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Object-relational mapper for Yahoo Query Language - A Object Relation Mapper for YQL in ruby, very similar to ActiveRecord 3.0.0 with chainability and lazy evaluation of queries
+email: 
+- k.n.selvakumar@gmail.com
+- s.sharanya@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/yarel/base.rb
+- lib/yarel/connection.rb
+- lib/yarel/extensions/object_extensions.rb
+- lib/yarel/table.rb
+- lib/yarel.rb
+has_rdoc: true
+homepage: http://github.com/selvakn/yarel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Object-relational mapper for Yahoo Query Language
+test_files: 
+- spec/spec_helper.rb
+- spec/yarel/base_spec.rb
+- spec/yarel/yarel_spec.rb