al_papi 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f94f272af2e8d0822dc70cd7d1b581b1bd06634d
-  data.tar.gz: c54796aa7be95b01098df4debd8b717a10caa84a
+  metadata.gz: 7a47ff1544d5b8ec96e73041252b8a2b78d9eab7
+  data.tar.gz: 548aedb6dbe56473a9ba120c7ace7725552836c1
 SHA512:
-  metadata.gz: 7856c8183a2cbc513dba37e98196eda31f845a54bd7311d1b6945616201b565eeee1ef6f6385deadf784ec926333fbc94b11a300019bbb4a1b00d6eed004fd2d
-  data.tar.gz: a04e5850d2e157cbd3abad145417032aa6a538ba6cdd9394ce5d9ee062d68f42983e502285751dfbd1f9450605fed977b19c4f6d83c2c6889d34ae06188ae906
+  metadata.gz: ad6c92cac8048b42d9df3c3680a72042dd593eff8aa9356a4178d3482423aaff00eb2c028d816a0f103a8e445b392232d1a4f8b98eb2e9fd2f6375280a157708
+  data.tar.gz: 2553763ba2ee05ac78e400b3486942e1a9711962ce1b22e82eda00d4c23599a1ab000423ee0b4da101a83ff31ff57342b76a918ac8d9c3969e1f837275b452a2

data/README.md

@@ -1,15 +1,17 @@
-AuthorityLabs Partner API Gem
-=============================
+# AuthorityLabs Partner API Gem
 
