semrush 3.0.12 → 3.0.13

data/README.rdoc

@@ -56,6 +56,8 @@ You may use the following parameters:
   :limit      # (Integer) select only the first 'limit' entries (This parameter is required in order to avoid uncontrolled heavy usage)
   :offset     # (Integer) skip the first 'offset' entries
   :export_columns # (String) select the columns you want to fetch, for instance: :export_columns => "Dn,Rk"
+  :display_sort   # (String) select the column and the order you want to sort with, for instance: :display_sort => 'tr_asc'
+  :display_filter # (String) list of filters for the report, separated by '|' (maximum number - 25). A filter consists of <sign>|<field>|<operation>|<value> (read http://www.semrush.com/api), for instance: :display_filter => '+|Po|Lt|5'
 
 Some examples:
 
@@ -84,8 +86,8 @@ They are 3 sources for the reports: domain, url and phrase.
 You may call for one of the following report types:
 
   data = report.basics                          # main report for either a domain or a phrase
-  data = report.keywords_organic                # keywords organic report for either a domain or a URL
-  data = report.keywords_adwords                # keywords adwords report for either a domain or a URL
+  data = report.organic                         # organic report for either a domain, a URL or a phrase
+  data = report.adwords                         # adwords report for either a domain or a URL
   data = report.competitors_organic             # for a domain
   data = report.competitors_adwords             # for a domain
   data = report.competitors_organic_by_adwords  # for a domain
@@ -94,6 +96,42 @@ You may call for one of the following report types:
 
 For more information about the report types, please read http://www.semrush.com/api.html
 
