acts_as_cleo 0.0.1 → 0.0.2

data/Gemfile

@@ -1,4 +1,21 @@
-source 'https://rubygems.org'
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
 
-# Specify your gem's dependencies in acts_as_cleo.gemspec
-gemspec
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+  gem 'ruby-debug19', :require => 'ruby-debug'
+  gem 'fixtures'
+  gem 'sqlite3'
+end
+
+
+gem 'happymapper'
+gem 'rails', '>= 3.1.0'

data/{LICENSE → LICENSE.txt}

@@ -1,7 +1,5 @@
 Copyright (c) 2012 Robert R. Meyer
 
-MIT License
-
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
@@ -19,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,24 @@
+= acts_as_cleo
+
+Acts As Cleo is a Rails gem that allows for easy integration with Linked In's Open Source type ahead manager. 
+
+Verify that you have downloaded and installed cleo locally.
+
+== Contributing to acts_as_cleo
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== To test
+* rake start:cleo
+* rake
+
+== Copyright
+
+Copyright (c) 2012 Robert R. Meyer. See LICENSE.txt for
+further details.

data/Rakefile

@@ -1,2 +1,54 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "acts_as_cleo"
+  gem.homepage = "http://github.com/blue-dog-archolite/acts_as_cleo"
+  gem.license = "MIT"
+  gem.summary = %Q{A Rails enabled Cleo API}
+  gem.description = %Q{LinkedIn Open Source type ahead tool's REST API as a ruby gem}
+  gem.email = "Blue.Dog.Archolite@gmail.com"
+  gem.authors = ["Robert R. Meyer"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+#require 'rcov/rcovtask'
+#Rcov::RcovTask.new do |test|
+#  test.libs << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#  test.rcov_opts << '--exclude "gems/*"'
+#end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_cleo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/acts_as_cleo.gemspec

@@ -1,17 +1,111 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/acts_as_cleo/version', __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Robert R. Meyer"]
-  gem.email         = ["Blue.Dog.Archolite@gmail.com"]
-  gem.description   = %q{A Cleo Inegration Gem}
-  gem.summary       = %q{A Rails interface for the Cleo REST API}
-  gem.homepage      = ""
+Gem::Specification.new do |s|
+  s.name = "acts_as_cleo"
+  s.version = "0.0.2"
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "acts_as_cleo"
-  gem.require_paths = ["lib"]
-  gem.version       = ActsAsCleo::VERSION
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robert R. Meyer"]
+  s.date = "2012-03-21"
+  s.description = "LinkedIn Open Source type ahead tool's REST API as a ruby gem"
+  s.email = "Blue.Dog.Archolite@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acts_as_cleo.gemspec",
+    "config/cleo.yml",
+    "lib/acts_as_cleo.rb",
+    "lib/acts_as_cleo/result.rb",
+    "lib/acts_as_cleo/version.rb",
+    "lib/acts_methods.rb",
+    "lib/class_methods.rb",
+    "lib/cleo.rb",
+    "lib/cleo/reference.rb",
+    "lib/cleo/result.rb",
+    "lib/cleo/server.rb",
+    "lib/common_methods.rb",
+    "lib/instance_methods.rb",
+    "test/config/cleo.yml",
+    "test/data/xml/cleo/element.xml",
+    "test/data/xml/cleo/elements.xml",
+    "test/data/xml/cleo/testing_element.xml",
+    "test/db/connection/sqlite.rb",
+    "test/db/migrate/001_create_books.rb",
+    "test/db/migrate/002_create_movies.rb",
+    "test/db/migrate/003_create_categories.rb",
+    "test/db/migrate/004_create_electronics.rb",
+    "test/db/migrate/005_create_authors.rb",
+    "test/db/migrate/006_create_postings.rb",
+    "test/db/test.db",
+    "test/fixtures/authors.yml",
+    "test/fixtures/books.yml",
+    "test/fixtures/categories.yml",
+    "test/fixtures/electronics.yml",
+    "test/fixtures/movies.yml",
+    "test/helper.rb",
+    "test/models/author.rb",
+    "test/models/book.rb",
+    "test/models/category.rb",
+    "test/models/electronic.rb",
+    "test/models/movie.rb",
+    "test/test_acts_as_cleo.rb",
+    "test/unit/test_acts_methods.rb",
+    "test/unit/test_cleo.rb",
+    "test/unit/test_result_parser.rb"
+  ]
+  s.homepage = "http://github.com/blue-dog-archolite/acts_as_cleo"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "A Rails enabled Cleo API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<happymapper>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.1.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<fixtures>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<happymapper>, [">= 0"])
+      s.add_dependency(%q<rails>, [">= 3.1.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<fixtures>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<happymapper>, [">= 0"])
+    s.add_dependency(%q<rails>, [">= 3.1.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<fixtures>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
 end
+

data/config/cleo.yml

@@ -0,0 +1,10 @@
+# Config file for the acts_as_solr plugin.
+#
+# If you change the host or port number here, make sure you update
+# them in your Solr config file
+
+development:
+  url: "http://localhost:8080/cleo-primer/"
+
+production:
+  url: "http://localhost:8080/cleo-primer/"

data/lib/acts_as_cleo.rb

@@ -1,111 +1,23 @@
-module Cleo::ActsAsCleo
-  extend ActiveSupport::Concern
+#load Cleo Module for result and server
+require File.dirname(__FILE__) + '/cleo'
 
-  ## Anything in here is done to all models
-  # def self.included(base)
-  #     base.before_create :set_cleo_id
-  #     base.after_commit :sync_with_cleo
-  #     base.after_destroy :remove_from_cleo
-  #
-  # end
+#Load ActsAsCleo method load
+require File.dirname(__FILE__) + '/acts_methods'
+require File.dirname(__FILE__) + '/class_methods'
+require File.dirname(__FILE__) + '/instance_methods'
+require File.dirname(__FILE__) + '/common_methods'
 
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
-
-  module ClassMethods
-    def acts_as_cleo(opts = {})
-      class_eval <<-EOV
-        include Cleo::ActsAsCleo::InstanceMethods
-        before_create :set_cleo_id
-        after_commit :sync_with_cleo
-        after_destroy :remove_from_cleo
-
-        cattr_accessor :cleo_config
-
-        #set type to query against in Cleo
-        #defaults to class name
-        #ie "User" when acts_as_cleo is included in user.b
-        self.cleo_config = {}
-        self.cleo_config[:type] = opts[:type] || self.ancestors.first.name
-
-        self.cleo_config[:name] = opts[:name]
-
-        #specify what columns to add as part of the xml object
-        #defaults to all columns in database
-        self.cleo_config[:terms] = opts[:terms] || self.column_names
-        self.cleo_config[:terms] = self.cleo_config[:terms] - opts[:except] unless opts[:except].blank?
-
-        #figure out what the score param is. execute the self.send(#{opts[:score].to_s}.count)
-        self.cleo_config[:score] = opts[:score]
-
-        def query(query, opts = {})
-          Cleo.query(query)
-        end
-
-        def cleo_id
-          record_type = self.cleo_config[:type]
-          return nil unless self.id
-        end
-
-        def cleo_id= ( new_id)
-        end
-
-      EOV
-
-    end
-  end
-
-
-  module InstanceMethods
-    # callback hooks to keep cleo insync with data
-    def sync_with_cleo
-      return if self.is_a?(Moderation)
-      return if self.is_a?(Audit)
-
-      if self.persisted?
-        Cleo.update(self)
-      else
-        Cleo.create(self)
-      end
-      #after_update send the data to cleo
-    end
-
-    def set_cleo_id
-      self.cleo_id = Time.now.to_i unless self.is_a?(Moderation) || self.is_a?(Audit)
-    end
-
-    def remove_from_cleo
-      return if self.is_a?(Moderation)
-      return if self.is_a?(Audit)
-      Cleo.delete(self) if self.persisted?
-    end
-    #end callback hooks
-
-    def to_cleo_result
-      #take self and change it into a Cleo::Result and return
-      cr = Cleo::Result.new
-      cr.term = []
-
-      self.cleo_config[:terms].each do |term|
-        cr.term << self.send(term).to_s
-      end
-
-      cr.term = cr.term.compact.reject(&:blank?)
-      self.cleo_id ||= Time.now.to_i
-      cr.id = self.cleo_id || Time.now.to_i
-
-      cr.name = self.send(self.cleo_config[:name]).to_s
-      cr.name = cr.term.first if cr.name.blank?
+module ActsAsCleo
+  include ActsMethods
+end
 
-      score = self.send(self.cleo_config[:score])
-      cr.score = score.nil? ? 0 : score.count
+ActiveRecord::Base.extend ActsAsCleo
 
-      cr
-    end
+root_path = Rails.root.nil? ? "#{File.dirname(File.expand_path(__FILE__))}/../"  : Rails.root
+cleo_file_path = File.join( root_path, 'config', 'cleo.yml' )
 
-    alias :as_cleo :to_cleo_result
-  end
+if File.exists?( cleo_file_path )
+  Cleo::Server.server_locations = YAML::load_file( cleo_file_path )[Rails.env].symbolize_keys
+else
+  raise LoadError.new("No cleo.yml found. Please viery that you have a copy of cleo.yml in your config directory.")
 end
-
-ActiveRecord::Base.send :include, Cleo::ActsAsCleo

data/lib/acts_methods.rb

@@ -0,0 +1,34 @@
+module ActsAsCleo
+  module ActsMethods
+    def acts_as_cleo(opts = {})
+      extend ClassMethods
+      include InstanceMethods
+      include CommonMethods
+
+      before_create :set_cleo_id
+      after_commit :sync_with_cleo
+      after_destroy :remove_from_cleo
+
+      cattr_accessor :cleo_config
+
+      #set type to query against in Cleo
+      #defaults to class name
+      #ie "User" when acts_as_cleo is included in user.b
+      self.cleo_config = {}
+      opts[:except] ||= []
+      opts[:except] += %w{id created_at updated_at}
+      self.cleo_config[:type] = opts[:type] || self.ancestors.first.name
+
+      self.cleo_config[:name] = opts[:name].blank? ? "name" : opts[:name]
+
+      #specify what columns to add as part of the xml object
+      #defaults to all columns in database
+      self.cleo_config[:terms] = opts[:terms] || self.column_names
+      self.cleo_config[:terms] = self.cleo_config[:terms] - opts[:except]
+
+      #figure out what the score param is. execute the self.send(#{opts[:score].to_s}.count)
+      opts[:score] ||= "id"
+      self.cleo_config[:score] = opts[:score]
+    end
+  end
+end

data/lib/class_methods.rb

@@ -0,0 +1,4 @@
+module ActsAsCleo
+  module ClassMethods
+  end
+end

data/lib/cleo/reference.rb

@@ -0,0 +1,5 @@
+module Cleo
+  class Reference < ActiveRecord::Base
+
+  end
+end

data/lib/cleo/result.rb

@@ -0,0 +1,18 @@
+require 'happymapper'
+
+module Cleo
+  class Result
+    include HappyMapper
+    tag 'element'
+
+    has_many :term, String, :tag => 'term'
+    element :id, Integer
+    element :name, String
+    element :score, Float
+    element :timestamp, Time
+    element :title, String
+    element :url, String
+
+    alias :terms :term
+  end
+end

data/lib/cleo/server.rb

@@ -0,0 +1,16 @@
+module Cleo
+  class Server
+    @@server_location = {:url => 'http://cleo.testingserver.com/cleo-primer/' }
+
+    def self.server_locations=(new_locations)
+      parts = new_locations[:url].split("/")
+      parts -=  %w{rest elements}
+      parts +=  %w{rest elements}
+      @@server_location[:url] = parts.join('/') + '/'
+    end
+
+    def self.url
+      @@server_location[:url]
+    end
+  end
+end

data/lib/cleo.rb

@@ -0,0 +1,95 @@
+module Cleo
+  @@net_http = nil
+
+  def self.net_http
+    @@net_http unless @@net_http.blank?
+    uri = URI.parse(Cleo::Server.url)
+
+    @@net_http = Net::HTTP.new(uri.host, uri.port)
+  end
+
+  def self.get(uri)
+    response = net_http.request(Net::HTTP::Get.new(uri.request_uri))
+
+    return response if good_response_code?(response)
+  end
+
+  def self.find(id)
+    #query by element/id to get from cleo fast
+    uri = URI.parse(Cleo::Server.url + "#{id}")
+    response = self.get(uri)
+
+    Cleo::Result.parse(response.body, :single => true)
+  end
+
+  def self.query(query_param)
+    uri = URI.parse(Cleo::Server.url + "search?query=#{CGI::escape query_param}")
+    response = self.get(uri)
+
+    Cleo::Result.parse(response.body, :single => false)
+  end
+
+
+  def self.update(obj)
+    obj = obj.to_cleo_result unless obj.is_a?(Cleo::Result)
+
+    uri = URI.parse Cleo::Server.url + "#{obj.id}"
+    request = Net::HTTP::Put.new(uri.path)
+
+    request.content_type = 'application/xml'
+    request.body = obj.to_xml
+    response = Net::HTTP.new(uri.host, uri.port).start { |http| http.request request }
+
+    return good_response_code?(response)
+  end
+
+  def self.delete(obj)
+    obj = obj.to_cleo_result unless obj.is_a?(Cleo::Result)
+
+    result = `curl -v -X DELETE #{Cleo::Server.url}#{obj.id}`
+
+    #TODO I HATE THIS. Make this use Rails and not a fracking curl call
+#    uri = URI.parse Cleo::Server.url + "/#{obj.id}"
+#    request = Net::HTTP::Delete.new(uri.path)
+#    response = Net::HTTP.new(uri.host, uri.port).start { |http| http.request request }
+
+
+#    uri = URI.parse Cleo::Server.url  + "#{obj.id}"
+
+#    request = Net::HTTP::Delete.new("#{obj.id}")
+#    request.content_type = 'application/xml'
+#    response = Net::HTTP.new(uri.host, 8080).start { |http| http.request request }
+#    http = Net::HTTP.new(Cleo::Server.url)
+#    response = http.request(request)
+
+#    return good_response_code?(response)
+  end
+
+  def self.create(obj)
+    obj = obj.to_cleo_result unless obj.is_a?(Cleo::Result)
+
+    uri = URI.parse Cleo::Server.url + "_"
+    request = Net::HTTP::Post.new(uri.path)
+
+    request.body = obj.to_xml
+    request.content_type = 'application/xml'
+
+    response = Net::HTTP.new(uri.host, uri.port).start { |http| http.request request }
+
+    return good_response_code?(response)
+  end
+
+  private
+  def self.good_response_code?(response)
+    case response
+    when Net::HTTPOK
+      true   # success response
+    when Net::HTTPClientError, Net::HTTPInternalServerError
+      false  # non-success response
+    end
+  end
+end
+
+#require Result Class
+require 'cleo/server'
+require 'cleo/result'

data/lib/common_methods.rb

@@ -0,0 +1,17 @@
+module ActsAsCleo
+  module CommonMethods
+    def query(query, opts = {})
+      Cleo.query(query)
+    end
+
+    def cleo_id
+      record_type = self.cleo_config[:type]
+      cr = Cleo::Reference.find_by_reference_and_id(record_type, self.id)
+      return cr.nil? ? nil : cr.id
+    end
+
+    def cleo_id=( new_id)
+      #this needs to be rerolled to pull an Cleo::Reference record and persist it.
+    end
+  end
+end

data/lib/instance_methods.rb

@@ -0,0 +1,45 @@
+module ActsAsCleo
+  module InstanceMethods
+    # callback hooks to keep cleo insync with data
+    def sync_with_cleo
+      if self.persisted?
+        Cleo.update(self)
+      else
+        Cleo.create(self)
+      end
+      #after_update send the data to cleo
+    end
+
+    def set_cleo_id
+      #this needs to be rerolled to pull an Cleo::Reference record and persist it.
+    end
+
+    def remove_from_cleo
+      Cleo.delete(self) if self.persisted?
+    end
+    #end callback hooks
+
+    def to_cleo_result
+      #take self and change it into a Cleo::Result and return
+      cr = Cleo::Result.new
+      cr.term = []
+
+      self.cleo_config[:terms].each do |term|
+        cr.term << self.send(term).to_s
+      end
+
+      cr.term = cr.term.compact.reject(&:blank?)
+      cr.id = self.cleo_id
+
+      cr.name = self.send(self.cleo_config[:name]).to_s
+      cr.name = cr.term.first if cr.name.blank?
+
+      score = self.send(self.cleo_config[:score])
+      cr.score = score.nil? ? 0 : score.count
+
+      cr
+    end
+
+    alias :as_cleo :to_cleo_result
+  end
+end

data/test/config/cleo.yml

@@ -0,0 +1,2 @@
+test:
+  url: http://localhost:8080/cleo-primer

data/test/data/xml/cleo/element.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<element>
+  <term>rob</term>
+  <term>inc.</term>
+  <term>goog</term>
+  <id>99999</id>
+  <name>Cleo Inc.</name>
+  <score>159350.0</score>
+  <title>Technology - Computer Software: Programming Data Processing</title>
+  <url>http://www.nasdaq.com/symbol/goog</url>
+</element>