elibri_watermarking 0.5.0 → 0.7.3

data/README.md

@@ -33,26 +33,27 @@ 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"], widoczny watermark [tekst widoczny na końcu każdego rozdziału], dopisek [krótki tekst dopisany do tytułu], 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"], 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] - 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) - 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.
 * available_files - zwraca listę dostępnych do watermarkingu przez klienta plików. Pliki są zwracane w postaci tablicy hashów, postaci:
 ```ruby
 [
-  {:product =>
-    {
-      :record_reference => 'a'
-      :publisher_name => 'b'
-      :publisher_id => 1
-      :isbn => '1234'
-      :title => 'Tytuł',
-      :formats => ["epub", "mobi"]
-      :premiere => "data premiery (jeśli w przyszłości - plik jest jeszcze niedostępny)"
-    }
+  {
+    :record_reference => 'a'
+    :publisher_name => 'b'
+    :publisher_id => 1
+    :isbn => '1234'
+    :title => 'Tytuł',
+    :formats => ["epub", "mobi"]
+    :available_date => "data od kiedy plik jest dostępny - jeśli pole nie występuje, znaczy to, że plik jest dostępny"
+    :suppliers => [1, 2, 3] #tablica zawierająca identyfikatora dostawców, mogących dostarczyć plik dla danego klienta
   }
 ]
 ```
+* check_suppliers (przyjmuje jeden parametr: identyfikator [ISBN bez myślników lub record_reference]) - zwraca listę dostawców danego pliku, w postaci tablicy zawierającej numeryczne identyfikatory dostawców
+* get_supplier (przyjmuje jeden parametr: numeryczny identyfikator dostawcy w systemie eLibri) - zwraca nazwę dostawcy o podanym identyfikatorze
 
 ## Błędy
 

data/lib/elibri_watermarking/client.rb

@@ -18,16 +18,26 @@ module ElibriWatermarking
       self.url = url
     end
     
-    def watermark(ident, formats, visible_watermark, title_postfix)
+    def watermark(ident, formats, visible_watermark, title_postfix, *args)
+      supplier = args[0]
+      client_symbol = args[1]
+      customer_ip = args[2]
       ident =~ /^[0-9]+$/ ? ident_type = 'isbn' : ident_type = 'record_reference'
-      raise WrongFormats.new if formats.is_a?(String) && !formats =~ /^(epub|mobi|,)+$/
-      raise WrongFormats.new if formats.is_a?(Array) && (formats != ['epub','mobi'] && formats != ['mobi','epub'] && formats != ['mobi'] && formats != ['epub'])
+      raise WrongFormats.new if formats.is_a?(String) && !formats =~ /^(epub|mobi|pdf|,)+$/
+      raise WrongFormats.new if formats.is_a?(Array) && ((formats - ['epub','mobi','pdf']) != [] || (formats & ['epub','mobi','pdf']).count < 1)
       uri = URI(self.url + '/watermark')
       formats = formats.join(",") if formats.is_a?(Array)
       timestamp = Time.now.to_i
       sig = CGI.escape(Base64.encode64(OpenSSL::HMAC.digest('sha1', timestamp.to_s, self.secret)).strip) 
       data = {ident_type => ident, 'formats' => formats, 'visible_watermark' => visible_watermark,
-        'title_postfix' => title_postfix, 'stamp' => timestamp, 'sig' => sig, 'token' => self.token}
+        'title_postfix' => title_postfix, 'stamp' => timestamp, 'sig' => sig, 'token' => self.token,
+        'client_symbol' => client_symbol}
+      if supplier
+        data.merge!(:supplier => supplier)
+      end
+      if customer_ip
+        data.merge!(:customer_ip => customer_ip)
+      end
       req = Net::HTTP::Post.new(uri.path)
       req.set_form_data(data)
       http = Net::HTTP.new(uri.host, uri.port)
@@ -79,8 +89,53 @@ module ElibriWatermarking
       return JSON.parse(validate_response(res))
     end
     
-    def watermark_and_deliver(ident, formats, visible_watermark, title_postfix)
-      trans_id = watermark(ident, formats, visible_watermark, title_postfix)
+    def soon_available_files
+      uri = URI(self.url + '/soon_available_files.json')
+      timestamp = Time.now.to_i
+      sig = CGI.escape(Base64.encode64(OpenSSL::HMAC.digest('sha1', timestamp.to_s, self.secret)).strip) 
+      data = {'stamp' => timestamp, 'sig' => sig, 'token' => self.token}
+      req = Net::HTTP::Get.new(uri.path)
+      req.set_form_data(data)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      res = http.start {|http| http.request(req) }
+      return JSON.parse(validate_response(res))
+    end
+    
+    def check_suppliers(ident)
+      ident =~ /^[0-9]+$/ ? ident_type = 'isbn' : ident_type = 'record_reference'
+      uri = URI(self.url + '/check_suppliers')
+      timestamp = Time.now.to_i
+      sig = CGI.escape(Base64.encode64(OpenSSL::HMAC.digest('sha1', timestamp.to_s, self.secret)).strip) 
+      data = {'stamp' => timestamp, 'sig' => sig, 'token' => self.token, ident_type => ident}
+      req = Net::HTTP::Get.new(uri.path)
+      req.set_form_data(data)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      res = http.start {|http| http.request(req) }
+      return validate_response(res).split(",").map { |x| x.to_i }
+    end
+    
+    def get_supplier(id)
+      uri = URI(self.url + '/get_supplier')
+      timestamp = Time.now.to_i
+      sig = CGI.escape(Base64.encode64(OpenSSL::HMAC.digest('sha1', timestamp.to_s, self.secret)).strip) 
+      data = {'stamp' => timestamp, 'sig' => sig, 'token' => self.token, 'id' => id}
+      req = Net::HTTP::Get.new(uri.path)
+      req.set_form_data(data)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      res = http.start {|http| http.request(req) }
+      return validate_response(res)
+    end
+    
+    def watermark_and_deliver(ident, formats, visible_watermark, title_postfix, *args)
+      supplier = args[0]
+      client_symbol = args[1]
+      trans_id = watermark(ident, formats, visible_watermark, title_postfix, supplier, client_symbol)
       return trans_id if deliver(trans_id) == "OK"
     end
     

data/lib/elibri_watermarking/version.rb

@@ -1,3 +1,3 @@
 module ElibriWatermarking
-  VERSION = "0.5.0"
+  VERSION = "0.7.3"
 end

metadata

@@ -1,39 +1,46 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: elibri_watermarking
-version: !ruby/object:Gem::Version
-  version: 0.5.0
+version: !ruby/object:Gem::Version 
+  hash: 5
   prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 3
+  version: 0.7.3
 platform: ruby
-authors:
+authors: 
 - Piotr Szmielew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-10 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-10-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
 description: Gem designed to help in use of Elibri watermarking API.
-email:
+email: 
 - p.szmielew@ava.waw.pl
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - Gemfile
 - README.md
@@ -45,32 +52,36 @@ files:
 - lib/elibri_watermarking/version.rb
 homepage: http://elibri.com.pl
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 788559910828618553
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: 788559910828618553
+      version: "0"
 requirements: []
+
 rubyforge_project: elibri_watermarking
-rubygems_version: 1.8.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Gem designed to help in use of Elibri watermarking API.
 test_files: []
+