+== ChangeLog
+
+=== 3.0.13, 2013-06-10
+
+* Add report type 'phrase_oganic'
+* Add parameter 'display_sort'
+* Add parameter 'display_filter'
+
+=== 3.0.12, 2013-05-31
+
+* Force parameter 'limit' > 0 to prevent limit=0
+
+=== 3.0.11, 2013-05-22
+
+* Fix parameters accessible through Semrush.before & Semrush.after
+
+=== 3.0.10, 2013-05-21
+
+* Fix remaining_quota (problem with redirections)
+
+=== 3.0.9, 2013-05-21
+
+* Add url in parameters accessible through Semrush.before & Semrush.after
+
+=== 3.0.8, 2013-05-21
+
+* Move after & before callbacks to Semrush module: Semrush.before & Semrush.after
+
+=== 3.0.7, 2013-05-21
+
+* Add after & before callbacks
+
+=== 3.0.6, 2013-05-7
+
+* Add method remaining_quota
+
 == About authors
 
 This gem is inspired by the work of Cramer Development for the semrush-client plugin (https://github.com/cramerdev/semrush-client).

data/Rakefile

@@ -21,7 +21,7 @@ require "rspec/core/rake_task"
 desc "Run all test with spec"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w[--color]
-  t.pattern = 'spec/*_spec.rb'
+  t.pattern = 'spec/**/*_spec.rb'
 end
 desc "Run tests"
 task :default => :spec

data/lib/semrush.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'cgi'
 require 'net/http'
 require 'csv'
 require 'rubygems'
@@ -8,7 +9,7 @@ require 'semrush/exception'
 require 'semrush/report'
 
 module Semrush
-  API_REPORT_URL = "http://%DB%.api.semrush.com/?action=report&type=%REPORT_TYPE%&%REQUEST_TYPE%=%REQUEST%&key=%API_KEY%&display_limit=%LIMIT%&display_offset=%OFFSET%&export=api&export_columns=%EXPORT_COLUMNS%"
+  API_REPORT_URL = "http://%DB%.api.semrush.com/?action=report&type=%REPORT_TYPE%&%REQUEST_TYPE%=%REQUEST%&key=%API_KEY%&display_limit=%LIMIT%&display_offset=%OFFSET%&export=api&export_columns=%EXPORT_COLUMNS%&display_sort=%DISPLAY_SORT%&display_filter=%DISPLAY_FILTER%"
   API_UNITS_URL = "http://www.semrush.com/users/countapiunits.html?key=%API_KEY%"
   mattr_accessor :api_key
   @@api_key = ""

data/lib/semrush/report.rb

@@ -9,7 +9,7 @@ module Semrush
   class Report
     DBS = [:us, :uk, :ru, :de, :fr, :es, :it, :br, :au] #"us" - for Google.com, "uk" - for Google.co.uk, "ru" - for Google.ru, "de" for Google.de, "fr" for Google.fr, "es" for Google.es, "it" for Google.it Beta, "br" for Google.com.br Beta, "au" for Google.com.au Beta.
     REPORT_TYPES = [:domain_rank, :domain_organic, :domain_adwords, :domain_organic_organic, :domain_adwords_adwords, :domain_organic_adwords, :domain_adwords_organic,
-                    :phrase_this, :phrase_related,
+                    :phrase_this, :phrase_organic, :phrase_related,
                     :url_organic, :url_adwords]
     REQUEST_TYPES = [:domain, :phrase, :url]
 
@@ -111,7 +111,7 @@ module Semrush
       domain? ? request(params.merge(:report_type => :domain_rank)) : request(params.merge(:report_type => :phrase_this))
     end
     
-    # Organic Keywords report
+    # Organic report
     # Can be called for a domain or a URL.
     # Default columns for a domain:
     # * Ph - The search query which the site has within the first 20 Google search results
@@ -135,11 +135,22 @@ module Semrush
     # * Tc - The ratio of the estimated cost of buying the same number of visitors for this search query to the estimated cost of purchasing the same number of targeted visitors coming to this URL
     # * Nr - The number of search results - how many pages does Google know for this query
     # * Td - Dynamics of change in the number of search queries in the past 12 months (estimated)
+    # Default columns for a phrase:
+    # * Dn - A site name
+    # * Ur - Target URL
+    def organic params = {}
+      case 
+      when url? then request(params.merge(:report_type => :url_organic))
+      when phrase? then request(params.merge(:report_type => :phrase_organic))
+      else request(params.merge(:report_type => :domain_organic))
+      end
+    end
     def keywords_organic params = {}
-      url? ? request(params.merge(:report_type => :url_organic)) : request(params.merge(:report_type => :domain_organic))
+      warn "[DEPRECATION] `keywords_organic` is deprecated.  Please use `organic` instead."
+      organic(params)
     end
 
-    # AdWords keywords report
+    # AdWords report
     # Can be called for a domain or a URL.
     # Default columns for a domain:
     # * Ph - Search query which the site buys in AdWords in Google
@@ -164,9 +175,13 @@ module Semrush
     # * Tc - The ratio of the estimated cost of buying the same number of visitors for this search query to the estimated cost of purchasing the same number of targeted visitors coming to this URL
     # * Nr - The number of search results - how many pages does Google know for this query
     # * Td - Dynamics of change in the number of search queries in the past 12 months (estimated)
-    def keywords_adwords params = {}
+    def adwords params = {}
       url? ? request(params.merge(:report_type => :url_adwords)) : request(params.merge(:report_type => :domain_adwords))
     end
+    def keywords_adwords params = {}
+      warn "[DEPRECATION] `keywords_adwords` is deprecated.  Please use `adwords` instead."
+      adwords(params)
+    end
 
     # Competitors in organic search report
     # Default columns:
@@ -237,7 +252,7 @@ module Semrush
         if v.blank?
           temp_url.gsub!(/&[^&=]+=%#{k.to_s}%/i, '')
         else
-          temp_url.gsub!("%#{k.to_s.upcase}%", URI.escape(v.to_s).gsub('&', '%26'))
+          temp_url.gsub!("%#{k.to_s.upcase}%", URI.escape(v.to_s).gsub('&', '%26').gsub('+', '%2B'))
         end
       }
       puts "[Semrush query] URL: #{temp_url}" if Semrush.debug
@@ -261,6 +276,8 @@ module Semrush
     # * limit - number of results returned
     # * offset - says to skip that many results before beginning to return results to you
     # * export_columns - list of column names, separated by coma. You may list just the column names you need in an order you need.
+    # * display_sort - a sorting as a String eg: 'am_asc' or 'am_desc'(read http://www.semrush.com/api) 
+    # * display_filter - list of filters separated by "|" (maximum number - 25). A filter consists of <sign>|<field>|<operation>|<value> (read http://www.semrush.com/api) 
     #
     # more details in http://www.semrush.com/api.html
     def validate_parameters params = {}
@@ -268,7 +285,7 @@ module Semrush
       params.delete(:db) unless DBS.include?(params[:db].try(:to_sym))
       params.delete(:report_type) unless REPORT_TYPES.include?(params[:report_type].try(:to_sym))
       params.delete(:request_type) unless REQUEST_TYPES.include?(params[:request_type].try(:to_sym))
-      @parameters = {:db => "us", :api_key => Semrush.api_key, :limit => "", :offset => "", :export_columns => ""}.merge(@parameters).merge(params)
+      @parameters = {:db => "us", :api_key => Semrush.api_key, :limit => "", :offset => "", :export_columns => "", :display_sort => "", :display_filter => ""}.merge(@parameters).merge(params)
       raise Semrush::Exception::Nolimit.new(self, "The limit parameter is missing: a limit is required.") unless @parameters[:limit].present? && @parameters[:limit].to_i>0
       raise Semrush::Exception::BadArgument.new(self, "Request parameter is missing: Domain name, URL, or keywords are required.") unless @parameters[:request].present?
       raise Semrush::Exception::BadArgument.new(self, "Bad db: #{@parameters[:db]}") unless DBS.include?(@parameters[:db].try(:to_sym))

data/lib/semrush/version.rb

@@ -1,3 +1,3 @@
 module Semrush
-  VERSION = "3.0.12" # we want to follow the API version: for API 3.0, the gem will be version 3.0.x
+  VERSION = "3.0.13" # we want to follow the API version: for API 3.0, the gem will be version 3.0.x
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semrush
 version: !ruby/object:Gem::Version
-  version: 3.0.12
+  version: 3.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport