b2-client 1.0.2 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0be79261fee4bcca3e1ba5a8dbe172bc505d38a35b79a0b3e25f81de26a900a
-  data.tar.gz: 593efe787fb433de833a8acb964f470ee9f5bc27c71b6ada97af1284e9d955e7
+  metadata.gz: 70e5dc6cc5de5772f02f575cceefa1137ce7750cf2042067c6e06d1809e0758f
+  data.tar.gz: 96e70fb4bbd010ff178a3ac506a62cf5dd85c65d9c6477c78c89687aeda21b5c
 SHA512:
-  metadata.gz: 8eb2b33f95494b125c0397de1355063b256c420a717ca4eb0ffd0772f815afd2e094d8dbb7ab22904ef8f7ac651a5e019aa19137e3127a46fa1b6e97982d60d7
-  data.tar.gz: 5505cb044eba0400384f2d072fa079bd7adfa8a5a3826719825644ab819d8945f5966cbc69f6485214cddc81a9f8890fbc2b79c72f2e0c110f9418ef474f91bf
+  metadata.gz: 7908671a61289946d1330ffa0668d38c0952607ab07932520abb3791ff6a217c8ded4b97e66f2b98784368dac62a55aa412ed636ee386bade7d37c80b013c729
+  data.tar.gz: 5e38e319103709afaca046533501b82f30050b48db439ac927bfc67b0fd0ce7f222327c439092236658f821aa3e025d457280acbaf7b1f1faa57cffeb12f0e95

data/lib/b2.rb

@@ -2,50 +2,57 @@ require 'uri'
 require 'json'
 require 'net/http'
 
+require File.expand_path('../b2/errors', __FILE__)
 require File.expand_path('../b2/file', __FILE__)
 require File.expand_path('../b2/bucket', __FILE__)
+require File.expand_path('../b2/api_connection', __FILE__)
 require File.expand_path('../b2/connection', __FILE__)
 require File.expand_path('../b2/upload_chunker', __FILE__)
 
 class B2
   
-  def initialize(account_id:, application_key:)
-    @account_id = account_id
-    @connection = B2::Connection.new(account_id, application_key)
-    @buckets_cache = []
+  def self.encode(value)
+    URI.encode_www_form_component(value.force_encoding(Encoding::UTF_8)).gsub("%2F", "/")
+  end
+  
+  def self.decode(value)
+    URI.decode_www_form_component(value, Encoding::UTF_8)
+  end
+  
+  def initialize(key_id: , secret: )
+    @connection = B2::Connection.new(key_id, secret)
+  end
+  
+  def account_id
+    @connection.account_id
   end
   
   def buckets
-    @connection.post('/b2api/v1/b2_list_buckets', {accountId: @account_id})['buckets'].map do |b|
-      B2::Bucket.new(b, @connection)
-    end
+    @connection.buckets
   end
-
-  def lookup_bucket_id(name)
-    bucket = @buckets_cache.find{ |b| b.name == name }
-    return bucket.id if bucket
-    
-    @buckets_cache = buckets
-    @buckets_cache.find{ |b| b.name == name }&.id
+  
+  def bucket(name)
+    bs = @connection.post('/b2api/v2/b2_list_buckets', {accountId: account_id, bucketName: name})['buckets']
+    B2::Bucket.new(bs.first, @connection)
   end
   
   def file(bucket, key)
-    bucket_id = lookup_bucket_id(bucket)
+    bucket_id = @connection.lookup_bucket_id(bucket)
     
