serp_metrics 0.0.2

data/spec/cassettes/serp_metrics__command_sets__priorities/add_with_location_adds_priority.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.serpmetrics.com/priority/add
+    body:
+      encoding: US-ASCII
+      string: key=h31x%25sd22hgjd2s&ts=1363584772&auth=lROO29qiF4QDoLetbhqb2gKopwnfB%2Bo%2F3g7RGDPcXx8%3D&params=%7B%22keyword%22%3A%22restaurants%22%2C%22engines%22%3A%5B%22google_en-us%22%5D%2C%22location%22%3A%22Nashville%22%7D
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Mar 2013 05:35:51 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '168'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - app=pe19h26kipb7om3fpl84ai2uf6; path=/; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok","data":[{"phrase":"restaurants","engine_code":"google_en-us","priority_id":"5146a7effc9f6ec52b000013","location":"Nashville"}],"request_time":1363585108}'
+    http_version: !!null 
+  recorded_at: Mon, 18 Mar 2013 05:32:52 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/serp_metrics__command_sets__priorities/add_without_location_adds_priority.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.serpmetrics.com/priority/add
+    body:
+      encoding: US-ASCII
+      string: key=h31x%25sd22hgjd2s&ts=1363584772&auth=lROO29qiF4QDoLetbhqb2gKopwnfB%2Bo%2F3g7RGDPcXx8%3D&params=%7B%22keyword%22%3A%22restaurants%22%2C%22engines%22%3A%5B%22google_en-us%22%5D%7D
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Mar 2013 05:35:51 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '145'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - app=gu8a855sid6reic25r744mlev6; path=/; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok","data":[{"phrase":"restaurants","engine_code":"google_en-us","priority_id":"5146a7effc9f6ec52b000013"}],"request_time":1363585109}'
+    http_version: !!null 
+  recorded_at: Mon, 18 Mar 2013 05:32:52 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/serp_metrics__command_sets__priorities/get_checks_priority.yml

@@ -0,0 +1,79 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.serpmetrics.com/priority/add
+    body:
+      encoding: US-ASCII
+      string: key=h31x%25sd22hgjd2s&ts=1363584772&auth=lROO29qiF4QDoLetbhqb2gKopwnfB%2Bo%2F3g7RGDPcXx8%3D&params=%7B%22keyword%22%3A%22restaurants%22%2C%22engines%22%3A%5B%22google_en-us%22%5D%7D
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Mar 2013 05:35:49 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '145'
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - app=68i5uv8hoc2deqm91hrdb4smo1; path=/; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"ok","data":[{"phrase":"restaurants","engine_code":"google_en-us","priority_id":"5146a7effc9f6ec52b000013"}],"request_time":1363585107}'
+    http_version: !!null 
+  recorded_at: Mon, 18 Mar 2013 05:32:52 GMT
+- request:
+    method: post
+    uri: http://api.serpmetrics.com/priority/status
+    body:
+      encoding: US-ASCII
+      string: key=h31x%25sd22hgjd2s&ts=1363584772&auth=lROO29qiF4QDoLetbhqb2gKopwnfB%2Bo%2F3g7RGDPcXx8%3D&params=%7B%22priority_id%22%3A%225146a7effc9f6ec52b000013%22%7D
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 18 Mar 2013 05:35:50 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '97'
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept-Encoding
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - app=vs805231hhsur4hjeoi21uq385; path=/; HttpOnly
+    body:
+      encoding: US-ASCII
+      string: ! '{"status":"error","message":"Currently in queue, please retry shortly","request_time":1363585108}'
+    http_version: !!null 
+  recorded_at: Mon, 18 Mar 2013 05:32:52 GMT
+recorded_with: VCR 2.4.0

data/spec/lib/serp_metrics/client_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SerpMetrics::Client do
+  it "provides accessors for key" do
+    instance = described_class.new
+    instance.key = "61dcaafa-5775-4905-b15a-c0dddb323038"
+    instance.key.should == "61dcaafa-5775-4905-b15a-c0dddb323038"
+  end
+
+  it "provides accessors for secret" do
+    instance = described_class.new
+    instance.secret = "4d5c3bb1-b274-4150-801b-7722d3427da1"
+    instance.secret.should == "4d5c3bb1-b274-4150-801b-7722d3427da1"
+  end
+
+  describe "configuration" do
+    it "performs block on client" do
+      instance = described_class.new
+      instance.configure do |client|
+        client.key = "acf08654-4694-4158-8b38-823233844d85"
+        client.secret = "eb9bb368-7c1f-41c0-afa1-c03fbfc2493b"
+      end
+      instance.key.should == "acf08654-4694-4158-8b38-823233844d85"
+      instance.secret.should == "eb9bb368-7c1f-41c0-afa1-c03fbfc2493b"
+    end
+  end
+end

data/spec/lib/serp_metrics/command_sets/account_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe SerpMetrics::CommandSets::Account, :vcr do
+  before do
+    api_configuration = YAML.load_file('spec/api_credentials.yml')
+    @client = SerpMetrics.client.configure do |client|
+      client.key = api_configuration['key']
+      client.secret = api_configuration['secret']
+    end
+  end
+
+  describe "credit" do
+    it "fetches credit information" do
+      response = @client.account.credit
+      response['status'].should == 'ok'
+      response['data'].should be_instance_of(Hash)
+      response['data']['serp_credit'].should_not be_nil
+    end
+  end
+
+  describe "time" do
+    it "fetches time" do
+      response = @client.account.time
+      response['request_time'].should_not be_nil
+    end
+  end
+end

data/spec/lib/serp_metrics/command_sets/engines_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe SerpMetrics::CommandSets::Engines, :vcr do
+  before do
+    api_configuration = YAML.load_file('spec/api_credentials.yml')
+    @client = SerpMetrics.client.configure do |client|
+      client.key = api_configuration['key']
+      client.secret = api_configuration['secret']
+    end
+  end
+
+  describe "codes" do
+    it "fetches search engine codes" do
+      response = @client.engines.codes
+      response['status'].should == 'ok'
+      response['data'].should be_instance_of(Array)
+      response['data'].should_not be_empty
+      response['data'][0]['engine_code'].should_not be_empty
+      response['data'][0]['name'].should_not be_empty
+    end
+  end
+end

data/spec/lib/serp_metrics/command_sets/flux_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe SerpMetrics::CommandSets::Flux, :vcr do
+  before do
+    api_configuration = YAML.load_file('spec/api_credentials.yml')
+    @client = SerpMetrics.client.configure do |client|
+      client.key = api_configuration['key']
+      client.secret = api_configuration['secret']
+    end
+  end
+
+  describe "flux" do
+    it "fetches flux trend" do
+      response = @client.flux.flux('google_en-us')
+      response['data'].should be_instance_of(Hash)
+      trend = response['data'].first
+      trend.should be_instance_of(Array)
+      trend.length.should == 2
+      trend[0].should be_instance_of(String)
+      trend[1].should be_instance_of(Fixnum)
+    end
+  end
+end

data/spec/lib/serp_metrics/command_sets/keywords_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe SerpMetrics::CommandSets::Keywords, :vcr do
+  before do
+    api_configuration = YAML.load_file('spec/api_credentials.yml')
+    @client = SerpMetrics.client.configure do |client|
+      client.key = api_configuration['key']
+      client.secret = api_configuration['secret']
+    end
+  end
+
+  after do
+    response = SerpMetrics.client.keywords.all
+    response['data'].each do |keyword_id, keyword_details|
+      SerpMetrics.client.keywords.remove(keyword_id)
+    end
+
+    # Fail if there are remaining keywords after attempt to remove them.
+    response = SerpMetrics.client.keywords.all
+    response['data'].should be_empty
+  end
+
+  describe "add" do
+    it "adds keyword" do
+      response = @client.keywords.add("restaurants", ['google_en-us'])
+      response['status'].should == 'ok'
+
+      keyword = response['data']
+      keyword['keyword'].should == "restaurants"
+      keyword['engines'].should == ['google_en-us']
+      keyword['keyword_id'].should_not be_empty
+    end
+  end
+
+  describe "remove" do
+    before do
+      response = @client.keywords.add("restaurants", ['google_en-us'])
+      @keyword_id = response['data']['keyword_id']
+    end
+
+    it "removes keyword" do
+      response = @client.keywords.remove(@keyword_id)
+      response['status'].should == 'ok'
+      keyword = response['data'].first
+      keyword['status'].should == 'ok'
+
+      # Verify that there is nothing left to remove.
+      response = @client.keywords.remove(@keyword_id)
+      response['status'].should == 'ok'
+      keyword = response['data'].first
+      keyword['status'].should == 'failed'
+    end
+  end
+
+  describe "check" do
+    before do
+      response = @client.keywords.add("restaurants", ['google_en-us'])
+      @keyword_id = response['data']['keyword_id']
+    end
+
+    it "retrieves checks" do
+      response = @client.keywords.check(@keyword_id, 'google_en-us')
+      response['data'].should_not be_empty
+      response['data']['checks'].should be_instance_of(Hash)
+    end
+  end
+
+  describe "serp" do
+    it "retrieves serp for check" do
+      response = @client.keywords.serp("03bcc63a-dc00-4a41-8010-4fc3346e85b5")
+      response['status'].should_not be_empty
+    end
+  end
+
+  describe "all" do
+    before do
+      @client.keywords.add("restaurants", ['google_en-us'])
+    end
+
+    it "retrieves keywords" do
+      response = @client.keywords.all
+
+      response['status'].should == 'ok'
+      keyword = response['data'].first
+      keyword[0].should_not be_empty
+      keyword[1]['phrase'].should == "restaurants"
+      keyword[1]['engines'].should == ['google_en-us']
+    end
+  end
+end

data/spec/lib/serp_metrics/command_sets/priorities_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe SerpMetrics::CommandSets::Priorities, :vcr do
+  before do
+    api_configuration = YAML.load_file('spec/api_credentials.yml')
+    @client = SerpMetrics.client.configure do |client|
+      client.key = api_configuration['key']
+      client.secret = api_configuration['secret']
+    end
+  end
+
+  describe "add" do
+    context "without location" do
+      it "adds priority" do
+        response = @client.priorities.add("restaurants", ['google_en-us'])
+        response['status'].should == 'ok'
+
+        priority = response['data'].first
+        priority['phrase'].should == "restaurants"
+        priority['engine_code'].should == 'google_en-us'
+        priority['location'].should be_nil
+        priority['priority_id'].should_not be_empty
+      end
+    end
+
+    context "with location" do
+      it "adds priority" do
+        response = @client.priorities.add("restaurants", ['google_en-us'], "Nashville")
+        response['status'].should == 'ok'
+
+        priority = response['data'].first
+        priority['phrase'].should == "restaurants"
+        priority['engine_code'].should == 'google_en-us'
+        priority['location'].should == "Nashville"
+        priority['priority_id'].should_not be_empty
+      end
+    end
+  end
+
+  describe "get" do
+    it "checks priority" do
+      response = @client.priorities.add("restaurants", ['google_en-us'])
+
+      priority = response['data'].first
+      priority_id = priority['priority_id']
+
+      response = @client.priorities.get(priority_id)
+      response['status'].should_not be_nil
+    end
+  end
+end

data/spec/lib/serp_metrics/commands_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe SerpMetrics::Client do
+  before do
+    @client = described_class.new
+  end
+
+  describe ".keywords" do
+    it "assigns client for command set" do
+      @client.keywords.client.should be_equal(@client)
+    end
+
+    it "caches command set for client" do
+      old_command_set = @client.keywords
+      @client.keywords.should be_equal(old_command_set)
+    end
+  end
+
+  describe ".account" do
+    it "assigns client for command set" do
+      @client.account.client.should be_equal(@client)
+    end
+
+    it "caches command set for client" do
+      old_command_set = @client.account
+      @client.account.should be_equal(old_command_set)
+    end
+  end
+
+  describe ".priorities" do
+    it "assigns client for command set" do
+      @client.priorities.client.should be_equal(@client)
+    end
+
+    it "caches command set for client" do
+      old_command_set = @client.priorities
+      @client.priorities.should be_equal(old_command_set)
+    end
+  end
+
+  describe ".flux" do
+    it "assigns client for command set" do
+      @client.flux.client.should be_equal(@client)
+    end
+
+    it "caches command set for client" do
+      old_command_set = @client.flux
+      @client.flux.should be_equal(old_command_set)
+    end
+  end
+
+  describe ".engines" do
+    it "assigns client for command set" do
+      @client.engines.client.should be_equal(@client)
+    end
+
+    it "caches command set for client" do
+      old_command_set = @client.engines
+      @client.engines.should be_equal(old_command_set)
+    end
+  end
+end