majestic_seo_api 0.9.3

data/lib/majestic_seo/api/response.rb

@@ -0,0 +1,113 @@
+
+=begin
+
+  Version 0.9.3
+
+  Copyright (c) 2011, Majestic-12 Ltd
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+  3. Neither the name of the Majestic-12 Ltd nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+=end
+
+module MajesticSeo
+  module Api
+    class Response
+      attr_accessor :response, :tables, :table_key
+      attr_accessor :code, :error_message, :full_error
+      attr_accessor :global_variables, :success, :items
+
+      # This method returns a new instance of the Response class.
+      # If one of the parameters are not provided, it will default to nil.
+      def initialize(response = nil)
+        @response           =   response
+        @global_variables   =   {}
+        @tables             =   {}
+        @success            =   false
+
+        parse_response
+      end
+
+      def parse_response
+        if (@response.is_a?(Nokogiri::XML::Document))
+          @response = (@response && @response.root) ? @response.root : nil
+        elsif (@response.is_a?(Faraday::Response))
+          @response = (@response && @response.body && @response.body.root) ? @response.body.root : nil
+        end
+
+        if (@response)
+          @response.attributes.each do |key, attribute|
+            self.send("#{key.underscore}=", attribute.value)
+          end
+
+          @success  =   @code.downcase.eql?("ok")
+
+          if (success?)
+            parse_global_variables
+            parse_tables
+          end
+        end
+      end
+
+      def success?
+        @success
+      end
+
+      def parse_global_variables
+        vars = @response.at_xpath("//GlobalVars")
+
+        vars.attributes.each do |key, attribute|
+          @global_variables[key.underscore] = attribute.value
+        end if (vars && vars.attributes.any?)
+      end
+
+      def stacktrace
+        @full_error
+      end
+
+      def items
+        if (@items.nil? || @items.empty?)
+          @items = (self.tables && self.tables.has_key?(self.table_key)) ? self.tables[self.table_key].rows : nil
+        end
+        
+        return @items
+      end
+
+      def parse_tables
+        tables = @response.xpath("//DataTables/DataTable")
+
+        tables.each do |table|
+          parse_table(table)
+        end if (tables && tables.any?)
+      end
+
+      def parse_table(table)
+        parsed_table                  =   MajesticSeo::Api::DataTable.new(table)
+        @tables[parsed_table.name]    =   parsed_table
+      end
+
+    end
+
+  end
+end
+

data/lib/majestic_seo/api/top_back_links_response.rb

@@ -0,0 +1,44 @@
+
+=begin
+
+  Version 0.9.3
+
+  Copyright (c) 2011, Majestic-12 Ltd
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+  3. Neither the name of the Majestic-12 Ltd nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+=end
+
+module MajesticSeo
+  module Api
+    
+    class TopBackLinksResponse < Response
+      def initialize(response, table_key = "URL")
+        @table_key = table_key
+        super(response)
+      end
+    end
+    
+  end
+end

data/lib/majestic_seo/extensions/string.rb

@@ -0,0 +1,10 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+

data/lib/majestic_seo/railtie.rb

@@ -0,0 +1,12 @@
+require 'majestic_seo_api'
+require 'rails'
+
+module MajesticSeo
+  class Railtie < Rails::Railtie
+    
+    #rake_tasks do
+    #  Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |ext| load ext }
+    #end
+    
+  end
+end

data/lib/majestic_seo_api.rb

@@ -0,0 +1,17 @@
+module MajesticSeoApi
+  require File.join(File.dirname(__FILE__), 'majestic_seo/railtie') if defined?(Rails)
+
+  if (!String.instance_methods(false).include?(:underscore))
+    require File.join(File.dirname(__FILE__), 'majestic_seo/extensions/string')
+  end
+
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/logger')
+
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/response')
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/item_info_response')
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/top_back_links_response')
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/data_table')
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/item_info')
+  require File.join(File.dirname(__FILE__), 'majestic_seo/api/client')
+end
+

data/majestic_seo_api.gemspec

@@ -0,0 +1,84 @@
+# 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 = "majestic_seo_api"
+  s.version = "0.9.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Majestic-12 Ltd", "Sebastian Johnsson"]
+  s.date = "2012-01-29"
+  s.description = "Interface for communicating with Majestic SEO's API"
+  s.email = "sebastian@agiley.se"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/majestic_seo/majestic_seo_generator.rb",
+    "lib/generators/templates/majestic_seo.template.yml",
+    "lib/majestic_seo/api/client.rb",
+    "lib/majestic_seo/api/data_table.rb",
+    "lib/majestic_seo/api/item_info.rb",
+    "lib/majestic_seo/api/item_info_response.rb",
+    "lib/majestic_seo/api/logger.rb",
+    "lib/majestic_seo/api/response.rb",
+    "lib/majestic_seo/api/top_back_links_response.rb",
+    "lib/majestic_seo/extensions/string.rb",
+    "lib/majestic_seo/railtie.rb",
+    "lib/majestic_seo_api.rb",
+    "majestic_seo_api.gemspec",
+    "script/get_index_item_info.rb",
+    "script/get_top_backlinks.rb",
+    "script/open_app_get_index_item_info.rb",
+    "spec/majestic_seo/client_spec.rb",
+    "spec/majestic_seo/item_info_response_spec.rb",
+    "spec/majestic_seo/top_back_links_response_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://developer-support.majesticseo.com/connectors/"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Interface for communicating with Majestic SEO's 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<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday>, ["~> 0.7.6"])
+      s.add_runtime_dependency(%q<agiley-faraday_middleware>, ["~> 0.8.3"])
+      s.add_runtime_dependency(%q<jruby-openssl>, ["~> 0.7"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<faraday>, ["~> 0.7.6"])
+      s.add_dependency(%q<agiley-faraday_middleware>, ["~> 0.8.3"])
+      s.add_dependency(%q<jruby-openssl>, ["~> 0.7"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<faraday>, ["~> 0.7.6"])
+    s.add_dependency(%q<agiley-faraday_middleware>, ["~> 0.8.3"])
+    s.add_dependency(%q<jruby-openssl>, ["~> 0.7"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/script/get_index_item_info.rb

@@ -0,0 +1,137 @@
+
+=begin
+
+  Version 0.9.3
+
+  Copyright (c) 2011, Majestic-12 Ltd
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+  3. Neither the name of the Majestic-12 Ltd nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+=end
+
+# NOTE: The code below is specifically for the GetIndexItemInfo API command
+#       For other API commands, the arguments required may differ.
+#       Please refer to the Majestic SEO Developer Wiki for more information
+#       regarding other API commands and their arguments.
+
+
+# add the majestic seo api library to the search path
+Bundler.require if defined?(Bundler)
+require File.expand_path('../../lib/majestic_seo_api', __FILE__)
+
+environment = :production
+
+puts "\n****************************************************************************"
+
+puts "\nEnvironment: #{environment}"
+
+if (environment.eql?(:production))
+  puts "\nThis program is hard-wired to the Enterprise API."
+
+  puts "\nIf you do not have access to the Enterprise API, " +
+    "change the environment to: \n:sandbox."
+elsif (environment.eql?(:sandbox))
+  puts "\nThis program is hard-wired to the Developer API " +
+    "and hence the subset of data \nreturned will be substantially " +
+    "smaller than that which will be returned from \neither the " +
+    "Enterprise API or the Majestic SEO website."
+
+  puts "\nTo make this program use the Enterprise API, change " +
+    "the environment to: \n:production."
+end
+
+puts "\n***********************************************************" +
+  "*****************";
+
+puts "\n\nThis example program will return key information about \"index items\"." +
+     "\n\nThe following must be provided in order to run this program: " +
+     "\n1. API key \n2. List of items to query" +
+     "\n\nPlease enter your API key:\n"
+
+api_key = gets.chomp
+
+puts "\nPlease enter the list of items you wish to query seperated by " +
+     "commas: \n(e.g. majesticseo.com, majestic12.co.uk)\n"
+
+items_to_query = gets.chomp
+items = items_to_query.split(/,\s?/)
+
+client = MajesticSeo::Api::Client.new(api_key, environment)
+response = client.get_index_item_info(items, {:data_source => :fresh, :timeout => 5})
+
+if (response && response.success)
+  response.items.each_with_index do |item, index|
+    puts "\n Result: #{index+1}: \n"
+    
+    instance_variables = item.instance_variables
+    instance_variables.delete(:@response)
+    instance_variables.delete(:@mappings)
+    
+    instance_variables.each do |var|
+      puts " #{var.to_s.gsub("@", "")} ... #{item.instance_variable_get(var)}"
+    end
+    
+    puts "\n"
+  end if (response.items && response.items.any?)
+  
+  if (environment.eql?(:sandbox))
+    puts "\n\n***********************************************************" +
+      "*****************"
+
+    puts "\nEnvironment: #{environment}"
+
+    puts"\nThis program is hard-wired to the Developer API " +
+      "and hence the subset of data \nreturned will be substantially " +
+      "smaller than that which will be returned from \neither the " +
+      "Enterprise API or the Majestic SEO website."
+
+    puts "\nTo make this program use the Enterprise API, change " +
+      "the environment to: \n:production."
+
+    puts "\n***********************************************************" +
+      "*****************"
+  end
+  
+else
+  puts "\nERROR MESSAGE:"
+  puts response.error_message
+
+  puts "\n\n***********************************************************" +
+    "*****************"
+
+  puts "\nDebugging Info:"
+  puts "\n  Environment: \t#{environment}"
+  puts "  API Key: \t#{api_key}"
+
+  if(environment.eql?(:production))
+    puts "\n  Is this API Key valid for this Endpoint?"
+
+    puts "\n  This program is hard-wired to the Enterprise API."
+
+    puts "\n  If you do not have access to the Enterprise API, " +
+      "change the environment to: \n  :sandbox."
+  end
+
+  puts "\n****************************************************************************"
+end

data/script/get_top_backlinks.rb

@@ -0,0 +1,140 @@
+
+=begin
+
+  Version 0.9.3
+
+  Copyright (c) 2011, Majestic-12 Ltd
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+  1. Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+  3. Neither the name of the Majestic-12 Ltd nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL Majestic-12 Ltd BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+=end
+
+# NOTE: The code below is specifically for the GetTopBackLinks API command
+#       For other API commands, the arguments required may differ.
+#       Please refer to the Majestic SEO Developer Wiki for more information
+#       regarding other API commands and their arguments.
+
+
+# add the majesticseo-external-rpc library to the search path
+$: << File.expand_path(File.dirname(__FILE__));
+
+require 'majesticseo-external-rpc/api_service'
+
+endpoint = "http://enterprise.majesticseo.com/api_command";
+
+puts "\n***********************************************************" +
+  "*****************";
+
+puts "\nEndpoint: #{endpoint}";
+
+if("http://enterprise.majesticseo.com/api_command" == endpoint)
+  puts "\nThis program is hard-wired to the Enterprise API.";
+
+  puts "\nIf you do not have access to the Enterprise API, " +
+    "change the endpoint to: \nhttp://developer.majesticseo.com/api_command.";
+else
+  puts "\nThis program is hard-wired to the Developer API " +
+    "and hence the subset of data \nreturned will be substantially " +
+    "smaller than that which will be returned from \neither the " +
+    "Enterprise API or the Majestic SEO website.";
+
+  puts "\nTo make this program use the Enterprise API, change " +
+    "the endpoint to: \nhttp://enterprise.majesticseo.com/api_command.";
+end
+
+puts "\n***********************************************************" +
+  "*****************";
+
+puts "\n\nThis example program will return the top backlinks for any URL, domain " +
+     "\nor subdomain." +
+     "\n\nThe following must be provided in order to run this program: " +
+     "\n1. API key, \n2. A URL, domain or subdomain to query" +
+     "\n\nPlease enter your API key:\n";
+
+api_key = gets.chomp;
+
+puts "\nPlease enter a URL, domain or subdomain to query:\n";
+
+item_to_query = gets.chomp;
+
+# set up parameters
+parameters = Hash.new;
+parameters["MaxSourceURLs"] = "10";
+parameters["URL"] = item_to_query;
+parameters["GetUrlData"] = "1";
+parameters["MaxSourceURLsPerRefDomain"] = "1";
+parameters["datasource"] = "fresh";
+
+api_service = ApiService.new(api_key, endpoint);
+response = api_service.execute_command('GetTopBackLinks', parameters);
+
+# check the response code
+if(response.is_ok)
+  # print the URL table
+  results = response.table_for_name('URL');
+  results.rows.each do |row|
+    puts "\nURL: " + row['SourceURL']
+    puts "ACRank: " + row['ACRank']
+  end
+
+  if("http://developer.majesticseo.com/api_command" == endpoint)
+    puts "\n\n***********************************************************" +
+      "*****************";
+
+    puts "\nEndpoint: #{endpoint}";
+
+    puts"\nThis program is hard-wired to the Developer API " +
+      "and hence the subset of data \nreturned will be substantially " +
+      "smaller than that which will be returned from \neither the " +
+      "Enterprise API or the Majestic SEO website.";
+
+    puts "\nTo make this program use the Enterprise API, change " +
+      "the endpoint to: \nhttp://enterprise.majesticseo.com/api_command.";
+
+    puts "\n***********************************************************" +
+      "*****************";
+  end
+else
+  puts "\nERROR MESSAGE:";
+  puts response.error_message;
+
+  puts "\n\n***********************************************************" +
+    "*****************";
+
+  puts "\nDebugging Info:";
+  puts "\n  Endpoint: \t#{endpoint}";
+  puts "  API Key: \t#{api_key}";
+
+  if("http://enterprise.majesticseo.com/api_command" == endpoint)
+    puts "\n  Is this API Key valid for this Endpoint?";
+
+    puts "\n  This program is hard-wired to the Enterprise API.";
+
+    puts "\n  If you do not have access to the Enterprise API, " +
+      "change the endpoint to: \n  http://developer.majesticseo.com/api_command.";
+  end
+
+  puts "\n***********************************************************" +
+    "*****************";
+end