scribe_api 0.1.0 → 0.2.0

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem "httparty", ">= 0"
+gem "json", ">= 0"
 
 group :development do
   gem "shoulda", ">= 0"

data/Gemfile.lock

@@ -19,7 +19,7 @@ GEM
       ruby_core_source (>= 0.1.4)
     multi_json (1.3.4)
     multi_xml (0.4.4)
-    rake (0.9.2.2)
+    rake (0.9.2.0)
     rdoc (3.12)
       json (~> 1.4)
     ruby-debug-base19 (0.11.25)
@@ -47,6 +47,7 @@ DEPENDENCIES
   httparty
   jeweler (~> 1.8.3)
   jnunemaker-matchy (= 0.4.0)
+  json
   rdoc (~> 3.12)
   ruby-debug19
   shoulda

data/Rakefile

@@ -20,7 +20,7 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{scribe api wrapper}
   gem.description = %Q{easily access the scribe api.}
   gem.email = "ianhenrysmith@gmail.com"
-  gem.authors = ["Ian Smith"]
+  gem.authors = ["Ian Henry Smith"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/scribe_api.rb

@@ -1,34 +1,43 @@
 require 'httparty'
+require 'json'
 
 class ScribeAPI
   include HTTParty
+  headers 'Content-Type' => 'application/json' 
+  default_params :output => 'json'
+  format :json
+  
+  # un-comment the next line to enable debug output from httparty
+  # debug_output $stdout
+  
   base_uri "api.scribeseo.com"
   
   def initialize( key )
     @key = key
   end
   
-  def keyword_suggestions( params )
-    options = { :body => { :query => params[:keyword] } }
+  def keyword_suggestions( params={} )
+    options = { :body => { :query => params[:keyword] }.to_json }
     self.class.post( "/analysis/kw/suggestions?apikey=#{@key}", options )
   end
   
-  def keyword_details( params )
-    options = { :body => { :query => params[:keyword], :domain => params[:domain] } }
+  def keyword_details( params={} )
+    options = { :body => { :query => params[:keyword], :domain => params[:domain] }.to_json }
     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] } }
+  def content_analysis( params={} )
+    options = { :body => { :htmlTitle => params[:title], :htmlDescription => params[:description], :htmlHeadline => params[:headline], :htmlBody => params[:body], :targetedKeyword => params[:keyword], :domain => params[:domain] }.to_json }
     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 )
+  def link_building( params={} )
+    options = { :body => { :query => params[:keyword], :domain => params[:domain] }.to_json }
+    # this is disabled cause scribe is working on this endpt.
+    # self.class.post( "/analysis/link?apikey=#{@key}", options )
   end
   
-  def user_information( )
+  def user_information( params={} )
     self.class.get( "/membership/user/detail?apikey=#{@key}" )
   end
 end

data/scribe_api.gemspec

