si-copyscape 0.1.0

data/test/cassettes/api_private_matches.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://www.copyscape.com/api/?c=3&e=UTF-8&k=test&o=psearch&u=test
+    body:
+      encoding: UTF-8
+      string: Because they are far less expensive when used, impractical vehicles
+        sell well in the secondary market.
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 26 Aug 2015 17:03:50 GMT
+      Server:
+      - Apache/2.2.15 (CentOS)
+      X-Powered-By:
+      - PHP/5.3.3
+      Set-Cookie:
+      - ck=A4D7XKCZ0AO0KGWG80G88KCS4; expires=Fri, 25-Aug-2017 17:03:50 GMT; path=/;
+        domain=.copyscape.com
+      Content-Length:
+      - '1081'
+      Connection:
+      - close
+      Content-Type:
+      - text/xml; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<response>\n\t<querywords>17</querywords>\n\t<count>1</count>\n\t<result>\n\t\t<index>1</index>\n\t\t<url></url>\n\t\t<id>88029</id>\n\t\t<handle>SIA_2_E00JOQ0A2W_OJLHS6GHNQ</handle>\n\t\t<articlewords>553</articlewords>\n\t\t<added>2015-08-26
+        17:06:42</added>\n\t\t<title>Content Manager Content Version for item: 22003</title>\n\t\t<textsnippet>
+        ... are far less expensive when used, impractical vehicles sell well in the
+        secondary market ... </textsnippet>\n\t\t<htmlsnippet> ... are far less expensive
+        when used, impractical vehicles sell well in the secondary market ... </htmlsnippet>\n\t\t<minwordsmatched>14</minwordsmatched>\n\t\t<wordsmatched>16</wordsmatched>\n\t\t<textmatched>Because
+        they are far less expensive when used, impractical vehicles sell well in the
+        secondary market</textmatched>\n\t\t<percentmatched>94</percentmatched>\n\t</result>\n\t<allwordsmatched>16</allwordsmatched>\n\t<allpercentmatched>94</allpercentmatched>\n\t<alltextmatched>Because
+        they are far less expensive when used, impractical vehicles sell well in the
+        secondary market</alltextmatched>\n</response>\n"
+    http_version:
+  recorded_at: Wed, 26 Aug 2015 17:08:02 GMT
+recorded_with: VCR 2.9.3

data/test/test_copyscape.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+class TestCopyscape < Minitest::Test
+  def setup
+    @cs = begin_copyscape
+
+    VCR.use_cassette("api_balance") do
+      @credit_balance = @cs.credit_balance
+    end
+    VCR.use_cassette("api_add_to_private_index") do
+      @private_index = @cs.add_to_private_index(text: 'Putting some text in our private index.  Fee Fi Fo Fum I smell the blood of an englishman')
+    end
+  end
+
+  def test_error
+    VCR.use_cassette("api_error") do
+      response = @cs.internet_matches! 'test'
+      error = 'At least 15 words are required to perform a search'
+      assert_equal(response.error, error)
+    end
+
+    VCR.use_cassette("api_internet_matches") do
+      response = @cs.internet_matches! 'A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+      assert_nil(response.error, "When no errors, error should return nil")
+    end
+  end
+
+  def test_credit_balance
+    assert_instance_of(SI::CopyScape::Balance, @credit_balance)
+  end
+
+  def test_credit_balance_value
+    assert(@credit_balance.value.is_a?(Float), "Credit Balance value must be a Float")
+    assert_equal(@credit_balance.value, 240.51)
+  end
+
+  def test_credit_balance_total
+    assert(@credit_balance.total.is_a?(Integer), "Credit Total must be an Int")
+    assert_equal(@credit_balance.total, 4810)
+  end
+
+  def test_credit_balance_today
+    assert(@credit_balance.today.is_a?(Integer), "Credit Total Today must be an Int")
+    assert_equal(@credit_balance.today, 4810)
+  end
+
+  def test_internet_matches
+    VCR.use_cassette("api_internet_matches") do
+      response = @cs.internet_matches! 'A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+      assert_instance_of(SI::CopyscapeMatches, response)
+    end
+  end
+
+  def test_private_matches
+    VCR.use_cassette("api_private_matches") do
+      response = @cs.private_matches! 'Because they are far less expensive when used, impractical vehicles sell well in the secondary market.'
+      assert_instance_of(SI::CopyscapeMatches, response)
+    end
+  end
+
+  def test_internet_and_private_matches
+    VCR.use_cassette("api_internet_and_private_matches") do
+      response = @cs.internet_and_private_matches! 'A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+      assert_instance_of SI::CopyscapeMatches, response
+    end
+  end
+
+  def test_add_to_private_index
+    assert_instance_of SI::CopyScape::PrivateIndex, @private_index
+  end
+
+  def test_private_index_words
+    assert(@private_index.words.is_a?(Integer), 'Private Index words must return an integer')
+    assert_equal(@private_index.words, 18)
+  end
+
+  def test_private_index_handle
+    assert(@private_index.handle.is_a?(String), 'Private Index handle must return a string')
+    assert_equal(@private_index.handle, 'SIA_2_E00JOQ0A2W_F0N8GRC4GS')
+  end
+
+  def test_private_index_id
+    assert_nil(@private_index.id)
+  end
+
+  def test_private_index_title
+    assert_nil(@private_index.title)
+  end
+end

data/test/test_copyscape_api.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class TestCopyscapeAPI < Minitest::Test
+  def test_request
+    api = SI::CopyscapeAPI.new(
+      username: 'test',
+      api_key: 'test',
+      api_url: 'http://www.copyscape.com/api/'
+    )
+    VCR.use_cassette("api_balance") do
+      response = api.request(operation: 'balance')
+      assert_instance_of SI::CopyscapeResponse, response
+    end
+  end
+end

data/test/test_copyscape_matches.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class TestCopyscapeMatches < Minitest::Test
+  def setup
+    VCR.use_cassette("api_internet_matches") do
+      cs = begin_copyscape
+      @matches = cs.internet_matches! 'A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+      @match = @matches.first
+    end
+  end
+
+  def test_matches_object
+    assert_instance_of(SI::CopyscapeMatches, @matches)
+    assert(@matches.is_a?(Enumerable), 'Expected matches to be enumerable')
+  end
+
+  def test_matches_object_count
+    assert_equal(@matches.count, 2, 'What goes in should come out')
+  end
+
+  def test_match_object
+    assert_instance_of(SI::CopyScape::Match, @match)
+  end
+
+  def test_match_html_snippet
+    snippet = '<font color="#777777">... Trusted, Scalable Search, Social and Online Advertising. </font><font color="#000000">A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.</font>'
+    assert_equal(@match.html_snippet, snippet)
+  end
+
+  def test_match_test_snippet
+    snippet = '... Trusted, Scalable Search, Social and Online Advertising. A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+    assert_equal(@match.text_snippet, snippet)
+  end
+
+  def test_match_copyscape_url
+    url = 'http://view.copyscape.com/compare/6jq6k9utaz/1'
+    assert_equal(@match.copyscape_url, url)
+  end
+
+  def test_match_url
+    url = 'http://www.searchinfluence.com/'
+    assert_equal(@match.url, url)
+  end
+
+  def test_match_title
+    title = 'Search Influence | Website Promotion Company'
+    assert_equal(@match.title, title)
+  end
+
+  def test_match_percent_matched
+    assert_equal(@match.percent_matched, 100)
+  end
+
+  def test_match_words_matched
+    assert_equal(@match.words_matched, 20)
+  end
+
+  def test_all_text_snippets
+    snippet = '... Trusted, Scalable Search, Social and Online Advertising. A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+    snippets = @matches.all_text_snippets
+    assert_kind_of(Array, snippets)
+    assert_equal(snippets.first, snippet)
+  end
+
+  def test_all_html_snippets
+    snippet = '<font color="#777777">... Trusted, Scalable Search, Social and Online Advertising. </font><font color="#000000">A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.</font>'
+    snippets = @matches.all_html_snippets
+    assert_kind_of(Array, snippets)
+    assert_equal(snippets.first, snippet)
+  end
+end

data/test/test_copyscape_response.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class TestCopyscapeResponse < Minitest::Test
+  def setup
+    api = SI::CopyscapeAPI.new(
+      username: 'test',
+      api_key: 'test',
+      api_url: 'http://www.copyscape.com/api/'
+    )
+    VCR.use_cassette("api_internet_matches") do
+      text = 'A national website promotion company, Search Influence routinely delivers a 10:1 return on investment, or better, for our customers.'
+      @response = api.request(operation: 'csearch', params: {c:3, e: 'UTF-8'}, postdata: text)
+    end
+  end
+
+  def test_raw_xml
+    assert_kind_of(String, @response.raw_xml, 'raw_xml should return an xml string')
+  end
+
+  def test_raw_hash
+    assert(@response.raw_hash.is_a?(Hash), "raw_hash method must return a hash")
+  end
+
+  def test_remaining_on_normal_search
+    assert_nil(@response.remaining, 'remaining should be nil if this isnt a balance check')
+  end
+
+  def test_remaining_on_balance_check
+    VCR.use_cassette("api_balance") do
+      api = SI::CopyscapeAPI.new(username: 'test', api_key: 'test', api_url: 'http://www.copyscape.com/api/')
+      balance_response = api.request(operation: 'balance')
+      assert_instance_of(SI::CopyscapeResponse, balance_response)
+    end
+  end
+
+  def test_response
+    assert(@response.response.is_a?(Hash), "response method must return a hash")
+  end
+
+  def test_results
+    assert(@response.results.is_a?(Array), 'results method must return an array')
+  end
+
+  def test_query_words
+    assert_equal(@response.query_words, 20)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'minitest/autorun'
+require 'copyscape_api'
+require 'copyscape'
+require 'copyscape_matches'
+require 'copyscape_response'
+require 'crack'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "test/cassettes"
+  config.hook_into :webmock # or :fakeweb
+end
+
+def begin_copyscape
+  SI::CopyScape.new(username: 'test', api_key: 'test')
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: si-copyscape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shane Kretzmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: guard
+  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: guard-minitest
+  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: 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: crack
+  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: Allow any ruby application to easily interact with copyscape premium
+  api
+email:
+- SKretzmann@searchinfluence.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- lib/copyscape.rb
+- lib/copyscape_api.rb
+- lib/copyscape_matches.rb
+- lib/copyscape_response.rb
+- lib/si-copyscape.rb
+- lib/version.rb
+- si-copyscape.gemspec
+- test/cassettes/api_add_to_private_index.yml
+- test/cassettes/api_balance.yml
+- test/cassettes/api_error.yml
+- test/cassettes/api_internet_and_private_matches.yml
+- test/cassettes/api_internet_matches.yml
+- test/cassettes/api_private_matches.yml
+- test/test_copyscape.rb
+- test/test_copyscape_api.rb
+- test/test_copyscape_matches.rb
+- test/test_copyscape_response.rb
+- test/test_helper.rb
+homepage: https://github.com/searchinfluence/copyscape
+licenses:
+- Private Property (c) Search Influence
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem to interface with Copyscape api
+test_files:
+- test/cassettes/api_add_to_private_index.yml
+- test/cassettes/api_balance.yml
+- test/cassettes/api_error.yml
+- test/cassettes/api_internet_and_private_matches.yml
+- test/cassettes/api_internet_matches.yml
+- test/cassettes/api_private_matches.yml
+- test/test_copyscape.rb
+- test/test_copyscape_api.rb
+- test/test_copyscape_matches.rb
+- test/test_copyscape_response.rb
+- test/test_helper.rb