ferto 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97a79db2d44895104a87860165f149d3b08ebe7b
-  data.tar.gz: 28bd5801d93445f394629766cf18d6bc2547ece3
+  metadata.gz: 9fe993b148492a811c70a78c299c483b2d23ef5e
+  data.tar.gz: '0180f279e8372d85c5e908060cb3c43e50467d62'
 SHA512:
-  metadata.gz: 7c04fbf4d9943121888bb8d211a4a31d8098e891150154f7c6853e4309d55fb87f46b2c86046fca8589d981d2d7eb5827fee54487d6f8ce12109abcad6bb2690
-  data.tar.gz: 05d6a9d9f3f4064d7e461eb57a4702eed647e9fca734e722e21db50ab973a901335fcb0f0e4a9ef339ffe2ecbaa01c5c00a6307d25a74ce50e748a165869177c
+  metadata.gz: '09ca432db72f3bb2f2c6456672f95a075c58ce32530fe0fc4fdd52849918d013f361157d2626e2899bc9b8f8912979cfbce46bbdf32cc5750a900d6b6cdb6d4a'
+  data.tar.gz: 6c1384ff84dcb8ce3afbafed63e61562b58743194a1ccf6c50f24be0624d95cd70165a543235b6f2e016fbaf5f3879b94be577da560883504b5cf5f5276302e1

data/.gitignore

@@ -9,4 +9,5 @@
 /tmp/
 
 *.swp
+*.gem
 .rspec

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/skroutz/ferto.svg?branch=master)](https://travis-ci.org/skroutz/ferto)
 [![Gem Version](https://badge.fury.io/rb/ferto.svg)](https://badge.fury.io/rb/ferto)
+[![Documentation](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/skroutz/ferto)
 
 A Ruby client for [skroutz/downloader](https://github.com/skroutz/downloader).
 

data/lib/ferto/client.rb

@@ -26,7 +26,7 @@ module Ferto
     #   the service to make.
     attr_reader :aggr_limit
 
-    # @param [Hash{Symbol => String, Fixnum}]
+    # @param opts [Hash{Symbol => String, Fixnum}]
     # @option opts [String] :scheme
     # @option opts [String] :host
     # @option opts [String] :path
@@ -47,22 +47,43 @@ module Ferto
 
     # Sends a request to Downloader and returns its reply.
     #
+    # @param url           [String] the resource to be downloaded
+    # @param callback_type [String]
+    # @param callback_dst  [String] the callback destination
+    # @param mime_type     [String] (default: "") accepted MIME types for the
+    #   resource
+    # @param aggr_id       [String] aggregation identifier
+    # @param aggr_limit    [Integer] aggregation concurrency limit
+    # @param aggr_proxy    [String] the HTTP proxy to use for downloading the
+    #   resource, by default no proxy is used. The proxy is set up on
+    #   aggregation level and it cannot be updated for an existing aggregation.
+    # @param download_timeout [Integer] the maximum time to wait for the
+    #   resource to be downloaded in seconds, by default there is no timeout
+    # @param user_agent [String] the User-Agent string to use for
+    #   downloading the resource, by default it uses the User-Agent string
+    #   set in the downloader's configuration
+    #
     # @example
-    #   downloader = Ferto::Client.new
-    #   dl_resp = downloader.download(
-    #     aggr_id: 'msystems',
-    #     aggr_limit: 3,
+    #   client.download(
     #     url: 'http://foo.bar/a.jpg',
     #     callback_type: 'http',
-    #     callback_dst: 'http://example.com/downloads/myfile',
-    #     extra: { groupno: 'foobar' }
+    #     callback_dst: 'http://myapp.com/handle-download',
+    #     aggr_id: 'foo', aggr_limit: 3,
+    #     download_timeout: 120,
+    #     aggr_proxy: 'http://myproxy.com/',
+    #     user_agent: 'my-useragent',
+    #     mime_type: "image/jpeg",
+    #     extra: { something: 'someone' }
     #   )
     #
-    # @raise [Ferto::ConnectionError] if the client failed to connect to the
-    #   downloader API
+    # @raise [Ferto::ConnectionError] if there was an error scheduling the
+    #   job to downloader
     #
     # @return [Ferto::Response]
+    #
+    # @see https://github.com/skroutz/downloader/#post-download
     def download(aggr_id:, aggr_limit: @aggr_limit, url:,
+                 aggr_proxy: nil, download_timeout: nil, user_agent: nil,
                  callback_url: "", callback_dst: "",
                  callback_type: "", mime_type: "", extra: {})
       uri = URI::HTTP.build(
@@ -70,7 +91,7 @@ module Ferto
       )
       body = build_body(
         aggr_id, aggr_limit, url, callback_url, callback_type, callback_dst,
-        mime_type, extra
+        aggr_proxy, download_timeout, user_agent, mime_type, extra
       )
       # Curl.post reuses the same handler
       begin
@@ -96,7 +117,8 @@ module Ferto
     end
 
     def build_body(aggr_id, aggr_limit, url, callback_url, callback_type,
-                   callback_dst, mime_type, extra)
+                   callback_dst, aggr_proxy, download_timeout, user_agent,
+                   mime_type, extra)
       body = {
         aggr_id: aggr_id,
         aggr_limit: aggr_limit,
@@ -114,6 +136,10 @@ module Ferto
         body[:mime_type] = mime_type
       end
 
+      body[:aggr_proxy] = aggr_proxy if aggr_proxy
+      body[:download_timeout] = download_timeout if download_timeout
+      body[:user_agent] = user_agent if user_agent
+
       if !extra.nil?
         body[:extra] = extra.is_a?(Hash) ? extra.to_json : extra.to_s
       end

data/lib/ferto/version.rb

@@ -1,3 +1,3 @@
 module Ferto
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferto
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Aggelos Avgerinos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -123,7 +123,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- ferto-0.1.0.gem
 - ferto.gemspec
 - lib/ferto.rb
 - lib/ferto/callback.rb