bkblz 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e5b80d7bec5fcf808b83fea5b07e508dc215e84
-  data.tar.gz: 50eba053e7feb3bf6ab847519ecac06d6a224d3a
+  metadata.gz: 4c2440a3e12c3022fbc44a05079430bc77c80a56
+  data.tar.gz: 667e2e0a9a71e6ceaf81aec43eca2f6e1f9c2d51
 SHA512:
-  metadata.gz: 586eb75671ece61435dd0bbfa3f28ff01e18b74286e9549dd9692dc7409c7e26e49ee51bbab579e7a75a94dc268abc04871f1322af4af77426bf854af5c1316c
-  data.tar.gz: 7d992fc8b24164ad07da989f0c5cf36c9c8beba3135f339b7ea9833cfe13674039a4d57bbf136a9135ff5a69147195e2bad400202b0285cf388dd85912032f41
+  metadata.gz: 0b2c6b5912e130d96ffab0390e098fd0b35e197f30240a856b21fca701cbe56396d7ecd5bb04fd9e5587725c430322e5f04e867acee8e578a02bcd5a9aae0652
+  data.tar.gz: ea2b13a18d20c29bb5929969137dede83e20782f5ecbe38b791d16c3ea0205576f9b2c5ee53b5fcfb92036a4f11a5f015cbeb3632389db59cf2da740dd189aaf

data/README.rb

@@ -1,8 +1,28 @@
-# Run `ruby README.rb` for a working demo, but first add your
-# application key and account id in the slots below.
+=begin
 
-# Or `gem install bkblz` to begin. After install try `bkblz -h` to use
-# the CLI
+This is the bkblz ruby gem, a library for the Backblaze B2 cloud
+storage API: https://www.backblaze.com/b2/docs/
+
+Currently the gem supports the following V1 API calls:
+
+  * b2_authorize_account
+  * b2_create_bucket
+  * b2_delete_bucket
+  * b2_delete_file_version
+  * b2_list_buckets
+  * b2_list_file_names
+  * b2_list_file_versions
+  * b2_upload_file
+  * b2_download_file_by_id
+  * b2_download_file_by_name
+
+Run `ruby README.rb` for a working demo, but first add your
+application key and account id in the slots below.
+
+Or `gem install bkblz` to begin. After install try `bkblz -h` to use
+the CLI
+
+=end
 
 $: << 'lib'
 require 'bkblz'
@@ -29,109 +49,157 @@ if Bkblz.config.account_id.match /!!!/
   exit 1
 end
 
-Bkblz.log.info do <<-EOS
-# Using the config above, create an authorized session. All
-# requests will run in the context of this session. See
-# +Bkblz::V1::Session#authorize+.
-EOS
-end
-Bkblz::V1::Session.authorize Bkblz.config do |api_session|
-  Bkblz.log.info "API session => #{api_session}"
-
-  Bkblz.log.info do <<-EOS
-  # First try to find an existing bucket named my-test-bucket,
-  # we'll use that if it exists. All requests in a session are sent
-  # through the session so that the request object gets access to the
-  # auth credentials.
-  EOS
-  end
-  buckets = api_session.send(Bkblz::V1::ListBucketsRequest.new).buckets
-  bucket = buckets.select { |b| b.bucket_name == "my-test-bucket" }.first
-  Bkblz.log.info "bucket list => #{buckets}"
-
+def run_readme
   Bkblz.log.info do <<-EOS
-  # Otherwise create a new my-test-bucket
+  # Using the config above, create an authorized session. All
+  # requests will run in the context of this session. See
+  # +Bkblz::V1::Session#authorize+.
   EOS
   end
-  unless bucket
-    bucket = Bkblz::V1::Model::Bucket.new \
-      :bucket_name => "my-test-bucket",
-      :bucket_type => "allPrivate",
-      :account_id => api_session.account_id
+  Bkblz::V1::Session.authorize Bkblz.config do |session|
+    Bkblz.log.info "API session => #{session}"
 
     Bkblz.log.info do <<-EOS
-    # Pass a model to the CreateBucketRequest,
-    # models are just named wrappers with dynamic methods
-    # around the JSON responses provided back from the Bkblz
-    # API. See lib/bkblz/v1/models.rb for a list of defined API
-    # objects. See Bkblz::V1::Model::Base for how it work.
+    # First try to find an existing bucket named my-test-bucket,
+    # we'll use that if it exists. All requests in a session are sent
+    # through the session so that the request object gets access to the
+    # auth credentials.
     EOS
     end
-    request = Bkblz::V1::CreateBucketRequest.new bucket
-    Bkblz.log.info "bucket model => #{bucket}"
-
-    # Bkblz::V1::Response objects are returned from +send+. Some
-    # provide a to_model method if they declare the +response_model+
-    # in the class definition.
-    bucket = api_session.send(request).to_model
-    Bkblz.log.info "created bucket => #{bucket.bucket_name}/#{bucket.bucket_id}"
-  end
-
-  Bkblz.log.info do <<-EOS
-  # Uploading a file begins with getting a dynamic URL from the API.
-  EOS
-  end
-  upload_auth = api_session.send(
-    Bkblz::V1::GetUploadUrlRequest.new bucket.bucket_id).to_model
-  Bkblz.log.info "upload file URL => #{upload_auth.upload_url}"
+    buckets = session.send(Bkblz::V1::ListBucketsRequest.new).buckets
+    Bkblz.log.info "bucket list => #{buckets}"
 
+    new_bucket_name = "bkblz-readme-bucket"
+    bucket = buckets.find { |b| b.bucket_name == new_bucket_name  }
 
-  Bkblz.log.info do <<-EOS
-  # Use the upload_auth model (a
-  # Bkblz::V1::Model::UploadAuth) to upload some files.
-  EOS
-  end
-  5.times do |i|
-    body = "some text #{i}"
-    file_name = "some_text_#{i}.txt"
-    content_type = nil
+    Bkblz.log.info do <<-EOS
+    # Otherwise create a new my-test-bucket
+    EOS
+    end
 
-    upload_file_info = api_session.send(
-      Bkblz::V1::UploadFileRequest.new upload_auth, body, file_name,
+    begin
+      unless bucket
+        bucket = Bkblz::V1::Model::Bucket.new \
+                                            :bucket_name => new_bucket_name,
+        :bucket_type => "allPrivate",
+        :account_id => session.account_id
+
+        Bkblz.log.info do <<-EOS
+        # Pass a model to the CreateBucketRequest,
+        # models are just named wrappers with dynamic methods
+        # around the JSON responses provided back from the Bkblz
+        # API. See lib/bkblz/v1/models.rb for a list of defined API
+        # objects. See Bkblz::V1::Model::Base for how it work.
+        EOS
+        end
+        request = Bkblz::V1::CreateBucketRequest.new bucket
+        Bkblz.log.info "bucket model => #{bucket}"
+
+        # Bkblz::V1::Response objects are returned from +send+. Some
+        # provide a to_model method if they declare the +response_model+
+        # in the class definition.
+        bucket = session.send(request).to_model
+        Bkblz.log.info "created bucket => #{bucket}"
+      end
+
+      Bkblz.log.info do <<-EOS
+      # Uploading a file begins with getting a dynamic URL from the API.
+      EOS
+      end
+      upload_auth = session.send(
+        Bkblz::V1::GetUploadUrlRequest.new bucket.bucket_id).to_model
+      Bkblz.log.info "upload file URL => #{upload_auth.upload_url}"
+
+
+      Bkblz.log.info do <<-EOS
+      # Use the upload_auth model (a
+      # Bkblz::V1::Model::UploadAuth) to upload some files.
+      EOS
+      end
+      5.times do |i|
+        body = "some text #{i}"
+        file_name = "some_text_#{i}.txt"
+        content_type = nil
+
+        upload_file_info = session.send(
+          Bkblz::V1::UploadFileRequest.new upload_auth, body, file_name,
                                            content_type, Time.now.to_i * 1000).to_model
-    Bkblz.log.info "uploaded file => #{upload_file_info.file_name}"
-  end
-
-  Bkblz.log.info do <<-EOS
-  # We uploaded 5 files above, here we'll read back out
-  # metadata from the first 2 files in the bucket.
-  EOS
-  end
-  list_files_response = api_session.send(
-    Bkblz::V1::ListFileVersionsRequest.new bucket, 2)
-  bucket_files_info = list_files_response.files
-  Bkblz.log.info "first 2 files => #{bucket_files_info.map(&:file_name).join "\n"}"
-
-  Bkblz.log.info do <<-EOS
-  # The response object returned object is a
-  # Bkblz::Api::PaginatedResponse. Use its +has_more?+ and
-  # +next_request+ methods to page through more results.
-  EOS
-  end
-  while list_files_response.has_more?
-    list_files_response = api_session.send list_files_response.next_request 100
-    bucket_files_info.concat list_files_response.files
-    Bkblz.log.info "next N files => #{list_files_response.files.map(&:file_name).join "\n"}"
+        Bkblz.log.info "uploaded file => #{upload_file_info.file_name}"
+      end
+
+      Bkblz.log.info do <<-EOS
+      # We uploaded 5 files above, here we'll read back out
+      # metadata from the first 2 files in the bucket.
+      EOS
+      end
+      list_files_response = session.send(
+        Bkblz::V1::ListFileVersionsRequest.new bucket, 2)
+      bucket_files_info = list_files_response.files
+      Bkblz.log.info "first 2 files => #{bucket_files_info.map(&:file_name).join "\n"}"
+
+      Bkblz.log.info do <<-EOS
+      # The response object returned object is a
+      # Bkblz::Api::PaginatedResponse. Use its +has_more?+ and
+      # +next_request+ methods to page through more results.
+      EOS
+      end
+      while list_files_response.has_more?
+        list_files_response = session.send list_files_response.next_request 100
+        bucket_files_info.concat list_files_response.files
+        Bkblz.log.info "next N files => #{list_files_response.files.map(&:file_name).join "\n"}"
+      end
+
+      Bkblz.log.info do <<-EOS
+      # Files can also be listed by name.
+      EOS
+      end
+      list_files_response = session.send(
+        Bkblz::V1::ListFileNamesRequest.new bucket, 10)
+      bucket_files_info = list_files_response.files
+      Bkblz.log.info "files by name => #{bucket_files_info.map(&:file_name).join "\n"}"
+
+      Bkblz.log.info do <<-EOS
+      # Files can be downloaded by file name
+      EOS
+      end
+      file_name = bucket_files_info.first.file_name
+      file_name_download = session.send(
+        Bkblz::V1::DownloadFileByNameRequest.new bucket, file_name).to_model
+      Bkblz.log.info file_name_download
+      Bkblz.log.info "file body: #{file_name_download.body}"
+
+      Bkblz.log.info do <<-EOS
+      # Files can also be downloaded by file id
+      EOS
+      end
+      file_info = bucket_files_info[1]
+      file_id_download = session.send(
+        Bkblz::V1::DownloadFileByIdRequest.new file_info).to_model
+      Bkblz.log.info file_id_download
+      Bkblz.log.info "file body: #{file_id_download.body}"
+
+      Bkblz.log.info do <<-EOS
+      # File byte ranges can also be downloaded
+      EOS
+      end
+      bytes = (2..8)
+      byte_range_download = session.send(
+        Bkblz::V1::DownloadFileByNameRequest.new bucket, file_name, bytes).to_model
+      Bkblz.log.info "file bytes: #{byte_range_download.body}"
+    rescue => e
+      Bkblz.log.error "there was an error: #{e}"
+      Bkblz.log.error e.backtrace.join "\n"
+      Bkblz.log.warn "cleaning up the bucket"
+    ensure
+      clear_the_bucket session, bucket
+    end
   end
+end
 
-  Bkblz.log.info do <<-EOS
-  # Files can also be listed by name.
-  EOS
-  end
-  list_files_response = api_session.send(
-    Bkblz::V1::ListFileNamesRequest.new bucket, 10)
+def clear_the_bucket(session, bucket)
+  list_files_response = session.send(
+    Bkblz::V1::ListFileVersionsRequest.new bucket)
   bucket_files_info = list_files_response.files
-  Bkblz.log.info "files by name => #{bucket_files_info.map(&:file_name).join "\n"}"
 
   Bkblz.log.info do <<-EOS
   # Delete all the files in the bucket that we added. This is
@@ -140,7 +208,7 @@ Bkblz::V1::Session.authorize Bkblz.config do |api_session|
   end
   bucket_files_info.each do |file_info|
     request = Bkblz::V1::DeleteFileVersionRequest.new file_info
-    delete_file_version_response = api_session.send request
+    delete_file_version_response = session.send request
     Bkblz.log.info "deleted file => #{delete_file_version_response.to_model.file_name}"
   end
 
@@ -149,6 +217,8 @@ Bkblz::V1::Session.authorize Bkblz.config do |api_session|
   EOS
   end
   request = Bkblz::V1::DeleteBucketRequest.new bucket
-  delete_bucket_response = api_session.send request
+  delete_bucket_response = session.send request
   Bkblz.log.info "deleted bucket => #{bucket.bucket_name}/#{bucket.bucket_id}"
 end
+
+run_readme

data/bin/bkblz

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-$: << "lib"
 require "bkblz"
 require "thor"
 require "yaml"
@@ -83,8 +82,7 @@ module Bkblz
 
       file_info = run_task do
         Bkblz::Task::UploadFile.run Bkblz.config, {
-                                                  :bucket_handle => bucket_name,
-                                                  :handle_type => :bucket_name,
+                                                  :bucket_name => bucket_name,
                                                   :file_path => local_file_path
                                                 }
       end

data/lib/bkblz/v1/all.rb

@@ -15,3 +15,4 @@ require_relative "upload_file"
 require_relative "list_file_names"
 require_relative "list_file_versions"
 require_relative "delete_file_version"
+require_relative "download_file"

data/lib/bkblz/v1/download_file.rb

@@ -0,0 +1,67 @@
+module Bkblz
+  module V1
+
+    class DownloadFileResponse < Response
+      response_model Model::FileDownload
+
+      def parse(http_response)
+        file_download_fields = {
+         :body => http_response.body,
+         :content_length => http_response["content-length"],
+         :content_type => http_response["content-type"],
+         :file_id => http_response["x-bz-file-id"],
+         :file_name => http_response["x-bz-file-name"],
+         :sha1 => http_response["x-bz-content-sha1"],
+         :x_bz_info => {}
+        }
+
+        http_response.each_header do |k, v|
+          if k.to_s.downcase.match /^x-bz-info/
+            file_download_fields[:x_bz_info][k.to_sym] = v
+          end
+        end
+
+        file_download_fields
+      end
+    end
+
+    class DownloadFileByIdRequest < Request
+
+      response_class DownloadFileResponse
+      url_suffix "/b2api/v1/b2_download_file_by_id"
+
+      def initialize(file_info, byte_range=nil)
+        @body = {:file_id => file_info.file_id}
+        @byte_range = byte_range
+      end
+
+      def build_request(session)
+        headers = {}
+        headers[:Range] = "bytes=%d-%d" % @byte_range.minmax if @byte_range
+        session.create_post url(session), @body, headers
+      end
+    end
+
+    class DownloadFileByNameRequest < Request
+
+      response_class DownloadFileResponse
+
+      def initialize(bucket, file_name, byte_range=nil)
+        @bucket = bucket
+        @file_name = file_name
+        @byte_range = byte_range
+      end
+
+      def build_request(session)
+        headers = {}
+        headers[:Range] = "bytes=%d-%d" % @byte_range.minmax if @byte_range
+        session.create_get url_for_file(session), headers
+      end
+
+      private
+      def url_for_file(session)
+        session.create_url(["file", @bucket.bucket_name, @file_name].join "/")
+      end
+    end
+  end
+end

data/lib/bkblz/v1/models.rb

@@ -10,6 +10,11 @@ module Bkblz
         :action, :content_length, :file_id, :file_name, :size, :upload_timestamp
       ]
 
+      # Returned by download_file_by_name and download_file_by_id
+      FileDownload = Model.define *[
+        :body, :content_length, :content_type, :file_id, :file_name, :sha1, :x_bz_info
+      ]
+
       # Returned by upload_file
       FileInfo = Model.define *[
         :account_id, :bucket_id, :content_length, :content_sha1, :content_type,

data/lib/bkblz/v1/request.rb

@@ -58,9 +58,10 @@ module Bkblz
           error_response = ErrorResponse.new response, self
           raise RequestError.create error_response
         end
-        Bkblz.log.debug { "#build_response => #{response}" }
+        Bkblz.log.debug1(self) { "#build_response => #{response}" }
 
         response_class = self.class.response_class || Response
+        Bkblz.log.debug1(self) { "#creating response of class => #{response_class}" }
         response_class.new response, self
       end
 

data/lib/bkblz/v1/response.rb

@@ -70,7 +70,6 @@ module Bkblz
         self.class.response_model.new @parsed_response.dup
       end
 
-      private
       def parse(http_response)
         parsed_json = JSON.parse http_response.body, {
                                    :allow_nan => true,

data/lib/bkblz/v1/session.rb

@@ -42,28 +42,44 @@ module Bkblz
         URI.join auth_response.api_url, url_suffix
       end
 
+      def create_get(url, addl_headers={})
+        Bkblz.log.debug { "creating GET for request => #{url}" }
+        check_authorized
+
+        request = Net::HTTP::Get.new uri_from_url(url)
+        add_request_headers request, addl_headers
+        request
+      end
+
       def create_post(url, body=nil, addl_headers={})
-        Bkblz.log.debug { "creating post for request => #{url}" }
+        Bkblz.log.debug { "creating POST for request => #{url}" }
         check_authorized
 
-        uri = url.is_a?(URI) ? url : URI(url)
-        request = Net::HTTP::Post.new uri
+        request = Net::HTTP::Post.new uri_from_url(url)
 
         if body.is_a? Hash
           body = Bkblz::MapKeyFormatter.camelcase_keys(body).to_json
         end
         request.body = body if body
 
+        add_request_headers request, addl_headers
+
+        request
+      end
+
+      private
+      def uri_from_url(url)
+        url.is_a?(URI) ? url : URI(url)
+      end
+
+      def add_request_headers(request, addl_headers)
         headers = {:"Authorization" => auth_response.authorization_token}
         headers.merge(addl_headers).each do |k,v|
-          Bkblz.log.debug2 { "adding request header => #{k}:#{v}" }
+          Bkblz.log.debug1(self) { "adding request header => #{k}:#{v}" }
           request.add_field k.to_s, v unless v.nil?
         end
-
-        request
       end
 
-      private
       def check_authorized
         raise SessionNotAuthorizedError unless authorized?
       end

data/lib/bkblz/version.rb

@@ -1,3 +1,3 @@
 module Bkblz
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bkblz
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Erick Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-06 00:00:00.000000000 Z
+date: 2016-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -101,6 +101,7 @@ files:
 - lib/bkblz/v1/create_bucket.rb
 - lib/bkblz/v1/delete_bucket.rb
 - lib/bkblz/v1/delete_file_version.rb
+- lib/bkblz/v1/download_file.rb
 - lib/bkblz/v1/error_response.rb
 - lib/bkblz/v1/get_upload_url.rb
 - lib/bkblz/v1/list_buckets.rb