scrapinghub-client 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+require "rspec"
+require "webmock/rspec"
+require "vcr"
+require "scrapinghub-client"
+
+RSpec::Expectations.configuration.warn_about_potential_false_positives = false
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/fixtures/vcr_cassettes"
+  config.configure_rspec_metadata!
+  config.hook_into :webmock
+  # allow code coverage reports to be sent to Code Climate
+  config.ignore_hosts "codeclimate.com"
+end
+
+RSpec.configure do |c|
+  c.extend VCR::RSpec::Macros
+end

data/spec/unit/jobs_spec.rb

@@ -0,0 +1,188 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require "rspec/autorun"
+
+shared_examples "disallows_unknown_keys" do
+  it "disallows unknown keys" do
+    expect{jobs.send(action, args.merge(foo: "blah"))}.to raise_error ParamContractError
+  end
+end
+
+describe Scrapinghub::Jobs do
+  let(:jobs) { Scrapinghub::Jobs.new(api_key: 'XXX') }
+
+  context "initialization" do
+    context "api_key" do
+      it "is required" do
+        expect{Scrapinghub::Jobs.new}.to raise_error ParamContractError
+        expect{Scrapinghub::Jobs.new({})}.to raise_error ParamContractError
+      end
+
+      it "must be a String" do
+        expect{Scrapinghub::Jobs.new(api_key: nil)}.to raise_error ParamContractError
+        expect{Scrapinghub::Jobs.new(api_key: 1)}.to raise_error ParamContractError
+        expect(Scrapinghub::Jobs.new(api_key: "foo")).to be_a Scrapinghub::Jobs
+      end
+    end
+  end
+
+  context "#list" do
+    let(:action) { :list }
+    let(:args)   { {project: 1} }
+
+    it_behaves_like "disallows_unknown_keys"
+
+    context "valid arguments" do
+      it "passes argument validation" do
+        expect{jobs.send(action, args)}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "project" do
+      it "is required" do
+        expect{jobs.send(action, args.reject{|k,_| k == :project})}.to raise_error ParamContractError
+      end
+
+      it "must be a natural number" do
+        expect{jobs.send(action, args.merge(project: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: "foo"))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: 1))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "job" do
+      it "must be a String or Array[String]" do
+        expect{jobs.send(action, args.merge(job: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(job: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(job: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(job: 1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(job: "foo"))}.not_to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(job: ["foo", "bar"]))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "spider" do
+      it "must be a String" do
+        expect{jobs.send(action, args.merge(spider: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: 1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: "foo"))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "state" do
+      it "must be 'pending', 'running', or 'finished'" do
+        expect{jobs.send(action, args.merge(state: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(state: []))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(state: "foo"))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(state: "pending"))}.not_to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(state: "running"))}.not_to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(state: "finished"))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "has_tag" do
+      it "must be a String or Array[String]" do
+        expect{jobs.send(action, args.merge(has_tag: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(has_tag: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(has_tag: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(has_tag: 1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(has_tag: [1,2,3]))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(has_tag: "foo"))}.not_to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(has_tag: ["foo", "bar"]))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "lacks_tag" do
+      it "must be a String or Array[String]" do
+        expect{jobs.send(action, args.merge(lacks_tag: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(lacks_tag: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(lacks_tag: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(lacks_tag: 1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(lacks_tag: [1,2,3]))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(lacks_tag: "foo"))}.not_to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(lacks_tag: ["foo", "bar"]))}.not_to raise_error ParamContractError
+      end
+    end
+  end
+
+  context "#schedule" do
+    let(:action) { :schedule }
+    let(:args)   { {project: 1, spider: "foo"} }
+
+    it_behaves_like "disallows_unknown_keys"
+
+    context "valid arguments" do
+      it "passes argument validation" do
+        expect{jobs.send(action, args)}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "project" do
+      it "is required" do
+        expect{jobs.send(action, args.reject{|k,_| k == :project})}.to raise_error ParamContractError
+      end
+
+      it "must be a natural number" do
+        expect{jobs.send(action, args.merge(project: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: "foo"))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(project: 1))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "spider" do
+      it "is required" do
+        expect{jobs.send(action, args.reject{|k,_| k == :spider})}.to raise_error ParamContractError
+      end
+
+      it "must be a String" do
+        expect{jobs.send(action, args.merge(spider: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: 1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(spider: "foo"))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "add_tag" do
+      it "must be a String or Array[String]" do
+        expect{jobs.send(action, args.merge(add_tag: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(add_tag: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(add_tag: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(add_tag: 1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(add_tag: [1,2,3]))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(add_tag: "foo"))}.not_to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(add_tag: ["foo", "bar"]))}.not_to raise_error ParamContractError
+      end
+    end
+
+    context "priority" do
+      it "must be 0, 1, 2, 3, or 4" do
+        expect{jobs.send(action, args.merge(priority: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(priority: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(priority: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(priority: 5))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(priority: "foo"))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(priority: []))}.to raise_error ParamContractError
+      end
+    end
+
+    context "extra" do
+      it "must be a HashOf[Symbol => String]" do
+        expect{jobs.send(action, args.merge(extra: nil))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: 1.234))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: -1))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: 5))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: "foo"))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: []))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: {"foo" => "bar"}))}.to raise_error ParamContractError
+        expect{jobs.send(action, args.merge(extra: {foo: 1}))}.to raise_error ParamContractError
+      end
+    end
+  end
+
+end

