sistrix 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+gem 'nokogiri'
+gem 'rest-client', '>= 1.0'
+
+group :development do
+  gem "rspec", ">= 1.3.2"
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "simplecov", ">= 0"
+  gem "webmock", ">=1.8.6"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tobias Begalke
+
+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/README.rdoc

@@ -0,0 +1,59 @@
+= sistrix
+
+A ruby library for the Sistrix web API
+
+== How to use Sistrix
+
+Use RubyGems to install sistrix:
+
+  $ gem install elcamino-sistrix
+
+Require the library:
+
+  require 'rubygems'
+  require 'sistrix'
+
+Provide your API credentials:
+
+  Sistrix.config do |c|
+    c.api_key = YOUR_API_KEY
+  end
+
+Call individual functions, e.g.
+
+  data = Sistrix.domain(:domain => 'zeit.de')
+  sichtbarkeitsindex = Sistrix.domain_sichtbarkeitsindex(:domain => 'zeit.de')
+  number_of_pages = Sistrix.domain_pages(:domain => 'zeit.de')
+  pagerank = Sistrix.domain_pagerank(:domain => 'zeit.de')
+  age = Sistrix.domain_age(:domain => 'zeit.de')
+  seo_competitors = Sistrix.domain_competitors_seo(:domain => 'zeit.de')
+  sem_competitors = Sistrix.domain_competitors_sem(:domain => 'zeit.de')
+  us_competitors = Sistrix.domain_competitors_us(:domain => 'zeit.de')
+  kwcount_seo = Sistrix.domain_kwcount_seo(:domain => 'zeit.de')
+  kwcount_sem = Sistrix.domain_kwcount_sem(:domain => 'zeit.de')
+
+You can see all available methods in the rspec test files "spec/*_spec.rb"
+
+This library supports all available methods. Please refer to the
+documentation at http://www.sistrix.de/service/docs/api. The API
+method domain.overview can be called through
+Sistrix.domain_overview(). Replace the dot in the original method name
+by an underscore (_) and call the method statically on the Sistrix
+class.
+
+
+== Contributing to sistrix
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011-2012 Tobias Begalke. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "sistrix"
+  gem.homepage = "http://github.com/elcamino/sistrix"
+  gem.license = "MIT"
+  gem.summary = %Q{Sistrix web API library for ruby}
+  gem.description = %Q{A ruby libary for the Sistrix web API}
+  gem.email = "elcamino@spyz.org"
+  gem.authors = ["Tobias Begalke"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sistrix #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sistrix.rb

@@ -0,0 +1,28 @@
+module Sistrix
+  require 'sistrix/config'
+
+  SERVICE_HOST = 'api.sistrix.net'
+
+
+  def self.method_missing(sym, *args, &block)
+    clazz_name = 'Sistrix::' + sym.to_s.split(/_/).map { |w| w[0].upcase + w[1..w.length] }.join('::')
+    lib_name   = 'sistrix/' + sym.to_s.gsub(/_/, '/')
+    require lib_name
+
+    clazz = class_from_string(clazz_name)
+    return clazz.new(args[0]).call
+  end
+
+  protected
+
+  def self.class_from_string(str)
+    str.split('::').inject(Object) do |mod, class_name|
+      mod.const_get(class_name)
+    end
+  end
+
+  class ArgumentException < Exception
+  end
+
+end
+

data/lib/sistrix/base.rb

@@ -0,0 +1,23 @@
+module Sistrix
+  module Base
+    require 'rest-client'
+    require 'nokogiri'
+
+    def fetch(options = {})
+      @options.merge!(options)
+
+      response = RestClient.get(base_uri, { :params => @options })
+      Nokogiri::XML(response.to_s)
+    end
+
+    def method_name
+      # derive the method name from the class name
+      #
+      self.class.to_s.downcase.sub(/^.+?::/, '').gsub(/::/, '.')
+    end
+
+    def base_uri
+      'http://' + ::Sistrix::SERVICE_HOST + '/' + method_name
+    end
+  end
+end

data/lib/sistrix/config.rb

@@ -0,0 +1,15 @@
+require "singleton"
+
+module Sistrix
+  class Config
+    include Singleton
+    attr_accessor :api_key, :proxy
+  end
+
+  def self.config
+    if block_given?
+      yield Config.instance
+    end
+    Config.instance
+  end
+end

data/lib/sistrix/domain.rb

@@ -0,0 +1,60 @@
+module Sistrix
+
+  require 'sistrix/base'
+
+  class Domain
+    include ::Sistrix::Base
+
+    attr_reader :credits, :options
+
+    def initialize(options = {})
+      @options = {
+        'domain' => nil,
+        'api_key' => Sistrix.config.api_key,
+      }.merge(options)
+
+      if Sistrix.config.proxy
+        RestClient.proxy = Sistrix.config.proxy
+      end
+    end
+
+    def call(options = {})
+      data = fetch(options)
+
+      @credits = data.xpath('//credits').first['used'].to_i
+      @options = []
+      data.xpath('//answer/option').each do |o|
+        @options << Record.new(o)
+      end
+
+      self
+    end
+
+    class Record
+      require 'sistrix/record'
+      include ::Sistrix::Record
+
+      def method
+        @data[:method]
+      end
+
+      def url
+        @data[:url]
+      end
+
+      def name
+        @data[:name]
+      end
+
+      def initialize(xml_node)
+        @data = {}
+
+        @data[:method] = xml_node['method']
+        @data[:url] = xml_node['url']
+        @data[:name] = xml_node['name']
+      end
+    end
+
+  end
+
+end

data/lib/sistrix/domain/age.rb

@@ -0,0 +1,32 @@
+module Sistrix
+  require 'sistrix/base'
+
+  class Domain
+    class Age
+      include ::Sistrix::Base
+      attr_reader :credits, :age, :domain
+
+      def initialize(options = {})
+        @options = {
+          'domain' => nil,
+          'api_key' => Sistrix.config.api_key,
+        }.merge(options)
+
+        if Sistrix.config.proxy
+          RestClient.proxy = Sistrix.config.proxy
+        end
+      end
+
+      def call(options = {})
+        data = fetch(options)
+
+        @credits = data.xpath('//credits').first['used'].to_i
+        age_node = data.xpath('//answer/age').first
+        @age     = Time.parse(age_node['value'])
+        @domain  = age_node['domain']
+
+        self
+      end
+    end
+  end
+end

data/lib/sistrix/domain/competitors/sem.rb

@@ -0,0 +1,50 @@
+module Sistrix
+
+  require 'sistrix/base'
+
+  class Domain
+    class Competitors
+      class Sem
+        include ::Sistrix::Base
+
+        attr_reader :credits, :competitors
+
+        def initialize(options = {})
+          @options = {
+            'num'    => 5,
+            'domain' => nil,
+            'api_key' => Sistrix.config.api_key,
+          }.merge(options)
+
+          if Sistrix.config.proxy
+            RestClient.proxy = Sistrix.config.proxy
+          end
+        end
+
+        def call(options = {})
+          data = fetch(options)
+
+          @credits = data.xpath('//credits').first['used'].to_i
+          @competitors = []
+          data.xpath('//answer/result').each do |r|
+            @competitors << Record.new(r)
+          end
+
+          self
+        end
+
+        class Record
+          require 'sistrix/record'
+          include ::Sistrix::Record
+
+          def initialize(xml_node)
+            @data = {}
+
+            @data[:domain] = xml_node['domain'].strip
+            @data[:match] = xml_node['match'].strip.to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sistrix/domain/competitors/seo.rb

@@ -0,0 +1,52 @@
+module Sistrix
+
+  require 'sistrix/base'
+
+  class Domain
+    class Competitors
+      class Seo
+        include ::Sistrix::Base
+
+        attr_reader :credits, :competitors
+
+        def initialize(options = {})
+          @options = {
+            'num'    => 5,
+            'domain' => nil,
+            'api_key' => Sistrix.config.api_key,
+          }.merge(options)
+
+          if Sistrix.config.proxy
+            RestClient.proxy = Sistrix.config.proxy
+          end
+        end
+
+        def call(options = {})
+          data = fetch(options)
+
+          @credits = data.xpath('//credits').first['used'].to_i
+          @competitors = []
+          data.xpath('//answer/result').each do |r|
+            @competitors << Record.new(r)
+          end
+
+          self
+        end
+
+        class Record
+          require 'sistrix/record'
+          include ::Sistrix::Record
+
+          def initialize(xml_node)
+            @data = {}
+
+            @data[:domain] = xml_node['domain'].strip
+            @data[:match] = xml_node['match'].strip.to_i
+          end
+        end
+
+
+      end
+    end
+  end
+end

data/lib/sistrix/domain/competitors/us.rb

@@ -0,0 +1,53 @@
+module Sistrix
+
+  require 'sistrix/base'
+
+  class Domain
+    class Competitors
+      class Us
+        include ::Sistrix::Base
+
+        attr_reader :credits, :competitors
+
+        def initialize(options = {})
+          @options = {
+            'num'    => 5,
+            'domain' => nil,
+            'api_key' => Sistrix.config.api_key,
+          }.merge(options)
+
+          if Sistrix.config.proxy
+            RestClient.proxy = Sistrix.config.proxy
+          end
+        end
+
+        def call(options = {})
+          data = fetch(options)
+
+          @credits = data.xpath('//credits').first['used'].to_i
+          @competitors = []
+          data.xpath('//answer/result').each do |r|
+            @competitors << Record.new(r)
+          end
+
+          self
+        end
+
+        class Record
+          require 'sistrix/record'
+          include ::Sistrix::Record
+
+          def initialize(xml_node)
+            @data = {}
+
+            @data[:domain] = xml_node['domain'].strip
+            @data[:match] = xml_node['match'].strip.to_i
+          end
+        end
+
+
+      end
+
+    end
+  end
+end