serpscan 0.0.1

data/spec/fixtures/vcr_cassettes/Serpscan_Website/keywords/should_return_an_array_of_keyword_objects.yml

@@ -0,0 +1,90 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5055/api/v1/websites/1?token=123
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: 'OK '
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - '"c959b5255215b9b0a60282ec6a65f51d"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 8f36bffc1a857fcc8f3a66ace6bddb91
+      X-Runtime:
+      - '0.022261'
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.9.3/2013-01-15)
+      Date:
+      - Sun, 22 Feb 2015 20:52:37 GMT
+      Content-Length:
+      - '28'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"id":1,"url":"example.com"}'
+    http_version: 
+  recorded_at: Sun, 22 Feb 2015 20:52:37 GMT
+- request:
+    method: get
+    uri: http://localhost:5055/api/v1/websites/1/keywords?token=123
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: 'OK '
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - '"4b29feb9b5591e6d4942ed04b043122e"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 8ccddba541fcaa47d67e17e4b45cf814
+      X-Runtime:
+      - '0.081146'
+      Server:
+      - WEBrick/1.3.1 (Ruby/1.9.3/2013-01-15)
+      Date:
+      - Sun, 22 Feb 2015 20:52:37 GMT
+      Content-Length:
+      - '239'
+      Connection:
+      - Keep-Alive
+    body:
+      encoding: UTF-8
+      string: '{"website_id":"1","page":1,"total_pages":1,"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:52:37 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/serpscan/keyword_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Serpscan::Keyword, vcr: true do
+  it_should_behave_like 'a creatable object',      keyword: 'example keyword', website_id: 1, search_engine_country_id: 1
+
+  it_should_behave_like 'a findable object',  1, Serpscan::Keyword::ATTRIBUTES
+  it_should_behave_like 'a deletable object', 1
+end

data/spec/lib/serpscan/search_engine_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Serpscan::SearchEngine, vcr: true do
+  it_should_behave_like 'a listable object', Serpscan::SearchEngine
+  it_should_behave_like 'a findable object',  1, Serpscan::SearchEngine::ATTRIBUTES
+end

data/spec/lib/serpscan/website_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Serpscan::Website, vcr: true do
+  it_should_behave_like 'a creatable object', url: 'example-website.com'
+  it_should_behave_like 'a listable object', Serpscan::Website
+  it_should_behave_like 'a findable object', 1, Serpscan::Website::ATTRIBUTES
+  it_should_behave_like 'a deletable object', 2
+  it_should_behave_like 'a listable object', Serpscan::Website
+
+  describe 'keywords' do
+    it 'should return a paginated array of keyword objects' do
+      website = subject.class.find(3)
+      keywords = website.keywords
+      expect(keywords.class).to eq Array
+      expect(keywords.first.class).to eq Serpscan::Keyword
+      expect(keywords.first.website.id).to eq website.id
+    end
+  end
+
+  describe 'create_keyword' do
+    let(:phrase) { 'new keyword' }
+
+    it 'should return a keyword object' do
+      website = subject.class.find(1)
+      keyword = website.create_keyword(phrase)
+      expect(keyword.class).to eq Serpscan::Keyword
+      expect(keyword.website).to eq website
+      expect(keyword.phrase).to eq phrase
+      expect(keyword.id).to_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'serpscan'
+require 'rspec'
+require 'webmock'
+require 'vcr'
+
+# Load shared examples
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.ignore_localhost = false
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Serpscan.api_key = '123'
+  end
+
+  config.before(:each) do
+    stub_const 'Serpscan::API::BASE_URL', 'http://localhost:5055/api/v1'
+  end
+end

data/spec/support/shared_examples/creatable.rb

@@ -0,0 +1,7 @@
+RSpec.shared_examples 'a creatable object' do |attributes|
+  let(:object) { subject.class.create(attributes) }
+
+  it 'should return object after creation' do
+    expect(object.class).to be subject.class
+  end
+end

data/spec/support/shared_examples/deletable.rb

@@ -0,0 +1,7 @@
+RSpec.shared_examples 'a deletable object' do |id|
+  let(:object) { subject.class.find(id) }
+
+  it 'should return true after delete' do
+    expect(object.delete).to be true
+  end
+end

data/spec/support/shared_examples/findable.rb

