klout 1.0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.travis.yml

@@ -0,0 +1 @@
+rvm: 1.9.2

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'json'
+gem 'xml-simple'
+
+group :development do
+	gem 'bundler', '~> 1.0.0'
+	gem 'fakeweb'
+	gem 'guard-rspec'
+	gem 'jeweler', '~> 1.6.4'
+	gem 'simplecov'
+  gem 'rspec'
+end

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/README.rdoc

@@ -0,0 +1,51 @@
+= Klout
+
+Klout is a Ruby gem that provides a wrapper for interacting with the {Klout API}[http://developer.klout.com/docs/read/api/API].
+
+== Requirements
+
+You will need a {Klout API Key}[http://developer.klout.com/member/register] in order to get started.
+
+== Installation
+
+  (sudo) gem install klout
+
+== Usage
+
+Please refer to the {Klout API Documentation}[http://developer.klout.com/docs/read/api/API] for more information about the API, or follow the examples below:
+
+  k = Klout::API.new('your_secret_api_key')
+
+There are also configuration options:
+
+  k = Klout::API.new('your_secret_api_key', {:format => 'xml', :secure => true})
+
+Once you have created a Klout object, you can interact with the API to find out how much influence certain Twitter users have. You can also pass comma-delimited string of multiple Twitter usernames as well.
+
+  k.klout('dhh')
+  k.klout('dhh, rails')
+  
+  k.show('dhh')
+  k.topics('dhh')
+  
+  k.influencer_of('rails')
+  k.influenced_by('dhh, rails')
+
+== Travis Build Status
+
+{<img src="http://travis-ci.org/terra-firma/klout.png" />}[http://travis-ci.org/terra-firma/klout]
+
+== Contributing to Klout
+ 
+* 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.
+
+== Copyright
+
+Copyright (c) 2011 Terra Firma Design & Consulting. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'rubygems'
+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 'rake'
+
+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 = "klout"
+  gem.homepage = "http://github.com/terra-firma/klout"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby gem for interacting with the Klout API.}
+  gem.description = %Q{Ruby gem for interacting with the Klout API.}
+  gem.email = "brian@terra-firma-design.com"
+  gem.authors = ["Brian Getting"]
+  # 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
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "klout #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/klout.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{klout}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Brian Getting}]
+  s.date = %q{2012-02-02}
+  s.description = %q{Ruby gem for interacting with the Klout API.}
+  s.email = %q{brian@terra-firma-design.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "Guardfile",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "klout.gemspec",
+    "lib/klout.rb",
+    "lib/klout/api.rb",
+    "spec/klout/fixtures/klout.json",
+    "spec/klout/fixtures/klout.xml",
+    "spec/klout/klout_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/terra-firma/klout}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
+  s.summary = %q{Ruby gem for interacting with the Klout 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<json>, [">= 0"])
+      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<xml-simple>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<xml-simple>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/klout.rb

@@ -0,0 +1,7 @@
+require 'uri'
+require 'net/http'
+require 'rubygems'
+require 'json'
+require 'xmlsimple'
+
+require 'klout/api'

data/lib/klout/api.rb

@@ -0,0 +1,57 @@
+module Klout
+  class API
+    # Blank slate
+    instance_methods.each do |m|
+      undef_method m unless m.to_s =~ /^__|object_id|method_missing|respond_to?|to_s|inspect/
+    end
+    
+    # Initialize
+    def initialize(api_key, config = {})
+      defaults = {
+        :format   => 'json',
+        :secure   => false
+      }
+      @config = defaults.merge(config).freeze
+      @api_key = api_key
+      protocol = @config[:secure] ? 'https' : 'http'
+      api_base = URI.parse("#{protocol}://api.klout.com/")
+      @klout_api = Net::HTTP.new(api_base.host, api_base.port)
+    end
+    
+    # Class Methods
+    def call(api_method, usernames)
+      path = '/1'
+      path += '/users' if ['show', 'topics'].include?(api_method.to_s)
+      path += '/soi' if ['influenced_by', 'influencer_of'].include?(api_method.to_s)
+      path += "/#{api_method}.#{@config[:format]}"
+      path += "?key=#{@api_key}"
+      path += "&users=#{URI.escape(usernames.gsub(/ /,''))}"
+      url = Net::HTTP::Get.new(path)
+      response = @klout_api.request(url)
+      # TODO: Clean this up when Klout fixes their ambiguous 404 responses.
+      raise APIError.new(response.code, response.message) if response.code.to_i > 202
+      return nil if response.body == ''
+      @config[:format] == 'xml' ? XmlSimple.xml_in(response.body, {'ForceArray' => false}) : JSON.parse(response.body)
+    end
+    
+    def method_missing(api_method, *args) # :nodoc:
+      call(api_method, *args)
+    # TODO: Need Klout to fix their ambiguous 404 responses.
+    #rescue Klout::APIError => error
+      #super if error.message == "<404> Not Found"
+    end
+    
+    def respond_to?(api_method) # :nodoc:
+      call(api_method, 'twitter')
+    rescue Klout::APIError => error
+      error.message == "<404> Not Found" ? false : true
+    end
+  end
+  
+  class APIError < StandardError
+    # Initialize
+    def initialize(code, message)
+      super "<#{code}> #{message}"
+    end
+  end
+end

data/spec/klout/fixtures/klout.json

@@ -0,0 +1,13 @@
+{
+	"status": 200,
+	"users": [
+		{
+			"twitter_screen_name": "sampler",
+			"kscore": "30.01"
+		},
+		{
+			"twitter_screen_name": "another",
+			"kscore": "60.02"
+		}
+	]
+}

data/spec/klout/fixtures/klout.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<users>
+  <user>
+    <twitter_screen_name>sampler</twitter_screen_name>
+    <kscore>30.01</kscore>
+  </user>
+	<user>
+    <twitter_screen_name>another</twitter_screen_name>
+    <kscore>60.02</kscore>
+  </user>
+</users>

data/spec/klout/klout_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module Klout
+  describe API do
+    
+    API_URL         = "http://api.klout.com/1"
+    API_URL_SECURE  = "http://api.klout.com:443/1"
+
+    it "requires an API key" do
+      expect {Klout::API.new}.should raise_error(ArgumentError)
+    end
+    
+    it "also accepts config options" do
+      expect {Klout::API.new(@api_key, {:secure => true})}.should_not raise_error(ArgumentError)
+    end
+    
+    it "requires username passed to methods" do
+      k = Klout::API.new(@apikey)
+      expect {k.klout}.should raise_error(ArgumentError)
+    end
+
+    it "can make a request to the API" do
+      FakeWeb.register_uri(:get, "#{API_URL}/klout.json?key=#{@api_key}&users=testuser", :body => @json_response)
+      k = Klout::API.new(@api_key)
+      k.klout('testuser')['status'].should eq(200)
+    end
+    
+    it "can make a secure request to the API" do
+      FakeWeb.register_uri(:get, "#{API_URL_SECURE}/klout.json?key=#{@api_key}&users=testuser", :body => @json_response)
+      k = Klout::API.new(@api_key, {:secure => true})
+      k.klout('testuser')['users'].first['kscore'].should eq("30.01")
+    end
+    
+    it "can return XML from the API" do
+      FakeWeb.register_uri(:get, "#{API_URL}/klout.xml?key=#{@api_key}&users=testuser", :body => @xml_response)
+      k = Klout::API.new(@api_key, {:format => 'xml'})
+      k.klout('testuser')['user'].first['kscore'].should eq("30.01")
+    end
+
+    it "injects the 'user' prefix for user requests" do
+      FakeWeb.register_uri(:get, "#{API_URL}/users/show.json?key=#{@api_key}&users=testuser", :body => @json_response)
+      k = Klout::API.new(@api_key)
+      k.show('testuser')['status'].should eq(200)
+    end
+
+    it "injects the 'soi' prefix for influence requests" do
+      FakeWeb.register_uri(:get, "#{API_URL}/soi/influenced_by.json?key=#{@api_key}&users=testuser", :body => @json_response)
+      k = Klout::API.new(@api_key)
+      k.influenced_by('testuser')['status'].should eq(200)
+    end
+
+    it "only responds to methods supported by the Klout API" do
+      FakeWeb.register_uri(:get, "#{API_URL}/bogus_method.json?key=#{@api_key}&users=twitter", :status => ["404", "Not Found"])
+      k = Klout::API.new(@api_key)
+      k.respond_to?("bogus_method").should eq(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'fakeweb'
+require 'klout'
+
+FakeWeb.allow_net_connect = false
+
+RSpec.configure do |config|
+  config.before(:each) do
+    FakeWeb.clean_registry
+    @api_key = 'valid-api-key'
+    @json_response = File.read(File.expand_path('spec/klout/fixtures/klout.json'))
+    @xml_response = File.read(File.expand_path('spec/klout/fixtures/klout.xml'))
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: klout
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Getting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2165150660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165150660
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &2165149560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165149560
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165148720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165148720
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2165147780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165147780
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2165146760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165146760
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2165145780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2165145780
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2165144920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165144920
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165128940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165128940
+description: Ruby gem for interacting with the Klout API.
+email: brian@terra-firma-design.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.rdoc
+- Rakefile
+- VERSION
+- klout.gemspec
+- lib/klout.rb
+- lib/klout/api.rb
+- spec/klout/fixtures/klout.json
+- spec/klout/fixtures/klout.xml
+- spec/klout/klout_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/terra-firma/klout
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -135046269901848319
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Ruby gem for interacting with the Klout API.
+test_files: []