overlord 0.1.4 → 0.1.5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Tatemae
+Copyright (c) 2009 Tatemae.com
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,13 +1,18 @@
 = overlord
 
 Talk to the Google ajax apis and render the results.  This gem contains several method calls and partials to call 
-out to the Google Ajax Apis (http://code.google.com/apis/ajax/).
+out to the Google Ajax Apis (http://code.google.com/apis/ajax/).  This gem is designed to work in Ruby on Rails and
+currently won't work outside that framework.
 
 == Usage
 
+=== Installation
+Installing the gem should install the dependencies
+  sudo gem install overlord
+
 === Settings
 This gem requires some configuration before it will work in your Rails application:
-You will need a global_config file with 'google_ajax_api_key' defined.  You can set it up thus:
+You will need a global_config file with 'google_ajax_api_key' and 'google_ajax_referer' defined.  You can set it up thus:
 
   # Load a global constant so the initializers can use them
   require 'ostruct'
@@ -32,7 +37,8 @@ Then in global_config.yml:
     session_secret: 882585c5d472d21e832965410ab233be541ea626e50ed0eb68a00a2f49b59073480e58599404e3dc62105a803ee42d67872e3f95eb48e2d6508b42038436abd6
 
     # Google related
-    google_ajax_api_key:
+    google_ajax_api_key:            # Google ajax api key
+    google_ajax_referer:            # Website making the request.  Required by Google.
     show_google_search: true        # Determines whether or not a google search is displayed on the topic page
     load_feeds_on_server: false     # Determines whether feeds on a topic page are loaded on the server or the client.  Loading on the server can take a while
     combine_feeds_on_server: false  # Combines feeds loaded on the server
@@ -113,4 +119,4 @@ inside of the test directory for more information on how to create these classes
                          
 == Copyright
 
-Copyright (c) 2009 Tatemae. See LICENSE for details.
+Copyright (c) 2009 Tatemae.com. See LICENSE for details.

data/Rakefile

@@ -12,7 +12,8 @@ begin
     gem.email = "justin@tatemae.com"
     gem.homepage = "http://github.com/jbasdf/overlord"
     gem.authors = ["Justin Ball", "Joel Duffin"]
-    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_dependency "httparty"
+    gem.add_development_dependency "shoulda"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/lib/overlord.rb

@@ -1,4 +1,7 @@
-require 'httparty'
+require 'json'
+require 'open-uri'
+require 'overlord/google_base'
+require 'overlord/google_search_request'
 require 'overlord/google_feed_request'
 
 I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', 'locales', '*.{rb,yml}') ]

data/lib/overlord/google_base.rb

@@ -0,0 +1,43 @@
+module Overlord
+
+  class GoogleBase
+  
+    # api_key_id:   Valid Google access key (optional)
+    def self.api_key_id=(val)
+      @api_key_id = val
+    end
+    
+    def self.api_key_id
+      @api_key_id
+    end
+    
+    # referer:      Url of the website making request.  Required by Google.
+    def self.referer=(val)
+      @referer = val
+    end
+
+    def self.referer
+      @referer
+    end
+    
+    # Add standard items to the google query
+    def self.build_google_query(query_options)
+      key = self.api_key_id || GlobalConfig.google_ajax_api_key rescue ''
+      query_options[:v] = '1.0'
+      query_options[:key] = key if key
+      query_options
+    end
+  
+    def self.get(uri, options)
+      header_params = { "UserAgent" => "Ruby/#{RUBY_VERSION}" }
+      ref = self.referer || GlobalConfig.google_ajax_referer rescue nil
+      header_params["Referer"] = ref if ref
+      # to_params comes from the httparty gem
+      buffer = open("#{uri}?#{options[:query].to_params}", header_params).read
+      JSON.parse(buffer)
+    end
+    
+  end
+  
+  
+end

data/lib/overlord/google_feed_request.rb

@@ -5,17 +5,8 @@ module Overlord
   # Google code playground:
   # http://code.google.com/apis/ajax/playground/?exp=search#load_feed
   #
-  class GoogleFeedRequest
-    include HTTParty
-    format :json
-  
-    # Initialize Google Request.
-    # Parameters:
-    # api_key_id:     Valid Google access key (optional)
-    def initialize(api_key_id = nil)
-      @api_key_id = api_key_id
-    end
-  
+  class GoogleFeedRequest < GoogleBase
+
     # Lookup a given feed.  
     def self.lookup_feed(uri)
       get('http://ajax.googleapis.com/ajax/services/feed/lookup', :query => build_google_query({:q => uri}))
@@ -104,13 +95,6 @@ module Overlord
                   :service_id => Service.find_service_by_uri(google_feed['link']).id)
       end
     end
-
-    # Add standard items to the google query
-    def self.build_google_query(query_options)
-      query_options[:v] = '1.0'
-      query_options[:key] = GlobalConfig.google_ajax_api_key if GlobalConfig.google_ajax_api_key
-      query_options
-    end
-  
+    
   end
 end

data/lib/overlord/google_search_request.rb

@@ -5,16 +5,7 @@ module Overlord
   # Google code playground:
   # http://code.google.com/apis/ajax/playground
   #
-  class GoogleSearchRequest
-    include HTTParty
-    format :json
-  
-    # Initialize Google Request.
-    # Parameters:
-    # api_key_id:     Valid Google access key (optional)
-    def initialize(api_key_id = nil)
-      @api_key_id = api_key_id
-    end
+  class GoogleSearchRequest < GoogleBase
   
     # Run a local search
     # Google docs:
@@ -73,13 +64,6 @@ module Overlord
         end
       end
     end
-    
-    # Add standard items to the google query
-    def self.build_google_query(query_options)
-      query_options[:v] = '1.0'
-      query_options[:key] = GlobalConfig.google_ajax_api_key if GlobalConfig.google_ajax_api_key
-      query_options
-    end
   
   end
 end

data/overlord.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{overlord}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Ball", "Joel Duffin"]
-  s.date = %q{2009-12-04}
+  s.date = %q{2009-12-08}
   s.description = %q{Code to interact with the google ajax apis on the server and the client.}
   s.email = %q{justin@tatemae.com}
   s.extra_rdoc_files = [
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
      "app/views/google/_search.html.erb",
      "app/views/google/_slide_show.html.erb",
      "lib/overlord.rb",
+     "lib/overlord/google_base.rb",
      "lib/overlord/google_feed_request.rb",
      "lib/overlord/google_search_request.rb",
      "locales/ar.yml",
@@ -680,11 +681,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end
+

data/test/rails_root/config/environment.rb

@@ -15,5 +15,6 @@ end
 
 Rails::Initializer.run do |config|
   config.time_zone = 'UTC'
+  config.gem "httparty"
   config.plugin_locators << TestGemLocator
 end

data/test/rails_root/config/global_config.yml

@@ -14,7 +14,8 @@ default: &DEFAULT
   session_secret: 882585c5d472d21e832965410ab233be541ea626e50ed0eb68a00a2f49b59073480e58599404e3dc62105a803ee42d67872e3f95eb48e2d6508b42038436abd6
 
   # Google related
-  google_ajax_api_key:
+  google_ajax_api_key:            # A google ajax api key - http://code.google.com/apis/ajaxsearch/signup.html
+  google_ajax_referer:            # The url of the site making the request.
   show_google_search: true        # Determines whether or not a google search is displayed on the topic page
   load_feeds_on_server: false     # Determines whether feeds on a topic page are loaded on the server or the client.  Loading on the server can take a while
   combine_feeds_on_server: false  # Combines feeds loaded on the server

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: overlord
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Justin Ball
@@ -10,11 +10,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-04 00:00:00 -07:00
+date: 2009-12-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -50,6 +60,7 @@ files:
 - app/views/google/_search.html.erb
 - app/views/google/_slide_show.html.erb
 - lib/overlord.rb
+- lib/overlord/google_base.rb
 - lib/overlord/google_feed_request.rb
 - lib/overlord/google_search_request.rb
 - locales/ar.yml