bits_service_client 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f4eb4e5a23a650a3ad048bf27d642ab8226a8a2
+  data.tar.gz: d60a71be08a7c33e674f8e816af57e8c12fc1626
+SHA512:
+  metadata.gz: 4158d05769b200bffd1fd94c1df4b5f94ef9da8a9f3292752b53251e5484ae5c3bc75dbe72850dfd050d53657e1890ce17fc325fbcd34182451abc8fefcdca5c
+  data.tar.gz: 0ac0d9c991dcba9d2b95da18f992ca0f0e1d8e78e194366a16432674d51e2e941432a70f2b0229efa221f0863e892a1c7e08fc640a28203147839a465a1c145c

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color --tty --format=documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,18 @@
+guard :bundler do
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/bits_service_client/(.+)\.rb$}){|m| "spec/unit/bits_service_client/#{m[1]}_spec.rb"}
+  watch(%r{^lib/bits_service_client/client.rb$}){|m| "spec/unit/bits_service_client/bits_service_client_spec.rb"}
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/README.md

@@ -0,0 +1,12 @@
+# Bits-Service Client
+
+Ruby client for [bits-service](https://github.com/cloudfoundry-incubator/bits-service).
+
+# Changelog
+
+* 0.2.0:
+  - Add `vcap_request_id` to `BitsService::Client` and `BitsService::ResourcePool`
+  - Add `request_timeout_in_seconds` to `BitsService::ResourcePool`
+  - Move unit tests from CloudController to this gem
+
+* 0.1.0: Initial version

data/Rakefile

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

data/bits_service_client.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bits_service_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bits_service_client"
+  spec.version       = BitsServiceClient::VERSION
+  spec.authors       = ['Rizwan Reza', 'Steffen Uhlig', 'Peter Goetz']
+  spec.email         = ["rizwanreza@gmail.com", 'steffen.uhlig@de.ibm.com', 'peter.gtz@gmail.com']
+
+  spec.summary       = %q{Bits Services client for Cloud Foundry}
+  spec.homepage      = "http://github.com/cloudfoundry/bits_service_client"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "steno"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", '= 1.20.4'
+  spec.add_development_dependency "multipart-post"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency 'terminal-notifier-guard'
+  spec.add_development_dependency 'terminal-notifier'
+end

data/lib/bits_service_client/blob.rb

@@ -0,0 +1,15 @@
+module BitsService
+  class Blob
+    attr_reader :guid, :public_download_url, :internal_download_url
+
+    def initialize(guid:, public_download_url:, internal_download_url:)
+      @guid = guid
+      @public_download_url = public_download_url
+      @internal_download_url = internal_download_url
+    end
+
+    def attributes(*_)
+      []
+    end
+  end
+end

data/lib/bits_service_client/client.rb

@@ -0,0 +1,164 @@
+require 'active_support/inflector'
+require 'bits_service_client/logging_http_client'
+
+module BitsService
+  class Client
+    ResourceTypeNotPresent = Class.new(StandardError)
+    ConfigurationError = Class.new(StandardError)
+
+    def initialize(bits_service_options:, resource_type:, vcap_request_id: '')
+      @username = validated(bits_service_options, :username)
+      @password = validated(bits_service_options, :password)
+      @private_endpoint = validated_http_url(bits_service_options, :private_endpoint)
+      @public_endpoint = validated_http_url(bits_service_options, :public_endpoint)
+
+      raise ResourceTypeNotPresent.new('Must specify resource type') unless resource_type
+      @resource_type = resource_type
+      @vcap_request_id = vcap_request_id
+
+      @private_http_client = LoggingHttpClient.new(Net::HTTP.new(@private_endpoint.host, @private_endpoint.port))
+      @public_http_client = LoggingHttpClient.new(Net::HTTP.new(@public_endpoint.host, @public_endpoint.port))
+    end
+
+    def local?
+      false
+    end
+
+    def exists?(key)
+      response = @private_http_client.head(resource_path(key), @vcap_request_id)
+      validate_response_code!([200, 302, 404], response)
+
+      response.code.to_i != 404
+    end
+
+    def cp_to_blobstore(source_path, destination_key)
+      filename = File.basename(source_path)
+      with_file_attachment!(source_path, filename) do |file_attachment|
+        body = { :"#{@resource_type.to_s.singularize}" => file_attachment }
+        response = @private_http_client.do_request(Net::HTTP::Put::Multipart.new(resource_path(destination_key), body), @vcap_request_id)
+        validate_response_code!(201, response)
+      end
+    end
+
+    def download_from_blobstore(source_key, destination_path, mode: nil)
+      FileUtils.mkdir_p(File.dirname(destination_path))
+      File.open(destination_path, 'wb') do |file|
+        response = @private_http_client.get(resource_path(source_key), @vcap_request_id)
+        validate_response_code!(200, response)
+        file.write(response.body)
+        file.chmod(mode) if mode
+      end
+    end
+
+    def cp_file_between_keys(source_key, destination_key)
+      temp_downloaded_file = Tempfile.new('foo')
+      download_from_blobstore(source_key, temp_downloaded_file.path)
+      cp_to_blobstore(temp_downloaded_file.path, destination_key)
+    end
+
+    def delete(key)
+      response = @private_http_client.delete(resource_path(key), @vcap_request_id)
+      validate_response_code!([204, 404], response)
+
+      if response.code.to_i == 404
+        raise FileNotFound.new("Could not find object '#{key}', #{response.code}/#{response.body}")
+      end
+    end
+
+    def blob(key)
+      response = @private_http_client.get('/sign' + resource_path(key), @vcap_request_id, {username: @username, password: @password})
+      validate_response_code!([200, 302], response)
+
+      response.tap do |response|
+        response.body = response['location'] if response.code.to_i == 302
+      end
+
+      Blob.new(
+        guid: key,
+        public_download_url: response.body,
+        internal_download_url: generate_private_url(key)
+      )
+    end
+
+    def delete_blob(blob)
+      delete(blob.guid)
+    end
+
+    def delete_all(_=nil)
+      raise NotImplementedError unless :buildpack_cache == resource_type
+
+      @private_http_client.delete(resource_path(''), @vcap_request_id).tap do |response|
+        validate_response_code!(204, response)
+      end
+    end
+
+    def delete_all_in_path(path)
+      raise NotImplementedError unless :buildpack_cache == resource_type
+
+      @private_http_client.delete(resource_path(path.to_s), @vcap_request_id).tap do |response|
+        validate_response_code!(204, response)
+      end
+    end
+
+    private
+
+    attr_reader :resource_type
+
+    def generate_private_url(guid)
+      path = resource_path(guid)
+
+      @private_http_client.head(path, @vcap_request_id).tap do |response|
+        return response['location'] if response.code.to_i == 302
+      end
+
+      File.join(@private_endpoint.to_s, path)
+    end
+
+    def validate_response_code!(expected_codes, response)
+      return if Array(expected_codes).include?(response.code.to_i)
+
+      error = {
+        response_code: response.code,
+        response_body: response.body,
+        response: response
+      }.to_json
+
+      logger.error("UnexpectedResponseCode: expected '#{expected_codes}' got #{error}")
+
+      fail BlobstoreError.new(error)
+    end
+
+    def resource_path(guid)
+      prefix = resource_type == :buildpack_cache ? 'buildpack_cache/entries/' : resource_type
+      File.join('/', prefix.to_s, guid.to_s)
+    end
+
+    def with_file_attachment!(file_path, filename, &block)
+      raise Errors::FileDoesNotExist.new("Could not find file: #{file_path}") unless File.exist?(file_path)
+
+      File.open(file_path) do |file|
+        attached_file = UploadIO.new(file, 'application/octet-stream', filename)
+        yield attached_file
+      end
+    end
+
+    def endpoint(http_client)
+      http_client == @public_http_client ? @public_endpoint : @private_endpoint
+    end
+
+    def logger
+      @logger ||= Steno.logger('cc.bits_service_client')
+    end
+
+    def validated_http_url(bits_service_options, attribute)
+      URI.parse(validated(bits_service_options, attribute)).tap do |uri|
+        raise ConfigurationError.new("Please provide valid http(s) #{attribute}") unless uri.scheme&.match /https?/
+      end
+    end
+
+    def validated(bits_service_options, attribute)
+      raise ConfigurationError.new("Please provide #{attribute}") unless bits_service_options[attribute]
+      bits_service_options[attribute]
+    end
+  end
+end

data/lib/bits_service_client/errors.rb

@@ -0,0 +1,7 @@
+module BitsService
+  module Errors
+    class Error < StandardError; end
+    class FileDoesNotExist < Error; end
+    class UnexpectedResponseCode < Error; end
+  end
+end

data/lib/bits_service_client/logging_http_client.rb

@@ -0,0 +1,45 @@
+module BitsService
+  class LoggingHttpClient
+    def initialize(http_client)
+      @http_client = http_client
+      @logger = Steno.logger('cc.bits_service_client')
+    end
+
+    def get(path, vcap_request_id, credentials=nil)
+      req = Net::HTTP::Get.new(path)
+      if credentials
+        req.basic_auth(credentials[:username], credentials[:password])
+      end
+      do_request(req, vcap_request_id)
+    end
+
+    def head(path, vcap_request_id)
+      do_request(Net::HTTP::Head.new(path), vcap_request_id)
+    end
+
+    def put(path, body, vcap_request_id)
+      do_request(Net::HTTP::Put::Multipart.new(path, body), vcap_request_id)
+    end
+
+    def delete(path, vcap_request_id)
+      do_request(Net::HTTP::Delete.new(path), vcap_request_id)
+    end
+
+    def do_request(request, vcap_request_id)
+      @logger.info('Request', {
+        method: request.method,
+        path: request.path,
+        address: @http_client.address,
+        port: @http_client.port,
+        vcap_request_id: vcap_request_id,
+      })
+
+      request.add_field('X_VCAP_REQUEST_ID', vcap_request_id)
+
+      @http_client.request(request).tap do |response|
+        @logger.info('Response', { code: response.code, vcap_request_id: vcap_request_id })
+      end
+    end
+
+  end
+end

data/lib/bits_service_client/resource_pool.rb

@@ -0,0 +1,99 @@
+module BitsService
+  class ResourcePool
+    def initialize(endpoint:, request_timeout_in_seconds:, vcap_request_id: '')
+      @endpoint = URI.parse(endpoint)
+      @request_timeout_in_seconds = request_timeout_in_seconds
+      @vcap_request_id = vcap_request_id
+      @logger = Steno.logger('cc.bits_service_client')
+    end
+
+    def matches(resources_json)
+      post('/app_stash/matches', resources_json, @vcap_request_id).tap do |response|
+        validate_response_code!(200, response)
+      end
+    end
+
+    def upload_entries(entries_path)
+      with_file_attachment!(entries_path, 'entries.zip') do |file_attachment|
+        body = { application: file_attachment }
+        multipart_post('/app_stash/entries', body, @vcap_request_id)
+      end
+    end
+
+    def bundles(resources_json)
+      post('/app_stash/bundles', resources_json, @vcap_request_id).tap do |response|
+        validate_response_code!(200, response)
+      end
+    end
+
+    private
+
+    attr_reader :endpoint
+
+    def validate_response_code!(expected, response)
+      return if expected.to_i == response.code.to_i
+
+      error = {
+        response_code: response.code,
+        response_body: response.body,
+        response: response
+      }.to_json
+
+      @logger.error("UnexpectedResponseCode: expected #{expected} got #{error}")
+
+      fail Errors::UnexpectedResponseCode.new(error)
+    end
+
+    def with_file_attachment!(file_path, filename, &block)
+      validate_file! file_path
+
+      File.open(file_path) do |file|
+        attached_file = UploadIO.new(file, 'application/octet-stream', filename)
+        yield attached_file
+      end
+    end
+
+    def validate_file!(file_path)
+      return if File.exist?(file_path)
+
+      raise Errors::FileDoesNotExist.new("Could not find file: #{file_path}")
+    end
+
+    def post(path, body, vcap_request_id)
+      request = Net::HTTP::Post.new(path)
+
+      request.body = body
+      do_request(http_client, request, vcap_request_id)
+    end
+
+    def multipart_post(path, body, vcap_request_id)
+      request = Net::HTTP::Post::Multipart.new(path, body)
+      do_request(http_client, request, vcap_request_id).tap do |response|
+        validate_response_code!(201, response)
+      end
+    end
+
+    def do_request(http_client, request, vcap_request_id)
+      @logger.info('Request', {
+        method: request.method,
+        path: request.path,
+        address: http_client.address,
+        port: http_client.port,
+        vcap_request_id: vcap_request_id,
+      })
+
+      request.add_field('X_VCAP_REQUEST_ID', vcap_request_id)
+
+      http_client.request(request).tap do |response|
+        @logger.info('Response', {
+          code: response.code,
+          vcap_request_id: vcap_request_id,
+        })
+      end
+    end
+
+    def http_client
+      @http_client ||= Net::HTTP.new(endpoint.host, endpoint.port).tap { |c| c.read_timeout = @request_timeout_in_seconds }
+    end
+  end
+end

data/lib/bits_service_client/version.rb

@@ -0,0 +1,3 @@
+module BitsServiceClient
+  VERSION = '0.2.1'
+end

data/lib/bits_service_client.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'net/http/post/multipart'
+
+require "bits_service_client/version"
+require "bits_service_client/blob"
+require "bits_service_client/errors"
+require "bits_service_client/client"
+require "bits_service_client/resource_pool"
+
+module BitsService
+  BlobstoreError = Class.new(StandardError)
+  FileNotFound = Class.new(StandardError)
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: bits_service_client
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Rizwan Reza
+- Steffen Uhlig
+- Peter Goetz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: steno
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  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: rack-test
+  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: guard
+  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: guard-bundler
+  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: guard-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: terminal-notifier-guard
+  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: terminal-notifier
+  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: 
+email:
+- rizwanreza@gmail.com
+- steffen.uhlig@de.ibm.com
+- peter.gtz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bits_service_client.gemspec
+- lib/bits_service_client.rb
+- lib/bits_service_client/blob.rb
+- lib/bits_service_client/client.rb
+- lib/bits_service_client/errors.rb
+- lib/bits_service_client/logging_http_client.rb
+- lib/bits_service_client/resource_pool.rb
+- lib/bits_service_client/version.rb
+homepage: http://github.com/cloudfoundry/bits_service_client
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Bits Services client for Cloud Foundry
+test_files: []