collecta_ruby 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+lib/quick_test.rb
+pkg/*

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Jim Myhrberg.
+
+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
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,66 @@
+# Collecta Ruby Library
+
+## Overview
+
+A quick and rough Ruby/Rails library to query info from the [Collecta][1] API. Check their [documentation][2] for more info.
+
+[1]: http://collecta.com/
+[2]: http://developer.collecta.com/
+
+## Setup
+
+### Ruby on Rails Plugin
+
+    script/plugin install git://github.com/jimeh/collecta_ruby.git
+
+And edit `config/collecta.yml` to supply your Collecta API key(s) for the each environment.
+
+### Plain Ruby
+
+Supply your API to the Collecta class:
+
+    Collecta.set_key = "APIKEY"
+
+## Usage
+
+Search for iPhone:
+
+    Collecta.search("iPhone")
+
+Search with additional options/parameters:
+
+    Collecta.search("iPhone", :format => "json", :page => 2, :category => ["technology", "games"], :exclude => ["politics"])
+
+Available parameter options are `:rpp`, `:page`, `:since_id`, `:format`, `:callback`, `:category`, and `:exclude`. The `:exclude` parameter simply excludes results from specified categories.
+
+## Notes / Planned Features
+
+* Response data from Collecta is currently returned in it's raw JSON or Atom form. Parsing the JSON responses to a Hash fails cause it's more than 20 levels deep. And parsing the Atom data fails for some reason cause XPath doesn't like Atom, and I'm no XML expert. If you know better than me, please fork, fix, and pull request :)
+
+* If you have any suggestions, comments, or complaints, please don't hesitate to contact me.
+
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2009 Jim Myhrberg.
+
+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
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "collecta_ruby"
+    gemspec.summary = "Ruby library to query the Collecta.com API."
+    gemspec.description = "A quick and rough Ruby/Rails library to query info from the Collecta API."
+    gemspec.email = "contact@jimeh.me"
+    gemspec.homepage = "http://github.com/jimeh/collecta_ruby"
+    gemspec.authors = ["Jim Myhrberg"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the collecta_ruby plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the collecta_ruby plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CollectaRuby'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/collecta_ruby.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{collecta_ruby}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jim Myhrberg"]
+  s.date = %q{2009-10-13}
+  s.description = %q{A quick and rough Ruby/Rails library to query info from the Collecta API.}
+  s.email = %q{contact@jimeh.me}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "collecta_ruby.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/collecta.rb",
+     "tasks/collecta_ruby_tasks.rake",
+     "templates/config/collecta.yml",
+     "test/collecta_ruby_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/jimeh/collecta_ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby library to query the Collecta.com API.}
+  s.test_files = [
+    "test/collecta_ruby_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,11 @@
+
+if defined? Rails
+  require 'collecta'
+  config_file = File.join(RAILS_ROOT, "config", "collecta.yml")
+  if File.exist?(config_file)
+    config = YAML.load_file(config_file)
+    if !config[RAILS_ENV.to_s].nil? && !config[RAILS_ENV.to_s]["api_key"].nil?
+      Collecta.api_key = config[RAILS_ENV.to_s]["api_key"]
+    end
+  end
+end

data/install.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "fileutils"
+
+dir = File.dirname(__FILE__)
+templates = File.join(dir, "templates")
+files = [
+  File.join("config", "collecta.yml")
+]
+
+files.each do |file|
+  FileUtils.cp File.join(templates, file), File.join(RAILS_ROOT, file) unless File.exist?(File.join(RAILS_ROOT, file))
+end

data/lib/collecta.rb

@@ -0,0 +1,74 @@
+require "rubygems"
+require "net/http"
+require "uri"
+require "cgi"
+require "json"
+require "xml"
+
+
+class Collecta
+  
+  @@api_key = nil
+  @@api_url = "http://api.collecta.com/search"
+  
+  def self.api_key
+    @@api_key
+  end
+  
+  def self.api_key=(key)
+    @@api_key = key
+  end
+  
+  def self.search(q = nil, params = {})
+    if !q.nil? && q != ""
+      params[:q] = q
+      return self.request(params)
+    end
+    return false
+  end
+  
+  def self.request(options = {})
+    params = {}
+    params[:api_key] = @@api_key if options[:api_key].nil?
+    params[:format]  = (!options[:format].nil?) ? options[:format] : "atom"
+    valid_params = [:q, :rpp, :page, :since_id, :callback, :category, :exclude]
+    valid_params.each do |param|
+      params[param] = options[param] if !options[param].nil?
+    end
+    request_url = self.build_url(params.clone)
+    if request_url
+      return Net::HTTP.get(URI.parse(request_url))
+    end
+    return false
+  end
+  
+  def self.build_url(params)
+    if !params[:q].nil? && !params[:api_key].nil?
+      # show specific categories
+      if params[:category].is_a?(Array) && params[:category].size > 0
+        params[:q] << params[:category].map { |item| " category:#{item}"}.join(" OR")
+      elsif params[:category].is_a?(String)
+        params[:q] << params[:category] && params[:category] != ""
+      end
+      params.delete(:category)
+      # exclude specific categories
+      if params[:exclude].is_a?(Array) && params[:exclude].size > 0
+        params[:q] << params[:exclude].map { |item| " -category:#{item}"}.join(" OR")
+      elsif params[:exclude].is_a?(String)
+        params[:q] << params[:exclude] && params[:exclude] != ""
+      end
+      params.delete(:exclude)
+      return @@api_url + self.build_query(params)
+    end
+    return false
+  end
+  
+  def self.build_query(params, first = true)
+    query = (first) ? "?" : ""
+    params[:format] = "json" if params[:format] == "hash"
+    return query << params.map { |name, value| "#{name}=" + CGI::escape(value).gsub("+", "%20") }.join("&")
+  end
+  
+end
+
+

data/tasks/collecta_ruby_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :collecta_ruby do
+#   # Task goes here
+# end

data/templates/config/collecta.yml

@@ -0,0 +1,8 @@
+development:
+  api_key: 
+
+test:
+  api_key: 
+
+production:
+  api_key: 

data/test/collecta_ruby_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class CollectaRubyTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: collecta_ruby
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jim Myhrberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-13 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: A quick and rough Ruby/Rails library to query info from the Collecta API.
+email: contact@jimeh.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- collecta_ruby.gemspec
+- init.rb
+- install.rb
+- lib/collecta.rb
+- tasks/collecta_ruby_tasks.rake
+- templates/config/collecta.yml
+- test/collecta_ruby_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/jimeh/collecta_ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby library to query the Collecta.com API.
+test_files: 
+- test/collecta_ruby_test.rb
+- test/test_helper.rb