majesticseo 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.0.2 2012-01-15
+* 2 minor enhancements 
+  * allow symbol as enviroment variable
+  * Allow supression of stdout msgs if :debug flag is set to false
+  * cherrypicked needed active support extensions (AS v.3.0.0 and up)
+  * majestic escapes pipes in text data in response. Parsing correctly
 === 1.0.0 2011-04-09
 * 2 minor enhancements:
   * Added installation message

data/Rakefile

@@ -7,9 +7,9 @@ require './lib/majesticseo'
 Hoe.plugin :newgem
 $hoe = Hoe.spec 'majesticseo' do
   self.developer 'Achilles Charmpilas', 'ac@humbuckercode.co.uk'
-  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           = [['activesupport','>= 2.0.2'], ['nokogiri','>= 1.4.0']]
+  self.post_install_message = 'PostInstall.txt'
+  self.rubyforge_name       = self.name
+  self.extra_deps           = [['activesupport','>= 3.0.0'], ['nokogiri','>= 1.4.0']]
 
 end
 

data/lib/majesticseo.rb

@@ -4,13 +4,20 @@ $:.unshift(File.dirname(__FILE__)) unless
 =begin rdoc
   This module implements a ruby-friendly interface to the Majestic SEO developer API.
 =end
-require "active_support"
 require "nokogiri"
 require "open-uri"
 require "ostruct"
 
+unless Hash.method_defined?(:to_param)
+  require "active_support/core_ext/object/to_query"
+end
+
+unless String.method_defined?(:underscore)
+  require "active_support/core_ext/string/inflections"
+end
+
 module Majesticseo
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
   class NoMethodError < ArgumentError; end
   class InvalidAPIKey < ArgumentError; end
 =begin rdoc
@@ -48,4 +55,4 @@ module Majesticseo
 =end
   class GlobalVars < Majesticseo::Structure; end
 end
-%W[data_table client].each { |r| require "#{File.dirname(__FILE__)}/majesticseo/#{r}" } 
+%W[data_table client].each { |r| require "#{File.dirname(__FILE__)}/majesticseo/#{r}" }

data/lib/majesticseo/client.rb

@@ -16,20 +16,29 @@ module Majesticseo
     end
 =end
   class Client
+    BASE_URI = "http://%s.majesticseo.com/api_command" unless
+      self.const_defined?(:BASE_URI)
+
     attr_reader   :app_api_key, :env, :uri, :response
     attr_accessor :code, :error_message, :full_error, :data_tables, :global_vars
 =begin rdoc
   Initialize a Majestic SEO aPI client passing the following options:
   app_api_key: You Majesticseo API key, found at: https://www.Majesticseo.com/account/api
-  enviroment (optional): Default to RAILS_ENV, RACK_ENV or default. Determines whether the client uses the sandbox or production API server
+  environment (optional): Default to RAILS_ENV, RACK_ENV or default. Determines whether the client uses the sandbox or production API server
 =end
     def initialize(opts = {})
       @app_api_key = opts.delete(:app_api_key)
-      
-      raise Majesticseo::InvalidAPIKey.new("API key needs to be a valid Majestic SEO API key. See: https://www.Majesticseo.com/account/api") if @app_api_key.blank?
-      
-      if opts[:enviroment]
-        @env = opts.delete(:enviroment)
+      @debug = opts.fetch(:debug, true)
+
+      if !@app_api_key || @app_api_key.empty?
+        msg = "API key needs to be a valid Majestic SEO API key. See: "\
+              "https://www.Majesticseo.com/account/api"
+
+        raise Majesticseo::InvalidAPIKey.new(msg)
+      end
+
+      if opts[:environment]
+        @env = opts.delete(:environment)
       elsif defined?(RAILS_ENV)
         @env = RAILS_ENV
       elsif defined?(RACK_ENV)
@@ -40,20 +49,35 @@ module Majesticseo
       @response = nil
       @data_tables = []
       @global_vars = nil
-      @uri = URI.parse("http://#{@env == "production" ? "enterprise" : "developer"}.Majesticseo.com/api_command")
+      @uri = URI.parse(build_url)
+
       puts "Started Majesticseo::Client in #{env} mode"
     end
 
     def call method, params
       params = {} unless params.is_a? Hash
       request_uri = uri.clone
-      request_uri.query = params.merge({:app_api_key => app_api_key, :cmd => method}).to_param
+      request_uri.query = params.merge({
+        :app_api_key => app_api_key,
+        :cmd => method
+      }).to_param
+
       @response = Nokogiri::XML(open(request_uri))
 
       # Set response and global variable attributes
-      response.at("Result").keys.each { |a| send("#{a.underscore}=".to_sym,response.at("Result").attr(a)) } if response.at("Result")
+      if response.at("Result")
+        response.at("Result").keys.each do |a|
+          send("#{a.underscore}=".to_sym, response.at("Result").attr(a))
+        end
+      end
+
       @global_vars = GlobalVars.new