-    file = @connection.post('/b2api/v1/b2_list_file_names', {
+    file = @connection.post('/b2api/v2/b2_list_file_names', {
       bucketId: bucket_id,
       startFileName: key
     })['files'].find {|f| f['fileName'] == key }
 
-    file ? B2::File.new(file.merge({'bucketId' => bucket_id})) : nil
+    file ? B2::File.new(file.merge({'bucketId' => bucket_id}), @connection) : nil
   end
   
   def delete(bucket, key)
     object = file(bucket, key)
     if object
-      @connection.post('/b2api/v1/b2_delete_file_version', {
-        fileName: file.name,
-        fileId: file.id
+      @connection.post('/b2api/v2/b2_delete_file_version', {
+        fileName: object.name,
+        fileId: object.id
       })
     else
       false
@@ -53,8 +60,8 @@ class B2
   end
   
   def get_upload_token(bucket)
-    @connection.post("/b2api/v1/b2_get_upload_url", {
-      bucketId: lookup_bucket_id(bucket)
+    @connection.post("/b2api/v2/b2_get_upload_url", {
+      bucketId: @connection.lookup_bucket_id(bucket)
     })
   end
   
@@ -68,7 +75,7 @@ class B2
     chunker = B2::UploadChunker.new(io_or_string)
     req = Net::HTTP::Post.new(uri.path)
     req['Authorization']      = upload['authorizationToken']
-    req['X-Bz-File-Name']     = B2::File.encode_filename(key)
+    req['X-Bz-File-Name']     = B2.encode(key)
     req['Content-Type']       = mime_type || 'b2/x-auto'
     req['X-Bz-Content-Sha1']  = 'hex_digits_at_end'
     info.each do |key, value|
@@ -85,13 +92,8 @@ class B2
     end
   end
   
-  def get_download_url(bucket, filename, expires_in: 3_600)
-    response = @connection.post("/b2api/v1/b2_get_download_authorization", {
-      bucketId: lookup_bucket_id(bucket),
-      fileNamePrefix: filename,
-      validDurationInSeconds: expires_in
-    })
-    @connection.download_url + '/file/' + bucket + '/' + filename + "?Authorization=" + response['authorizationToken']
+  def get_download_url(bucket, filename, **options)
+    @connection.get_download_url(bucket, filename, **options)
   end
   
   def download(bucket, key, to=nil, &block)
@@ -100,11 +102,11 @@ class B2
 
   
   def download_to_file(bucket, key, filename)
-    file = File.open(filename, 'w')
+    file = ::File.open(filename, 'wb')
     download(bucket, key) do |chunk|
       file << chunk
     end
     file.close
   end
 
-end
+end

data/lib/b2/api_connection.rb

@@ -0,0 +1,118 @@
+class B2
+  class APIConnection
+    
+    attr_reader :key_id, :key_secret, :download_url
+    
+    def initialize(key_id, secret)
+      @key_id = key_id
+      @key_secret = secret
+    end
+    
+    def connect!
+      conn = Net::HTTP.new('api.backblazeb2.com', 443)
+      conn.use_ssl = true
+      
+      req = Net::HTTP::Get.new('/b2api/v2/b2_authorize_account')
+      req.basic_auth(@key_id, @key_secret)
+
+      key_expiration = Time.now.to_i + 86_400 #24hr expiry
+      resp = conn.start { |http| http.request(req) }
+      if resp.is_a?(Net::HTTPSuccess)
+        resp = JSON.parse(resp.body)
+      else
+        raise "Error connecting to B2 API"
+      end
+
+      uri = URI.parse(resp['apiUrl'])
+      @connection = Net::HTTP.new(uri.host, uri.port)
+      @connection.use_ssl = uri.scheme == 'https'
+      @connection.start
+
+      @auth_token_expires_at = key_expiration
+      @account_id = resp['accountId']
+      @minimum_part_size = resp['absoluteMinimumPartSize']
+      @recommended_part_size = resp['recommendedPartSize']
+      @auth_token = resp['authorizationToken']
+      @download_url = resp['downloadUrl']
+    end
+
+    def account_id
+      return @account_id if !@account_id.nil?
+      
+      connect!
+      @account_id
+    end
+    
+    def disconnect!
+      if @connection
+        @connection.finish if @connection.active?
+        @connection = nil
+      end
+    end
+    
+    def reconnect!
+      disconnect!
+      connect!
+    end
+    
+    def authorization_token
+      if @auth_token_expires_at.nil? || @auth_token_expires_at <= Time.now.to_i
+        reconnect!
+      end
+      @auth_token
+    end
+    
+    def active?
+      !@connection.nil? && @connection.active?
+    end
+    
+    def connection
+      reconnect! if !active?
+      @connection
+    end
+
+    def send_request(request, body=nil, &block)
+      retries = 0
+      request['Authorization'] = authorization_token
+      request.body = (body.is_a?(String) ? body : JSON.generate(body)) if body
+      
+      return_value = nil
+      close_connection = false
+      begin
+        connection.request(request) do |response|
+          close_connection = response['Connection'] == 'close'
+          
+          case response
+          when Net::HTTPSuccess
+            if block_given?
+              return_value = yield(response)
+            else
+              return_value = JSON.parse(response.body)
+            end
+          else
+            body = JSON.parse(response.body)
+            case body['code']
+            when 'not_found'
+              raise B2::NotFound(body['message'])
+            when 'expired_auth_token'
+              raise B2::ExpiredAuthToken(body['message'])
+            else
+              raise "Error connecting to B2 API #{response.body}"
+            end
+          end
+        end
+        
+      # Unexpected EOF (end of file) errors can occur when streaming from a
+      # remote because of Backblaze quota restrictions.
+      rescue B2::ExpiredAuthToken, EOFError
+        reconnect!
+        retries =+ 1
+        retry if retries < 2
+      end
+      disconnect! if close_connection
+
+      return_value
+    end
+    
+  end
+end

data/lib/b2/bucket.rb

@@ -14,7 +14,7 @@ class B2
     end
     
     def get_upload_token
-      @connection.post("/b2api/v1/b2_get_upload_url", { bucketId: @id })
+      @connection.post("/b2api/v2/b2_get_upload_url", { bucketId: @id })
     end
     
     def upload_file(key, io_or_string, mime_type: nil, sha1: nil, content_disposition: nil, info: {})
@@ -27,12 +27,12 @@ class B2
       chunker = sha1 ? io_or_string : B2::UploadChunker.new(io_or_string)
       req = Net::HTTP::Post.new(uri.path)
       req['Authorization']      = upload['authorizationToken']
-      req['X-Bz-File-Name']     = B2::File.encode_filename(key)
+      req['X-Bz-File-Name']     = B2.encode(key)
       req['Content-Type']       = mime_type || 'b2/x-auto'
       req['X-Bz-Content-Sha1']  = sha1 ? sha1 : 'hex_digits_at_end'
-      req['X-Bz-Info-b2-content-disposition'] = content_disposition if content_disposition
+      req['X-Bz-Info-b2-content-disposition'] = B2.encode(content_disposition) if content_disposition
       info.each do |key, value|
-        req["X-Bz-Info-#{key}"] = value
+        req["X-Bz-Info-#{key}"] = B2.encode(value)
       end
       req['Content-Length']     = chunker.size
       req.body_stream           = chunker
@@ -41,14 +41,24 @@ class B2
       result = if resp.is_a?(Net::HTTPSuccess)
         JSON.parse(resp.body)
       else
-        raise "Error connecting to B2 API"
+        raise "Error connecting to B2 API #{resp.body}"
       end
       
       B2::File.new(result, @connection)
     end
+  
+    def keys(prefix: nil, delimiter: nil)
+      #TODO: add abilty to get all names
+      @connection.post('/b2api/v2/b2_list_file_names', {
+        bucketId: @id,
+        maxFileCount: 1000,
+        prefix: prefix,
+        delimiter: delimiter
+      })['files'].map{ |f| f['fileName'] }
+    end
     
     def has_key?(key)
-      !@connection.post('/b2api/v1/b2_list_file_names', {
+      !@connection.post('/b2api/v2/b2_list_file_names', {
         bucketId: @id,
         startFileName: key,
         maxFileCount: 1,
@@ -57,7 +67,7 @@ class B2
     end
 
     def file(key)
-      file = @connection.post('/b2api/v1/b2_list_file_names', {
+      file = @connection.post('/b2api/v2/b2_list_file_names', {
         bucketId: @id,
         startFileName: key,
         maxFileCount: 1,
@@ -67,6 +77,10 @@ class B2
       file ? B2::File.new(file.merge({'bucketId' => @id}), @connection) : nil
     end
     
+    def get_download_url(key, **options)
+      @connection.get_download_url(@name, key, **options)
+    end
+
     def download(key, to=nil, &block)
       @connection.download(@name, key, to, &block)
     end
@@ -76,4 +90,4 @@ class B2
     end
 
   end
-end
+end

data/lib/b2/connection.rb

@@ -1,122 +1,140 @@
+require 'cgi'
+require 'thread'
+
 class B2
   class Connection
     
-    attr_reader :account_id, :application_key, :download_url
-    
-    def initialize(account_id, application_key)
-      @account_id = account_id
-      @application_key = application_key
+    def initialize(key_id, secret, pool: 5, timeout: 5)
+      @mutex        = Mutex.new
+      @availability = ConditionVariable.new
+      @max          = pool
+      @timeout      = timeout
+      @free_pool    = []
+      @used_pool    = []
+      
+      @key_id = key_id
+      @key_secret = secret
+
+      @buckets_cache = Hash.new { |hash, name| hash[name] = bucket(name) }
     end
     
-    def connect!
-      conn = Net::HTTP.new('api.backblazeb2.com', 443)
-      conn.use_ssl = true
+    def account_id
+      return @account_id if !@account_id.nil?
       
-      req = Net::HTTP::Get.new('/b2api/v1/b2_authorize_account')
-      req.basic_auth(account_id, application_key)
+      @account_id = with_connection { |conn| conn.account_id }
+    end
 
-      key_expiration = Time.now.to_i + 86_400 #24hr expiry
-      resp = conn.start { |http| http.request(req) }
-      if resp.is_a?(Net::HTTPSuccess)
-        resp = JSON.parse(resp.body)
-      else
-        raise "Error connecting to B2 API"
+    def with_connection
+      conn = @mutex.synchronize do
+        cxn = if !@free_pool.empty?
+          @free_pool.shift
+        elsif @free_pool.size + @used_pool.size < @max
+          B2::APIConnection.new(@key_id, @key_secret)
+        else
+          @availability.wait(@mutex, @timeout)
+          @free_pool.shift || B2::APIConnection.new(@key_id, @key_secret)
+        end
+        
+        @used_pool << cxn
+        cxn
+      end
+      
+      yield conn
+    ensure
+      @mutex.synchronize do
+        @used_pool.delete(conn)
+        @free_pool << conn if conn.active?
+        @availability.signal()
       end
-
-      uri = URI.parse(resp['apiUrl'])
-      @connection = Net::HTTP.new(uri.host, uri.port)
-      @connection.use_ssl = uri.scheme == 'https'
-      @connection.start
-
-      @auth_token_expires_at = key_expiration
-      @minimum_part_size = resp['absoluteMinimumPartSize']
-      @recommended_part_size = resp['recommendedPartSize']
-      @auth_token = resp['authorizationToken']
-      @download_url = resp['downloadUrl']
     end
     
-    def disconnect!
-      if @connection
-        @connection.finish if @connection.active?
-        @connection = nil
-      end
+    def authorization_token
+      with_connection { |conn| conn.authorization_token }
     end
     
-    def reconnect!
-      disconnect!
-      connect!
+    def send_request(request, body=nil, &block)
+      with_connection { |conn| conn.send_request(request, body, &block) }
     end
     
-    def authorization_token
-      if @auth_token_expires_at.nil? || @auth_token_expires_at <= Time.now.to_i
-        reconnect!
+    def download_url
+      with_connection { |conn| conn.download_url }
+    end
+
+    def buckets
+      post('/b2api/v2/b2_list_buckets', {accountId: account_id})['buckets'].map do |b|
+        B2::Bucket.new(b, self)
       end
-      @auth_token
     end
     
-    def active?
-      !@connection.nil? && @connection.active?
+    def bucket(name)
+      response = post('/b2api/v2/b2_list_buckets', {
+        accountId: account_id,
+        bucketName: name
+      })['buckets']
+      response.map { |b| B2::Bucket.new(b, self) }.first
     end
 
-    def send_request(request, body=nil, &block)
-      request['Authorization'] = authorization_token
-      request.body = (body.is_a?(String) ? body : JSON.generate(body)) if body
-      
-      return_value = nil
-      close_connection = false
-      @connection.request(request) do |response|
-        close_connection = response['Connection'] == 'close'
-        
-        case response
-        when Net::HTTPSuccess
-          if block_given?
-            return_value = yield(response)
-          else
-            return_value = JSON.parse(response.body)
-          end
-        else
-          raise "Error connecting to B2 API #{response.body}"
-        end
-      end
-      @connection.finish if close_connection
+    def lookup_bucket_id(name)
+      @buckets_cache[name].id
+    end
 
-      return_value
+    def get_download_url(bucket, filename, expires_in: 3_600, disposition: nil)
+      response = post("/b2api/v2/b2_get_download_authorization", {
+        bucketId: lookup_bucket_id(bucket),
+        fileNamePrefix: filename,
+        validDurationInSeconds: expires_in,
+        b2ContentDisposition: disposition
+      })
+      url =  download_url + '/file/' + bucket + '/' + filename + "?Authorization=" + response['authorizationToken']
+      url += "&b2ContentDisposition=#{CGI.escape(disposition)}" if disposition
+      url
     end
-    
-    def download(bucket, key, to=nil, &block)
+
+    def download(bucket, key, to=nil)
       opened_file = (to && to.is_a?(String))
       to = ::File.open(to, 'wb') if to.is_a?(String)
       digestor = Digest::SHA1.new
       data = ""
     
-      uri = URI.parse(@download_url)
+      uri = URI.parse(download_url)
       conn = Net::HTTP.new(uri.host, uri.port)
       conn.use_ssl = uri.scheme == 'https'
 
       req = Net::HTTP::Get.new("/file/#{bucket}/#{key}")
       req['Authorization'] = authorization_token
       conn.start do |http|
-        http.request(req) do |response|
-          case response
-          when Net::HTTPSuccess
-            response.read_body do |chunk|
-              digestor << chunk
-              if to
-                to << chunk
-              elsif block
-                block(chunk)
-              else
-                data << chunk
+          http.request(req) do |response|
+            case response
+            when Net::HTTPSuccess
+              response.read_body do |chunk|
+                digestor << chunk
+                if to
+                  to << chunk
+                elsif block_given?
+                  yield(chunk)
+                else
+                  data << chunk
+                end
               end
-            end
       
-            if digestor.hexdigest != response['X-Bz-Content-Sha1']
-              raise 'file error'
+              if response['X-Bz-Content-Sha1'] != 'none' && digestor.hexdigest != response['X-Bz-Content-Sha1']
+                rase B2::FileIntegrityError.new("SHA1 Mismatch, expected: \"#{response['X-Bz-Content-Sha1']}\", actual: \"#{digestor.hexdigest}\"")
+              end
+            when Net::HTTPNotFound
+              raise B2::NotFound.new(JSON.parse(response.body)['message'])
+            else
+              begin
+                body = JSON.parse(response.body)
+              if body['code'] == 'not_found'
+                  raise B2::NotFound(body['message'])
+                else
+                  raise "#{body['code']} (#{body['message']})"
+                end
+              rescue
+                raise response.body
+              end
             end
-          else
-            raise response.body
           end
-        end
       end
       
       if opened_file
@@ -124,7 +142,7 @@ class B2
       elsif to
         to.flush
       end
-      block.nil? && to.nil? ? data : nil
+      !block_given? && to.nil? ? data : nil
     end
     
     def get(path, body=nil, &block)
@@ -140,4 +158,5 @@ class B2
     end
     
   end
-end
+end
+

data/lib/b2/errors.rb

@@ -0,0 +1,15 @@
+class B2
+
+  class Error < StandardError
+  end
+  
+  class NotFound < Error
+  end
+
+  class FileIntegrityError < Error
+  end
+  
+  class ExpiredAuthToken < Error
+  end
+
+end

data/lib/b2/file.rb

@@ -5,7 +5,7 @@ class B2
     
     def initialize(attrs, connection)
       @id = attrs['fileId']
-      @name = B2::File.decode_filename(attrs['fileName'])
+      @name = B2.decode(attrs['fileName'])
       @account_id = attrs['accountId']
       @bucket_id = attrs['bucketId']
       @size = attrs['contentLength']
@@ -17,16 +17,8 @@ class B2
       @connection = connection
     end
     
-    def self.encode_filename(str)
-      URI.encode_www_form_component(str.force_encoding(Encoding::UTF_8)).gsub("%2F", "/")
-    end
-    
-    def self.decode_filename(str)
-      URI.decode_www_form_component(str, Encoding::UTF_8)
-    end
-    
     def delete!
-      @connection.post('/b2api/v1/b2_delete_file_version', {
+      @connection.post('/b2api/v2/b2_delete_file_version', {
         fileId: @id,
         fileName: @name
       })

data/lib/b2/version.rb

@@ -1,3 +1,3 @@
 class B2
-  VERSION = '1.0.2'
+  VERSION = '1.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: b2-client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.7
 platform: ruby
 authors:
 - Jon Bracy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,9 +36,11 @@ files:
 - README.md
 - b2-client.gemspec
 - lib/b2.rb
+- lib/b2/api_connection.rb
 - lib/b2/bucket.rb
 - lib/b2/client.rb
 - lib/b2/connection.rb
+- lib/b2/errors.rb
 - lib/b2/file.rb
 - lib/b2/upload_chunker.rb
 - lib/b2/version.rb
@@ -46,7 +48,7 @@ homepage: https://github.com/malomalo/b2
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,9 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Backblaze B2 Client
 test_files: []