@@ -0,0 +1,9 @@
+RSpec.shared_examples 'a findable object' do |id, attributes|
+  let(:object) { subject.class.find(id) }
+
+  attributes.each do |attribute|
+    it "should return a value for #{attribute}" do
+      expect(object.send(attribute)).not_to be nil
+    end
+  end
+end

data/spec/support/shared_examples/listable.rb

@@ -0,0 +1,7 @@
+RSpec.shared_examples 'a listable object' do |subject|
+  it "should return an array of #{subject} objects" do
+    list = subject.all
+    expect(list.class).to eq Array
+    expect(list.first.class).to eq subject
+  end
+end

metadata

@@ -0,0 +1,240 @@
+--- !ruby/object:Gem::Specification
+name: serpscan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dylan Montgomery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '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: 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: rest-client
+  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: json
+  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: queryparams
+  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'
+description: API client for SERP Scan rank tracker
+email:
+- mail@citizensinspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/serpscan.rb
+- lib/serpscan/account.rb
+- lib/serpscan/api.rb
+- lib/serpscan/errors.rb
+- lib/serpscan/keyword.rb
+- lib/serpscan/search_engine.rb
+- lib/serpscan/search_engine_country.rb
+- lib/serpscan/serpscan_child_object.rb
+- lib/serpscan/serpscan_object.rb
+- lib/serpscan/utilities.rb
+- lib/serpscan/version.rb
+- lib/serpscan/website.rb
+- serpscan.gemspec
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_creatable_object/should_return_object_after_creation.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_deletable_object/should_return_true_after_delete.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_alltime_change.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_current_rank.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_day_change.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_initial_rank.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_phrase.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_search_engine_country_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_search_volume.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_week_change.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_findable_object/should_return_a_value_for_countries.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_findable_object/should_return_a_value_for_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_findable_object/should_return_a_value_for_title.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_listable_object/should_return_an_array_of_Serpscan_SearchEngine_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_listable_object/should_return_an_array_of_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/create_keyword/should_return_a_keyword_object.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_creatable_object/should_return_object_after_creation.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_deletable_object/should_return_true_after_delete.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_findable_object/should_return_a_value_for_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_findable_object/should_return_a_value_for_url.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_listable_object/should_return_an_array_of_Serpscan_Website_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_listable_object/should_return_an_array_of_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/keywords/should_return_a_paginated_array_of_keyword_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/keywords/should_return_an_array_of_keyword_objects.yml
+- spec/lib/serpscan/keyword_spec.rb
+- spec/lib/serpscan/search_engine_spec.rb
+- spec/lib/serpscan/website_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/creatable.rb
+- spec/support/shared_examples/deletable.rb
+- spec/support/shared_examples/findable.rb
+- spec/support/shared_examples/listable.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.4.5
+signing_key: 
+specification_version: 4
+summary: API client for SERP Scan rank tracker
+test_files:
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_creatable_object/should_return_object_after_creation.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_deletable_object/should_return_true_after_delete.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_alltime_change.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_current_rank.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_day_change.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_initial_rank.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_phrase.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_search_engine_country_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_search_volume.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Keyword/it_should_behave_like_a_findable_object/should_return_a_value_for_week_change.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_findable_object/should_return_a_value_for_countries.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_findable_object/should_return_a_value_for_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_findable_object/should_return_a_value_for_title.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_listable_object/should_return_an_array_of_Serpscan_SearchEngine_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_SearchEngine/it_should_behave_like_a_listable_object/should_return_an_array_of_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/create_keyword/should_return_a_keyword_object.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_creatable_object/should_return_object_after_creation.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_deletable_object/should_return_true_after_delete.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_findable_object/should_return_a_value_for_id.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_findable_object/should_return_a_value_for_url.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_listable_object/should_return_an_array_of_Serpscan_Website_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/it_should_behave_like_a_listable_object/should_return_an_array_of_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/keywords/should_return_a_paginated_array_of_keyword_objects.yml
+- spec/fixtures/vcr_cassettes/Serpscan_Website/keywords/should_return_an_array_of_keyword_objects.yml
+- spec/lib/serpscan/keyword_spec.rb
+- spec/lib/serpscan/search_engine_spec.rb
+- spec/lib/serpscan/website_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/creatable.rb
+- spec/support/shared_examples/deletable.rb
+- spec/support/shared_examples/findable.rb
+- spec/support/shared_examples/listable.rb