-      response.at("GlobalVars").keys.each { |a| @global_vars.send("#{a.underscore}=".to_sym,response.at("GlobalVars").attr(a)) } if response.at("GlobalVars")
+      if response.at("GlobalVars")
+        response.at("GlobalVars").keys.each do |a|
+          @global_vars.send("#{a.underscore}=".to_sym, response.at("GlobalVars").attr(a)) 
+        end
+      end
+
       parse_data if success?
     end
 
@@ -62,11 +86,29 @@ module Majesticseo
     end
 
     def parse_data
-      @data_tables = @response.search("DataTable").collect { |table| DataTable.create_from_xml(table) }
+      @data_tables = @response.search("DataTable").map do |table|
+        DataTable.create_from_xml(table)
+      end
     end
 
     def success?
       code == "OK" and error_message == ""
     end
+
+    def build_url
+      subdomain = Hash.new("developer")
+      subdomain[:production] = "enterprise"
+      subdomain['production'] = "enterprise"
+
+      BASE_URI % subdomain[env]
+    end
+
+    def puts(msg)
+      Kernel.puts(msg) if debug?
+    end
+
+    def debug?
+      @debug
+    end
   end
-end
+end

data/lib/majesticseo/data_table.rb

@@ -9,7 +9,7 @@ module Majesticseo
       table.rows_count = xml.attr("RowsCount").to_i
       table.rows = xml.search("Row").map do |r|
         row = Row.new
-        data = r.content.split("|")
+        data = r.content.scan(/(?=<!\|)\|(?=!\|)/)
         table.headers.each_index { |i| row.send("#{table.headers[i].underscore}=",data[i])} 
         row
       end
@@ -28,4 +28,5 @@ module Majesticseo
       @headers ? @headers : []
     end
   end
-end
+end
+

data/test/test_helper.rb

@@ -1,3 +1,13 @@
+require 'rubygems'
 require 'stringio'
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/majesticseo'
+require File.expand_path('../../lib/majesticseo', __FILE__)
+
+def maj_client(key=nil, env=nil)
+  Majesticseo::Client.new(:app_api_key => key, :environment => env)
+end
+
+def fake_client(env=nil)
+  maj_client("fake", env)
+end
+

data/test/test_majesticseo.rb

@@ -1,15 +1,56 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class TestMajesticseo < Test::Unit::TestCase
-  def test_cannot_initialize_client_without_api_key
-    assert_raise Majesticseo::InvalidAPIKey do
-      Majesticseo::Client.new
-    end
-  end
-  
-  def test_cannot_initialize_client_with_empty_api_key
-    assert_raise Majesticseo::InvalidAPIKey do
-      Majesticseo::Client.new(:app_api_key => "")
-    end
-  end
-end
+require File.expand_path('../test_helper', __FILE__)
+
+class TestMajesticseo < Test::Unit::TestCase
+  def test_cannot_initialize_client_without_api_key
+    assert_raise Majesticseo::InvalidAPIKey do
+      Majesticseo::Client.new
+    end
+  end
+
+  def test_cannot_initialize_client_with_empty_api_key
+    assert_raise Majesticseo::InvalidAPIKey do
+      Majesticseo::Client.new(:app_api_key => "")
+    end
+  end
+end
+
+class TestMajesticURL < Test::Unit::TestCase
+  def test_builds_correct_url_for_development
+    assert_equal "http://developer.majesticseo.com/api_command",
+      fake_client("development").build_url
+  end
+
+  def test_builds_correct_url_for_production
+    [:production, "production"].each do |e|
+      assert_equal "http://enterprise.majesticseo.com/api_command",
+        fake_client(e).build_url
+    end
+  end
+
+  def test_builds_correct_url_for_default
+    assert_equal "http://developer.majesticseo.com/api_command",
+      fake_client.build_url
+  end
+end
+
+class TestMajesticDebug < Test::Unit::TestCase
+  def setup
+    @_stdout = $stdout
+    @stringio = StringIO.new
+    $stdout = @stringio
+  end
+
+  def teardown
+    $stdout = @_stdout
+  end
+
+  def test_client_in_debug_mode_by_default
+    assert fake_client.debug?
+  end
+
+  def test_suppress_output_when_not_in_debug_mode
+    client = Majesticseo::Client.new(:app_api_key => "test", :debug => false)
+
+    assert_equal "", @stringio.string
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: majesticseo
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Achilles Charmpilas
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-09 00:00:00 +02:00
+date: 2013-01-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 7
         segments: 
-        - 2
+        - 3
         - 0
-        - 2
-        version: 2.0.2
+        - 0
+        version: 3.0.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -51,37 +51,21 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: hoe
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 35
         segments: 
         - 2
-        - 0
+        - 9
         - 4
-        version: 2.0.4
+        version: 2.9.4
   type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id004 !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: *id004
 description: A ruby-friendly interface to the Majestic SEO API.
 email: 
 - ac@humbuckercode.co.uk
@@ -107,6 +91,7 @@ files:
 - script/generate
 - test/test_helper.rb
 - test/test_majesticseo.rb
+- .gemtest
 has_rdoc: true
 homepage: http://github.com/Achillefs/majesticseo
 licenses: []
@@ -138,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: majesticseo
-rubygems_version: 1.4.2
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: A ruby-friendly interface to the Majestic SEO API.