{"id":22683252,"url":"https://github.com/mtchavez/rb-raven-api","last_synced_at":"2025-03-29T14:27:57.010Z","repository":{"id":5880928,"uuid":"7098644","full_name":"mtchavez/rb-raven-api","owner":"mtchavez","description":"Ruby wrapper for RavenTools API.","archived":false,"fork":false,"pushed_at":"2013-01-03T02:51:20.000Z","size":144,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-03-14T23:06:57.380Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mtchavez.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rdoc","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-12-10T18:45:03.000Z","updated_at":"2013-11-03T16:40:19.000Z","dependencies_parsed_at":"2022-08-20T16:00:52.316Z","dependency_job_id":null,"html_url":"https://github.com/mtchavez/rb-raven-api","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Frb-raven-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Frb-raven-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Frb-raven-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mtchavez%2Frb-raven-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mtchavez","download_url":"https://codeload.github.com/mtchavez/rb-raven-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246195626,"owners_count":20738910,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-09T21:11:23.328Z","updated_at":"2025-03-29T14:27:56.978Z","avatar_url":"https://github.com/mtchavez.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"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)\n=============================\n\nA wrapper around the RavenTools API calls.\n\n* Github: http://github.com/mtchavez/rb-raven-api\n* [![endorse](http://api.coderwall.com/mtchavez/endorsecount.png)](http://coderwall.com/mtchavez)\n\n## Install\n\n    gem install 'rb_raven_api'\n\n## Configuration\n\nSet configuration options to be used on requests:\n\n    require 'rb_raven_api'\n\n    Raven.configure do |config|\n      config.api_key = 'my-key'\n    end\n\nOr set your key without a block before making some requests:\n\n    require 'rb_raven_api'\n\n    Raven.configure 'my-key'\n\n## Profile\n\nGet info pertaining to your RavenTools profile.\n\n### Info\n\nThis request will return the name and billable keyword usage for the current profile.\n\n    Raven::Profile.info\n\nExample response in JSON\n\n    {\n      \"name\":\"Tweetstalk\",\n      \"keyword_usage\":\"33\"\n    }\n\n##Domains\n\nAPI specific calls for domains.\n\n### All\n\nThis request will return the available domains for the profile associated with your API key.\n\n    Raven::Domain.all\n    # =\u003e [\"example.com\",\"tweetstalk.com\"]\n\n### Add\n\nThe 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.\n\n    Raven::Domain.add 'poop-chute.com', '1,2,3'\n\nExample response in JSON\n\n    {\n      \"response\":\"success\"\n    }\n\n## Competitors\n\nCompetitors endpoint to get your tracked competitors for a domain.\n\n### For Domain\n\nThis request will return the available competitors for the domain provided.\n\n    Raven::Competitors.for_domain 'poop-chute.com'\n\nExample response in JSON\n\n    [\"poopers.com\", \"daily-fiber.com\", \"metamucil.com\"]\n\n### Keywords\n\nThis request will return the available keywords for the domain provided.\n\n    Raven::Domain.keywords 'poop-chute.com'\n\nExample response in JSON\n\n    [\n      \"toilets\",\n      \"plunger\",\n      \"toilet paper\"\n    ]\n\n### Keywords with Tags\n\nThis request will return the available keywords for the domain provided.\n\n    Raven::Domain.keywords_with_tags 'poop-chute.com'\n\nExample response in JSON\n\n    [\n      {\n        \"keyword\":\"toilets\", \n        \"tags\":null\n      },\n      {\n        \"keyword\":\"plunger\",\n        \"tags\":[\"one\", \"two\"]\n      },\n      {\n        \"keyword\":\"toilet paper\",\n        \"tags\":[\"three\"]\n      }\n    ]\n\n### Domain Info\n\nThis request will return the search engines for the domain provided.\n\n    Raven::Domain.info 'poop-chute.com'\n\nExample response in JSON\n\n    [\n      {\"id\":\"1\",\"name\":\"Google\"},\n      {\"id\":\"2\",\"name\":\"Yahoo!\"},\n      {\"id\":\"3\",\"name\":\"Bing\"}\n    ]\n\n## Keywords\n\nKeywords endpoint allows you to create and add keywords to a domain.\n\n### Add\n\nThis request will add keyword to the domain provided.\n\n    Raven::Keyword.add 'twitter.com', 'microblog'\n\nExample response in JSON\n\n    {\n      \"response\":\"success\"\n    }\n\n### Remove\n\nThis request will remove a keyword from the domain provided.\n\n    Raven::Keyword.remove 'twitter.com', 'microblog'\n\nExample response in JSON\n\n    {\n      \"response\":\"success\"\n    }\n\n## Engines\n\nEngines endpoint to get all the supported Raven engines.\n\n## All\n\nThis request will return the available search engines for tracking keywords, to be used when adding or modifying domains.\n\n    Raven::Engines.all\n\nExample response in JSON\n\n    [\n      {\"id\":\"93\",\"name\":\"Yahoo! GR\"},\n      {\"id\":\"94\",\"name\":\"Bing NL\"},\n      {\"id\":\"95\",\"name\":\"Bing FR\"},\n      {\"id\":\"96\",\"name\":\"Yahoo FR\"},\n      {\"id\":\"97\",\"name\":\"Google LT\"},\n      {\"id\":\"98\",\"name\":\"Bing BE\"},\n      {\"...\":\"...\"},\n      {\"id\":\"1\",\"name\":\"Google\"},\n      {\"id\":\"2\",\"name\":\"Yahoo!\"},\n      {\"id\":\"3\",\"name\":\"Bing\"}\n    ]\n\n## License\n\nWritten by Chavez\n\nReleased under the MIT License: http://www.opensource.org/licenses/mit-license.php\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtchavez%2Frb-raven-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmtchavez%2Frb-raven-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmtchavez%2Frb-raven-api/lists"}