scribe_api 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "httparty", ">= 0"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem 'ruby-debug19', :require => 'ruby-debug'
+  gem "jeweler", "~> 1.8.3"
+  gem 'jnunemaker-matchy', '0.4.0', :require => 'matchy'
+  gem 'fakeweb', '1.3.0'
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    jnunemaker-matchy (0.4.0)
+    json (1.7.1)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    multi_json (1.3.4)
+    multi_xml (0.4.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  fakeweb (= 1.3.0)
+  httparty
+  jeweler (~> 1.8.3)
+  jnunemaker-matchy (= 0.4.0)
+  rdoc (~> 3.12)
+  ruby-debug19
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ian Smith
+
+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,14 @@
+= scribe_api
+
+This gem lets you interact with the Scribe SEO v4 API from Copyblogger Media. It uses HTTParty, which is a neato gem.
+
+== Contributing to scribe_api
+ 
+* 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.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# 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 = "scribe_api"
+  gem.homepage = "http://github.com/ianisborn/scribe_api"
+  gem.license = "MIT"
+  gem.summary = %Q{scribe api wrapper}
+  gem.description = %Q{easily access the scribe api.}
+  gem.email = "ianhenrysmith@gmail.com"
+  gem.authors = ["Ian Smith"]
+  # 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 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scribe_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/scribe_api.rb

@@ -0,0 +1,34 @@
+require 'httparty'
+
+class ScribeAPI
+  include HTTParty
+  base_uri "api.scribeseo.com"
+  
+  def initialize( key )
+    @key = key
+  end
+  
+  def keyword_suggestions( params )
+    options = { :body => { :query => params[:keyword] } }
+    self.class.post( "/analysis/kw/suggestions?apikey=#{@key}", options )
+  end
+  
+  def keyword_details( params )
+    options = { :body => { :query => params[:keyword], :domain => params[:domain] } }
+    self.class.post( "/analysis/kw/detail?apikey=#{@key}", options )
+  end
+  
+  def content_analysis( params )
+    options = { :body => { :htmlTitle => params[:title], :htmlDescription => params[:description], :htmlHeadline => params[:headline], :htmlBody => params[:body], :targetedKeyword => params[:keyword] } }
+    self.class.post( "/analysis/content?apikey=#{@key}", options )
+  end
+  
+  def link_building( params )
+    options = { :body => { :query => params[:keyword], :domain => params[:domain] } }
+    self.class.post( "/analysis/link?apikey=#{@key}", options )
+  end
+  
+  def user_information( )
+    self.class.get( "/membership/user/detail?apikey=#{@key}" )
+  end
+end

data/test/fixtures.json

@@ -0,0 +1,14 @@
+keyword suggestions:
+{"scoreDifficulty":100,"scoreContent":2,"scoreLinks":0,"scoreDomainAuthority":0,"scorePageAuthority":1,"scoreFacebookLikes":0,"scoreGenderMale":50,"scoreGenderFemale":47,"agePrimaryDescription":"Age 35 to 49","agePrimaryValue":37,"ageSecondaryDescription":"Age 25 to 34","ageSecondaryValue":27,"ppc":0,"volumeAnnual":28735836,"volumeMonthly":2394653}
+
+keyword details: 
+{"suggestions":[{"term":"horse","competition":66,"popularity":19},{"term":"horses","competition":61,"popularity":9},{"term":"equestrian","competition":57,"popularity":5},{"term":"riding","competition":62,"popularity":5},{"term":"horse health","competition":41,"popularity":4},{"term":"horse supplies","competition":46,"popularity":4},{"term":"equine","competition":56,"popularity":4},{"term":"horses for sale","competition":54,"popularity":3},{"term":"care","competition":71,"popularity":3},{"term":"games","competition":73,"popularity":3}]}
+
+content analysis:
+(need this to work)
+
+link building:
+(need this to work)
+
+user info:
+{"accountStatus":1,"accountType":"developer","evaluations":[{"remaining":1993,"term":"monthly","total":2000,"type":"KeywordIdeaResearch"},{"remaining":4999,"term":"monthly","total":5000,"type":"ContentAnalysis"}]}

data/test/helper.rb

@@ -0,0 +1,29 @@
+require 'pathname'
+require 'rubygems'
+require 'bundler'
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
+require 'fakeweb'
+require 'ruby-debug'
+
+# FakeWeb.allow_net_connect = false
+
+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
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'scribe_api'
+
+class Test::Unit::TestCase
+  def fixture_file( path )
+    Pathname(__FILE__).dirname.join(*path.split('/')).read
+  end
+end

data/test/test_scribe_api.rb

@@ -0,0 +1,48 @@
+require 'helper'
+require 'open-uri'
+
+class TestScribeApi < Test::Unit::TestCase
+  context "scribe_api" do
+    setup do
+      @key = "scribe-2c81aaba77ca4fc4bcf0a94812dd5e32"
+    end
+    
+    # should "have keyword suggestions" do
+    #   @scribe = ScribeAPI.new( @key )
+    #   params = { :keyword => "horse" }
+    #   suggestions = @scribe.keyword_suggestions( params )
+    #   puts suggestions
+    # end
+    # 
+    # should "have keyword details" do
+    #   @scribe = ScribeAPI.new( @key )
+    #   params = { :keyword => "design", :domain => "http://blog.iso50.com" }
+    #   details = @scribe.keyword_details( params )
+    #   puts details
+    # end
+    # 
+    # should "have content analysis" do
+    #   @scribe = ScribeAPI.new( @key )
+    #   params = { :title => URI::encode("<title>Stocks Claw Back</title>") }
+    #   params[:description] = URI::encode("<meta property='og:description' content='Stocks reversed losses and inched higher, after elections in France and Greece fueled concerns about the region's ability to deal with its sovereign-debt problems.' >")
+    #   params[:keyword] = "stocks"
+    #   params[:headline] = URI::encode("<h1>Stocks Claw Back</h1>")
+    #   params[:body] = URI::encode("<p>Stocks reversed losses and inched higher, after elections in France and Greece fueled concerns about the region's ability to deal with its sovereign-debt problems. Stocks opened lower but recovered most losses by Monday afternoon. The Dow Jones Industrial Average rose 10 points, or 0.1%, to 13048. The Dow industrials fell as much as 68 points early in the session. The Standard & Poor's 500-stock index rose four points, or 0.3%, to 1373, and the Nasdaq Composite rose 13 points, 0.4%, to 2969. Vincent Cignarella and Michael Casey join Markets Hub with the U.S. reaction to weekend elections in France and Greece, and what the new order will mean for the continent's debt struggles. Financial-sector stocks rose the most, with Bank of America CVX -0.31% leading Dow components. Utility stocks trailed behind. Walt Disney DIS +1.93% rose after its latest superhero action film, 'The Avengers,' raked in over $200 million in its weekend box-office debut. Strong ticket sales validated Disney's $4 billion acquisition of Marvel Entertainment and softened the blow of the recently disappointing 'John Carter.' American International Group AIG -3.37% slumped after the U.S. government agreed to sell $5 billion of the insurer's stock at $30.50 a share, representing a 7.1% discount to Friday's closing price. Weekend elections across the Atlantic initially jostled markets.</p>")
+    #   analysis = @scribe.content_analysis( params )
+    #   puts analysis
+    # end
+    
+    should "have link building" do
+      @scribe = ScribeAPI.new( @key )
+      params = { :keyword => "llama", :domain => "simcity.com" }
+      link_building = @scribe.link_building( params )
+      puts link_building
+    end
+    
+    # should "have user info" do
+    #   @scribe = ScribeAPI.new( @key )
+    #   info = @scribe.user_information
+    #   puts info
+    # end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: scribe_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2156514340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156514340
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2156513380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156513380
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2156512580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2156512580
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2156511660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156511660
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2156510520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156510520
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2156508680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *2156508680
+- !ruby/object:Gem::Dependency
+  name: jnunemaker-matchy
+  requirement: &2156505500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156505500
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2156504540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2156504540
+description: easily access the scribe api.
+email: ianhenrysmith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/scribe_api.rb
+- test/fixtures.json
+- test/helper.rb
+- test/test_scribe_api.rb
+homepage: http://github.com/ianisborn/scribe_api
+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: 2392811585307659062
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: scribe api wrapper
+test_files: []