al_papi 0.0.8 → 0.0.9

data/lib/al_papi/config.rb

@@ -0,0 +1,25 @@
+module AlPapi
+
+  class Config
+
+    DEFAULT_HOST = 'http://api.authoritylabs.com'
+    DEFAULT_PORT = 80
+
+    attr_accessor :api_key
+    attr_reader   :host, :port
+
+    ##
+    #
+    # == Options
+    #
+    # [auth_key]  Your Partner API api key. Required to make any API requests  
+
+    def initialize(options = {})
+      @api_key = options[:api_key]
+      @host    = DEFAULT_HOST
+      @port    = DEFAULT_PORT
+    end
+    
+  end
+
+end

data/lib/al_papi/engines.rb

@@ -0,0 +1,11 @@
+module AlPapi
+
+  class Engines
+
+    def self.all
+      %w(google bing yahoo)
+    end
+
+  end
+
+end

data/lib/al_papi/http.rb

@@ -0,0 +1,54 @@
+module AlPapi
+
+  class Http # :nodoc:all:
+
+    attr_accessor :errors, :response, :success, :config
+
+    def initialize(_config)
+      @config, @errors, @success = _config, [], false
+    end
+
+    def get(path, params = {})
+      request 'get', "#{path}?#{RestClient::Payload.generate(build_params(params))}"
+    end
+
+    def post(path, params = {})
+      request 'post', path, build_params(params)
+    end
+    
+    def build_params(params = nil)
+      return nil if params.empty?
+      return nil unless params.is_a?(Hash)
+      params.merge(auth_token: @config.api_key, format: 'json')
+    end
+
+    def request(http_verb, path, params = nil)
+      url  = "#{@config.host}#{path}"
+      args = http_verb == 'post' ? [http_verb, url, params] : [http_verb, url]
+
+      response = RestClient.send *args do |res, req, raw_res|
+        body = raw_res.body
+        code = raw_res.code.to_i
+
+        self.response = body
+        self.errors   = []
+
+        case code
+        when 200
+          self.response = JSON.parse body
+          self.success = true
+        when 204
+          self.errors << RequestError.new('No Content', code, path, params)
+        when 401
+          self.errors << RequestError.new('Invalid Auth Token Provided', code, path, params)
+        else
+          self.errors << RequestError.new(body, code, path, params)
+        end
+
+        Response.new(self, code, path, params)
+      end
+    end
+
+  end
+
+end

data/lib/al_papi/locales.rb

