scrapinghub-client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5388fb17c08f77b3091bdb87b8be779237f21404
-  data.tar.gz: 3756c4dcaefbf715608a9d958beb986f18b6f8da
+  metadata.gz: 3511f325b2c1cc5ecb3757701a6ff3bc837f57ff
+  data.tar.gz: c32c5d71fe5f8fec373efbe530f3e704ae28d80f
 SHA512:
-  metadata.gz: 457ceddece99e63f370213e5b17a667d414d315f750cc7ff675dc98e7ce56f179c03fa84b9d73c6951511a6adb2e68c80ef28bfccfe3fa9cc7ea19ec305a05e6
-  data.tar.gz: ed0dcb6729211f0dc44e57ebe047e71ccc8ea87b24b21e1b7d30ca6be223c3f361f61e905ff005c15ce3d9ef9d38f96e60513e97c694db9bad92f3b62407f38d
+  metadata.gz: 9788f21ed29f22d3d65652243a8585f733e5383e5e1bfe7712f1532d10f03269f7759d877c061c9c6957a554cdf776bd3d1f0b35d4f3d21e4371772e93ef2e2d
+  data.tar.gz: 8af726be06460cff06d67db37f245d167a3c97a6de391c6e08a4bd62e3a7ff23e6f2a197e2ee3d77d9699f25fcc338cfedbeee9fa4834cdaa1d9dc4257df72b5

data/README.md

@@ -8,7 +8,7 @@ Scrapinghub client
 
 Ruby client for the [Scrapinghub API][api]. So far it only supports the [Jobs API][jobs-api] (pull requests welcome).
 
-This library tries to take an FP-ish approach. It uses the [contracts gem][contracts] for validating function input and output types (see the [docs][] for the full list of functions and their types) and the [kleisli gem][kleisli] for returning composition-friendly output types. Outputs will be a `Try::Failure` if an exception was raised (e.g. a network timeout), a `Left` if the Scrapinghub API returns failure, or a `Right` if the operation was successful.
+This library tries to take an FP-ish approach. It uses the [contracts gem][contracts] for validating function input and output types (see the [docs][] for the full list of functions and their types) and the [kleisli gem][kleisli] for returning composition-friendly output types. Outputs will be a `Left` if the Scrapinghub API returns failure or if an exception was raised (e.g. a network timeout), or a `Right` if the operation was successful.
 
 The Kleisli gem [introductory blog post][kleisli-blog] gives some great examples on how to work with the output types.
 
@@ -32,7 +32,7 @@ require "scrapinghub-client"
 j = Scrapinghub::Jobs.new(api_key: 'abc123')
 j.schedule(project: 123, spider: "foo", add_tag: "bar", extra: { DOWNLOAD_DELAY: "0.5" })
   .fmap{|r| puts "Job scheduled! Jobid: #{r['jobid']}"}
