semrush 3.0.5 → 3.0.6

data/README.rdoc

@@ -37,13 +37,18 @@ or
 
   keywords_data = report.keywords_organic
 
+If you want to know your remaining api units:
+
+  units = Semrush::Report.remaining_quota
+
+
 == Parameters
 
 You may use the following parameters:
 
-  :db         # (String) select the google engine ('us' for google.comn 'fr' for google.fr)
+  :db         # (String) select the google engine ('us' for google.com 'fr' for google.fr)
   :api_key    # (String) change the api_key
-  :limit      # (Integer) select only the first 'limit' entries
+  :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"
 
@@ -90,4 +95,4 @@ This gem is inspired by the work of Cramer Development for the semrush-client pl
 
 It has been rewritten and gemified for the internal use in Weboglobin (http://fr.weboglobin.com).
 
-This project rocks and uses MIT-LICENSE.
+This project rocks and uses MIT-LICENSE.

data/lib/semrush.rb

@@ -9,7 +9,7 @@ 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_UNITS_URL = "http://fr.semrush.com/users/countapiunits.html?key=%API_KEY%"
   mattr_accessor :api_key
   @@api_key = ""
   mattr_accessor :debug

data/lib/semrush/report.rb

@@ -59,6 +59,28 @@ module Semrush
       self.new(params.merge(:request_type => :url, :request => url))
     end
 
+    # Initializes & calls a report for the remaining API units
+    # Takes a hash parameter that may contain the following keys :
+    # * :api_key (ex: :api_key => 'gt97s6d4a6w')
+    def self.remaining_quota params = {}
+      temp_url = "#{API_UNITS_URL}" #do not copy the constant as is or else the constant would be modified !!
+      params = {:api_key => Semrush.api_key}.merge(params)
+      params.each {|k, v|
+        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'))
+        end
+      }
+      puts "[Semrush query] URL: #{temp_url}" if Semrush.debug
+      url = URI.parse(temp_url)
+      response = Net::HTTP.start(url.host, url.port) {|http|
+        http.get(url.path+"?"+url.query)
+      }.body rescue "ERROR :: RESPONSE ERROR (-1)" # Make this error up
+      response.force_encoding("utf-8")
+      response.starts_with?("ERROR") ? error(response) : response.to_i
+    end
+
     # Main report.
     # Available for a phrase or a domain.
     # Default columns for a domain:

data/lib/semrush/version.rb

@@ -1,3 +1,3 @@
 module Semrush
-  VERSION = "3.0.5" # we want to follow the API version: for API 3.0, the gem will be version 3.0.x
+  VERSION = "3.0.6" # 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.5
+  version: 3.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport