al_papi 0.0.15 → 1.0.0

data/README.md

@@ -9,19 +9,62 @@ A wrapper around the Partner API calls. Allows post, priority post and get calls
 
     gem install 'al_papi'
 
-## Usage
+## Configuration
 
-Make a request object using your api key:
+Set configuration options to be used on requests:
 
     require 'al_papi'
 
-    req = AlPapi::Request.new(api_key: 'yR43BtBDjadfavMy6a6aK0')
+    AlPapi.configure do |config|
+      config.api_key = 'yR43BtBDjadfavMy6a6aK0'
+    end
+
+## Account
+
+Account endpoint lets you get basic info about your account, current queue times and any system messages.
+
+    # Pass your account ID into the info method
+    res = AlPapi::Account.info '1'
+    
+    # Response body will be JSON response
+    res.body
+    
+    # You can use the parsed_body method for convenience to access data
+    account_info = @res.parsed_body
+    account_info.user.current_balance # 500.00
+    account_info.queue.bing_time # 15
+    account_info.messages.system # ['The system is back online!']
+
+Example response in JSON
+
+    {
+        "messages": {
+            "system": ['The system is back online!']
+        }, 
+        "queue": {
+            "bing_time": 15, 
+            "google_time": 3, 
+            "yahoo_time": 2
+        }, 
+        "user": {
+            "current_balance": 500.00, 
+            "current_get_count": 2000, 
+            "current_post_count": 1000, 
+            "hourly_get_limit": 2000, 
+            "hourly_post_limit": 1000
+        }
+    }
+
+## Keywords
+
+Keywords endpoint allows you to POST keywords you want SERPs for and to GET those results
+when they are ready.
 
 ### POST
 
 Post your keyword-engine-locale combination to the API:
 
-    res = req.post keyword: "Centaur Love'n", engine: 'google', locale: 'en-us'
+    res = AlPapi::Keyword.post keyword: "Centaur Love'n", engine: 'google', locale: 'en-us'
 
     if res.success?
       p 'Centaur High Hoof'
@@ -33,7 +76,7 @@ Post your keyword-engine-locale combination to the API:
 
 Post your keyword to the priority queue if you need results in a more timely manner:
 
-    res = req.priority_post keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+    res = AlPapi::Keyword.priority_post keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
 
     if res.success?
       p 'Canadian Bing Scientist Time'
@@ -45,7 +88,7 @@ Post your keyword to the priority queue if you need results in a more timely man
 
 When you are ready to get your results you can do a GET request for your keyword-engine-locale combo:
 
-    res = req.get keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+    res = AlPapi::Keyword.get keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
 
     if res.success?
       p 'Canadian Bing Scientist Time'
@@ -82,6 +125,11 @@ When making an API request a response object is returned with any errors, http r
     # On GET requests the body will be a hash of your results if successful.
     res.body
 
+    # Parsed Body:
+    # Returns the parsed JSON body, if present, as a Hashie::Mash object.
+    # This can be useful to get an object with methods to call instead of
+    # indexing into nested hashes.
+
     # Code:
     # Returns http response code.
     # 204: On GET requests when no data is available yet
@@ -98,6 +146,30 @@ When making an API request a response object is returned with any errors, http r
     # Returns true or false if your account has been suspended
     res.suspended?
 
+## Web Insight
+
+### Description
+
+Web Insight queue takes a URL for the Partner API to scrape and parse out high level insight about the page
+and return the results to your callback URL passed in or set for your account.
+
+### POST
+
+Post the URL of the page you want to gain insight into and the callback URL knowing when your results are
+ready to get.
+
+    res = AlPapi::WebInsight.post url: 'http://www.qwiki.com', callback: 'http://your-callback-url.com'
+
+### GET
+
+When your results are ready to get you will receive a callback that contains the information on how
+to get the insight on your URL. In the callback you should receive a date_created and time_created to use
+in your get request. You will also use your original URL posted.
+
+    res = AlPapi::WebInsight.get url: 'http://www.qwiki.com', date_created: '2012-06-14', time_created: '01:50'
+
+## Extras
+
 ### Engines
 
 Supported engines are Google, Yahoo and Bing. To get a list of supported engines run the following:
@@ -109,9 +181,44 @@ Supported engines are Google, Yahoo and Bing. To get a list of supported engines
 Supported locales differ by the engine being used. In order to make sure you are using a supported locale
 for the engine you are posting a keyword to there is a locales class to help you:
 
-    AlPapi::Locales.supported # returns an array of locales for the default engine Google
-    AlPapi::Locales.supported 'bing' # for other engines pass in the engine name
-    AlPapi::Locales.supported 'yahoo'
+### Supported
+
+A way to see all the supported locales for a specified engine
+
+    AlPapi::Locales.supported # defaults to google
+
+Example response
+
+    {
+      engine: google
+      locales: {
+        ko-kr: {
+          description: Korea - Korean
+          tld: http://www.google.co.kr
+        },
+        ...
+        el-gr: {
+          description: Greece - Greek
+          tld: http://www.google.gr
+        }
+      }
+      supported: true
+    }
+
+### Description
+
+You can query the API to see if a specific locale is supported for an engine and get a description of that locale.
+
+    AlPapi::Locales.description 'google', 'ko-kr'
+
+Example response
+
+    {
+      locale: ko-kr
+      description: Korea - Korean
+      supported: true
+      engine: google
+    }
 
 ## License
 

data/lib/al_papi.rb

@@ -3,15 +3,39 @@ require 'rest-client'
 require 'net/http'
 require 'hashie'
 
-module AlPapi
-
-end
-
+require File.dirname(__FILE__) + '/al_papi/account'
 require File.dirname(__FILE__) + '/al_papi/config'
+require File.dirname(__FILE__) + '/al_papi/engines'
 require File.dirname(__FILE__) + '/al_papi/http'
-require File.dirname(__FILE__) + '/al_papi/request'
+require File.dirname(__FILE__) + '/al_papi/keyword'
+require File.dirname(__FILE__) + '/al_papi/locales'
 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'
 require File.dirname(__FILE__) + '/al_papi/web_insight'
+
+module AlPapi
+
+  extend self
+
+  ##
+  # @example Configure takes block to set API key to be used in API calls.
+  #    AlPapi.configure do |config|
+  #      config.api_key = 'my-key'
+  #    end
+
+  def configure
+    yield config
+  end
+
+  #
+  # @return [AlPapi::Config]
+
+  def config
+    @config ||= Config.new
+  end
+
+  def http # @private
+    Http.new(config)
+  end
+
+end

data/lib/al_papi/account.rb

@@ -0,0 +1,17 @@
+module AlPapi
+
+  class Account
+
+    ##
+    # Details for your account including hourly POST/GET limits, current queue times and current balance.
+    # Also includes any system messages posted about the API.
+    #
+    # @param account_id [String] *Required* - Your account ID in the Partner API
+
+    def self.info(account_id)
+      AlPapi.http.get "/account/#{account_id}"
+    end
+
+  end
+
+end

data/lib/al_papi/config.rb

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

data/lib/al_papi/engines.rb

@@ -2,8 +2,13 @@ module AlPapi
 
   class Engines
 
+    ##
+    # Supported engines for Partner API.
+    #
+    # @return [Array] Supported engines.
+
     def self.all
-      %w(google bing yahoo)
+      %w[google bing yahoo]
     end
 
   end

data/lib/al_papi/http.rb

@@ -16,10 +16,8 @@ module AlPapi
       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')
+    def build_params(params = {})
+      params.merge(:auth_token => @config.api_key, :format => 'json')
     end
 
     def request(http_verb, path, params = nil)

data/lib/al_papi/keyword.rb

@@ -0,0 +1,45 @@
+module AlPapi
+
+  class Keyword
+    
+    ##
+    #
+    # POST a keyword/engine/locale combination to get SERP for.
+    #
+    # @param keyword    [String] *Required* - The keyword you are ready to get results for.
+    # @param engine     [String] _Optional_ - Defaults to google
+    # @param locale     [String] _Optional_ - Defaults to en-us. See {AlPapi::Locales} for supported locales.
+    # @param pages_from [String] _Optional_ - Defaults is false. Google specific parameter to get results from locale passed in when set to true.
+    # @param callback   [String] _Optional_ - Default is the callback you have set for your account. Set specific callbacks per request by using this paramerter. A POST is sent to this callback URL when results are returned.
+
+    def self.post(params = {}, priority = false)
+      path = priority ? '/keywords/priority' : '/keywords'
+      AlPapi.http.post path, params
+    end
+    
+    ##
+    #
+    # See post method {AlPapi::Keyword.post} for required params
+    
+    def self.priority_post(params = {})
+      post params, true
+    end
+
+    ##
+    #
+    # Get SERP results for keyword already POSTed or in Partner API already.
+    # See parameters for what can be passed in.
+    #
+    # @param keyword     [String] *Required* - The keyword you are ready to get results for.
+    # @param engine      [String] _Optional_ - Defaults to google
+    # @param locale      [String] _Optional_ - Defaults to en-us. See {AlPapi::Locales} for supported locales.
+    # @param rank_date   [String] _Optional_ - Defaults to today UTC time. Format of YYY-MM-DD ie. 2011-12-28
+    # @param data_format [String] _Optional_ - Default is JSON. If you want raw html pass "html" in for data_format
+
+    def self.get(params = {})
+      AlPapi.http.get '/keywords/get', params
+    end
+
+  end
+  
+end

data/lib/al_papi/locales.rb

@@ -2,224 +2,23 @@ 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.
+    # Get supported locales for specified engine.
+    # @param engine [String] Defaults to google. Returns Partner API supported locales for engine or not supported message.
 
     def self.supported(engine = 'google')
-      return [] unless AlPapi::Engines.all.include?(engine.downcase)
-      self.const_get("#{engine.upcase}_LOCALES")
+      AlPapi.http.get "/supported/#{engine}"
+    end
+
+    ##
+    #
+    # Get further metadata on a specific locale for an engine.
+    # @param engine [String] Defaults to google.
+    # @param locale [String] Defaults to en-us.
+
+    def self.description(engine = 'google', locale = 'en-us')
+      AlPapi.http.get "/supported/#{engine}/#{locale.downcase}"
     end
 
   end