-A wrapper around the Partner API calls. Allows post, priority post and get calls.
+[![Latest Version](http://img.shields.io/github/release/mtchavez/skiplist.svg?style=flat-square)](https://github.com/mtchavez/al_papi/releases)
+[![Build Status](https://secure.travis-ci.org/mtchavez/al_papi.png)](http://travis-ci.org/mtchavez/al_papi?branch=master)
+[![Coverage Status](https://coveralls.io/repos/mtchavez/al_papi/badge.png?branch=update%2Fdependencies)](https://coveralls.io/r/mtchavez/al_papi?branch=update%2Fdependencies)
+[![Code Climate](https://codeclimate.com/github/mtchavez/al_papi.png)](https://codeclimate.com/github/mtchavez/al_papi)
 
-* Github: http://github.com/mtchavez/al_papi
-* [![Build Status](https://secure.travis-ci.org/mtchavez/al_papi.png)](http://travis-ci.org/mtchavez/al_papi?branch=master)
-* [![Code Climate](https://codeclimate.com/github/mtchavez/al_papi.png)](https://codeclimate.com/github/mtchavez/al_papi)
+A wrapper around the Partner API calls. Allows post, priority post and get calls.
 
 ## Install
 
-    gem install 'al_papi'
+```ruby
+gem install 'al_papi'
+```
 
 ## Configuration
 
@@ -35,7 +37,7 @@ res = AlPapi::Account.info '1'
 res.body
 
 # You can use the parsed_body method for convenience to access data
-account_info = @res.parsed_body
+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!']
@@ -249,9 +251,3 @@ Example response
   engine: google
 }
 ```
-
-## License
-
-Written by Chavez
-
-Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

data/lib/al_papi.rb

@@ -13,9 +13,12 @@ require File.dirname(__FILE__) + '/al_papi/request_error'
 require File.dirname(__FILE__) + '/al_papi/response'
 require File.dirname(__FILE__) + '/al_papi/web_insight'
 
-module AlPapi
+def ruby_19?
+  RUBY_VERSION == '1.9.3'
+end
 
-  extend self
+module AlPapi
+  module_function unless ruby_19?
 
   ##
   # @example Configure takes block to set API key to be used in API calls.
@@ -26,6 +29,7 @@ module AlPapi
   def configure
     yield config
   end
+  module_function :configure if ruby_19?
 
   #
   # @return [AlPapi::Config]
@@ -33,9 +37,10 @@ module AlPapi
   def config
     @config ||= Config.new
   end
+  module_function :config if ruby_19?
 
   def http # @private
     Http.new(config)
   end
-
+  module_function :http if ruby_19?
 end

data/lib/al_papi/account.rb

@@ -1,7 +1,5 @@
 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.
@@ -11,7 +9,5 @@ module AlPapi
     def self.info(account_id)
       AlPapi.http.get "/account/#{account_id}"
     end
-
   end
-
 end

data/lib/al_papi/config.rb

@@ -1,17 +1,15 @@
 module AlPapi
-
   ##
   #
   # Config class used internally.
   # Configure API calls using AlPapi.configure
 
   class Config
-
     DEFAULT_HOST = 'http://api.authoritylabs.com'
     DEFAULT_PORT = 80 # @private
 
     attr_accessor :api_key
-    attr_reader   :host, :port # @private
+    attr_reader :host, :port # @private
 
     ##
     #
@@ -21,7 +19,5 @@ module AlPapi
       @host = DEFAULT_HOST
       @port = DEFAULT_PORT
     end
-    
   end
-
 end

data/lib/al_papi/engines.rb

@@ -1,7 +1,5 @@
 module AlPapi
-
   class Engines
-
     ##
     # Supported engines for Partner API.
     #
@@ -10,7 +8,5 @@ module AlPapi
     def self.all
       %w[google bing yahoo]
     end
-
   end
-
 end

data/lib/al_papi/http.rb

@@ -1,11 +1,10 @@
 module AlPapi
-
   class Http # @private
-
+    HANDLED_CODES = [200, 204, 401, 403]
     attr_accessor :errors, :response, :success, :config, :over_limit, :suspended
 
-    def initialize(_config)
-      @config, @errors, @success, @over_limit, @suspended = _config, [], false, false, false
+    def initialize(config)
+      @config, @errors, @success, @over_limit, @suspended = config, [], false, false, false
     end
 
     def get(path, params = {})
@@ -17,7 +16,7 @@ module AlPapi
     end
 
     def build_params(params = {})
-      params.merge(:auth_token => @config.api_key, :format => 'json')
+      params.merge(auth_token: @config.api_key, format: 'json')
     end
 
     def request(http_verb, path, params = nil)
@@ -25,41 +24,50 @@ module AlPapi
       args = [http_verb, url]
       args << params if http_verb == 'post'
 
-      RestClient.send(*args) do |res, req, raw_res|
-        body = raw_res.body
-        code = raw_res.code.to_i
+      RestClient.send(*args) do |res|
+        body = res.body
+        code = res.code.to_i
 
         self.response = body
         self.errors   = []
 
-        case code
-        when 200
-          begin
-            JSON.parse body
-          rescue JSON::ParserError
-            self.response = body
-          end
-          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)
-        when 403
-          if body.match(/Account Suspended/i)
-            self.suspended = true
-            self.errors << RequestError.new('Account Suspended', code, path, params)
-          elsif body.match(/Request Limit Exceeded/i)
-            self.over_limit = true
-            self.errors << RequestError.new('Request Limit Exceeded', code, path, params)
-          end
+        if HANDLED_CODES.include?(code)
+          send "handle_#{code}", body, code, path, params
         else
-          self.errors << RequestError.new(body, code, path, params)
+          errors << RequestError.new(body, code, path, params)
         end
 
         Response.new(self, code, path, params)
       end
     end
 
-  end
+    def handle_200(body, _code, _path, _params)
+      # Check valid JSON body.
+      # API returns 'OK' in some cases where response has no
+      # meaningful body, which is invalid JSON, so let it be
+      # a successfull call
+      JSON.parse body unless body == 'OK'
+      self.success = true
+    rescue JSON::ParserError
+      self.response = body
+    end
+
+    def handle_204(_body, code, path, params)
+      errors << RequestError.new('No Content', code, path, params)
+    end
 
+    def handle_401(_body, code, path, params)
+      errors << RequestError.new('Invalid Auth Token Provided', code, path, params)
+    end
+
+    def handle_403(body, code, path, params)
+      if body.match(/Account Suspended/i)
+        self.suspended = true
+        errors << RequestError.new('Account Suspended', code, path, params)
+      elsif body.match(/Request Limit Exceeded/i)
+        self.over_limit = true
+        errors << RequestError.new('Request Limit Exceeded', code, path, params)
+      end
+    end
+  end
 end

data/lib/al_papi/keyword.rb

@@ -1,7 +1,5 @@
 module AlPapi
-
   class Keyword
-    
     ##
     #
     # POST a keyword/engine/locale combination to get SERP for.
@@ -9,18 +7,21 @@ module AlPapi
     # @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.
+    # @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
@@ -39,7 +40,5 @@ module AlPapi
     def self.get(params = {})
       AlPapi.http.get '/keywords/get', params
     end
-
   end
-  
 end

data/lib/al_papi/locales.rb

@@ -1,11 +1,10 @@
 module AlPapi
-
   class Locales
-
     ##
     #
     # Get supported locales for specified engine.
-    # @param engine [String] Defaults to google. Returns Partner API supported locales for engine or not supported message.
+    # @param engine [String] Defaults to google. Returns Partner API supported
+    #                        locales for engine or not supported message.
 
     def self.supported(engine = 'google')
       AlPapi.http.get "/supported/#{engine}"
@@ -20,7 +19,5 @@ module AlPapi
     def self.description(engine = 'google', locale = 'en-us')
       AlPapi.http.get "/supported/#{engine}/#{locale.downcase}"
     end
-
   end
-
 end

data/lib/al_papi/request_error.rb

@@ -1,13 +1,9 @@
 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
+    def initialize(message, code, path, params) # @private
+      @message, @code, @path, @params = message, code, path, params
     end
-
   end
-
 end

data/lib/al_papi/response.rb

@@ -1,7 +1,5 @@
 module AlPapi
-
   class Response
-
     attr_reader :success, :body, :errors, :code, :path, :params, :over_limit, :suspeneded
 
     ##
@@ -9,19 +7,19 @@ module AlPapi
     #
     # @private
 
-    def initialize(http, _code, _path, _params) # @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
-      @code, @path, @params    = _code, _path, _params
+      @code, @path, @params    = code, path, params
     end
-    
+
     ##
     #
     # Convenience method to determine if request was successfull or not
     # @return [Boolean]
 
     def success?
-      !!@success
+      @success ? true : false
     end
 
     ##
@@ -30,7 +28,7 @@ module AlPapi
     # @return [Boolean]
 
     def over_limit?
-      !!@over_limit
+      @over_limit ? true : false
     end
 
     ##
@@ -39,7 +37,7 @@ module AlPapi
     # @return [Boolean]
 
     def suspended?
-      !!@suspended
+      @suspended ? true : false
     end
 
     ##
@@ -48,10 +46,10 @@ module AlPapi
     # @return [Hashie::Mash]
 
     def parsed_body
-      hash = JSON.parse(@body) rescue {}
+      hash = JSON.parse(@body)
       Hashie::Mash.new hash
+    rescue
+      {}
     end
-
   end
-
 end

data/lib/al_papi/web_insight.rb

@@ -1,7 +1,5 @@
 module AlPapi
-
   class WebInsight
-
     ENDPOINT = '/web/insight'
 
     ##
@@ -10,7 +8,10 @@ module AlPapi
     # when results are ready to get.
     #
     # @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.
+    # @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 self.post(params = {})
@@ -32,8 +33,6 @@ module AlPapi
       request 'get', params
     end
 
-  private
-
     ##
     #
     # Check if required params exist
@@ -41,14 +40,12 @@ module AlPapi
 
     def self.check_params(params, *param)
       param.each do |p|
-        raise "#{p} parameter is required." if params[p].nil? || params[p.to_s].empty?
+        fail "#{p} parameter is required." if params[p].nil? || params[p.to_s].empty?
       end
     end
 
     def self.request(method, params = {})
       AlPapi.http.send method, ENDPOINT, params
     end
-
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: al_papi
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Chavez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -76,160 +76,160 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.12.6
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.12
+        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.12.6
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.4.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: '2.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: 2.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: '2.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: 2.9.3
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.11
+        version: '1.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.11
+        version: 1.20.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.11
+        version: '1.20'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.11
+        version: 1.20.4
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: 0.8.7.6
 description: Wraps AuthorityLabs Partner API calls in a gem.
 email: ''
 executables: []
@@ -273,4 +273,3 @@ signing_key:
 specification_version: 4
 summary: AuthorityLabs Partner API Wrapper
 test_files: []
-has_rdoc: