rest-scrapyd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07145a8352001d446eec7552548b46f13353dbda
+  data.tar.gz: dea9c9d7988700c9b95b463a8e9ec7ffa190406d
+SHA512:
+  metadata.gz: 4aaa558d3cdb57c41585752b4ae6c0687b4f3f104d79aceb54bbedbcc37aa08bd859af5b6bff8cc764fcc6333d39895091c3e233e408766a9e97aedeaabd3102
+  data.tar.gz: 4e6aaef7f108cf06ec7ab9a78aee2c15ed070d34cb29b2d81fd2373bb0e3457ec1ac14c4590d44d5922b892af4b04f74f008671678165a9c1671d5bdef32f8ee

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2015 wvengen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+rest-scrapyd
+============
+[![Gem Version](https://badge.fury.io/rb/rest-scrapyd.svg)](http://badge.fury.io/rb/rest-scrapyd)
+[![Documentation](http://b.repl.ca/v1/yard-docs-blue.png)](http://rubydoc.info/github/wvengen/rest-scrapyd)
+
+Ruby client for the [Scrapyd](http://scrapyd.readthedocs.org/) REST API
+built on top of [rest-core](https://github.com/godfat/rest-core).
+
+
+Installation
+------------
+
+```sh
+gem install rest-scrapyd
+```
+
+or, when using a Gemfile
+
+```ruby
+gem 'rest-scrapyd'
+```
+
+and run `bundle install`.
+
+
+Usage
+-----
+
+```ruby
+require 'rest-scrapyd'
+
+r = RestScrapyd.new site: "http://example.com:6800/"
+r.listprojects
+# => ["project1", "project2"]
+r.listspiders(project: "project1")
+# => ["spider1", "spider2"]
+
+# connect to default site at http://localhost:6800/
+r = RestScrapyd.new
+# and set a default project
+r.project = "project1"
+r.listspiders
+# => ["spider1", "spider2"]
+r.listversions
+# => ["123456-master"]
+
+# you can also specify a default project on construction
+r = RestScrapyd.new project: "project1"
+r.schedule("spider1", "123456-master")
+# => "1234567890abcdef1234567890abcdef"
+```
+
+For more information, see the [RestScrapyd](http://rubydoc.info/github/wvengen/rest-scrapyd/RestScrapyd.html)
+and [Scrapyd API](http://scrapyd.readthedocs.org/en/latest/api.html) documentation.
+
+
+Copyright
+---------
+
+Copyright © 2015 wvengen, released under the [MIT license](LICENSE).

data/lib/rest-scrapyd.rb

@@ -0,0 +1,104 @@
+#
+# Simple REST-client for the Scrapyd API
+#
+require 'rest-core'
+
+RestScrapyd = RC::Builder.client do
+  use RC::Timeout       , 3
+
+  use RC::DefaultSite   , 'http://localhost:6800/'
+  use RC::DefaultHeaders, {'Accept' => 'application/json'}
+
+  use RC::CommonLogger  , nil
+  use RC::ErrorHandler  , lambda {|env| RuntimeError.new(env[RC::RESPONSE_BODY]['message']) }
+  use RC::ErrorDetector , lambda {|env| env[RC::RESPONSE_BODY]['status'] != 'ok'}
+  use RC::ErrorDetectorHttp
+  use RC::JsonResponse  , true
+  use RC::Cache         , nil, 600
+end
+
+# Don't define a `RestScrapyd::Client` and include it in the class to avoid yardoc choking
+class RestScrapyd
+  include RestCore
+
+  # @!attribute project
+  # Default project name (can also be passed as hash argument to constructor).
+  attr_accessor :project
+
+  # Add a version to a project, creating the project if it doesn’t exist.
+  # @param version [String] Project version
+  # @param egg [String, IO] Filename or file to upload, must be a Scrapy egg
+  # @return [Hash<String, Object>] Response, right now just +{"spiders": <n>}+
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#addversion-json
+  def addversion(version, egg, project=self.project)
+    egg = File.open(egg, 'rb') if egg.is_a? String
+    post('addversion.json', project: project, version: version, egg: egg)
+  end
+
+  # Schedule a spider run (also known as a job).
+  # @param spider [String] Spider name
+  # @param version [String] Project version
+  # @param settings [Hash<String, String>] Additional Scrapy settings
+  # @option settings [String] :project ({self.project}) Project name
+  # @return [String] Job id
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#schedule-json
+  def schedule(spider, version, settings={})
+    settings = {project: self.project, spider: spider}.merge(settings)
+    post('schedule.json', settings)['jobid']
+  end
+
+  # Cancel a scheduled or running job
+  # @param job [String] Jobid to cancel
+  # @param project [String] Project name
+  # @return [String] Previous state of job
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#cancel-json
+  def cancel(job, project=self.project)
+    post('cancel.json', project: project, job: job)['prevstate']
+  end
+
+  # Get the list of projects uploaded to this Scrapy server.
+  # @return [Array<String>] Available projects
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#listprojects-json
+  def listprojects
+    get('listprojects.json')['projects']
+  end
+
+  # Get the list of versions available for some project.
+  # @param project [String] Project name
+  # @return [Array<String>] Available versions for project
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#listversions-json
+  def listversions(project=self.project)
+    get('listversions.json', project: project)['versions']
+  end
+
+  # Get the list of spiders available in the last version of some project.
+  # @param project [String] Project name
+  # @return [Array<String>] Available spiders for project
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#listspiders-json
+  def listspiders(project=self.project)
+    get('listspiders.json', project: project)['spiders']
+  end
+
+  # Get the list of pending, running and finished jobs of some project.
+  # @param project [String] Project name
+  # @return [Hash<String, Array<Hash>>] Jobs for project
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#listjobs-json
+  def listjobs(project=self.project)
+    get('listjobs.json', project: project).reject{|k,v| k=='status'}
+  end
+
+  # Delete a project version.
+  # @param version [String] Project version
+  # @param project [String] Project name
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#delversion-json
+  def delversion(version, project=self.project)
+    post('delversion.json', project: project, version: version)
+  end
+
+  # Delete a project and all its uploaded versions.
+  # @param project [String] Project name
+  # @see http://scrapyd.readthedocs.org/en/latest/api.html#delproject-json
+  def delproject(project)
+    post('delproject.json', project: project)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: rest-scrapyd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wvengen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: REST client for the Scrapyd API, built with [rest-core](https://github.com/godfat/rest-core).
+email: dev-rails@willem.engen.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/rest-scrapyd.rb
+homepage: https://github.com/wvengen/ruby-rest-scrapyd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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.3
+signing_key: 
+specification_version: 4
+summary: REST client for the Scrapyd API
+test_files: []