@@ -0,0 +1,75 @@
+# 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{scribe_api}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Ian Henry Smith}]
+  s.date = %q{2012-05-09}
+  s.description = %q{easily access the scribe api.}
+  s.email = %q{ianhenrysmith@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/scribe_api.rb",
+    "scribe_api.gemspec",
+    "test/fixtures.json",
+    "test/helper.rb",
+    "test/test_scribe_api.rb"
+  ]
+  s.homepage = %q{http://github.com/ianisborn/scribe_api}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{scribe api wrapper}
+
+  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<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+      s.add_development_dependency(%q<fakeweb>, ["= 1.3.0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+      s.add_dependency(%q<fakeweb>, ["= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
+    s.add_dependency(%q<fakeweb>, ["= 1.3.0"])
+  end
+end
+

data/test/fixtures.json

@@ -5,7 +5,7 @@ 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)
+{"docScore":59,"docScoreE":["BodyLen","Hyper"],"fleschScore":"very difficult","keywords":[{"kwc":4.59,"kwd":4.38,"kwe":[],"kwf":7,"kwl":1,"kwlText":"Primary","kwo":"A","kwod":"Congratulations, this term strikes a good balance between search optimization and copywriting best practices.","kwp":"Very High","kwr":1,"kws":13.61,"text":"stocks"},{"kwc":1.22,"kwd":1.88,"kwe":["KwET"],"kwf":3,"kwl":4,"kwlText":"Not Emphasized","kwo":"B","kwod":"To improve the ranking for this term, correct the copywriting and\/or document issues found.","kwp":"Very Low","kwr":2,"kws":10.21,"text":"greece"},{"kwc":1.02,"kwd":1.25,"kwe":["KwET","KwEMP","KwELF"],"kwf":2,"kwl":4,"kwlText":"Not Emphasized","kwo":"B","kwod":"To improve the ranking for this term, correct the copywriting and\/or document issues found.","kwp":"Very Low","kwr":5,"kws":5.21,"text":"sovereign debt"},{"kwc":1.22,"kwd":1.88,"kwe":["KwET"],"kwf":3,"kwl":4,"kwlText":"Not Emphasized","kwo":"B","kwod":"To improve the ranking for this term, correct the copywriting and\/or document issues found.","kwp":"Very Low","kwr":4,"kws":9.69,"text":"france"},{"kwc":1.59,"kwd":1.25,"kwe":["KwELF"],"kwf":2,"kwl":4,"kwlText":"Not Emphasized","kwo":"B","kwod":"To improve the ranking for this term, correct the copywriting and\/or document issues found.","kwp":"Very Low","kwr":3,"kws":9.78,"text":"stock"},{"kwc":3.18,"kwd":1.25,"kwe":["KwEM","KwELF"],"kwf":2,"kwl":2,"kwlText":"Important","kwo":"C","kwod":"While your copywriting is strong, consider writing more about this topic on your site and\/or use this term more frequently in your content.","kwp":"Very High","kwr":6,"kws":3.61,"text":"claw"},{"kwc":1.02,"kwd":1.25,"kwe":["KwET","KwEMP","KwELF"],"kwf":2,"kwl":4,"kwlText":"Not Emphasized","kwo":"D","kwod":"You will need to do some work for this term, including improving your copywriting and writing more about this topic on your site.","kwp":"Very Low","kwr":7,"kws":4.03,"text":"ability"}],"scribeScore":92,"tags":["stocks","greece","sovereign debt","france","stock","claw","ability","economic history of the united kingdom","fuel","economics","reverse","loss","election"]}
 
 link building:
 (need this to work)

data/test/test_scribe_api.rb

@@ -7,42 +7,43 @@ class TestScribeApi < Test::Unit::TestCase
       @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 keyword suggestions" do
+      @scribe = ScribeAPI.new( @key )
+      params = { :keyword => "horse" }
+      suggestions = @scribe.keyword_suggestions( params )
+      puts suggestions
+    end
     
-    should "have link building" do
+    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 = { :keyword => "llama", :domain => "simcity.com" }
-      link_building = @scribe.link_building( params )
-      puts link_building
+      params = { :title => "Stocks Claw Back" }
+      params[:description] = "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] = "Stocks Claw Back"
+      params[:domain] = "http://online.wsj.com"
+      params[:body] = "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."
+      analysis = @scribe.content_analysis( params )
+      puts analysis
     end
     
-    # should "have user info" do
+    # should "have link building" do
     #   @scribe = ScribeAPI.new( @key )
-    #   info = @scribe.user_information
-    #   puts info
+    #   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

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: scribe_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
-- Ian Smith
+- Ian Henry Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000Z
+date: 2012-05-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2156514340 !ruby/object:Gem::Requirement
+  requirement: &2152366840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156514340
+  version_requirements: *2152366840
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2152362220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152362220
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2156513380 !ruby/object:Gem::Requirement
+  requirement: &2152361400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156513380
+  version_requirements: *2152361400
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2156512580 !ruby/object:Gem::Requirement
+  requirement: &2152360440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *2156512580
+  version_requirements: *2152360440
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2156511660 !ruby/object:Gem::Requirement
+  requirement: &2152359780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2156511660
+  version_requirements: *2152359780
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2156510520 !ruby/object:Gem::Requirement
+  requirement: &2152359100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156510520
+  version_requirements: *2152359100
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156508680 !ruby/object:Gem::Requirement
+  requirement: &2152358100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +87,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2156508680
+  version_requirements: *2152358100
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &2156505500 !ruby/object:Gem::Requirement
+  requirement: &2152356960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -87,10 +98,10 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *2156505500
+  version_requirements: *2152356960
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2156504540 !ruby/object:Gem::Requirement
+  requirement: &2152356100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -98,7 +109,7 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *2156504540
+  version_requirements: *2152356100
 description: easily access the scribe api.
 email: ianhenrysmith@gmail.com
 executables: []
@@ -115,6 +126,7 @@ files:
 - Rakefile
 - VERSION
 - lib/scribe_api.rb
+- scribe_api.gemspec
 - test/fixtures.json
 - test/helper.rb
 - test/test_scribe_api.rb
@@ -133,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2392811585307659062
+      hash: 1460378721273916177
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: