cf_ruby_client 0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb88cdcfbf1e3f243eeac061f2e1aaeb38306052
+  data.tar.gz: 0e0cfea9483a2e2b0e6499a442db477bc053ecdd
+SHA512:
+  metadata.gz: a0ec5b7b0c9a4986d5f0c99a888a548111b63aee272eb1c05869da1a45cc7f2dcbd556801e2e7168c449ab6bdb4dae9f30df3a55a18cf9c86b18ed4808d3eceb
+  data.tar.gz: 30837d40d690a58999784241f39575510432478976c63c9dff37d4279a66f3837c918400c5abb9c060f4f627fb66790e2e946066fa86207ded2dad2f7d305237

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,36 @@
+# cf_ruby_client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cf_ruby_client'
+```
+
+## Usage
+
+```
+CfRubyClient.configure(
+  api_endpoint: 'http://api.10.244.0.34.xip.io',
+  uaa_endpoint: 'http://uaa.10.244.0.34.xip.io',
+  username: 'admin',
+  password: 'admin',
+  passcode: 'admin'
+)
+```
+
+```
+app = CfRubyClient::App.new("guid")
+app.instances
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/a9hcp/cf_ruby_client.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cf_ruby_client"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cf_ruby_client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cf_ruby_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cf_ruby_client"
+  spec.version       = CfRubyClient::VERSION
+  spec.authors       = ["Michael Both", "Lucas Pinto"]
+  spec.email         = ["mboth@avarteq.de", "pinto@avarteq.de"]
+
+  spec.summary       = %q{Gem for interacting with CF cloud controller API}
+  spec.description   = %q{This gem may be used in rails apps for interacting with CF cloud controller API.}
+  spec.homepage      = "https://github.com/anynines/cf_ruby_client"
+
+  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_dependency "cf-uaa-lib", "~> 3.9"
+  spec.add_dependency "rest-client", "~> 2.0"
+
+
+  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 "ffaker", "~> 2.2"
+  spec.add_development_dependency "sinatra", "~> 1.4"
+  spec.add_development_dependency "webmock", "~> 1.22"
+end

data/lib/cf_ruby_client/app.rb

@@ -0,0 +1,33 @@
+module CfRubyClient
+  class App < Base
+    STARTED_STATE = "STARTED"
+
+    def self.all
+      url_path = "/v2/apps"
+      JSON::parse(CfRubyClient::Base.new.fetch_entities(url_path))
+    end
+
+    attr_reader :guid
+
+    def initialize(guid)
+      @guid = guid
+    end
+
+    def instances
+      return [] unless started?
+
+      url_path = "/v2/apps/#{guid}/instances"
+      JSON::parse(fetch_entities(url_path)).keys.map do |index|
+        AppInstance.new(guid, index)
+      end
+    end
+
+    private
+
+    def started?
+      url_path = "/v2/apps/#{guid}"
+      app_json = JSON::parse(fetch_entities(url_path))
+      app_json["entity"]["state"] == STARTED_STATE
+    end
+  end
+end

data/lib/cf_ruby_client/app_instance.rb

@@ -0,0 +1,21 @@
+module CfRubyClient
+  class AppInstance < Base
+
+    attr_reader :app_guid, :index
+
+    def initialize(guid, index)
+      @app_guid = guid
+      @index = index
+    end
+
+    def restart
+      url_path = "/v2/apps/#{app_guid}/instances/#{index}"
+      delete_entity(url_path)
+    end
+
+    def status
+      url_path = "/v2/apps/#{app_guid}/instances"
+      JSON::parse(fetch_entities(url_path))[index.to_s]
+    end
+  end
+end

data/lib/cf_ruby_client/base.rb

@@ -0,0 +1,121 @@
+module CfRubyClient
+  class Base
+
+    def api_endpoint
+      cloud_foundry_config.api_endpoint
+    end
+
+    def uaa_endpoint
+      cloud_foundry_config.uaa_endpoint
+    end
+
+    def authorization_string
+      @authorization_string ||= Login.new.authorization_string
+    end
+
+    def resource(url)
+      RestClient::Resource.new(
+        api_endpoint + url,
+        headers: headers_hash,
+        verify_ssl: cloud_foundry_config.skip_ssl_validation ? OpenSSL::SSL::VERIFY_NONE : OpenSSL::SSL::VERIFY_PEER
+      )
+    end
+
+    def fetch_entities(url)
+      logger.info "cf_ruby_client: GETting: #{url.inspect}"
+      resource(url).get(:Authorization => authorization_string) do |response, request, result, &block|
+        case response.code
+          when 200
+            response
+          when 404
+            logger.warn "cf_ruby_client: not found"
+            "{}"
+          else
+            logger.error "cf_ruby_client: Received: #{response.inspect}"
+            response.return!(&block)
+        end
+      end
+    end
+
+    def delete_entity(url)
+      logger.info "cf_ruby_client: DELETEing: #{url.inspect}"
+      resource(url).delete(:Authorization => authorization_string) do |response, request, result, &block|
+        case response.code
+          when 204
+            true
+          when 404
+            logger.warn "cf_ruby_client: not found"
+            false
+          else
+            logger.error "cf_ruby_client: Received: #{response.inspect}"
+            response.return!(&block)
+        end
+      end
+    end
+
+    def post_entity(url, body = nil)
+      logger.info "cf_ruby_client: POSTing: #{url}, body: #{body.inspect}"
+      resource(url).post(body.to_json, :Authorization => authorization_string) do |response, request, result, &block|
+        case response.code
+          when 200
+            true
+          when 404
+            logger.warn "cf_ruby_client: not found"
+            false
+          else
+            logger.error "cf_ruby_client: Received: #{response.inspect}"
+            response.return!(&block)
+        end
+      end
+    end
+
+    def patch_entity(url, body = nil)
+      logger.info "cf_ruby_client: PATCHing: #{url}, body: #{body.inspect}"
+      resource(url).patch(body.to_json, :Authorization => authorization_string) do |response, request, result, &block|
+        case response.code
+          when 200
+            true
+          when 404
+            logger.warn "cf_ruby_client: not found"
+            false
+          else
+            logger.error "cf_ruby_client: Received: #{response.inspect}"
+            response.return!(&block)
+        end
+      end
+    end
+
+    def put_entity(url, body = nil)
+      logger.info "cf_ruby_client: PUTting: #{url}, body: #{body.inspect}"
+      resource(url).put(body.to_json, :Authorization => authorization_string) do |response, request, result, &block|
+        case response.code
+          when 201
+            true
+          when 404
+            logger.warn "cf_ruby_client: not found"
+            false
+          else
+            logger.error "cf_ruby_client: Received: #{response.inspect}"
+            response.return!(&block)
+        end
+      end
+    end
+
+    def logger
+      ::CfRubyClient.logger
+    end
+
+    def cloud_foundry_config
+      ::CfRubyClient.configuration
+    end
+
+    private
+
+    def headers_hash
+      {
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+    end
+  end
+end

data/lib/cf_ruby_client/configuration.rb

@@ -0,0 +1,14 @@
+module CfRubyClient
+  class << self
+    attr_accessor :configuration, :logger
+  end
+
+  def self.configure(options={})
+    [:api_endpoint, :uaa_endpoint, :username, :password, :passcode].each do |required_argument|
+      raise ArgumentError.new("Configuration #{required_argument} required") if options[required_argument].nil?
+    end
+    options[:skip_ssl_validation] ||= false
+    self.logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+    self.configuration = OpenStruct.new(options)
+  end
+end

data/lib/cf_ruby_client/login.rb

@@ -0,0 +1,23 @@
+module CfRubyClient
+  class Login < Base
+
+    def authorization_string
+      token.info["token_type"] + " " + token.info["access_token"]
+    end
+
+    def token
+      @token ||= begin
+        token_issuer = CF::UAA::TokenIssuer.new(
+          uaa_endpoint,
+          "cf",
+          nil,
+          skip_ssl_validation: cloud_foundry_config.skip_ssl_validation
+        )
+        token_issuer.owner_password_grant(
+          username: cloud_foundry_config.username,
+          password: cloud_foundry_config.password
+        )
+      end
+    end
+  end
+end

data/lib/cf_ruby_client/service_instance.rb

@@ -0,0 +1,110 @@
+module CfRubyClient
+  class ServiceInstance < Base
+    SECURITY_GROUPS_PATH = "/v2/security_groups"
+    SERVICE_INSTANCES_PATH = "/v2/service_instances"
+    APP_RESTARTING_PATH = "/apps/restart_all/bound_to"
+
+    # TODO: make this configurable
+    NAME_PREFIX = "guard_"
+
+    def self.all
+      url_path = "#{SERVICE_INSTANCES_PATH}"
+      JSON::parse(CfRubyClient::Base.new.fetch_entities(url_path))
+    end
+
+    attr_reader :service_instance_guid
+
+    def initialize(service_instance_guid)
+      @service_instance_guid = service_instance_guid
+    end
+
+    def instance
+      url_path = "#{SERVICE_INSTANCES_PATH}/#{service_instance_guid}"
+
+      JSON::parse(fetch_entities(url_path))
+    end
+
+    def space_guid
+      return nil if instance.nil? or instance.empty?
+      instance["entity"]["space_guid"]
+    end
+
+    def service_bindings
+      url_path = "#{SERVICE_INSTANCES_PATH}/#{service_instance_guid}/service_bindings"
+
+      JSON::parse(fetch_entities(url_path))
+    end
+
+    def app_guids
+      return [] if service_bindings.nil? or service_bindings.empty?
+      service_bindings["resources"].map { |entry| entry["entity"]["app_guid"] }
+    end
+
+    def security_group_guid
+      return nil if security_group.empty?
+      security_group[:guid]
+    end
+
+    # restarts all applications running on Cloud Foundry which are bound to the
+    # service instance passed in the initializer.
+    def restart_apps
+      url = "#{APP_RESTARTING_PATH}/#{service_instance_guid}"
+
+      post_entity(url)
+    end
+
+    # gets the security group from the cloud controller associated with the service
+    # instance
+    def security_group(name)
+      url_path = "#{SECURITY_GROUPS_PATH}?q=name:#{name}"
+
+      extract_security_group(JSON::parse(fetch_entities(url_path)))
+    end
+
+    def create_security_group(body)
+      logger.debug "cf_ruby_client: Creating Security Group in the Cloud Controller"
+      url = SECURITY_GROUPS_PATH
+
+      post_entity(url, body)
+    end
+
+    def update_security_group(body, security_group_guid)
+      logger.debug "cf_ruby_client: Updating Security Group in the Cloud Controller"
+
+      url = "#{SECURITY_GROUPS_PATH}/#{security_group_guid}"
+
+      put_entity(url, body)
+    end
+
+    def delete_security_group(security_group_guid)
+      logger.debug "cf_ruby_client: Deleting Security Group in the Cloud Controller"
+
+      url = "#{SECURITY_GROUPS_PATH}/#{security_group_guid}"
+
+      delete_entity(url)
+    end
+
+    private
+
+    def extract_security_group(security_groups)
+      logger.debug "cf_ruby_client: Extracting Security Group from: #{security_groups}"
+      if security_groups["total_results"] == 0
+        return {}
+      else
+        sanitize_security_group(security_groups["resources"][0])
+      end
+    end
+
+    def sanitize_security_group(security_group)
+      logger.debug("cf_ruby_client: Sanitizing: #{security_group}")
+      # copy guids and space guids into the entity
+      entity = security_group["entity"]
+      entity["guid"] = security_group["metadata"]["guid"]
+      entity["space_guids"] = security_group["metadata"]["space_guids"]
+      entity && entity.keep_if do |key, _|
+        [:name, :rules, :guid, :space_guid].include? key.to_sym
+      end
+    end
+  end
+end
+

data/lib/cf_ruby_client/space.rb

@@ -0,0 +1,28 @@
+module CfRubyClient
+  class Space < Base
+
+    def self.all
+      url_path = "/v2/spaces"
+      JSON::parse(CfRubyClient::Base.new.fetch_entities(url_path))
+    end
+
+    attr_reader :guid
+
+    def initialize(guid)
+      @guid = guid
+    end
+
+    def apps
+      url_path = "/v2/spaces/#{guid}/apps"
+      JSON::parse(fetch_entities(url_path))
+    end
+
+    def app_guids
+      if not(apps.nil? or apps.empty?)
+        apps["resources"].collect {|entry| entry["metadata"]["guid"]}
+      else
+        []
+      end
+    end
+  end
+end

data/lib/cf_ruby_client/version.rb

@@ -0,0 +1,3 @@
+module CfRubyClient
+  VERSION = "0.6"
+end

data/lib/cf_ruby_client.rb

@@ -0,0 +1,19 @@
+require "rest-client"
+require 'uaa'
+
+require "cf_ruby_client/version"
+
+require "cf_ruby_client/configuration.rb"
+require "cf_ruby_client/base.rb"
+require "cf_ruby_client/login.rb"
+require "cf_ruby_client/app.rb"
+require "cf_ruby_client/app_instance.rb"
+require "cf_ruby_client/service_instance.rb"
+require "cf_ruby_client/space.rb"
+
+
+module CfRubyClient
+  def version
+    VERSION
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: cf_ruby_client
+version: !ruby/object:Gem::Version
+  version: '0.6'
+platform: ruby
+authors:
+- Michael Both
+- Lucas Pinto
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cf-uaa-lib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: This gem may be used in rails apps for interacting with CF cloud controller
+  API.
+email:
+- mboth@avarteq.de
+- pinto@avarteq.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cf_ruby_client.gemspec
+- lib/cf_ruby_client.rb
+- lib/cf_ruby_client/app.rb
+- lib/cf_ruby_client/app_instance.rb
+- lib/cf_ruby_client/base.rb
+- lib/cf_ruby_client/configuration.rb
+- lib/cf_ruby_client/login.rb
+- lib/cf_ruby_client/service_instance.rb
+- lib/cf_ruby_client/space.rb
+- lib/cf_ruby_client/version.rb
+homepage: https://github.com/anynines/cf_ruby_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: Gem for interacting with CF cloud controller API
+test_files: []
+has_rdoc: