majesticseo 1.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 2011-04-09
+* 2 minor enhancements:
+  * Added installation message
+  * removed some deps
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/majesticseo.rb
+lib/majesticseo/client.rb
+lib/majesticseo/data_table.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_majesticseo.rb

data/PostInstall.txt

@@ -0,0 +1,4 @@
+Thanks for installing me.
+For more information, see http://humbuckercode.co.uk/licks/gems/majestic-seo/
+
+

data/README.rdoc

@@ -0,0 +1,57 @@
+= majesticseo
+
+* http://github.com/Achillefs/majesticseo
+
+== DESCRIPTION:
+
+A ruby-friendly interface to the Majestic SEO API.
+
+== FEATURES/PROBLEMS:
+
+* Data structures are returned as ruby objects. Majestic SEO responses are parsed into corresponding objects, allowing developers to access them as they would access any ruby object.
+
+== SYNOPSIS:
+
+  maj = Majesticseo::Client.new(:app_api_key => "BLAH")
+  maj.get_subscription_info
+  # GlobalVars works as an array or object
+  if maj.success?
+    puts maj.global_vars.max_bulk_backlinks_check
+  else
+    puts maj.response
+    puts maj.error_message
+  end
+
+== REQUIREMENTS:
+
+* activesupport >= 2.0.2
+* nokogiri >= 1.4.0
+
+== INSTALL:
+
+* sudo gem install majesticseo --no-ri --no-rdoc
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Achilles Charmpilas, Humbucker Ltd
+
+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/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+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']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/majesticseo.rb

@@ -0,0 +1,51 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+=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"
+
+module Majesticseo
+  VERSION = '1.0.1'
+  class NoMethodError < ArgumentError; end
+  class InvalidAPIKey < ArgumentError; end
+=begin rdoc
+  Very simple ostruct-based data struct
+=end
+  class Structure < OpenStruct
+    def [] key
+      send(key.underscore)
+    end
+  end
+  
+=begin rdoc
+  Structure respresenting one data row. Can be accessed either as a Ruby object, or as an array.
+  Object methods are underscored versions of the actual array element keys.
+  =Example
+    maj = Majesticseo::Client.new(:app_api_key => "APPKEYHASH")
+    maj.get_subscription_info
+    puts maj.data_tables.first.rows.first["IndexItemInfoResUnits"]
+    => 99992
+    puts maj.data_tables.first.rows.first.index_item_info_res_units
+    => 99992
+=end
+  class Row < Majesticseo::Structure; end
+
+=begin rdoc
+  Structure respresenting a response global vers element. Can be accessed either as a Ruby object, or as an array.
+  Object methods are underscored versions of the actual array element keys.
+  =Example
+    maj = Majesticseo::Client.new(:app_api_key => "APPKEYHASH")
+    maj.get_subscription_info
+    puts maj.global_vars["MaxBulkBacklinksCheck"]
+    => 120
+    puts maj.global_vars.max_bulk_backlinks_check
+    => 120
+=end
+  class GlobalVars < Majesticseo::Structure; end
+end
+%W[data_table client].each { |r| require "#{File.dirname(__FILE__)}/majesticseo/#{r}" } 

data/lib/majesticseo/client.rb

@@ -0,0 +1,72 @@
+module Majesticseo
+=begin rdoc
+  Please refer to the Majesticseo developer documentation for information regarding API methods: http://developer-support.Majesticseo.com/
+
+  =Example
+    maj = Majesticseo::Client.new(:app_api_key => "BLAH")
+    maj.get_subscription_info
+    if maj.success?
+      puts maj.global_vars.max_bulk_backlinks_check
+      => 120
+      puts maj.data_tables.first.rows.first.index_item_info_res_units
+      => 99992
+    else
+      puts maj.response
+      puts maj.error_message
+    end
+=end
+  class Client
+    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
+=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)
+      elsif defined?(RAILS_ENV)
+        @env = RAILS_ENV
+      elsif defined?(RACK_ENV)
+        @env = RACK_ENV
+      else
+        @env = "development"
+      end
+      @response = nil
+      @data_tables = []
+      @global_vars = nil
+      @uri = URI.parse("http://#{@env == "production" ? "enterprise" : "developer"}.Majesticseo.com/api_command")
+      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
+      @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")
+      @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")
+      parse_data if success?
+    end
+
+    def method_missing(m, *args)
+      call(m.to_s.camelize, args[0])
+    end
+
+    def parse_data
+      @data_tables = @response.search("DataTable").collect { |table| DataTable.create_from_xml(table) }
+    end
+
+    def success?
+      code == "OK" and error_message == ""
+    end
+  end
+end

data/lib/majesticseo/data_table.rb

@@ -0,0 +1,31 @@
+module Majesticseo
+  class DataTable
+    attr_accessor :name, :rows, :rows_count
+
+    def self.create_from_xml xml
+      table = DataTable.new
+      table.headers = xml.attr("Headers")
+      table.name = xml.attr("Name")
+      table.rows_count = xml.attr("RowsCount").to_i
+      table.rows = xml.search("Row").map do |r|
+        row = Row.new
+        data = r.content.split("|")
+        table.headers.each_index { |i| row.send("#{table.headers[i].underscore}=",data[i])} 
+        row
+      end
+      table
+    end
+
+    def headers= headers
+      if headers.is_a? String
+        @headers = headers.split("|")
+      else
+        @headers = headers
+      end
+    end
+
+    def headers
+      @headers ? @headers : []
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/majesticseo.rb'}"
+puts "Loading majesticseo gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/majesticseo'

data/test/test_majesticseo.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: majesticseo
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Achilles Charmpilas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/majesticseo.rb
+- lib/majesticseo/client.rb
+- lib/majesticseo/data_table.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_majesticseo.rb
+has_rdoc: true
+homepage: http://github.com/Achillefs/majesticseo
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: majesticseo
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A ruby-friendly interface to the Majestic SEO API.
+test_files: 
+- test/test_helper.rb
+- test/test_majesticseo.rb