@@ -0,0 +1,227 @@
+module AlPapi
+
+  class Locales
+
+    GOOGLE_LOCALES = [
+      'af-za',
+      'ar-ae',
+      'ar-bh',
+      'ar-il',
+      'ar-qa',
+      'ar-sa',
+      'ar-tn',
+      'bg-bg',
+      'ca-ct',
+      'cs-cz',
+      'da-dk',
+      'de-at',
+      'de-be',
+      'de-ch',
+      'de-de',
+      'de-ro',
+      'el-gr',
+      'en-ae',
+      'en-au',
+      'en-be',
+      'en-bh',
+      'en-ca',
+      'en-hk',
+      'en-id',
+      'en-ie',
+      'en-il',
+      'en-in',
+      'en-mt',
+      'en-my',
+      'en-ng',
+      'en-nz',
+      'en-ph',
+      'en-sa',
+      'en-sg',
+      'en-th',
+      'en-tw',
+      'en-ua',
+      'en-uk',
+      'en-us',
+      'en-vn',
+      'en-qa',
+      'en-za',
+      'es-ar',
+      'es-cl',
+      'es-co',
+      'es-es',
+      'es-mx',
+      'es-pe',
+      'es-pr',
+      'es-us',
+      'es-ve',
+      'et-ee',
+      'fi-fl',
+      'fr-be',
+      'fr-ca',
+      'fr-ch',
+      'fr-fr',
+      'fr-tn',
+      'fr-vn',
+      'ga-ie',
+      'ha-ng',
+      'he-il',
+      'hi-in',
+      'hr-hr',
+      'hu-hu',
+      'hu-ro',
+      'id-id',
+      'ie-en',
+      'ig-ng',
+      'it-ch',
+      'it-it',
+      'ja-jp',
+      'jw-id',
+      'ko-kr',
+      'lt-lt',
+      'lt-lv',
+      'lv-lv',
+      'mi-nz',
+      'ms-my',
+      'ms-sg',
+      'mt-mt',
+      'nl-be',
+      'nl-nl',
+      'no-no',
+      'pl-pl',
+      'pt-br',
+      'pt-pt',
+      'rm-ch',
+      'ro-ro',
+      'ru-et',
+      'ru-lv',
+      'ru-ru',
+      'ru-ua',
+      'sl-si',
+      'sk-sk',
+      'sr-rs',
+      'sv-fi',
+      'sv-se',
+      'ta-sg',
+      'th-th',
+      'tl-ph',
+      'tr-tr',
+      'uk-ua',
+      'vi-vn',
+      'xh-za',
+      'yo-ng',
+      'zh-cn-hk',
+      'zh-hk-hk',
+      'zh-cn-sg',
+      'zh-cn-tw',
+      'zh-cn-vn',
+      'zh-tw-tw',
+      'zu-za'
+    ]
+    
+    YAHOO_LOCALES = [
+      'da-dk',
+      'de-at',
+      'de-ch',
+      'de-de',
+      'el-gr',
+      'en-au',
+      'en-ca',
+      'en-ie',
+      'en-in',
+      'en-my',
+      'en-nz',
+      'en-ph',
+      'en-sg',
+      'en-tw',
+      'en-uk',
+      'en-us',
+      'es-ar',
+      'es-cl',
+      'es-co',
+      'es-es',
+      'es-mx',
+      'es-pe',
+      'es-us',
+      'es-ve',
+      'fi-fl',
+      'fr-ca',
+      'fr-ch',
+      'fr-fr',
+      'id-id',
+      'it-ch',
+      'it-it',
+      'ja-jp',
+      'ko-kr',
+      'kr-kr',
+      'nl-nl',
+      'no-no',
+      'pt-br',
+      'ro-ro',
+      'ru-ru',
+      'sv-se',
+      'th-th',
+      'tr-tr',
+      'vi-vn',
+      'zh-cn',
+      'zh-cn-tw',
+      'zh-hk'
+    ]
+    
+    BING_LOCALES = [
+      'ar-sa',
+      'de-at',
+      'de-ch',
+      'de-de',
+      'da-dk',
+      'en-au',
+      'en-ca',
+      'en-ch',
+      'en-ie',
+      'en-in',
+      'en-nz',
+      'en-sa',
+      'en-sg',
+      'en-uk',
+      'en-us',
+      'es-ar',
+      'es-co',
+      'es-cl',
+      'es-es',
+      'es-mx',
+      'es-pe',
+      'es-us',
+      'es-ve',
+      'fr-ca',
+      'fr-ch',
+      'fr-fr',
+      'it-ch',
+      'it-it',
+      'ja-jp',
+      'ms-my',
+      'nl-be',
+      'nl-nl',
+      'no-no',
+      'pt-br',
+      'rm-ch',
+      'ru-ru',
+      'sv-se',
+      'tl-ph',
+      'vi-vn',
+      'zh-cn',
+      'zh-cn-tw',
+      'zh-hk'
+    ]
+    
+    ##
+    #
+    # [engine]  Defaults to google. Returns Partner API supported locales. 
+    #           Allowed engines are google, bing, yahoo.
+
+    def self.supported(engine = 'google')
+      return [] unless AlPapi::Engines.all.include?(engine.downcase)
+      self.const_get("#{engine.upcase}_LOCALES")
+    end
+
+  end
+
+end

data/lib/al_papi/request.rb