-  .or{|f| puts "Failed to schedule job! Reason: #{f.inspect}"}
+  .or{|f| puts "Failed to schedule job! Reason: #{f.value}"}
 ```
 
 [travis]: https://travis-ci.org/abevoelker/scrapinghub-client

data/lib/scrapinghub/jobs.rb

@@ -25,7 +25,7 @@ module Scrapinghub
                          :state => Optional[Or["pending", "running", "finished"]],
                          :has_tag => Optional[Or[String, ArrayOf[String]]],
                          :lacks_tag => Optional[Or[String, ArrayOf[String]]],
-                         :count => Optional[Nat] ] => Or[Kleisli::Try, Kleisli::Either]
+                         :count => Optional[Nat] ] => Kleisli::Either
     # Retrieve information about jobs.
     #
     # @param project [Fixnum] the project's numeric ID
@@ -41,13 +41,13 @@ module Scrapinghub
     #   containing the given tag(s)
     # @param count [Fixnum] (optional) maximum number of jobs to return
     #
-    # @return [Kleisli::Try, Kleisli::Either] a Kleisli::Try if a low-level
-    #   exception is raised (e.g. the host is down), a Kleisli::Either::Left
-    #   if validation fails (e.g. bad authentication), or a
-    #   Kleisli::Either::Right if everything was successful.
+    # @return [Kleisli::Left] if validation fails (e.g. bad authentication) or
+    #   if there were any low-level exceptions (e.g. the host is down), with a
+    #   message detailing the failure.
+    # @return [Kleisli::Right] if the operation was successful.
     def list(args)
       options = { query: args, basic_auth: { username: @api_key } }
-      Try { self.class.get("/api/jobs/list.json", options) } >-> response {
+      Try { self.class.get("/api/jobs/list.json", options) }.to_either >-> response {
         if response.code == 200
           Right(response)
         else
@@ -60,7 +60,7 @@ module Scrapinghub
                          :spider => String,
                          :add_tag => Optional[Or[String, ArrayOf[String]]],
                          :priority => Optional[Or[0, 1, 2, 3, 4]],
-                         :extra => Optional[HashOf[Symbol => String]] ] => Or[Kleisli::Try, Kleisli::Either]
+                         :extra => Optional[HashOf[Symbol => String]] ] => Kleisli::Either
     # Schedule a job.
     #
     # @param project [Fixnum] the project's numeric ID
@@ -71,14 +71,14 @@ module Scrapinghub
     # @param extra [Hash] (optional) extra parameters passed as spider
     #   arguments
     #
-    # @return [Kleisli::Try, Kleisli::Either] a Kleisli::Try if a low-level
-    #   exception is raised (e.g. the host is down), a Kleisli::Either::Left
-    #   if validation fails (e.g. bad authentication), or a
-    #   Kleisli::Either::Right if everything was successful.
+    # @return [Kleisli::Left] if validation fails (e.g. bad authentication) or
+    #   if there were any low-level exceptions (e.g. the host is down), with a
+    #   message detailing the failure.
+    # @return [Kleisli::Right] if the operation was successful.
     def schedule(args)
       extra = args.delete(:extra) || {}
       options = { body: args.merge(extra), basic_auth: { username: @api_key } }
-      Try { self.class.post("/api/schedule.json", options) } >-> response {
+      Try { self.class.post("/api/schedule.json", options) }.to_either >-> response {
         if response.code == 200
           Right(response)
         else
@@ -94,7 +94,7 @@ module Scrapinghub
                          :has_tag => Optional[Or[String, ArrayOf[String]]],
                          :lacks_tag => Optional[Or[String, ArrayOf[String]]],
                          :add_tag => Optional[Or[String, ArrayOf[String]]],
-                         :remove_tag => Optional[Or[String, ArrayOf[String]]] ] => Or[Kleisli::Try, Kleisli::Either]
+                         :remove_tag => Optional[Or[String, ArrayOf[String]]] ] => Kleisli::Either
     # Update information about jobs.
     #
     # @param project [Fixnum] the project's numeric ID
@@ -112,13 +112,13 @@ module Scrapinghub
     # @param remove_tag [String, Array<String>] (optional) tag(s) to remove
     #   from the queried jobs
     #
-    # @return [Kleisli::Try, Kleisli::Either] a Kleisli::Try if a low-level
-    #   exception is raised (e.g. the host is down), a Kleisli::Either::Left
-    #   if validation fails (e.g. bad authentication), or a
-    #   Kleisli::Either::Right if everything was successful.
+    # @return [Kleisli::Left] if validation fails (e.g. bad authentication) or
+    #   if there were any low-level exceptions (e.g. the host is down), with a
+    #   message detailing the failure.
+    # @return [Kleisli::Right] if the operation was successful.
     def update(args)
       options = { body: args, basic_auth: { username: @api_key } }
-      Try { self.class.post("/api/jobs/update.json", options) } >-> response {
+      Try { self.class.post("/api/jobs/update.json", options) }.to_either >-> response {
         if response.code == 200
           Right(response)
         else
@@ -128,19 +128,19 @@ module Scrapinghub
     end
 
     Contract KeywordArgs[:project => Nat,
-                         :job => Or[String, ArrayOf[String]] ] => Or[Kleisli::Try, Kleisli::Either]
+                         :job => Or[String, ArrayOf[String]] ] => Kleisli::Either
     # Delete one or more jobs.
     #
     # @param project [Fixnum] the project's numeric ID
     # @param job [String, Array<String>] the ID of a specific job to delete
     #
-    # @return [Kleisli::Try, Kleisli::Either] a Kleisli::Try if a low-level
-    #   exception is raised (e.g. the host is down), a Kleisli::Either::Left
-    #   if validation fails (e.g. bad authentication), or a
-    #   Kleisli::Either::Right if everything was successful.
+    # @return [Kleisli::Left] if validation fails (e.g. bad authentication) or
+    #   if there were any low-level exceptions (e.g. the host is down), with a
+    #   message detailing the failure.
+    # @return [Kleisli::Right] if the operation was successful.
     def delete(args)
       options = { body: args, basic_auth: { username: @api_key } }
-      Try { self.class.post("/api/jobs/delete.json", options) } >-> response {
+      Try { self.class.post("/api/jobs/delete.json", options) }.to_either >-> response {
         if response.code == 200
           Right(response)
         else
@@ -150,19 +150,19 @@ module Scrapinghub
     end
 
     Contract KeywordArgs[:project => Nat,
-                         :job => String ] => Or[Kleisli::Try, Kleisli::Either]
+                         :job => String ] => Kleisli::Either
     # Stop one or more running jobs.
     #
     # @param project [Fixnum] the project's numeric ID
     # @param job [String] the ID of a job to stop
     #
-    # @return [Kleisli::Try, Kleisli::Either] a Kleisli::Try if a low-level
-    #   exception is raised (e.g. the host is down), a Kleisli::Either::Left
-    #   if validation fails (e.g. bad authentication), or a
-    #   Kleisli::Either::Right if everything was successful.
+    # @return [Kleisli::Left] if validation fails (e.g. bad authentication) or
+    #   if there were any low-level exceptions (e.g. the host is down), with a
+    #   message detailing the failure.
+    # @return [Kleisli::Right] if the operation was successful.
     def stop(args)
       options = { body: args, basic_auth: { username: @api_key } }
-      Try { self.class.post("/api/jobs/stop.json", options) } >-> response {
+      Try { self.class.post("/api/jobs/stop.json", options) }.to_either >-> response {
         if response.code == 200
           Right(response)
         else

data/lib/scrapinghub/version.rb

@@ -1,3 +1,3 @@
 module Scrapinghub
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/scrapinghub.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
 
   s.add_dependency "contracts", "~> 0.11"
-  s.add_dependency "kleisli"
+  s.add_dependency "kleisli", ">= 0.2.7"
   s.add_dependency "httparty"
 
   s.add_development_dependency "rake"

data/spec/integration/jobs_spec.rb

@@ -5,8 +5,8 @@ shared_examples "connection_refused_returns_try" do
     stub_request(:any, "dash.scrapinghub.com").to_timeout
   end
 
-  it "returns a Try::Failure when host is down" do
-    expect(jobs.send(action, args)).to be_a Kleisli::Try::Failure
+  it "returns a Kleisli::Either::Left when host is down" do
+    expect(jobs.send(action, args)).to be_a Kleisli::Either::Left
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrapinghub-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Abe Voelker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for Scrapinghub API