elibri_watermarking 0.9.7 → 0.9.8

data/README.md

@@ -33,7 +33,7 @@ client = ElibriWatermarking::Client.new('token', 'secret')
 
 Biblioteka daje nam do dyspozycji parę metod, odpowiadających wywołaniom metod API watermarkingu elibri:
 
-* watermark (przyjmuje parametry: identyfikator [ISBN bez myślników lub record_reference], formaty [zapisana po przecinku lista formatów do watermarkingu - najcześciej "epub,mobi", możliwe wartości:  epub, mobi, pdf, mp3_in_zip], widoczny watermark [tekst widoczny na końcu każdego rozdziału], dopisek [krótki tekst dopisany do tytułu], supplier [numeryczny identyfikator dostawcy pliki], client_symbol [alfanumeryczny identyfikator zapisany przy transakcji], customer_ip [ip klienta końcowego, do celów statystycznych], delivery_form [opcjonalna forma dostarczenia (używane tylko przy audiobooku). Może przyjąć wartości: zip (wtedy audiobook zostanie dostarczony jako plik zip), lub mp3 (wtedy w miarę postępu procesu watermarkowania, pojawiać się będą kolejne pliki w folderze o nazwie równej trans_id, na S3). W przypadku drugiej formy, klient zostanie powiadomiony o zakończeniu procesu dopiero gdy wszystkie pliki zostaną zwatermarkowane (wtedy również w folderze S3 pojawi się plik done). Jeśli sklep chce pobierać pliki mp3 w miarę postępu watermarkowania, jest zobowiązany do sprawdzania ich obecności na s3, zanim zostanie poinformowany o zakończeniu transakcji. W przypadku używania typu dostarczenia=mp3, audiobook musi być jedynym formatem, który jest żądany w danej transakcji] - zwraca identyfikator transakcji, który klient zobowiązany jest zapisać i przechowywać) - wywołuje żądanie watermarku na podanym produkcie, w podanych formatach
+* watermark (przyjmuje parametry: identyfikator [ISBN bez myślników lub record_reference], formaty [zapisana po przecinku lista formatów do watermarkingu - najcześciej "epub,mobi", możliwe wartości:  epub, mobi, pdf, mp3_in_zip], widoczny watermark [tekst widoczny na końcu każdego rozdziału], dopisek [krótki tekst dopisany do tytułu], supplier [numeryczny identyfikator dostawcy pliki], client_symbol [alfanumeryczny identyfikator zapisany przy transakcji], customer_ip [ip klienta końcowego, do celów statystycznych], price [cena zakupu pliku przez klienta końcowego], promotion_id [id promocji w jakiej został zakupiony plik], delivery_form [opcjonalna forma dostarczenia (używane tylko przy audiobooku). Może przyjąć wartości: zip (wtedy audiobook zostanie dostarczony jako plik zip), lub mp3 (wtedy w miarę postępu procesu watermarkowania, pojawiać się będą kolejne pliki w folderze o nazwie równej trans_id, na S3). W przypadku drugiej formy, klient zostanie powiadomiony o zakończeniu procesu dopiero gdy wszystkie pliki zostaną zwatermarkowane (wtedy również w folderze S3 pojawi się plik done). Jeśli sklep chce pobierać pliki mp3 w miarę postępu watermarkowania, jest zobowiązany do sprawdzania ich obecności na s3, zanim zostanie poinformowany o zakończeniu transakcji. W przypadku używania typu dostarczenia=mp3, audiobook musi być jedynym formatem, który jest żądany w danej transakcji] - zwraca identyfikator transakcji, który klient zobowiązany jest zapisać i przechowywać) - wywołuje żądanie watermarku na podanym produkcie, w podanych formatach
 * deliver (przyjmuje jeden parametr: identifykator transacji [otrzymany od watermark]) - wywołuje żądanie dostarczenia zwatermarkowanego pliku do bucketu klienta na s3
 * watermark_and_deliver (przyjmuje parametry identyczne jak watermark, zwraca identyfikator transacji, który klient zobowiązany jest zapisać i przechowywać) - wywołuje watermarkowanie pliku, a następnie żąda jego dostarczenia do bucketu klienta na s3
 * retry (przyjmuje jako parametr identyfikator transakcji, zwraca identyfikator nowej transakcji i opcjonalnie delivery_form [opcjonalna forma dostarczenia (używane tylko przy audiobooku), analogicznie jak przy watermark]) - wywołuje żądanie ponowienia watermarkingu pliku, który został już ściągnięty (uwaga - sklep jest zobowiązany do przetrzymywanie zwatermarkowanego pliku przynajmniej przez 7 dni, dopiero po tym czasie możliwe jest wywołanie retry). Watermarking wykonywany jest z identycznymi parametrami, jak poprzedni. Klient zobowiązany jest zapisać i przechowywać nowy identyfikator transakcji. Po komendzie retry, niezbędne jest wywołanie komendy deliver w celu dostarczeni pliku do bucketu s3. Uwaga! Każdą transakcję retryować mozna tylko raz - w przypadku kolejnego żądania retry, konieczne jest podanie identyfikatora transakcji otrzymanego od poprzedniej komendy retry.

