serpscan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bef7e95dba139b3f0ded2f2e0b72c322a705c246
+  data.tar.gz: 5fddfcf2957118ef0a3de69486a0a06918008405
+SHA512:
+  metadata.gz: 9d30ff1ae77e6c9aa5768339e5e4c0c832759e94c1d71a7ba7d4825fa268a4f128686d40d34ee30016b1916398cb590116f63d4dac05d859dd79c1ca85e2c359
+  data.tar.gz: d50dc61fc0ea9b32161ca636a4c3d00aa8630856ffee9408277258b233e1b12966cd03e2324ede9ca5d59267a45ba77f2a38d4265a737e274132275a188b7ef3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rvmrc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dylan Montgomery
+
+MIT License
+
+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,82 @@
+# SERP Scan API
+
+##### SERP Scan tracks your website's search engine position for the keywords that matter to you.
+
+The serpscan gem is a ruby wrapper for interacting with the SERP Scan API. Before you can use the gem you'll need a SERP Scan account (https://serpscan.com), and an api key which can be found on the accounts page. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'serpscan'
+```
+
+And then execute:
+
+$ bundle
+
+Or install it yourself as:
+
+$ gem install serpscan
+
+## Usage
+
+Set your API key. If you're using Rails you may want to place the code below in a file at config/initializers/serpscan.rb.
+
+```ruby
+Serpscan.api_key = 'YOUR API KEY'
+```
+
+To create a website:
+
+```ruby
+Serpscan::Website.create(url: 'example.com')
+```
+
+To get a list of the websites currently in your account:
+
+
+```ruby
+Serpscan::Website.all
+```
+
+To get a particular website:
+
+```ruby
+Serpscan::Website.find(id)
+```
+
+To get a list of keywords for a website:
+
+```ruby
+website = Serpscan::Website.find(1)
+website.keywords
+```
+
+To create a keyword:
+
+```ruby
+website = Serpscan::Website.find(1)
+website.create_keyword(phrase: 'example keyword')
+```
+
+## Attributes
+
+Each of these attributes can be called directly on the object. Example:
+```
+website = Serpscan::Website.find(1)
+website.id # => 1
+```
+
+Websites:
+
+```Website
+[:id, :url] 
+```
+
+Keywords:
+
+```ruby
+[:id, :phrase, :current_rank, :initial_rank, :day_change, :week_change, :alltime_change, :search_volume, :search_engine_country_id]
+```

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/serpscan.rb

@@ -0,0 +1,16 @@
+require 'serpscan/version'
+require 'serpscan/api'
+require 'serpscan/utilities'
+require 'serpscan/serpscan_object'
+require 'serpscan/serpscan_child_object'
+require 'serpscan/keyword'
+require 'serpscan/search_engine'
+require 'serpscan/website'
+require 'serpscan/errors'
+require 'queryparams'
+
+module Serpscan
+  class << self
+    attr_accessor :api_key
+  end
+end

data/lib/serpscan/account.rb

@@ -0,0 +1,8 @@
+require 'rest_client'
+
+module Serpscan
+  class Account < SerpscanObject
+    ATTRIBUTES = []
+    attr_accessor *ATTRIBUTES
+  end
+end

data/lib/serpscan/api.rb

@@ -0,0 +1,48 @@
+require 'rest_client'
+
+module Serpscan
+  class API
+    BASE_URL = 'https://serpscan.com/api/v1'
+    class << self
+      def get(path, options = {})
+        url = api_url(path)
+        if options[:params]
+          url += "&#{querify(options[:params])}"
+        end
+
+        normalize_response RestClient.get(url)
+      end
+
+      def delete(path)
+        RestClient.delete(api_url(path))
+      end
+
+      def post(path, options = {})
+        normalize_response RestClient.post(api_url(path), options[:params].to_json)
+      end
+
+      def put(path, options = {})
+        normalize_response RestClient.put(api_url(path), options[:params].to_json, content_type: :json)
+      end
+
+      private
+
+      def normalize_response(response)
+        JSON.parse(response)
+      end
+
+      def api_url(path)
+        "#{BASE_URL}#{tokenize(path)}"
+      end
+
+      def querify(hash)
+        hash.map { |k, v| "#{k}=#{v}".to_s }.join('&')
+      end
+
+      def tokenize(path)
+        param_separator = path.include?('?') ? '&' : '?'
+        path += "#{param_separator}token=#{Serpscan.api_key}"
+      end
+    end
+  end
+end

data/lib/serpscan/errors.rb

@@ -0,0 +1,3 @@
+module Serpscan
+  class ParentError < StandardError; end
+end

data/lib/serpscan/keyword.rb

@@ -0,0 +1,10 @@
+module Serpscan
+  class Keyword < SerpscanChildObject
+    ATTRIBUTES = [:id, :phrase, :current_rank, :initial_rank, :day_change, :week_change, :alltime_change, :search_volume, :search_engine_country_id]
+    attr_accessor *ATTRIBUTES
+
+    def website
+      parent
+    end
+  end
+end

data/lib/serpscan/search_engine.rb

@@ -0,0 +1,6 @@
+module Serpscan
+  class SearchEngine < SerpscanObject
+    ATTRIBUTES = [:id, :title, :countries]
+    attr_accessor *ATTRIBUTES
+  end
+end

data/lib/serpscan/search_engine_country.rb

@@ -0,0 +1,21 @@
+module Serpscan
+  class SearchEngineCountry < SerpscanChildObject
+    ATTRIBUTES = [:id, :location, :search_engine_id]
+    attr_accessor *ATTRIBUTES
+
+    def search_engine
+      parent
+    end
+
+    def save(params = {})
+      super(params)
+    end
+
+    class << self
+      def create
+        params = { Serpscan::Utilities.object_to_string(self) => params }
+        API.post("#{api_path}?#{QueryParams.encode(params)}", params: params, json: true)
+      end
+    end
+  end
+end

data/lib/serpscan/serpscan_child_object.rb

@@ -0,0 +1,23 @@
+module Serpscan
+  class SerpscanChildObject < SerpscanObject
+    attr_accessor :parent
+
+    def initialize(options = {})
+      @parent = options[:parent]
+      super
+    end
+
+    class << self
+      def all(params = {})
+        params.merge!(parent: params[:parent], child: self)
+        super
+      end
+
+      def create(params = {})
+        object = new(params)
+        params.merge!("#{object.parent.object_name}_id" => object.parent.id) if object.parent
+        super
+      end
+    end
+  end
+end

data/lib/serpscan/serpscan_object.rb

@@ -0,0 +1,68 @@
+module Serpscan
+  class SerpscanObject
+    def initialize(options = {})
+      assign_attributes(options)
+    end
+
+    def api_path
+      SerpscanObject.api_path(self)
+    end
+
+    def object_name
+      Serpscan::Utilities.object_to_string(self)
+    end
+
+    def delete
+      Serpscan::API.delete("#{api_path}/#{id}")
+      true
+    end
+
+    class << self
+      def api_path(object = self)
+        "/#{Serpscan::Utilities.object_to_string(object)}s"
+      end
+
+      def all(options = {})
+        parent = options[:parent]
+        child = options[:child]
+        objects = options.fetch(:objects, [])
+
+        url = options[:parent] ? "#{parent.api_path}/#{parent.id}#{child.api_path}" : api_path
+        results = Serpscan::API.get(url, params: options[:params])
+
+        results['results'].map do |object|
+          objects << new(object.merge(parent: options[:parent]))
+        end
+
+        consider_pagination(results, options, objects)
+        objects
+      end
+
+      def find(id)
+        results = Serpscan::API.get("#{api_path}/#{id}")
+        new(results)
+      end
+
+      def create(params)
+        parent_object = params.delete(:parent)
+        params = { Serpscan::Utilities.object_to_string(self) => params }
+        results = Serpscan::API.post("#{api_path}?#{QueryParams.encode(params)}", params: params)
+        new(results.merge(parent: parent_object))
+      end
+
+      def consider_pagination(results, options, objects)
+        if results['page'] && results['page'].to_i < results['total_pages']
+          (options[:child]).all(options.merge(objects: objects, params: { page: results['page'].to_i + 1 }))
+        end
+      end
+    end
+
+    private
+
+    def assign_attributes(options = {})
+      self.class::ATTRIBUTES.each do |attribute|
+        send("#{attribute}=", options[attribute.to_s])
+      end
+    end
+  end
+end

data/lib/serpscan/utilities.rb

@@ -0,0 +1,18 @@
+module Serpscan
+  class Utilities
+    class << self
+      def object_to_string(object)
+        object_name = object.is_a?(Class) ? object.name : object.class
+        underscore(object_name.to_s.split('::').last).downcase
+      end
+
+      def underscore(string)
+        string.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end
+    end
+  end
+end

data/lib/serpscan/version.rb

@@ -0,0 +1,3 @@
+module Serpscan
+  VERSION = '0.0.1'
+end

data/lib/serpscan/website.rb

@@ -0,0 +1,16 @@
+require 'rest_client'
+
+module Serpscan
+  class Website < SerpscanObject
+    ATTRIBUTES = [:id, :url]
+    attr_accessor *ATTRIBUTES
+
+    def create_keyword(phrase)
+      keyword = Serpscan::Keyword.create(parent: self, phrase: phrase)
+    end
+
+    def keywords
+      @keywords ||= Serpscan::Keyword.all(parent: self)
+    end
+  end
+end

data/serpscan.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serpscan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'serpscan'
+  spec.version       = Serpscan::VERSION
+  spec.authors       = ['Dylan Montgomery']
+  spec.email         = ['mail@citizensinspace.com']
+  spec.summary       = 'API client for SERP Scan rank tracker'
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'json'
+  spec.add_dependency 'queryparams'
+end

data/spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_creatable_object/should_return_object_after_creation.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://localhost:5055/api/v1/keywords?keyword%5Bkeyword%5D=example%20keyword&keyword%5Bsearch_engine_country_id%5D=1&keyword%5Bwebsite_id%5D=1&token=123
+    body:
+      encoding: UTF-8
+      string: '{"keyword":{"keyword":"example keyword","website_id":1,"search_engine_country_id":1}}'
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '85'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 201
+      message: 'Created '
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - '"b468971b71df0e30c02b082c707379cf"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 7024f78e2d3309f8fd844a19208d4da7
+      X-Runtime:
+      - '0.069711'
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.9.3/2013-01-15)
+      Date:
+      - Sun, 22 Feb 2015 20:43:19 GMT
+      Content-Length:
+      - '246'
+      Connection:
+      - Keep-Alive
+      Set-Cookie:
+      - _serps_session=BAh7BkkiD3Nlc3Npb25faWQGOgZFRkkiJTgxOTYyYTcxZGNkNzk1NjQ3MGFmZGUwNzQ0MTNjYThjBjsAVA%3D%3D--08f481b92b725e3339e9a3d8177e6c10e57ab1a2;
+        path=/; HttpOnly
+    body:
+      encoding: UTF-8
+      string: '{"website_id":null,"page":null,"total_pages":null,"results":[{"id":3,"phrase":"example
+        keyword","current_rank":null,"initial_rank":null,"day_change":null,"week_change":null,"alltime_change":"_","search_volume":null,"search_engine_country_id":1}]}'
+    http_version: 
+  recorded_at: Sun, 22 Feb 2015 20:43:19 GMT
+recorded_with: VCR 2.9.3