data/spec/unit/scrapinghub_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+require "rspec/autorun"
+
+describe Scrapinghub do
+  it "is equivalent to ScrapingHub" do
+    expect(Scrapinghub).to be(ScrapingHub)
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: scrapinghub-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abe Voelker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: kleisli
+  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: httparty
+  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: rake
+  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: 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: 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'
+description: Ruby client for Scrapinghub API
+email: abe@abevoelker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/scrapinghub-client.rb
+- lib/scrapinghub/jobs.rb
+- lib/scrapinghub/version.rb
+- scrapinghub.gemspec
+- spec/fixtures/vcr_cassettes/jobs/delete/bad_auth.yml
+- spec/fixtures/vcr_cassettes/jobs/delete/job/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/delete/job/multiple.yml
+- spec/fixtures/vcr_cassettes/jobs/delete/job/single.yml
+- spec/fixtures/vcr_cassettes/jobs/delete/project/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/delete/project/valid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/bad_auth.yml
+- spec/fixtures/vcr_cassettes/jobs/list/count/3.yml
+- spec/fixtures/vcr_cassettes/jobs/list/has_tag/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/has_tag/multiple.yml
+- spec/fixtures/vcr_cassettes/jobs/list/has_tag/single.yml
+- spec/fixtures/vcr_cassettes/jobs/list/job/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/job/multiple.yml
+- spec/fixtures/vcr_cassettes/jobs/list/job/single.yml
+- spec/fixtures/vcr_cassettes/jobs/list/lacks_tag/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/lacks_tag/multiple.yml
+- spec/fixtures/vcr_cassettes/jobs/list/lacks_tag/single.yml
+- spec/fixtures/vcr_cassettes/jobs/list/project/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/project/valid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/spider/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/spider/valid.yml
+- spec/fixtures/vcr_cassettes/jobs/list/state/finished.yml
+- spec/fixtures/vcr_cassettes/jobs/list/state/pending.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/bad_auth.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/project/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/spider/add_tag.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/spider/already-running.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/spider/extra.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/spider/minimal.yml
+- spec/fixtures/vcr_cassettes/jobs/schedule/spider/priority.yml
+- spec/fixtures/vcr_cassettes/jobs/stop/bad_auth.yml
+- spec/fixtures/vcr_cassettes/jobs/stop/job/already-stopped.yml
+- spec/fixtures/vcr_cassettes/jobs/stop/job/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/stop/job/valid.yml
+- spec/fixtures/vcr_cassettes/jobs/stop/project/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/update/bad_auth.yml
+- spec/fixtures/vcr_cassettes/jobs/update/has_tag.yml
+- spec/fixtures/vcr_cassettes/jobs/update/job.yml
+- spec/fixtures/vcr_cassettes/jobs/update/lacks_tag.yml
+- spec/fixtures/vcr_cassettes/jobs/update/no-query-filters.yml
+- spec/fixtures/vcr_cassettes/jobs/update/no-update-params.yml
+- spec/fixtures/vcr_cassettes/jobs/update/project/invalid.yml
+- spec/fixtures/vcr_cassettes/jobs/update/spider.yml
+- spec/fixtures/vcr_cassettes/jobs/update/state.yml
+- spec/integration/jobs_spec.rb
+- spec/spec_helper.rb
+- spec/unit/jobs_spec.rb
+- spec/unit/scrapinghub_spec.rb
+homepage: https://github.com/abevoelker/scrapinghub-client
+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: Ruby client for Scrapinghub API
+test_files: []