data/lib/elibri_watermarking/client.rb

@@ -19,7 +19,8 @@ module ElibriWatermarking
       self.servers = servers
     end
     
-    def watermark(ident, formats, visible_watermark, title_postfix, customer_ip, client_symbol = nil, supplier = nil, delivery_form = nil, price = nil, promotion_id = nil)
+    def watermark(ident, formats, visible_watermark, title_postfix, customer_ip, client_symbol = nil, supplier = nil, 
+                  delivery_form = nil, price = nil, promotion_id = nil, low_priority = false)
       if ident =~ /^[0-9]+$/ && ident.size == 13
         ident_type = 'isbn'
       else
@@ -36,20 +37,25 @@ module ElibriWatermarking
       data.merge!(:customer_ip => customer_ip) if customer_ip
       data.merge!(:price => price) if price
       data.merge!(:promotion_id => promotion_id) if promotion_id
+      data.merge!(:low_priority => low_priority) if low_priority
       try_with_different_servers('watermark') do |uri|
         return get_response_from_server(uri, data, Net::HTTP::Post)
       end  
     end
 
-    def deliver(trans_id)
+    def deliver(trans_id, low_priority = false)
       try_with_different_servers('deliver') do |uri|
-        return get_response_from_server(uri, {'trans_id' =>  trans_id}, Net::HTTP::Post)
+        data = {'trans_id' =>  trans_id}
+        data.merge!(:low_priority => low_priority) if low_priority
+        return get_response_from_server(uri, data, Net::HTTP::Post)
       end
     end
 
-    def retry(trans_id, delivery_form = nil)
+    def retry(trans_id, delivery_form = nil, low_priority = false)
       try_with_different_servers('retry') do |uri|
-        return get_response_from_server(uri, {'trans_id' =>  trans_id, 'delivery_form' => delivery_form}, Net::HTTP::Post)
+        data = {'trans_id' =>  trans_id, 'delivery_form' => delivery_form}
+        data.merge!(:low_priority => low_priority) if low_priority
+        return get_response_from_server(uri, data, Net::HTTP::Post)
       end
     end
 

data/lib/elibri_watermarking/exceptions.rb

@@ -1,6 +1,6 @@
 module ElibriWatermarking
   
-  class ElibriException < Exception
+  class ElibriException < StandardError
   end
   
   class ParametersError < ElibriException

data/lib/elibri_watermarking/version.rb

@@ -1,3 +1,3 @@
 module ElibriWatermarking
-  VERSION = "0.9.7"
+  VERSION = "0.9.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elibri_watermarking
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -73,22 +73,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2862660958945275009
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2862660958945275009
 requirements: []
 rubyforge_project: elibri_watermarking
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Gem designed to help in use of Elibri watermarking API.
 test_files: []
+has_rdoc: