places_scout 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f440cab434622af128a6384ee030633dc851ae50
-  data.tar.gz: 975f83b748566573af6fe9f863c11fb71b3e57a4
+  metadata.gz: f468cfc1af5525677fca6bc11d2b44f06b8efa48
+  data.tar.gz: 5e9d854364d7f21d466acf8c17e9c17d9b2073f1
 SHA512:
-  metadata.gz: 83bde4dbc82c9916dad408f2cc72a522dfa05947dd1dfa76e9c917124de77948495073ccbfb814e4ce6952ebe73c4e106accfd541896b028ded2ebe1b73d24c3
-  data.tar.gz: 64c5b786c32045922aa72979de9fec36c83f5307c225b30d664eee63eb6cfd9786ccf43c3cb9cd3b22e713da0e21c8be3bdc1e15d07d01f0a280c58ca3eada21
+  metadata.gz: 1afacba91e4525ecb062ddcd6ba3a5c6237d18bf054e8843c427cc7367397c0a6a536d9f54d4b50fc84d9742a9775f8b841d44f409d212e4361def11c39d173e
+  data.tar.gz: 6f85e09a03769e81d7bbcccdc598f86a2123d72625ac43eaef66d2458053f89f2ba3b4190c9d6756d8de9875fd55d732086599c88eaa0b0c85fc16ed51487bce

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-test.rb
+test.rb
+*.gem

data/README.md

@@ -70,6 +70,97 @@ testcon.get_ranking_reports(:reportid => 'report-id', :runs => true, :newest =>
 ```ruby
 testcon.get_status #Grab the status of all reports
 ```
+## Sample Code
+```ruby
+clients = get_clients_and_ids(testcon) #Grab all clients
+add_report_ids(clients, testcon) #Grab report ID's per client
+add_report_run_ids(clients, testcon) # Grab run  per report
+get_run_rankings(clients, testcon) # Grab results per run
+puts clients[0][:reports][0][:runs][0][:rankings][0] # Return first client, report, run, keyword ranks
+
+
+def get_clients_and_ids(testcon)
+    clients = []
+    results = testcon.get_clients()  
+
+    results.each do |result|
+        result['items'].each do |item|
+          clients.push(:name => item['name'], :id => item['id'])
+        end
+    end
+
+    return clients
+end
+
+def add_report_ids(clients, testcon)
+    clients.each do |client|
+        report_ids = []
+        rankings = testcon.get_ranking_reports(:clientid => client[:id])
+        rankings.each do |rank|
+            rank['items'].each do |item|
+                report_ids.push(:id => item['rankingReport']['id']) 
+            end
+        end
+        client[:reports] = report_ids
+    end
+    return clients
+end
+
+def add_report_run_ids(clients, testcon)
+    clients.each do |client|
+        run_id_date = []
+        client[:reports].each do |report|
+            report_runs = testcon.get_ranking_reports(:reportid => report[:id], :rundates => true)
+                report_runs.each do |runs|
+                    runs['items'].each do |run|
+                        run_id_date.push(:runID => run['runId'], :runDate => parse_date(run['runDate']))
+                    end
+                end
+             report[:runs] = run_id_date
+        end
+    end
+end
+
+def get_run_rankings(clients, testcon)
+    clients.each do |client|
+        client[:reports].each do |report|            
+            report[:runs].each do |run|
+            keyword_rankings = []
+                report_runs = testcon.get_ranking_reports(:reportid => report[:id], :runs => true, :runid => run[:runID])
+                    report_runs.each do |report_run|
+                        report_run['keywordRankingResults'].each do |results|
+                            results[1].each do |result|
+                                google_rankings = []
+                                bing_rankings = []
+                                result['keywordSearch']['keyword']
+
+                                result['googleOrganicRankings'].each do |g_rank|
+                                    google_rankings.push(g_rank['rank'])
+                                end
+
+                                result['bingOrganicRankings'].each do |b_rank|
+                                    bing_rankings.push(b_rank['rank'])
+                                end
+
+                                keyword_rankings.push(:keyword => result['keywordSearch']['keyword'], :google_rank => google_rankings, :bing_rank => bing_rankings)
+
+                            end
+                        end
+                    end
+                run[:rankings] = keyword_rankings
+            end
+        end
+    end
+end
+
+
+def parse_date(datestring)
+  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+  return Time.at(seconds_since_epoch)
+end
+
+```
+
 
 ## Development
 

data/lib/places_scout.rb

@@ -13,7 +13,7 @@ module PlacesScout
 
     def initialize(u, p)
       @url = 'https://apihost1.placesscout.com'
-      $auth = 'Basic ' + Base64.encode64(u + ':' + p).chomp      
+      @auth = 'Basic ' + Base64.encode64(u + ':' + p).chomp      
     end
 
     def parse_json(response)
@@ -28,11 +28,11 @@ module PlacesScout
         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_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
+          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
@@ -50,11 +50,11 @@ module PlacesScout
       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_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
+        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
@@ -70,11 +70,11 @@ module PlacesScout
         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_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 
+          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
@@ -114,11 +114,11 @@ module PlacesScout
         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_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
+          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
@@ -131,7 +131,7 @@ module PlacesScout
       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
+      response = parse_json(RestClient.get(@url+path, params: params, :content_type => 'application/json', :accept => 'application/json', :Authorization => @auth)).body
     end
 
 

data/lib/places_scout/version.rb

@@ -1,3 +1,3 @@
 module PlacesScout
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/places_scout.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_dependency "rest-client", "~> 2.0.2"
+  spec.add_dependency "json", "~> 2.1.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: places_scout
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Hoskison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.1.0
 description: Places Scout API
 email:
 - mhoskison@etnainteractive.com