rocky-klout 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-10-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,12 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+init.rb
+lib/rocky-klout.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_rocky-klout.rb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+ADRIAAAAAAAAAAN!
+
+

data/README.rdoc

@@ -0,0 +1,66 @@
+= rocky-klout
+
+* http://github.com/empika/rocky-klout
+
+== DESCRIPTION:
+
+Quick, easy access to the Klout.com API. Loosely based on the Klout gem by Jason Torres (http://github.com/jasontorres/klout) but using HTTParty and updating API methods.
+
+== REQUIREMENTS:
+
+HTTParty
+
+== INSTALL:
+
+sudo gem install rocky-klout
+
+== Usage:
+
+> rk = RockyKlout.new(your_api_key_here)
+> rk.user_show("empika")
+=> Hash
+> rk.user_show(["empika", "kibokoapp", "darthvader"])
+=> Hash
+
+Available methods:
+
+score_klout("username_or_id"), score_klout(["array" "of", "usernames", "or", "ids"])
+
+user_show("username_or_id"), user_show(["array" "of", "usernames", "or", "ids"])
+user_topics("username_or_id"),  user_topics(["array" "of", "usernames", "or", "ids"])
+user_stats("username_or_id"), user_stats(["array" "of", "usernames", "or", "ids"])
+user_history("username_or_id", "measure", "start_date", "end_date"), user_history(["array" "of", "usernames", "or", "ids"], "measure", "start_date", "end_date")
+I have no idea what some of the options for user_history are as its not very well documented. if you know, please let me know.
+
+relationship_influenced_by("username_or_id"), relationship_influenced_by(["array" "of", "usernames", "or", "ids"])
+relationship_influcencer_of("username_or_id"), relationship_influcencer_of(["array" "of", "usernames", "or", "ids"])
+
+topic_search("topic_string")
+topic_verify("topic_string")
+
+Enjoy!
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Eddy Parris
+
+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,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/rocky-klout'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'rocky-klout' do
+  self.developer 'Eddy Parris', 'eddy@kibokoapp.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['httparty','>= 0.6.1']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/rocky-klout'

data/lib/rocky-klout.rb

@@ -0,0 +1,84 @@
+require 'rubygems'
+require 'json'
+require 'httparty'
+begin
+  require 'cgi'
+end
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+# module RockyKlout
+#   VERSION = '0.0.1'
+# end
+
+class RockyKlout
+    include HTTParty
+    VERSION = '0.0.1'
+  
+    @@base_uri = "http://api.klout.com"
+    @@api_version = "1"
+  
+    @@api_key = ""
+    
+    def initialize(api_key)
+      @@api_key = api_key
+    end
+
+    def api_key=(api)
+      @@api_key = api
+    end
+  
+    def api_key
+      @@api_key
+    end
+
+    def score_klout(usernames)
+      request_uri = "/#{@@api_version}/klout.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",")
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def user_show(usernames)
+      request_uri = "/#{@@api_version}/users/show.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",")
+      self.class.get(@@base_uri + request_uri)
+    end  
+    
+    def user_topics(usernames)
+      request_uri = "/#{@@api_version}/users/topics.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",")
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def user_stats(usernames)
+      request_uri = "/#{@@api_version}/users/stats.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",")
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def user_history(usernames, measure, start_date, end_date)
+      request_uri = "/#{@@api_version}/users/show.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",") +
+        "&measure=" + CGI.escape(measure) +
+        "&start_date=" + CGI.escape(start_date)
+        "&end_date=" + CGI.escape(end_date)
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def relationship_influenced_by(usernames)
+      request_uri = "/#{@@api_version}/soi/influenced_by.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",")
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def relationship_influcencer_of(usernames)
+      request_uri = "/#{@@api_version}/soi/influencer_of.json?key=#{@@api_key}&users=" + usernames.collect{|name| CGI.escape(name)}.join(",")
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def topic_search(topic)
+      request_uri = "/#{@@api_version}/topics/search.json?key=#{@@api_key}&topic=" + CGI.escape(topic)
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+    def topic_verify(topic)
+      request_uri = "/#{@@api_version}/topics/verify.json?key=#{@@api_key}&topic=" + CGI.escape(topic)
+      self.class.get(@@base_uri + request_uri)
+    end
+    
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rocky-klout.rb'}"
+puts "Loading rocky-klout gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/rocky-klout'

data/test/test_rocky-klout.rb

@@ -0,0 +1,124 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRockyKlout < Test::Unit::TestCase
+
+  def setup
+    usage = "Usage: ruby test_rocky-klout.rb -- [klout_api_key]"
+    puts "Uh oh! \n"
+    puts usage
+    unless !ARGV[0].nil?
+      
+      exit
+    end
+    @api_key = ARGV[0] #"uxs4r9352tszfnau7np97zqs"
+    @rk = RockyKlout.new(@api_key)
+    @user_single = "darthvader"
+    @user_array = ["darthvader", "DeathStarPR"]
+    @measure = nil # not used yet, see test
+    @start_date = nil # not used yet, see test
+    @end_date = nil # not used yet, see test
+    @topic = "star wars"
+  end
+  
+  # klout score
+  def test_score_klout_single
+    response = @rk.score_klout(@user_single)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_score_klout_array
+    response = @rk.score_klout(@user_array)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  # user methods
+  def test_user_show_single
+    response = @rk.user_show(@user_single)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_user_show_array
+    response = @rk.user_show(@user_array)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_user_topics_single
+    response = @rk.user_topics(@user_single)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_user_topics_array
+    response = @rk.user_topics(@user_array)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_user_stats_single
+    response = @rk.user_stats(@user_single)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_user_stats_array
+    response = @rk.user_stats(@user_array)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  # skip these because we have no way of knowing what the arguments are
+  # def test_user_history_single
+  #   response = @rk.user_history(@user_single, @measure, @start_date, @end_date)
+  #   assert_instance_of Hash, response
+  #   assert_equal response["status"], 200
+  # end
+  # 
+  # def test_user_history_array
+  #   response = @rk.user_history(@user_array, @measure, @start_date, @end_date)
+  #   assert_instance_of Hash, response
+  #   assert_equal response["status"], 200
+  # end
+  
+  # relationship methods
+  def test_relationship_influenced_by_single
+    response = @rk.relationship_influenced_by(@user_single)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_relationship_influenced_by_array
+    response = @rk.relationship_influenced_by(@user_array)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_relationship_influcencer_of_single
+    response = @rk.relationship_influenced_by(@user_single)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_relationship_influcencer_of_array
+    response = @rk.relationship_influenced_by(@user_array)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  
+  # topic methods
+  def test_topic_search_single
+    response = @rk.topic_search(@topic)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+  
+  def test_topic_verify_array
+    response = @rk.topic_verify(@topic)
+    assert_instance_of Hash, response
+    assert_equal response["status"], 200
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: rocky-klout
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Eddy Parris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id003
+description: Quick, easy access to the Klout.com API. Loosely based on the Klout gem by Jason Torres (http://github.com/jasontorres/klout) but using HTTParty and updating API methods.
+email: 
+- eddy@kibokoapp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/rocky-klout.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_rocky-klout.rb
+has_rdoc: true
+homepage: http://github.com/empika/rocky-klout
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rocky-klout
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Quick, easy access to the Klout.com API
+test_files: 
+- test/test_helper.rb
+- test/test_rocky-klout.rb