serpbook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2dca0ca81e1e755f893d2b525e9452cfc5b557f8
+  data.tar.gz: 2b82bf40edda8f5850eb9c7322aee6d7c869052b
+SHA512:
+  metadata.gz: ceb7112470d5cf5bd6c3905e82e84a518e12af924b176412206b317ff62bf58f5384abab14884a7f1b18369e9331b85800559f9fb9c80a1e44a0539cec04cbad
+  data.tar.gz: 2019069f9ac69e8e491374565880ad2efc266fc1781673929568027d38277e1447705a3402d9f63843ae327d9ae9764f81ea30716132cdce957164d1ec78cef3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/bin/
+spec/.env.rb
+spec/vcr

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serpbook.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,65 @@
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kosh-jelly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# Serpbook
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serpbook'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serpbook
+
+## Usage
+
+1. Configure your master key and email
+
+    ```ruby
+    Serpbook.config do |conf|
+        conf.master_key = 'my_key'
+        conf.email = 'my email'
+    end
+    ````
+
+2. Interact with a category
+
+    ```ruby
+    cat = Serpbook::Category.new(name: 'My Category name')
+
+    # get your rankings
+    cat.rankings
+
+    #convinience methods to drill down
+    cat.rankings.for_keyword('my keyword')
+    cat.rankings.for_url('myurl.com')
+
+    # add a new keyword - note various options that can be included. see code at lib/serpbook/category.rb
+    cat.create('myurl.com', 'my keyword')
+
+    # delete a keyword
+    cat.delete('myurl.com', 'my keyword')
+    ````
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Currently specs are setup to read in a `spec/.env.rb` file with your master_key and email. (See the spec_helper file.)
+
+TODO: make tests general enough to allow others to contribute without changing values. Perhaps reading in a valid category name from the `.env.rb` file.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kosh-jelly/serpbook.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/serpbook.rb

@@ -0,0 +1,52 @@
+require "serpbook/version"
+require 'serpbook/category'
+require 'httparty'
+
+
+module Serpbook
+  include HTTParty
+
+  class Configuration
+    attr_accessor :master_key, :email
+  end
+
+  base_uri 'https://serpbook.com/serp/api/'
+
+  class << self
+
+    def config &block
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def categories
+     request(viewkey: 'getcategories').map do |name, url|
+        [name, CGI::parse(URI.parse(url).query).map{|k,v| [k.to_sym, v.first]}.to_h]
+      end.to_h
+    end
+
+    def request(params)
+      full_params = default_params.merge(params)
+      response = self.get('/', query: full_params, verify: false)
+
+      json_data = JSON.parse(response.body)
+
+      if response.code != 200 || (json_data["Response"] && json_data["Response"] != 200)
+        raise ResponseError, "responded with #{response.code}, and messsage #{response.body}"
+      end
+
+      json_data
+    end
+
+    private
+    def default_params
+      { auth: Serpbook.configuration.master_key, 
+        e: Serpbook.configuration.email }
+    end
+  
+  end
+
+end

data/lib/serpbook/category.rb

@@ -0,0 +1,73 @@
+module Serpbook
+  class Category
+    attr_accessor :name
+    attr_writer :cat_auth, :viewkey
+
+    def initialize(opts)
+      self.name = opts[:name]
+      self.cat_auth = opts[:cat_auth]
+      self.viewkey = opts[:viewkey]
+    end
+
+    def cat_auth
+      @cat_key ||= fetch_keys[:auth]
+    end
+
+    def viewkey
+      @viewkey ||= fetch_keys[:viewkey]
+    end
+
+    def rankings
+      @rankings ||= Rankings.new(Serpbook.request(auth: cat_auth, viewkey: viewkey))
+    end
+
+    def create(url, keyword, region: 'google.com', language: 'en', ignore_local: true)
+      exact = url.start_with?('http') ? 1 : 0
+      ignore_local = ignore_local ? 1 : 0
+      Serpbook.request(viewkey: 'addkeyword', category: name, kw: keyword, 
+                       url: clean_url(url), region: region, language: language, exact: exact, 
+                       ignore_local: ignore_local)
+    end
+
+    def delete(url, keyword, region: 'google.com', language: 'en')
+      Serpbook.request(viewkey: 'delkeyword', category: name, kw: keyword, 
+                       url: clean_url(url), region: region, language: language)
+    end
+
+    def reload
+      @rankings = nil
+      self
+    end
+
+    class Rankings
+      include Enumerable
+      attr_accessor :ranks
+
+      def initialize(ranks)
+        self.ranks = ranks
+      end
+
+      def each &block
+        ranks.each(&block)
+      end
+
+      def for_keyword(keyword)
+        self.class.new(ranks.select {|row| row['kw'] == keyword } )
+      end
+
+      def for_url(url)
+        self.class.new(ranks.select {|row| row['url'] == url } )
+      end
+    end
+
+
+  private
+    def clean_url(url)
+      url.gsub('http://', '')
+    end
+
+    def fetch_keys
+      @keys ||= Serpbook.categories[name]
+    end
+  end
+end

data/lib/serpbook/version.rb

@@ -0,0 +1,3 @@
+module Serpbook
+  VERSION = "0.1.0"
+end

data/serpbook.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serpbook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "serpbook"
+  spec.version       = Serpbook::VERSION
+  spec.authors       = ["Josh Kelly"]
+  spec.email         = ["josh@kellys.org"]
+
+  spec.summary       = %q{Interact with the serpbook api}
+  spec.description   = %q{Interact with the serpbook api}
+  spec.homepage      = "https://github.com/kosh-jelly/serpbook"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "awesome_print"
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: serpbook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Kelly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interact with the serpbook api
+email:
+- josh@kellys.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/serpbook.rb
+- lib/serpbook/category.rb
+- lib/serpbook/version.rb
+- serpbook.gemspec
+homepage: https://github.com/kosh-jelly/serpbook
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Interact with the serpbook api
+test_files: []