wordstream 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Logan Koester
+
+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.rdoc

@@ -0,0 +1,17 @@
+= wordstream
+
+The Free Keyword Tool by WordStream provides extensive, relevant keyword and related keyword suggestions
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Logan Koester. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "wordstream"
+    gem.summary = %Q{Ruby interface to the Wordstream API}
+    gem.description = %Q{The Free Keyword Tool by WordStream provides extensive, relevant keyword and related keyword suggestions}
+    gem.email = "logan@logankoester.com"
+    gem.homepage = "http://github.com/logankoester/wordstream"
+    gem.authors = ["Logan Koester"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "httparty"
+    gem.add_dependency "hashie"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "wordstream #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/wordstream.rb

@@ -0,0 +1,67 @@
+#gem 'httparty', '=0.5.2'
+require 'httparty'
+require 'hashie'
+require 'json'
+require 'ostruct'
+
+module Wordstream
+
+  class Client
+    include HTTParty
+    base_uri 'http://api.wordstream.com'
+    default_params :callback => 'response'
+
+    attr_accessor :username, :password
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+
+    def login
+      resp = self.class.get('/authentication/login', :query => {:username => @username, :password => @password})
+      parsed = response(resp)
+      self.class.default_params :session_id => parsed.data.session_id
+    end
+
+    def logout
+      response( self.class.get('/authentication/logout') )
+    end
+
+    def get_api_credits
+      response(self.class.get('/authentication/get_api_credits'))
+    end
+
+    def response(resp)
+      Hashie::Mash.new (JSON.parse( resp.match(/response\((.*)\)/)[1]) )
+    end
+  end
+
+  class KeywordTool
+    attr_accessor :client, :seeds
+    attr_reader :keywords, :niches
+    def initialize(client, seeds)
+      @client, @seeds = client, seeds
+    end
+
+    def get_keyword_niches(max_niches)
+      resp = @client.response( @client.class.get('/keywordtool/get_keyword_niches', :query => {:seeds => @seeds, :max_niches => max_niches}) )
+      @niches = resp.data
+      @niches = resp.data.groupings.collect do |g|
+        keywords = g.matches.collect { |m| Keyword.new(:keyword => resp.data.keywords[m][0], :volume => resp.data.keywords[m][1]) }
+        Niche.new(
+          :title    => g.title,
+          :score    => g.score,
+          :wordlist => g.wordlist,
+          :keywords => keywords
+        )
+      end
+    end
+
+    def get_keywords(max_results)
+      resp = @client.response( @client.class.get('/keywordtool/get_keywords', :query => {:seeds => @seeds, :max_results => max_results}) )
+      @keywords = resp.data.collect { |k| Keyword.new(:keyword => k[0], :volume => k[1]) }
+    end
+  end
+
+  class Keyword < OpenStruct
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'wordstream'
+
+class Test::Unit::TestCase
+end

data/test/test_wordstream.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestWordstream < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: wordstream
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-14 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: The Free Keyword Tool by WordStream provides extensive, relevant keyword and related keyword suggestions
+email: logan@logankoester.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/wordstream.rb
+- test/helper.rb
+- test/test_wordstream.rb
+has_rdoc: true
+homepage: http://github.com/logankoester/wordstream
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the Wordstream API
+test_files: 
+- test/helper.rb
+- test/test_wordstream.rb