al_papi 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f94f272af2e8d0822dc70cd7d1b581b1bd06634d
+  data.tar.gz: c54796aa7be95b01098df4debd8b717a10caa84a
+SHA512:
+  metadata.gz: 7856c8183a2cbc513dba37e98196eda31f845a54bd7311d1b6945616201b565eeee1ef6f6385deadf784ec926333fbc94b11a300019bbb4a1b00d6eed004fd2d
+  data.tar.gz: a04e5850d2e157cbd3abad145417032aa6a538ba6cdd9394ce5d9ee062d68f42983e502285751dfbd1f9450605fed977b19c4f6d83c2c6889d34ae06188ae906

data/README.md

@@ -1,9 +1,11 @@
-AuthorityLabs Partner API Gem [![Build Status](https://secure.travis-ci.org/mtchavez/al_papi.png)](http://travis-ci.org/mtchavez/al_papi?branch=master)
+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
+* [![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)
 
 ## Install
 
@@ -13,47 +15,53 @@ A wrapper around the Partner API calls. Allows post, priority post and get calls
 
 Set configuration options to be used on requests:
 
-    require 'al_papi'
+```ruby
+require 'al_papi'
 
-    AlPapi.configure do |config|
-      config.api_key = 'yR43BtBDjadfavMy6a6aK0'
-    end
+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!']
+```ruby
+# 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
-        }
+```javascript
+{
+    "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
 
@@ -64,87 +72,95 @@ when they are ready.
 
 Post your keyword-engine-locale combination to the API:
 
-    res = AlPapi::Keyword.post keyword: "Centaur Love'n", engine: 'google', locale: 'en-us'
+```ruby
+res = AlPapi::Keyword.post keyword: "Centaur Love'n", engine: 'google', locale: 'en-us'
 
-    if res.success?
-      p 'Centaur High Hoof'
-    else
-      p 'PAPI Fail'
-    end
+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 = AlPapi::Keyword.priority_post keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+```ruby
+res = AlPapi::Keyword.priority_post keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
 
-    if res.success?
-      p 'Canadian Bing Scientist Time'
-    else
-      p 'PAPI Fail'
-    end
+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 = AlPapi::Keyword.get keyword: "Mad Scientist", engine: 'bing', locale: 'en-ca'
+```ruby
+res = AlPapi::Keyword.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
+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
-
-    # 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
-    # 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?
+```ruby
+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
+
+# 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
+# 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?
+```
 
 ## Web Insight
 
@@ -158,7 +174,9 @@ and return the results to your callback URL passed in or set for your account.
 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'
+```ruby
+res = AlPapi::WebInsight.post url: 'http://www.qwiki.com', callback: 'http://your-callback-url.com'
+```
 
 ### GET
 
@@ -166,7 +184,9 @@ When your results are ready to get you will receive a callback that contains the
 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'
+```ruby
+res = AlPapi::WebInsight.get url: 'http://www.qwiki.com', date_created: '2012-06-14', time_created: '01:50'
+```
 
 ## Extras
 
@@ -174,7 +194,9 @@ in your get request. You will also use your original URL posted.
 
 Supported engines are Google, Yahoo and Bing. To get a list of supported engines run the following:
 
-    AlPapi::Engines.all
+```ruby
+AlPapi::Engines.all
+```
 
 ### Locales
 
@@ -185,40 +207,48 @@ for the engine you are posting a keyword to there is a locales class to help you
 
 A way to see all the supported locales for a specified engine
 
-    AlPapi::Locales.supported # defaults to google
+```ruby
+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
+```javascript
+{
+  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'
+```ruby
+AlPapi::Locales.description 'google', 'ko-kr'
+```
 
 Example response
 
-    {
-      locale: ko-kr
-      description: Korea - Korean
-      supported: true
-      engine: google
-    }
+```javascript
+{
+  locale: ko-kr
+  description: Korea - Korean
+  supported: true
+  engine: google
+}
+```
 
 ## License
 

data/lib/al_papi/http.rb

@@ -15,16 +15,17 @@ module AlPapi
     def post(path, params = {})
       request 'post', path, build_params(params)
     end
-    
+
     def build_params(params = {})
       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]
+      args = [http_verb, url]
+      args << params if http_verb == 'post'
 
-      response = RestClient.send *args do |res, req, raw_res|
+      RestClient.send(*args) do |res, req, raw_res|
         body = raw_res.body
         code = raw_res.code.to_i
 
@@ -33,9 +34,9 @@ module AlPapi
 
         case code
         when 200
-          begin 
-            parsed = JSON.parse body
-          rescue JSON::ParserError => e
+          begin
+            JSON.parse body
+          rescue JSON::ParserError
             self.response = body
           end
           self.success = true
@@ -44,10 +45,10 @@ module AlPapi
         when 401
           self.errors << RequestError.new('Invalid Auth Token Provided', code, path, params)
         when 403
-          if body.match /Account Suspended/i
+          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
+          elsif body.match(/Request Limit Exceeded/i)
             self.over_limit = true
             self.errors << RequestError.new('Request Limit Exceeded', code, path, params)
           end

data/lib/al_papi/web_insight.rb

@@ -2,6 +2,8 @@ module AlPapi
 
   class WebInsight
 
+    ENDPOINT = '/web/insight'
+
     ##
     #
     # URL for the page you want insight into and the callback url you have implemented to know
@@ -13,7 +15,7 @@ module AlPapi
 
     def self.post(params = {})
       check_params Hashie::Mash.new(params), *%w[url callback]
-      AlPapi.http.post '/web/insight', params
+      request 'post', params
     end
 
     ##
@@ -27,9 +29,11 @@ module AlPapi
 
     def self.get(params = {})
       check_params Hashie::Mash.new(params), *%w[date_created time_created]
-      AlPapi.http.get '/web/insight', params
+      request 'get', params
     end
 
+  private
+
     ##
     #
     # Check if required params exist
@@ -41,6 +45,10 @@ module AlPapi
       end
     end
 
+    def self.request(method, params = {})
+      AlPapi.http.send method, ENDPOINT, params
+    end
+
   end
 
 end

metadata

@@ -1,112 +1,235 @@
 --- !ruby/object:Gem::Specification
 name: al_papi
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors:
 - Chavez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: gemcutter
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
+        version: 0.7.1
+    - - ">="
+      - !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: 1.2.0
+        version: 0.7.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.14.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.8.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.5
+    - - ">="
       - !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::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
+    - - ">="
       - !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
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.11
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7.4
 description: Wraps AuthorityLabs Partner API calls in a gem.
 email: ''
 executables: []
@@ -114,6 +237,8 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- README.md
+- lib/al_papi.rb
 - lib/al_papi/account.rb
 - lib/al_papi/config.rb
 - lib/al_papi/engines.rb
@@ -123,32 +248,29 @@ files:
 - lib/al_papi/request_error.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: []
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8 --main=README.md
+- "--charset=UTF-8 --main=README.md"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: AuthorityLabs Partner API Wrapper
 test_files: []
 has_rdoc: