b2-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c46280fcd18ce9df082fc3edfcddf837786817a52d70cd0e485584027807e4b8
+  data.tar.gz: 58e53bc7bec6095f7e4a541a8e6ec4fa28994cabe933b9f397fc9c0d820b9470
+SHA512:
+  metadata.gz: 9139847cc212553bc2d214711c1ae79db7065c0e7a456c62ae15e2908b25f6dafa2effaa72df915d3f6afb72a62f07c8b1c194bcaeabf665808000f472fa94e0
+  data.tar.gz: 6c093acb1482a0bd61c949f68d02f11782b5c4bd5fdf816d7686074c3a30499f8e95318ffe77d011a1d7b6d500c085c2de070bc88680b3efbdbd38f1f76ee0fe

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jon Bracy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# B2
+A Backblaze B2 Client
+
+# Usage
+
+```ruby
+b2 = B2.new(account_id: B2_ACCOUNT_ID, application_key: B2_APPLICATION_KEY)
+
+b2.upload_file('bucket_name', 'key', io_or_string)
+
+b2.download('bucket_name', 'key') # => binary_string
+
+b2.download('bucket_name', 'key') do |chunk|
+    # ... process the file as it streams ...
+end
+
+b2.download_to_file('bucket_name', 'key', '/path/to/file')
+
+b2.file('bucket_name', 'key') # => #<B2::File>
+
+b2.delete('bucket_name', 'key') # => bool
+```

data/b2-client.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path("../lib/b2/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "b2-client"
+  s.version     = B2::VERSION
+  s.authors     = ["Jon Bracy"]
+  s.email       = ["jonbracy@gmail.com"]
+  s.homepage    = "https://github.com/malomalo/b2"
+  s.summary     = %q{Backblaze B2 Client}
+  s.description = %q{Backblaze B2 Client}
+  s.licenses    = ['MIT']
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Developoment 
+  s.add_development_dependency 'rake'
+end

data/lib/b2.rb

@@ -0,0 +1,121 @@
+require 'uri'
+require 'json'
+require 'net/http'
+
+require File.expand_path('../b2/file', __FILE__)
+require File.expand_path('../b2/bucket', __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 = []
+  end
+  
+  def buckets
+    @connection.post('/b2api/v1/b2_list_buckets', {accountId: @account_id})['buckets'].map do |b|
+      B2::Bucket.new(b, @connection)
+    end
+  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
+  end
+  
+  def file(bucket, key)
+    bucket_id = lookup_bucket_id(bucket)
+    
+    file = @connection.post('/b2api/v1/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
+  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
+      })
+    else
+      false
+    end
+  end
+  
+  def get_upload_token(bucket)
+    @connection.post("/b2api/v1/b2_get_upload_url", {
+      bucketId: lookup_bucket_id(bucket)
+    })
+  end
+  
+  def upload_file(bucket, key, io_or_string, mime_type: nil, info: {})
+    upload = get_upload_token(bucket)
+  
+    uri = URI.parse(upload['uploadUrl'])
+    conn = Net::HTTP.new(uri.host, uri.port)
+    conn.use_ssl = uri.scheme == 'https'
+
+    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['Content-Type']       = mime_type || 'b2/x-auto'
+    req['X-Bz-Content-Sha1']  = 'hex_digits_at_end'
+    info.each do |key, value|
+      req["X-Bz-Info-#{key}"] = value
+    end
+    req['Content-Length']     = chunker.size
+    req.body_stream           = chunker
+
+    resp = conn.start { |http| http.request(req) }
+    if resp.is_a?(Net::HTTPSuccess)
+      JSON.parse(resp.body)
+    else
+      raise "Error connecting to B2 API"
+    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']
+  end
+  
+  def download(bucket, filename, &block)
+    digestor = Digest::SHA1.new
+    data = ""
+    
+    @connection.get("/file/#{bucket}/#{filename}") do |response|
+      response.read_body do |chunk|
+        digestor << chunk
+        block.nil? ? (data << chunk) : block(chunk)
+      end
+      if digestor.hexdigest != resp['X-Bz-Content-Sha1']
+        raise 'file error'
+      end
+    end
+    block.nil? ? data : nil
+  end
+  
+  def download_to_file(bucket, key, filename)
+    file = File.open(filename, 'w')
+    download(bucket, key) do |chunk|
+      file << chunk
+    end
+    file.close
+  end
+
+end

data/lib/b2/bucket.rb

@@ -0,0 +1,105 @@
+class B2
+  class Bucket
+
+    attr_reader :id, :name, :account_id, :revision
+    
+    def initialize(attrs, connection)
+      @id = attrs['bucketId']
+      @name = attrs['bucketName']
+      
+      @account_id = attrs['accountId']
+      @revision = attrs['revision']
+      
+      @connection = connection
+    end
+    
+    def get_upload_token
+      @connection.post("/b2api/v1/b2_get_upload_url", { bucketId: @id })
+    end
+    
+    def upload_file(key, io_or_string, mime_type: nil, sha1: nil, content_disposition: nil, info: {})
+      upload = get_upload_token
+  
+      uri = URI.parse(upload['uploadUrl'])
+      conn = Net::HTTP.new(uri.host, uri.port)
+      conn.use_ssl = uri.scheme == 'https'
+
+      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['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
+      info.each do |key, value|
+        req["X-Bz-Info-#{key}"] = value
+      end
+      req['Content-Length']     = chunker.size
+      req.body_stream           = chunker
+
+      resp = conn.start { |http| http.request(req) }
+      result = if resp.is_a?(Net::HTTPSuccess)
+        JSON.parse(resp.body)
+      else
+        raise "Error connecting to B2 API"
+      end
+      
+      B2::File.new(result, @connection)
+    end
+    
+    def has_key?(key)
+      !@connection.post('/b2api/v1/b2_list_file_names', {
+        bucketId: @id,
+        startFileName: key,
+        maxFileCount: 1,
+        prefix: key
+      })['files'].empty?
+    end
+
+    def file(key)
+      file = @connection.post('/b2api/v1/b2_list_file_names', {
+        bucketId: @id,
+        startFileName: key,
+        maxFileCount: 1,
+        prefix: key
+      })['files'].first
+
+      file ? B2::File.new(file.merge({'bucketId' => @id}), @connection) : nil
+    end
+    
+    def download(key, to=nil, &block)
+      to = File.open(to, 'w') if to.is_a?(String)
+      data = ""
+      digestor = Digest::SHA1.new
+
+      uri = URI.parse(@connection.download_url)
+      conn = Net::HTTP.new(uri.host, uri.port)
+      conn.use_ssl = uri.scheme == 'https'
+    
+      conn.get("/file/#{@name}/#{key}") do |response|
+        
+        response.read_body do |chunk|
+          digestor << chunk
+          if to
+            to << chunk
+          elsif block
+            block(chunk)
+          else
+            data << chunk
+          end
+        end
+        
+        if digestor.hexdigest != resp['X-Bz-Content-Sha1']
+          raise 'file error'
+        end
+        
+      end
+      block.nil? && to.nil? ? data : nil
+    end
+    
+    def delete!(key)
+      file(key).delete!
+    end
+
+  end
+end

data/lib/b2/client.rb

@@ -0,0 +1 @@
+require File.expand_path('../../b2', __FILE__)

data/lib/b2/connection.rb

@@ -0,0 +1,99 @@
+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
+    end
+    
+    def connect!
+      conn = Net::HTTP.new('api.backblazeb2.com', 443)
+      conn.use_ssl = true
+      
+      req = Net::HTTP::Get.new('/b2api/v1/b2_authorize_account')
+      req.basic_auth(account_id, application_key)
+
+      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
+      @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
+    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 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
+
+      return_value
+    end
+    
+    def get(path, body=nil, &block)
+      request = Net::HTTP::Get.new(path)
+      
+      send_request(request, body, &block)
+    end
+    
+    def post(path, body=nil, &block)
+      request = Net::HTTP::Post.new(path)
+      
+      send_request(request, body, &block)
+    end
+    
+  end
+end

data/lib/b2/file.rb

@@ -0,0 +1,36 @@
+class B2
+  class File
+
+    attr_reader :id, :name, :account_id, :bucket_id, :size, :sha1, :mime_type, :uploaded_at, :metadata
+    
+    def initialize(attrs, connection)
+      @id = attrs['fileId']
+      @name = B2::File.decode_filename(attrs['fileName'])
+      @account_id = attrs['accountId']
+      @bucket_id = attrs['bucketId']
+      @size = attrs['contentLength']
+      @sha1 = attrs['contentSha1']
+      @mime_type = attrs['contentType']
+      @uploaded_at = attrs['uploadTimestamp']
+      @metadata = attrs['fileInfo']
+      
+      @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', {
+        fileId: @id,
+        fileName: @name
+      })
+    end
+
+  end
+end

data/lib/b2/upload_chunker.rb

@@ -0,0 +1,38 @@
+class B2
+  class UploadChunker
+    attr_reader :size, :sha1
+
+    def initialize(data)
+      @data = data
+      @sha_appended = false
+      @digestor = Digest::SHA1.new
+      @size = if data.is_a?(::File)
+        data.size + 40
+      elsif data.is_a?(String)
+        data.bytesize + 40
+      end
+    end
+
+    def read(length=nil, outbuf=nil)
+      return_value = @data.read(length, outbuf)
+  
+      if outbuf.nil?
+        if return_value.nil? && !@sha_appended
+          @sha_appended = true
+          @digestor.hexdigest
+        else
+          @digestor << return_value
+          return_value
+        end
+      else
+        if outbuf.empty? && !@sha_appended
+          @sha_appended = true
+          outbuf.replace(@digestor.hexdigest)
+        else
+          @digestor << outbuf
+        end
+        outbuf
+      end
+    end
+  end
+end

data/lib/b2/version.rb

@@ -0,0 +1,3 @@
+module B2
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: b2-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Bracy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Backblaze B2 Client
+email:
+- jonbracy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- b2-client.gemspec
+- lib/b2.rb
+- lib/b2/bucket.rb
+- lib/b2/client.rb
+- lib/b2/connection.rb
+- lib/b2/file.rb
+- lib/b2/upload_chunker.rb
+- lib/b2/version.rb
+homepage: https://github.com/malomalo/b2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Backblaze B2 Client
+test_files: []