rb_raven_api 0.0.1

data/README.md

@@ -0,0 +1,138 @@
+Raven Tools API Gem [![Build Status](https://secure.travis-ci.org/mtchavez/rb-raven-api.png)](http://travis-ci.org/mtchavez/rb-raven-api?branch=master)
+=============================
+
+A wrapper around the RavenTools API calls.
+
+* Github: http://github.com/mtchavez/rb-raven-api
+* [![endorse](http://api.coderwall.com/mtchavez/endorsecount.png)](http://coderwall.com/mtchavez)
+
+## Install
+
+    gem install 'rb_raven_api'
+
+## Configuration
+
+Set configuration options to be used on requests:
+
+    require 'rb_raven_api'
+
+    Raven.configure do |config|
+      config.api_key = 'my-key'
+    end
+
+Or set your key without a block before making some requests:
+
+    require 'rb_raven_api'
+
+    Raven.configure 'my-key'
+
+## Profile
+
+Get info pertaining to your RavenTools profile.
+
+### Info
+
+This request will return the name and billable keyword usage for the current profile.
+
+    Raven::Profile.info
+
+Example response in JSON
+
+    {
+      "name":"Tweetstalk",
+      "keyword_usage":"33"
+    }
+
+##Domains
+
+API specific calls for domains.
+
+### All
+
+This request will return the available domains for the profile associated with your API key.
+
+    Raven::Domain.all
+    # => ["example.com","tweetstalk.com"]
+
+### Add
+
+The domain name you want to add. "www." prefixes are ignored for purposes of matching ranks, but will be stored as part of the domain name for future requests.
+
+    Raven::Domain.add 'poop-chute.com', '1,2,3'
+
+Example response in JSON
+
+    {
+      "response":"success"
+    }
+
+### Keywords
+
+This request will return the available keywords for the domain provided.
+
+    Raven::Domain.keywords 'poop-chute.com'
+
+Example response in JSON
+
+    [
+      "toilets",
+      "plunger",
+      "toilet paper"
+    ]
+
+### Keywords with Tags
+
+This request will return the available keywords for the domain provided.
+
+    Raven::Domain.keywords_with_tags 'poop-chute.com'
+
+Example response in JSON
+
+    [
+      {
+        "keyword":"toilets", 
+        "tags":null
+      },
+      {
+        "keyword":"plunger",
+        "tags":["one", "two"]
+      },
+      {
+        "keyword":"toilet paper",
+        "tags":["three"]
+      }
+    ]
+
+## Keywords
+
+Keywords endpoint allows you to create and add keywords to a domain.
+
+### Add
+
+This request will add keyword to the domain provided.
+
+    Raven::Keyword.add 'twitter.com', 'microblog'
+
+Example response in JSON
+
+    {
+      "response":"success"
+    }
+
+### Remove
+
+This request will remove a keyword from the domain provided.
+
+    Raven::Keyword.remove 'twitter.com', 'microblog'
+
+Example response in JSON
+
+    {
+      "response":"success"
+    }
+
+## License
+
+Written by Chavez
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

data/lib/raven.rb

@@ -0,0 +1,47 @@
+require 'json'
+require 'rest-client'
+require 'net/http'
+require 'hashie'
+
+require File.dirname(__FILE__) + '/rb_raven_api/config'
+require File.dirname(__FILE__) + '/rb_raven_api/domain'
+require File.dirname(__FILE__) + '/rb_raven_api/engines'
+require File.dirname(__FILE__) + '/rb_raven_api/http'
+require File.dirname(__FILE__) + '/rb_raven_api/keyword'
+require File.dirname(__FILE__) + '/rb_raven_api/profile'
+require File.dirname(__FILE__) + '/rb_raven_api/request_error'
+require File.dirname(__FILE__) + '/rb_raven_api/response'
+
+module Raven
+
+  extend self
+
+  ##
+  # @example Configure takes block to set API key to be used in API calls.
+  #    Raven.configure do |config|
+  #      config.api_key = 'my-key'
+  #    end
+  # @example Configure can also just take an api_key
+  #    Raven.configure 'my-key'
+  #
+
+  def configure api_key = nil
+    if block_given?
+      yield config
+    else
+      config.api_key = api_key
+    end
+  end
+
+  #
+  # @return [Raven::Config]
+
+  def config
+    @config ||= Config.new
+  end
+
+  def http # @private
+    Http.new(config)
+  end
+
+end

data/lib/rb_raven_api.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/raven'

data/lib/rb_raven_api/config.rb

@@ -0,0 +1,27 @@
+module Raven
+
+  ##
+  #
+  # Config class used internally.
+  # Configure API calls using Raven.configure
+
+  class Config
+
+    DEFAULT_HOST = 'https://api.raventools.com/api'
+    DEFAULT_PORT = 80 # @private
+
+    attr_accessor :api_key
+    attr_reader   :host, :port # @private
+
+    ##
+    #
+    # @private
+
+    def initialize
+      @host = DEFAULT_HOST
+      @port = DEFAULT_PORT
+    end
+    
+  end
+
+end

data/lib/rb_raven_api/domain.rb

@@ -0,0 +1,48 @@
+module Raven
+
+  class Domain
+
+    ##
+    # Your account domains.
+    #
+    # @return [Array] Domains.
+    #
+
+    def self.all
+      Raven.http.get '', { method: 'domains' }
+    end
+
+    ##
+    # This request will add the domain provided.
+    #
+    # @param domain    [String] *Required* The domain name you want to add. "www." prefixes are ignored for purposes of matching ranks, but will be stored as part of the domain name for future requests.
+    # @param engine_id [String] _Optional_ Comma separate list of search engine ids that you want to track for this domain. Defaults to '1,2,3' which is Google, Yahoo! and Bing
+    #
+
+    def self.add domain, engine_id = '1,2,3'
+      Raven.http.get '', { method: 'add_domain', domain: domain, engine_id: engine_id }
+    end
+
+    ##
+    # This request will return the available keywords for the domain provided.
+    #
+    # @param domain [String] *Required* The domain name you want results for. _Must match exactly_
+    #
+
+    def self.keywords domain
+      Raven.http.get '', { method: 'keywords', domain: domain }
+    end
+
+    ##
+    # This request will return the available keywords for the domain provided.
+    #
+    # @param domain [String] *Required* The domain name you want results for. _Must match exactly_
+    #
+
+    def self.keywords_with_tags domain
+      Raven.http.get '', { method: 'keywords_tags', domain: domain }
+    end
+
+  end
+
+end

data/lib/rb_raven_api/engines.rb

@@ -0,0 +1,18 @@
+module Raven
+
+  class Engines
+
+    ##
+    # Supported engines for Raven.
+    #
+    # @return [Array] Supported engines.
+    # @note Currently getting redirected to login for this endpoint
+    #
+
+    def self.all
+      Raven.http.get '', { method: 'engines' }
+    end
+
+  end
+
+end

data/lib/rb_raven_api/http.rb

@@ -0,0 +1,54 @@
+module Raven
+
+  class Http # @private
+
+    attr_accessor :errors, :response, :success, :config
+
+    def initialize(_config)
+      @config, @errors, @success = _config, [], false
+    end
+
+    def get(path = '', params = {})
+      request 'get', "#{path}?#{RestClient::Payload.generate(build_params(params))}"
+    end
+
+    def post(path = '', params = {})
+      request 'post', path, build_params(params)
+    end
+    
+    def build_params(params = {})
+      params.merge key: @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]
+
+      response = RestClient.send *args do |res, req, raw_res|
+        body = raw_res.body
+        code = raw_res.code.to_i
+
+        self.response = body
+        self.errors   = []
+
+        case code
+        when 200
+          begin 
+            parsed = JSON.parse body
+          rescue JSON::ParserError => e
+            self.response = body
+          end
+          self.success = true
+        when 204
+          self.errors << RequestError.new('No Content', code, path, params)
+        else
+          self.errors << RequestError.new(body, code, path, params)
+        end
+
+        Response.new(self, code, path, params)
+      end
+    end
+
+  end
+
+end

data/lib/rb_raven_api/keyword.rb

@@ -0,0 +1,29 @@
+module Raven
+
+  class Keyword
+
+    ##
+    # This request will add keyword to the domain provided.
+    #
+    # @param domain  [String] *Required* - The domain you want the keyword to be added to.
+    # @param keyword [String] *Required* - The keyword you are adding.
+    #
+
+    def self.add domain, keyword
+      Raven.http.get '', { method: 'add_keyword', domain: domain, keyword: keyword }
+    end
+
+    ##
+    # This request will remove a keyword from the domain provided.
+    #
+    # @param domain  [String] *Required* - The domain you want the keyword to be removed from.
+    # @param keyword [String] *Required* - The keyword you are removing.
+    #
+
+    def self.remove domain, keyword
+      Raven.http.get '', { method: 'remove_keyword', domain: domain, keyword: keyword }
+    end
+
+  end
+
+end

data/lib/rb_raven_api/profile.rb

@@ -0,0 +1,17 @@
+module Raven
+
+  class Profile
+
+    ##
+    # This request will return the name and billable keyword usage for the current profile.
+    #
+    # @return [Hash] Hash of profile information.
+    #
+
+    def self.info
+      Raven.http.get '', { method: 'profile_info' }
+    end
+
+  end
+
+end

data/lib/rb_raven_api/request_error.rb

@@ -0,0 +1,13 @@
+module Raven
+
+  class RequestError
+
+    attr_reader :message, :code, :path, :params
+
+    def initialize(_message, _code, _path, _params) # @private
+      @message, @code, @path, @params = _message, _code, _path, _params
+    end
+
+  end
+
+end

data/lib/rb_raven_api/response.rb

@@ -0,0 +1,38 @@
+module Raven
+
+  class Response
+
+    attr_reader :success, :body, :errors, :code, :path, :params
+
+    ##
+    # Initializing response object to be returned from API calls, used internally.
+    #
+
+    def initialize(http, _code, _path, _params) # @private
+      @success, @body, @errors = http.success, http.response, http.errors
+      @code, @path, @params    = _code, _path, _params
+    end
+    
+    ##
+    #
+    # Convenience method to determine if request was successfull or not
+    # @return [Boolean]
+
+    def success?
+      !!@success
+    end
+
+    ##
+    #
+    # Parses JSON body of request and returns a Hashie::Mash
+    # @return [Hashie::Mash]
+
+    def parsed_body
+      hash = JSON.parse(@body) rescue {}
+      return hash if hash.is_a?(Array)
+      Hashie::Mash.new hash
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: rb_raven_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chavez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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
+description: Wraps RavenTools API calls in a gem.
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/raven.rb
+- lib/rb_raven_api/config.rb
+- lib/rb_raven_api/domain.rb
+- lib/rb_raven_api/engines.rb
+- lib/rb_raven_api/http.rb
+- lib/rb_raven_api/keyword.rb
+- lib/rb_raven_api/profile.rb
+- lib/rb_raven_api/request_error.rb
+- lib/rb_raven_api/response.rb
+- lib/rb_raven_api.rb
+- README.md
+homepage: http://github.com/mtchavez/rb-raven-api
+licenses: []
+post_install_message: 
+rdoc_options:
+- --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.23
+signing_key: 
+specification_version: 3
+summary: RavenTools API
+test_files: []
+has_rdoc: