al_papi 0.0.14 → 0.0.15

data/README.md

@@ -7,111 +7,111 @@ A wrapper around the Partner API calls. Allows post, priority post and get calls
 
 ## Install
 
-	gem install 'al_papi'
+    gem install 'al_papi'
 
 ## Usage
-	
+
 Make a request object using your api key:
 
-	require 'al_papi'
+    require 'al_papi'
 
-	req = AlPapi::Request.new(api_key: 'yR43BtBDjadfavMy6a6aK0')
+    req = AlPapi::Request.new(api_key: 'yR43BtBDjadfavMy6a6aK0')
 
 ### POST
-	
+
 Post your keyword-engine-locale combination to the API:
 
-	res = req.post keyword: "Centaur Love'n", engine: 'google', locale: 'en-us'
-		
-	if res.success?
-		p 'Centaur High Hoof'
-	else
-		p 'PAPI Fail'
-	end
+    res = req.post keyword: "Centaur Love'n", engine: 'google', locale: 'en-us'
+
+    if res.success?
+      p 'Centaur High Hoof'
+    else
+      p 'PAPI Fail'
+    end
 
 ### Priority POST
-	
+
 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'
-		
-	if res.success?
-		p 'Canadian Bing Scientist Time'
-	else
-		p 'PAPI Fail'
-	end
+    res = req.priority_post keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+
+    if res.success?
+      p 'Canadian Bing Scientist Time'
+    else
+      p 'PAPI Fail'
+    end
 
 ### GET
 
 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'
-		
-	if res.success?
-		p 'Canadian Bing Scientist Time'
-		res.body # Hash of your results for that keyword-engine-locale
-	else
-		p 'PAPI Fail'
-	end
+
+    res = req.get keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+
+    if res.success?
+      p 'Canadian Bing Scientist Time'
+      res.body # Hash of your results for that keyword-engine-locale
+    else
+      p 'PAPI Fail'
+    end
 
 ### Response
 
 When making an API request a response object is returned with any errors, http response code and http reponse body.
 
-	res = req.get keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
-	
-	# Errors:
-	# Returns an array of error objects.
-	res.errors
-	
-	if res.errors.present?
-		res.errors.each do |error|
-			p error.code			# http repsonse code
-			p error.message		# error message
-			p error.params		# params of request
-			p error.path			# path of request
-		end
-	end
-	
-	# Success:
-	# Returns true or false if request was successful or not.
-	res.success?
-	
-	# Body:
-	# Returns body of response.
-	# On GET requests the body will be a hash of your results if successful.
-	res.body
-	
-	# Code:
-	# Returns http response code.
-	# 204: On GET requests when no data is available yet
-	# 200: Successful
-	# 401: Invalid api key
-	# 500: Server Error
-	res.code
-	
-	# Over Limit:
-	# Returns true or false if over hourly limit
-	res.over_limit?
-	
-	# Suspended:
-	# Returns true or false if your account has been suspended
-	res.over_limit?
-	
+    res = req.get keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+
+    # Errors:
+    # Returns an array of error objects.
+    res.errors
+
+    if res.errors.present?
+      res.errors.each do |error|
+        p error.code      # http repsonse code
+        p error.message   # error message
+        p error.params    # params of request
+        p error.path      # path of request
+      end
+    end
+
+    # Success:
+    # Returns true or false if request was successful or not.
+    res.success?
+
+    # Body:
+    # Returns body of response.
+    # On GET requests the body will be a hash of your results if successful.
+    res.body
+
+    # Code:
+    # Returns http response code.
+    # 204: On GET requests when no data is available yet
+    # 200: Successful
+    # 401: Invalid api key
+    # 500: Server Error
+    res.code
+
+    # Over Limit:
+    # Returns true or false if over hourly limit
+    res.over_limit?
+
+    # Suspended:
+    # Returns true or false if your account has been suspended
+    res.suspended?
+
 ### Engines
 
 Supported engines are Google, Yahoo and Bing. To get a list of supported engines run the following:
 
-	AlPapi::Engines.all
-	
+    AlPapi::Engines.all
+
 ### Locales
 
 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'
+    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'
 
 ## License
 

data/lib/al_papi/web_insight.rb

@@ -0,0 +1,65 @@
+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.
+
+    def post(params = {}, priority = false)
+      check_params Hashie::Mash.new(params), *%w[url callback]
+      http.post '/web/insight', params
+    end
+
+    ##
+    # == Params
+    #
+    # 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.
+
+    def get(params = {})
+      check_params Hashie::Mash.new(params), *%w[date_created time_created]
+      http.get '/web/insight', params
+    end
+
+    def 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

data/lib/al_papi.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'rest-client'
 require 'net/http'
+require 'hashie'
 
 module AlPapi
 
@@ -13,3 +14,4 @@ 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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: al_papi
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70208320860320 !ruby/object:Gem::Requirement
+  requirement: &70322796432540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70208320860320
+  version_requirements: *70322796432540
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70208320859520 !ruby/object:Gem::Requirement
+  name: hashie
+  requirement: &70322796431940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,18 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70208320859520
+  version_requirements: *70322796431940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70322796431440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70322796431440
 description: Wraps AuthorityLabs Partner API calls in a gem.
 email: ''
 executables: []
@@ -48,6 +59,7 @@ files:
 - lib/al_papi/request_error.rb
 - lib/al_papi/request.rb
 - lib/al_papi/response.rb
+- lib/al_papi/web_insight.rb
 - README.md
 homepage: http://github.com/mtchavez/al_papi
 licenses: []
@@ -70,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: AuthorityLabs Partner API Wrapper