backblaze 0.1.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 068ed971b2bfb14ba4c2723d0ed6a8ab6e532028
+  data.tar.gz: d318da137e35f01461104b7b80532944fcc362c5
+SHA512:
+  metadata.gz: 03c6c97c22963300e0deb4bfda498fbeef9e946a793a8897a21638da5a173154400ef715fd1b16f726198ee2a46bbd2f45c9c5752801c1ee25fc4b0c667fd550
+  data.tar.gz: 37b8599f0d5b54152efd63e54c55ed4b1002dafcb68de058e17ee0c8200cbff2f7ed438e76d53e05f936f9aa21a6fc86360e65d04a88bf8d474c3e9610025a6c

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in backblaze.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Winston Durand
+
+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,38 @@
+# Backblaze
+
+The Backblaze ruby gem is an implementation of the [Backblaze B2 Cloud Storage API](https://www.backblaze.com/b2/docs/). In addition to simplifying calls, it also implements an object oriented structure for dealing with files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backblaze'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backblaze
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/backblaze. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/backblaze.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backblaze/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "backblaze"
+  spec.version       = Backblaze::VERSION
+  spec.authors       = ["Winston Durand"]
+  spec.email         = ["me@winstondurand.com"]
+
+  spec.summary       = %q{Interface for teh Backblaze B2 Cloud}
+  spec.description   = %q{Intended to offer a way to interact with Backblaze B2 Cloud Storage without touching the API directly.}
+  spec.homepage      = "https://github.com/R167/backblaze"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "httparty"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "backblaze"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/backblaze.rb

@@ -0,0 +1,9 @@
+require "httparty"
+
+require "backblaze/version"
+require "backblaze/utils"
+require "backblaze/errors"
+require "backblaze/b2"
+
+module Backblaze
+end

data/lib/backblaze/b2.rb

@@ -0,0 +1,33 @@
+require "backblaze/b2/base"
+require "backblaze/b2/bucket"
+require "backblaze/b2/file"
+
+module Backblaze::B2
+  class << self
+    attr_reader :account_id, :token, :api_url, :download_url
+
+    ##
+    # Authenticates with the server to get the authorization data. Raises an error if there is a problem
+    #
+    # @param [#to_s] account_id the account id
+    # @param [#to_s] application_key the private app key
+    # @raise [Backblaze::AuthError] when unable to authenticate
+    # @return [void]
+    def login(account_id:, application_key:, api_path: '/b2api/v1/')
+      options = {
+        basic_auth: {username: account_id, password: application_key}
+      }
+      response = HTTParty.get("https://api.backblaze.com/b2api/v1/b2_authorize_account", options)
+      raise Backblaze::AuthError.new(response) unless response.code == 200
+
+      @account_id = response['accountId']
+      @token = response['authorizationToken']
+      @api_url = response['apiUrl']
+      @download_url = response['downloadUrl']
+      @api_path = api_path
+
+      Backblaze::B2::Base.base_uri "#{@api_url}#{api_path}"
+      Backblaze::B2::Base.headers 'Authorization' => @token, 'Content-Type' => 'application/json'
+    end
+  end
+end

data/lib/backblaze/b2/base.rb

@@ -0,0 +1,27 @@
+module Backblaze::B2
+  class Base
+    include HTTParty
+    include Backblaze::Utils
+
+    format :json
+
+    # @!method get(path, options={}, &block)
+    # Calls the class level equivalent from HTTParty
+    # @see http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/ClassMethods HTTParty::ClassMethods
+
+    # @!method head(path, options={}, &block)
+    # (see #get)
+
+    # @!method post(path, options={}, &block)
+    # (see #get)
+
+    # @!method put(path, options={}, &block)
+    # (see #get)
+
+    [:get, :head, :post, :put].each do |req|
+      define_method(req) do |path, options={}, &block|
+        self.class.send(req, path, options, &block)
+      end
+    end
+  end
+end

data/lib/backblaze/b2/bucket.rb

@@ -0,0 +1,156 @@
+module Backblaze::B2
+
+  ##
+  # A class to represent the online buckets. Mostly used for file access
+  class Bucket < Base
+
+    ##
+    # Creates a bucket from all of the possible parameters. This sould be rarely used and instead use a finder or creator
+    # @param [#to_s] bucket_name the bucket name
+    # @param [#to_s] bucket_id the bucket id
+    # @param [#to_s] bucket_type the bucket publicity type
+    # @param [#to_s] account_id the account to which this bucket belongs
+    def initialize(bucket_name:, bucket_id:, bucket_type:, account_id:)
+      @bucket_name = bucket_name
+      @bucket_id = bucket_id
+      @bucket_type = bucket_type
+      @account_id = account_id
+    end
+
+    # @return [String] bucket name
+    def bucket_name
+      @bucket_name
+    end
+
+    # @return [String] bucket id
+    def bucket_id
+      @bucket_id
+    end
+
+    # @return [Boolean] is the bucket public
+    def public?
+      @bucket_type == 'allPublic'
+    end
+
+    # @return [Boolean] is the bucket private
+    def private?
+      !public?
+    end
+
+    # @return [String] account id
+    def account_id
+      @account_id
+    end
+
+    # @return [String] bucket type
+    def bucket_type
+      @bucket_type
+    end
+
+    # Check if eqivalent. Takes advantage of globally unique names
+    # @return [Boolean] equality
+    def ==(other)
+      bucket_name == other.bucket_name
+    end
+
+    ##
+    # Lists all files that are in the bucket. This is the basic building block for the search.
+    # @param [Integer] limit max number of files to retreive. Set to `-1` to get all files.
+    #   This is not exact as it mainly just throws the limit into max param on the request
+    #   so it will try to grab at least `limit` files, unless there aren't enoungh in the bucket
+    # @param [Boolean] cache if there is no cache, create one. If there is a cache, use it.
+    #   Will check if the previous cache had the same size limit and convert options
+    # @param [Boolean] convert convert the files to Backblaze::B2::File objects
+    # @param [Integer] double_check_server whether or not to assume the server returns the most files possible
+    # @return [Array<Backblaze::B2::File>] when convert is true
+    # @return [Array<Hash>] when convert is false
+    # @note many of these methods are for the recusion
+    def file_names(limit: 100, cache: false, convert: true, double_check_server: false)
+      if cache && !@file_cache.nil?
+        if limit <= @file_cache[:limit] && convert == @file_cache[:convert]
+          return @file_cache[:files]
+        end
+      end
+
+      retreive_count = (double_check_server ? 0 : -1)
+      files = file_list(limit: limit, retreived: retreive_count, first_file: nil, start_field: 'startFileName'.freeze)
+
+      files.map! do |f|
+        Backblaze::B2::File.new(f)
+      end if convert
+      if cache
+        @file_name_cache = {limit: limit, convert: convert, files: files}
+      end
+      files
+    end
+
+    class << self
+      ##
+      # Create a bucket
+      # @param [String] name name of the new bucket
+      #   must be no more than 50 character and only contain letters, digits, "-", and "_".
+      #   must be globally unique
+      # @param [:public, :private] type determines the type of bucket
+      # @raise [Backblaze::BucketError] unable to create the specified bucket
+      def create(name:, type:)
+        body = {
+          accountId: Backblaze::B2.account_id,
+          bucketName: name,
+          bucketType: (type == :public ? 'allPublic' : 'allPrivate')
+        }
+        response = post('/b2_create_bucket', body: body.to_json)
+
+        raise Backblaze::BucketError.new(response) unless response.code / 100 == 2
+
+        params = %w(account_id bucket_id bucket_name bucket_type).map {|e| [e.to_sym, response[camelize(e)]]}.to_h
+
+        new(params)
+      end
+    end
+
+    private
+
+    def file_list(limit:, retreived:, first_file:, start_field:)
+      params = {'bucketId' => bucket_id}
+      if limit == -1
+        params['maxFileCount'.freeze] = 1000
+      elsif limit > 1000
+        params['maxFileCount'.freeze] = 1000
+      elsif limit > 0
+        params['maxFileCount'.freeze] = limit
+      else
+        return []
+      end
+      unless first_file.nil?
+        params[start_field] = first_file
+      end
+
+      response = post("/b2_list_file_#{start_field == 'startFileName' ? 'names' : 'versions'}", body: params.to_json)
+
+      files = response['files']
+      files.map! do |f|
+        f.map {|k, v| [underscore(k).to_sym, v]}.to_h
+      end
+
+      retreived = retreived + files.size if retreived >= 0
+      if limit > 0
+        limit = limit - (retreived >= 0 ? files.size : 1000)
+        limit = 0 if limit < 0
+      end
+
+      next_item = response[start_field.sub('start', 'next')]
+
+      if (limit > 0 || limit == -1) && !!next_item
+        files.concat file_list(
+          first_file: next_item,
+          limit: limit,
+          convert: convert,
+          retreived: retreived,
+          start_field: start_field
+        )
+      else
+        files
+      end
+    end
+  end
+end

data/lib/backblaze/b2/file.rb

@@ -0,0 +1,8 @@
+module Backblaze::B2
+  class File < Base
+    def initialize(file_id:, file_name:, size:, account_id:)
+      @versions = []
+
+    end
+  end
+end

data/lib/backblaze/b2/file_version.rb

@@ -0,0 +1,5 @@
+module Backblaze::B2
+  class FileVersion < Base
+
+  end
+end

data/lib/backblaze/errors.rb

@@ -0,0 +1,63 @@
+module Backblaze
+  ##
+  # Base Backblaze error class
+  # @abstract
+  class Error < StandardError
+  end
+
+  ##
+  # Basic needs for error messages.
+  # @note this could be abstract, but just keeps things simple.
+  class RequestError < Error
+    ##
+    # Creates the Error
+    # @param [HTTParty::Response] response the json response
+    def initialize(response)
+      @response = response
+    end
+
+    ##
+    # The response from the server
+    # @return [HTTParty::Response] the response
+    def response
+      @response
+    end
+
+    ##
+    # The Backblaze B2 error code
+    # @return [String] error code
+    def code
+      self['code']
+    end
+
+    ##
+    # The Backblaze B2 request status
+    # @return [Integer] status code
+    def status
+      self['status']
+    end
+
+    ##
+    # The Backblaze B2 error message which is a human explanation
+    # @return [String] the problem in human words
+    def message
+      self['message']
+    end
+
+
+    ##
+    # Shortcut to access the response keys
+    # @return [Object] the object stored at `key` in the response
+    def [](key)
+      @response[key]
+    end
+  end
+
+  ##
+  # Error class for authentication errors
+  class AuthError < RequestError; end
+
+  ##
+  # Error class for bucket errors
+  class BucketError < RequestError; end
+end

data/lib/backblaze/utils.rb

@@ -0,0 +1,26 @@
+module Backblaze::Utils
+  def underscore(word)
+    word.to_s.
+      gsub(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+
+  def camelize(word, capitalize=false)
+    word = word.to_s
+    "#{capitalize ? word[0, 1].upcase : word[0, 1].downcase}#{word.split('_').map(&:capitalize).join('')[1..-1]}"
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    include Backblaze::Utils
+  end
+
+  class << self
+    include Backblaze::Utils
+  end
+end

data/lib/backblaze/version.rb

@@ -0,0 +1,3 @@
+module Backblaze
+  VERSION = "0.1.0-alpha"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: backblaze
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha
+platform: ruby
+authors:
+- Winston Durand
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Intended to offer a way to interact with Backblaze B2 Cloud Storage without
+  touching the API directly.
+email:
+- me@winstondurand.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backblaze.gemspec
+- bin/console
+- bin/setup
+- lib/backblaze.rb
+- lib/backblaze/b2.rb
+- lib/backblaze/b2/base.rb
+- lib/backblaze/b2/bucket.rb
+- lib/backblaze/b2/file.rb
+- lib/backblaze/b2/file_version.rb
+- lib/backblaze/errors.rb
+- lib/backblaze/utils.rb
+- lib/backblaze/version.rb
+homepage: https://github.com/R167/backblaze
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Interface for teh Backblaze B2 Cloud
+test_files: []
+has_rdoc: