al_papi 0.0.11 → 0.0.12

data/README.md

@@ -0,0 +1,75 @@
+AuthorityLabs Partner API Gem
+=============================
+
+A wrapper around the Partner API calls. Allows post, priority post and get calls.
+
+* Github: http://github.com/mtchavez/al_papi
+
+## Install
+
+	gem install 'al_papi'
+
+## Usage
+	
+Make a request object using your api key:
+
+	require 'al_papi'
+
+	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
+
+### 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
+
+### GET
+
+When you are ready to get your results you can do a GET request for your keyword-engine-locale combo:
+	res = req.post 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
+
+### Engines
+
+Supported engines are Google, Yahoo and Bing. To get a list of supported engines run the following:
+
+	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'
+
+## License
+
+Written by Chavez
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

data/lib/al_papi/http.rb

@@ -1,6 +1,6 @@
 module AlPapi
 
-  class Http # :nodoc:all:
+  class Http # @private
 
     attr_accessor :errors, :response, :success, :config
 

data/lib/al_papi/request.rb

@@ -14,7 +14,7 @@ module AlPapi
       @success, @errors = false, []
     end
     
-    def http # :nodoc:
+    def http # @private
       Http.new(@config)
     end
     

data/lib/al_papi/request_error.rb

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

data/lib/al_papi/response.rb

@@ -4,7 +4,7 @@ module AlPapi
 
     attr_reader :success, :body, :errors, :code, :path, :params
 
-    def initialize(http, _code, _path, _params) # :nodoc:
+    def initialize(http, _code, _path, _params) # @private
       @success, @body, @errors = http.success, http.response, http.errors
       @code, @path, @params    = _code, _path, _params
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: al_papi
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-29 00:00:00.000000000 Z
+date: 2012-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70173415655640 !ruby/object:Gem::Requirement
+  requirement: &70322318185480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70173415655640
+  version_requirements: *70322318185480
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70173415655120 !ruby/object:Gem::Requirement
+  requirement: &70322318184620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,13 +32,13 @@ dependencies:
         version: '2.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70173415655120
+  version_requirements: *70322318184620
 description: Wraps AuthorityLabs Partner API calls in a gem.
 email: ''
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
 - lib/al_papi.rb
 - lib/al_papi/config.rb
@@ -48,12 +48,12 @@ files:
 - lib/al_papi/request_error.rb
 - lib/al_papi/request.rb
 - lib/al_papi/response.rb
-- README.rdoc
+- README.md
 homepage: http://github.com/mtchavez/al_papi
 licenses: []
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- --charset=UTF-8 --main=README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/README.rdoc

@@ -1,27 +0,0 @@
-= AuthorityLabs Partner API Gem
-
-A wrapper around the Partner API calls. Allows post, priority post and get calls.
-
-* Github: http://github.com/mtchavez/al_papi
-
-== Install:
-
-  gem install 'al_papi'
-
-== Usage:
-
-  require 'al_papi'
-
-  req = AlPapi::Request.new(api_key: 'yR43BtBDjadfavMy6a6aK0')
-  
-  req.post { :keyword => 'Centaurs', :locale => 'en-us', :engine => 'google' }
-  
-  req.get { :keyword => 'Centaurs', :locale => 'en-us', :engine => 'google' }
-  
-  req.priority_post { :keyword => 'Centaurs', :locale => 'en-us', :engine => 'google' }
-
-== License
-
-Written by Chavez
-
-Released under the MIT License: http://www.opensource.org/licenses/mit-license.php