data/lib/al_papi/request_error.rb

@@ -3,7 +3,7 @@ module AlPapi
   class RequestError
 
     attr_reader :message, :code, :path, :params
-    
+
     def initialize(_message, _code, _path, _params) # @private
       @message, @code, @path, @params = _message, _code, _path, _params
     end

data/lib/al_papi/response.rb

@@ -4,6 +4,11 @@ module AlPapi
 
     attr_reader :success, :body, :errors, :code, :path, :params, :over_limit, :suspeneded
 
+    ##
+    # Initializing response object to be returned from API calls, used internally.
+    #
+    # @private
+
     def initialize(http, _code, _path, _params) # @private
       @success, @body, @errors = http.success, http.response, http.errors
       @over_limit, @suspended  = http.over_limit, http.suspended
@@ -13,25 +18,38 @@ module AlPapi
     ##
     #
     # Convenience method to determine if request was successfull or not
+    # @return [Boolean]
 
     def success?
-      return @success
+      !!@success
     end
 
     ##
     #
     # Convenience method to see if you have reached your hourly limit
+    # @return [Boolean]
 
     def over_limit?
-      return @over_limit
+      !!@over_limit
     end
 
     ##
     #
     # Convenience method to see if your account is supended
+    # @return [Boolean]
 
     def suspended?
-      return @suspended
+      !!@suspended
+    end
+
+    ##
+    #
+    # Parses JSON body of request and returns a Hashie::Mash
+    # @return [Hashie::Mash]
+
+    def parsed_body
+      hash = JSON.parse(@body) rescue {}
+      Hashie::Mash.new hash
     end
 
   end

data/lib/al_papi/web_insight.rb

@@ -2,64 +2,45 @@ module AlPapi
 
   class WebInsight
 
-    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 # @private
-      Http.new(@config)
-    end
-    
-    ##
-    # == Params
     #
     # URL for the page you want insight into and the callback url you have implemented to know
     # when results are ready to get.
     #
-    # [url]         <b>Required</b> - 
-    #               The web page you want to gain insight on.
-    # [callback]    <em>Required</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.
+    # @param url      [String] *Required* - The web page you want to gain insight on.
+    # @param callback [String] *Required* - Default is the callback you have set for your account. Set specific callbacks per request by using this paramerter. A POST is sent to this callback URL when results are returned.
+    # @raise [] When required parameter is not found.
 
-    def post(params = {}, priority = false)
+    def self.post(params = {})
       check_params Hashie::Mash.new(params), *%w[url callback]
-      http.post '/web/insight', params
+      AlPapi.http.post '/web/insight', params
     end
 
     ##
-    # == Params
     #
-    # Parameters should be the same url as what was posted to the Partner API and the 
+    # Parameters should be the same url as what was posted to the Partner API and the
     # date_created and time_created values passed back to you via the callback posted.
     #
-    # [url]            <b>Required</b> - 
-    #                  The URL originally posted to Partner API
-    # [date_created]   <em>Required</em> - 
-    #                  The date_created that was returned in the callback.
-    # [time_created]   <em>Required</em> - 
-    #                  The time_created that was returned in the callback.
+    # @param url          [String] *Required* - The URL originally posted to Partner API
+    # @param date_created [String] *Required* - The date_created that was returned in the callback.
+    # @param time_created [String] *Required* - The time_created that was returned in the callback.
 
-    def get(params = {})
+    def self.get(params = {})
       check_params Hashie::Mash.new(params), *%w[date_created time_created]
-      http.get '/web/insight', params
+      AlPapi.http.get '/web/insight', params
     end
 
-    def check_params(params, *param)
+    ##
+    #
+    # Check if required params exist
+    # @private
+
+    def self.check_params(params, *param)
       param.each do |p|
         raise "#{p} parameter is required." if params[p].nil? || params[p.to_s].empty?
       end
     end
 
   end
-  
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: al_papi
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-05 00:00:00.000000000 Z
+date: 2012-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70322796432540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70322796432540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70322796431940 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70322796431940
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70322796431440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,60 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70322796431440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.8.11
 description: Wraps AuthorityLabs Partner API calls in a gem.
 email: ''
 executables: []
@@ -51,15 +114,16 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- lib/al_papi.rb
+- lib/al_papi/account.rb
 - lib/al_papi/config.rb
 - lib/al_papi/engines.rb
 - lib/al_papi/http.rb
+- lib/al_papi/keyword.rb
 - lib/al_papi/locales.rb
 - lib/al_papi/request_error.rb
-- lib/al_papi/request.rb
 - lib/al_papi/response.rb
 - lib/al_papi/web_insight.rb
+- lib/al_papi.rb
 - README.md
 homepage: http://github.com/mtchavez/al_papi
 licenses: []
@@ -82,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: AuthorityLabs Partner API Wrapper

data/lib/al_papi/request.rb

@@ -1,75 +0,0 @@
-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 # @private
-      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