places_scout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fb4545fabed5b244cdf7286a4ec0c334da46bf6
+  data.tar.gz: b1656588dbe562538908cca4a3dc6b660c72126c
+SHA512:
+  metadata.gz: 3eb7b5ebe099c6aa822ad8f5eb9dcb63d6ca49020b352091817df06e6ffb0981135b1dc1427b860eccd99dd02c1f29db6af3e780d377628520e86c8c7edc7573
+  data.tar.gz: e658722d41fd01a4b9298d7c4a27d4c139092eb46a46f5c9725ec7c85e1bfa56083a0bd974ed9564b41a49d5088aa2dbf1981666ca972be5b63e1f7e0d348242

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Hoskison
+
+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,88 @@
+# PlacesScout
+
+A gem to interact with the Places Scout API. https://www.placesscout.com/api
+Check the usage section for what's currently implemented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'places_scout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install places_scout
+
+## Usage
+
+You can add :size & :page as parameters to grab specific size/page to the calls below. The maximum size supported by the API is 100.
+```ruby
+get_ranking_reports() # Defaults to returning all pages with 100 results each
+get_ranking_reports(:size => '10') # Returns all pages with 10 results each
+get_ranking_reports(:size => '5', page => '5') # Returns only the 5th page
+```
+### Connecting to the API
+```ruby
+testcon = PlacesScout::Api.new("username", "password")
+```
+### Clients
+```ruby
+testcon.get_clients()   # Grab all clients. 
+testcon.get_clients(:clientid => 'client-id') #Grab specific client
+```
+### Locations
+```ruby
+testcon.get_client_locations()   # Grab all client locations. 
+testcon.get_client_locations(:clientid => 'client-id') #Grab locations for specific client
+testcon.get_client_locations(:locationid => 'location-id') #Grab by location id
+```
+### Folders
+```ruby
+testcon.get_client_folders()#Grab all client folders.
+testcon.get_client_folders(:clientid => 'client-id') #Grab folder off client id
+```
+### Rank Reports
+```ruby
+testcon.get_ranking_reports #Grab a list of all ranking reports. 
+testcon.get_ranking_reports(:all => true) #Grab all ranking report data. 
+testcon.get_ranking_reports(:clientid => 'client-id') #Grab Rank reports for a specific client
+testcon.get_ranking_reports(:clientid => 'client-id', :locationid=> 'location-id') # Grab specific location for specific client
+testcon.get_ranking_reports(:reportid => 'report-id') #Grab a specific ranking report
+testcon.get_ranking_reports(:reportid => 'report-id', :historical => true) #Return chart for average rankings over time 
+testcon.get_ranking_reports(:reportid => 'report-id', :historical => true, :keywords => true) #Return chart for keyword rankings over time
+testcon.get_ranking_reports(:reportid => 'report-id', :rundates => true) # Return run dates and ID's for a report
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true) #Grab the runs for a report
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id') #Grab a specific report run
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :keywordresults => true) #Grab a specific report run keyword results
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :keywordresults => true, :keywordresultsid => 'keyword-results-id') #Grab a specific keyword result for a specific report run 
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :keywordserpscreenshot => 'adhesion treatment' , :googlelocation => 'San Luis Obispo, CA') #Google Organic SERP Page
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :runid => 'run-id', :summary => true) # Grab summary metrics
+testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :newest => true) # Grab newest if :newest => true. Grab oldest if :newest => false
+```
+
+### Status
+```ruby
+testcon.get_status #Grab the status of all reports
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mhoskiso/places_scout.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "places_scout"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/places_scout.rb

@@ -0,0 +1,143 @@
+require 'bundler/setup'
+require "places_scout/version"
+require "base64"
+require 'json'
+require 'ostruct'
+
+require 'rest-client'
+
+module PlacesScout
+  class Api
+  # RestClient.log = 'stdout' #Debugging API calls
+    MAX_PAGE_SIZE = '100'
+
+    def initialize(u, p)
+      @url = 'https://apihost1.placesscout.com'
+      $auth = 'Basic ' + Base64.encode64(u + ':' + p).chomp      
+    end
+
+    def parse_json(response)
+      body = JSON.parse(response.to_str) if response.code == 200
+      OpenStruct.new(code: response.code, body: body)
+    end
+
+# /clients
+    def get_clients( opts = {})
+        path = "/clients/#{opts[:clientid]}"
+        results = []
+        params = {}
+        params[:page] = opts[:page] || 1
+        params[:size] = opts[:size] || MAX_PAGE_SIZE
+        total_size = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body['total'] || 1
+        total_pages = (opts[:page]) ? 1 : (total_size/params[:size].to_f).ceil  
+    
+        while total_pages > 0      
+          response = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body
+          results.push(response)
+          params[:page] += 1 unless opts[:page]
+          total_pages -= 1
+        end
+
+        return results
+    end
+
+# Client Locations
+    def get_client_locations( opts = {})
+      path = "/clientlocations/#{opts[:locationid]}"
+      results = []
+      params = {}
+      params[:page] = opts[:page] || 1
+      params[:size] = opts[:size] || MAX_PAGE_SIZE
+      params[:clientid] = opts[:clientid]
+      location = opts[:locationid]
+      total_size = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body['total'] || 1
+      total_pages = (opts[:page]) ? 1 : (total_size/params[:size].to_f).ceil  
+
+      while total_pages > 0
+        response = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body
+        results.push(response)
+        params[:page] += 1 unless opts[:page]
+        total_pages -= 1
+      end
+      return results
+    end
+
+# /folders
+    def get_client_folders( opts = {})
+        results = []
+        params = {}
+        params[:page] = opts[:page] || 1
+        params[:size] = opts[:size] || MAX_PAGE_SIZE
+        params[:clientid] = opts[:clientid] 
+        path =  "/clientfolders"
+        total_size = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body['total'] || 1
+        total_pages = (opts[:page]) ? 1 : (total_size/params[:size].to_f).ceil  
+
+        while total_pages > 0      
+          response = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body 
+          results.push(response)
+          params[:page] += 1 unless opts[:page]
+          total_pages -= 1
+        end
+        return results
+    end
+
+# /rankingreports
+      def get_ranking_reports( opts = {})
+        results = []
+        params = {}
+        reportid = "/#{opts[:reportid]}" || ""
+        params[:locationid] = opts[:locationid] || ""
+        params[:clientid] = opts[:clientid] || ""
+        all = (opts[:all]) ? "/all" : ""
+        historical = (opts[:historical] && opts[:reportid] && all == "") ? "/historical" : ""
+        keywords = (opts[:historical] && opts[:reportid] && opts[:keywords] && all == "") ? "/keywords" : ""
+        rundates = (opts[:rundates] && opts[:reportid] && all == "") ? "/rundatesandids" : ""
+        runs = (opts[:runs] && opts[:reportid] && rundates == "" && all == "") ? "/runs" : ""
+        runid = (opts[:runid] && opts[:runs] && rundates == "" && all == "") ? "/#{opts[:runid]}" : ""
+        summary = (opts[:summary] && opts[:runid] && opts[:runs] && rundates == "" && all == "") ? "/summarymetrics" : ""
+        keywordresults = (opts[:keywordresults] && opts[:runid] && opts[:runs] && opts[:reportid] && rundates =="" && summary == "" && all == "") ? "/keywordsearchresults" : ""
+        keywordresultsid = (opts[:keywordresultsid] && opts[:keywordresults] && opts[:runid] && opts[:runs] && opts[:reportid] && rundates =="" && summary == "" && all == "") ? "/#{opts[:keywordresultsid]}" : ""
+        keywordserpscreenshot = (opts[:runid] && opts[:runs] && opts[:reportid] && rundates == "" && keywordresults == "" && keywordresultsid == "" && summary == "" && all == "") ? "/keywordserpscreenshot" : ""
+        
+        newest = case opts[:newest]
+                  when opts[:newest] = true  
+                      "/newest"
+                  when opts[:newest] = false
+                      "/oldest"
+                  else
+                      ""
+                 end
+
+        path = (opts[:clientid] && params[:locationid] == "" && all == "") ? "/rankingreports/#{opts[:clientid]}/allbyclient" : "/rankingreports#{all}#{opts[:reportid]}#{rundates}#{runs}#{newest}#{runid}#{summary}#{historical}#{keywords}#{keywordresults}#{keywordresultsid}#{keywordserpscreenshot}"     
+        params[:Keyword] = opts[:keywordserpscreenshot] if opts[:keywordserpscreenshot]
+        params[:GoogleLocation] = opts[:googlelocation] if opts[:googlelocation]
+        params[:page] = opts[:page] || 1
+        params[:size] = opts[:size] || MAX_PAGE_SIZE
+        total_size = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body['total'] || 1
+        total_pages = (opts[:page] || opts[:locationid]) ? 1 : (total_size/params[:size].to_f).ceil        
+        
+        while total_pages > 0  
+          response = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body
+          results.push(response)
+          params[:page] += 1 unless opts[:page]
+          total_pages -= 1
+        end
+        return results     
+    end
+
+    def get_status( opts = {})
+      results = []
+      params = {}
+      reportid = "/#{opts[:reportid]}" || ""
+      path = "/status/getreportstatus"
+      response = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => $auth)).body
+    end
+
+
+
+
+
+  end
+
+end

data/lib/places_scout/version.rb

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

data/places_scout.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'places_scout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "places_scout"
+  spec.version       = PlacesScout::VERSION
+  spec.authors       = ["Michael Hoskison"]
+  spec.email         = ["mhoskison@etnainteractive.com"]
+
+  spec.summary       = %q{Used to access the Places Scout api}
+  spec.description   = %q{Places Scout API}
+  spec.homepage      = "https://github.com/mhoskiso/places_scout"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "rest-client", "~> 1.8.0"
+  spec.add_dependency "json", "~> 1.8.1"
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: places_scout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Hoskison
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: Places Scout API
+email:
+- mhoskison@etnainteractive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/places_scout.rb
+- lib/places_scout/version.rb
+- places_scout.gemspec
+homepage: https://github.com/mhoskiso/places_scout
+licenses:
+- MIT
+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: Used to access the Places Scout api
+test_files: []