@@ -0,0 +1,75 @@
+module AlPapi
+
+  class Request
+
+    attr_reader   :config
+    
+    ##
+    # 
+    # [config]  * Hash { auth_key: 'your_auth_token' }
+    #           * OR AlPapi::Config
+
+    def initialize(config)
+      @config  = config.is_a?(AlPapi::Config) ? config : Config.new(config)
+      @success, @errors = false, []
+    end
+    
+    def http # :nodoc:
+      Http.new(@config)
+    end
+    
+    ##
+    # == Params
+    #
+    # [keyword]     <b>Required</b> - 
+    #               Your keyword you want to get results for
+    # [engine]      <em>Optional</em> - 
+    #               Defaults to google. Allowed engines are google, yahoo, bing.
+    # [locale]      <em>Optional</em> - 
+    #               Defaults to en-us. See AlPapi::Locales for supported locales.
+    # [pages_from]  <em>Optional</em> - 
+    #               Default is false. Google specific parameter to get results from
+    #               the locale passed in when set to true.
+    # [callback]    <em>Optional</em> - 
+    #               Default is set on your account through the website. 
+    #               Set specific callbacks here for each request. Callback a url that
+    #               is sent a POST when results are returned.
+
+    def post(params = {}, priority = false)
+      path = priority ? '/keywords/priority' : '/keywords'
+      http.post path, params
+    end
+    
+    ##
+    # == Params
+    #
+    # See post for required params
+    
+    def priority_post(params = {})
+      post params, true
+    end
+
+    ##
+    # == Params
+    #
+    # Parameters should be the same as what was posted to the Partner API where applies.
+    #
+    # [keyword]     <b>Required</b> - 
+    #               The keyword you are ready to get results for.
+    # [engine]      <em>Optional</em> - 
+    #               Defaults to google. Allowed engines are google, yahoo, bing.
+    # [locale]      <em>Optional</em> - 
+    #               Defaults to en-us. See AlPapi::Locales for supported locales.
+    # [rank_date]   <em>Optional</em> - 
+    #               Default is set to today UTC time.
+    #               Date should be in format of YYYY-MM-DD ie. 2011-12-28
+    # [data_format] <em>Optional</em> - 
+    #               Default is JSON. Options are HTML or JSON.
+
+    def get(params = {})
+      http.get '/keywords/get', params
+    end
+
+  end
+  
+end

data/lib/al_papi/request_error.rb

@@ -0,0 +1,13 @@
+module AlPapi
+
+  class RequestError
+
+    attr_reader :message, :code, :path, :params
+    
+    def initialize(_message, _code, _path, _params) # :nodoc:
+      @message, @code, @path, @params = _message, _code, _path, _params
+    end
+
+  end
+
+end

data/lib/al_papi/response.rb

@@ -0,0 +1,22 @@
+module AlPapi
+
+  class Response
+
+    attr_reader :success, :body, :errors, :code, :path, :params
+
+    def initialize(http, _code, _path, _params) # :nodoc:
+      @success, @body, @errors = http.success, http.response, http.errors
+      @code, @path, @params    = _code, _path, _params
+    end
+    
+    ##
+    #
+    # Convenience method to determine if request was successfull or not
+
+    def success?
+      return @success
+    end
+
+  end
+
+end

data/lib/al_papi.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'rest-client'
+require 'net/http'
+
+module AlPapi
+
+end
+
+require File.dirname(__FILE__) + '/al_papi/config'
+require File.dirname(__FILE__) + '/al_papi/http'
+require File.dirname(__FILE__) + '/al_papi/request'
+require File.dirname(__FILE__) + '/al_papi/request_error'
+require File.dirname(__FILE__) + '/al_papi/response'
+require File.dirname(__FILE__) + '/al_papi/locales'
+require File.dirname(__FILE__) + '/al_papi/engines'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: al_papi
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70345285697560 !ruby/object:Gem::Requirement
+  requirement: &70354144621020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70345285697560
+  version_requirements: *70354144621020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70345285697060 !ruby/object:Gem::Requirement
+  requirement: &70354144620500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70345285697060
+  version_requirements: *70354144620500
 description: Wraps AuthorityLabs Partner API calls in a gem.
 email: ''
 executables: []
@@ -40,6 +40,14 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- lib/al_papi.rb
+- lib/al_papi/config.rb
+- lib/al_papi/engines.rb
+- lib/al_papi/http.rb
+- lib/al_papi/locales.rb
+- lib/al_papi/request_error.rb
+- lib/al_papi/request.rb
+- lib/al_papi/response.rb
 - README.rdoc
 homepage: http://github.com/mtchavez/al_papi
 licenses: []