rb_raven_api 0.0.2 → 0.0.3

data/CHANGELOG.rdoc

@@ -0,0 +1,23 @@
+== 0.0.3
+
+* Raven::Engines
+  * Specs added since no longer redirecting to login.
+* Raven::Competitors
+  * Raven::Competitors#for_domain
+
+== 0.0.2
+
+* Raven::Domain#info
+
+== 0.0.1
+
+* Raven
+* Raven::Domain
+  * Raven::Domain#all
+  * Raven::Domain#add
+  * Raven::Domain#keywords
+  * Raven::Domain#keywords_with_tags
+* Raven::Engines
+  * Raven::Engines#all [Not Working, Redirecting to login]
+* Raven::Profile
+  * Raven::Profile#info

data/README.md

@@ -66,6 +66,20 @@ Example response in JSON
       "response":"success"
     }
 
+## Competitors
+
+Competitors endpoint to get your tracked competitors for a domain.
+
+### For Domain
+
+This request will return the available competitors for the domain provided.
+
+    Raven::Competitors.for_domain 'poop-chute.com'
+
+Example response in JSON
+
+    ["poopers.com", "daily-fiber.com", "metamucil.com"]
+
 ### Keywords
 
 This request will return the available keywords for the domain provided.
@@ -109,7 +123,13 @@ This request will return the search engines for the domain provided.
 
     Raven::Domain.info 'poop-chute.com'
 
+Example response in JSON
 
+    [
+      {"id":"1","name":"Google"},
+      {"id":"2","name":"Yahoo!"},
+      {"id":"3","name":"Bing"}
+    ]
 
 ## Keywords
 
@@ -139,6 +159,31 @@ Example response in JSON
       "response":"success"
     }
 
+## Engines
+
+Engines endpoint to get all the supported Raven engines.
+
+## All
+
+This request will return the available search engines for tracking keywords, to be used when adding or modifying domains.
+
+    Raven::Engines.all
+
+Example response in JSON
+
+    [
+      {"id":"93","name":"Yahoo! GR"},
+      {"id":"94","name":"Bing NL"},
+      {"id":"95","name":"Bing FR"},
+      {"id":"96","name":"Yahoo FR"},
+      {"id":"97","name":"Google LT"},
+      {"id":"98","name":"Bing BE"},
+      {"...":"..."},
+      {"id":"1","name":"Google"},
+      {"id":"2","name":"Yahoo!"},
+      {"id":"3","name":"Bing"}
+    ]
+
 ## License
 
 Written by Chavez

data/lib/raven.rb

@@ -3,6 +3,7 @@ require 'rest-client'
 require 'net/http'
 require 'hashie'
 
+require File.dirname(__FILE__) + '/rb_raven_api/competitors'
 require File.dirname(__FILE__) + '/rb_raven_api/config'
 require File.dirname(__FILE__) + '/rb_raven_api/domain'
 require File.dirname(__FILE__) + '/rb_raven_api/engines'

data/lib/rb_raven_api/competitors.rb

@@ -0,0 +1,18 @@
+module Raven
+
+  class Competitors
+
+    ##
+    # This request will return the available competitors for the domain provided.
+    #
+    # @param domain [String] *Required* The domain name you want results for. _Must match exactly_
+    # @return [Raven::Response] Response object with request results.
+    #
+
+    def self.for_domain domain
+      Raven.http.get '', { method: 'competitors', domain: domain }
+    end
+
+  end
+
+end

data/lib/rb_raven_api/engines.rb

@@ -5,8 +5,7 @@ module Raven
     ##
     # Supported engines for Raven.
     #
-    # @return [Array] Supported engines.
-    # @note Currently getting redirected to login for this endpoint
+    # @return [Raven::Response] Response object with request results.
     #
 
     def self.all

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb_raven_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2012-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -113,8 +113,10 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
+- CHANGELOG.rdoc
 files:
 - lib/raven.rb
+- lib/rb_raven_api/competitors.rb
 - lib/rb_raven_api/config.rb
 - lib/rb_raven_api/domain.rb
 - lib/rb_raven_api/engines.rb
@@ -125,6 +127,7 @@ files:
 - lib/rb_raven_api/response.rb
 - lib/rb_raven_api.rb
 - README.md
+- CHANGELOG.rdoc
 homepage: http://github.com/mtchavez/rb-raven-api
 licenses: []
 post_install_message: