majestic_seo_api 1.3.1 → 1.4.0

data/script/get_index_item_info.rb

@@ -1,137 +0,0 @@
-
-=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

@@ -1,140 +0,0 @@
-
-=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

data/script/open_app_get_index_item_info.rb

@@ -1,156 +0,0 @@
-
-=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 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 key information about \"index items\"." +
-     "\n\nThe following must be provided in order to run this program: " +
-	"\n1. OpenApp \"private key\"\n2. Access Token\n3. List of items to query" +
-     "\n\nPlease enter a valid OpenApp \"private key\":\n";
-
-private_key = gets.chomp;
-
-puts "\nEnter your user access token:\n";
-
-access_token = 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(/, /);
-
-# create a hash from the resulting array with the key being
-# "item0 => first item to query, item1 => second item to query" etc
-items_hash = Hash.new;
-0.upto(items.length-1) do |i|
-  items_hash["item" + i.to_s] = items[i];
-end
-
-# add the total number of items to the hash with the key being "items"
-items_hash['items'] = items.length.to_s;
-items_hash['datasource'] = 'fresh';
-
-api_service = ApiService.new(private_key, endpoint);
-response = api_service.execute_openapp_request('GetIndexItemInfo', items_hash, access_token);
-
-# check the response code
-if(response.is_ok)
-  # print the results table
-  results = response.table_for_name('Results');
-  results.rows.each do |row|
-    item = row['Item'];
-    puts "\n<#{item}>\n";
-
-    row.keys.sort.each do |key|
-      unless(key.eql?('Item'))
-        value = row[key];
-        puts " #{key} ... #{value}\n";
-      end
-    end
-  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:\n";
-  puts "Endpoint:\t#{endpoint}\n";
-  puts "OpenApp \"private key\":\t#{private_key}\n";
-  puts "Access token:\t#{access_token}\n";
-
-  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

data/spec/majestic_seo/client_spec.rb

@@ -1,74 +0,0 @@
-require File.expand_path('../../spec_helper', __FILE__)
-
-describe "Majestic Seo Api Client"  do
-  describe "initialization settings" do
-
-    describe "with defaults" do
-      before(:each) do
-        config = {"environment" =>  "sandbox", "api_key"  =>  "api_key"}
-        MajesticSeo::Api::Client.any_instance.expects(:config).at_least_once.returns(config)
-        @client = MajesticSeo::Api::Client.new
-      end
-
-      it "should contain a key" do
-      	@client.api_key.should == "api_key"
-      end
-
-      it "should have the environment set to sandbox" do
-      	@client.environment.should == :sandbox
-      end
-
-    end
-
-    describe "#get_index_item_info" do
-      it "should send a correct request" do
-        client = MajesticSeo::Api::Client.new
-
-        urls        =   ["google.com", "yahoo.com"]
-        parameters  =   {:data_source => :historic}
-        options     =   {:timeout     => 5}
-
-        expecting   =   {"datasource"     =>    :historic,
-                         "items"          =>    2,
-                         "item0"          =>    "google.com",
-                         "item1"          =>    "yahoo.com",
-                         "app_api_key"    =>    client.api_key,
-                         "cmd"            =>    "GetIndexItemInfo"
-                        }
-
-        client.expects(:execute_request).with(expecting, options)
-        response = client.get_index_item_info(urls, parameters, options)
-
-        #To test behind a proxy:
-        #response = client.get_index_item_info(urls, parameters, options.merge(:proxy => {:uri => URI('http://proxy.com:1234')}))
-      end
-    end
-
-    describe "#get_top_back_links" do
-      it "should send a correct request" do
-        client = MajesticSeo::Api::Client.new
-
-        url           =   "google.com"
-        parameters    =   {:data_source => :historic}
-        options       =   {:timeout     => 5}
-
-        expecting     = {"datasource"                 =>    :historic,
-                         "URL"                        =>    "google.com",
-                         "MaxSourceURLs"              =>    100,
-                         "ShowDomainInfo"             =>    0,
-                         "GetUrlData"                 =>    1,
-                         "GetSubDomainData"           =>    0,
-                         "GetRootDomainData"          =>    0,
-                         "MaxSourceURLsPerRefDomain"  =>    -1,
-                         "DebugForceQueue"            =>    0,
-                         "app_api_key"                =>    client.api_key,
-                         "cmd"                        =>    "GetTopBackLinks"}
-
-        client.expects(:execute_request).with(expecting, options)
-        response = client.get_top_back_links(url, parameters, options)
-      end
-    end
-
-  end
-end
-